summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAntoine Gagné <AntoineGagne@users.noreply.github.com>2021-02-28 08:31:44 -0500
committerGitHub <noreply@github.com>2021-02-28 22:31:44 +0900
commit48fab99a0ab793e1b9607795c21659f12bd6947f (patch)
tree5d554e05d76fb9197e3c89e806490f4cd98b0fac /doc
parent038e4a8c31feb03beea02c09d953affc8c460515 (diff)
downloadale-48fab99a0ab793e1b9607795c21659f12bd6947f.zip
Add support for `erlfmt` fixer (#3602)
* Add support for `erlfmt` * Add missing entry to table of contents * Fix warnings * Add missing tools to supported tools
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-erlang.txt20
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale.txt1
3 files changed, 23 insertions, 0 deletions
diff --git a/doc/ale-erlang.txt b/doc/ale-erlang.txt
index 93ac7915..ede179d1 100644
--- a/doc/ale-erlang.txt
+++ b/doc/ale-erlang.txt
@@ -72,6 +72,26 @@ g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
-------------------------------------------------------------------------------
+erlfmt *ale-erlang-erlfmt*
+
+g:ale_erlang_erlfmt_executable *g:ale_erlang_erlfmt_executable*
+ *b:ale_erlang_erlfmt_executable*
+ Type: |String|
+ Default: `'erlfmt'`
+
+ This variable can be changed to specify the erlfmt executable.
+
+
+g:ale_erlang_erlfmt_options *g:ale_erlang_erlfmt_options*
+ *b:ale_erlang_erlfmt_options*
+ Type: |String|
+ Default: `''`
+
+ This variable controls additional parameters passed to `erlfmt`, such as
+ `--insert-pragma` or `--print-width`.
+
+
+-------------------------------------------------------------------------------
syntaxerl *ale-erlang-syntaxerl*
g:ale_erlang_syntaxerl_executable *g:ale_erlang_syntaxerl_executable*
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index cb90de4c..e6764144 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -150,8 +150,10 @@ Notes:
* `ruumba`
* Erlang
* `SyntaxErl`
+ * `dialyzer`
* `elvis`!!
* `erlc`
+ * `erlfmt`
* Fish
* `fish` (-n flag)
* `fish_indent`
diff --git a/doc/ale.txt b/doc/ale.txt
index 113e29c5..1f7dbe76 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2697,6 +2697,7 @@ documented in additional help files.
dialyzer..............................|ale-erlang-dialyzer|
elvis.................................|ale-erlang-elvis|
erlc..................................|ale-erlang-erlc|
+ erlfmt................................|ale-erlang-erlfmt|
syntaxerl.............................|ale-erlang-syntaxerl|
eruby...................................|ale-eruby-options|
ruumba................................|ale-eruby-ruumba|