cmake tidy

Cmake-tidy

目录

• 1。简介
• 2。应用使用情况
  • 2.1。 format子命令
  • 2.2。 analyze子命令
• 3。已知限制/错误
• 4。其他信息
  • 4.1。安装
  • 4.2。 CI状态

1。简介

项目的目的是提供一组工具，以减轻CMake编写的构建系统代码的开发过程。该工具的主要思想是但不限于：

• CMake代码格式 - 基于语言语法分析

• 现代CMake静态分析 - 可能自动固定的基本代码分析。

• 配置的灵活性很大 - 编码样式有很大差异。

• 易于使用 - 与其他最先进的工具模拟使用和参数，以减少用户学习曲线。

2。应用使用情况

cmake-tidy是python3编写的命令行应用程序。

可用的子命令：

 usage: cmake-tidy [-h] {format} ...

optional arguments:
  -h, --help  show this help message and exit

sub-commands:
  {format}    see "cmake-tidy <command> --help" to read more about a specific
              sub-command.
    format    format file to align it to standard

2.1。 format子命令

2.1.1。用法

 usage: cmake-tidy format [-h] [--dump-config] [-i] [--diff] [--verbose]
                         [input [input ...]]

positional arguments:
  input          CMake file to be formatted

optional arguments:
  -h, --help     show this help message and exit
  --dump-config  Dump to stdout current settings. Script tries to read
                 settings from `.cmake-tidy.json` or provides default
                 settings. Precedence of searching `.cmake-tidy.json` is
                 described on github
  -i, --inplace  Inplace edit specified <input_data> file
  --diff         Print to stdout unified diff between original file and
                 formatted version.
  --verbose      Print to stdout information about formatted file 

2.1.2。配置

用户可以通过提供自定义.cmake-tidy.json文件为应用程序提供替代设置。有关可用参数和值的更多信息，请访问此处。

2.2。 analyze子命令

引言正在进行中。

3。已知限制/错误

• 应用程序只能格式化有效的cmake文件（语法错误导致应用程序退出而无需修改格式文件的内容）。

• 支持旧版本的--version的deprecated关键字/属性的支持可能有限。如果您需要支持它们，请提供拉动请求或将它们指定为.cmake-tidy.json配置文件中的自定义关键字。

• 线延续处理未实施。

4。其他信息

4.1。安装

该工具可通过命令通过python软件包索引提供：

python3 -m pip install cmake-tidy

为了确认安装成功，您可以运行：

cmake-tidy -v

4.2。 CI状态

自动测试是通过工作流进行的：

• ubuntu-lastest, python-3.8

• windows-lastest, python-3.8