summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBartek thindil Jasicki <thindil@laeran.pl>2020-11-27 13:38:24 +0100
committerBartek thindil Jasicki <thindil@laeran.pl>2020-11-27 13:38:24 +0100
commit09b8cc97de2bd78f09c8331be25ede9e4ef8abb1 (patch)
tree62407f3473347c164aaa8960cb6796c790d99ecd /doc
parentf156548c16d87a60664002a4c88c534486b84de5 (diff)
parent1365dce921c1fb84a668ae121d5d5aeebef99fbc (diff)
downloadale-09b8cc97de2bd78f09c8331be25ede9e4ef8abb1.zip
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-erlang.txt12
-rw-r--r--doc/ale-haskell.txt20
-rw-r--r--doc/ale-lua.txt16
-rw-r--r--doc/ale-php.txt73
-rw-r--r--doc/ale-python.txt28
-rw-r--r--doc/ale-r.txt29
-rw-r--r--doc/ale-rust.txt4
-rw-r--r--doc/ale-supported-languages-and-tools.txt8
-rw-r--r--doc/ale-yaml.txt38
-rw-r--r--doc/ale.txt59
10 files changed, 271 insertions, 16 deletions
diff --git a/doc/ale-erlang.txt b/doc/ale-erlang.txt
index 59993a99..38762f08 100644
--- a/doc/ale-erlang.txt
+++ b/doc/ale-erlang.txt
@@ -31,6 +31,18 @@ g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile*
This variable can be changed to specify the profile that is used to
run dialyzer with rebar3.
+
+-------------------------------------------------------------------------------
+elvis *ale-erlang-elvis*
+
+g:ale_erlang_elvis_executable *g:ale_erlang_elvis_executable*
+ *b:ale_erlang_elvis_executable*
+ Type: |String|
+ Default: `'elvis'`
+
+ This variable can be changed to specify the elvis executable.
+
+
-------------------------------------------------------------------------------
erlc *ale-erlang-erlc*
diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt
index 5dd3ec15..fde439fe 100644
--- a/doc/ale-haskell.txt
+++ b/doc/ale-haskell.txt
@@ -173,4 +173,24 @@ g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
===============================================================================
+ormolu *ale-haskell-ormolu*
+
+g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable*
+ *b:ale_haskell_ormolu_executable*
+ Type: |String|
+ Default: `'ormolu'`
+
+ This variable can be changed to use a different executable for ormolu.
+
+
+g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
+ *b:ale_haskell_ormolu_options*
+ Type: String
+ Default: ''
+
+ This variable can be used to pass extra options to the underlying ormolu
+ executable.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-lua.txt b/doc/ale-lua.txt
index f1286f89..408f0c3c 100644
--- a/doc/ale-lua.txt
+++ b/doc/ale-lua.txt
@@ -31,4 +31,20 @@ g:ale_lua_luacheck_options *g:ale_lua_luacheck_options*
===============================================================================
+luafmt *ale-lua-luafmt*
+
+g:ale_lua_luafmt_executable *g:ale_lua_luafmt_executable*
+ *b:ale_lua_luafmt_executable*
+ Type: |String|
+ Default: `'luafmt'`
+
+ This variable can be set to use a different executable for luafmt.
+
+g:ale_lua_luafmt_options *g:ale_lua_luafmt_options*
+ *b:ale_lua_luafmt_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the luafmt 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 9fe868f8..4ee016fb 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -85,6 +85,14 @@ g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global*
See |ale-integrations-local-executables|
+g:ale_php_phpcbf_options *g:ale_php_phpcbf_options*
+ *b:ale_php_phpcbf_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to php-cbf
+
+
===============================================================================
phpcs *ale-php-phpcs*
@@ -243,5 +251,70 @@ g:ale_php_php_executable *g:ale_php_php_executable*
This variable sets the executable used for php.
+
+===============================================================================
+tlint *ale-php-tlint*
+
+g:ale_php_tlint_executable *g:ale_php_tlint_executable*
+ *b:ale_php_tlint_executable*
+ Type: |String|
+ Default: `'tlint'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_php_tlint_use_global *g:ale_php_tlint_use_global*
+ *b:ale_php_tlint_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_php_tlint_options *g:ale_php_tlint_options*
+ *b:ale_php_tlint_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to tlint
+
+
+===============================================================================
+intelephense *ale-php-intelephense*
+
+g:ale_php_intelephense_executable *g:ale_php_intelephense_executable*
+ *b:ale_php_intelephense_executable*
+ Type: |String|
+ Default: `'intelephense'`
+
+ The variable can be set to configure the executable that will be used for
+ running the intelephense language server. `node_modules` directory
+ executable will be preferred instead of this setting if
+ |g:ale_php_intelephense_use_global| is `0`.
+
+ See: |ale-integrations-local-executables|
+
+
+g:ale_php_intelephense_use_global *g:ale_php_intelephense_use_global*
+ *b:ale_php_intelephense_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ This variable can be set to `1` to force the language server to be run with
+ the executable set for |g:ale_php_intelephense_executable|.
+
+ See: |ale-integrations-local-executables|
+
+
+g:ale_php_intelephense_config *g:ale_php_intelephense_config*
+ *b:ale_php_intelephense_config*
+ Type: |Dictionary|
+ Default: `{}`
+
+ The initialization options config specified by Intelephense. Refer to the
+ installation docs provided by intelephense (github.com/bmewburn/intelephense
+ -docs).
+
+
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 6b1a6d33..f0c8bfb8 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -42,6 +42,32 @@ The first directory containing any of the files named above will be used.
===============================================================================
+autoimport *ale-python-autoimport*
+
+g:ale_python_autoimport_executable *g:ale_python_autoimport_executable*
+ *b:ale_python_autoimport_executable*
+ Type: |String|
+ Default: `'autoimport'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_python_autoimport_options *g:ale_python_autoimport_options*
+ *b:ale_python_autoimport_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass extra options to autoimport.
+
+
+g:ale_python_autoimport_use_global *g:ale_python_autoimport_use_global*
+ *b:ale_python_autoimport_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+===============================================================================
autopep8 *ale-python-autopep8*
g:ale_python_autopep8_executable *g:ale_python_autopep8_executable*
@@ -687,7 +713,7 @@ g:ale_python_pyre_auto_pipenv *g:ale_python_pyre_auto_pipenv*
===============================================================================
pyright *ale-python-pyright*
-The `pyrlight` linter requires a recent version of `pyright` which includes
+The `pyright` linter requires a recent version of `pyright` which includes
the `pyright-langserver` executable. You can install `pyright` on your system
through `npm` with `sudo npm install -g pyright` or similar.
diff --git a/doc/ale-r.txt b/doc/ale-r.txt
index b5ccebe5..3fabf702 100644
--- a/doc/ale-r.txt
+++ b/doc/ale-r.txt
@@ -3,6 +3,29 @@ ALE R Integration *ale-r-options*
===============================================================================
+languageserver *ale-r-languageserver*
+
+g:ale_r_languageserver_cmd *g:ale_r_languageserver_cmd*
+ *b:ale_r_languageserver_cmd*
+ Type: |String|
+ Default: `'languageserver::run()'`
+
+ This option can be configured to change the execution command for
+ languageserver.
+
+ See the languageserver documentation for more options.
+
+
+g:ale_r_languageserver_config *g:ale_r_languageserver_config*
+ *b:ale_r_languageserver_config*
+ Type: |Dictionary|
+ Default: `{}`
+
+ This option can be configured to change settings for languageserver. See the
+ languageserver documentation for more information.
+
+
+===============================================================================
lintr *ale-r-lintr*
g:ale_r_lintr_options *g:ale_r_lintr_options*
@@ -22,7 +45,7 @@ g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package*
Default: `0`
When set to `1`, the file will be checked with `lintr::lint_package` instead
- of `lintr::lint`. This prevents erroneous namespace warnings when linting
+ of `lintr::lint`. This prevents erroneous namespace warnings when linting
package files.
@@ -36,8 +59,8 @@ g:ale_r_styler_options *g:ale_r_styler_options*
This option can be configured to change the options for styler.
- The value of this option will be used as the `style` argument for the
- `styler::style_file` options. Consult the styler documentation
+ The value of this option will be used as the `style` argument for the
+ `styler::style_file` options. Consult the styler documentation
for more information.
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index f4b4e7b7..3aa63673 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -22,12 +22,12 @@ Integration Information
3. rls -- If you have `rls` installed, you might prefer using this linter
over cargo. rls implements the Language Server Protocol for incremental
compilation of Rust code, and can check Rust files while you type. `rls`
- requires Rust files to contained in Cargo projects.
+ requires Rust files to be contained in Cargo projects.
4. analyzer -- If you have rust-analyzer installed, you might prefer using
this linter over cargo and rls. rust-analyzer also implements the
Language Server Protocol for incremental compilation of Rust code, and is
the next iteration of rls. rust-analyzer, like rls, requires Rust files
- to contained in Cargo projects.
+ to be contained in Cargo projects.
5. rustfmt -- If you have `rustfmt` installed, you can use it as a fixer to
consistently reformat your Rust code.
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index bb933997..449bf6d8 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -141,6 +141,7 @@ Notes:
* `erubis`
* `ruumba`
* Erlang
+ * `elvis`!!
* `erlc`
* `SyntaxErl`
* Fish
@@ -196,6 +197,7 @@ Notes:
* `hie`
* `hindent`
* `hlint`
+ * `ormolu`
* `stack-build`!!
* `stack-ghc`
* `stylish-haskell`
@@ -266,6 +268,7 @@ Notes:
* Lua
* `luac`
* `luacheck`
+ * `luafmt`
* Mail
* `alex`!!
* `languagetool`!!
@@ -325,6 +328,7 @@ Notes:
* Perl6
* `perl6 -c`
* PHP
+ * `intelephense`
* `langserver`
* `phan`
* `phpcbf`
@@ -334,6 +338,7 @@ Notes:
* `phpmd`
* `phpstan`
* `psalm`!!
+ * `tlint`
* PO
* `alex`!!
* `msgfmt`
@@ -362,6 +367,7 @@ Notes:
* `purescript-language-server`
* `purty`
* Python
+ * `autoimport`
* `autopep8`
* `bandit`
* `black`
@@ -384,6 +390,7 @@ Notes:
* `qmlfmt`
* `qmllint`
* R
+ * `languageserver`
* `lintr`
* `styler`
* Racket
@@ -518,6 +525,7 @@ Notes:
* YAML
* `prettier`
* `swaglint`
+ * `yamlfix`
* `yamllint`
* YANG
* `yang-lsp`
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index c9a12ea1..61bfc139 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -15,7 +15,6 @@ Install prettier either globally or locally: >
npm install prettier -g # global
npm install prettier # local
<
-
===============================================================================
swaglint *ale-yaml-swaglint*
@@ -49,6 +48,43 @@ g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global*
See |ale-integrations-local-executables|
+===============================================================================
+yamlfix *ale-yaml-yamlfix*
+
+Website: https://lyz-code.github.io/yamlfix
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install yamlfix: >
+
+ pip install yamlfix
+<
+
+Options
+-------------------------------------------------------------------------------
+g:ale_yaml_yamlfix_executable *g:ale_yaml_yamlfix_executable*
+ *b:ale_yaml_yamlfix_executable*
+ Type: |String|
+ Default: `'yamlfix'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_yaml_yamlfix_options *g:ale_yaml_yamlfix_options*
+ *b:ale_yaml_yamlfix_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass extra options to yamlfix.
+
+g:ale_yaml_yamlfix_use_global *g:ale_yaml_yamlfix_use_global*
+ *b:ale_yaml_yamlfix_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
===============================================================================
yamllint *ale-yaml-yamllint*
diff --git a/doc/ale.txt b/doc/ale.txt
index 4f8ba7cc..389447df 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -673,13 +673,31 @@ for a full list of options.
-------------------------------------------------------------------------------
5.7 Refactoring: Rename, Actions *ale-refactor*
-ALE supports renaming symbols in symbols in code such as variables or class
-names with the |ALERename| command.
+ALE supports renaming symbols in code such as variables or class names with
+the |ALERename| command.
|ALECodeAction| will execute actions on the cursor or applied to a visual
range selection, such as automatically fixing errors.
+Actions will appear in the right click mouse menu by default for GUI versions
+of Vim, unless disabled by setting |g:ale_popup_menu_enabled| to `0`.
+Make sure to set your Vim to move the cursor position whenever you right
+click, and enable the mouse menu: >
+
+ set mouse=a
+ set mousemodel=popup_setpos
+<
+You may wish to remove some other menu items you don't want to see: >
+
+ silent! aunmenu PopUp.Select\ Word
+ silent! aunmenu PopUp.Select\ Sentence
+ silent! aunmenu PopUp.Select\ Paragraph
+ silent! aunmenu PopUp.Select\ Line
+ silent! aunmenu PopUp.Select\ Block
+ silent! aunmenu PopUp.Select\ Blockwise
+ silent! aunmenu PopUp.Select\ All
+<
===============================================================================
6. Global Options *ale-options*
@@ -1676,6 +1694,7 @@ g:ale_lsp_root *g:ale_lsp_root*
If neither variable yields a result, a linter-specific function is invoked to
detect a project root. If this, too, yields no result, the linter is disabled.
+
g:ale_max_buffer_history_size *g:ale_max_buffer_history_size*
Type: |Number|
@@ -1784,6 +1803,19 @@ g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
will not set buffer variables per |g:ale_pattern_options|.
+g:ale_popup_menu_enabled *g:ale_popup_menu_enabled*
+
+ Type: |Number|
+ Default: `has('gui_running')`
+
+ When this option is set to `1`, ALE will show code actions and rename
+ capabilities in the right click mouse menu when there's a LSP server or
+ tsserver available. See |ale-refactor|.
+
+ This setting must be set to `1` before ALE is loaded for this behavior
+ to be enabled. See |ale-lint-settings-on-startup|.
+
+
g:ale_rename_tsserver_find_in_comments *g:ale_rename_tsserver_find_in_comments*
Type: |Number|
@@ -1808,7 +1840,7 @@ g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons*
- Type: |Number|
+ Type: |Number| or |String|
Default: `has('balloon_eval') && has('gui_running')`
When this option is set to `1`, balloon messages will be displayed for
@@ -1819,6 +1851,13 @@ g:ale_set_balloons *g:ale_set_balloons*
supporting "Hover" information, per |ale-hover|, then brief information
about the symbol under the cursor will be displayed in a balloon.
+ This option can be set to `'hover'` to only enable balloons for hover
+ message, so diagnostics are never shown in balloons. You may wish to
+ configure use this setting only in GUI Vim like so: >
+
+ let g:ale_set_balloons = has('gui_running') ? 'hover' : 0
+<
+
Balloons can be enabled for terminal versions of Vim that support balloons,
but some versions of Vim will produce strange mouse behavior when balloons
are enabled. To configure balloons for your terminal, you should first
@@ -2601,6 +2640,7 @@ documented in additional help files.
elm-make..............................|ale-elm-elm-make|
erlang..................................|ale-erlang-options|
dialyzer..............................|ale-erlang-dialyzer|
+ elvis.................................|ale-erlang-elvis|
erlc..................................|ale-erlang-erlc|
syntaxerl.............................|ale-erlang-syntaxerl|
eruby...................................|ale-eruby-options|
@@ -2654,6 +2694,7 @@ documented in additional help files.
stack-ghc.............................|ale-haskell-stack-ghc|
stylish-haskell.......................|ale-haskell-stylish-haskell|
hie...................................|ale-haskell-hie|
+ ormolu................................|ale-haskell-ormolu|
hcl.....................................|ale-hcl-options|
terraform-fmt.........................|ale-hcl-terraform-fmt|
html....................................|ale-html-options|
@@ -2713,6 +2754,7 @@ documented in additional help files.
lua.....................................|ale-lua-options|
luac..................................|ale-lua-luac|
luacheck..............................|ale-lua-luacheck|
+ luafmt................................|ale-lua-luafmt|
markdown................................|ale-markdown-options|
markdownlint..........................|ale-markdown-markdownlint|
mdl...................................|ale-markdown-mdl|
@@ -2764,6 +2806,8 @@ documented in additional help files.
psalm.................................|ale-php-psalm|
php-cs-fixer..........................|ale-php-php-cs-fixer|
php...................................|ale-php-php|
+ tlint.................................|ale-php-tlint|
+ intelephense..........................|ale-php-intelephense|
po......................................|ale-po-options|
write-good............................|ale-po-write-good|
pod.....................................|ale-pod-options|
@@ -2789,6 +2833,7 @@ documented in additional help files.
pyrex (cython)..........................|ale-pyrex-options|
cython................................|ale-pyrex-cython|
python..................................|ale-python-options|
+ autoimport............................|ale-python-autoimport|
autopep8..............................|ale-python-autopep8|
bandit................................|ale-python-bandit|
black.................................|ale-python-black|
@@ -2810,6 +2855,7 @@ documented in additional help files.
qml.....................................|ale-qml-options|
qmlfmt................................|ale-qml-qmlfmt|
r.......................................|ale-r-options|
+ languageserver........................|ale-r-languageserver|
lintr.................................|ale-r-lintr|
styler................................|ale-r-styler|
reasonml................................|ale-reasonml-options|
@@ -2926,6 +2972,7 @@ documented in additional help files.
yaml....................................|ale-yaml-options|
prettier..............................|ale-yaml-prettier|
swaglint..............................|ale-yaml-swaglint|
+ yamlfix...............................|ale-yaml-yamlfix|
yamllint..............................|ale-yaml-yamllint|
yang....................................|ale-yang-options|
yang-lsp..............................|ale-yang-lsp|
@@ -3111,12 +3158,6 @@ ALERename *ALERename*
The symbol where the cursor is resting will be the symbol renamed, and a
prompt will open to request a new name.
- ALE will refuse to complete a rename operation if there are files to modify
- which have not yet been saved in Vim. If the command is run with a bang
- (`:ALERename!`), all warnings will be suppressed, and files that are still
- open in Vim and not saved will be ignored and left in a state where symbols
- in those files will not be updated.
-
ALECodeAction *ALECodeAction*