SublimeLinter-contrib-ruby-lint

这款代码检查插件为 SublimeLinter 提供了 ruby-lint 的接口。它将用于具有“Ruby”语法的文件。

安装

要使用此插件，必须安装 SublimeLinter 3。如果未安装 SublimeLinter 3，请按照此处的说明操作。

代码检查器安装

在使用此插件之前，您必须确保您的系统上已安装了 ruby-lint。安装 ruby-lint，请执行以下操作

1. 安装 Ruby。

2. 在终端中输入以下命令来安装 ruby-lint

[sudo] gem install ruby-lint

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

注意： 此插件需要 ruby-lint 2.0.0 或更高版本。

代码检查器配置

为了使 ruby-lint 可由 SublimeLinter 执行，您必须确保其路径对 SublimeLinter 可用。在继续操作之前，请阅读并按照文档中的“查找代码检查器可执行文件”中的步骤执行，特别是“验证您的 PATH”。

安装并配置 ruby-lint 后，您可以继续安装 SublimeLinter-contrib-ruby-lint 插件（如果尚未安装）。

插件安装

请使用 Package Control 安装代码检查器插件。这将确保插件在新版本可用时自动更新。如果您想从源代码安装以便修改源代码，则您可能已经知道自己在做什么，因此我们不在此处介绍。

通过 Package Control 安装，请按照以下步骤操作

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

2. 当插件列表出现时，输入ruby-lint。在条目中，您应该看到SublimeLinter-contrib-ruby-lint。如果该条目没有被高亮，请使用键盘或鼠标选择它。

设置

有关SublimeLinter如何与设置工作的通用信息，请参阅设置。有关通用linter设置的信息，请参阅linter 设置。

默认情况下，linter插件在当前目录及其父目录中寻找名为ruby-lint.yml的配置文件。为了覆盖配置文件路径，您需要在linter设置中添加以下内容

"ruby-lint": {
    "args": ["--config", "path/to/ruby-lint.yml"]
}

贡献

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

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

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

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

重要！

请注意，此仓库使用overcommit作为一个验证工具。在做出任何更改之前，请在您的本地仓库中安装overcommit。

感谢您的帮助！