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.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-tidy
is 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
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.4.1.tar.gz
(13.4 kB
view details)
Built Distribution
File details
Details for the file clang_tidier-0.4.1.tar.gz
.
File metadata
- Download URL: clang_tidier-0.4.1.tar.gz
- Upload date:
- Size: 13.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae7307ae23a77512552794aac802a586cc109c7a78a77005d23530cf433375a6 |
|
MD5 | 34fb67d0295371aec56728b45e965c31 |
|
BLAKE2b-256 | 9153c1810c8d1887e21beed9870c491669f25483b31faaad99f727702828cd1e |
File details
Details for the file clang_tidier-0.4.1-py3-none-any.whl
.
File metadata
- Download URL: clang_tidier-0.4.1-py3-none-any.whl
- Upload date:
- Size: 13.9 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 | 02285b020bf123dbd75eadff8127b69e472e8629f17e62cf5fede50e10a19a1c |
|
MD5 | 160e266a86d5452d7a740fd7475ec671 |
|
BLAKE2b-256 | 51b9635430cb9dd871d85f485023d221ec251cbdf9fdede3a7de070152b16fa3 |