summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authoryohei yoshimuta <yoheimuta@gmail.com>2021-04-09 22:16:23 +0900
committerGitHub <noreply@github.com>2021-04-09 22:16:23 +0900
commitcec9954d016e4d388cd6a9abed798de7f330d185 (patch)
treec060a1b598d161da466c6ef78f4442b44a6f1bc3 /doc
parentf0887d3e6178482255f11aa378124aef3699245f (diff)
downloadale-cec9954d016e4d388cd6a9abed798de7f330d185.zip
feat: Add protolint as linter and fixer (#2911)
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-proto.txt37
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 34 insertions, 5 deletions
diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt
index 734e23d5..8ab56a14 100644
--- a/doc/ale-proto.txt
+++ b/doc/ale-proto.txt
@@ -5,14 +5,15 @@ ALE Proto Integration *ale-proto-options
===============================================================================
Integration Information
-Linting of `.proto` files requires that the `protoc` binary is installed in the
-system path and that the `protoc-gen-lint` plugin for the `protoc` binary is also
-installed.
-
To enable `.proto` file linting, update |g:ale_linters| as appropriate:
>
" Enable linter for .proto files
- let g:ale_linters = {'proto': ['protoc-gen-lint']}
+ let g:ale_linters = {'proto': ['protoc-gen-lint', 'protolint']}
+
+To enable `.proto` file fixing, update |g:ale_fixers| as appropriate:
+>
+ " Enable linter for .proto files
+ let b:ale_fixers = {'proto': ['protolint']}
<
===============================================================================
protoc-gen-lint *ale-proto-protoc-gen-lint*
@@ -30,4 +31,30 @@ g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
before any user-supplied options.
===============================================================================
+protolint *ale-proto-protolint*
+
+ The linter is a pluggable tool that doesn't depend on the `protoc` binary.
+ This supports both linting and fixing.
+ Make sure the binary is available in the system path, or set
+ ale_proto_protolint_executable.
+ Note that the binary with v0.22.0 or above is supported.
+
+g:ale_proto_protolint_executable *g:ale_proto_protolint_executable*
+
+ Type: |String|
+ Default: 'protolint'
+
+ This variable can be changed to modify the executable used for protolint.
+
+g:ale_proto_protolint_config *g:ale_proto_protolint_config*
+
+ Type: |String|
+ Default: `''`
+
+ A path to a protolint configuration file.
+
+ The path to the configuration file can be an absolute path or a relative
+ path. ALE will search for the relative path in parent directories.
+
+===============================================================================
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 e0e0a6a3..67dc971c 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -385,6 +385,7 @@ Notes:
* `swipl`
* proto
* `protoc-gen-lint`
+ * `protolint`
* Pug
* `pug-lint`
* Puppet
diff --git a/doc/ale.txt b/doc/ale.txt
index 682db80d..96069d5a 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2918,6 +2918,7 @@ documented in additional help files.
swipl.................................|ale-prolog-swipl|
proto...................................|ale-proto-options|
protoc-gen-lint.......................|ale-proto-protoc-gen-lint|
+ protolint.............................|ale-proto-protolint|
pug.....................................|ale-pug-options|
puglint...............................|ale-pug-puglint|
puppet..................................|ale-puppet-options|