summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorlucas-str <32294068+lucas-str@users.noreply.github.com>2023-05-06 02:02:07 +0200
committerGitHub <noreply@github.com>2023-05-06 09:02:07 +0900
commit9fe9f115213d7e7bf52d06ebdc69c6df38b1120b (patch)
tree36afc7ede0bf275c71e4f043745d5e15b40860e0 /doc
parent61248e1453dc6373160154e1f6855ffc510a7dfc (diff)
downloadale-9fe9f115213d7e7bf52d06ebdc69c6df38b1120b.zip
Add support for npm-groovy-lint (#4495)
* Add support for npm-groovy-lint * Add doc and tests for npm-groovy-lint * Use ale#util#FuzzyJSONDecode instead of json_decode
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-groovy.txt42
-rw-r--r--doc/ale-supported-languages-and-tools.txt2
-rw-r--r--doc/ale.txt3
3 files changed, 47 insertions, 0 deletions
diff --git a/doc/ale-groovy.txt b/doc/ale-groovy.txt
new file mode 100644
index 00000000..cc5e8881
--- /dev/null
+++ b/doc/ale-groovy.txt
@@ -0,0 +1,42 @@
+===============================================================================
+ALE Groovy Integration *ale-groovy-options*
+
+
+===============================================================================
+Integration Information
+
+Linting and fixing of Groovy files is enabled with the integration of
+`npm-groovy-lint`.
+
+
+===============================================================================
+npm-groovy-lint *ale-groovy-npm-groovy-lint*
+
+g:ale_groovy_npmgroovylint_executable *g:ale_groovy_npmgroovylint_executable*
+ *b:ale_groovy_npmgroovylint_executable*
+ Type: |String|
+ Default: `'npm-groovy-lint'`
+
+ Location of the npm-groovy-lint binary file.
+
+
+g:ale_groovy_npmgroovylint_options *g:ale_groovy_npmgroovylint_options*
+ *b:ale_groovy_npmgroovylint_options*
+ Type: |String|
+ Default: `'--loglevel warning'`
+
+ Additional npm-groovy-lint linter options.
+
+
+g:ale_groovy_npmgroovylint_fix_options *g:ale_groovy_npmgroovylint_fix_options*
+ *b:ale_groovy_npmgroovylint_fix_options*
+ Type: |String|
+ Default: `'--fix'`
+
+ This variable can be used to configure fixing with npm-groovy-lint. It must
+ contain either `--fix` or `--format` for the fixer to work. See
+ `npm-groovy-lint --help` for more information on possible fix rules.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 6369224a..571322f4 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -223,6 +223,8 @@ Notes:
* `eslint`
* `gqlint`
* `prettier`
+* Groovy
+ * `npm-groovy-lint`
* Hack
* `hack`
* `hackfmt`
diff --git a/doc/ale.txt b/doc/ale.txt
index 76f00c43..a167f214 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1642,6 +1642,7 @@ g:ale_linters *g:ale_linters*
\ 'csh': ['shell'],
\ 'elixir': ['credo', 'dialyxir', 'dogma'],
\ 'go': ['gofmt', 'golint', 'gopls', 'govet'],
+ \ 'groovy': ['npm-groovy-lint'],
\ 'hack': ['hack'],
\ 'help': [],
\ 'inko': ['inko'],
@@ -2995,6 +2996,8 @@ documented in additional help files.
eslint................................|ale-graphql-eslint|
gqlint................................|ale-graphql-gqlint|
prettier..............................|ale-graphql-prettier|
+ groovy..................................|ale-groovy-options|
+ npm-groovy-lint.......................|ale-groovy-npm-groovy-lint|
hack....................................|ale-hack-options|
hack..................................|ale-hack-hack|
hackfmt...............................|ale-hack-hackfmt|