Fix check-merge-conflict hook false positive in RST (#53)

Fixes #52
salt-extensions · Sep 23, 2024 · 035b990 · 035b990
1 parent b50919a
commit 035b990
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/changelog/52.fixed.md b/changelog/52.fixed.md
@@ -0,0 +1 @@
+Fixed check-merge-conflict pre-commit hook false positive in RST files with specific Saltext name lengths
diff --git a/project/.pre-commit-hooks/make-autodocs.py.j2 b/project/.pre-commit-hooks/make-autodocs.py.j2
@@ -33,9 +33,14 @@ def write_module(rst_path, path, use_virtualname=True):
         virtualname = "``" + _find_virtualname(path) + "``"
     else:
         virtualname = make_import_path(path)
+    header_len = len(virtualname)
+    # The check-merge-conflict pre-commit hook chokes here:
+    # https://github.com/pre-commit/pre-commit-hooks/issues/100
+    if header_len == 7:
+        header_len += 1
     module_contents = f"""\
 {virtualname}
-{'='*len(virtualname)}
+{'='*header_len}
 
 .. automodule:: {make_import_path(path)}
     :members: