You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This linter plugin for [SublimeLinter](http://sublimelinter.readthedocs.org) provides an interface to linting via [ruby -wc](https://www.ruby-lang.org). It will be used with files that have the “Ruby” syntax.
6
+
This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to linting via [ruby -wc](https://www.ruby-lang.org). It will be used with files that have the “Ruby” syntax.
7
7
8
8
## Installation
9
-
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here](http://sublimelinter.readthedocs.org/en/latest/installation.html).
9
+
SublimeLinter must be installed in order to use this plugin.
10
+
11
+
Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
10
12
11
-
### Linter installation
12
13
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](https://www.ruby-lang.org/en/downloads/).
13
14
14
15
If you are using `rvm` or `rbenv`, ensure that they are loaded in your shell’s “profile” file. See [here](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#shell-startup-files) for more information.
15
16
16
-
### Linter configuration
17
-
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”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
18
-
19
-
Once `ruby` is installed and configured, you can proceed to install the SublimeLinter-ruby plugin if it is not yet installed.
20
-
21
-
### Plugin installation
22
-
Please use [Package Control](https://sublime.wbond.net/installation) 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.
23
-
24
-
To install via Package Control, do the following:
25
-
26
-
1. Within Sublime Text, bring up the [Command Palette](http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html) 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.
27
-
28
-
1. 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.
29
-
30
17
## Settings
31
-
For general information on how SublimeLinter works with settings, please see [Settings](http://sublimelinter.readthedocs.org/en/latest/settings.html). For information on generic linter settings, please see [Linter Settings](http://sublimelinter.readthedocs.org/en/latest/linter_settings.html).
32
-
33
-
## Contributing
34
-
If you would like to contribute enhancements or fixes, please do the following:
35
-
36
-
1. Fork the plugin repository.
37
-
1. Hack on a separate topic branch created from the latest `master`.
38
-
1. Commit and push the topic branch.
39
-
1. Make a pull request.
40
-
1. Be patient. ;-)
41
-
42
-
Please note that modications should follow these coding guidelines:
43
-
44
-
- Indent is 4 spaces.
45
-
- Code should pass flake8 and pep257 linters.
46
-
- Vertical whitespace helps readability, don’t be afraid to use it.
0 commit comments