From e4b3f579fa3c5e4edc8214194cfab4d8cb8aaa6b Mon Sep 17 00:00:00 2001 From: KabbAmine Date: Mon, 10 Oct 2016 15:53:54 +0400 Subject: Echo string format (#76) * Implement an option to configure the echoed message, #48 Via `g:ale_echo_msg_format` where: - `%s` is the error message itself - `%linter%` is the linter name - `%severity` is the severity type e.g let g:ale_echo_msg_fomat = '[%linter%] [%severity%] %s' * Add new options for defining the string used for errors in echoed message `g:ale_echo_msg_error_str` and `g:ale_echo_msg_warning_str` * Change text output of some linters Now that the echoed message can be customized, no need to add the type to the text variable. * Update README & documentation file * Fix some typos * Sort the table of options alphabetically (except echo_msg_x_str options) * Added echo warning str option to the doc --- doc/ale.txt | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/ale.txt b/doc/ale.txt index bdd2b801..ec2e8028 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1,7 +1,7 @@ -*ale.txt* For Vim version 8.0. Last change: 2016 October 7 +*ale.txt* For Vim version 8.0. Last change: 2016 October 10 *ale* -ALE - Asychronous Lint Engine +ALE - Asynchronous Lint Engine =============================================================================== CONTENTS *ale-contents* @@ -157,7 +157,7 @@ g:ale_set_signs *g:ale_set_signs* When this option is set to `1`, the |sign| column will be populated with signs marking where errors and warnings appear in the file. The - 'ALEErrorSign' and 'ALEWarningSign' highlight groups will be used to provide + `ALEErrorSign` and `ALEWarningSign` highlight groups will be used to provide highlighting for the signs. The text used for signs can be customised with the |g:ale_sign_error| and |g:ale_sign_warning| options. @@ -216,6 +216,39 @@ g:ale_echo_cursor *g:ale_echo_cursor* 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 behaviour. + The format of the message can be customizable in |g:ale_echo_msg_format|. + + +g:ale_echo_msg_format *g:ale_echo_msg_format* + + Type: |String| + Default: `%s` + + This variable defines the format of the echoed message. The `%s` is the + error message itself, and it can contain the following handlers: + - `%linter%` for linter's name + - `%severity%` for the type of severity + Note |`g:ale_echo_cursor`| should be setted to 1 + + +g:ale_echo_msg_error_str *g:ale_echo_msg_error_str* + + Type: |String| + Default: `Error` + + The string used for error severity in the echoed message. + Note |`g:ale_echo_cursor`| should be setted to 1 + Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler + + +g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* + + Type: |String| + Default: `Warning` + + The string used for warning severity in the echoed message. + Note |`g:ale_echo_cursor`| should be setted to 1 + Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler g:ale_warn_about_trailing_whitespace *g:ale_warn_about_trailing_whitespace* -- cgit v1.2.3