summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKabbAmine <KabbAmine@users.noreply.github.com>2016-10-10 15:53:54 +0400
committerw0rp <w0rp@users.noreply.github.com>2016-10-10 12:53:54 +0100
commite4b3f579fa3c5e4edc8214194cfab4d8cb8aaa6b (patch)
tree9fccc3ca68d9d120ea1ac14df5f44bb23286fbdf /README.md
parentf60df660f8af489af55270d205ad70a4b569742f (diff)
downloadale-e4b3f579fa3c5e4edc8214194cfab4d8cb8aaa6b.zip
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
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 32 insertions, 5 deletions
diff --git a/README.md b/README.md
index a628e9e3..d142f400 100644
--- a/README.md
+++ b/README.md
@@ -76,20 +76,23 @@ vimrc file for all given linters is as follows:
| Option | Description | Default |
| ------ | ----------- | ------- |
-| `g:ale_linters` | a dictionary of linters to whitelist | _not set_ |
-| `g:ale_lint_on_text_changed` | lint while typing | `1` |
+| `g:ale_echo_cursor` | echo errors when the cursor is over them | `1` |
+| `g:ale_echo_msg_format` | string format to use for the echoed message | `'%s'` |
+| `g:ale_echo_msg_error_str` | string used for error severity in echoed message | `'Error'` |
+| `g:ale_echo_msg_warning_str` | string used for warning severity in echoed message | `'Warning'` |
| `g:ale_lint_delay` | milliseconds to wait before linting | `200` |
+| `g:ale_linters` | a dictionary of linters to whitelist | _not set_ |
| `g:ale_lint_on_enter` | lint when opening a file | `1` |
| `g:ale_lint_on_save` | lint when saving a file | `0` |
+| `g:ale_lint_on_text_changed` | lint while typing | `1` |
| `g:ale_set_loclist` | set the loclist with errors | `1` |
| `g:ale_set_signs` | set gutter signs with error markers | `has('signs')` |
| `g:ale_sign_column_always` | always show the sign gutter | `0` |
| `g:ale_sign_error` | the text to use for errors in the gutter | `'>>'` |
-| `g:ale_sign_warning` | the text to use for warnings in the gutter | `'--'` |
| `g:ale_sign_offset` | an offset for sign ids | `1000000` |
-| `g:ale_echo_cursor` | echo errors when the cursor is over them | `1` |
+| `g:ale_sign_warning` | the text to use for warnings in the gutter | `'--'` |
+| `g:ale_statusline_format` | string format to use in statusline flag | `['%d error(s)', '%d warning(s)', 'OK']` |
| `g:ale_warn_about_trailing_whitespace` | enable trailing whitespace warnings for some linters | `1` |
-| `g:ale_statusline_format` | String format to use in statusline flag | `['%d error(s)', '%d warning(s)', 'OK']` |
### Selecting Particular Linters
@@ -155,6 +158,30 @@ let g:ale_statusline_format = ['⨉ %d', '⚠ %d', '⬥ ok']
![Statusline with issues](img/issues.png)
![Statusline with no issues](img/no_issues.png)
+
+### Customize echoed message
+
+There are 3 global options that allow customizing the echoed message.
+
+- `g:ale_echo_msg_format` where:
+ * `%s` is the error message itself
+ * `%linter%` is the linter name
+ * `%severity` is the severity type
+- `g:ale_echo_msg_error_str` is the string used for error severity.
+- `g:ale_echo_msg_warning_str` is the string used for warning severity.
+
+So for example this:
+
+```vim
+let g:ale_echo_msg_error_str = 'E'
+let g:ale_echo_msg_error_str = 'W'
+let g:ale_echo_msg_fomat = '[%linter%] %s [%severity%]'
+```
+
+Will give you:
+
+![Echoed message](img/echo.png)
+
## Installation
To install this plugin, you should use one of the following methods.