A simple runner for clang-tidy.
Project description
clang-tidier
A simple clang-tidy runner for C and C++ projects.
Installation
clang-tidier requires Python 3.8 or higher, as well as some version of clang-tidy visible on the system PATH.
pip3 install clang-tidier
Usage
clang-tidier is a command-line application
usage: clang-tidier [-h] [--version] [--include <regex> [<regex> ...]] [--exclude <regex> [<regex> ...]]
[--werror] [--threads <num>] [--session | --no-session] [compile_db]
clang-tidy runner for C and C++ projects.
positional arguments:
compile_db path to compile_commands.json, or a directory containing it (default: discover automatically)
options:
-h, --help show this help message and exit
--version print the version and exit
--include <regex> [<regex> ...]
regular expression to select source files.
--exclude <regex> [<regex> ...]
regular expression to exclude source files.
--werror stop on the first file that emits warnings
--threads <num> number of threads to use.
--session, --no-session
saves run information so subsequent re-runs may avoid re-scanning files. (default: True)
v0.3.0 - github.com/marzer/clang-tidier
Exit codes
| Value | Meaning |
|---|---|
| 0 | No issues were found |
N, where N is a positive integer |
N issues were found |
| -1 | A fatal error occurred |
Changelog
v0.5.1 - 2025/01/29
- Fixed sanitizer and GCC flags breaking clang-tidy in some common cases
v0.5.0 - 2025/01/27
- Added
--batch x/yto enable distributed parallelism - Minor internal fixes
v0.4.1 - 2024/11/19
- Fixed precompiled headers breaking runs in some circumstances
- Improved wording of session restart message
v0.4.0 - 2024/09/07
- Fixed sessions not restarting if
.clang-tidyis modified - Added
--labels-only - Minor performance improvements
v0.3.0 - 2024/08/04
- Added
--no-session - Added use of sessions by default
v0.2.0 - 2024/08/03
- Added
--session
v0.1.2 - 2024/06/06
- Fixed build-generated translation causing 'did not exist or was not a file' errors
- Improved performance of TU enumeration step
v0.1.1 - 2024/05/16
- Fixed issues with older clang-tidy versions trying to use
--use-color
v0.1.0 - 2024/05/09
- First public release 🎉️
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
clang_tidier-0.5.1.tar.gz
(14.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file clang_tidier-0.5.1.tar.gz.
File metadata
- Download URL: clang_tidier-0.5.1.tar.gz
- Upload date:
- Size: 14.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d2bc76251fca6348fb62242e821d3ce78ee2b435373e6e5be6b22e103cc46455
|
|
| MD5 |
cf97a2d5da3190c82e9b71f0fdc5f183
|
|
| BLAKE2b-256 |
9c64097539bbd4fdb2e20edeba9c70b846c2fe7086079e0c190d872b8a9f54ad
|
File details
Details for the file clang_tidier-0.5.1-py3-none-any.whl.
File metadata
- Download URL: clang_tidier-0.5.1-py3-none-any.whl
- Upload date:
- Size: 14.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aef91d02d80c2242711445d6e10c4d6238c9969bfb692622e2e63784baa29d7f
|
|
| MD5 |
860aee8f542fd784163a4b678eb52c01
|
|
| BLAKE2b-256 |
3729bdc6d8fef7f75c182574b69e795f3531c123938c5bc20d5e21725c5e3bb7
|