SublimeLinter-contrib-reek

此 SublimeLinter 插件用于 SublimeLinter，提供对 reek 的接口。它将用于具有 ruby，ruby on rails，rspec，betterruby，better rspec，ruby experimental 或 cucumber steps 语法的文件。

安装

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

linters 安装

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

1. 安装 Ruby。

2. 使用以下命令安装 reek：

[sudo] gem install reek

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

注意：此插件需要 reek 3.5.0 或更高版本。

lniter 配置

为了使 reek 能够由 SublimeLinter 执行，您必须确保其路径对 SublimeLinter 可用。在进行任何操作之前，请阅读并按照文档中的“Finding a linter executable”部分中的步骤进行操作，其中包含在“Validating your PATH”部分中的说明。

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

插件安装

请使用 Package Control 来安装代码校验插件。这将确保插件在有新版本可用时会自动更新。如果您想从源码安装以便修改源代码，那么您可能已经知道如何操作，因此此处不展开介绍。

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

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

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

设置

关于SublimeLinter如何使用设置的通用信息，请参阅 设置。有关通用代码校验器设置的详细信息，请参阅 代码校验器设置。

您可以使用config.reek配置文件，以命令行的方式配置reek。有关更多信息，请参阅reek 文档。

默认情况下，代码校验插件会在当前目录及其父目录中查找名为config.reek的配置文件。若要覆盖配置文件路径，请在代码校验器设置中添加以下内容：

"reek": {
    "args": ["-c", "path/to/config.reek"]
}

贡献

如果您想贡献改进或修复，请按照以下步骤操作：

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

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

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

感谢您的帮助！