diff options
| author | Pierre-Nicolas Clauss <pinicarus@protonmail.com> | 2021-01-23 19:06:59 +0100 |
|---|---|---|
| committer | Pierre-Nicolas Clauss <pinicarus@protonmail.com> | 2021-01-23 19:06:59 +0100 |
| commit | 0ac7595fe97607ae99757787eba19cf0870be00d (patch) | |
| tree | 43bebcf52c3caf7a22d26b9309d0beb58aa144a9 /doc/ale-yaml.txt | |
| parent | db96b007209f7ea0983c58cb1d18771f5a45a543 (diff) | |
| parent | 9fd9435cd525b1d3c4470db0d514f72ed31cfece (diff) | |
| download | ale-0ac7595fe97607ae99757787eba19cf0870be00d.zip | |
Merge remote-tracking branch 'upstream/master'
Signed-off-by: Pierre-Nicolas Clauss <pinicarus@protonmail.com>
Diffstat (limited to 'doc/ale-yaml.txt')
| -rw-r--r-- | doc/ale-yaml.txt | 70 |
1 files changed, 69 insertions, 1 deletions
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt index c9a12ea1..04871403 100644 --- a/doc/ale-yaml.txt +++ b/doc/ale-yaml.txt @@ -15,7 +15,38 @@ Install prettier either globally or locally: > npm install prettier -g # global npm install prettier # local < - +=============================================================================== +spectral *ale-yaml-spectral* + +Website: https://github.com/stoplightio/spectral + +Installation +------------------------------------------------------------------------------- + +Install spectral either globally or locally: > + + npm install @stoplight/spectral -g # global + npm install @stoplight/spectral # local +< + +Options +------------------------------------------------------------------------------- + +g:ale_yaml_spectral_executable *g:ale_yaml_spectral_executable* + *b:ale_yaml_spectral_executable* + Type: |String| + Default: `'spectral'` + + This variable can be set to change the path to spectral. + +g:ale_yaml_spectral_use_global *g:ale_yaml_spectral_use_global* + *b:ale_yaml_spectral_use_global* + Type: |String| + Default: `get(g:, 'ale_use_global_executables', 0)` + + See |ale-integrations-local-executables| + + =============================================================================== swaglint *ale-yaml-swaglint* @@ -49,6 +80,43 @@ g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global* See |ale-integrations-local-executables| +=============================================================================== +yamlfix *ale-yaml-yamlfix* + +Website: https://lyz-code.github.io/yamlfix + + +Installation +------------------------------------------------------------------------------- + +Install yamlfix: > + + pip install yamlfix +< + +Options +------------------------------------------------------------------------------- +g:ale_yaml_yamlfix_executable *g:ale_yaml_yamlfix_executable* + *b:ale_yaml_yamlfix_executable* + Type: |String| + Default: `'yamlfix'` + + See |ale-integrations-local-executables| + + +g:ale_yaml_yamlfix_options *g:ale_yaml_yamlfix_options* + *b:ale_yaml_yamlfix_options* + Type: |String| + Default: `''` + + This variable can be set to pass extra options to yamlfix. + +g:ale_yaml_yamlfix_use_global *g:ale_yaml_yamlfix_use_global* + *b:ale_yaml_yamlfix_use_global* + Type: |Number| + Default: `get(g:, 'ale_use_global_executables', 0)` + + See |ale-integrations-local-executables| =============================================================================== yamllint *ale-yaml-yamllint* |