diff options
author | Bartek thindil Jasicki <thindil@laeran.pl> | 2019-10-18 18:15:05 +0200 |
---|---|---|
committer | Bartek thindil Jasicki <thindil@laeran.pl> | 2019-10-18 18:15:05 +0200 |
commit | 8239b76c5a4c765ffa04cb5c6ad0ad94cd1d0dea (patch) | |
tree | a06e6d34aad2fea419ae92109fc6319dadda2758 /doc | |
parent | 6d5d3fa4dd1cc18a5b90c587502ad37323df08a3 (diff) | |
parent | c06467438dff38b939fd81b32395296d01a59df6 (diff) | |
download | ale-8239b76c5a4c765ffa04cb5c6ad0ad94cd1d0dea.zip |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ale-nim.txt | 25 | ||||
-rw-r--r-- | doc/ale-php.txt | 4 | ||||
-rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 1 | ||||
-rw-r--r-- | doc/ale.txt | 55 |
4 files changed, 82 insertions, 3 deletions
diff --git a/doc/ale-nim.txt b/doc/ale-nim.txt new file mode 100644 index 00000000..ad7aa686 --- /dev/null +++ b/doc/ale-nim.txt @@ -0,0 +1,25 @@ +=============================================================================== +ALE Nim Integration *ale-nim-options* + + +=============================================================================== +nimcheck *ale-nim-nimcheck* + + ALE does not provide additional configuration options for `nimcheck` at this + point. + + +=============================================================================== +nimlsp *ale-nim-nimlsp* + +g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources* + + Type: |String| + Default: `''` + + Sets the path to Nim source repository as the first argument to `nimlsp` + command. + + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-php.txt b/doc/ale-php.txt index d41fb50d..e17e1023 100644 --- a/doc/ale-php.txt +++ b/doc/ale-php.txt @@ -157,9 +157,9 @@ g:ale_php_phpstan_level *g:ale_php_phpstan_level* Type: |String| Default: `''` - This variable controls the rule levels. 0 is the loosest and 4 is the + This variable controls the rule levels. 0 is the loosest and 7 is the strictest. If this option isn't set, the rule level will be controlled by - the configuration file. If no configuration file can be detected, `'4'` will + the configuration file. If no configuration file can be detected, `'7'` will be used instead. diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index a9bd47d0..9d296ac5 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -283,6 +283,7 @@ Notes: * `nasm`!! * Nim * `nim check`!! + * `nimlsp` * nix * `nix-instantiate` * `nixpkgs-fmt` diff --git a/doc/ale.txt b/doc/ale.txt index c6c9418a..2c36cd3d 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -172,7 +172,7 @@ address to connect to instead. > call ale#linter#Define('filetype_here', { \ 'name': 'any_name_you_want', - \ 'lsp': 'stdio', + \ 'lsp': 'socket', \ 'address': 'servername:1234', \ 'project_root': '/path/to/root_of_project', \}) @@ -801,6 +801,15 @@ g:ale_echo_msg_info_str *g:ale_echo_msg_info_str* The string used for `%severity%` for info. See |g:ale_echo_msg_format| +g:ale_echo_msg_log_str *g:ale_echo_msg_log_str* + + Type: |String| + Default: `'Log'` + + The string used for `%severity%` for log, used only for handling LSP show + message requests. See |g:ale_lsp_show_message_format| + + g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str* Type: |String| @@ -1251,6 +1260,47 @@ 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* + + Type: |String| + Default: `'%severity%:%linter%: %s'` + + This variable defines the format that messages received from an LSP will + have when echoed. The following sequences of characters will be replaced. + + `%s` - replaced with the message text + `%linter%` - replaced with the name of the linter + `%severity%` - replaced with the severity of the message + + The strings for `%severity%` levels "error", "info" and "warning" are shared + with |g:ale_echo_msg_format|. Severity "log" is unique to + |g:ale_lsp_show_message_format| and it can be configured via + + |g:ale_echo_msg_log_str| - Defaults to `'Log'` + + Please note that |g:ale_lsp_show_message_format| *can not* be configured + separately for each buffer like |g:ale_echo_msg_format| can. + + +g:ale_lsp_show_message_severity *g:ale_lsp_show_message_severity* + + Type: |String| + Default: `'error'` + + This variable defines the minimum severity level an LSP message needs to be + displayed. Messages below this level are discarded; please note that + messages with `Log` severity level are always discarded. + + Possible values follow the LSP spec `MessageType` definition: + + `'error'` - Displays only errors. + `'warning'` - Displays errors and warnings. + `'information'` - Displays errors, warnings and infos + `'log'` - Same as `'information'` + `'disabled'` - Doesn't display any information at all. + + g:ale_lsp_root *g:ale_lsp_root* b:ale_lsp_root *b:ale_lsp_root* @@ -2308,6 +2358,9 @@ documented in additional help files. mmc...................................|ale-mercury-mmc| nasm....................................|ale-nasm-options| nasm..................................|ale-nasm-nasm| + nim.....................................|ale-nim-options| + nimcheck..............................|ale-nim-nimcheck| + nimlsp................................|ale-nim-nimlsp| nix.....................................|ale-nix-options| nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt| nroff...................................|ale-nroff-options| |