summaryrefslogtreecommitdiff
path: root/doc/ale-ruby.txt
blob: 6e8aa0eb8c8fa379fbb34f9131712cc823b362fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
===============================================================================
ALE Ruby Integration                                         *ale-ruby-options*


-------------------------------------------------------------------------------
brakeman                                                    *ale-ruby-brakeman*

g:ale_ruby_brakeman_options                       *g:ale_ruby_brakeman_options*
                                                  *b:ale_ruby_brakeman_options*
  Type: |String|
  Default: `''`

  The contents of this variable will be passed through to brakeman.


-------------------------------------------------------------------------------
reek                                                            *ale-ruby-reek*

g:ale_ruby_reek_show_context                     *g:ale_ruby_reek_show_context*
                                                 *b: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*
                                               *b: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_executable                   g:ale_ruby_rubocop_executable
                                                b:ale_ruby_rubocop_executable
  Type: String
  Default: 'rubocop'

  Override the invoked rubocop binary. This is useful for running rubocop
  from binstubs or a bundle.


g:ale_ruby_rubocop_options                         *g:ale_ruby_rubocop_options*
                                                   *b:ale_ruby_rubocop_options*
  Type: |String|
  Default: `''`

  This variable can be change to modify flags given to rubocop.


-------------------------------------------------------------------------------
  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: