Skip to content
SublimeLinter plugin for ruby, using ruby -wc.
Python
Latest commit ee80611 May 17, 2016 @groteworld groteworld Update to pydocstyle
Failed to load latest commit information.
messages Version bump. Jan 4, 2014
.gitignore Update config Oct 4, 2014
.sublimelinterrc Update config Oct 5, 2014
.travis.yml Update to pydocstyle May 17, 2016
LICENSE Initial commit. Dec 15, 2013
README.md Using new travis build status image (svg) Apr 8, 2014
linter.py Copyright bump May 17, 2016
messages.json Version bump. Jan 4, 2014

README.md

SublimeLinter-ruby

Build Status

This linter plugin for SublimeLinter provides an interface to linting via ruby -wc. It will be used with files that have the “Ruby” syntax.

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 installing this plugin, you must ensure that ruby is installed on your system. On Mac OS X and Linux, ruby comes preinstalled. On Windows, follow the instructions on the Ruby site.

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

Linter configuration

In order for ruby 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 ruby is installed and configured, you can proceed to install the SublimeLinter-ruby 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 ruby. Among the entries you should see SublimeLinter-ruby. 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.

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

Thank you for helping out!

Something went wrong with that request. Please try again.