summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-ada.txt30
-rw-r--r--doc/ale-apkbuild.txt30
-rw-r--r--doc/ale-dafny.txt16
-rw-r--r--doc/ale-dart.txt25
-rw-r--r--doc/ale-development.txt18
-rw-r--r--doc/ale-dhall.txt52
-rw-r--r--doc/ale-elixir.txt7
-rw-r--r--doc/ale-erlang.txt16
-rw-r--r--doc/ale-haskell.txt12
-rw-r--r--doc/ale-inko.txt22
-rw-r--r--doc/ale-json.txt32
-rw-r--r--doc/ale-openapi.txt74
-rw-r--r--doc/ale-python.txt11
-rw-r--r--doc/ale-ruby.txt10
-rw-r--r--doc/ale-salt.tmt43
-rw-r--r--doc/ale-supported-languages-and-tools.txt50
-rw-r--r--doc/ale-terraform.txt22
-rw-r--r--doc/ale-typescript.txt60
-rw-r--r--doc/ale-vala.txt21
-rw-r--r--doc/ale-yaml.txt32
-rw-r--r--doc/ale.txt83
21 files changed, 639 insertions, 27 deletions
diff --git a/doc/ale-ada.txt b/doc/ale-ada.txt
index 2ac30c0a..0fc55a9c 100644
--- a/doc/ale-ada.txt
+++ b/doc/ale-ada.txt
@@ -33,4 +33,34 @@ g:ale_ada_gnatpp_options *g:ale_ada_gnatpp_options*
===============================================================================
+ada-language-server *ale-ada-language-server*
+
+g:ale_ada_adals_executable *g:ale_ada_adals_executable*
+ *b:ale_ada_adals_executable*
+ Type: |String|
+ Default: `'ada_language_server'`
+
+ This variable can be changed to use a different executable for Ada Language
+ Server.
+
+
+g:ale_ada_adals_project *g:ale_ada_adals_project*
+ *b:ale_ada_adals_project*
+ Type: |String|
+ Default: `'default.gpr'`
+
+This variable can be changed to use a different GPR file for
+Ada Language Server.
+
+
+g:ale_ada_adals_encoding *g:ale_ada_adals_encoding*
+ *b:ale_ada_adals_encoding*
+ Type: |String|
+ Default: `'utf-8'`
+
+This variable can be changed to use a different file encoding for
+Ada Language Server.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-apkbuild.txt b/doc/ale-apkbuild.txt
new file mode 100644
index 00000000..05261400
--- /dev/null
+++ b/doc/ale-apkbuild.txt
@@ -0,0 +1,30 @@
+===============================================================================
+ALE APKBUILD Integration *ale-apkbuild-options*
+
+
+===============================================================================
+apkbuild-lint *ale-apkbuild-apkbuild-lint*
+
+g:ale_apkbuild_apkbuild_lint_executable
+ *g:ale_apkbuild_apkbuild_lint_executable*
+ *b:ale_apkbuild_apkbuild_lint_executable*
+
+ Type: |String|
+ Default: `'apkbuild-lint'`
+
+ This variable can be set to change the path to apkbuild-lint
+
+===============================================================================
+secfixes-check *ale-apkbuild-secfixes-check*
+
+g:ale_apkbuild_secfixes_check_executable
+ *g:ale_apkbuild_secfixes_check_executable*
+ *b:ale_apkbuild_secfixes_check_executable*
+
+ Type: |String|
+ Default: `'secfixes-check'`
+
+ This variable can be set to change the path to secfixes-check
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-dafny.txt b/doc/ale-dafny.txt
new file mode 100644
index 00000000..005170ad
--- /dev/null
+++ b/doc/ale-dafny.txt
@@ -0,0 +1,16 @@
+===============================================================================
+ALE Dafny Integration *ale-dafny-options*
+
+
+===============================================================================
+dafny *ale-dafny-dafny*
+
+g:ale_dafny_dafny_timelimit *g:ale_dafny_dafny_timelimit*
+ *b:ale_dafny_dafny_timelimit*
+ Type: |Number|
+ Default: `10`
+
+ This variable sets the `/timeLimit` used for dafny.
+
+
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-dart.txt b/doc/ale-dart.txt
index a6d88dd8..01089252 100644
--- a/doc/ale-dart.txt
+++ b/doc/ale-dart.txt
@@ -3,6 +3,31 @@ ALE Dart Integration *ale-dart-options*
===============================================================================
+analysis_server *ale-dart-analysis_server*
+
+Installation
+-------------------------------------------------------------------------------
+
+Install Dart via whatever means. `analysis_server` will be included in the SDK.
+
+In case that `dart` is not in your path, try to set the executable option to
+its absolute path. : >
+ " Set the executable path for dart to the absolute path to it.
+ let g:ale_dart_analysis_server_executable = '/usr/local/bin/dart'
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_dart_analysis_server_executable *g:ale_dart_analysis_server_executable*
+ *b:ale_dart_analysis_server_executable*
+ Type: |String|
+ Default: `'dart'`
+
+ This variable can be set to change the path of dart.
+
+
+===============================================================================
dartanalyzer *ale-dart-dartanalyzer*
Installation
diff --git a/doc/ale-development.txt b/doc/ale-development.txt
index afd9798f..dbbeb2da 100644
--- a/doc/ale-development.txt
+++ b/doc/ale-development.txt
@@ -148,13 +148,14 @@ Apply the following rules when writing Bash scripts.
===============================================================================
4. Testing ALE *ale-development-tests* *ale-dev-tests* *ale-tests*
-ALE is tested with a suite of tests executed in Travis CI and AppVeyor. ALE
-runs tests with the following versions of Vim in the following environments.
-
-1. Vim 8.0.0027 on Linux via Travis CI.
-2. Vim 8.1.0519 on Linux via Travis CI.
-3. NeoVim 0.2.0 on Linux via Travis CI.
-4. NeoVim 0.3.5 on Linux via Travis CI.
+ALE is tested with a suite of tests executed via GitHub Actions and AppVeyor.
+ALE runs tests with the following versions of Vim in the following
+environments.
+
+1. Vim 8.0.0027 on Linux via GitHub Actions.
+2. Vim 8.2.2401 on Linux via GitHub Actions.
+3. NeoVim 0.2.0 on Linux via GitHub Actions.
+4. NeoVim 0.4.4 on Linux via GitHub Actions.
5. Vim 8 (stable builds) on Windows via AppVeyor.
If you are developing ALE code on Linux, Mac OSX, or BSD, you can run ALEs
@@ -192,7 +193,8 @@ tests.
When you add new linters or fixers, make sure to add them into the tables in
supported-tools.md and |ale-supported-languages-and-tools.txt|. If you forget to
-keep them both in sync, you should see an error like the following in Travis CI.
+keep them both in sync, you should see an error like the following in the
+builds run for GitHub Actions.
>
========================================
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
diff --git a/doc/ale-dhall.txt b/doc/ale-dhall.txt
new file mode 100644
index 00000000..44b0bf32
--- /dev/null
+++ b/doc/ale-dhall.txt
@@ -0,0 +1,52 @@
+===============================================================================
+ALE Dhall Integration *ale-dhall-options*
+
+g:ale_dhall_executable *g:ale_dhall_executable*
+ *b:ale_dhall_executable*
+ Type: |String|
+ Default: `'dhall'`
+
+g:ale_dhall_options g:ale_dhall_options
+ b:ale_dhall_options
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the 'dhall` executable.
+ This is shared with `dhall-freeze` and `dhall-lint`.
+>
+ let g:dhall_options = '--ascii'
+<
+
+===============================================================================
+dhall-format *ale-dhall-format*
+
+Dhall
+ (https://dhall-lang.org/)
+
+
+===============================================================================
+dhall-freeze *ale-dhall-freeze*
+
+Dhall
+ (https://dhall-lang.org/)
+
+g:ale_dhall_freeze_options g:ale_dhall_freeze_options
+ b:ale_dhall_freeze_options
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to the 'dhall freeze`
+ executable.
+>
+ let g:dhall_freeze_options = '--all'
+<
+
+===============================================================================
+dhall-lint *ale-dhall-lint*
+
+Dhall
+ (https://dhall-lang.org/)
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt
index de9daacf..a4e5c2c6 100644
--- a/doc/ale-elixir.txt
+++ b/doc/ale-elixir.txt
@@ -85,5 +85,12 @@ g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*
Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode.
+g:ale_elixir_credo_config_file g:ale_elixir_credo_config_file
+
+ Type: String
+ Default: ''
+
+ Tells credo to use a custom configuration file.
+
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-erlang.txt b/doc/ale-erlang.txt
index 38762f08..93ac7915 100644
--- a/doc/ale-erlang.txt
+++ b/doc/ale-erlang.txt
@@ -13,6 +13,14 @@ g:ale_erlang_dialyzer_executable *g:ale_erlang_dialyzer_executable*
This variable can be changed to specify the dialyzer executable.
+g:ale_erlang_dialyzer_options *g:ale_erlang_dialyzer_options*
+ *b:ale_erlang_dialyzer_options*
+ Type: |String|
+ Default: `'-Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspec'`
+
+ This variable can be changed to specify the options to pass to the dialyzer
+ executable.
+
g:ale_erlang_dialyzer_plt_file *g:ale_erlang_dialyzer_plt_file*
*b:ale_erlang_dialyzer_plt_file*
Type: |String|
@@ -46,6 +54,14 @@ g:ale_erlang_elvis_executable *g:ale_erlang_elvis_executable*
-------------------------------------------------------------------------------
erlc *ale-erlang-erlc*
+g:ale_erlang_erlc_executable *g:ale_erlang_erlc_executable*
+ *b:ale_erlang_erlc_executable*
+ Type: |String|
+ Default: `'erlc'`
+
+ This variable can be changed to specify the erlc executable.
+
+
g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
*b:ale_erlang_erlc_options*
Type: |String|
diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt
index fde439fe..09894340 100644
--- a/doc/ale-haskell.txt
+++ b/doc/ale-haskell.txt
@@ -125,6 +125,18 @@ g:ale_haskell_hlint_options g:ale_haskell_hlint_options
===============================================================================
+hls *ale-haskell-hls*
+
+g:ale_haskell_hls_executable *g:ale_haskell_hls_executable*
+ *b:ale_haskell_his_executable*
+ Type: |String|
+ Default: `'haskell-language-server-wrapper'`
+
+ This variable can be changed to use a different executable for the haskell
+ language server.
+
+
+===============================================================================
stack-build *ale-haskell-stack-build*
g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options*
diff --git a/doc/ale-inko.txt b/doc/ale-inko.txt
new file mode 100644
index 00000000..5ca14af6
--- /dev/null
+++ b/doc/ale-inko.txt
@@ -0,0 +1,22 @@
+===============================================================================
+ALE Inko Integration *ale-inko-options*
+ *ale-integration-inko*
+
+===============================================================================
+Integration Information
+
+ Currently, the only supported linter for Inko is the Inko compiler itself.
+
+===============================================================================
+inko *ale-inko-inko*
+
+g:ale_inko_inko_executable *g:ale_inko_inko_executable*
+ *b:ale_inko_inko_executable*
+ Type: |String|
+ Default: `'inko'`
+
+ This variable can be modified to change the executable path for `inko`.
+
+
+===============================================================================
+ 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 96499a04..dc91e14c 100644
--- a/doc/ale-json.txt
+++ b/doc/ale-json.txt
@@ -102,4 +102,36 @@ See |ale-javascript-prettier| for information about the available options.
===============================================================================
+spectral *ale-json-spectral*
+
+Website: https://github.com/stoplightio/spectral
+
+Installation
+-------------------------------------------------------------------------------
+
+Install spectral either globally or locally: >
+
+ npm install @stoplight/spectral -g # global
+ npm install @stoplight/spectral # local
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_json_spectral_executable *g:ale_json_spectral_executable*
+ *b:ale_json_spectral_executable*
+ Type: |String|
+ Default: `'spectral'`
+
+ This variable can be set to change the path to spectral.
+
+g:ale_json_spectral_use_global *g:ale_json_spectral_use_global*
+ *b:ale_json_spectral_use_global*
+ Type: |String|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-openapi.txt b/doc/ale-openapi.txt
new file mode 100644
index 00000000..1fc41add
--- /dev/null
+++ b/doc/ale-openapi.txt
@@ -0,0 +1,74 @@
+===============================================================================
+ALE OpenApi Integration *ale-openapi-options*
+
+===============================================================================
+ibm_validator *ale-openapi-ibm-validator*
+
+Website: https://github.com/IBM/openapi-validator
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install ibm-openapi-validator either globally or locally: >
+
+ npm install ibm-openapi-validator -g # global
+ npm install ibm-openapi-validator # local
+<
+Configuration
+-------------------------------------------------------------------------------
+
+OpenAPI files can be written in YAML or JSON so in order for ALE plugins to
+work with these files we must set the buffer |filetype| to either |openapi.yaml|
+or |openapi.json| respectively. This causes ALE to lint the file with linters
+configured for openapi and yaml files or openapi and json files respectively.
+
+For example setting filetype to |openapi.yaml| on a buffer and the following
+|g:ale_linters| configuration will enable linting of openapi files using both
+|ibm_validator| and |yamlint|:
+
+>
+ let g:ale_linters = {
+ \ 'yaml': ['yamllint'],
+ \ 'openapi': ['ibm_validator']
+ \}
+<
+
+The following plugin will detect openapi files automatically and set the
+filetype to |openapi.yaml| or |openapi.json|:
+
+ https://github.com/hsanson/vim-openapi
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_openapi_ibm_validator_executable *g:ale_openapi_ibm_validator_executable*
+ *b:ale_openapi_ibm_validator_executable*
+ Type: |String|
+ Default: `'lint-openapi'`
+
+ This variable can be set to change the path to lint-openapi.
+
+
+g:ale_openapi_ibm_validator_options *g:ale_openapi_ibm_validator_options*
+ *b:ale_openapi_ibm_validator_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to lint-openapi.
+
+
+===============================================================================
+prettier *ale-openapi-prettier*
+
+See |ale-javascript-prettier| for information about the available options.
+
+
+===============================================================================
+yamllint *ale-openapi-yamllint*
+
+See |ale-yaml-yamllint| for information about the available options.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index f0c8bfb8..1f263e84 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -36,6 +36,8 @@ ALE will look for configuration files with the following filenames. >
.pylintrc
Pipfile
Pipfile.lock
+ poetry.lock
+ pyproject.toml
<
The first directory containing any of the files named above will be used.
@@ -280,6 +282,15 @@ g:ale_python_isort_use_global *g:ale_python_isort_use_global*
See |ale-integrations-local-executables|
+g:ale_python_isort_auto_pipenv *g:ale_python_isort_auto_pipenv*
+ *b:ale_python_isort_auto_pipenv*
+ Type: |Number|
+ Default: `0`
+
+ Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+ if true. This is overridden by a manually-set executable.
+
+
===============================================================================
mypy *ale-python-mypy*
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index 8815404a..edc6144a 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -177,6 +177,16 @@ g:ale_ruby_sorbet_options *g:ale_ruby_sorbet_options*
This variable can be changed to modify flags given to sorbet.
+g:ale_ruby_sorbet_enable_watchman *g:ale_ruby_sorbet_enable_watchman*
+ *b:ale_ruby_sorbet_enable_watchman*
+ Type: |Number|
+ Default: `0`
+
+ Whether or not to use watchman to let the LSP server to know about changes
+ to files from outside of vim. Defaults to disable watchman because it
+ requires watchman to be installed separately from sorbet.
+
+
===============================================================================
standardrb *ale-ruby-standardrb*
diff --git a/doc/ale-salt.tmt b/doc/ale-salt.tmt
new file mode 100644
index 00000000..ac500d37
--- /dev/null
+++ b/doc/ale-salt.tmt
@@ -0,0 +1,43 @@
+===============================================================================
+ALE SALT Integration *ale-salt-options*
+
+===============================================================================
+salt-lint *ale-salt-salt-lint*
+
+Website: https://github.com/warpnet/salt-lint
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install salt-lint in your a virtualenv directory, locally, or globally: >
+
+ pip install salt-lint # After activating virtualenv
+ pip install --user salt-lint # Install to ~/.local/bin
+ sudo pip install salt-lint # Install globally
+
+See |g:ale_virtualenv_dir_names| for configuring how ALE searches for
+virtualenv directories.
+
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_salt_salt-lint_executable *g:ale_salt_salt_lint_executable*
+ *b:ale_salt_salt_lint_executable*
+ Type: |String|
+ Default: `'salt-lint'`
+
+ This variable can be set to change the path to salt-lint.
+
+
+g:ale_salt_salt-lint_options *g:ale_salt_salt-lint_options*
+ *b:ale_salt_salt-lint_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to salt-lint.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 36e27932..72c685c5 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -13,12 +13,16 @@ Notes:
`!!` These linters check only files on disk. See |ale-lint-file-linters|
* Ada
+ * `ada_language_server`
* `gcc`
* `gnatpp`
* Ansible
* `ansible-lint`
* API Blueprint
* `drafter`
+* APKBUILD
+ * `apkbuild-lint`
+ * `secfixes-check`
* AsciiDoc
* `alex`!!
* `languagetool`!!
@@ -49,8 +53,8 @@ Notes:
* `astyle`
* `ccls`
* `clang` (`cc`)
- * `clangd`
* `clang-format`
+ * `clangd`
* `clangtidy`!!
* `cppcheck`
* `cpplint`!!
@@ -67,9 +71,9 @@ Notes:
* `astyle`
* `ccls`
* `clang` (`cc`)
+ * `clang-format`
* `clangcheck`!!
* `clangd`
- * `clang-format`
* `clangtidy`!!
* `clazy`!!
* `cppcheck`
@@ -116,11 +120,14 @@ Notes:
* Dafny
* `dafny`!!
* Dart
+ * `analysis_server`
* `dartanalyzer`!!
* `dartfmt`!!
* `language_server`
* Dhall
* `dhall-format`
+ * `dhall-freeze`
+ * `dhall-lint`
* Dockerfile
* `dockerfile_lint`
* `hadolint`
@@ -140,9 +147,9 @@ Notes:
* `erubis`
* `ruumba`
* Erlang
+ * `SyntaxErl`
* `elvis`!!
* `erlc`
- * `SyntaxErl`
* Fish
* `fish` (-n flag)
* Fortran
@@ -160,17 +167,17 @@ Notes:
* Go
* `bingo`
* `go build`!!
+ * `go mod`!!
+ * `go vet`!!
* `gofmt`
* `goimports`
* `golangci-lint`!!
* `golangserver`
* `golint`
* `gometalinter`!!
- * `go mod`!!
* `gopls`
* `gosimple`!!
* `gotype`!!
- * `go vet`!!
* `revive`!!
* `staticcheck`!!
* GraphQL
@@ -196,6 +203,7 @@ Notes:
* `hie`
* `hindent`
* `hlint`
+ * `hls`
* `ormolu`
* `stack-build`!!
* `stack-ghc`
@@ -203,10 +211,10 @@ Notes:
* HCL
* `terraform-fmt`
* HTML
+ * `HTMLHint`
* `alex`!!
* `fecs`
* `html-beautify`
- * `HTMLHint`
* `prettier`
* `proselint`
* `tidy`
@@ -215,15 +223,17 @@ Notes:
* `idris`
* Ink
* `ink-language-server`
+* Inko
+ * `inko` !!
* ISPC
* `ispc`!!
* Java
+ * `PMD`
* `checkstyle`
* `eclipselsp`
* `google-java-format`
* `javac`
* `javalsp`
- * `PMD`
* `uncrustify`
* JavaScript
* `eslint`
@@ -242,6 +252,7 @@ Notes:
* `jq`
* `jsonlint`
* `prettier`
+ * `spectral`
* Julia
* `languageserver`
* Kotlin
@@ -300,6 +311,7 @@ Notes:
* nix
* `nix-instantiate`
* `nixpkgs-fmt`
+ * `rnix-lsp`
* nroff
* `alex`!!
* `proselint`
@@ -318,6 +330,10 @@ Notes:
* `ocamlformat`
* `ocp-indent`
* `ols`
+* OpenApi
+ * `ibm_validator`
+ * `prettier`
+ * `yamllint`
* Pawn
* `uncrustify`
* Perl
@@ -330,10 +346,10 @@ Notes:
* `intelephense`
* `langserver`
* `phan`
+ * `php -l`
+ * `php-cs-fixer`
* `phpcbf`
* `phpcs`
- * `php-cs-fixer`
- * `php -l`
* `phpmd`
* `phpstan`
* `psalm`!!
@@ -394,6 +410,8 @@ Notes:
* `styler`
* Racket
* `raco`
+* Re:VIEW
+ * `redpen`
* ReasonML
* `merlin`
* `ols`
@@ -407,8 +425,6 @@ Notes:
* `textlint`
* `vale`
* `write-good`
-* Re:VIEW
- * `redpen`
* RPM spec
* `rpmlint`
* Ruby
@@ -428,6 +444,8 @@ Notes:
* `rust-analyzer`
* `rustc` (see |ale-integration-rust|)
* `rustfmt`
+* Salt
+ * `salt-lint`
* Sass
* `sass-lint`
* `stylelint`
@@ -453,10 +471,10 @@ Notes:
* `solium`
* SQL
* `pgformatter`
+ * `sql-lint`
* `sqlfmt`
* `sqlformat`
* `sqlint`
- * `sql-lint`
* Stylus
* `stylelint`
* SugarSS
@@ -469,7 +487,10 @@ Notes:
* Tcl
* `nagelfar`!!
* Terraform
- * `fmt`
+ * `terraform`
+ * `terraform-fmt-fixer`
+ * `terraform-ls`
+ * `terraform-lsp`
* `tflint`
* Texinfo
* `alex`!!
@@ -486,6 +507,7 @@ Notes:
* Thrift
* `thrift`
* TypeScript
+ * `deno`
* `eslint`
* `fecs`
* `prettier`
@@ -495,6 +517,7 @@ Notes:
* `typecheck`
* VALA
* `uncrustify`
+ * `vala_lint`!!
* Verilog
* `hdl-checker`
* `iverilog`
@@ -523,6 +546,7 @@ Notes:
* `xmllint`
* YAML
* `prettier`
+ * `spectral`
* `swaglint`
* `yamlfix`
* `yamllint`
diff --git a/doc/ale-terraform.txt b/doc/ale-terraform.txt
index f62db190..175bdf5c 100644
--- a/doc/ale-terraform.txt
+++ b/doc/ale-terraform.txt
@@ -33,6 +33,28 @@ g:ale_terraform_terraform_executable *g:ale_terraform_terraform_executable*
===============================================================================
+terraform-ls *ale-terraform-terraform-ls*
+
+Official terraform language server. More stable than *terraform-lsp* but
+currently has less features.
+
+g:ale_terraform_ls_executable *g:ale_terraform_ls_executable*
+ *b:ale_terraform_ls_executable*
+ Type: |String|
+ Default: `'terraform-ls'`
+
+ This variable can be changed to use a different executable for terraform-ls.
+
+
+g:ale_terraform_ls_options *g:ale_terraform_ls_options*
+ *b:ale_terraform_ls_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to pass custom CLI flags to terraform-ls.
+
+
+===============================================================================
terraform-lsp *ale-terraform-terraform-lsp*
g:ale_terraform_langserver_executable *g:ale_terraform_langserver_executable*
diff --git a/doc/ale-typescript.txt b/doc/ale-typescript.txt
index 2c50d119..a2446c2c 100644
--- a/doc/ale-typescript.txt
+++ b/doc/ale-typescript.txt
@@ -3,6 +3,39 @@ ALE TypeScript Integration *ale-typescript-options*
===============================================================================
+deno *ale-typescript-deno*
+
+Starting from version 1.6.0, Deno comes with its own language server. Earlier
+versions are not supported.
+
+g:ale_deno_executable *g:ale_deno_executable*
+ *b:ale_deno_executable*
+ Type: |String|
+ Default: `'deno'`
+
+
+g:ale_deno_lsp_project_root *g:ale_deno_lsp_project_root*
+ *b:ale_deno_lsp_project_root*
+ Type: |String|
+ Default: `''`
+
+ If this variable is left unset, ALE will try to find the project root by
+ executing the following steps in the given order:
+
+ 1. Find an ancestor directory containing a tsconfig.json.
+ 2. Find an ancestory irectory containing a .git folder.
+ 3. Use the directory of the current buffer (if the buffer was opened from
+ a file).
+
+g:ale_deno_unstable *g:ale_deno_unstable*
+ *b:ale_deno_unstable*
+ Type: |Number|
+ Default: `0`
+
+ Enable or disable unstable Deno features and APIs.
+
+
+===============================================================================
eslint *ale-typescript-eslint*
Because of how TypeScript compiles code to JavaScript and how interrelated
@@ -139,4 +172,31 @@ g:ale_typescript_tsserver_use_global *g:ale_typescript_tsserver_use_global*
===============================================================================
+xo *ale-typescript-xo*
+
+g:ale_typescript_xo_executable *g:ale_typescript_xo_executable*
+ *b:ale_typescript_xo_executable*
+ Type: |String|
+ Default: `'xo'`
+
+ See |ale-integrations-local-executables|
+
+
+g:ale_typescript_xo_options *g:ale_typescript_xo_options*
+ *b:ale_typescript_xo_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be set to pass additional options to xo.
+
+
+g:ale_typescript_xo_use_global *g:ale_typescript_xo_use_global*
+ *b:ale_typescript_xo_use_global*
+ Type: |Number|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-vala.txt b/doc/ale-vala.txt
index ca24bcf4..d48f68bb 100644
--- a/doc/ale-vala.txt
+++ b/doc/ale-vala.txt
@@ -9,4 +9,25 @@ See |ale-c-uncrustify| for information about the available options.
===============================================================================
+Vala-Lint *ale-vala-vala-lint*
+
+g:vala_vala_lint_executable *g:vala_vala_lint_executable*
+ *b:vala_vala_lint_executable*
+ Type: |String|
+ Default: `'io.elementary.vala-lint'`
+
+ This variable can be set to specify a Vala-Lint executable file.
+
+
+g:vala_vala_lint_config_filename *g:vala_vala_lint_config_filename*
+ *b:vala_vala_lint_config_filename*
+ Type: |String|
+ Default: `'vala-lint.conf'`
+
+ This variable can be set to specify a Vala-Lint config filename. When a file
+ with the specified name was not found or this variable was set to empty,
+ Vala-Lint will be executed without specifying a config filename.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index 61bfc139..04871403 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -16,6 +16,38 @@ Install prettier either globally or locally: >
npm install prettier # local
<
===============================================================================
+spectral *ale-yaml-spectral*
+
+Website: https://github.com/stoplightio/spectral
+
+Installation
+-------------------------------------------------------------------------------
+
+Install spectral either globally or locally: >
+
+ npm install @stoplight/spectral -g # global
+ npm install @stoplight/spectral # local
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_yaml_spectral_executable *g:ale_yaml_spectral_executable*
+ *b:ale_yaml_spectral_executable*
+ Type: |String|
+ Default: `'spectral'`
+
+ This variable can be set to change the path to spectral.
+
+g:ale_yaml_spectral_use_global *g:ale_yaml_spectral_use_global*
+ *b:ale_yaml_spectral_use_global*
+ Type: |String|
+ Default: `get(g:, 'ale_use_global_executables', 0)`
+
+ See |ale-integrations-local-executables|
+
+
+===============================================================================
swaglint *ale-yaml-swaglint*
Website: https://github.com/byCedric/swaglint
diff --git a/doc/ale.txt b/doc/ale.txt
index f9f40d12..9268c9f2 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -228,8 +228,8 @@ A minimal configuration for a language server linter might look so. >
\ 'project_root': '/path/to/root_of_project',
\})
<
-For language servers that use a TCP socket connection, you should define the
-address to connect to instead. >
+For language servers that use a TCP or named pipe socket connection, you
+should define the address to connect to instead. >
call ale#linter#Define('filetype_here', {
\ 'name': 'any_name_you_want',
@@ -646,6 +646,9 @@ problem will be displayed in a balloon instead of hover information.
Hover information can be displayed in the preview window instead by setting
|g:ale_hover_to_preview| to `1`.
+When using Neovim, if |g:ale_hover_to_floating_preview| or |g:ale_floating_preview|
+is set to 1, the hover information will show in a floating window.
+
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
@@ -954,6 +957,15 @@ g:ale_default_navigation *g:ale_default_navigation*
buffer, such as for |ALEFindReferences|, or |ALEGoToDefinition|.
+g:ale_detail_to_floating_preview *g:ale_detail_to_floating_preview*
+ *b:ale_detail_to_floating_preview*
+ Type: |Number|
+ Default: `0`
+
+ When this option is set to `1`, Neovim will use a floating window for
+ ALEDetail output.
+
+
g:ale_disable_lsp *g:ale_disable_lsp*
*b:ale_disable_lsp*
@@ -1177,6 +1189,16 @@ g:ale_fix_on_save_ignore *g:ale_fix_on_save_ignore*
let g:ale_fix_on_save_ignore = [g:AddBar]
<
+g:ale_floating_preview *g:ale_floating_preview*
+
+ Type: |Number|
+ Default: `0`
+
+ When set to `1`, Neovim will use a floating window for ale's preview window.
+ This is equivalent to setting |g:ale_hover_to_floating_preview| and
+ |g:ale_detail_to_floating_preview| to `1`.
+
+
g:ale_history_enabled *g:ale_history_enabled*
Type: |Number|
@@ -1235,6 +1257,14 @@ g:ale_hover_to_preview *g:ale_hover_to_preview*
instead of in balloons or the message line.
+g:ale_hover_to_floating_preview *g:ale_hover_to_floating_preview*
+ *b:ale_hover_to_floating_preview*
+ Type: |Number|
+ Default: `0`
+
+ If set to `1`, Neovim will use floating windows for hover messages.
+
+
g:ale_keep_list_window_open *g:ale_keep_list_window_open*
*b:ale_keep_list_window_open*
Type: |Number|
@@ -1526,11 +1556,13 @@ g:ale_linters *g:ale_linters*
following values: >
{
+ \ 'apkbuild': ['apkbuild_lint', 'secfixes_check'],
\ 'csh': ['shell'],
\ 'elixir': ['credo', 'dialyxir', 'dogma'],
\ 'go': ['gofmt', 'golint', 'go vet'],
\ 'hack': ['hack'],
\ 'help': [],
+ \ 'inko': ['inko'],
\ 'perl': ['perlcritic'],
\ 'perl6': [],
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright'],
@@ -1677,6 +1709,15 @@ g:ale_lsp_show_message_severity *g:ale_lsp_show_message_severity*
`'disabled'` - Doesn't display any information at all.
+g:ale_lsp_suggestions *g:ale_lsp_suggestions*
+
+ Type: |Number|
+ Default: 1
+
+ This variable defines if suggestions must be collected from LSP or tsserver
+ and shown.
+
+
g:ale_lsp_root *g:ale_lsp_root*
*b:ale_lsp_root*
@@ -1812,6 +1853,8 @@ g:ale_popup_menu_enabled *g:ale_popup_menu_enabled*
capabilities in the right click mouse menu when there's a LSP server or
tsserver available. See |ale-refactor|.
+ This feature is only supported in GUI versions of Vim.
+
This setting must be set to `1` before ALE is loaded for this behavior
to be enabled. See |ale-lint-settings-on-startup|.
@@ -2556,8 +2599,12 @@ documented in additional help files.
ada.....................................|ale-ada-options|
gcc...................................|ale-ada-gcc|
gnatpp................................|ale-ada-gnatpp|
+ ada-language-server...................|ale-ada-language-server|
ansible.................................|ale-ansible-options|
ansible-lint..........................|ale-ansible-ansible-lint|
+ apkbuild................................|ale-apkbuild-options|
+ apkbuild-lint.........................|ale-apkbuild-apkbuild-lint|
+ secfixes-check........................|ale-apkbuild-secfixes-check|
asciidoc................................|ale-asciidoc-options|
write-good............................|ale-asciidoc-write-good|
textlint..............................|ale-asciidoc-textlint|
@@ -2621,9 +2668,16 @@ documented in additional help files.
dfmt..................................|ale-d-dfmt|
dls...................................|ale-d-dls|
uncrustify............................|ale-d-uncrustify|
+ dafny...................................|ale-dafny-options|
+ dafny.................................|ale-dafny-dafny|
dart....................................|ale-dart-options|
+ analysis_server.......................|ale-dart-analysis_server|
dartanalyzer..........................|ale-dart-dartanalyzer|
dartfmt...............................|ale-dart-dartfmt|
+ dhall...................................|ale-dhall-options|
+ dhall-format..........................|ale-dhall-format|
+ dhall-freeze..........................|ale-dhall-freeze|
+ dhall-lint............................|ale-dhall-lint|
dockerfile..............................|ale-dockerfile-options|
dockerfile_lint.......................|ale-dockerfile-dockerfile_lint|
hadolint..............................|ale-dockerfile-hadolint|
@@ -2689,6 +2743,7 @@ documented in additional help files.
hfmt..................................|ale-haskell-hfmt|
hindent...............................|ale-haskell-hindent|
hlint.................................|ale-haskell-hlint|
+ hls...................................|ale-haskell-hls|
stack-build...........................|ale-haskell-stack-build|
stack-ghc.............................|ale-haskell-stack-ghc|
stylish-haskell.......................|ale-haskell-stylish-haskell|
@@ -2708,6 +2763,8 @@ documented in additional help files.
idris.................................|ale-idris-idris|
ink.....................................|ale-ink-options|
ink-language-server...................|ale-ink-language-server|
+ inko....................................|ale-inko-options|
+ inko..................................|ale-inko-inko|
ispc....................................|ale-ispc-options|
ispc..................................|ale-ispc-ispc|
java....................................|ale-java-options|
@@ -2735,6 +2792,7 @@ documented in additional help files.
jsonlint..............................|ale-json-jsonlint|
jq....................................|ale-json-jq|
prettier..............................|ale-json-prettier|
+ spectral..............................|ale-json-spectral|
julia...................................|ale-julia-options|
languageserver........................|ale-julia-languageserver|
kotlin..................................|ale-kotlin-options|
@@ -2787,6 +2845,10 @@ documented in additional help files.
ols...................................|ale-ocaml-ols|
ocamlformat...........................|ale-ocaml-ocamlformat|
ocp-indent............................|ale-ocaml-ocp-indent|
+ openapi.................................|ale-openapi-options|
+ ibm_validator.........................|ale-openapi-ibm-validator|
+ prettier..............................|ale-openapi-prettier|
+ yamllint..............................|ale-openapi-yamllint|
pawn....................................|ale-pawn-options|
uncrustify............................|ale-pawn-uncrustify|
perl....................................|ale-perl-options|
@@ -2882,6 +2944,8 @@ documented in additional help files.
rls...................................|ale-rust-rls|
rustc.................................|ale-rust-rustc|
rustfmt...............................|ale-rust-rustfmt|
+ salt....................................|ale-salt-options|
+ salt-lint.............................|ale-salt-salt-lint|
sass....................................|ale-sass-options|
sasslint..............................|ale-sass-sasslint|
stylelint.............................|ale-sass-stylelint|
@@ -2923,6 +2987,7 @@ documented in additional help files.
terraform...............................|ale-terraform-options|
terraform-fmt-fixer...................|ale-terraform-fmt-fixer|
terraform.............................|ale-terraform-terraform|
+ terraform-ls..........................|ale-terraform-terraform-ls|
terraform-lsp.........................|ale-terraform-terraform-lsp|
tflint................................|ale-terraform-tflint|
tex.....................................|ale-tex-options|
@@ -2938,11 +3003,13 @@ documented in additional help files.
thrift..................................|ale-thrift-options|
thrift................................|ale-thrift-thrift|
typescript..............................|ale-typescript-options|
+ deno..................................|ale-typescript-deno|
eslint................................|ale-typescript-eslint|
prettier..............................|ale-typescript-prettier|
standard..............................|ale-typescript-standard|
tslint................................|ale-typescript-tslint|
tsserver..............................|ale-typescript-tsserver|
+ xo....................................|ale-typescript-xo|
vala....................................|ale-vala-options|
uncrustify............................|ale-vala-uncrustify|
verilog/systemverilog...................|ale-verilog-options|
@@ -2956,11 +3023,11 @@ documented in additional help files.
hdl-checker...........................|ale-vhdl-hdl-checker|
vcom..................................|ale-vhdl-vcom|
xvhdl.................................|ale-vhdl-xvhdl|
+ vim help................................|ale-vim-help-options|
+ write-good............................|ale-vim-help-write-good|
vim.....................................|ale-vim-options|
vimls.................................|ale-vim-vimls|
vint..................................|ale-vim-vint|
- vim help................................|ale-vim-help-options|
- write-good............................|ale-vim-help-write-good|
vue.....................................|ale-vue-options|
prettier..............................|ale-vue-prettier|
vls...................................|ale-vue-vls|
@@ -2970,6 +3037,7 @@ documented in additional help files.
xmllint...............................|ale-xml-xmllint|
yaml....................................|ale-yaml-options|
prettier..............................|ale-yaml-prettier|
+ spectral..............................|ale-yaml-spectral|
swaglint..............................|ale-yaml-swaglint|
yamlfix...............................|ale-yaml-yamlfix|
yamllint..............................|ale-yaml-yamllint|
@@ -3788,7 +3856,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
When this argument is set to `'socket'`, then the
linter will be defined as an LSP linter via a TCP
- socket connection. `address` must be set.
+ or named pipe socket connection. `address` must be set.
ALE will not start a server automatically.
@@ -3813,7 +3881,10 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
`address` A |String| representing an address to connect to,
or a |Funcref| accepting a buffer number and
- returning the |String|.
+ returning the |String|. If the value contains a
+ colon, it is interpreted as referring to a TCP
+ socket; otherwise it is interpreted as the path of a
+ named pipe.
The result can be computed with |ale#command#Run()|.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-07 20:32:27 +0000