指南

安装

您可以通过以下几种方式安装此工具：

使用预构建包

从发布页面下载适用于您平台的预构建包。

从源代码构建

按照本文档的构建部分中的构建说明进行操作。

命令行使用

此工具根据 GJB-8114 编码标准为 C/C++ 代码提供静态分析检查。使用 clang-tidy 运行它：

1clang-tidy your_file.cpp -checks='-*,gjb8114-*' -load='/path/to/libclang-tidy-gjb8114.so'

还可以通过创建 .clang-tidy 配置文件将其与的构建系统集成。

规则的命名约定为 gjb8114-[准则编号]，例如：

• gjb8114-r-1-1-1：禁止宏定义覆盖关键字
• gjb8114-r-1-1-10：禁止有符号位域的位宽等于 1

list-checks 命令可以列出所有可用的检查：

1clang-tidy -list-checks -checks='-*,gjb8114-*' -load='/path/to/libclang-tidy-gjb8114.so'

或者查看文档以获取更多信息。

开发说明

搭建开发环境

前置要求

• cmake，版本3.23或更高
• llvm
• ruby gems

macOS

安装前置要求：

1brew install llvm

构建

构建项目最简单的方法是使用CMake预设。

1cmake --preset=debug
2cmake --build --preset=debug

将--preset=debug更改为--preset=release以进行发布构建。

运行测试

Cucumber 测试

项目包含 Cucumber 测试以验证插件行为。

安装项目依赖

1bundle install  # 安装Gemfile中所需的Ruby gems

运行测试

使用默认配置文件运行（自动检测路径）

1bundle exec rake cucumber

使用默认配置文件运行（使用环境变量覆盖路径）

1CLANG_TIDY_PATH=/path/to/clang-tidy BIN_DIR=/build/release bundle exec rake cucumber