VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2026-05-18 14:29:50 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Implement Lua ALE setup & overhaul documentation

Browse Source 
1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
This commit is contained in:
w0rp
2025-03-20 21:33:12 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ale-proto.txt
+29 -19
View File
@@ -1,5 +1,5 @@
===============================================================================
ALE Proto Integration *ale-proto-options*
ALE Proto Integration *ale-proto-options*
===============================================================================
@@ -10,23 +10,23 @@ To enable `.proto` file linting, update |g:ale_linters| as appropriate:
" Enable linter for .proto files
let g:ale_linters = {'proto': ['buf-lint', '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': ['buf-format', 'protolint']}
<
===============================================================================
buf-format *ale-proto-buf-format*
buf-format *ale-proto-buf-format*
The formatter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
on `protoc`. Make sure the `buf` binary is available in the system path, or
set ale_proto_buf_format_executable.
g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable*
*ale-options.proto_buf_format_executable*
*g:ale_proto_buf_format_executable*
proto_buf_format_executable
g:ale_proto_buf_format_executable
Type: |String|
Default: `'buf'`
@@ -34,21 +34,25 @@ g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable*
===============================================================================
buf-lint *ale-proto-buf-lint*
buf-lint *ale-proto-buf-lint*
The linter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
on `protoc`. Make sure the `buf` binary is available in the system path, or
set ale_proto_buf_lint_executable.
g:ale_proto_buf_lint_executable *g:ale_proto_buf_lint_executable*
*ale-options.proto_buf_lint_executable*
*g:ale_proto_buf_lint_executable*
proto_buf_lint_executable
g:ale_proto_buf_lint_executable
Type: |String|
Default: `'buf'`
This variable can be changed to modify the executable used for buf.
g:ale_proto_buf_lint_config *g:ale_proto_buf_lint_config*
*ale-options.proto_buf_lint_config*
*g:ale_proto_buf_lint_config*
proto_buf_lint_config
g:ale_proto_buf_lint_config
Type: |String|
Default: `''`
@@ -66,13 +70,15 @@ Note that the C options are also used for Proto.
===============================================================================
protoc-gen-lint *ale-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*
*ale-options.proto_protoc_gen_lint_options*
*g:ale_proto_protoc_gen_lint_options*
proto_protoc_gen_lint_options
g:ale_proto_protoc_gen_lint_options
Type: |String|
Default: `''`
@@ -82,7 +88,7 @@ g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
===============================================================================
protolint *ale-proto-protolint*
protolint *ale-proto-protolint*
The linter is a pluggable tool that doesn't depend on the `protoc` binary.
This supports both linting and fixing.
@@ -90,15 +96,19 @@ protolint *ale-proto-protolint
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*
*ale-options.proto_protolint_executable*
*g:ale_proto_protolint_executable*
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*
*ale-options.proto_protolint_config*
*g:ale_proto_protolint_config*
proto_protolint_config
g:ale_proto_protolint_config
Type: |String|
Default: `''`