Static code checker for CMake files
cmakelint parses CMake files and reports style issues.
cmakelint requires Python.
To install cmakelint from PyPI, run:
.. code-block:: bash
$ pip install cmakelint
Syntax: cmakelint [--config=file] [--filter=-x,+y] <file> [file] ... filter=-x,+y,... Specify a comma separated list of filters to apply config=file Use the given file for configuration. By default the file $PWD/.cmakelintrc, ~/.config/cmakelintrc, $XDG_CONFIG_DIR/cmakelintrc or ~/.cmakelintrc is used if it exists. Use the value "None" to use no configuration file (./None for a file called literally None) Only the option "filter=" is currently supported in this file.
--filter= option with no filter to see available options. Currently
convention/filename linelength package/consistency readability/logic readability/mixedcase readability/wonkycase syntax whitespace/eol whitespace/extra whitespace/indent whitespace/mismatch whitespace/newline whitespace/tabs
An example .cmakelintrc file would be as follows:
With this file in your home directory, running these commands would have the same effect:
cmakelint.py CMakeLists.txt cmakelint.py --filter=-whitespace/indent CMakeLists.txt
cmakelint can also be run with pre-commit. Add the following configuration block to your
- repo: https://github.com/cmake-lint/cmake-lint hooks: - id: cmakelint
Output status codes
The program should exit with the following status codes:
- 0 if everything went fine
- 1 if an error message was issued
- 32 on usage error
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
cmakelint-1.4.2.tar.gz (69.5 kB view hashes)
cmakelint-1.4.2-py3-none-any.whl (13.4 kB view hashes)
Hashes for cmakelint-1.4.2-py3-none-any.whl