Merge remote-tracking branch 'upstream/master'

1 files changed, 188 insertions, 77 deletions

diff --git a/doc/ale.txt b/doc/ale.txt
index 70a28515..497a4786 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -433,17 +433,54 @@ vimrc, and your issues should go away. >
   set completeopt=menu,menuone,preview,noselect,noinsert
 <
 
+Or alternatively, if you want to show documentation in popups: >
+
+  set completeopt=menu,menuone,popup,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*
 
 ALE supports jumping to the files and locations where symbols are defined
 through any enabled LSP linters. The locations ALE will jump to depend on the
-information returned by LSP servers. The following commands are supported:
-
-|ALEGoToDefinition|      - Open the definition of the symbol under the cursor.
-|ALEGoToDefinitionInTab| - The same, but for opening the file in a new tab.
-|ALEGoToDefinitionInSplit| - The same, but in a new split.
-|ALEGoToDefinitionInVSplit| - The same, but in a new vertical split.
+information returned by LSP servers. The |ALEGoToDefinition| command will jump
+to the definition of symbols under the cursor. See the documentation for the
+command for configuring how the location will be displayed.
 
 ALE will update Vim's |tagstack| automatically unless |g:ale_update_tagstack| is
 set to `0`.
@@ -453,15 +490,10 @@ set to `0`.
 
 ALE supports jumping to the files and locations where symbols' types are
 defined through any enabled LSP linters. The locations ALE will jump to depend
-on the information returned by LSP servers. The following commands are
-supported:
-
-|ALEGoToTypeDefinition|      - Open the definition of the symbol's type under
-                             the cursor.
-|ALEGoToTypeDefinitionInTab| - The same, but for opening the file in a new tab.
-|ALEGoToTypeDefinitionInSplit| - The same, but in a new split.
-|ALEGoToTypeDefinitionInVSplit| - The same, but in a new vertical split.
-
+on the information returned by LSP servers. The |ALEGoToTypeDefinition|
+command will jump to the definition of symbols under the cursor. See the
+documentation for the command for configuring how the location will be
+displayed.
 
 -------------------------------------------------------------------------------
 5.4 Find References                                       *ale-find-references*
@@ -490,6 +522,9 @@ the mouse over a symbol in a buffer. Diagnostic information will take priority
 over hover information for balloons. If a line contains a problem, that
 problem will be displayed in a balloon instead of hover information.
 
+Hover information can be displayed in the preview window instead by setting
+|g:ale_hover_to_preview| to `1`.
+
 For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
 |balloonexpr| commands in terminals can cause scrolling issues in terminals,
 so ALE will not attempt to show balloons unless |g:ale_set_balloons| is set to
@@ -623,7 +658,7 @@ g:ale_completion_delay                                 *g:ale_completion_delay*
 
 
 g:ale_completion_enabled                             *g:ale_completion_enabled*
-b:ale_completion_enabled                             *b:ale_completion_enabled*
+                                                     *b:ale_completion_enabled*
 
   Type: |Number|
   Default: `0`
@@ -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|
@@ -709,6 +785,16 @@ g:ale_cursor_detail                                       *g:ale_cursor_detail*
   loaded for messages to be displayed. See |ale-lint-settings-on-startup|.
 
 
+g:ale_default_navigation                             *g:ale_default_navigation*
+                                                     *b:ale_default_navigation*
+
+  Type: |String|
+  Default: `'buffer'`
+
+  The default method for navigating away from the current buffer to another
+  buffer, such as for |ALEFindReferences:|, or |ALEGoToDefinition|.
+
+
 g:ale_disable_lsp                                           *g:ale_disable_lsp*
                                                             *b:ale_disable_lsp*
 
@@ -761,7 +847,7 @@ g:ale_echo_msg_error_str                             *g:ale_echo_msg_error_str*
 
 
 g:ale_echo_msg_format                                   *g:ale_echo_msg_format*
-b:ale_echo_msg_format                                   *b:ale_echo_msg_format*
+                                                        *b:ale_echo_msg_format*
 
   Type: |String|
   Default: `'%code: %%s'`
@@ -839,6 +925,21 @@ g:ale_enabled                                                   *g:ale_enabled*
   See |g:ale_pattern_options| for more information on that option.
 
 
+g:ale_exclude_highlights                             *g:ale_exclude_highlights*
+                                                     *b:ale_exclude_highlights*
+
+  Type: |List|
+  Default: `[]`
+
+  A list of regular expressions for matching against highlight messages to
+  remove. For example: >
+
+  " Do not highlight messages matching strings like these.
+  let b:ale_exclude_highlights = ['line too long', 'foo.*bar']
+<
+  See also: |g:ale_set_highlights|
+
+
 g:ale_fixers                                                     *g:ale_fixers*
                                                                  *b:ale_fixers*
 
@@ -862,7 +963,7 @@ g:ale_fixers                                                     *g:ale_fixers*
 <
 
 g:ale_fix_on_save                                           *g:ale_fix_on_save*
-b:ale_fix_on_save                                           *b:ale_fix_on_save*
+                                                            *b:ale_fix_on_save*
 
   Type: |Number|
   Default: `0`
@@ -884,7 +985,7 @@ b:ale_fix_on_save                                           *b:ale_fix_on_save*
 
 
 g:ale_fix_on_save_ignore                             *g:ale_fix_on_save_ignore*
-b:ale_fix_on_save_ignore                             *b:ale_fix_on_save_ignore*
+                                                     *b:ale_fix_on_save_ignore*
 
   Type: |Dictionary| or |List|
   Default: `{}`
@@ -947,6 +1048,16 @@ g:ale_history_log_output                             *g:ale_history_log_output*
   if you want to save on some memory usage.
 
 
+g:ale_hover_to_preview                                 *g:ale_hover_to_preview*
+                                                       *b:ale_hover_to_preview*
+
+  Type: |Number|
+  Default: `0`
+
+  If set to `1`, hover messages will be displayed in the preview window,
+  instead of in balloons or the message line.
+
+
 g:ale_keep_list_window_open                       *g:ale_keep_list_window_open*
                                                   *b:ale_keep_list_window_open*
   Type: |Number|
@@ -1250,7 +1361,7 @@ g:ale_list_vertical                                       *g:ale_list_vertical*
 
 
 g:ale_loclist_msg_format                             *g:ale_loclist_msg_format*
-b:ale_loclist_msg_format                             *b:ale_loclist_msg_format*
+                                                     *b:ale_loclist_msg_format*
 
   Type: |String|
   Default: `g:ale_echo_msg_format`
@@ -1261,7 +1372,7 @@ 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*
+g:ale_lsp_show_message_format                   *g:ale_lsp_show_message_format*
 
   Type: |String|
   Default: `'%severity%:%linter%: %s'`
@@ -1283,7 +1394,7 @@ g:ale_lsp_show_message_format                           *g:ale_lsp_show_message_
   separately for each buffer like |g:ale_echo_msg_format| can.
 
 
-g:ale_lsp_show_message_severity                         *g:ale_lsp_show_message_severity*
+g:ale_lsp_show_message_severity               *g:ale_lsp_show_message_severity*
 
   Type: |String|
   Default: `'error'`
@@ -1302,7 +1413,7 @@ g:ale_lsp_show_message_severity                         *g:ale_lsp_show_message_
 
 
 g:ale_lsp_root                                                 *g:ale_lsp_root*
-b:ale_lsp_root                                                 *b:ale_lsp_root*
+                                                               *b:ale_lsp_root*
 
   Type: |Dictionary| or |String|
   Default: {}
@@ -1515,6 +1626,8 @@ g:ale_set_highlights                                     *g:ale_set_highlights*
   match highlights, whereas the line highlights when signs are enabled will
   run to the edge of the screen.
 
+  Highlights can be excluded with the |g:ale_exclude_highlights| option.
+
 
 g:ale_set_loclist                                           *g:ale_set_loclist*
 
@@ -1781,7 +1894,8 @@ g:ale_virtualtext_cursor                             *g:ale_virtualtext_cursor*
 
 
 g:ale_virtualtext_delay                               *g:ale_virtualtext_delay*
-b:ale_virtualtext_delay                               *b:ale_virtualtext_delay*
+                                                      *b:ale_virtualtext_delay*
+
   Type: |Number|
   Default: `10`
 
@@ -1800,7 +1914,7 @@ g:ale_virtualtext_prefix                             *g:ale_virtualtext_prefix*
   Prefix to be used with |g:ale_virtualtext_cursor|.
 
 g:ale_virtualenv_dir_names                         *g:ale_virtualenv_dir_names*
-b:ale_virtualenv_dir_names                         *b:ale_virtualenv_dir_names*
+                                                   *b:ale_virtualenv_dir_names*
 
   Type: |List|
   Default: `['.env', '.venv', 'env', 've-py3', 've', 'virtualenv', 'venv']`
@@ -1814,7 +1928,7 @@ b:ale_virtualenv_dir_names                         *b:ale_virtualenv_dir_names*
 
 
 g:ale_warn_about_trailing_blank_lines   *g:ale_warn_about_trailing_blank_lines*
-b:ale_warn_about_trailing_blank_lines   *b:ale_warn_about_trailing_blank_lines*
+                                        *b:ale_warn_about_trailing_blank_lines*
 
   Type: |Number|
   Default: `1`
@@ -1826,7 +1940,7 @@ b:ale_warn_about_trailing_blank_lines   *b:ale_warn_about_trailing_blank_lines*
 
 
 g:ale_warn_about_trailing_whitespace     *g:ale_warn_about_trailing_whitespace*
-b:ale_warn_about_trailing_whitespace     *b:ale_warn_about_trailing_whitespace*
+                                         *b:ale_warn_about_trailing_whitespace*
 
   Type: |Number|
   Default: `1`
@@ -2166,6 +2280,8 @@ documented in additional help files.
     gcc...................................|ale-asm-gcc|
   awk.....................................|ale-awk-options|
     gawk..................................|ale-awk-gawk|
+  bats....................................|ale-bats-options|
+    shellcheck............................|ale-bats-shellcheck|
   bib.....................................|ale-bib-options|
     bibclean..............................|ale-bib-bibclean|
   c.......................................|ale-c-options|
@@ -2264,6 +2380,7 @@ documented in additional help files.
     gometalinter..........................|ale-go-gometalinter|
     gopls.................................|ale-go-gopls|
     govet.................................|ale-go-govet|
+    revive................................|ale-go-revive|
     staticcheck...........................|ale-go-staticcheck|
   graphql.................................|ale-graphql-options|
     eslint................................|ale-graphql-eslint|
@@ -2362,6 +2479,7 @@ documented in additional help files.
   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|
@@ -2465,6 +2583,7 @@ documented in additional help files.
     sorbet................................|ale-ruby-sorbet|
     standardrb............................|ale-ruby-standardrb|
   rust....................................|ale-rust-options|
+    analyzer..............................|ale-rust-analyzer|
     cargo.................................|ale-rust-cargo|
     rls...................................|ale-rust-rls|
     rustc.................................|ale-rust-rustc|
@@ -2509,6 +2628,7 @@ documented in additional help files.
   terraform...............................|ale-terraform-options|
     terraform-fmt-fixer...................|ale-terraform-fmt-fixer|
     terraform.............................|ale-terraform-terraform|
+    terraform-lsp.........................|ale-terraform-terraform-lsp|
     tflint................................|ale-terraform-tflint|
   tex.....................................|ale-tex-options|
     chktex................................|ale-tex-chktex|
@@ -2525,6 +2645,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|
@@ -2539,6 +2660,7 @@ documented in additional help files.
     vcom..................................|ale-vhdl-vcom|
     xvhdl.................................|ale-vhdl-xvhdl|
   vim.....................................|ale-vim-options|
+    vimls.................................|ale-vim-vimls|
     vint..................................|ale-vim-vint|
   vim help................................|ale-vim-help-options|
     write-good............................|ale-vim-help-write-good|
@@ -2592,11 +2714,23 @@ ALEFindReferences                                           *ALEFindReferences*
   Enter key (`<CR>`) can be used to jump to a referencing location, or the `t`
   key can be used to jump to the location in a new tab.
 
+  The locations opened in different ways using the following variations.
+
+  `:ALEFindReferences -tab`    - Open the location in a new tab.
+  `:ALEFindReferences -split`  - Open the location in a horizontal split.
+  `:ALEFindReferences -vsplit` - Open the location in a vertical split.
+
+  The default method used for navigating to a new location can be changed
+  by modifying |g:ale_default_navigation|.
+
+  The selection can be opened again with the |ALERepeatSelection| command.
+
   You can jump back to the position you were at before going to a reference of
   something with jump motions like CTRL-O. See |jump-motions|.
 
   A plug mapping `<Plug>(ale_find_references)` is defined for this command.
 
+
 ALEFix                                                                 *ALEFix*
 
   Fix problems with the current buffer. See |ale-fix| for more information.
@@ -2611,40 +2745,29 @@ ALEFixSuggest                                                   *ALEFixSuggest*
   See |ale-fix| for more information.
 
 
-ALEGoToDefinition                                           *ALEGoToDefinition*
+ALEGoToDefinition `<options>`                               *ALEGoToDefinition*
 
   Jump to the definition of a symbol under the cursor using the enabled LSP
   linters for the buffer. ALE will jump to a definition if an LSP server
   provides a location to jump to. Otherwise, ALE will do nothing.
 
-  You can jump back to the position you were at before going to the definition
-  of something with jump motions like CTRL-O. See |jump-motions|.
-
-  A plug mapping `<Plug>(ale_go_to_definition)` is defined for this command.
-
-
-ALEGoToDefinitionInTab                                 *ALEGoToDefinitionInTab*
-
-  The same as |ALEGoToDefinition|, but opens results in a new tab.
+  The locations opened in different ways using the following variations.
 
-  A plug mapping `<Plug>(ale_go_to_definition_in_tab)` is defined for this
-  command.
-
-
-ALEGoToDefinitionInSplit                             *ALEGoToDefinitionInSplit*
-
-  The same as |ALEGoToDefinition|, but opens results in a new split.
-
-  A plug mapping `<Plug>(ale_go_to_definition_in_split)` is defined for this
-  command.
+  `:ALEGoToDefinition -tab`    - Open the location in a new tab.
+  `:ALEGoToDefinition -split`  - Open the location in a horizontal split.
+  `:ALEGoToDefinition -vsplit` - Open the location in a vertical split.
 
+  The default method used for navigating to a new location can be changed
+  by modifying |g:ale_default_navigation|.
 
-ALEGoToDefinitionInVSplit                           *ALEGoToDefinitionInVSplit*
+  You can jump back to the position you were at before going to the definition
+  of something with jump motions like CTRL-O. See |jump-motions|.
 
-  The same as |ALEGoToDefinition|, but opens results in a new vertical split.
+  You should consider using the 'hidden' option in combination with this
+  command. Otherwise, Vim will refuse to leave the buffer you're jumping from
+  unless you have saved your edits.
 
-  A plug mapping `<Plug>(ale_go_to_definition_in_vsplit)` is defined for this
-  command.
+  A plug mapping `<Plug>(ale_go_to_definition)` is defined for this command.
 
 
 ALEGoToTypeDefinition                                   *ALEGoToTypeDefinition*
@@ -2654,6 +2777,15 @@ ALEGoToTypeDefinition                                   *ALEGoToTypeDefinition*
   definition if an LSP server provides a location to jump to. Otherwise, ALE
   will do nothing.
 
+  The locations opened in different ways using the following variations.
+
+  `:ALEGoToTypeDefinition -tab`    - Open the location in a new tab.
+  `:ALEGoToTypeDefinition -split`  - Open the location in a horizontal split.
+  `:ALEGoToTypeDefinition -vsplit` - Open the location in a vertical split.
+
+  The default method used for navigating to a new location can be changed
+  by modifying |g:ale_default_navigation|.
+
   You can jump back to the position you were at before going to the definition
   of something with jump motions like CTRL-O. See |jump-motions|.
 
@@ -2661,31 +2793,6 @@ ALEGoToTypeDefinition                                   *ALEGoToTypeDefinition*
   command.
 
 
-ALEGoToTypeDefinitionInTab                         *ALEGoToTypeDefinitionInTab*
-
-  The same as |ALEGoToTypeDefinition|, but opens results in a new tab.
-
-  A plug mapping `<Plug>(ale_go_to_type_definition_in_tab)` is defined for
-  this command.
-
-
-ALEGoToTypeDefinitionInSplit                     *ALEGoToTypeDefinitionInSplit*
-
-  The same as |ALEGoToTypeDefinition|, but opens results in a new split.
-
-  A plug mapping `<Plug>(ale_go_to_type_definition_in_split)` is defined for
-  this command.
-
-
-ALEGoToTypeDefinitionInVSplit                   *ALEGoToTypeDefinitionInVSplit*
-
-  The same as |ALEGoToTypeDefinition|, but opens results in a new vertical
-  split.
-
-  A plug mapping `<Plug>(ale_go_to_type_definition_in_vsplit)` is defined for
-  this command.
-
-
 ALEHover                                                             *ALEHover*
 
   Print brief information about the symbol under the cursor, taken from any
@@ -2711,6 +2818,11 @@ ALERename                                                           *ALERename*
   The user will be prompted for a new name.
 
 
+ALERepeatSelection                                         *ALERepeatSelection*
+
+  Repeat the last selection displayed in the preview window.
+
+
 ALESymbolSearch `<query>`                                     *ALESymbolSearch*
 
   Search for symbols in the workspace, taken from any available LSP linters.
@@ -3019,7 +3131,6 @@ ale#command#Run(buffer, command, callback, [options])       *ale#command#Run()*
 
     'command': {b -> ale#command#Run(b, 'foo', function('s:GetCommand'))}
 <
-
   The following `options` can be provided.
 
     `output_stream` - Either `'stdout'`, `'stderr'`, `'both'`, or `'none`' for