Linter package must be installed in order to use this plugin. If Linter is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
rubocop, version 0.37 or
greater, is installed on your system. To install
rubocop, do the following:
Now you can proceed to install the linter-rubocop plugin.
apm install linter-rubocop
You can configure linter-rubocop by editing
(choose Open Your Config in Atom menu):
If you're using RVM and receiving errors in Atom that indicate Rubocop can't be
found, you may need to change
/wrappers in the path that gets
which rubocop before using it as your
For example, change:
"linter-rubocop": command: "/Users/JohnDoe/.rvm/gems/ruby-2.2.4@global/bin/rubocop"
"linter-rubocop": command: "/Users/JohnDoe/.rvm/gems/ruby-2.2.4@global/wrappers/rubocop"
If you're using
rbenv, it's recommended that you set your
command to point to the Rubocop shim. This way, when you upgrade Ruby, the command will be a pointer to a Rubocop executable, regardless of your current Ruby version.
"linter-rubocop": command: "/Users/JohnDoe/.rbenv/shims/rubocop"
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.
- Welcome to the club!
Please note that modifications should follow these coding guidelines:
- Indent is 2 spaces.
- Code should pass
npm run lint(eslint).
- Vertical whitespace helps readability, don’t be afraid to use it.
Thank you for helping out!