README.md

linter-ruumba

This plugin for Linter provides an interface to ruumba. It will be used with files that use the Ruby ERB templating system syntax.

Installation

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

Installing ruumba

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

1. Install ruby.

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

   gem install ruumba

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

Installing the Plugin

$ apm install linter-ruumba

Settings

You can configure linter-ruumba from its settings panel or by editing ~/.atom/config.cson (choose Open Your Config in Atom menu).

Executable Path

'linter-ruumba':
  'executablePath': /path/to/your/ruumba/here

Disable when no .ruumba.yml config file is present

'linter-ruumba':
  'disableWhenNoConfigFile': false

Use available CPUs to execute inspection in parallel.

'linter-ruumba':
  'useParallelExecution': false

Run which ruumba to find the path (if you're using rbenv run rbenv which ruumba).

If you are working with a Rails project take a look at How best to use ruumba with rubocop on a Rails project? for an appropiated configuration.