foodcritic linter in sublime....finally!
- Total 631
- Win 226
- Mac 307
- Linux 98
|May 17||May 16||May 15||May 14||May 13||May 12||May 11||May 10||May 9||May 8||May 7||May 6||May 5||May 4||May 3||May 2||May 1||Apr 30||Apr 29||Apr 28||Apr 27||Apr 26||Apr 25||Apr 24||Apr 23||Apr 22||Apr 21||Apr 20||Apr 19||Apr 18||Apr 17||Apr 16||Apr 15||Apr 14||Apr 13||Apr 12||Apr 11||Apr 10||Apr 9||Apr 8||Apr 7||Apr 6||Apr 5||Apr 4||Apr 3|
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
foodcritic is installed on your system. To install
foodcritic, do the following:
foodcriticby typing the following in a terminal:
[sudo] gem install foodcritic
- If you are using
rvm, ensure that they are loaded in your shell’s correct startup file. See here for more information.
Note: This plugin requires
foodcritic 2.2.0 or later.
In order for
foodcritic to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once you have installed and configured
foodcritic, you can proceed to install the SublimeLinter-contrib-foodcritic plugin if it is not yet installed.
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type
install. Among the commands you should see
Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
When the plugin list appears, type
foodcritic. Among the entries you should see
SublimeLinter-contrib-foodcritic. If that entry is not highlighted, use the keyboard or mouse to select it.
The only rules that are excluded by default is FC011,FC031,FC033,FC045. The reason these rules are excluded is that they match file names with metadata/template files within the cookbook structure. This was out of my scope. I simply want to lint the actual cookbook file. However, I am open to pull requests.
Foodcritic should still be used as part of your CI process to ensure the metadata files of your cookbook are properly annotated.
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modifications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are very well known.
Thank you for helping out!