carlosbaraza / linter-rubocop

Linter plugin for Ruby, using rubocop

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

linter-rubocop

Gitter Plugin installs! Package version! Dependencies!

Gratipay donate button PayPayl donate button BitCoin donate button

This linter plugin for Linter provides an interface to rubocop. 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.

rubocop installation

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

  1. Install ruby.

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

    gem install rubocop
    

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

Plugin installation

$ apm install linter-rubocop

Settings

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

executablePath

'linter-rubocop':
  'executablePath': null # rubocop path.

Run which rubocop to find the path, if you using rbenv run rbenv which rubocop

Note: This plugin finds the nearest .rubocop.yml file and uses the --config command line argument to use that file, so you may not use the --config 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

Share the love!

Gratipay donate button PayPayl donate button BitCoin donate button

About

Linter plugin for Ruby, using rubocop


Languages

Language:CoffeeScript 100.0%