A simple linter for CMake.
Project description
check-cmake
A simple linter for CMake.
Installation
check-cmake
requires Python 3.8 or higher.
pip3 install check-cmake
Usage
check-cmake
is a command-line application
usage: check-cmake [-h] [-v] [--version] [--recurse | --no-recurse] [--limit LIMIT] [root]
CMake checker for C and C++ projects.
positional arguments:
root path to the project root (default: .)
options:
-h, --help show this help message and exit
-v, --verbose enable verbose output
--version print the version and exit
--recurse, --no-recurse
recurse into subfolders (default: True)
--limit LIMIT maximum errors to emit (default: 0)
v0.3.0 - github.com/marzer/check_cmake
Exit codes
Value | Meaning |
---|---|
0 | No issues were found |
N , where N is a positive integer |
N issues were found in total |
-1 | A fatal error occurred |
Example output
error: /my_lib/CMakeLists.txt:29:9: language standard level should be set on a per-target basis using target_compile_features()
Context:
29 | set_target_properties(
30 | my_lib
31 | PROPERTIES
32 | CXX_STANDARD 14
33 | CXX_STANDARD_REQUIRED ON
34 | CXX_EXTENSIONS OFF
35 | )
Replace with:
target_compile_features(): https://cmake.org/cmake/help/latest/command/target_compile_features.html
More information:
CMAKE_CXX_KNOWN_FEATURES: https://cmake.org/cmake/help/latest/prop_gbl/CMAKE_CXX_KNOWN_FEATURES.html
CMAKE_C_KNOWN_FEATURES: https://cmake.org/cmake/help/latest/prop_gbl/CMAKE_C_KNOWN_FEATURES.html
found 1 error in 1 file.
Suppressing checks
Checks can be suppressed using comment-based 'pragmas' at the end of the source line:
set_target_properties(
my_lib
PROPERTIES
CXX_STANDARD 14 # nocheck
CXX_STANDARD_REQUIRED ON
CXX_EXTENSIONS OFF
)
For compatibility with other tools, any the following will also work:
# nolint
# check-cmake ignore
# lint-cmake ignore
# cmake-check ignore
# cmake-lint ignore
# check-cmake disable
# lint-cmake disable
# cmake-check disable
# cmake-lint disable
# check-cmake: ignore
# lint-cmake: ignore
# cmake-check: ignore
# cmake-lint: ignore
# check-cmake: disable
# lint-cmake: disable
# cmake-check: disable
# cmake-lint: disable
Changelog
v0.4.0
- Fixed line numbers sometimes being wrong in context snippets
- Added check for incorrectly-placed
SYSTEM
intarget_include_directories()
- Added check for extraneous space in
ExternalProject_Add()
CMAKE_ARGS
v0.3.0
- Fixed
#nocheck
v0.2.0
- Added pragmas for ignoring checks on a line
- Added check for
cmake_minimum_required()
whenproject()
is present - Fixed minor formatting issues
v0.1.0
- 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
check_cmake-0.4.0.tar.gz
(15.2 kB
view hashes)
Built Distribution
Close
Hashes for check_cmake-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec200077ca2363b3579b15eee1a33f15700e20ffb54f453e6580d902b0c62808 |
|
MD5 | d344c44bb634fcd207b244755e5eef89 |
|
BLAKE2b-256 | 10bdef45a3a657a9e482a550c03a4a989c7c37750a2dce88c54cfb82a8f05a4c |