Skip to content

Better error message for run_formatter #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olehermanse merged 1 commit into from
Jul 10, 2026
+6 −2
Merged

Better error message for run_formatter #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/cfengine_cli/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import os
import json
import subprocess
import textwrap

import markdown_it
from cfbs.pretty import pretty_file
Expand Down Expand Up @@ -375,8 +376,11 @@ def _run_formatter(tool, args, cwd, install_hint):
check=True,
cwd=cwd,
)
except:
raise UserError(f"Encountered an error running {tool}\nInstall: {install_hint}")
except FileNotFoundError:
raise UserError(f"'{tool}' not found. Install it with: {install_hint}")
except subprocess.CalledProcessError as e:
error_msg = textwrap.indent(str(e.stderr).strip(), "> ")
raise UserError(f"Encountered an error running {tool}:\n{error_msg}")
return result


Expand Down
Loading