Merge branch 'main' of https://github.com/Kudrixon/pre-commit_hook_static_path

Author: Przemyslaw Kudriawcew

.pre-commit-config.yaml

@@ -3,5 +3,5 @@ repos:
   rev: v1.1.0
   hooks:
     - id: check-static-path
-      args: ["-k=/home/tester"]
+      args: ['--keywords=/home/tester']
       verbose: true

README.md

@@ -54,14 +54,27 @@ check static path........................................................Failed
 Specified keyword: /home/vtest detected in file pre_commit_hooks/sample.py, line 1 content: kualalumpur("/home/vtest")
 ```
 
+#### Pass multiple strings to keywords parameter
+
+```
+repos:
+- repo: https://github.com/Kudrixon/pre-commit_hook_static_path
+  rev: v1.1.0
+  hooks:
+    - id: check-static-path
+      args: ['--keywords', 'for', 'if', '--nodiff', 'true', '--',]
+      verbose: true
+```
+
+***"--"*** needs to be added at the end when using this kind of syntax while providing args
 
 ### Parameters
 
 ***--filename***:
 By default this pre-commit dont need You to provide filename because diff mechanism gets it by itself. When executed pre-commit mechanism gets filename parameter anyway.
 
-***--keyword, -k***:
-[REQUIRED] Provide this to find specific string existing in incoming commit, or to find it in file specified by You
+***--keywords, -k***:
+[REQUIRED] Provide this to find specific list of strings existing in incoming commit, or to find it in file specified by You
 
 ***--nodiff, -nd***:
 If You wish to use this pre-commit to check for string in whole file not just in incoming changes you can use this flag with parameters: "false" which is default setting for using script in diff mode, "true" sets script in no-diff mode which allows user to find phrase in whole file chosen previously

pre_commit_hooks/check_static_path.py

@@ -17,18 +17,18 @@ def extractMatches(text, pattern):
             result.append(match.group(0))
     return result
 
-def findStringInRangeForFile(filename, keyword, changes_range):
-    result = []
+def findStringInRangeForFile(filename, keywords, changes_range):
+    results = []
     with open(filename, "r") as f:
         lines = f.readlines()
         for i, line in enumerate(lines):
             for start, end in changes_range:
-                if start <= i+1 <= end and keyword in line:
-                    result.append((filename, i+1, line))
-    return result
+                if start <= i+1 <= end and any(keyword in line for keyword in keywords):
+                    results.append((filename, i+1, line))
+    return results
 
-def findStringInRange(filenames, keyword):
-    result = []
+def findStringInRange(filenames, keywords):
+    results = []
     for filename in filenames:
         text = subprocess.run(['git', 'diff', "--unified=0", 'HEAD', filename], capture_output=True, text=True).stdout
         matches = extractMatches(text, pattern)
@@ -42,23 +42,24 @@ def findStringInRange(filenames, keyword):
                     changes_range.append((start, end))
                 else:
                     changes_range.append((start, end - 1))
-        result += findStringInRangeForFile(filename, keyword, changes_range)
-    return result
+        results += findStringInRangeForFile(filename, keywords, changes_range)
+    return results
 
-def findStringInFile(filename, keyword, retval):
+def findStringInFile(filename, keywords, retval):
     with open(filename, 'r') as f:
         lines = f.readlines()
     for line_num, line in enumerate(lines, start=1):
-        if keyword in line:
-            print(f"Specified keyword: {keyword} detected in file {filename}, line {line_num} content: {line}")
-            retval = 1
+        for keyword in keywords:
+            if keyword in line:
+                print(f"Specified keyword: {keyword} detected in file {filename}, line {line_num} content: {line}")
+                retval = 1
     return retval
 
 
 def main(argv: Union[Sequence[str], None] = None) -> int:
     parser = argparse.ArgumentParser()
     parser.add_argument('filenames', nargs='*')
-    parser.add_argument('-k', '--keyword', help='Static string excluded in commiting', required=True)
+    parser.add_argument('-k', '--keywords', nargs='+', help='Static string excluded in commiting', required=True)
     parser.add_argument('-nd', '--nodiff', default="false", choices=['true', 'false'], help='If you need to check just specified file select true')
 
     args = parser.parse_args(argv)
@@ -70,15 +71,16 @@ def main(argv: Union[Sequence[str], None] = None) -> int:
         matches = extractMatches(text, pattern)
         filenames = [match.replace("+++ b/", "") for match in matches if match.startswith("+++ b/")]
         filenames = [filename for filename in filenames if filename is not None]
-        results = findStringInRange(filenames, args.keyword)
-        for r in results:
-            print(f"Static path of {args.keyword} detected in file {r[0]}, line {r[1]} content: {r[2]}, change to dynamic needed")
-            retval = 1
+        results = findStringInRange(filenames, args.keywords)
+        for keyword in args.keywords:
+            for r in results:
+                print(f"Static path of '{keyword}' detected in file {r[0]}, line {r[1]} content: {r[2]}, change to dynamic needed")
+                retval = 1
 
     else:
         for filename in args.filenames:
             try:
-                retval = findStringInFile(filename, args.keyword, retval)
+                retval = findStringInFile(filename, args.keywords, retval)
 
             except SyntaxError:
                 impl = platform.python_implementation()