Fix --insert-license-after-regex to work beyond first line (#103)

ashb · web-flow · commit fd3fbe825390 · 2025-06-05T13:51:00.000+02:00
There was a logic bug where `index` wasn't incremenetd, so we
would search through the file for the regex, but index was still 0
so the index always got put after line 0.
diff --git a/pre_commit_hooks/insert_license.py b/pre_commit_hooks/insert_license.py
@@ -328,7 +328,7 @@ def license_not_found(  # pylint: disable=too-many-arguments
     """
     if not remove_header:
         index = 0
-        for line in src_file_content:
+        for index, line in enumerate(src_file_content):
             stripped_line = line.strip()
             # Special treatment for user provided regex,
             # or shebang, file encoding directive,
@@ -339,13 +339,14 @@ def license_not_found(  # pylint: disable=too-many-arguments
                     index += 1  # Skip matched line
                     break  # And insert after that line.
             elif (
-                stripped_line.startswith("#!")
-                or stripped_line.startswith("# -*- coding")
-                or stripped_line == ""
+                not stripped_line.startswith("#!")
+                and not stripped_line.startswith("# -*- coding")
+                and not stripped_line == ""
             ):
-                index += 1
-            else:
                 break
+        else:
+            # We got all the way to the end without hitting `break`, reset it to line 0
+            index = 0
         src_file_content = (
             src_file_content[:index]
             + license_info.prefixed_license
diff --git a/tests/insert_license_test.py b/tests/insert_license_test.py
@@ -190,6 +190,15 @@ def _convert_line_ending(file_path, new_line_endings):
                         True,
                         ["--insert-license-after-regex", "^<\\?php$"],
                     ),
+                    (
+                        "module_without_license.py",
+                        "#",
+                        "module_with_license.py",
+                        "",
+                        True,
+                        # Test that when the regex is not found, the license is put at the first line
+                        ["--insert-license-after-regex", "^<\\?php$"],
+                    ),
                     (
                         "module_without_license.py",
                         "#",
diff --git a/tests/resources/module_with_license.php b/tests/resources/module_with_license.php
@@ -1,3 +1,5 @@
+<!-- Hi -->
+<html>
 <?php
 /*
  * Copyright (C) 2017 Teela O'Malley
diff --git a/tests/resources/module_without_license.php b/tests/resources/module_without_license.php
@@ -1,2 +1,4 @@
+<!-- Hi -->
+<html>
 <?php
 print "Hello";

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+<!-- Hi -->`
	`2`	`+<html>`
`1`	`3`	`<?php`
`2`	`4`	`/*`
`3`	`5`	`* Copyright (C) 2017 Teela O'Malley`
-Original file line number
+Diff line change
@@ @@ -1,2 +1,4 @@ @@
 +<!-- Hi -->
 +<html>
 <?php
 print "Hello";