ale/doc/ale-ruby.txt

121 lines
4.6 KiB
Plaintext
Raw Normal View History

===============================================================================
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.
===============================================================================
rails_best_practices *ale-ruby-rails_best_practices*
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'
Override the invoked rails_best_practices binary. Set this to `'bundle'` to
invoke `'bundle` `exec` `rails_best_practices'`.
g:ale_ruby_rails_best_practices_options
*g:ale_ruby_rails_best_practices_options*
*b:ale_ruby_rails_best_practices_options*
Type: |String|
Default: `''`
The contents of this variable will be passed through to rails_best_practices.
===============================================================================
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*
2017-05-16 11:47:35 -04:00
Type: String
Default: `'rubocop'`
2017-05-16 11:47:35 -04:00
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.
===============================================================================
ruby *ale-ruby-ruby*
g:ale_ruby_ruby_executable *g:ale_ruby_ruby_executable*
*b:ale_ruby_ruby_executable*
Type: String
Default: `'ruby'`
This variable can be changed to use a different executable for ruby.
2018-03-10 23:33:57 -05:00
===============================================================================
rufo *ale-ruby-rufo*
g:ale_ruby_rufo_executable *g:ale_ruby_rufo_executable*
*b:ale_ruby_rufo_executable*
Type: String
Default: `'rufo'`
Override the invoked rufo binary. This is useful for running rufo from
binstubs or a bundle.
2018-08-24 00:02:51 -04:00
===============================================================================
solargraph *ale-ruby-solargraph*
g:ale_ruby_solargraph_host *g:ale_ruby_solargraph_host*
*b:ale_ruby_solargraph_host*
Type: String
Default: `'127.0.0.1'`
The host/ip where the solargraph language server is running.
g:ale_ruby_solargraph_port *g:ale_ruby_solargraph_port*
*b:ale_ruby_solargraph_port*
Type: String
Default: `'7658'`
The listening port where the solargraph language server is running.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: