summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthew Turland <tobias382@gmail.com>2017-07-17 14:28:21 -0500
committerw0rp <w0rp@users.noreply.github.com>2017-07-17 20:28:21 +0100
commitda410caff8b2a7ba5c57e210ce24ac229ce347f0 (patch)
tree212057ac1202cb235489690d26b25e8094ec9d30 /doc
parenta6cc492a996476f55a93c12d34c0547e5d9dd37f (diff)
downloadale-da410caff8b2a7ba5c57e210ce24ac229ce347f0.zip
Add yaml swaglint linter (#771)
* Add yaml swaglint linter
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-yaml.txt34
-rw-r--r--doc/ale.txt3
2 files changed, 36 insertions, 1 deletions
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index 4a24afa1..a902f25d 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -3,6 +3,40 @@ ALE YAML Integration *ale-yaml-options*
===============================================================================
+swaglint *ale-yaml-swaglint*
+
+Website: https://github.com/byCedric/swaglint
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install swaglint either globally or locally: >
+
+ npm install swaglint -g # global
+ npm install swaglint # local
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_yaml_swaglint_executable *g:ale_yaml_swaglint_executable*
+ *b:ale_yaml_swaglint_executable*
+ Type: |String|
+ Default: `'swaglint'`
+
+ This variable can be set to change the path to swaglint.
+
+
+g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global*
+ *b:ale_yaml_swaglint_use_global*
+ Type: |String|
+ Default: `0`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
yamllint *ale-yaml-yamllint*
Website: https://github.com/adrienverge/yamllint
diff --git a/doc/ale.txt b/doc/ale.txt
index 7a551c0d..be79cedf 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -121,6 +121,7 @@ CONTENTS *ale-contents*
xml...................................|ale-xml-options|
xmllint.............................|ale-xml-xmllint|
yaml..................................|ale-yaml-options|
+ swaglint............................|ale-yaml-swaglint|
yamllint............................|ale-yaml-yamllint|
6. Commands/Keybinds....................|ale-commands|
7. API..................................|ale-api|
@@ -224,7 +225,7 @@ The following languages and tools are supported.
* Vim help: 'proselint'
* XHTML: 'proselint'
* XML: 'xmllint'
-* YAML: 'yamllint'
+* YAML: 'swaglint', 'yamllint'
===============================================================================
3. Global Options *ale-options*