First commit

Author: shenxianpeng

.github/workflows/add-tag.yml

@@ -0,0 +1,24 @@
+name: "Tag"
+
+on:
+  push:
+    branches: main
+    paths: '**.py'
+  pull_request:
+    branches: main
+    paths: '**.py'
+  workflow_dispatch:
+
+jobs:
+  add-tag:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: retag latest commit for testing
+        run: |
+          git config user.name 'github-actions'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          git push --delete origin latest || true
+          git tag -a latest -m 'Retag latest commit'
+          git push origin latest

.gitignore

@@ -0,0 +1,3 @@
+build
+dist
+cpp_linter_hooks.egg-info

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/shenxianpeng/cpp-linter-hooks
+    rev: latest
+    hooks:
+      - id: clang-format
+        verbose: true
+        args: [--style=Google, --version=13]

.pre-commit-hooks.yaml

@@ -0,0 +1,34 @@
+---
+# This file tells https://pre-commit.com/ which hooks
+# are provided by this repo for use by other git repos.
+
+- id: clang-format
+  name: clang-format
+  description: Automatically run `clang-format` against C/C++ source code
+  entry: clang-format
+  language: python
+  files: \.(h\+\+|h|hh|hxx|hpp|c|cc|cpp|c\+\+|cxx)$
+  types_or: [c, c++, c#, objective-c]
+
+# - id: clang-tidy
+#   name: clang-tidy
+#   description: Run `clang-tidy` against C/C++ code to find warnings/errors
+#   language: python
+#   files: \.(h\+\+|h|hh|hxx|hpp|c|cc|cpp|c\+\+|cxx)$
+#   types_or: [c, c++, c#, objective-c]
+#   entry: clang-tidy
+
+# - id: docker-clang-format
+#   name: clang-format
+#   description: Run `clang-format` against C/C++ source code in Docker container
+#   language: docker
+#   files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
+#   entry: clang-format -i
+#   args: ["-style=Google"]
+  
+# - id: docker-clang-tidy
+#   name: clang-tidy
+#   description: Run `clang-tidy` against C/C++ code to find warnings/errors in Docker container
+#   language: docker
+#   types_or: [c, c++, c#, objective-c]
+#   entry: clang-tidy

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Peter Shen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,18 @@
+# C/C++ linter hooks for pre-commit
+
+Linter your C/C++ code with `clang-format` and `clang-tidy` for [pre-commit](https://pre-commit.com/).
+
+**Automaticlly install `clang-format` and `clang-tidy`** when they do not exist.
+
+## Usage
+
+For example
+
+```yaml
+repos:
+  - repo: https://github.com/shenxianpeng/cpp-linter-hooks
+    hooks:
+      - id: clang-format
+        args: ["--style=Google", "--version=14"]
+      - id: clang-tidy
+```

cpp_linter_hooks/__init__.py

@@ -0,0 +1,14 @@
+import sys
+from cpp_linter_hooks.util import get_expect_version, check_installed
+
+
+clang_tools = ['clang-format', 'clang-tidy']
+args = list(sys.argv[1:])
+
+expect_version = get_expect_version(args)
+
+for tool in clang_tools:
+    if expect_version:
+        check_installed(tool, version=expect_version)
+    else:
+        check_installed(tool)

cpp_linter_hooks/clang_format.py

@@ -0,0 +1,26 @@
+import subprocess
+from cpp_linter_hooks import args, expect_version
+
+
+def run_clang_format(args) -> int:
+    if expect_version:
+        command = [f'clang-format-{expect_version}', '-i']
+    else:
+        command = ["clang-format", '-i']
+    for arg in args:
+        if arg == expect_version or arg.startswith("--version"):
+            continue
+        command.append(arg)
+    try:
+        subprocess.run(command, stdout=subprocess.PIPE)
+        return 0
+    except FileNotFoundError:
+        return 1
+
+
+def main() -> int:
+    run_clang_format(args)
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

cpp_linter_hooks/clang_tidy.py

@@ -0,0 +1,2 @@
+def clang_tidy(*args) -> None:
+    pass

cpp_linter_hooks/util.py

@@ -0,0 +1,22 @@
+import subprocess
+
+
+def check_installed(tool, version='13'):
+    command = [f'{tool}-{version} ', '--version']
+    try:
+        subprocess.run(command, stdout=subprocess.PIPE)
+    except FileNotFoundError:
+        # clang-tools exist because install_requires=['clang-tools'] in setup.py
+        subprocess.run(['clang-tools', '-i', version], stdout=subprocess.PIPE)
+
+
+def get_expect_version(args):
+    for arg in args:
+        if arg.startswith("--version") :  # expect specific clang-tools version.
+            # If --version is passed in as 2 arguments, the second is version
+            if arg == "--version" and args.index(arg) != len(args) - 1:
+                expect_version = args[args.index(arg) + 1]
+            # Expected split of --version=14 or --version 14
+            else:
+                expect_version = arg.replace(" ", "").replace("=", "").replace("--version", "")
+            return expect_version