summaryrefslogtreecommitdiff
path: root/doc/ale.txt
diff options
context:
space:
mode:
authorLuan Santos <cfcluan@gmail.com>2018-11-05 22:45:40 -0800
committerLuan Santos <cfcluan@gmail.com>2018-11-05 22:45:40 -0800
commitc41dbe2ba9862037122b98fa2bb55fd72d277b74 (patch)
tree6c741ebab57adde45c821a5a6ed80dfc67a2323c /doc/ale.txt
parent945dd2fa26af2632d78855d7fe3ff113f9b41a91 (diff)
downloadale-c41dbe2ba9862037122b98fa2bb55fd72d277b74.zip
Add support for nvim's virtualtext on cursor
- Add g:ale_virtualtext_cursor boolean to enable/disable it - Add g:ale_virtualtext_prefix to configure what prefix to use (default: '> ') - Requires neovim 0.3.2's unreleased API `nvim_buf_set_virtual_text`
Diffstat (limited to 'doc/ale.txt')
-rw-r--r--doc/ale.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index d4223f84..1e114c72 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -557,6 +557,7 @@ their relevant options.
* By setting error highlights. - |g:ale_set_highlights|
* By creating signs in the sign column. - |g:ale_set_signs|
* By echoing messages based on your cursor. - |g:ale_echo_cursor|
+* By inline text based on your cursor. - |g:ale_virtualtext_cursor|
* By displaying the preview based on your cursor. - |g:ale_cursor_detail|
* By showing balloons for your mouse cursor - |g:ale_set_balloons|
@@ -1868,6 +1869,29 @@ g:ale_use_global_executables *g:ale_use_global_executables*
options.
+g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
+
+ Type: |Number|
+ Default: `0`
+
+ 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
+ contains a warning or error. This option can be set to `0` to disable this
+ behavior.
+
+ Messages are only displayed after a short delay. See |g:ale_echo_delay|.
+
+ Messages can be prefixed prefixed with a string. See |g:ale_virtualtext_prefix|.
+
+
+g:ale_virtualtext_prefix *g:ale_virtualtext_prefix*
+
+ Type: |String|
+ Default: `'> '`
+
+ 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*