feat: v1.1.0

.github/workflows/format.yml

@@ -4,6 +4,8 @@ on:
   workflow_dispatch:
   pull_request:
   push:
+    branches:
+      - master
 
 jobs:
   python-black:
@@ -12,4 +14,4 @@ jobs:
       - uses: actions/checkout@v4
       - uses: psf/black@stable
         with: # see: https://black.readthedocs.io/en/stable/integrations/github_actions.html
-          version: "~= 24.0"
+          version: "~= 25.0"

.github/workflows/python.yml

@@ -0,0 +1,23 @@
+name: python
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  basedpyright:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run basedpyright
+        run: uv run basedpyright **/*.py

.gitignore

@@ -1,6 +1,9 @@
 # Packages
 /clangd_tidy/_dist_ver.py
 
+# uv
+uv.lock
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -15,6 +15,7 @@ Unfortunately, there seems to be no plan within LLVM to accelerate the standalon
 - clangd-tidy is significantly faster than clang-tidy (over 10x in my experience).
 - clangd-tidy can check header files individually, even if they are not included in the compilation database.
 - clangd-tidy groups diagnostics by files -- no more duplicated diagnostics from the same header!
+- clangd-tidy provides an optional code format checking feature, eliminating the need to run clang-format separately.
 - clangd-tidy supports [`.clangd` configuration files](https://clangd.llvm.org/config), offering features not supported by clang-tidy.
   - Example: Removing unknown compiler flags from the compilation database.
     ```yaml
@@ -29,19 +30,22 @@ Unfortunately, there seems to be no plan within LLVM to accelerate the standalon
       # Require clangd-17
       MissingIncludes: Strict
     ```
+- Hyperlinks on diagnostic check names in supported terminals.
 - Refer to [Usage](#usage) for more features.
 
 **Cons:**
 
 - clangd-tidy lacks support for the `--fix` option. (Consider using code actions provided by your editor if you have clangd properly configured, as clangd-tidy is primarily designed for speeding up CI checks.)
-- clangd-tidy silently disables [several](https://searchfox.org/llvm/rev/cb7bda2ace81226c5b33165411dd0316f93fa57e/clang-tools-extra/clangd/TidyProvider.cpp#199-227) checks not supported by clangd.
+- clangd-tidy silently disables [several](https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/clangd/TidyProvider.cpp#L197) checks not supported by clangd.
 - Diagnostics generated by clangd-tidy might be marginally less aesthetically pleasing compared to clang-tidy.
+- Other known discrepancies between clangd and clang-tidy behavior: #7, #15, #16.
 
 ## Prerequisites
 
 - [clangd](https://clangd.llvm.org/)
 - Python 3.8+ (may work on older versions, but not tested)
-- [tqdm](https://github.com/tqdm/tqdm) (optional)
+- [attrs](https://www.attrs.org/) and [cattrs](https://catt.rs/) (automatically installed if clangd-tidy is installed via pip)
+- [tqdm](https://github.com/tqdm/tqdm) (optional, required for progress bar support)
 
 ## Installation
 
@@ -51,65 +55,121 @@ pip install clangd-tidy
 
 ## Usage
 
+### clang-tidy
+
 ```
-usage: clangd-tidy [-h] [-p COMPILE_COMMANDS_DIR] [-j JOBS] [-o OUTPUT]
-                   [--clangd-executable CLANGD_EXECUTABLE]
-                   [--allow-extensions ALLOW_EXTENSIONS]
-                   [--fail-on-severity SEVERITY] [--tqdm] [--github]
+usage: clangd-tidy [--allow-extensions ALLOW_EXTENSIONS]
+                   [--fail-on-severity SEVERITY] [-f] [-o OUTPUT]
+                   [--line-filter LINE_FILTER] [--tqdm] [--github]
                    [--git-root GIT_ROOT] [-c] [--context CONTEXT]
                    [--color {auto,always,never}] [-v]
+                   [-p COMPILE_COMMANDS_DIR] [-j JOBS]
+                   [--clangd-executable CLANGD_EXECUTABLE]
+                   [--query-driver QUERY_DRIVER] [-V] [-h]
                    filename [filename ...]
 
 Run clangd with clang-tidy and output diagnostics. This aims to serve as a
 faster alternative to clang-tidy.
 
-positional arguments:
-  filename              Files to check. Files whose extensions are not in
-                        ALLOW_EXTENSIONS will be ignored.
-
-options:
-  -h, --help            show this help message and exit
-  -V, --version         show program's version number and exit
-  -p COMPILE_COMMANDS_DIR, --compile-commands-dir COMPILE_COMMANDS_DIR
-                        Specify a path to look for compile_commands.json. If
-                        the path is invalid, clangd will look in the current
-                        directory and parent paths of each source file.
-                        [default: build]
-  -j JOBS, --jobs JOBS  Number of async workers used by clangd. Background
-                        index also uses this many workers. [default: 1]
-  -o OUTPUT, --output OUTPUT
-                        Output file for diagnostics. [default: stdout]
-  --clangd-executable CLANGD_EXECUTABLE
-                        Path to clangd executable. [default: clangd]
+input options:
+  filename              Files to analyze. Ignores files with extensions not
+                        listed in ALLOW_EXTENSIONS.
   --allow-extensions ALLOW_EXTENSIONS
                         A comma-separated list of file extensions to allow.
                         [default: c,h,cpp,cc,cxx,hpp,hh,hxx,cu,cuh]
+
+check options:
   --fail-on-severity SEVERITY
-                        On which severity of diagnostics this program should
-                        exit with a non-zero status. Candidates: error, warn,
-                        info, hint. [default: hint]
+                        Specifies the diagnostic severity level at which the
+                        program exits with a non-zero status. Possible values:
+                        error, warn, info, hint. [default: hint]
+  -f, --format          Also check code formatting with clang-format. Exits
+                        with a non-zero status if any file violates formatting
+                        rules.
+
+output options:
+  -o OUTPUT, --output OUTPUT
+                        Output file for diagnostics. [default: stdout]
+  --line-filter LINE_FILTER
+                        A JSON with a list of files and line ranges that will
+                        act as a filter for diagnostics. Compatible with
+                        clang-tidy --line-filter parameter format.
   --tqdm                Show a progress bar (tqdm required).
   --github              Append workflow commands for GitHub Actions to output.
-  --git-root GIT_ROOT   Root directory of the git repository. Only works with
-                        --github. [default: current directory]
+  --git-root GIT_ROOT   Specifies the root directory of the Git repository.
+                        Only works with --github. [default: current directory]
   -c, --compact         Print compact diagnostics (legacy).
   --context CONTEXT     Number of additional lines to display on both sides of
                         each diagnostic. This option is ineffective with
                         --compact. [default: 2]
   --color {auto,always,never}
                         Colorize the output. This option is ineffective with
                         --compact. [default: auto]
-  -v, --verbose         Show verbose output from clangd.
+  -v, --verbose         Stream verbose output from clangd to stderr.
+
+clangd options:
+  -p COMPILE_COMMANDS_DIR, --compile-commands-dir COMPILE_COMMANDS_DIR
+                        Specify a path to look for compile_commands.json. If
+                        the path is invalid, clangd will look in the current
+                        directory and parent paths of each source file.
+                        [default: build]
+  -j JOBS, --jobs JOBS  Number of async workers used by clangd. Background
+                        index also uses this many workers. [default: 1]
+  --clangd-executable CLANGD_EXECUTABLE
+                        Clangd executable. [default: clangd]
+  --query-driver QUERY_DRIVER
+                        Comma separated list of globs for white-listing gcc-
+                        compatible drivers that are safe to execute. Drivers
+                        matching any of these globs will be used to extract
+                        system includes. e.g.
+                        `/usr/bin/**/clang-*,/path/to/repo/**/g++-*`.
+
+generic options:
+  -V, --version         Show program's version number and exit.
+  -h, --help            Show this help message and exit.
 
 Find more information on https://github.com/lljbash/clangd-tidy.
 ```
 
+### clangd-tidy-diff
+
+```
+usage: clangd-tidy-diff [-h] [-V] [-p COMPILE_COMMANDS_DIR]
+                        [--pass-arg PASS_ARG]
+
+Run clangd-tidy on modified files, reporting diagnostics only for changed lines.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -V, --version         show program's version number and exit
+  -p COMPILE_COMMANDS_DIR, --compile-commands-dir COMPILE_COMMANDS_DIR
+                        Specify a path to look for compile_commands.json. If
+                        the path is invalid, clangd-tidy will look in the
+                        current directory and parent paths of each source
+                        file.
+  --pass-arg PASS_ARG   Pass this argument to clangd-tidy (can be used
+                        multiple times)
+
+Receives a diff on stdin and runs clangd-tidy only on the changed lines.
+This is useful to slowly onboard a codebase to linting or to find regressions.
+Inspired by clang-tidy-diff.py from the LLVM project.
+
+Example usage with git:
+    git diff -U0 HEAD^^..HEAD | clangd-tidy-diff -p my/build
+
+```
+
 ## Acknowledgement
 
-Special thanks to [@yeger00](https://github.com/yeger00) for his [pylspclient](https://github.com/yeger00/pylspclient).
+Special thanks to [@yeger00](https://github.com/yeger00) for his [pylspclient](https://github.com/yeger00/pylspclient), which inspired earlier versions of this project.
 
 A big shoutout to [clangd](https://clangd.llvm.org/) and [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) for their great work!
 
-Claps to [@ArchieAtkinson](https://github.com/ArchieAtkinson) for his artistic flair in the fancy diagnostic formatter.
+Claps to
+- [@ArchieAtkinson](https://github.com/ArchieAtkinson) for his artistic flair in the fancy diagnostic formatter.
+- [@jmpfar](https://github.com/jmpfar) for his contribution to hyperlink support and `clangd-tidy-diff`.
+- And all other contributors who have helped improve this project:
+    [@mateosss](https://github.com/mateosss)
+    [@kammce](https://github.com/kammce)
 
 Contributions are welcome! Feel free to open an issue or a pull request.

clangd_tidy/__init__.py

@@ -1,4 +1,5 @@
+from .clangd_tidy_diff_cli import clang_tidy_diff
 from .main_cli import main_cli
 from .version import __version__
 
-__all__ = ["main_cli", "__version__"]
+__all__ = ["main_cli", "clang_tidy_diff", "__version__"]