Skip to main content

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>] [--resumable] [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.
  --resumable           saves run information so subsequent re-runs may avoid re-scanning files.

v0.2.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.2.0 - 2024/08/04

  • Added --resumable

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.2.0.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

clang_tidier-0.2.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file clang_tidier-0.2.0.tar.gz.

File metadata

  • Download URL: clang_tidier-0.2.0.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for clang_tidier-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b9273b0605e8968e9fe29ae7978a034b54002079b692e474161ae4252ac52293
MD5 9bcb4a4187a87cfce6083e612f12697e
BLAKE2b-256 a5944caa883744bbc68e92405481f21b8da02b1176c11644b4f0d5269d7a0027

See more details on using hashes here.

File details

Details for the file clang_tidier-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for clang_tidier-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4fdb27c9e938cd2ef75053a7a560fe93d06bb15ecbcbe37833a3341cdfe511c8
MD5 dbb653c6ae078e35195c941c9c7a0b92
BLAKE2b-256 a2f42582de7a418570fdb7cea2053607bcdc4cf57a3d4968d627981db54b1a89

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page