summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-elm.txt14
-rw-r--r--doc/ale-html.txt10
-rw-r--r--doc/ale-nim.txt45
-rw-r--r--doc/ale-nix.txt24
-rw-r--r--doc/ale-php.txt11
-rw-r--r--doc/ale-purescript.txt9
-rw-r--r--doc/ale-ruby.txt26
-rw-r--r--doc/ale-scala.txt26
-rw-r--r--doc/ale-supported-languages-and-tools.txt10
-rw-r--r--doc/ale-typescript.txt27
-rw-r--r--doc/ale.txt143
11 files changed, 334 insertions, 11 deletions
diff --git a/doc/ale-elm.txt b/doc/ale-elm.txt
index 823b53e1..b1510241 100644
--- a/doc/ale-elm.txt
+++ b/doc/ale-elm.txt
@@ -50,7 +50,7 @@ g:ale_elm_ls_use_global *g:ale_elm_ls_use_global*
g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
*b:ale_elm_ls_elm_path*
Type: |String|
- Default: `'elm'`
+ Default: `''`
See |ale-integrations-local-executables|
@@ -58,7 +58,7 @@ g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
*b:ale_elm_ls_elm_format_path*
Type: |String|
- Default: `'elm-format'`
+ Default: `''`
See |ale-integrations-local-executables|
@@ -66,10 +66,18 @@ g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
g:ale_elm_ls_elm_test_path *g:ale_elm_ls_elm_test_path*
*b:ale_elm_ls_elm_test_path*
Type: |String|
- Default: `'elm-test'`
+ Default: `''`
See |ale-integrations-local-executables|
+
+g:ale_elm_ls_elm_analyse_trigger *g:ale_elm_ls_elm_analyse_trigger*
+ *b:ale_elm_ls_elm_analyse_trigger*
+ Type: |String|
+ Default: `'change'`
+
+ One of 'change', 'save' or 'never'
+
===============================================================================
elm-make *ale-elm-elm-make*
diff --git a/doc/ale-html.txt b/doc/ale-html.txt
index 5d6b20e2..c78dc4cd 100644
--- a/doc/ale-html.txt
+++ b/doc/ale-html.txt
@@ -9,6 +9,16 @@ fecs *ale-html-fecs*
and both of them reads `./.fecsrc` as the default configuration file.
See: |ale-javascript-fecs|.
+===============================================================================
+html-beautify *ale-html-beautify*
+
+g:ale_html_beautify_options *g:ale_html_beautify_options*
+ *b:ale_html_beautify_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to html-beautify.
+
===============================================================================
htmlhint *ale-html-htmlhint*
diff --git a/doc/ale-nim.txt b/doc/ale-nim.txt
new file mode 100644
index 00000000..8985aeb8
--- /dev/null
+++ b/doc/ale-nim.txt
@@ -0,0 +1,45 @@
+===============================================================================
+ALE Nim Integration *ale-nim-options*
+
+
+===============================================================================
+nimcheck *ale-nim-nimcheck*
+
+ ALE does not provide additional configuration options for `nimcheck` at this
+ point.
+
+
+===============================================================================
+nimlsp *ale-nim-nimlsp*
+
+g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources*
+
+ Type: |String|
+ Default: `''`
+
+ Sets the path to Nim source repository as the first argument to `nimlsp`
+ command.
+
+
+===============================================================================
+nimpretty *ale-nim-nimpretty*
+
+
+g:ale_nim_nimpretty_executable *g:ale_nim_nimpretty_executable*
+ *b:ale_nim_nimpretty_executable*
+ Type: |String|
+ Default: `'nimpretty'`
+
+ This variable can be changed to use a different executable for nimpretty.
+
+
+g:ale_nim_nimpretty_options *g:ale_nim_nimpretty_options*
+ *b:ale_nim_nimpretty_options*
+ Type: |String|
+ Default: `'--maxLineLen:80'`
+
+ This variable can be changed to modify flags given to nimpretty.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-nix.txt b/doc/ale-nix.txt
new file mode 100644
index 00000000..5b2bd6cb
--- /dev/null
+++ b/doc/ale-nix.txt
@@ -0,0 +1,24 @@
+===============================================================================
+ALE Nix Integration *ale-nix-options*
+
+
+===============================================================================
+nixpkgs-fmt *ale-nix-nixpkgs-fmt*
+
+g:ale_nix_nixpkgsfmt_executable *g:ale_nix_nixpkgsfmt_executable*
+ *b:ale_nix_nixpkgsfmt_executable*
+ Type: |String|
+ Default: `'nixpkgs-fmt'`
+
+ This variable sets executable used for nixpkgs-fmt.
+
+g:ale_nix_nixpkgsfmt_options *g:ale_nix_nixpkgsfmt_options*
+ *b:ale_nix_nixpkgsfmt_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the nixpkgs-fmt fixer.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-php.txt b/doc/ale-php.txt
index d41fb50d..645decd7 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -157,9 +157,9 @@ g:ale_php_phpstan_level *g:ale_php_phpstan_level*
Type: |String|
Default: `''`
- This variable controls the rule levels. 0 is the loosest and 4 is the
+ This variable controls the rule levels. 0 is the loosest and 7 is the
strictest. If this option isn't set, the rule level will be controlled by
- the configuration file. If no configuration file can be detected, `'4'` will
+ the configuration file. If no configuration file can be detected, `'7'` will
be used instead.
@@ -189,6 +189,13 @@ g:ale_php_psalm_executable *g:ale_php_psalm_executable*
This variable sets the executable used for psalm.
+g:ale_psalm_langserver_options *g:ale_psalm_langserver_options*
+ *b:ale_psalm_langserver_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to psalm.
+
===============================================================================
php-cs-fixer *ale-php-php-cs-fixer*
diff --git a/doc/ale-purescript.txt b/doc/ale-purescript.txt
index 33fd2429..e809f2c9 100644
--- a/doc/ale-purescript.txt
+++ b/doc/ale-purescript.txt
@@ -30,4 +30,13 @@ g:ale_purescript_ls_config g:ale_purescript_ls_config
\ }
\}
===============================================================================
+purty *ale-purescript-purty*
+
+g:ale_purescript_purty_executable *g:ale_purescript_purty_executable*
+ *b:ale_purescript_purty_executable*
+ Type: |String|
+ Default: `'purty'`
+
+ This variable can be changed to use a different executable for purty.
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index e373ab8e..a27a20b2 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -21,6 +21,26 @@ g:ale_ruby_brakeman_options *g:ale_ruby_brakeman_options*
The contents of this variable will be passed through to brakeman.
+===============================================================================
+debride *ale-ruby-debride*
+
+g:ale_ruby_debride_executable *g:ale_ruby_debride_executable*
+ *b:ale_ruby_debride_executable*
+ Type: String
+ Default: `'debride'`
+
+ Override the invoked debride binary. Set this to `'bundle'` to invoke
+ `'bundle` `exec` debride'.
+
+
+g:ale_ruby_debride_options *g:ale_ruby_debride_options*
+ *b:ale_ruby_debride_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to debride.
+
+
===============================================================================
rails_best_practices *ale-ruby-rails_best_practices*
@@ -91,7 +111,7 @@ g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
Type: |String|
Default: `''`
- This variable can be change to modify flags given to rubocop.
+ This variable can be changed to modify flags given to rubocop.
===============================================================================
@@ -146,7 +166,7 @@ g:ale_ruby_sorbet_options *g:ale_ruby_sorbet_options*
Type: |String|
Default: `''`
- This variable can be change to modify flags given to sorbet.
+ This variable can be changed to modify flags given to sorbet.
===============================================================================
@@ -166,7 +186,7 @@ g:ale_ruby_standardrb_options *g:ale_ruby_standardrb_options*
Type: |String|
Default: `''`
- This variable can be change to modify flags given to standardrb.
+ This variable can be changed to modify flags given to standardrb.
===============================================================================
diff --git a/doc/ale-scala.txt b/doc/ale-scala.txt
index ff43cd6c..c9638baf 100644
--- a/doc/ale-scala.txt
+++ b/doc/ale-scala.txt
@@ -3,6 +3,32 @@ ALE Scala Integration *ale-scala-options*
===============================================================================
+metals *ale-scala-metals*
+
+`metals` requires either an SBT project, a Mill project, or a running Bloop
+server.
+
+
+g:ale_scala_metals_executable *g:ale_scala_metals_executable*
+ *b:ale_scala_metals_executable*
+ Type: |String|
+ Default: `'metals-vim'`
+
+ Override the invoked `metals` binary.
+
+
+g:ale_scala_metals_project_root *g:ale_scala_metals_project_root*
+ *b:ale_scala_metals_project_root*
+ Type: |String|
+ Default: `''`
+
+ By default the project root is found by searching upwards for `build.sbt`,
+ `build.sc`, `.bloop` or `.metals`.
+ If the project root is elsewhere, you can override the project root
+ directory.
+
+
+===============================================================================
sbtserver *ale-scala-sbtserver*
`sbtserver` requires a running ^1.1.x sbt shell to connect to. It will attempt
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index a29ea6a3..29dabab7 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -124,7 +124,7 @@ Notes:
* `mix`!!
* Elm
* `elm-format`
- * `elm-lsp`
+ * `elm-ls`
* `elm-make`
* Erb
* `erb`
@@ -194,6 +194,7 @@ Notes:
* HTML
* `alex`!!
* `fecs`
+ * `html-beautify`
* `HTMLHint`
* `prettier`
* `proselint`
@@ -282,8 +283,11 @@ Notes:
* `nasm`!!
* Nim
* `nim check`!!
+ * `nimlsp`
+ * `nimpretty`
* nix
* `nix-instantiate`
+ * `nixpkgs-fmt`
* nroff
* `alex`!!
* `proselint`
@@ -346,6 +350,7 @@ Notes:
* `puppet-lint`
* PureScript
* `purescript-language-server`
+ * `purty`
* Python
* `autopep8`
* `bandit`
@@ -391,6 +396,7 @@ Notes:
* `rpmlint`
* Ruby
* `brakeman`
+ * `debride`
* `rails_best_practices`!!
* `reek`
* `rubocop`
@@ -409,6 +415,7 @@ Notes:
* `stylelint`
* Scala
* `fsc`
+ * `metals`
* `sbtserver`
* `scalac`
* `scalafmt`
@@ -462,6 +469,7 @@ Notes:
* `eslint`
* `fecs`
* `prettier`
+ * `standard`
* `tslint`
* `tsserver`
* `typecheck`
diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt
index 7dc59820..2c50d119 100644
--- a/doc/ale-typescript.txt
+++ b/doc/ale-typescript.txt
@@ -17,6 +17,33 @@ See |ale-javascript-prettier| for information about the available options.
===============================================================================
+standard *ale-typescript-standard*
+
+g:ale_typescript_standard_executable *g:ale_typescript_standard_executable*
+ *b:ale_typescript_standard_executable*
+ Type: |String|
+ Default: `'standard'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_typescript_standard_options *g:ale_typescript_standard_options*
+ *b:ale_typescript_standard_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to standard.
+
+
+g:ale_typescript_standard_use_global *g:ale_typescript_standard_use_global*
+ *b:ale_typescript_standard_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
tslint *ale-typescript-tslint*
This linter isn't recommended, because TSLint can't be used for checking for
diff --git a/doc/ale.txt b/doc/ale.txt
index b368afd3..847a9777 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -172,7 +172,7 @@ address to connect to instead. >
call ale#linter#Define('filetype_here', {
\ 'name': 'any_name_you_want',
- \ 'lsp': 'stdio',
+ \ 'lsp': 'socket',
\ 'address': 'servername:1234',
\ 'project_root': '/path/to/root_of_project',
\})
@@ -432,7 +432,42 @@ vimrc, and your issues should go away. >
set completeopt=menu,menuone,preview,noselect,noinsert
<
-
+ *ale-symbols*
+
+ALE provides a set of basic completion symbols. If you want to replace those
+symbols with others, you can set the variable |g:ale_completion_symbols| with
+a mapping of the type of completion to the symbol or other string that you
+would like to use. An example here shows the available options for symbols >
+
+ let g:ale_completion_symbols = {
+ \ 'text': '',
+ \ 'method': '',
+ \ 'function': '',
+ \ 'constructor': '',
+ \ 'field': '',
+ \ 'variable': '',
+ \ 'class': '',
+ \ 'interface': '',
+ \ 'module': '',
+ \ 'property': '',
+ \ 'unit': 'unit',
+ \ 'value': 'val',
+ \ 'enum': '',
+ \ 'keyword': 'keyword',
+ \ 'snippet': '',
+ \ 'color': 'color',
+ \ 'file': '',
+ \ 'reference': 'ref',
+ \ 'folder': '',
+ \ 'enum member': '',
+ \ 'constant': '',
+ \ 'struct': '',
+ \ 'event': 'event',
+ \ 'operator': '',
+ \ 'type_parameter': 'type param',
+ \ '<default>': 'v'
+ \ }
+<
-------------------------------------------------------------------------------
5.2 Go To Definition *ale-go-to-definition*
@@ -671,6 +706,47 @@ g:ale_completion_excluded_words *g:ale_completion_excluded_words*
let b:ale_completion_excluded_words = ['it', 'describe']
<
+g:ale_completion_symbols *g:ale_completion_symbols*
+
+ Type: |Dictionary|
+
+
+ A mapping from completion types to symbols for completions. See
+ |ale-symbols| for more information.
+
+ By default, this mapping only uses built in Vim completion kinds, but it can
+ be updated to use any unicode character for the completion kind. For
+ example: >
+ let g:ale_completion_symbols = {
+ \ 'text': '',
+ \ 'method': '',
+ \ 'function': '',
+ \ 'constructor': '',
+ \ 'field': '',
+ \ 'variable': '',
+ \ 'class': '',
+ \ 'interface': '',
+ \ 'module': '',
+ \ 'property': '',
+ \ 'unit': 'v',
+ \ 'value': 'v',
+ \ 'enum': 't',
+ \ 'keyword': 'v',
+ \ 'snippet': 'v',
+ \ 'color': 'v',
+ \ 'file': 'v',
+ \ 'reference': 'v',
+ \ 'folder': 'v',
+ \ 'enum_member': 'm',
+ \ 'constant': 'm',
+ \ 'struct': 't',
+ \ 'event': 'v',
+ \ 'operator': 'f',
+ \ 'type_parameter': 'p',
+ \ '<default>': 'v'
+ \ })
+<
+
g:ale_completion_max_suggestions *g:ale_completion_max_suggestions*
Type: |Number|
@@ -801,6 +877,15 @@ g:ale_echo_msg_info_str *g:ale_echo_msg_info_str*
The string used for `%severity%` for info. See |g:ale_echo_msg_format|
+g:ale_echo_msg_log_str *g:ale_echo_msg_log_str*
+
+ Type: |String|
+ Default: `'Log'`
+
+ The string used for `%severity%` for log, used only for handling LSP show
+ message requests. See |g:ale_lsp_show_message_format|
+
+
g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
Type: |String|
@@ -1251,6 +1336,47 @@ b:ale_loclist_msg_format *b:ale_loclist_msg_format*
The strings for configuring `%severity%` are also used for this option.
+
+g:ale_lsp_show_message_format *g:ale_lsp_show_message_format*
+
+ Type: |String|
+ Default: `'%severity%:%linter%: %s'`
+
+ This variable defines the format that messages received from an LSP will
+ have when echoed. The following sequences of characters will be replaced.
+
+ `%s` - replaced with the message text
+ `%linter%` - replaced with the name of the linter
+ `%severity%` - replaced with the severity of the message
+
+ The strings for `%severity%` levels "error", "info" and "warning" are shared
+ with |g:ale_echo_msg_format|. Severity "log" is unique to
+ |g:ale_lsp_show_message_format| and it can be configured via
+
+ |g:ale_echo_msg_log_str| - Defaults to `'Log'`
+
+ Please note that |g:ale_lsp_show_message_format| *can not* be configured
+ separately for each buffer like |g:ale_echo_msg_format| can.
+
+
+g:ale_lsp_show_message_severity *g:ale_lsp_show_message_severity*
+
+ Type: |String|
+ Default: `'error'`
+
+ This variable defines the minimum severity level an LSP message needs to be
+ displayed. Messages below this level are discarded; please note that
+ messages with `Log` severity level are always discarded.
+
+ Possible values follow the LSP spec `MessageType` definition:
+
+ `'error'` - Displays only errors.
+ `'warning'` - Displays errors and warnings.
+ `'information'` - Displays errors, warnings and infos
+ `'log'` - Same as `'information'`
+ `'disabled'` - Doesn't display any information at all.
+
+
g:ale_lsp_root *g:ale_lsp_root*
b:ale_lsp_root *b:ale_lsp_root*
@@ -1709,6 +1835,8 @@ g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
Type: |Number|
Default: `0`
+ This option only has any effect in NeoVim.
+
When this option is set to `1`, a message will be shown when a cursor is
near a warning or error. ALE will attempt to find the warning or error at a
column nearest to the cursor when the cursor is resting on a line which
@@ -2241,6 +2369,7 @@ documented in additional help files.
terraform-fmt.........................|ale-hcl-terraform-fmt|
html....................................|ale-html-options|
fecs..................................|ale-html-fecs|
+ html-beautify.........................|ale-html-beautify|
htmlhint..............................|ale-html-htmlhint|
tidy..................................|ale-html-tidy|
prettier..............................|ale-html-prettier|
@@ -2305,6 +2434,12 @@ documented in additional help files.
mmc...................................|ale-mercury-mmc|
nasm....................................|ale-nasm-options|
nasm..................................|ale-nasm-nasm|
+ nim.....................................|ale-nim-options|
+ nimcheck..............................|ale-nim-nimcheck|
+ nimlsp................................|ale-nim-nimlsp|
+ nimpretty.............................|ale-nim-nimpretty|
+ nix.....................................|ale-nix-options|
+ nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
nroff...................................|ale-nroff-options|
write-good............................|ale-nroff-write-good|
objc....................................|ale-objc-options|
@@ -2360,6 +2495,7 @@ documented in additional help files.
puppet-languageserver.................|ale-puppet-languageserver|
purescript..............................|ale-purescript-options|
purescript-language-server............|ale-purescript-language-server|
+ purty.................................|ale-purescript-purty|
pyrex (cython)..........................|ale-pyrex-options|
cython................................|ale-pyrex-cython|
python..................................|ale-python-options|
@@ -2395,6 +2531,7 @@ documented in additional help files.
write-good............................|ale-restructuredtext-write-good|
ruby....................................|ale-ruby-options|
brakeman..............................|ale-ruby-brakeman|
+ debride...............................|ale-ruby-debride|
rails_best_practices..................|ale-ruby-rails_best_practices|
reek..................................|ale-ruby-reek|
rubocop...............................|ale-ruby-rubocop|
@@ -2412,6 +2549,7 @@ documented in additional help files.
sasslint..............................|ale-sass-sasslint|
stylelint.............................|ale-sass-stylelint|
scala...................................|ale-scala-options|
+ metals................................|ale-scala-metals|
sbtserver.............................|ale-scala-sbtserver|
scalafmt..............................|ale-scala-scalafmt|
scalastyle............................|ale-scala-scalastyle|
@@ -2463,6 +2601,7 @@ documented in additional help files.
typescript..............................|ale-typescript-options|
eslint................................|ale-typescript-eslint|
prettier..............................|ale-typescript-prettier|
+ standard..............................|ale-typescript-standard|
tslint................................|ale-typescript-tslint|
tsserver..............................|ale-typescript-tsserver|
vala....................................|ale-vala-options|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-07 16:44:57 +0000