| Name | clang-tidier JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | A simple runner for clang-tidy. |
| upload_time | 2024-11-19 15:10:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
c++
clang-tidy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 🎉️
Raw data
{
"_id": null,
"home_page": null,
"name": "clang-tidier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "c++, clang-tidy",
"author": null,
"author_email": "Mark Gillard <mark.gillard@outlook.com.au>",
"download_url": "https://files.pythonhosted.org/packages/91/53/c1810c8d1887e21beed9870c491669f25483b31faaad99f727702828cd1e/clang_tidier-0.4.1.tar.gz",
"platform": null,
"description": "# clang-tidier\r\n\r\nA simple `clang-tidy` runner for C and C++ projects.\r\n\r\n## Installation\r\n\r\n`clang-tidier` requires Python 3.8 or higher, as well as some version of `clang-tidy` visible on the system PATH.\r\n\r\n```\r\npip3 install clang-tidier\r\n```\r\n\r\n## Usage\r\n\r\n`clang-tidier` is a command-line application\r\n\r\n```\r\nusage: clang-tidier [-h] [--version] [--include <regex> [<regex> ...]] [--exclude <regex> [<regex> ...]]\r\n [--werror] [--threads <num>] [--session | --no-session] [compile_db]\r\n\r\nclang-tidy runner for C and C++ projects.\r\n\r\npositional arguments:\r\n compile_db path to compile_commands.json, or a directory containing it (default: discover automatically)\r\n\r\noptions:\r\n -h, --help show this help message and exit\r\n --version print the version and exit\r\n --include <regex> [<regex> ...]\r\n regular expression to select source files.\r\n --exclude <regex> [<regex> ...]\r\n regular expression to exclude source files.\r\n --werror stop on the first file that emits warnings\r\n --threads <num> number of threads to use.\r\n --session, --no-session\r\n saves run information so subsequent re-runs may avoid re-scanning files. (default: True)\r\n\r\nv0.3.0 - github.com/marzer/clang-tidier\r\n```\r\n\r\n## Exit codes\r\n\r\n| Value | Meaning |\r\n| :----------------------------------- | :--------------------- |\r\n| 0 | No issues were found |\r\n| `N`, where `N` is a positive integer | `N` issues were found |\r\n| -1 | A fatal error occurred |\r\n\r\n\r\n# Changelog\r\n\r\n## v0.4.1 - 2024/11/19\r\n\r\n- Fixed precompiled headers breaking runs in some circumstances\r\n- Improved wording of session restart message\r\n\r\n## v0.4.0 - 2024/09/07\r\n\r\n- Fixed sessions not restarting if `.clang-tidy` is modified\r\n- Added `--labels-only`\r\n- Minor performance improvements\r\n\r\n## v0.3.0 - 2024/08/04\r\n\r\n- Added `--no-session`\r\n- Added use of sessions by default\r\n\r\n## v0.2.0 - 2024/08/03\r\n\r\n- Added `--session`\r\n\r\n## v0.1.2 - 2024/06/06\r\n\r\n- Fixed build-generated translation causing 'did not exist or was not a file' errors\r\n- Improved performance of TU enumeration step\r\n\r\n## v0.1.1 - 2024/05/16\r\n\r\n- Fixed issues with older clang-tidy versions trying to use `--use-color`\r\n\r\n## v0.1.0 - 2024/05/09\r\n\r\n- First public release \ud83c\udf89️\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple runner for clang-tidy.",
"version": "0.4.1",
"project_urls": {
"Funding": "https://github.com/sponsors/marzer",
"Source": "https://github.com/marzer/clang-tidier",
"Tracker": "https://github.com/marzer/clang-tidier/issues"
},
"split_keywords": [
"c++",
" clang-tidy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "51b9635430cb9dd871d85f485023d221ec251cbdf9fdede3a7de070152b16fa3",
"md5": "160e266a86d5452d7a740fd7475ec671",
"sha256": "02285b020bf123dbd75eadff8127b69e472e8629f17e62cf5fede50e10a19a1c"
},
"downloads": -1,
"filename": "clang_tidier-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "160e266a86d5452d7a740fd7475ec671",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13939,
"upload_time": "2024-11-19T15:10:10",
"upload_time_iso_8601": "2024-11-19T15:10:10.187891Z",
"url": "https://files.pythonhosted.org/packages/51/b9/635430cb9dd871d85f485023d221ec251cbdf9fdede3a7de070152b16fa3/clang_tidier-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9153c1810c8d1887e21beed9870c491669f25483b31faaad99f727702828cd1e",
"md5": "34fb67d0295371aec56728b45e965c31",
"sha256": "ae7307ae23a77512552794aac802a586cc109c7a78a77005d23530cf433375a6"
},
"downloads": -1,
"filename": "clang_tidier-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "34fb67d0295371aec56728b45e965c31",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13358,
"upload_time": "2024-11-19T15:10:11",
"upload_time_iso_8601": "2024-11-19T15:10:11.787972Z",
"url": "https://files.pythonhosted.org/packages/91/53/c1810c8d1887e21beed9870c491669f25483b31faaad99f727702828cd1e/clang_tidier-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 15:10:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "marzer",
"github_not_found": true,
"lcname": "clang-tidier"
}
