diff options
| author | Eddie Lebow <elebow@users.noreply.github.com> | 2017-04-20 02:37:08 -0400 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2017-04-20 07:37:08 +0100 |
| commit | 0384cabd77e38f9a04ff1c8832f6b755855e909e (patch) | |
| tree | 502e93f9a0f30dc47a932ac316a4879d464272c0 /doc | |
| parent | c6ef9e28a50f2378568c4c35a5346b495cb15c34 (diff) | |
| download | ale-0384cabd77e38f9a04ff1c8832f6b755855e909e.zip | |
Add the Reek checker for Ruby. (#490)
Add the Reek checker for Ruby.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-ruby.txt | 21 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
2 files changed, 23 insertions, 1 deletions
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt index 77ea7342..033da360 100644 --- a/doc/ale-ruby.txt +++ b/doc/ale-ruby.txt @@ -3,6 +3,27 @@ ALE Ruby Integration *ale-ruby-options* ------------------------------------------------------------------------------- +reek *ale-ruby-reek* + +g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context* + + Type: |Number| + Default: 0 + + Controls whether context is included in the linter message. Defaults to off + because context is usually obvious while viewing a file. + + +g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link* + + Type: |Number| + Default: 0 + + Controls whether linter messages contain a link to an explanatory wiki page + for the type of code smell. Defaults to off to improve readability. + + +------------------------------------------------------------------------------- rubocop *ale-ruby-rubocop* g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options* diff --git a/doc/ale.txt b/doc/ale.txt index 8979b1b8..8011a215 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -60,6 +60,7 @@ CONTENTS *ale-contents* mypy................................|ale-python-mypy| pylint..............................|ale-python-pylint| ruby..................................|ale-ruby-options| + reek................................|ale-ruby-reek| rubocop.............................|ale-ruby-rubocop| rust..................................|ale-rust-options| cargo...............................|ale-rust-cargo| @@ -155,7 +156,7 @@ The following languages and tools are supported. * reStructuredText: 'proselint' * RPM spec: 'spec' * Rust: 'rustc' (see |ale-integration-rust|) -* Ruby: 'rubocop' +* Ruby: 'reek', 'rubocop' * SASS: 'sasslint', 'stylelint' * SCSS: 'sasslint', 'scsslint', 'stylelint' * Scala: 'scalac' |