SublimeLinter-contrib-clang-tidy

此针对SublimeLinter的代码检查器插件提供了对clang-tidy的接口。它将用于具有<强>C、<强>C++、<强>Objective-C或<强>Objective-C++语法的文件。

安装

要使用此插件，必须安装SublimeLinter 3。如果尚未安装SublimeLinter 3，请按照以下安装指南进行操作。

代码检查器安装

在使用此插件之前，您必须确保系统中已安装clang-tidy。要安装clang-tidy，请按照以下步骤操作

1. 在终端中键入以下内容以安装clang-tidy

   $ brew install llvm  # OSX
   

或

```bash
$ sudo apt install clang-tidy  # Ubuntu 16.04

```

此插件在Windows上未经测试。

1. 确保您为项目拥有一个<强>编译数据库（参见设置部分）

2. 确保您的项目有一个.clang-tidy配置文件。该.clang-tidy文件应该位于项目的根目录中。请阅读此博客文章了解如何创建.clang-tidy文件。

注意：此插件需要clang-tidy <强>1.0或更高版本。

代码检查器配置

为了使clang-tidy可以通过SublimeLinter执行，您必须确保其路径对SublimeLinter可用。在继续之前，请阅读并在文档中遵循“查找代码检查器可执行文件”部分中“验证您的PATH”部分的步骤。

在安装并配置好 clang-tidy 之后，如果还未安装，您可以继续安装 SublimeLinter-contrib-clang-tidy 插件。

插件安装

请使用 Package Control 来安装代码检查插件。这将确保在有新版本可用时，插件会自动更新。如果您想从源代码安装以便修改源代码，您可能很清楚自己要做什么，所以我们在这里不涉及这一点。

要通过 Package Control 安装，请执行以下操作

1. 在 Sublime Text 中，打开 命令菜单 并输入 install。您应该看到命令列表中的 Package Control: Install Package。如果该命令未被突出显示，请使用键盘或鼠标选择它。Package Control 将会暂停几秒钟以获取可用插件的列表。

2. 插件列表出现后，输入 clang-tidy。在条目中您应该看到 SublimeLinter-contrib-clang-tidy。如果该条目未被突出显示，请使用键盘或鼠标选择它。

设置

有关 SublimeLinter 与设置如何工作的详细信息，请参阅 设置。有关通用代码检查设置的信息，请参阅 代码检查设置。

为了让代码检查工作，您需要一个编译数据库。这是一个命名为 compile_commands.json 的 JSON 文件。可以通过在调用 cmake 时在命令行指定 -DCMAKE_EXPORT_COMPILE_COMMANDS=ON 来由 CMake 生成。

为了让此插件知道编译数据库的位置，请在您的 .sublime-project 中添加以下条目

{
    "folders":
    [
        // ...
    ],
    "settings":
    {
        // ...
        "SublimeLinter.linters.clangtidy.compile_commands": "${project_path}/PATH/TO/YOUR/BUILD/DIR"
        // ...
    }
}

如果没有设置这一项，该插件将无法工作。

请记住：头文件不会被编译。因此，默认情况下，头文件不在编译数据库中。所以，clang-tidy 与头文件不兼容。您可以使用 此 Python 包 来增强现有的 compile_commands.json 并添加额外的头文件。

用法

在打开一个适当的文件时，如果编译数据库以及 .clang-tidy 文件已存在于正确的位置，SublimeLinter 将运行 clang-tidy 代码检查器。请注意，这意味着源文件正由 clang-tidy 编译。所以，消息开始显示可能需要一些时间。由于 clang-tidy 作用于源文件，因此只有在您打开或保存源文件时才运行的代码检查器。clang-tidy 代码检查器 不会在您编辑文件时执行代码检查。它只会 在加载和保存时执行代码检查。

推荐其他插件

• Clang Format

贡献

如果您想贡献增强或修复，请按照以下步骤操作

1. 从插件仓库中分叉。
2. 从最新的 master 分叉创建一个单独的主题分支。
3. 提交并推送主题分支。
4. 发起拉取请求。
5. 请耐心等待。;-)

请注意，修改应遵循以下编码指南

• 缩进为 4 个空格。
• 代码应通过 flake8 和 pep257 代码检查器。
• 垂直空白有助于可读性，不要害怕使用它。
• 请使用描述性的变量名，除非它们非常知名，否则不要使用缩写。

感谢您的帮助！