summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHoracio Sanson <hsanson@gmail.com>2022-09-11 10:53:33 +0900
committerGitHub <noreply@github.com>2022-09-11 10:53:33 +0900
commita51fd9dababe43d239b8bdc1c10ac1f5397d6739 (patch)
tree1a5491d00b264710af0dd85b342edb068ecc5749 /doc
parent9e8920b3362b1382cfe4bb6691f2bf4bf41e6e68 (diff)
downloadale-a51fd9dababe43d239b8bdc1c10ac1f5397d6739.zip
Add gitlablint support (#3042)
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale-yaml.txt47
-rw-r--r--doc/ale.txt1
3 files changed, 49 insertions, 0 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 4f90ecb6..c7548f9f 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -665,6 +665,7 @@ Notes:
* YAML
* `actionlint`
* `circleci`!!
+ * `gitlablint`
* `prettier`
* `spectral`
* `swaglint`
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index 9733990e..b3450b87 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -281,4 +281,51 @@ g:ale_yaml_yamllint_options *g:ale_yaml_yamllint_options*
===============================================================================
+gitlablint *ale-yaml-gitlablint*
+
+Website: https://github.com/elijah-roberts/gitlab-lint
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install yamllint in your a virtualenv directory, locally, or globally: >
+
+ pip3 install gitlab_lint # After activating virtualenv
+ pip3 install --user gitlab_lint # Install to ~/.local/bin
+ sudo pip3 install gitlab_lint # Install globally
+
+See |g:ale_virtualenv_dir_names| for configuring how ALE searches for
+virtualenv directories.
+
+Is recommended to use |g:ale_pattern_options| to enable this linter so it only
+applies to 'gitlab-ci.yml' files and not all yaml files:
+>
+ let g:ale_pattern_options = {
+ \ '.gitlab-ci\.yml$': {
+ \ 'ale_linters': ['gitlablint'],
+ \ },
+ \}
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_yaml_gitlablint_executable *g:ale_yaml_gitlablint_executable*
+ *b:ale_yaml_gitlablint_executable*
+ Type: |String|
+ Default: `'gll'`
+
+ This variable can be set to change the path to gll.
+
+
+g:ale_yaml_gitlablint_options *g:ale_yaml_gitlablint_options*
+ *b:ale_yaml_gitlablint_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to gll.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 049f7159..ed3696d4 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -3329,6 +3329,7 @@ documented in additional help files.
yaml-language-server..................|ale-yaml-language-server|
yamlfix...............................|ale-yaml-yamlfix|
yamllint..............................|ale-yaml-yamllint|
+ gitlablint............................|ale-yaml-gitlablint|
yang....................................|ale-yang-options|
yang-lsp..............................|ale-yang-lsp|
zeek....................................|ale-zeek-options|