diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-ansible.txt | 16 | ||||
| -rw-r--r-- | doc/ale-d.txt | 11 | ||||
| -rw-r--r-- | doc/ale-elixir.txt | 13 | ||||
| -rw-r--r-- | doc/ale-hcl.txt | 11 | ||||
| -rw-r--r-- | doc/ale-json.txt | 7 | ||||
| -rw-r--r-- | doc/ale-rust.txt | 31 | ||||
| -rw-r--r-- | doc/ale-terraform.txt | 18 | ||||
| -rw-r--r-- | doc/ale.txt | 41 |
8 files changed, 140 insertions, 8 deletions
diff --git a/doc/ale-ansible.txt b/doc/ale-ansible.txt new file mode 100644 index 00000000..3a4efaa5 --- /dev/null +++ b/doc/ale-ansible.txt @@ -0,0 +1,16 @@ +=============================================================================== +ALE Ansible Integration *ale-ansible-options* + + +=============================================================================== +ansible-lint *ale-ansible-ansible-lint* + +g:ale_ansible_ansible_lint_executable *g:ale_ansible_ansible_lint_executable* + *b:ale_ansible_ansible_lint_executable* + Type: |String| + Default: `'ansible-lint'` + + This variable can be changed to modify the executable used for ansible-lint. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-d.txt b/doc/ale-d.txt index 8db04774..55596062 100644 --- a/doc/ale-d.txt +++ b/doc/ale-d.txt @@ -3,6 +3,17 @@ ALE D Integration *ale-d-options* =============================================================================== +dls *ale-d-dls* + +g:ale_d_dls_executable *g:ale_d_dls_executable* + *b:ale_d_dls_executable* + Type: |String| + Default: `dls` + +See |ale-integrations-local-executables| + + +=============================================================================== uncrustify *ale-d-uncrustify* See |ale-c-uncrustify| for information about the available options. diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt index ac0ec605..769842a4 100644 --- a/doc/ale-elixir.txt +++ b/doc/ale-elixir.txt @@ -41,4 +41,17 @@ See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more information. =============================================================================== +elixir-ls *ale-elixir-elixir-ls* + +Elixir Language Server (https://github.com/JakeBecker/elixir-ls) + +g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release* + *b:ale_elixir_elixir_ls_release* + Type: |String| + Default: `'elixir-ls'` + + Location of the elixir-ls release directory. This directory must contain + the language server scripts (language_server.sh and language_server.bat). + +=============================================================================== vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-hcl.txt b/doc/ale-hcl.txt new file mode 100644 index 00000000..8060ac44 --- /dev/null +++ b/doc/ale-hcl.txt @@ -0,0 +1,11 @@ +=============================================================================== +ALE HCL Integration *ale-hcl-options* + + +=============================================================================== +terraform-fmt *ale-hcl-terraform-fmt* + +See |ale-terraform-fmt| for information about the available options. + +=============================================================================== + vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: diff --git a/doc/ale-json.txt b/doc/ale-json.txt index 0ec7932d..6a0a9fae 100644 --- a/doc/ale-json.txt +++ b/doc/ale-json.txt @@ -73,6 +73,13 @@ g:ale_json_jq_options *g:ale_json_jq_options* This option can be changed to pass extra options to `jq`. +g:ale_json_jq_filters *g:ale_json_jq_filters* + *b:ale_json_jq_filters* + Type: |String| + Default: `'.'` + + This option can be changed to pass custom filters to `jq`. + =============================================================================== prettier *ale-json-prettier* diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index 13e5f6f0..ce5634ae 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -109,6 +109,7 @@ g:ale_rust_cargo_include_features *g:ale_rust_cargo_include_features* When defined, ALE will set the `--features` option when invoking `cargo` to perform the lint check. See |g:ale_rust_cargo_default_feature_behavior|. + g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace* *b:ale_rust_cargo_avoid_whole_workspace* Type: |Number| @@ -119,6 +120,36 @@ g:ale_rust_cargo_avoid_whole_workspace *g:ale_rust_cargo_avoid_whole_workspace* in the crate's directory. Otherwise, behave as usual. +g:ale_rust_cargo_use_clippy + *g:ale_rust_cargo_use_clippy* + *b:ale_rust_cargo_use_clippy* + Type: |Number| + Default: `0` + + When set to 1, `cargo clippy` will be used instead of `cargo check` or + `cargo build` as linter. + For details of `cargo clippy`, please visit the following link: + + https://github.com/rust-lang-nursery/rust-clippy + + Since `cargo clippy` is optional toolchain, it's safer to check whether + `cargo-clippy` is executable as follows: +> + let g:ale_rust_cargo_use_clippy = executable('cargo-clippy') +< + +g:ale_rust_cargo_clippy_options + *g:ale_rust_cargo_clippy_options* + *b:ale_rust_cargo_clippy_options* + + Type: |String| + Default: `''` + + When `cargo clippy` is used, this value will be added to a command line to run + it. This variable is useful when you want to add some extra options which + only `cargo clippy` supports (e.g. `--deny`). + + =============================================================================== rls *ale-rust-rls* diff --git a/doc/ale-terraform.txt b/doc/ale-terraform.txt index ec86e9a0..49a55028 100644 --- a/doc/ale-terraform.txt +++ b/doc/ale-terraform.txt @@ -3,6 +3,24 @@ ALE Terraform Integration *ale-terraform-options* =============================================================================== +fmt *ale-terraform-fmt* + +g:ale_terraform_fmt_executable *g:ale_terraform_fmt_executable* + *b:ale_terraform_fmt_executable* + + Type: |String| + Default: `'terraform'` + + This variable can be changed to use a different executable for terraform. + + +g:ale_terraform_fmt_options *g:ale_terraform_fmt_options* + *b:ale_terraform_fmt_options* + Type: |String| + Default: `''` + + +=============================================================================== tflint *ale-terraform-tflint* g:ale_terraform_tflint_executable *g:ale_terraform_tflint_executable* diff --git a/doc/ale.txt b/doc/ale.txt index 24d69fb2..7e37d2dc 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -18,6 +18,8 @@ CONTENTS *ale-contents* 6.1 Highlights........................|ale-highlights| 6.2 Options for write-good Linter.....|ale-write-good-options| 7. Integration Documentation............|ale-integrations| + ansible...............................|ale-ansible-options| + ansible-lint........................|ale-ansible-ansible-lint| asciidoc..............................|ale-asciidoc-options| write-good..........................|ale-asciidoc-write-good| asm...................................|ale-asm-options| @@ -67,6 +69,7 @@ CONTENTS *ale-contents* cuda..................................|ale-cuda-options| nvcc................................|ale-cuda-nvcc| d.....................................|ale-d-options| + dls.................................|ale-d-dls| uncrustify..........................|ale-d-uncrustify| dart..................................|ale-dart-options| dartanalyzer........................|ale-dart-dartanalyzer| @@ -77,6 +80,7 @@ CONTENTS *ale-contents* mix.................................|ale-elixir-mix| mix_format..........................|ale-elixir-mix-format| dialyxir............................|ale-elixir-dialyxir| + elixir-ls...........................|ale-elixir-elixir-ls| elm...................................|ale-elm-options| elm-format..........................|ale-elm-elm-format| elm-make............................|ale-elm-elm-make| @@ -125,6 +129,8 @@ CONTENTS *ale-contents* stack-build.........................|ale-haskell-stack-build| stylish-haskell.....................|ale-haskell-stylish-haskell| hie.................................|ale-haskell-hie| + hcl...................................|ale-hcl-options| + terraform-fmt.......................|ale-hcl-terraform-fmt| html..................................|ale-html-options| htmlhint............................|ale-html-htmlhint| tidy................................|ale-html-tidy| @@ -295,6 +301,7 @@ CONTENTS *ale-contents* tcl...................................|ale-tcl-options| nagelfar............................|ale-tcl-nagelfar| terraform.............................|ale-terraform-options| + fmt.................................|ale-terraform-fmt| tflint..............................|ale-terraform-tflint| tex...................................|ale-tex-options| chktex..............................|ale-tex-chktex| @@ -395,11 +402,11 @@ Notes: * CSS: `csslint`, `prettier`, `stylelint` * Cucumber: `cucumber` * Cython (pyrex filetype): `cython` -* D: `dmd`, `uncrustify` +* D: `dls`, `dmd`, `uncrustify` * Dafny: `dafny`!! * Dart: `dartanalyzer`!!, `language_server`, dartfmt!! * Dockerfile: `hadolint` -* Elixir: `credo`, `dialyxir`, `dogma`, `mix`!! +* Elixir: `credo`, `dialyxir`, `dogma`, `mix`!!, `elixir-ls` * Elm: `elm-format, elm-make` * Erb: `erb`, `erubi`, `erubis` * Erlang: `erlc`, `SyntaxErl` @@ -415,6 +422,7 @@ Notes: * Haml: `haml-lint` * Handlebars: `ember-template-lint` * Haskell: `brittany`, `ghc`, `cabal-ghc`, `stylish-haskell`, `stack-ghc`, `stack-build`!!, `ghc-mod`, `hlint`, `hdevtools`, `hfmt`, `hie` +* HCL: `terraform-fmt` * HTML: `alex`!!, `HTMLHint`, `proselint`, `tidy`, `write-good` * Idris: `idris` * Java: `checkstyle`, `javac`, `google-java-format`, `PMD`, `javalsp`, `uncrustify` @@ -467,7 +475,7 @@ Notes: * SQL: `sqlint`, `sqlfmt` * Swift: `swiftlint`, `swiftformat` * Tcl: `nagelfar`!! -* Terraform: `tflint` +* Terraform: `fmt`, `tflint` * Texinfo: `alex`!!, `proselint`, `write-good` * Text^: `alex`!!, `proselint`, `redpen`, `textlint`, `vale`, `write-good` * Thrift: `thrift` @@ -712,10 +720,11 @@ Completion is only supported while at least one LSP linter is enabled. ALE will only suggest symbols provided by the LSP servers. Suggestions will be made while you type after completion is enabled. -Completion can be enabled by setting |g:ale_completion_enabled| to `1`. The -delay for completion can be configured with |g:ale_completion_delay|. ALE will -only suggest so many possible matches for completion. The maximum number of -items can be controlled with |g:ale_completion_max_suggestions|. +Completion can be enabled by setting |g:ale_completion_enabled| to `1`. This +setting must be set to `1` before ALE is loaded. The delay for completion can +be configured with |g:ale_completion_delay|. ALE will only suggest so many +possible matches for completion. The maximum number of items can be controlled +with |g:ale_completion_max_suggestions|. If you don't like some of the suggestions you see, you can filter them out with |g:ale_completion_excluded_words| or |b:ale_completion_excluded_words|. @@ -761,12 +770,25 @@ at the cursor taken from LSP linters. The following commands are supported: |ALEHover| - Print information about the symbol at the cursor. -If |b:ale_set_balloons| is set to `1` and your version of Vim supports the +If |g:ale_set_balloons| is set to `1` and your version of Vim supports the |balloon_show()| function, then "hover" information also show up when you move the mouse over a symbol in a buffer. Diagnostic information will take priority over hover information for balloons. If a line contains a problem, that problem will be displayed in a balloon instead of hover information. +For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling +|balloonexpr| commands in terminals can cause scrolling issues in terminals, +so ALE will not attempt to show balloons unless |g:ale_set_balloons| is set to +`1` before ALE is loaded. + +For enabling mouse support in terminals, you may have to change your mouse +settings. For example: > + + " Example mouse settings. + " You will need to try different settings, depending on your terminal. + set mouse=a + set ttymouse=xterm +< =============================================================================== 6. Global Options *ale-options* @@ -879,6 +901,9 @@ g:ale_completion_enabled *g:ale_completion_enabled* When this option is set to `1`, completion support will be enabled. + This setting must be set to `1` before ALE is loaded for this behavior + to be enabled. + See |ale-completion| |