summaryrefslogtreecommitdiff
path: root/doc/ale-elixir.txt
diff options
context:
space:
mode:
authorDavid Houston <houstdav000@gmail.com>2021-11-18 17:41:05 -0500
committerGitHub <noreply@github.com>2021-11-19 07:41:05 +0900
commitea643b97ab08e571a543f4bd89cd3170f3f288e2 (patch)
treef701724bf0911b445107fc5caa23d6d1503de260 /doc/ale-elixir.txt
parentaee0cc45bea7f190c27f0fc06f98a465ecff56fa (diff)
downloadale-ea643b97ab08e571a543f4bd89cd3170f3f288e2.zip
Add cspell Linter (#3981)
* Add cspell linter Add cspell linter, with the languages it supports. Signed-off-by: David Houston <houstdav000@gmail.com> * Add cspell Global Variables Documentation Add documentation to /doc/ale.txt with cspell configuration options. Signed-off-by: David Houston <houstdav000@gmail.com> * Add cspell to docs, Minor Cleanup Add cspell for each supported language, adding some spaces and removing others when caught navigating the file. Signed-off-by: David Houston <houstdav000@gmail.com>
Diffstat (limited to 'doc/ale-elixir.txt')
-rw-r--r--doc/ale-elixir.txt24
1 files changed, 18 insertions, 6 deletions
diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt
index a4e5c2c6..693db5aa 100644
--- a/doc/ale-elixir.txt
+++ b/doc/ale-elixir.txt
@@ -5,7 +5,6 @@ ALE Elixir Integration *ale-elixir-options*
===============================================================================
mix *ale-elixir-mix*
-
The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters`
@@ -18,6 +17,7 @@ g:ale_elixir_mix_options *g:ale_elixir_mix_options*
This variable can be changed to specify the mix executable.
+
===============================================================================
mix_format *ale-elixir-mix-format*
@@ -30,6 +30,7 @@ g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
This variable can be changed to specify the mix options passed to the
mix_format fixer
+
===============================================================================
dialyxir *ale-elixir-dialyxir*
@@ -45,6 +46,7 @@ configured on your project's `mix.exs`.
See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more
information.
+
===============================================================================
elixir-ls *ale-elixir-elixir-ls*
@@ -72,6 +74,8 @@ g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*
\ }
<
Consult the ElixirLS documentation for more information about settings.
+
+
===============================================================================
credo *ale-elixir-credo*
@@ -79,18 +83,26 @@ Credo (https://github.com/rrrene/credo)
g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*
- Type: Integer
- Default: 0
+ Type: |Integer|
+ Default: `0`
Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode.
-g:ale_elixir_credo_config_file g:ale_elixir_credo_config_file
- Type: String
- Default: ''
+g:ale_elixir_credo_config_file *g:ale_elixir_credo_config_file*
+
+ Type: |String|
+ Default: `''`
Tells credo to use a custom configuration file.
+
+===============================================================================
+cspell *ale-elixir-cspell*
+
+See |ale-cspell-options|
+
+
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: