summaryrefslogtreecommitdiff
path: root/doc/ale-yaml.txt
diff options
context:
space:
mode:
authorHoracio Sanson <hsanson@gmail.com>2020-11-27 16:02:33 +0900
committerGitHub <noreply@github.com>2020-11-27 16:02:33 +0900
commit1365dce921c1fb84a668ae121d5d5aeebef99fbc (patch)
treea8de9ed73e87ad1b0ea0f997c7701ee237f9a259 /doc/ale-yaml.txt
parent681a6e371d02cce9c2414c19f5deeae61aa321fa (diff)
parent12eb8d15234e6f4e77672c29659c29a7c0dcf2fb (diff)
downloadale-1365dce921c1fb84a668ae121d5d5aeebef99fbc.zip
Merge pull request #3461 from lyz-code/feat/add-yamlfixer
feat: add yamlfix fixer
Diffstat (limited to 'doc/ale-yaml.txt')
-rw-r--r--doc/ale-yaml.txt38
1 files changed, 37 insertions, 1 deletions
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index c9a12ea1..61bfc139 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -15,7 +15,6 @@ Install prettier either globally or locally: >
npm install prettier -g # global
npm install prettier # local
<
-
===============================================================================
swaglint *ale-yaml-swaglint*
@@ -49,6 +48,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*