Rewrite, fixes issue#43

* Added type annotations to hooks
* Removed hardcoded regexes identified by qq7te
* Use types: in .pre-commit-config.yaml to filter for correct files instead of files: regex

Author: pocc

.pre-commit-config.yaml

@@ -19,15 +19,15 @@ repos:
       - id: check-yaml
       - id: debug-statements
       - id: requirements-txt-fixer
-  - repo: https://github.com/pre-commit/pre-commit
-    rev: b8300268bf2d8797f28edf9063d7e5659ad4d535
-    hooks:
-    -   id: validate_manifest
   - repo: https://github.com/asottile/reorder_python_imports
     rev: bc7b5b2f0fde191c9d0121588ef9bbb79f8e5e21
     hooks:
       - id: reorder-python-imports
         language_version: python3
+  - repo: https://github.com/pre-commit/pre-commit
+    rev: v2.16.0
+    hooks:
+    -   id: validate_manifest
   - repo: https://github.com/asottile/pyupgrade
     rev: v1.16.1
     hooks:
@@ -37,12 +37,6 @@ repos:
     hooks:
       - id: black
         args: ["-l", "120"]
-  - repo: https://github.com/jumanjihouse/pre-commit-hooks
-    rev: 1.11.0
-    hooks:
-      - id: shellcheck
-        args: ["--color=always", "--shell=bash", "-x", "-a", "--exclude=SC1090"]
-        additional_dependencies: [shellcheck]
   - repo: local
     hooks:
       - id: tests

.pre-commit-hooks.yaml

@@ -7,41 +7,42 @@
   name: clang-format
   entry: clang-format-hook
   description: Formats C, C++, Objective-C, and Java code
-  files: \.(c|cc|cxx|cpp|h|hpp|hxx|m|mm|java)$
+  types_or: [c, c++, c#, objective-c, java]
   language: python
 - id: clang-tidy
   name: clang-tidy
   entry: clang-tidy-hook
   description: Find warnings/errors in C, C++, and Objective-C code
-  files: \.(c|cc|cxx|cpp|h|hpp|hxx|m)$
+  types_or: [c, c++, c#, objective-c]
   language: python
 - id: oclint
   name: oclint
   entry: oclint-hook
   description: Find warnings/errors in C, C++, and Objective-C code
-  files: \.(c|cc|cxx|cpp|h|hpp|hxx|m)$
+  types_or: [c, c++, c#, objective-c]
   language: python
 - id: uncrustify
   name: uncrustify
   entry: uncrustify-hook
   description: Formats C, C++, Objective-C, Java, D, and Vala code
-  files: \.(c|cc|cxx|cpp|h|hpp|hxx|m|mm|d|java|vala)$
+  # D, vala currently aren't valid file types. See https://github.com/pre-commit/identify/issues/258
+  types_or: [c, c++, c#, objective-c, java]
   language: python
 - id: cppcheck
   name: cppcheck
   entry: cppcheck-hook
   description: Find warnings/errors in C, C++, and Objective-C code
-  files: \.(c|cc|cxx|cpp|h|hpp|hxx|m)$
+  types_or: [c, c++, c#, objective-c]
   language: python
 - id: cpplint
   name: cpplint
   entry: cpplint-hook
   description: Find warnings/errors in C/CPP code
-  files: \.(c|cc|cpp|cu|cuh|cxx|h|hh|hpp|hxx)$
+  types_or:  [c, c++, c#, objective-c, cuda]
   language: python
 - id: include-what-you-use
   name: include-what-you-use
   entry: include-what-you-use-hook
   description: Runs Include-What-You-Use (iwyu) in C/CPP code
-  files: \.(c|cc|cxx|cpp|cu|h|hpp|hxx)$
+  types_or:  [c, c++, c#, objective-c, cuda]
   language: python

Makefile

@@ -4,16 +4,16 @@
 clean:
 	rm -rf dist *.egg-info
 
-test:
-	rm ~/.local/bin/*-hook && pip install . && pytest -x -vvv
+install:
+	rm ~/.local/bin/*-hook && pip3 install . --user
+
+test: install
+	pytest -x -vvv --pdb
 
 # Test with fresh installs of downloaded utilities
 test_fresh_installs:
 	./tests/run_tests.sh
 
-install:
-	pip3 install . --user
-
 upload: clean
 	python3 setup.py sdist
 	twine upload dist/* --verbose

hooks/clang_format.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 """Wrapper script for clang-format"""
 import sys
+from typing import List
 
 from hooks.utils import FormatterCmd
 
@@ -11,7 +12,7 @@ class ClangFormatCmd(FormatterCmd):
     command = "clang-format"
     lookbehind = "clang-format version "
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.check_installed()
         self.parse_args(args)
@@ -27,7 +28,7 @@ def run(self):
             sys.exit(self.returncode)
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = ClangFormatCmd(argv)
     cmd.run()
 

hooks/clang_tidy.py

@@ -2,6 +2,7 @@
 """Wrapper script for clang-tidy."""
 import re
 import sys
+from typing import List
 
 from hooks.utils import StaticAnalyzerCmd
 
@@ -12,7 +13,7 @@ class ClangTidyCmd(StaticAnalyzerCmd):
     command = "clang-tidy"
     lookbehind = "LLVM version "
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.parse_args(args)
         self.edit_in_place = "-fix" in self.args or "--fix-errors" in self.args
@@ -28,7 +29,7 @@ def run(self):
             self.exit_on_error()
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = ClangTidyCmd(argv)
     cmd.run()
 

hooks/cppcheck.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 """Wrapper script for cppcheck."""
 import sys
+from typing import List
 
 from hooks.utils import StaticAnalyzerCmd
 
@@ -11,7 +12,7 @@ class CppcheckCmd(StaticAnalyzerCmd):
     command = "cppcheck"
     lookbehind = "Cppcheck "
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.parse_args(args)
         # quiet for stdout purposes
@@ -32,7 +33,7 @@ def run(self):
             self.exit_on_error()
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = CppcheckCmd(argv)
     cmd.run()
 

hooks/cpplint.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 """Wrapper script for cpplint."""
 import sys
+from typing import List
 
 from hooks.utils import StaticAnalyzerCmd
 
@@ -11,7 +12,7 @@ class CpplintCmd(StaticAnalyzerCmd):
     command = "cpplint"
     lookbehind = "cpplint "
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.parse_args(args)
         self.add_if_missing(["--verbose=0"])
@@ -23,7 +24,7 @@ def run(self):
             self.exit_on_error()
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = CpplintCmd(argv)
     cmd.run()
 

hooks/include_what_you_use.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 """Wrapper for include-what-you-use"""
 import sys
+from typing import List
 
 from hooks.utils import StaticAnalyzerCmd
 
@@ -12,7 +13,7 @@ class IncludeWhatYouUseCmd(StaticAnalyzerCmd):
     command = "include-what-you-use"
     lookbehind = "include-what-you-use "
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.check_installed()
         self.parse_args(args)
@@ -32,7 +33,7 @@ def run(self):
                 sys.exit(self.returncode)
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = IncludeWhatYouUseCmd(argv)
     cmd.run()
 

hooks/oclint.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 """Wrapper script for oclint"""
 import os
+import sys
+from typing import List
 
 from hooks.utils import StaticAnalyzerCmd
 
@@ -11,7 +13,7 @@ class OCLintCmd(StaticAnalyzerCmd):
     command = "oclint"
     lookbehind = "OCLint version "
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.version = self.get_version_str()
         self.parse_args(args)
@@ -44,15 +46,15 @@ def run(self):
             self.cleanup_files(current_files)
 
     @staticmethod
-    def cleanup_files(existing_files):
+    def cleanup_files(existing_files: List[str]):
         """Delete the plist files that oclint generates."""
         new_files = os.listdir(os.getcwd())
         for filename in new_files:
             if filename not in existing_files and filename[-6:] == ".plist":
                 os.remove(filename)
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = OCLintCmd(argv)
     cmd.run()
 

hooks/uncrustify.py

@@ -4,6 +4,7 @@
 import re
 import subprocess as sp
 import sys
+from typing import List
 
 from hooks.utils import FormatterCmd
 
@@ -14,7 +15,7 @@ class UncrustifyCmd(FormatterCmd):
     command = "uncrustify"
     lookbehind = "[uU]ncrustify[- ]"
 
-    def __init__(self, args):
+    def __init__(self, args: List[str]):
         super().__init__(self.command, self.lookbehind, args)
         self.check_installed()
         self.parse_args(args)
@@ -49,7 +50,7 @@ def run(self):
             sys.exit(self.returncode)
 
 
-def main(argv=None):
+def main(argv: List[str] = sys.argv):
     cmd = UncrustifyCmd(argv)
     cmd.run()