summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLyz <lyz@riseup.net>2020-11-24 23:56:30 +0100
committerLyz <lyz@riseup.net>2020-11-25 01:21:53 +0100
commitc69d696e1b63c7797e8696f923856d131f02f5e9 (patch)
treebf57c7df355d1d576879f15b9c971642bc27f21c /doc
parent681a6e371d02cce9c2414c19f5deeae61aa321fa (diff)
downloadale-c69d696e1b63c7797e8696f923856d131f02f5e9.zip
feat: add yamlfix fixer
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale-yaml.txt38
-rw-r--r--doc/ale.txt1
3 files changed, 39 insertions, 1 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index f4673ec0..36e27932 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -524,6 +524,7 @@ Notes:
* YAML
* `prettier`
* `swaglint`
+ * `yamlfix`
* `yamllint`
* YANG
* `yang-lsp`
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*
diff --git a/doc/ale.txt b/doc/ale.txt
index 00f43aa5..f9f40d12 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2971,6 +2971,7 @@ documented in additional help files.
yaml....................................|ale-yaml-options|
prettier..............................|ale-yaml-prettier|
swaglint..............................|ale-yaml-swaglint|
+ yamlfix...............................|ale-yaml-yamlfix|
yamllint..............................|ale-yaml-yamllint|
yang....................................|ale-yang-options|
yang-lsp..............................|ale-yang-lsp|