From 27780cbb230fad55fbc07752febe5c21a69a18aa Mon Sep 17 00:00:00 2001 From: Jeff Willette Date: Fri, 10 Nov 2017 18:37:23 +0900 Subject: Added support for linting of proto files (#1098) * Added support for linting of proto files * Added function to get the proper protoc command --- doc/ale-proto.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/ale-proto.txt (limited to 'doc/ale-proto.txt') 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: -- cgit v1.2.3