diff options
| author | Jeffrey Lau <9203+zoonfafer@users.noreply.github.com> | 2022-01-07 22:57:29 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-07 23:57:29 +0900 |
| commit | 5087246c8223712fa0097098e910951aba8603fb (patch) | |
| tree | 2be44dff3e7c2832e06223cf3a2e2d3e38011c4a /doc | |
| parent | 76bd0593713004ae38d738874e9e0575aefc88dd (diff) | |
| download | ale-5087246c8223712fa0097098e910951aba8603fb.zip | |
Add yaml-language-server support for YAML (#2874) (#4029)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 1 | ||||
| -rw-r--r-- | doc/ale-yaml.txt | 53 | ||||
| -rw-r--r-- | doc/ale.txt | 1 |
3 files changed, 55 insertions, 0 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index f93e0807..ed1d1d5e 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -640,6 +640,7 @@ Notes: * `prettier` * `spectral` * `swaglint` + * `yaml-language-server` * `yamlfix` * `yamllint` * YANG diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt index 65e0d069..a5da85a5 100644 --- a/doc/ale-yaml.txt +++ b/doc/ale-yaml.txt @@ -106,6 +106,59 @@ g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global* =============================================================================== +yaml-language-server *ale-yaml-language-server* + +Website: https://github.com/redhat-developer/yaml-language-server + + +Installation +------------------------------------------------------------------------------- + +Install yaml-language-server either globally or locally: > + + npm install yaml-language-server -g # global + npm install yaml-language-server # local + + +Options +------------------------------------------------------------------------------- + +g:ale_yaml_ls_executable *g:ale_yaml_ls_executable* + *b:ale_yaml_ls_executable* + Type: |String| + Default: `'yaml-language-server'` + + This variable can be set to change the path to yaml-language-server. + + +g:ale_yaml_ls_config *g:ale_yaml_ls_config* + *b:ale_yaml_ls_config* + Type: |Dictionary| + Default: `{}` + + Dictionary containing configuration settings that will be passed to the + language server. For example, to enable schema store: > + { + \ 'yaml': { + \ 'schemaStore': { + \ 'enable': v:true, + \ }, + \ }, + \ } +< + Consult the yaml-language-server documentation for more information about + settings. + + +g:ale_yaml_ls_use_global *g:ale_yaml_ls_use_global* + *b:ale_yaml_ls_use_global* + Type: |String| + Default: `get(g:, 'ale_use_global_executables', 0)` + + See |ale-integrations-local-executables| + + +=============================================================================== yamlfix *ale-yaml-yamlfix* Website: https://lyz-code.github.io/yamlfix diff --git a/doc/ale.txt b/doc/ale.txt index 19a8dd2f..4e576284 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -3232,6 +3232,7 @@ documented in additional help files. prettier..............................|ale-yaml-prettier| spectral..............................|ale-yaml-spectral| swaglint..............................|ale-yaml-swaglint| + yaml-language-server..................|ale-yaml-language-server| yamlfix...............................|ale-yaml-yamlfix| yamllint..............................|ale-yaml-yamllint| yang....................................|ale-yang-options| |