在 C++ 代码中使用 clang-tidy
clang-tidy
是一种工具,用于自动检查 C/C++/Objective-C 代码的样式违规、编程错误和最佳实践。
Electron 的 clang-tidy
集成作为 linter 脚本提供,可以使用 npm run lint:clang-tidy
运行。虽然 clang-tidy
检查磁盘上的文件,但您需要构建 Electron 以便它知道使用了哪些编译器标志。脚本有一个必需的选项 --output-dir
,它告诉脚本从哪个构建目录中提取编译信息。典型用法如下:npm run lint:clang-tidy --out-dir ../out/Testing
如果没有提供文件名,则将检查所有 C/C++/Objective-C 文件。您可以通过在选项后传递文件名来提供要检查的文件列表:npm run lint:clang-tidy --out-dir ../out/Testing shell/browser/api/electron_api_app.cc
虽然 clang-tidy
有一个 很长的检查列表,但在 Electron 中默认情况下只启用了几个检查。目前 Electron 没有 .clang-tidy
配置文件,因此 clang-tidy
将找到 Chromium 中的 src/.clang-tidy
文件并使用 Chromium 已启用的检查。您可以使用 --checks=
选项更改运行的检查。此选项直接传递给 clang-tidy
,因此请参阅其文档以获取完整详细信息。可以使用通配符,并且可以通过在前面添加 -
来禁用检查。默认情况下,列出的任何检查都会添加到 .clang-tidy
中的检查,因此如果您想将检查限制为特定的检查,则应首先排除所有检查,然后添加您想要的检查,例如 --checks=-*,performance*
。
运行 clang-tidy
相当缓慢 - 在内部,它会编译每个文件,然后运行检查,因此它始终比编译慢一些。虽然您可以使用 --jobs|-j
选项使用并行运行来加快速度,但 clang-tidy
在检查期间也会使用大量内存,因此很容易出现内存不足错误。因此,默认作业数为 1。