feat: make disclaimer optional and include informative comment to markdown template (#145)

Author: esynr3z

schemas/corsair-build-schema.json

@@ -74,6 +74,12 @@
           "title": "Print Conventions",
           "type": "boolean"
         },
+        "print_disclaimer": {
+          "default": true,
+          "description": "Enable generating disclaimer with version at the beginning of the file.",
+          "title": "Print Disclaimer",
+          "type": "boolean"
+        },
         "wavedrom": {
           "$ref": "#/$defs/corsair___generators__wavedrom__WaveDromGenerator__Config",
           "default": {

src/corsair/_generators/markdown.py

@@ -39,6 +39,9 @@ class Config(GeneratorConfig):
         print_conventions: bool = True
         """Enable generating table with register access modes explained."""
 
+        print_disclaimer: bool = True
+        """Enable generating disclaimer with version at the beginning of the file."""
+
         wavedrom: WaveDromGenerator.Config = WaveDromGenerator.Config()
         """Configuration for the WaveDrom generator."""
 

src/corsair/_templates/regmap.md.j2

@@ -17,9 +17,13 @@
 {% set tmp = namespace() %}
 
 {#- TEMPLATE #}
+[//]: # (DO NOT EDIT THIS AUTOGENERATED FILE. ALL CHANGES WILL BE LOST.)
+
 # {{ cfg.title }}
 
-Created with [Corsair](https://github.com/esynr3z/corsair) v{{ version }}.
+{% if cfg.print_disclaimer %}
+Generated by [Corsair](https://github.com/esynr3z/corsair) v{{ version }}.
+{% endif %}
 
 {% if cfg.print_conventions %}
 ## Conventions

tests/generators/test_markdown.py

@@ -239,6 +239,46 @@ def test_wavedrom_dump_json(tmp_path: Path, simple_regmap: csr.Map) -> None:
     assert {f for f in expected_data_dir.iterdir() if f.suffix == ".json"} == expected_json_files
 
 
+def test_autogenerated_comment_present(tmp_path: Path, simple_regmap: csr.Map) -> None:
+    """Test that the autogenerated comment is present in the output file."""
+    config = csr.MarkdownGenerator.Config()
+    gen = csr.MarkdownGenerator(
+        label="test_md_gen_autogen_comment", register_map=simple_regmap, config=config, output_dir=tmp_path
+    )
+    generated_files = list(gen())
+
+    assert len(generated_files) == 1
+    output_file = generated_files[0]
+    assert output_file.is_file()
+
+    content = output_file.read_text()
+    assert "[//]: # (DO NOT EDIT THIS AUTOGENERATED FILE. ALL CHANGES WILL BE LOST.)" in content
+
+
+def test_print_disclaimer_true(tmp_path: Path, simple_regmap: csr.Map) -> None:
+    """Test that disclaimer is printed when print_disclaimer is True."""
+    config = csr.MarkdownGenerator.Config(print_disclaimer=True)
+    gen = csr.MarkdownGenerator(
+        label="test_md_gen_disclaimer_true", register_map=simple_regmap, config=config, output_dir=tmp_path
+    )
+    generated_files = list(gen())
+    output_file = generated_files[0]
+    content = output_file.read_text()
+    assert "Generated by [Corsair]" in content
+
+
+def test_print_disclaimer_false(tmp_path: Path, simple_regmap: csr.Map) -> None:
+    """Test that disclaimer is not printed when print_disclaimer is False."""
+    config = csr.MarkdownGenerator.Config(print_disclaimer=False)
+    gen = csr.MarkdownGenerator(
+        label="test_md_gen_disclaimer_false", register_map=simple_regmap, config=config, output_dir=tmp_path
+    )
+    generated_files = list(gen())
+    output_file = generated_files[0]
+    content = output_file.read_text()
+    assert "Generated by [Corsair]" not in content
+
+
 def test_custom_template_and_extra_param(tmp_path: Path, simple_regmap: csr.Map, custom_template: Path) -> None:
     """Test generation with a custom template and extra config parameters."""
     template_file = custom_template