From c41dbe2ba9862037122b98fa2bb55fd72d277b74 Mon Sep 17 00:00:00 2001 From: Luan Santos Date: Mon, 5 Nov 2018 22:45:40 -0800 Subject: 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` --- doc/ale.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'doc/ale.txt') 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* -- cgit v1.2.3 From 3ec09f7826a6799aa4186542e0f802991b36ddc3 Mon Sep 17 00:00:00 2001 From: Luan Santos Date: Tue, 6 Nov 2018 22:36:37 -0800 Subject: Document ale_virtualtext_delay --- doc/ale.txt | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'doc/ale.txt') diff --git a/doc/ale.txt b/doc/ale.txt index 1e114c72..d260b40e 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1880,11 +1880,23 @@ g:ale_virtualtext_cursor *g:ale_virtua 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 are only displayed after a short delay. See |g:ale_virtualtext_delay|. Messages can be prefixed prefixed with a string. See |g:ale_virtualtext_prefix|. +g:ale_virtualtext_delay *g:ale_virtualtext_delay* + *b:ale_virtualtext_delay* + Type: |Number| + Default: `10` + + Given any integer, this option controls the number of milliseconds before + ALE will show a message for a problem near the cursor. + + The value can be increased to decrease the amount of processing ALE will do + for files displaying a large number of problems. + + g:ale_virtualtext_prefix *g:ale_virtualtext_prefix* Type: |String| -- cgit v1.2.3