diff options
| author | Jeff Willette <jrwillette88@gmail.com> | 2017-11-10 18:37:23 +0900 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2017-11-10 09:37:23 +0000 |
| commit | 27780cbb230fad55fbc07752febe5c21a69a18aa (patch) | |
| tree | 3a88b32c4ba2d3b3c12efbfe10c61ed90e869c8b /doc/ale-proto.txt | |
| parent | d425b8a18ab3c8155fdc7376192434f8878e954f (diff) | |
| download | ale-27780cbb230fad55fbc07752febe5c21a69a18aa.zip | |
Added support for linting of proto files (#1098)
* Added support for linting of proto files
* Added function to get the proper protoc command
Diffstat (limited to 'doc/ale-proto.txt')
| -rw-r--r-- | doc/ale-proto.txt | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt new file mode 100644 index 00000000..6a256380 --- /dev/null +++ b/doc/ale-proto.txt @@ -0,0 +1,24 @@ +=============================================================================== +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']} +< +=============================================================================== +protoc-gen-lint *ale-proto-protoc-gen-lint* + + The linter is a plugin for the `protoc` binary. As long as the binary resides + in the system path, `protoc` will find it. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: |