SublimeLinter-contrib-codeclimate

这个 SublimeLinter 插件提供了一个与 codeclimate CLI 的接口。Code Climate 支持多种语言，通过称为静态分析引擎的标准 Docker 镜像。

依赖项

SublimeLinter 和 codeclimate CLI 必须安装才能使用此插件。

• 如果您尚未安装 SublimeLinter，请按照此处的说明进行操作。
• 如果您尚未安装 codeclimate CLI，请按照此处的说明进行操作。

建议将 codeclimate 可执行文件添加到您的 $PATH 环境变量中。您可以在 SublimeLinter 文档中找到有关这一步骤的一些帮助。另外，您也可以在 SublimeLinter 设置中设置 codeclimate 可执行文件的自定义路径（《设置》中查看）。

插件安装

请使用 Package Control 安装检查器插件。这将确保当有新版本可用时，插件将得到更新。

在 Sublime Text 中，打开命令面板，并输入 install。选择 Package Control: Install Package，然后等待几秒钟， Package Control 会获取可用的插件列表。

当插件列表出现时，输入 codeclimate 并选择 SublimeLinter-contrib-codeclimate。

工作原理

• 如果打开的文件夹在 SublimeText 中包含根目录下的 .codeclimate.yml 配置文件，则 codeclimate 将识别该文件的设置。否则，它将自动运行默认的 structure 和 duplication 检查。
• 如果您不同文件夹中有 .codeclimate.yml 配置文件，您可以设置 SublimeLinter 的 working_dir 设置（《设置》中查看）。

SublimeLinter存在一些无法运行 codeclimate 用例的情况。例如：当你在一个已经打开的同一视图中打开单个文件时。在这种情况下，语法检查器将失败并打印一个警告，因为单个文件没有工作目录（这是 codeclimate 必需的）。

限制

如果许多项目文件都在SublimeText中打开，此插件可能会导致性能问题。

我建议默认全局停用此插件，然后根据你打开的文件夹或作为SublimeText项目的一部分激活它。

设置

有关SublimeLinter设置的工作原理，请参阅SublimeLinter文档中的设置和（通用）语法检查设置。

例子

在这里，我尝试给您提供一些日常用例的例子。

禁用/启用此插件

{
  "linters": {
    "codeclimate": {
      "disable": true
    }
  }
}

对于SublimeLinter的全局设置，请转到 首选项 > 包设置 > SublimeLinter > 设置。

设置可执行文件

你可以在全局SublimeLinter设置或你的项目设置中设置codeclimate可执行文件的路径。

{
  "linters": {
    "codeclimate": {
      "executable": "/usr/local/bin/codeclimate"
    }
  }
}

传递参数到codeclimate CLI

如果你想忽略.codeclimate.yml配置文件（例如，以运行代码climate的子集），你可以在全局SublimeLinter设置或项目设置中设置语法检查器参数。

{
  "linters": {
    "codeclimate": {
      "args": [
          "-e",
          "structure",
          "-e",
          "duplication"
        ]
    }
  }
}

自定义工作目录

假设您使用.codeclimate.yml配置文件。在这种情况下，需要在使用配置文件的目录中执行codeclimate CLI。否则，它无法检测您的配置并只运行默认分析。

SublimeLinter将当前文件在SublimeText侧边栏中的根文件夹作为其语法检查命令的工作目录。您可以通过设置执行工作目录来更改这种行为。

{
  "linters": {
    "codeclimate": {
      "working_dir": "/path/to/working/dir"
    }
  }
}

提示：确保工作目录位于您要检查的文件路径中！

设置关联的文件类型

你可以在全局SublimeLinter设置或你的项目设置中设置关联的文件类型。

{
  "linters": {
    "codeclimate": {
      "selector": "source.php, source.python"
    }
  }
}

要查找给定文件类型应使用哪个选择器，请使用“工具 > 开发者 > 显示范围名称”菜单项。（SublimeLinter 文档）

贡献

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

1. 从最新的main分支中选取插件仓库的副本。
2. 在创建的独立主题分支中进行您的更改。
3. 提交并推送主题分支。
4. 发起拉取请求。

请注意，修改应符合以下编码规范

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

非常感谢您的帮助！

许可

MIT，详情请参阅LICENSE