diff options
| author | Antoine Gagné <AntoineGagne@users.noreply.github.com> | 2019-05-19 16:16:17 -0400 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2019-05-19 21:16:17 +0100 |
| commit | 3b7c86e401eb488acd8713f7c9ee81344095080d (patch) | |
| tree | 2eb2260f62c3529c2fb51998a4581fc9397878f6 /doc | |
| parent | 652d991077ac3261e51abfa51d979774a555b405 (diff) | |
| download | ale-3b7c86e401eb488acd8713f7c9ee81344095080d.zip | |
Add support for Erlang dialyzer (#2509)
* Add support for Erlang dialyzer
* Add an option to specify rebar3 profile
In doing so, the use of the `**` wildcard becomes unnecessary.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-erlang.txt | 29 | ||||
| -rw-r--r-- | doc/ale.txt | 1 |
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/ale-erlang.txt b/doc/ale-erlang.txt index ad3c1e5a..59993a99 100644 --- a/doc/ale-erlang.txt +++ b/doc/ale-erlang.txt @@ -3,6 +3,35 @@ ALE Erlang Integration *ale-erlang-options* =============================================================================== +dialyzer *ale-erlang-dialyzer* + +g:ale_erlang_dialyzer_executable *g:ale_erlang_dialyzer_executable* + *b:ale_erlang_dialyzer_executable* + Type: |String| + Default: `'dialyzer'` + + This variable can be changed to specify the dialyzer executable. + + +g:ale_erlang_dialyzer_plt_file *g:ale_erlang_dialyzer_plt_file* + *b:ale_erlang_dialyzer_plt_file* + Type: |String| + + This variable can be changed to specify the path to the PLT file. By + default, it will search for the PLT file inside the `_build` directory. If + there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`. + Otherwise, it will default to `$HOME/.dialyzer_plt`. + + +g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile* + *b:ale_erlang_dialyzer_rebar3_profile* + Type: |String| + Default: `'default'` + + This variable can be changed to specify the profile that is used to + run dialyzer with rebar3. + +------------------------------------------------------------------------------- erlc *ale-erlang-erlc* g:ale_erlang_erlc_options *g:ale_erlang_erlc_options* diff --git a/doc/ale.txt b/doc/ale.txt index 7e6ac443..ac3661fc 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1989,6 +1989,7 @@ documented in additional help files. elm-lsp...............................|ale-elm-elm-lsp| elm-make..............................|ale-elm-elm-make| erlang..................................|ale-erlang-options| + dialyzer..............................|ale-erlang-dialyzer| erlc..................................|ale-erlang-erlc| syntaxerl.............................|ale-erlang-syntaxerl| eruby...................................|ale-eruby-options| |