mirror of
https://github.com/dense-analysis/ale
synced 2024-12-25 15:42:26 +00:00
b5a5cdf920
Typically proto files depend on and make use of proto definitions in other files. When invoking protoc user can supply paths to inspect for dependencies. This patch makes it possible to configure flags passed to protoc. This makes it e.g., possible to change include paths of the linter's protoc invocation.
34 lines
1.3 KiB
Plaintext
34 lines
1.3 KiB
Plaintext
===============================================================================
|
|
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.
|
|
|
|
g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
|
|
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
This variable can be changed to modify flags given to protoc. Note that the
|
|
directory of the linted file is always passed as an include path with '-I'
|
|
before any user-supplied options.
|
|
|
|
===============================================================================
|
|
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|