Wrapper to invoke code linters through ccache to accelerate analysis as part of a regular compile job.
Use by simply putting linter-cache before the actual linting command.
This was originally started as cache-tidy.py in mz-cmaketools but moved to a dedicated C++ project as ccache expects compilers to have .exe and not .py as extension on Windows and the startup times for python were found to be too slow sometimes.
While there is other caching implementations like cltcache or clang-tidy-cache these have the downside that they create separate caches. The goal of this project is to achieve acceleration through caching but reusing the setup already made for ccache including its remote capabilities.
Currently supported and tested linters:
- clang-tidy
CMake is used as the build system wrapped with my mz-cmaketools for convenience.
These get pulled as git submodule so make sure to run git submodule update --init before trying to build.
Make sure you have cmake, g++ and ninja installed and available in your path. Use cmake to configure and build the project:
mkdir build/release
cd build/release
cmake -G Ninja -D CMAKE_BUILD_TYPE=Release -S ../.. -B .
cmake --build .In case you find that dependencies are missing you can use Conan 1.x to pull them automatically. Note that Conan 2
is untested and not supported at this point. Make sure you have conan installed and in your path, then run:
MZ_USE_CONAN=true cmake -G Ninja -D CMAKE_BUILD_TYPE=Release -S ../.. -B .
cmake --build .The resulting binaries can be found in the bin directory of the build folder created above.
Simply replace your calls to clang-tidy in your build scripts with calls to the
linter-cache binary and pass --clang-tidy <your clang-tidy path>
to switch to clang-tidy mode and have your linting cached.
For example a call clang-tidy -p _build/compile_commands.json src/main.cpp becomes
linter-cache --clang-tidy=clang-tidy -p _build/compile_commands.json src/main.cpp
We welcome any contributions.
We use GitHub to handle bug reports, feature requests and questions - please use "issues" for any of these. Code changes and documentation improvements get handled via pull requests.
In order to foster open exchange, all communication should happen using the English language.
Any changes to this repository get done via GitHub's standard workflow. See GitHub's First Contributions document for an introduction.
This project is using mz-lictools to manage all license headers which will also automatically add an attribution to the top of a file you edit.
Also see the list of contributors generated by Github.
This project is licensed under the Apache 2.0 License.