From 5a47d878fbb837af4c89ab545f473f8526bd4d64 Mon Sep 17 00:00:00 2001
From: tatsuya <t2h5k0@gmail.com>
Date: Sun, 13 Dec 2020 17:06:23 +0900
Subject: add spectral linter for yaml

ci
---
 doc/ale-supported-languages-and-tools.txt |  1 +
 doc/ale-yaml.txt                          | 32 +++++++++++++++++++++++++++++++
 doc/ale.txt                               |  1 +
 3 files changed, 34 insertions(+)

(limited to 'doc')

diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 6744e30e..0b864b48 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -537,6 +537,7 @@ Notes:
   * `xmllint`
 * YAML
   * `prettier`
+  * `spectral`
   * `swaglint`
   * `yamlfix`
   * `yamllint`
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index 61bfc139..04871403 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -15,6 +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*
 
diff --git a/doc/ale.txt b/doc/ale.txt
index 97fb0786..f8fea05b 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3028,6 +3028,7 @@ documented in additional help files.
     xmllint...............................|ale-xml-xmllint|
   yaml....................................|ale-yaml-options|
     prettier..............................|ale-yaml-prettier|
+    spectral..............................|ale-yaml-spectral|
     swaglint..............................|ale-yaml-swaglint|
     yamlfix...............................|ale-yaml-yamlfix|
     yamllint..............................|ale-yaml-yamllint|
-- 
cgit v1.2.3