SublimeLinter-contrib-foodcritic

这个用于SublimeLinter的检查器插件提供了一个SublimeLinter接口到foodcritic。它将对具有“ruby”语法的文件使用。

安装

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

检查器安装

在使用此插件之前，您必须确保系统中已安装了foodcritic。要安装foodcritic，请按照以下步骤操作

1. 安装Ruby。

2. 在终端中键入以下内容以安装foodcritic：

[sudo] gem install foodcritic

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

注意：此插件需要foodcritic 2.2.0或更高版本。

检查器配置

为了使SublimeLinter能够执行foodcritic，您必须确保其路径对SublimeLinter可用。在继续之前，请阅读并遵循文档中的“Finding a linter executable”步骤，“Validating your PATH”。

安装并配置foodcritic后，您可以继续安装SublimeLinter-contrib-foodcritic插件，如果尚未安装的话。

插件安装

请使用Package Control安装检查器插件。这将确保在提供新版本时更新插件。如果您想从源代码安装以便您可以修改源代码，那么您可能已经知道您正在做什么，所以我们在这里不介绍该过程。

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

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

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

设置

有关SublimeLinter如何与设置联动的详细信息，请参阅设置。有关通用linter设置的详细信息，请参阅linter设置。

默认情况下排除的规则只有FC011、FC031、FC033、FC045。这些规则被排除的原因是它们匹配了cookbook结构中的元数据/模板文件名称。这超出了我的职责范围。我只想检查实际的cookbook文件。然而，我对pull requests持开放态度。

仍然应该将Foodcritic作为您的CI流程的一部分来确保cookbook的元数据文件得到适当的注释。

贡献

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

1. Fork插件的仓库。
2. 在从最新master创建的单独分支上开发。
3. 提交并推送分支。
4. 发起一个pull request。
5. 耐心等待。;-)

请注意，修改应遵循以下编码规范

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

感谢您的帮助！