SublimeLinter-contrib-standardrb

此代码检查插件为SublimeLinter提供与StandardRB的接口。它将用于具有ruby、ruby on rails、rspec、betterruby、better rspec、ruby experimental或cucumber steps语法的文件。

安装

为了使用此插件，您需要安装SublimeLinter和StandardRB。

如果您已满足这些要求，那么很棒！🎉。您可以使用Package Control安装SublimeLinter-contrib-standardrb插件。

如果您尚未安装SublimeLinter和StandardRB，请参见以下内容

安装SublimeLinter

有关安装说明，请参阅SublimeLinter文档。

安装StandardRB

在使用此插件之前，您必须确保系统上已安装standard。要安装standard，请在终端中键入以下内容

1. 安装Ruby。

2. 按以下方式使用终端安装standard

   gem install standard
   

3. 如果您正在使用rvm或rbenv，请确保它们已在您的shell的正确启动文件中加载。有关更多信息，请参阅此处。

PATH配置

为了使SublimeLinter可以执行standard，您必须确保其路径对SublimeLinter可用。SublimeLinter文档涵盖了解决PATH配置问题。

设置

要了解SublimeLinter的设置，请查看

• SublimeLinter设置
• 代码检查器设置

包管理器

如果您正在使用包管理器并且想使用StandardRB的锁定版本，您需要将use_bundle_exec设置为true

{
    "settings": {
        "SublimeLinter.linters.standardrb.use_bundle_exec": true
    }
}

与SublimeLinter-Rubocop相容

假设您也启用了SublimeLinter-Rubocop插件…

您可能想在某些项目中使用Standard作为lint，在其他项目中直接使用Rubocop。由于Standard是Rubocop的封装，并且两个lint都会检查相同的文件，同时启用它们可能会产生一些冲突的结果（例如，既不允许单引号也不允许双引号字符串字面值）。有几种方法可以防止这两个lint之间的冲突。

选项1：手动切换lint

您可以使用命令面板中的“禁用包”/“启用包”来关闭或开启lint插件。您还可以使用设置文件来全局启用或禁用lint插件。这两个方法都非常糟糕的用户体验，您真应该使用下面的其他选项之一。

选项2：使用.sublime-project文件

处理lint冲突的一个选项是在您的全局设置文件中禁用一个lint，然后根据每个项目覆盖设置。例如，如果您想全局启用StandardRB并仅在特定项目中使用Rubocop，首先在您的Preferences.sublime-settings文件中全局禁用rubocop lint

{
    "SublimeLinter.linters.rubocop.disable": true
}

这将防止SublimeLinter使用Rubocop lint同时继续允许使用SublimeRB lint。

然后，对于您希望使用Rubocop而不是StandardRB进行lint的任何项目，您可以将以下内容添加到您的*.sublime-project设置中

{
    "settings": {
        "SublimeLinter.linters.rubocop.disable": false,
        "SublimeLinter.linters.standardrb.disable": true
    }
}

上述设置将禁用StandardRB lint并启用Rubocop。

如果你的项目未使用*.sublime-project文件打开（例如，从终端提示符执行subl ~/path/to/ruby/project），则此方法将很好地工作。这种方法的缺点是它可能无法选择你想要的lint。

选项3：使用prefer_standard设置检查配置文件

(👆 - 提示：这可能是你要找的。）

更智能（也更具有观点）的一个选项是使用prefer_standard选项。启用此选项将使StandardRB lint插件根据相应的lint配置文件的是否存在，选择性地启用StandardRB或Rubocop lint。首先在项目目录（项目中的第一个文件夹）及其每个父目录中搜索.standard.yml文件，然后搜索.rubocop.yml文件。对于找到的第一个配置文件，将激活相应的lint。

要使用prefer_standard选项，您需要在全局首选项中添加以下内容

{
    "settings": {
        "SublimeLinter.linters.rubocop.disable": null,
        "SublimeLinter.linters.standardrb.disable": null,
        "SublimeLinter.linters.standardrb.prefer_standard": true,
    }
}

请注意，两个lint的disable设置都设置为null，而不是false。 true和false是明确的决策，prefer_standard将乐于尊重。 null意味着您同意不做决定，并让prefer_standard为您决定。

帮助我们改进

如果您遇到问题，请打开问题或拉取请求。

行为准则

此项目遵循Test Double的行为准则，适用于所有社区互动，包括（但不限于）一对一交流、公开帖子/评论、代码审查、拉取请求和GitHub问题。如果发生违规行为，Test Double将对违规行为采取适当的行动，直至包括阻止用户使用该组织的存储库。

此插件主要基于SublimeLinter-Rubocop