diff options
| author | Fran Casas <nflamel@gmail.com> | 2018-01-22 13:21:07 +0100 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2018-01-22 12:21:07 +0000 |
| commit | 038789f0ed42cfffbd442a6a399cb2395591821d (patch) | |
| tree | 4fe4464b09f38ff95673b4e322acf89462756c74 /doc | |
| parent | acf9c92ab40737d6993e55d182b00097e5a8d406 (diff) | |
| download | ale-038789f0ed42cfffbd442a6a399cb2395591821d.zip | |
Add Elixir linter for dialyxir (#1257)
* Add Elixir linter for dialyxir
* Update doc/ale.txt with dialyxir
* Keep elixir tools alphabetically ordered in README
* Add a missing entry for dialyxir to the main documentation file.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-elixir.txt | 15 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
2 files changed, 17 insertions, 1 deletions
diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt index a5318c0f..b7d4922e 100644 --- a/doc/ale-elixir.txt +++ b/doc/ale-elixir.txt @@ -14,4 +14,19 @@ g:ale_elixir_mix_options *g:ale_elixir_mix_options* This variable can be changed to specify the mix executable. =============================================================================== +dialyxir *ale-elixir-dialyxir* + +Dialyzer, a DIscrepancy AnaLYZer for ERlang programs. +http://erlang.org/doc/man/dialyzer.html + +It can be used with elixir through dialyxir +https://github.com/jeremyjh/dialyxir + +Options for dialyzer are not configurable by ale, but they are instead +configured on your project's `mix.exs`. + +See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more +information. + +=============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale.txt b/doc/ale.txt index b99c800c..47765685 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -57,6 +57,7 @@ CONTENTS *ale-contents* hadolint............................|ale-dockerfile-hadolint| elixir................................|ale-elixir-options| mix.................................|ale-elixir-mix| + dialyxir............................|ale-elixir-dialyxir| elm...................................|ale-elm-options| elm-format..........................|ale-elm-elm-format| elm-make............................|ale-elm-elm-make| @@ -301,7 +302,7 @@ Notes: * Dafny: `dafny`!! * Dart: `dartanalyzer`!!, `language_server` * Dockerfile: `hadolint` -* Elixir: `credo`, `dogma`!! +* Elixir: `credo`, `dialyxir`, `dogma`!! * Elm: `elm-format, elm-make` * Erb: `erb`, `erubis` * Erlang: `erlc`, `SyntaxErl` |