[!提醒] 寻找新的维护者。请参阅 https://github.com/pderichs/sublime_rubocop/issues/71 以获取更多信息。

Sublime RuboCop

这是一个 Sublime Text 插件，它可以在编辑器中对您的 Ruby 文件运行 RuboCop。它将在视图中标记问题，也可以从 ST 菜单调用它作为“编译器”。

插件目前支持 ST2 和 ST3，但强烈建议使用 ST3。

安装

先决条件

请确保已安装 rubocop

gem install rubocop

推荐

通过 Package Control 安装 Sublime RuboCop。

手动

1. 导航到 Sublime Text 软件包文件夹（您可以在 这里 找到软件包文件夹的位置）。

2. 在软件包目录内直接运行 git clone 命令： git clone [email protected]:pderichs/sublime_rubocop.git "RuboCop"

3. 重新启动 Sublime Text。

它能为您做什么？

默认情况下，插件在打开或保存 Ruby 文件时，会在视图中标记 RuboCop 的问题。

此外，您可以通过多种方式从 ST 菜单运行 RuboCop。例如，您可以对当前项目的所有文件执行 RuboCop 检查，以获得一般概述。问题将在 Sublime 输出窗口中列出，因此您可以轻松地逐个导航到每个问题。

您还可以从 Sublime Text 菜单运行当前文件的 RuboCop 自动纠正。

ST2

由于性能问题，插件在 ST2 下的行为略有不同。它只会在您 保存 文件时运行 RuboCop。如果您在此插件的保存 Ruby 文件时遇到任何性能问题，只需在设置中禁用该功能（见 mark_issues_in_view）即可。

环境

默认情况下，此插件使用 rvm 来运行 RuboCop，但您可以在设置中切换到 rbenv 或提供自己的命令行。插件使用默认路径来运行 rvm 或 rbenv，但您可以在设置中自定义这些路径。

例如，要使用 rbenv，请转到 首选项 > 包设置 > Rubocop >用户设置 并添加以下内容

{
  "check_for_rvm": false,
  "check_for_rbenv": true,
  // In case you need a custom rbenv path
  "rbenv_path": "~/.rbenv/bin/rbenv",
}

待办事项

• 根据一些用户的报告，当使用 RVM 和自定义 gemsets 时，此插件似乎运行不正确： 问题 #19。

问题报告

如果您遇到问题，请添加一些有关您环境的通用信息

• 操作系统
• Sublime Text 版本
• 有关您的配置的详细信息，例如，您是否使用 rbenv、rvm 或 your_own_command 来运行 rubocop？

请同时提供重现问题的步骤。

贡献

1. 复制仓库。
2. 从当前主分支创建一个新分支。
3. 开始开发。
4. 创建一个拉取请求。
5. 耐心 :-relaxed: 。

致谢

感谢所有 贡献者。

感谢 Will Bond 为他的出色样本和 ST 插件的文档，还要感谢那些实现 sublime-text-2-ruby-tests 插件 的人 - 您的源代码为我实现提供了一些重要提示。

许可证

Sublime RuboCop 的所有内容均为 MIT 许可。

版权所有 © 2013 Patrick Derichs [email protected]

特此授予任何获得本软件及其相关文档文件（“软件”）副本的人（“任何人”）使用本软件的权利，不受限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，以及允许向本软件提供副本的人这样做，但受以下条件约束

上述版权声明和本许可声明应包含在所有副本或主要部分的软件中。

软件按“原样”提供，不包括任何形式的明示或暗示保证，包括但不限于适销性、特定用途和侵权保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论该索赔、损害或其他责任是因合同、侵权或其他方式引起的，与软件或软件的使用或其它交易有关。