SublimeLinter-contrib-reek

This linter plugin for SublimeLinter provides an interface to reek. It will be used with files that have the ruby, ruby on rails, rspec, betterruby, better rspec, ruby experimental or cucumber steps syntaxes.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that reek is installed on your system. To install reek, do the following:

1. Install Ruby.

2. Install reek by typing the following in a terminal:

[sudo] gem install reek

1. If you are using rbenv or rvm, ensure that they are loaded in your shell’s correct startup file. See here for more information.

Note: This plugin requires reek 3.5.0 or later.

Linter configuration

In order for reek 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 reek, you can proceed to install the SublimeLinter-contrib-reek plugin if it is not yet installed.

Plugin installation

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:

1. 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.

2. When the plugin list appears, type reek. Among the entries you should see SublimeLinter-contrib-reek. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

You can configure reek exactly the way you would from the command line, using config.reek configuration files. For more information, see the reek documentation.

By default, the linter plugin looks for a config file called config.reek in the current directory and its parents. To override the config file path, you would add this to the linter settings:

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

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. 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!