1
0
mirror of https://github.com/amix/vimrc synced 2025-09-18 18:45:01 +08:00

Merge branch 'Linux' of https://github.com/Geezus42/vimrc into Linux

This commit is contained in:
geezus
2021-06-30 13:19:18 -05:00
235 changed files with 6246 additions and 1351 deletions

View File

@ -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|

View File

@ -21,6 +21,24 @@ g:ale_cuda_nvcc_options *g:ale_cuda_nvcc_options*
This variable can be changed to modify flags given to nvcc.
===============================================================================
clangd *ale-cuda-clangd*
g:ale_cuda_clangd_executable *g:ale_cuda_clangd_executable*
*b:ale_cuda_clangd_executable*
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_cuda_clangd_options *g:ale_cuda_clangd_options*
*b:ale_cuda_clangd_options*
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clangd.
===============================================================================
clang-format *ale-cuda-clangformat*

View File

@ -0,0 +1,21 @@
===============================================================================
ALE desktop Integration *ale-desktop-options*
===============================================================================
desktop-file-validate *ale-desktop-desktop-file-validate*
ALE supports checking .desktop files with `desktop-file-validate.`
g:ale_desktop_desktop_file_validate_options
*g:ale_desktop_desktop_file_validate_options*
*b:ale_desktop_desktop_file_validate_options*
Type: |String|
Default: `''`
This variable can be changed to set options for `desktop-file-validate`,
such as `'--warn-kde'`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -181,13 +181,17 @@ Generally write tests for any changes you make. The following types of tests
are recommended for the following types of code.
* New/edited error handler callbacks -> Write tests in `test/handler`
* New/edited command callbacks -> Write tests in `test/command_callback`
* New/edited linter definition -> Write tests in `test/linter`
* New/edited fixer functions -> Write tests in `test/fixers`
Look at existing tests in the codebase for examples of how to write tests.
Refer to the Vader documentation for general information on how to write Vader
tests: https://github.com/junegunn/vader.vim
If you need to add any supporting files for tests, such as empty files present
to test searching upwards through paths for configuration files, they can be
added to the `test/test-files` directory.
See |ale-development-linter-tests| for more information on how to write linter
tests.
@ -274,8 +278,8 @@ be written like so. >
\ '1:Something went wrong',
\ ]
<
Tests for what ALE runs should go in the `test/command_callback` directory,
and should be written like so. >
Tests for what ALE runs should go in the `test/linter` directory, and should
be written like so. >
Before:
" Load the linter and set up a series of commands, reset linter variables,
@ -311,6 +315,7 @@ The full list of commands that will be temporarily defined for linter tests
given the above setup are as follows.
`GivenCommandOutput [...]` - Define output for ale#command#Run.
`AssertLinterCwd cwd` - Check the `cwd` for the linter.
`AssertLinter executable, command` - Check the executable and command.
`AssertLinterNotExecuted` - Check that linters will not be executed.
`AssertLSPLanguage language` - Check the language given to an LSP server.
@ -357,6 +362,7 @@ The full list of commands that will be temporarily defined for fixer tests
given the above setup are as follows.
`GivenCommandOutput [...]` - Define output for ale#command#Run.
`AssertFixerCwd cwd` - Check the `cwd` for the fixer.
`AssertFixer results` - Check the fixer results
`AssertFixerNotExecuted` - Check that fixers will not be executed.

View File

@ -71,6 +71,26 @@ g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
or `-pa`.
-------------------------------------------------------------------------------
erlfmt *ale-erlang-erlfmt*
g:ale_erlang_erlfmt_executable *g:ale_erlang_erlfmt_executable*
*b:ale_erlang_erlfmt_executable*
Type: |String|
Default: `'erlfmt'`
This variable can be changed to specify the erlfmt executable.
g:ale_erlang_erlfmt_options *g:ale_erlang_erlfmt_options*
*b:ale_erlang_erlfmt_options*
Type: |String|
Default: `''`
This variable controls additional parameters passed to `erlfmt`, such as
`--insert-pragma` or `--print-width`.
-------------------------------------------------------------------------------
syntaxerl *ale-erlang-syntaxerl*

View File

@ -20,8 +20,8 @@ the benefit of running a number of linters, more than ALE would by default,
while ensuring it doesn't run any linters known to be slow or resource
intensive.
g:ale_go_go_executable *g:ale_go_go_options*
*b:ale_go_go_options*
g:ale_go_go_executable *g:ale_go_go_executable*
*b:ale_go_go_executable*
Type: |String|
Default: `'go'`
@ -194,12 +194,30 @@ g:ale_go_gometalinter_lint_package *g:ale_go_gometalinter_lint_package*
===============================================================================
gopls *ale-go-gopls*
gopls is the official Go language server, and is enabled for use with ALE by
default.
To install the latest stable version of `gopls` to your `$GOPATH`, try the
following command: >
GO111MODULE=on go get golang.org/x/tools/gopls@latest
<
If `$GOPATH` is readable by ALE, it should probably work without you having to
do anything else. See the `gopls` README file for more information:
https://github.com/golang/tools/blob/master/gopls/README.md
g:ale_go_gopls_executable *g:ale_go_gopls_executable*
*b:ale_go_gopls_executable*
Type: |String|
Default: `'gopls'`
Location of the gopls binary file.
See |ale-integrations-local-executables|
ALE will search for `gopls` in locally installed directories first by
default, and fall back on a globally installed `gopls` if it can't be found
otherwise.
g:ale_go_gopls_options *g:ale_go_gopls_options*
@ -228,6 +246,18 @@ g:ale_go_gopls_init_options *g:ale_go_gopls_init_options*
For a full list of supported analyzers, see:
https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
<<<<<<< HEAD
=======
g:ale_go_gopls_use_global *g:ale_go_gopls_use_global*
*b:ale_go_gopls_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
===============================================================================
govet *ale-go-govet*
@ -262,6 +292,18 @@ g:ale_go_revive_options *g:ale_go_revive_options*
===============================================================================
staticcheck *ale-go-staticcheck*
g:ale_go_staticcheck_executable *g:ale_go_staticcheck_executable*
*b:ale_go_staticcheck_executable*
Type: |String|
Default: `'staticcheck'`
See |ale-integrations-local-executables|
ALE will search for `staticcheck` in locally installed directories first by
default, and fall back on a globally installed `staticcheck` if it can't be
found otherwise.
g:ale_go_staticcheck_options *g:ale_go_staticcheck_options*
*b:ale_go_staticcheck_options*
Type: |String|
@ -280,5 +322,13 @@ g:ale_go_staticcheck_lint_package *g:ale_go_staticcheck_lint_package*
current file.
g:ale_go_staticcheck_use_global *g:ale_go_staticcheck_use_global*
*b:ale_go_staticcheck_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:

View File

@ -2,13 +2,41 @@
ALE HTML Integration *ale-html-options*
===============================================================================
angular *ale-html-angular*
ALE supports language server features for Angular. You can install it via `npm`: >
$ npm install --save-dev @angular/language-server
<
Angular 11 and up are supported.
g:ale_html_angular_executable *g:ale_html_angular_executable*
*b:ale_html_angular_executable*
Type: |String|
Default: `'ngserver'`
See |ale-integrations-local-executables|
g:ale_html_angular_use_global *g:ale_html_angular_use_global*
*b:ale_html_angular_use_global*
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
fecs *ale-html-fecs*
`fecs` options for HTMl is the same as the options for JavaScript,
and both of them reads `./.fecsrc` as the default configuration file.
`fecs` options for HTML are the same as the options for JavaScript, and both
of them read `./.fecsrc` as the default configuration file.
See: |ale-javascript-fecs|.
===============================================================================
html-beautify *ale-html-beautify*
@ -47,6 +75,40 @@ g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
See |ale-integrations-local-executables|
===============================================================================
prettier *ale-html-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
stylelint *ale-html-stylelint*
g:ale_html_stylelint_executable *g:ale_html_stylelint_executable*
*b:ale_html_stylelint_executable*
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_html_stylelint_options *g:ale_html_stylelint_options*
*b:ale_html_stylelint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_html_stylelint_use_global *g:ale_html_stylelint_use_global*
*b:ale_html_stylelint_use_global*
Type: |String|
Default: `0`
See |ale-integrations-local-executables|
===============================================================================
tidy *ale-html-tidy*
@ -97,39 +159,6 @@ g:ale_html_tidy_use_global *g:html_tidy_use_global*
See |ale-integrations-local-executables|
===============================================================================
prettier *ale-html-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
stylelint *ale-html-stylelint*
g:ale_html_stylelint_executable *g:ale_html_stylelint_executable*
*b:ale_html_stylelint_executable*
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_html_stylelint_options *g:ale_html_stylelint_options*
*b:ale_html_stylelint_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_html_stylelint_use_global *g:ale_html_stylelint_use_global*
*b:ale_html_stylelint_use_global*
Type: |String|
Default: `0`
See |ale-integrations-local-executables|
===============================================================================
write-good *ale-html-write-good*

View File

@ -2,6 +2,24 @@
ALE Nix Integration *ale-nix-options*
===============================================================================
nixfmt *ale-nix-nixfmt*
g:ale_nix_nixfmt_executable *g:ale_nix_nixfmt_executable*
*b:ale_nix_nixfmt_executable*
Type: String
Default: 'nixfmt'
This variable sets the executable used for nixfmt.
g:ale_nix_nixfmt_options *g:ale_nix_nixfmt_options*
*b:ale_nix_nixfmt_options*
Type: String
Default: ''
This variable can be set to pass additional options to the nixfmt fixer.
===============================================================================
nixpkgs-fmt *ale-nix-nixpkgs-fmt*

View File

@ -0,0 +1,24 @@
===============================================================================
ALE Pascal Integration *ale-pascal-options*
===============================================================================
ptop *ale-pascal-ptop*
g:ale_pascal_ptop_executable *g:ale_pascal_ptop_executable*
*b:ale_pascal_ptop_executable*
Type: |String|
Default: `'ptop'`
This variable can be changed to specify the ptop executable.
g:ale_pascal_ptop_options *g:ale_pascal_ptop_options*
*b:ale_pascal_ptop_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the ptop fixer.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -5,14 +5,15 @@ 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']}
let g:ale_linters = {'proto': ['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': ['protolint']}
<
===============================================================================
protoc-gen-lint *ale-proto-protoc-gen-lint*
@ -29,5 +30,31 @@ g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
directory of the linted file is always passed as an include path with '-I'
before any user-supplied options.
===============================================================================
protolint *ale-proto-protolint*
The linter is a pluggable tool that doesn't depend on the `protoc` binary.
This supports both linting and fixing.
Make sure the binary is available in the system path, or set
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*
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*
Type: |String|
Default: `''`
A path to a protolint configuration file.
The path to the configuration file can be an absolute path or a relative
path. ALE will search for the relative path in parent directories.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -688,6 +688,25 @@ g:ale_python_pyls_config *g:ale_python_pyls_config*
\ }
<
g:ale_python_pyls_options *g:ale_python_pyls_options*
*b:ale_python_pyls_options*
Type: |String|
Default: `''`
This variable can be changed to add command-line arguments to the pyls
invocation. Note that this is not the same thing as ale_python_pyls_config,
which allows configuration of how pyls functions; this is intended to
provide flexibility in how the pyls command is invoked.
For example, if you had installed `pyls` but your `pyls` executable was not
on your `PATH` for some reason, an alternative way to run the pyls server
would be:
let g:ale_python_pyls_executable = 'python3'
let g:ale_python_pyls_options = '-m pyls'
An example stragety for installing `pyls`:
`python3 -m pip install --user pyls`
===============================================================================
pyre *ale-python-pyre*

View File

@ -43,6 +43,8 @@ Notes:
* `shfmt`
* Bats
* `shellcheck`
* Bazel
* `buildifier`
* BibTeX
* `bibclean`
* Bourne Shell
@ -107,6 +109,7 @@ Notes:
* Cucumber
* `cucumber`
* CUDA
* `clangd`
* `nvcc`!!
* Cypher
* `cypher-lint`
@ -124,6 +127,8 @@ Notes:
* `dartanalyzer`!!
* `dartfmt`!!
* `language_server`
* desktop
* `desktop-file-validate`
* Dhall
* `dhall-format`
* `dhall-freeze`
@ -148,8 +153,15 @@ Notes:
* `ruumba`
* Erlang
* `SyntaxErl`
<<<<<<< HEAD
* `elvis`!!
* `erlc`
=======
* `dialyzer`
* `elvis`!!
* `erlc`
* `erlfmt`
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
* Fish
* `fish` (-n flag)
* `fish_indent`
@ -163,7 +175,7 @@ Notes:
* Git Commit Messages
* `gitlint`
* GLSL
* glslang
* `glslang`
* `glslls`
* Go
* `bingo`
@ -214,8 +226,13 @@ Notes:
* HTML
* `HTMLHint`
* `alex`!!
* `angular`
* `fecs`
* `html-beautify`
<<<<<<< HEAD
=======
* `htmlhint`
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
* `prettier`
* `proselint`
* `tidy`
@ -311,6 +328,7 @@ Notes:
* `nimpretty`
* nix
* `nix-instantiate`
* `nixfmt`
* `nixpkgs-fmt`
* `rnix-lsp`
* nroff
@ -336,6 +354,11 @@ Notes:
* `ibm_validator`
* `prettier`
* `yamllint`
<<<<<<< HEAD
=======
* Pascal
* `ptop`
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
* Pawn
* `uncrustify`
* Perl
@ -374,6 +397,7 @@ Notes:
* `swipl`
* proto
* `protoc-gen-lint`
* `protolint`
* Pug
* `pug-lint`
* Puppet
@ -482,11 +506,16 @@ Notes:
* `stylelint`
* SugarSS
* `stylelint`
* Svelte
* `prettier`
* `svelteserver`
* Swift
* Apple `swift-format`
* `sourcekit-lsp`
* `swiftformat`
* `swiftlint`
* systemd
* `systemd-analyze`!!
* Tcl
* `nagelfar`!!
* Terraform
@ -518,6 +547,9 @@ Notes:
* `tslint`
* `tsserver`
* `typecheck`
* V
* `v`
* `vfmt`
* VALA
* `uncrustify`
* `vala_lint`!!
@ -548,6 +580,7 @@ Notes:
* XML
* `xmllint`
* YAML
* `circleci`!!
* `prettier`
* `spectral`
* `swaglint`
@ -557,3 +590,6 @@ Notes:
* `yang-lsp`
* Zig
* `zls`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -0,0 +1,31 @@
===============================================================================
ALE Svelte Integration *ale-svelte-options*
===============================================================================
prettier *ale-svelte-prettier*
See |ale-javascript-prettier| for information about the available options.
===============================================================================
svelteserver *ale-svelte-svelteserver*
g:ale_svelte_svelteserver_executable *g:ale_svelte_svelteserver_executable*
*b:ale_svelte_svelteserver_executable*
Type: |String|
Default: `'svelteserver'`
See |ale-integrations-local-executables|
g:ale_svelte_svelteserver_use_global *g:ale_svelte_svelteserver_use_global*
*b:ale_svelte_svelteserver_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:

View File

@ -2,6 +2,44 @@
ALE Swift Integration *ale-swift-options*
===============================================================================
apple-swift-format *ale-swift-apple-swift-format*
There are 3 options to enable linting and fixing with Apple's swift-format:
1. Install the local executable in your path, as described here:
https://github.com/apple/swift-format
2. Install the executable via your OS package manager, for instance via
Homebrew with `brew install swift-format`
3. Your Swift project has a dependency on the swift-format package, so it can
be run with `swift run swift-format lint ...` In this case, you need to set
a variable, see |g:ale_swift_appleswiftformat_use_swiftpm|.
Additionally, ALE tries to locate and use the nearest existing `.swift-format`
configuration file.
g:ale_swift_appleswiftformat_executable *g:ale_swift_appleswiftformat_executable*
*b:ale_swift_appleswiftformat_executable*
Type: |String|
Default: `'swift-format'`
This variable can be modified to change the executable path for
`swift-format`.
g:ale_swift_appleswiftformat_use_swiftpm *g:ale_swift_appleswiftformat_use_swiftpm*
*b:ale_swift_appleswiftformat_use_swiftpm*
Type: |Number|
Default: `0`
When set to `1`, this option will cause ALE to use
`swift run swift-format lint ...` instead of the global executable. Use this
option if your Swift project has a dependency on the swift-format package.
See |ale-integrations-local-executables|
===============================================================================
sourcekitlsp *ale-swift-sourcekitlsp*
@ -16,6 +54,7 @@ g:ale_sourcekit_lsp_executable *g:ale_sourcekit_lsp_executable*
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -0,0 +1,14 @@
===============================================================================
ALE systemd Integration *ale-systemd-options*
===============================================================================
systemd-analyze *ale-systemd-analyze*
ALE supports checking user systemd units with `systemd-analyze --user verify`
Checks will only work with user unit files in their proper location. There
aren't any options, and checks can only run after saving the file.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -0,0 +1,45 @@
===============================================================================
ALE V Integration *ale-v-options*
===============================================================================
Integration Information
`v` is V's build tool. `vfmt` (called as `v fmt` from the same
executable that does the builds) is the autoformatter/fixer.
g:ale_v_v_executable *g:ale_v_v_executable*
*b:ale_v_v_executable*
Type: |String|
Default: `'v'`
The executable that will be run for the `v` linter and the `vfmt` fixer.
===============================================================================
v *ale-v-v*
g:ale_v_v_options *g:ale_v_v_options*
*b:ale_v_v_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the v linter.
They are injected directly after "v .".
===============================================================================
vfmt *ale-v-vfmt*
g:ale_v_vfmt_options *g:ale_v_vfmt_options*
*b:ale_v_vfmt_options*
Type: |String|
Default: `''`
This variable can be set to pass additional options to the vfmt fixer.
They are injected directly after "v fmt".
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@ -1,6 +1,28 @@
===============================================================================
ALE YAML Integration *ale-yaml-options*
===============================================================================
circleci *ale-yaml-circleci*
Website: https://circleci.com/docs/2.0/local-cli
Installation
-------------------------------------------------------------------------------
Follow the instructions on the website, and make sure to test that you can
validate configuration files with: >
circleci config validate - < .circleci/config.yml
<
As long as the validator runs correctly, you should be able to see errors when
you save the configuration file. The validator doesn't run as you type because
it sends network requests, and running too often would overload the circleci
servers.
===============================================================================
prettier *ale-yaml-prettier*
@ -15,6 +37,40 @@ Install prettier either globally or locally: >
npm install prettier -g # global
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|
===============================================================================
spectral *ale-yaml-spectral*
@ -80,6 +136,7 @@ g:ale_yaml_swaglint_use_global *g:ale_yaml_swaglint_use_global*
See |ale-integrations-local-executables|
===============================================================================
yamlfix *ale-yaml-yamlfix*
@ -118,6 +175,7 @@ g:ale_yaml_yamlfix_use_global *g:ale_yaml_yamlfix_use_global*
See |ale-integrations-local-executables|
===============================================================================
yamllint *ale-yaml-yamllint*

View File

@ -342,6 +342,12 @@ the buffers being checked.
When a |Dictionary| is returned for an |ALEFix| callback, the following keys
are supported for running the commands.
`cwd` An optional |String| for setting the working directory
for the command.
If not set, or `v:null`, the `cwd` of the last command
that spawn this one will be used.
`command` A |String| for the command to run. This key is required.
When `%t` is included in a command string, a temporary
@ -555,7 +561,6 @@ vimrc, and your issues should go away. >
set completeopt=menu,menuone,preview,noselect,noinsert
<
Or alternatively, if you want to show documentation in popups: >
set completeopt=menu,menuone,popup,noselect,noinsert
@ -647,7 +652,12 @@ 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|
<<<<<<< HEAD
is set to 1, the hover information will show in a floating window.
=======
is set to 1, the hover information will show in a floating window. And
|g:ale_floating_window_border| for the border setting.
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
For Vim 8.1+ terminals, mouse hovering is disabled by default. Enabling
|balloonexpr| commands in terminals can cause scrolling issues in terminals,
@ -957,8 +967,13 @@ g:ale_default_navigation *g:ale_default_navigation*
buffer, such as for |ALEFindReferences|, or |ALEGoToDefinition|.
<<<<<<< HEAD
g:ale_detail_to_floating_preview *g:ale_detail_to_floating_preview*
*b:ale_detail_to_floating_preview*
=======
g:ale_detail_to_floating_preview *g:ale_detail_to_floating_preview*
*b:ale_detail_to_floating_preview*
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
Type: |Number|
Default: `0`
@ -1189,7 +1204,11 @@ g:ale_fix_on_save_ignore *g:ale_fix_on_save_ignore*
let g:ale_fix_on_save_ignore = [g:AddBar]
<
<<<<<<< HEAD
g:ale_floating_preview *g:ale_floating_preview*
=======
g:ale_floating_preview *g:ale_floating_preview*
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
Type: |Number|
Default: `0`
@ -1199,6 +1218,22 @@ g:ale_floating_preview *g:ale_floating_pre
|g:ale_detail_to_floating_preview| to `1`.
<<<<<<< HEAD
=======
g:ale_floating_window_border *g:ale_floating_window_border*
Type: |List|
Default: `['|', '-', '+', '+', '+', '+']`
When set to `[]`, window borders are disabled. The elements in the list set
the horizontal, top, top-left, top-right, bottom-right and bottom-left
border characters, respectively.
If the terminal supports Unicode, you might try setting the value to
` ['│', '─', '╭', '╮', '╯', '╰']`, to make it look nicer.
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
g:ale_history_enabled *g:ale_history_enabled*
Type: |Number|
@ -1257,8 +1292,13 @@ g:ale_hover_to_preview *g:ale_hover_to_preview*
instead of in balloons or the message line.
<<<<<<< HEAD
g:ale_hover_to_floating_preview *g:ale_hover_to_floating_preview*
*b:ale_hover_to_floating_preview*
=======
g:ale_hover_to_floating_preview *g:ale_hover_to_floating_preview*
*b:ale_hover_to_floating_preview*
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
Type: |Number|
Default: `0`
@ -1418,6 +1458,7 @@ g:ale_linter_aliases *g:ale_linter_aliases*
\ 'ps1': 'powershell',
\ 'rmarkdown': 'r',
\ 'rmd': 'r',
\ 'svelte': ['svelte', 'javascript'],
\ 'systemverilog': 'verilog',
\ 'typescriptreact': ['typescript', 'tsx'],
\ 'verilog_systemverilog': ['verilog_systemverilog', 'verilog'],
@ -1559,7 +1600,7 @@ g:ale_linters *g:ale_linters*
\ 'apkbuild': ['apkbuild_lint', 'secfixes_check'],
\ 'csh': ['shell'],
\ 'elixir': ['credo', 'dialyxir', 'dogma'],
\ 'go': ['gofmt', 'golint', 'go vet'],
\ 'go': ['gofmt', 'golint', 'gopls', 'govet'],
\ 'hack': ['hack'],
\ 'help': [],
\ 'inko': ['inko'],
@ -1568,9 +1609,11 @@ g:ale_linters *g:ale_linters*
\ 'python': ['flake8', 'mypy', 'pylint', 'pyright'],
\ 'rust': ['cargo', 'rls'],
\ 'spec': [],
\ 'svelte': ['eslint', 'svelteserver'],
\ 'text': [],
\ 'vue': ['eslint', 'vls'],
\ 'zsh': ['shell'],
\ 'v': ['v'],
\}
<
This option can be used to enable only a particular set of linters for a
@ -1710,6 +1753,7 @@ g:ale_lsp_show_message_severity *g:ale_lsp_show_message_severity*
g:ale_lsp_suggestions *g:ale_lsp_suggestions*
<<<<<<< HEAD
Type: |Number|
Default: `0`
@ -1720,20 +1764,14 @@ g:ale_lsp_suggestions *g:ale_lsp_suggestions*
g:ale_lsp_root *g:ale_lsp_root*
*b:ale_lsp_root*
=======
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
Type: |Dictionary| or |String|
Default: {}
Type: |Number|
Default: `0`
This option is used to determine the project root for the LSP linter. If the
value is a |Dictionary|, it maps a linter to either a string containing the
project root or a |Funcref| to call to look up the root. The funcref is
provided the buffer number as its argument.
The buffer-specific variable may additionally be a string containing the
project root itself.
If neither variable yields a result, a linter-specific function is invoked to
detect a project root. If this, too, yields no result, the linter is disabled.
If set to `1`, show hints/suggestions from LSP servers or tsserver, in
addition to warnings and errors.
g:ale_max_buffer_history_size *g:ale_max_buffer_history_size*
@ -1880,6 +1918,25 @@ g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
`1`.
g:ale_root *g:ale_root*
*b:ale_root*
Type: |Dictionary| or |String|
Default: {}
This option is used to determine the project root for a linter. If the value
is a |Dictionary|, it maps a linter to either a |String| containing the
project root or a |Funcref| to call to look up the root. The |Funcref| is
provided the buffer number as its argument.
The buffer-specific variable may additionally be a string containing the
project root itself.
If neither variable yields a result, a linter-specific function is invoked to
detect a project root. If this, too, yields no result, and the linter is an
LSP linter, it will not run.
g:ale_set_balloons *g:ale_set_balloons*
*b:ale_set_balloons*
@ -2614,6 +2671,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|
@ -2663,6 +2722,7 @@ documented in additional help files.
stylelint.............................|ale-css-stylelint|
cuda....................................|ale-cuda-options|
nvcc..................................|ale-cuda-nvcc|
clangd................................|ale-cuda-clangd|
clang-format..........................|ale-cuda-clangformat|
d.......................................|ale-d-options|
dfmt..................................|ale-d-dfmt|
@ -2674,6 +2734,11 @@ documented in additional help files.
analysis_server.......................|ale-dart-analysis_server|
dartanalyzer..........................|ale-dart-dartanalyzer|
dartfmt...............................|ale-dart-dartfmt|
<<<<<<< HEAD
=======
desktop.................................|ale-desktop-options|
desktop-file-validate.................|ale-desktop-desktop-file-validate|
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
dhall...................................|ale-dhall-options|
dhall-format..........................|ale-dhall-format|
dhall-freeze..........................|ale-dhall-freeze|
@ -2695,6 +2760,7 @@ documented in additional help files.
dialyzer..............................|ale-erlang-dialyzer|
elvis.................................|ale-erlang-elvis|
erlc..................................|ale-erlang-erlc|
erlfmt................................|ale-erlang-erlfmt|
syntaxerl.............................|ale-erlang-syntaxerl|
eruby...................................|ale-eruby-options|
ruumba................................|ale-eruby-ruumba|
@ -2753,12 +2819,13 @@ documented in additional help files.
hcl.....................................|ale-hcl-options|
terraform-fmt.........................|ale-hcl-terraform-fmt|
html....................................|ale-html-options|
angular...............................|ale-html-angular|
fecs..................................|ale-html-fecs|
html-beautify.........................|ale-html-beautify|
htmlhint..............................|ale-html-htmlhint|
tidy..................................|ale-html-tidy|
prettier..............................|ale-html-prettier|
stylelint.............................|ale-html-stylelint|
tidy..................................|ale-html-tidy|
write-good............................|ale-html-write-good|
idris...................................|ale-idris-options|
idris.................................|ale-idris-idris|
@ -2829,6 +2896,7 @@ documented in additional help files.
nimlsp................................|ale-nim-nimlsp|
nimpretty.............................|ale-nim-nimpretty|
nix.....................................|ale-nix-options|
nixfmt................................|ale-nix-nixfmt|
nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
nroff...................................|ale-nroff-options|
write-good............................|ale-nroff-write-good|
@ -2851,6 +2919,11 @@ documented in additional help files.
ibm_validator.........................|ale-openapi-ibm-validator|
prettier..............................|ale-openapi-prettier|
yamllint..............................|ale-openapi-yamllint|
<<<<<<< HEAD
=======
pascal..................................|ale-pascal-options|
ptop..................................|ale-pascal-ptop|
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
pawn....................................|ale-pawn-options|
uncrustify............................|ale-pawn-uncrustify|
perl....................................|ale-perl-options|
@ -2884,6 +2957,7 @@ documented in additional help files.
swipl.................................|ale-prolog-swipl|
proto...................................|ale-proto-options|
protoc-gen-lint.......................|ale-proto-protoc-gen-lint|
protolint.............................|ale-proto-protolint|
pug.....................................|ale-pug-options|
puglint...............................|ale-pug-puglint|
puppet..................................|ale-puppet-options|
@ -2983,8 +3057,14 @@ documented in additional help files.
stylelint.............................|ale-stylus-stylelint|
sugarss.................................|ale-sugarss-options|
stylelint.............................|ale-sugarss-stylelint|
svelte..................................|ale-svelte-options|
prettier..............................|ale-svelte-prettier|
svelteserver..........................|ale-svelte-svelteserver|
swift...................................|ale-swift-options|
apple-swift-format....................|ale-swift-apple-swift-format|
sourcekitlsp..........................|ale-swift-sourcekitlsp|
systemd.................................|ale-systemd-options|
systemd-analyze.......................|ale-systemd-analyze|
tcl.....................................|ale-tcl-options|
nagelfar..............................|ale-tcl-nagelfar|
terraform...............................|ale-terraform-options|
@ -3013,6 +3093,12 @@ documented in additional help files.
tslint................................|ale-typescript-tslint|
tsserver..............................|ale-typescript-tsserver|
xo....................................|ale-typescript-xo|
<<<<<<< HEAD
=======
v.......................................|ale-v-options|
v.....................................|ale-v-v|
vfmt..................................|ale-v-vfmt|
>>>>>>> 1cca3b1df2973096bb9526a0d79c7b93c04e66b3
vala....................................|ale-vala-options|
uncrustify............................|ale-vala-uncrustify|
verilog/systemverilog...................|ale-verilog-options|
@ -3039,6 +3125,7 @@ documented in additional help files.
xml.....................................|ale-xml-options|
xmllint...............................|ale-xml-xmllint|
yaml....................................|ale-yaml-options|
circleci..............................|ale-yaml-circleci|
prettier..............................|ale-yaml-prettier|
spectral..............................|ale-yaml-spectral|
swaglint..............................|ale-yaml-swaglint|
@ -3575,6 +3662,12 @@ ale#command#Run(buffer, command, callback, [options]) *ale#command#Run()*
<
The following `options` can be provided.
`cwd` - An optional |String| for setting the working directory
for the command, just as per |ale#linter#Define|.
If not set, or `v:null`, the `cwd` of the last command
that spawned this one will be used.
`output_stream` - Either `'stdout'`, `'stderr'`, `'both'`, or
`'none`' for selecting which output streams to read
lines from.
@ -3684,6 +3777,21 @@ ale#fix#registry#Add(name, func, filetypes, desc, [aliases])
ALE will search for fixers in the registry first by `name`, then by their
`aliases`.
For example to register a custom fixer for `luafmt`: >
function! FormatLua(buffer) abort
return {
\ 'command': 'luafmt --stdin'
\}
endfunction
execute ale#fix#registry#Add('luafmt', 'FormatLua', ['lua'], 'luafmt for lua')
" You can now use it in g:ale_fixers
let g:ale_fixers = {
\ 'lua': ['luafmt']
}
<
ale#linter#Define(filetype, linter) *ale#linter#Define()*
@ -3800,10 +3908,33 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
The result can be computed with |ale#command#Run()|.
The command string can be formatted with format
markers. See |ale-command-format-strings|.
This command will be fed the lines from the buffer to
check, and will produce the lines of output given to
the `callback`.
`cwd` An optional |String| for setting the working
directory for the command, or a |Funcref| for a
function to call for computing the command, accepting
a buffer number. The working directory can be
specified as a format string for determining the path
dynamically. See |ale-command-format-strings|.
To set the working directory to the directory
containing the file you're checking, you should
probably use `'%s:h'` as the option value.
If this option is absent or the string is empty, the
`command` will be run with no determined working
directory in particular.
The directory specified with this option will be used
as the default working directory for all commands run
in a chain with |ale#command#Run()|, unless otherwise
specified.
`output_stream` A |String| for the output stream the lines of output
should be read from for the command which is run. The
accepted values are `'stdout'`, `'stderr'`, and