diff options
| author | w0rp <w0rp@users.noreply.github.com> | 2018-09-14 13:27:07 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-14 13:27:07 +0100 |
| commit | 7f1c411b5e5ef978e7bf4d032e6bd1ddeabb20c5 (patch) | |
| tree | 92fc306223bcc1dda9f1826dbce7119cae37c246 /doc | |
| parent | 43d7e8fde9aedb5dc3d76014a64de04fbdbaa276 (diff) | |
| parent | b01470cbbcfb64ba2ca5b23016e6c9e8702fb0ce (diff) | |
| download | ale-7f1c411b5e5ef978e7bf4d032e6bd1ddeabb20c5.zip | |
Merge pull request #1850 from rrosenblum/ruby_linters
Update all Ruby linters to work consistently with bundler
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-ruby.txt | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt index ec7b07cf..810a1d45 100644 --- a/doc/ale-ruby.txt +++ b/doc/ale-ruby.txt @@ -5,6 +5,15 @@ ALE Ruby Integration *ale-ruby-options* =============================================================================== brakeman *ale-ruby-brakeman* +g:ale_ruby_brakeman_executable *g:ale_ruby_brakeman_executable* + *b:ale_ruby_brakeman_executable* + Type: String + Default: `'brakeman'` + + Override the invoked brakeman binary. Set this to `'bundle'` to invoke + `'bundle` `exec` brakeman'. + + g:ale_ruby_brakeman_options *g:ale_ruby_brakeman_options* *b:ale_ruby_brakeman_options* Type: |String| @@ -20,10 +29,11 @@ g:ale_ruby_rails_best_practices_executable *g:ale_ruby_rails_best_practices_executable* *b:ale_ruby_rails_best_practices_executable* Type: String - Default: 'rails_best_practices' + Default: `'rails_best_practices'` Override the invoked rails_best_practices binary. Set this to `'bundle'` to - invoke `'bundle` `exec` `rails_best_practices'`. + invoke `'bundle` `exec` rails_best_practices'. + g:ale_ruby_rails_best_practices_options *g:ale_ruby_rails_best_practices_options* @@ -37,6 +47,15 @@ g:ale_ruby_rails_best_practices_options =============================================================================== reek *ale-ruby-reek* +g:ale_ruby_reek_executable *g:ale_ruby_reek_executable* + *b:ale_ruby_reek_executable* + Type: String + Default: `'reek'` + + Override the invoked reek binary. Set this to `'bundle'` to invoke + `'bundle` `exec` reek'. + + g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context* *b:ale_ruby_reek_show_context* Type: |Number| @@ -63,8 +82,8 @@ g:ale_ruby_rubocop_executable *g:ale_ruby_rubocop_executable* Type: String Default: `'rubocop'` - Override the invoked rubocop binary. This is useful for running rubocop - from binstubs or a bundle. + Override the invoked rubocop binary. Set this to `'bundle'` to invoke + `'bundle` `exec` rubocop'. g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options* |