linter-reek

This linter plugin for Linter provides an interface to Reek. It will be used with files that have the “Ruby” syntax.

Installation

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

reek 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:

   gem install reek
   

Now you can proceed to install the linter-reek plugin.

Plugin installation

$ apm install linter-reek

Settings

You can configure linter-reek by editing ~/.atom/config.cson (choose Open Your Config in Atom menu):

reekExecutablePath

'linter-reek':
  'reekExecutablePath': /path/to/your/reek/here

Run which reek to find the path (if you using rbenv run rbenv which reek).

Note: This plugin finds the nearest config.reek file and uses the -c command line argument to use that file, so you may not use the -c argument in the linter settings.

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. welcome to the club

Please note that modifications should follow these coding guidelines:

• Indent is 2 spaces.
• Code should pass coffeelint linter.
• Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!

Donation