diff options
| author | Jon Parise <jon@indelible.org> | 2021-02-21 04:35:26 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-21 21:35:26 +0900 |
| commit | 90b9597d500c528d46aa13ccfa678a86ef7ea22b (patch) | |
| tree | 2f94224a548ac63f66860eddc7fa4f6f099923aa /doc | |
| parent | 2550f5d952caea4ac607ec0796d8f1fae4d7b9a5 (diff) | |
| download | ale-90b9597d500c528d46aa13ccfa678a86ef7ea22b.zip | |
Add a buildifier fixer for Bazel files (#3499)
This fixer enables buildifier's formatting and "lint fix" modes.
Additional options can be provided via `bazel_buildifier_options`.
It also implements some basic logic for guessing the file's type.
buildifier itself usually does this based on the filenames provided on
the command line, but because we're piping our buffer via stdin, we need
to do this manually.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-bazel.txt | 28 | ||||
| -rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 2 | ||||
| -rw-r--r-- | doc/ale.txt | 2 |
3 files changed, 32 insertions, 0 deletions
diff --git a/doc/ale-bazel.txt b/doc/ale-bazel.txt new file mode 100644 index 00000000..e2922aaf --- /dev/null +++ b/doc/ale-bazel.txt @@ -0,0 +1,28 @@ +=============================================================================== +ALE Bazel Integration *ale-bazel-options* + +=============================================================================== +buildifier *ale-bazel-buildifier* + +g:ale_bazel_buildifier_executable *g:ale_bazel_buildifier_executable* + *b:ale_bazel_buildifier_executable* + Type: |String| + Default: `'buildifier'` + + See |ale-integrations-local-executables| + + +g:ale_bazel_buildifier_options *g:ale_bazel_buildifier_options* + *b:ale_bazel_buildifier_options* + Type: |String| + Default: `''` + + This variable can be set to pass extra options to buildifier. + + +g:ale_bazel_buildifier_use_global *g:ale_bazel_buildifier_use_global* + *b:ale_bazel_buildifier_use_global* + Type: |Number| + Default: `get(g:, 'ale_use_global_executables', 0)` + + See |ale-integrations-local-executables| diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt index 71abb0a1..cb90de4c 100644 --- a/doc/ale-supported-languages-and-tools.txt +++ b/doc/ale-supported-languages-and-tools.txt @@ -43,6 +43,8 @@ Notes: * `shfmt` * Bats * `shellcheck` +* Bazel + * `buildifier` * BibTeX * `bibclean` * Bourne Shell diff --git a/doc/ale.txt b/doc/ale.txt index 3031cd1b..113e29c5 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2614,6 +2614,8 @@ documented in additional help files. gawk..................................|ale-awk-gawk| bats....................................|ale-bats-options| shellcheck............................|ale-bats-shellcheck| + bazel...................................|ale-bazel-options| + buildifier............................|ale-bazel-buildifier| bib.....................................|ale-bib-options| bibclean..............................|ale-bib-bibclean| c.......................................|ale-c-options| |