diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-eruby.txt | 26 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
2 files changed, 26 insertions, 3 deletions
diff --git a/doc/ale-eruby.txt b/doc/ale-eruby.txt index a0f6f4f8..d75d3868 100644 --- a/doc/ale-eruby.txt +++ b/doc/ale-eruby.txt @@ -1,15 +1,37 @@ =============================================================================== ALE Eruby Integration *ale-eruby-options* -There are three linters for `eruby` files: +There are four linters for `eruby` files: - `erb` - `erubis` - `erubi` +- `ruumba` `erb` is in the Ruby standard library and is mostly universal. `erubis` is the default parser in Rails between 3.0 and 5.1. `erubi` is the default in Rails -5.1 and later. To selectively enable a subset, see |g:ale_linters|. +5.1 and later. `ruumba` can extract Ruby from eruby files and run rubocop on +the result. To selectively enable a subset, see |g:ale_linters|. + +=============================================================================== +ruumba *ale-eruby-ruumba* + +g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable* + *b:ale_eruby_ruumba_executable* + Type: String + Default: `'ruumba` + + Override the invoked ruumba binary. This is useful for running ruumba + from binstubs or a bundle. + + +g:ale_eruby_ruumba_options *g:ale_ruby_ruumba_options* + *b:ale_ruby_ruumba_options* + Type: |String| + Default: `''` + + This variable can be change to modify flags given to ruumba. + =============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index e4fc0e3c..d4223f84 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -92,6 +92,7 @@ CONTENTS *ale-contents* erlc................................|ale-erlang-erlc| syntaxerl...........................|ale-erlang-syntaxerl| eruby.................................|ale-eruby-options| + ruumba..............................|ale-eruby-ruumba| fish..................................|ale-fish-options| fortran...............................|ale-fortran-options| gcc.................................|ale-fortran-gcc| @@ -415,7 +416,7 @@ Notes: * Dockerfile: `dockerfile_lint`, `hadolint` * Elixir: `credo`, `dialyxir`, `dogma`, `mix`!!, `elixir-ls` * Elm: `elm-format, elm-make` -* Erb: `erb`, `erubi`, `erubis` +* Erb: `erb`, `erubi`, `erubis`, `ruumba` * Erlang: `erlc`, `SyntaxErl` * Fish: `fish` (-n flag) * Fortran: `gcc`, `language_server` |