|
1 |
| -linter-ruby |
2 |
| -========================= |
| 1 | +# linter-ruby |
3 | 2 |
|
4 |
| -This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides an interface to Ruby's builtin syntax analysis. It will be used with files that have the `Ruby` syntax. |
| 3 | +This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides |
| 4 | +an interface to Ruby's builtin syntax analysis. It will be used with files that |
| 5 | +have the `Ruby` syntax. |
5 | 6 |
|
6 | 7 | ## Installation
|
7 |
| -On first activation the plugin will install all dependencies automatically, you no longer have to worry about installing Linter. |
| 8 | + |
| 9 | +On first activation the plugin will install all dependencies automatically, you |
| 10 | +no longer have to worry about installing Linter. |
8 | 11 |
|
9 | 12 | Just install this package and you'll be good to go.
|
10 | 13 |
|
11 | 14 | ## Settings
|
12 |
| -You can configure linter-ruby by editing ~/.atom/config.cson (choose Open Your Config in Atom menu): |
13 |
| -```coffee |
| 15 | + |
| 16 | +You can configure linter-ruby by editing `~/.atom/config.cson` (choose Open |
| 17 | +Your Config in Atom menu): |
| 18 | + |
| 19 | +```coffeescript |
14 | 20 | 'linter-ruby':
|
15 | 21 | # ruby path. run `which ruby` to find the path.
|
16 | 22 | 'rubyExecutablePath': null
|
17 | 23 |
|
18 | 24 | # ignored extensions, ERB and markdown files by default.
|
19 | 25 | 'ignoredExtensions': 'erb, md'
|
20 | 26 | ```
|
21 |
| - |
22 |
| -## Contributing |
23 |
| -If you would like to contribute enhancements or fixes, please do the following: |
24 |
| - |
25 |
| -1. Fork the plugin repository. |
26 |
| -1. Hack on a separate topic branch created from the latest `master`. |
27 |
| -1. Commit and push the topic branch. |
28 |
| -1. Make a pull request. |
29 |
| -1. welcome to the club |
30 |
| - |
31 |
| -Please note that modifications should follow these coding guidelines: |
32 |
| - |
33 |
| -- Indent is 2 spaces. |
34 |
| -- Code should pass coffeelint linter. |
35 |
| -- Vertical whitespace helps readability, don’t be afraid to use it. |
36 |
| - |
37 |
| -Thank you for helping out! |
38 |
| - |
39 |
| -## Donation |
40 |
| -[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KXUYS4ARNHCN8) |
0 commit comments