From eabbd82929c8c7045742e5a813090da680413472 Mon Sep 17 00:00:00 2001 From: Sara Thon Date: Fri, 5 Jun 2026 10:05:23 +0200 Subject: [PATCH] CFE-4665: `cfengine dev format docs` should tell you what files it formatted Ticket: CFE-4665 --- src/cfengine_cli/docs.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/src/cfengine_cli/docs.py b/src/cfengine_cli/docs.py index 26deceb..daca74a 100644 --- a/src/cfengine_cli/docs.py +++ b/src/cfengine_cli/docs.py @@ -256,7 +256,6 @@ def _process_markdown_code_blocks( return if syntax_check: - # We currently only print the filenames during linting, not formatting print( f"Processing code blocks (snippets) inside {origin_paths_len} markdown files:" ) @@ -265,9 +264,13 @@ def _process_markdown_code_blocks( spaces = " " * (4 - len(str(percentage))) prefix = f"[{origin_paths_i + 1}/{origin_paths_len}{spaces}({percentage}%)] " offset = 0 + original_content = None if syntax_check and not parsed_markdowns["files"][origin_path]["code-blocks"]: print(f"{prefix}SKIP: No code blocks in '{origin_path}'") continue + if autoformat: + with open(origin_path, "r") as f: + original_content = f.read() for i, code_block in enumerate( parsed_markdowns["files"][origin_path]["code-blocks"] ): @@ -345,6 +348,12 @@ def _process_markdown_code_blocks( if cleanup: os.remove(snippet_path) + if autoformat: + with open(origin_path, "r") as f: + new_content = f.read() + if new_content != original_content: + print(f"Markdown file '{origin_path}' was reformatted") + def _run_formatter(tool, args, cwd, install_hint): print(f"Formatting with {tool}...")