CMakeLint

cmakelint解析CMake文件并报告样式问题。

cmakelint需要Python。

安装

要从PyPI安装cmakelint，请运行

.. 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=选项以查看可用选项。目前这些是

convention/filename
linelength
package/consistency
readability/logic
readability/mixedcase
readability/wonkycase
syntax
whitespace/eol
whitespace/extra
whitespace/indent
whitespace/mismatch
whitespace/newline
whitespace/tabs

一个示例 .cmakelintrc 文件可能如下所示

filter=-whitespace/indent

将此文件放在您的家目录中，运行以下命令会产生相同的效果

cmakelint.py CMakeLists.txt
cmakelint.py --filter=-whitespace/indent CMakeLists.txt

过滤器可以可选地从CMake文件内部直接启用/禁用，覆盖文件或CLI参数的配置

# lint_cmake: <+ or -><filter name>
# e.g.:
# lint_cmake: -readability/wonkycase
# add multiple filters as list:
# lint_cmake: <+/-><filter1>, <+/-><filter2>

cmakelint还可以与pre-commit一起运行。将以下配置块添加到您的 .pre-commit-config.yaml

  - repo: https://github.com/cmake-lint/cmake-lint
    hooks:
      - id: cmakelint

输出状态码

程序应使用以下状态码退出

• 如果一切正常，则为0
• 如果发出错误消息，则为1
• 在用法错误时为32