mirror of
https://github.com/amix/vimrc
synced 2025-06-23 15:04:59 +08:00
Updated plugins
This commit is contained in:
@ -11,22 +11,21 @@ csc *ale-cs-csc*
|
||||
|
||||
The |ale-cs-csc| linter checks for semantic errors when files are opened or
|
||||
saved.
|
||||
|
||||
|
||||
See |ale-lint-file-linters| for more information on linters which do not
|
||||
check for problems while you type.
|
||||
|
||||
The csc linter uses the mono csc compiler providing full c# 7 and newer
|
||||
support to generate a temporary module target file (/t:module). The module
|
||||
includes including all '*.cs' files contained in the directory tree rooted
|
||||
at the path defined by the |g:ale_cs_csc_source| or |b:ale_cs_csc_source|
|
||||
variabl and all sub directories.
|
||||
|
||||
The csc linter uses the mono csc compiler, providing full C# 7 and newer
|
||||
support, to generate a temporary module target file (/t:module). The module
|
||||
includes all '*.cs' files contained in the directory tree rooted at the path
|
||||
defined by the |g:ale_cs_csc_source| or |b:ale_cs_csc_source| variable and
|
||||
all sub directories.
|
||||
|
||||
It will in future replace the |ale-cs-mcs| and |ale-cs-mcsc| linters as both
|
||||
utilizer the mcsc compiler which according to mono porject ist further
|
||||
developed and as of writint these lines only receives maintenance updates.
|
||||
The down is that the csc compiler does not support the -sytax option any more
|
||||
and therefore |ale-cs-csc| linter doese not offer any as you type syntax
|
||||
checking like the |ale-cs-mcsc| linter doesn't.
|
||||
utilize the mcsc compiler which, according to the mono project, is no longer
|
||||
actively developed, and only receives maintenance updates. However, because
|
||||
the csc compiler does not support the -syntax option, this linter does not
|
||||
offer any as-you-type syntax checking, similar to the |ale-cs-mcsc| linter.
|
||||
|
||||
The paths to search for additional assembly files can be specified using the
|
||||
|g:ale_cs_csc_assembly_path| or |b:ale_cs_csc_assembly_path| variables.
|
||||
|
@ -1,6 +1,15 @@
|
||||
===============================================================================
|
||||
ALE D Integration *ale-d-options*
|
||||
|
||||
===============================================================================
|
||||
dfmt *ale-d-dfmt*
|
||||
|
||||
g:ale_d_dfmt_options *g:ale_d_dfmt_options*
|
||||
*b:ale_d_dfmt_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to the dfmt fixer.
|
||||
|
||||
===============================================================================
|
||||
dls *ale-d-dls*
|
||||
|
@ -184,13 +184,12 @@ tests: https://github.com/junegunn/vader.vim
|
||||
See |ale-development-linter-tests| for more information on how to write linter
|
||||
tests.
|
||||
|
||||
When you add new linters or fixers, make sure to add them into the table in
|
||||
the README, and also into the |ale-support| list in the main help file. If you
|
||||
forget to keep them both in sync, you should see an error like the following
|
||||
in Travis CI. >
|
||||
|
||||
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.
|
||||
>
|
||||
========================================
|
||||
diff README.md and doc/ale.txt tables
|
||||
diff supported-tools.md and doc/ale-supported-languages-and-tools.txt tables
|
||||
========================================
|
||||
Differences follow:
|
||||
|
||||
|
@ -50,7 +50,7 @@ g:ale_elm_ls_use_global *g:ale_elm_ls_use_global*
|
||||
g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
|
||||
*b:ale_elm_ls_elm_path*
|
||||
Type: |String|
|
||||
Default: `'elm'`
|
||||
Default: `''`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
@ -58,7 +58,7 @@ g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
|
||||
g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
|
||||
*b:ale_elm_ls_elm_format_path*
|
||||
Type: |String|
|
||||
Default: `'elm-format'`
|
||||
Default: `''`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
@ -66,10 +66,18 @@ g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
|
||||
g:ale_elm_ls_elm_test_path *g:ale_elm_ls_elm_test_path*
|
||||
*b:ale_elm_ls_elm_test_path*
|
||||
Type: |String|
|
||||
Default: `'elm-test'`
|
||||
Default: `''`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_elm_ls_elm_analyse_trigger *g:ale_elm_ls_elm_analyse_trigger*
|
||||
*b:ale_elm_ls_elm_analyse_trigger*
|
||||
Type: |String|
|
||||
Default: `'change'`
|
||||
|
||||
One of 'change', 'save' or 'never'
|
||||
|
||||
===============================================================================
|
||||
elm-make *ale-elm-elm-make*
|
||||
|
||||
|
@ -9,6 +9,16 @@ fecs *ale-html-fecs*
|
||||
and both of them reads `./.fecsrc` as the default configuration file.
|
||||
See: |ale-javascript-fecs|.
|
||||
|
||||
===============================================================================
|
||||
html-beautify *ale-html-beautify*
|
||||
|
||||
g:ale_html_beautify_options *g:ale_html_beautify_options*
|
||||
*b:ale_html_beautify_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be changed to modify flags given to html-beautify.
|
||||
|
||||
|
||||
===============================================================================
|
||||
htmlhint *ale-html-htmlhint*
|
||||
|
40
sources_non_forked/ale/doc/ale-ink.txt
Normal file
40
sources_non_forked/ale/doc/ale-ink.txt
Normal file
@ -0,0 +1,40 @@
|
||||
===============================================================================
|
||||
ALE Ink Integration *ale-ink-options*
|
||||
|
||||
|
||||
===============================================================================
|
||||
ink-language-server *ale-ink-language-server*
|
||||
|
||||
Ink Language Server
|
||||
(https://github.com/ephraim/ink-language-server)
|
||||
|
||||
g:ale_ink_ls_executable g:ale_ink_ls_executable
|
||||
b:ale_ink_ls_executable
|
||||
Type: |String|
|
||||
Default: `'ink-language-server'`
|
||||
|
||||
Ink language server executable.
|
||||
|
||||
g:ale_ink_ls_initialization_options
|
||||
g:ale_ink_ls_initialization_options
|
||||
b:ale_ink_ls_initialization_options
|
||||
Type: |Dictionary|
|
||||
Default: `{}`
|
||||
|
||||
Dictionary containing configuration settings that will be passed to the
|
||||
language server at startup. For certain platforms and certain story
|
||||
structures, the defaults will suffice. However, many projects will need to
|
||||
change these settings - see the ink-language-server website for more
|
||||
information.
|
||||
|
||||
An example of setting non-default options:
|
||||
{
|
||||
\ 'ink': {
|
||||
\ 'mainStoryPath': 'init.ink',
|
||||
\ 'inklecateExecutablePath': '/usr/local/bin/inklecate',
|
||||
\ 'runThroughMono': v:false
|
||||
\ }
|
||||
\}
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
45
sources_non_forked/ale/doc/ale-nim.txt
Normal file
45
sources_non_forked/ale/doc/ale-nim.txt
Normal file
@ -0,0 +1,45 @@
|
||||
===============================================================================
|
||||
ALE Nim Integration *ale-nim-options*
|
||||
|
||||
|
||||
===============================================================================
|
||||
nimcheck *ale-nim-nimcheck*
|
||||
|
||||
ALE does not provide additional configuration options for `nimcheck` at this
|
||||
point.
|
||||
|
||||
|
||||
===============================================================================
|
||||
nimlsp *ale-nim-nimlsp*
|
||||
|
||||
g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources*
|
||||
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
Sets the path to Nim source repository as the first argument to `nimlsp`
|
||||
command.
|
||||
|
||||
|
||||
===============================================================================
|
||||
nimpretty *ale-nim-nimpretty*
|
||||
|
||||
|
||||
g:ale_nim_nimpretty_executable *g:ale_nim_nimpretty_executable*
|
||||
*b:ale_nim_nimpretty_executable*
|
||||
Type: |String|
|
||||
Default: `'nimpretty'`
|
||||
|
||||
This variable can be changed to use a different executable for nimpretty.
|
||||
|
||||
|
||||
g:ale_nim_nimpretty_options *g:ale_nim_nimpretty_options*
|
||||
*b:ale_nim_nimpretty_options*
|
||||
Type: |String|
|
||||
Default: `'--maxLineLen:80'`
|
||||
|
||||
This variable can be changed to modify flags given to nimpretty.
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
24
sources_non_forked/ale/doc/ale-nix.txt
Normal file
24
sources_non_forked/ale/doc/ale-nix.txt
Normal file
@ -0,0 +1,24 @@
|
||||
===============================================================================
|
||||
ALE Nix Integration *ale-nix-options*
|
||||
|
||||
|
||||
===============================================================================
|
||||
nixpkgs-fmt *ale-nix-nixpkgs-fmt*
|
||||
|
||||
g:ale_nix_nixpkgsfmt_executable *g:ale_nix_nixpkgsfmt_executable*
|
||||
*b:ale_nix_nixpkgsfmt_executable*
|
||||
Type: |String|
|
||||
Default: `'nixpkgs-fmt'`
|
||||
|
||||
This variable sets executable used for nixpkgs-fmt.
|
||||
|
||||
g:ale_nix_nixpkgsfmt_options *g:ale_nix_nixpkgsfmt_options*
|
||||
*b:ale_nix_nixpkgsfmt_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to the nixpkgs-fmt fixer.
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
@ -157,9 +157,9 @@ g:ale_php_phpstan_level *g:ale_php_phpstan_level*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable controls the rule levels. 0 is the loosest and 4 is the
|
||||
This variable controls the rule levels. 0 is the loosest and 7 is the
|
||||
strictest. If this option isn't set, the rule level will be controlled by
|
||||
the configuration file. If no configuration file can be detected, `'4'` will
|
||||
the configuration file. If no configuration file can be detected, `'7'` will
|
||||
be used instead.
|
||||
|
||||
|
||||
@ -189,6 +189,13 @@ g:ale_php_psalm_executable *g:ale_php_psalm_executable*
|
||||
|
||||
This variable sets the executable used for psalm.
|
||||
|
||||
g:ale_psalm_langserver_options *g:ale_psalm_langserver_options*
|
||||
*b:ale_psalm_langserver_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to psalm.
|
||||
|
||||
===============================================================================
|
||||
php-cs-fixer *ale-php-php-cs-fixer*
|
||||
|
||||
|
@ -29,5 +29,14 @@ g:ale_purescript_ls_config g:ale_purescript_ls_config
|
||||
\ 'buildCommand': 'spago build -- --json-errors'
|
||||
\ }
|
||||
\}
|
||||
===============================================================================
|
||||
purty *ale-purescript-purty*
|
||||
|
||||
g:ale_purescript_purty_executable *g:ale_purescript_purty_executable*
|
||||
*b:ale_purescript_purty_executable*
|
||||
Type: |String|
|
||||
Default: `'purty'`
|
||||
|
||||
This variable can be changed to use a different executable for purty.
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
@ -21,6 +21,26 @@ g:ale_ruby_brakeman_options *g:ale_ruby_brakeman_options*
|
||||
|
||||
The contents of this variable will be passed through to brakeman.
|
||||
|
||||
===============================================================================
|
||||
debride *ale-ruby-debride*
|
||||
|
||||
g:ale_ruby_debride_executable *g:ale_ruby_debride_executable*
|
||||
*b:ale_ruby_debride_executable*
|
||||
Type: String
|
||||
Default: `'debride'`
|
||||
|
||||
Override the invoked debride binary. Set this to `'bundle'` to invoke
|
||||
`'bundle` `exec` debride'.
|
||||
|
||||
|
||||
g:ale_ruby_debride_options *g:ale_ruby_debride_options*
|
||||
*b:ale_ruby_debride_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be changed to modify flags given to debride.
|
||||
|
||||
|
||||
|
||||
===============================================================================
|
||||
rails_best_practices *ale-ruby-rails_best_practices*
|
||||
@ -91,7 +111,7 @@ g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be change to modify flags given to rubocop.
|
||||
This variable can be changed to modify flags given to rubocop.
|
||||
|
||||
|
||||
===============================================================================
|
||||
@ -146,7 +166,7 @@ g:ale_ruby_sorbet_options *g:ale_ruby_sorbet_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be change to modify flags given to sorbet.
|
||||
This variable can be changed to modify flags given to sorbet.
|
||||
|
||||
|
||||
===============================================================================
|
||||
@ -166,7 +186,7 @@ g:ale_ruby_standardrb_options *g:ale_ruby_standardrb_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be change to modify flags given to standardrb.
|
||||
This variable can be changed to modify flags given to standardrb.
|
||||
|
||||
|
||||
===============================================================================
|
||||
|
@ -2,6 +2,32 @@
|
||||
ALE Scala Integration *ale-scala-options*
|
||||
|
||||
|
||||
===============================================================================
|
||||
metals *ale-scala-metals*
|
||||
|
||||
`metals` requires either an SBT project, a Mill project, or a running Bloop
|
||||
server.
|
||||
|
||||
|
||||
g:ale_scala_metals_executable *g:ale_scala_metals_executable*
|
||||
*b:ale_scala_metals_executable*
|
||||
Type: |String|
|
||||
Default: `'metals-vim'`
|
||||
|
||||
Override the invoked `metals` binary.
|
||||
|
||||
|
||||
g:ale_scala_metals_project_root *g:ale_scala_metals_project_root*
|
||||
*b:ale_scala_metals_project_root*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
By default the project root is found by searching upwards for `build.sbt`,
|
||||
`build.sc`, `.bloop` or `.metals`.
|
||||
If the project root is elsewhere, you can override the project root
|
||||
directory.
|
||||
|
||||
|
||||
===============================================================================
|
||||
sbtserver *ale-scala-sbtserver*
|
||||
|
||||
|
@ -2,6 +2,18 @@
|
||||
ALE Solidity Integration *ale-solidity-options*
|
||||
|
||||
|
||||
===============================================================================
|
||||
solc *ale-solidity-solc*
|
||||
|
||||
|
||||
g:ale_solidity_solc_options *g:ale_solidity_solc_options*
|
||||
*b:ale_solidity_solc_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass extra options to solc.
|
||||
|
||||
|
||||
===============================================================================
|
||||
solhint *ale-solidity-solhint*
|
||||
|
||||
|
@ -39,5 +39,23 @@ g:ale_sql_sqlfmt_options *g:ale_sql_sqlfmt_options*
|
||||
At this time only the -u flag is available to format with upper-case.
|
||||
|
||||
|
||||
===============================================================================
|
||||
sqlformat *ale-sql-sqlformat*
|
||||
|
||||
g:ale_sql_sqlformat_executable *g:ale_sql_sqlformat_executable*
|
||||
*b:ale_sql_sqlformat_executable*
|
||||
Type: |String|
|
||||
Default: `'sqlformat'`
|
||||
|
||||
This variable sets executable used for sqlformat.
|
||||
|
||||
g:ale_sql_sqlformat_options *g:ale_sql_sqlformat_options*
|
||||
*b:ale_sql_sqlformat_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to the sqlformat fixer.
|
||||
|
||||
|
||||
===============================================================================
|
||||
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
|
||||
|
@ -103,6 +103,7 @@ Notes:
|
||||
* Cython (pyrex filetype)
|
||||
* `cython`
|
||||
* D
|
||||
* `dfmt`
|
||||
* `dls`
|
||||
* `dmd`
|
||||
* `uncrustify`
|
||||
@ -123,7 +124,7 @@ Notes:
|
||||
* `mix`!!
|
||||
* Elm
|
||||
* `elm-format`
|
||||
* `elm-lsp`
|
||||
* `elm-ls`
|
||||
* `elm-make`
|
||||
* Erb
|
||||
* `erb`
|
||||
@ -193,6 +194,7 @@ Notes:
|
||||
* HTML
|
||||
* `alex`!!
|
||||
* `fecs`
|
||||
* `html-beautify`
|
||||
* `HTMLHint`
|
||||
* `prettier`
|
||||
* `proselint`
|
||||
@ -200,6 +202,8 @@ Notes:
|
||||
* `write-good`
|
||||
* Idris
|
||||
* `idris`
|
||||
* Ink
|
||||
* `ink-language-server`
|
||||
* ISPC
|
||||
* `ispc`!!
|
||||
* Java
|
||||
@ -279,8 +283,11 @@ Notes:
|
||||
* `nasm`!!
|
||||
* Nim
|
||||
* `nim check`!!
|
||||
* `nimlsp`
|
||||
* `nimpretty`
|
||||
* nix
|
||||
* `nix-instantiate`
|
||||
* `nixpkgs-fmt`
|
||||
* nroff
|
||||
* `alex`!!
|
||||
* `proselint`
|
||||
@ -343,6 +350,7 @@ Notes:
|
||||
* `puppet-lint`
|
||||
* PureScript
|
||||
* `purescript-language-server`
|
||||
* `purty`
|
||||
* Python
|
||||
* `autopep8`
|
||||
* `bandit`
|
||||
@ -388,6 +396,7 @@ Notes:
|
||||
* `rpmlint`
|
||||
* Ruby
|
||||
* `brakeman`
|
||||
* `debride`
|
||||
* `rails_best_practices`!!
|
||||
* `reek`
|
||||
* `rubocop`
|
||||
@ -406,6 +415,7 @@ Notes:
|
||||
* `stylelint`
|
||||
* Scala
|
||||
* `fsc`
|
||||
* `metals`
|
||||
* `sbtserver`
|
||||
* `scalac`
|
||||
* `scalafmt`
|
||||
@ -420,11 +430,13 @@ Notes:
|
||||
* SML
|
||||
* `smlnj`
|
||||
* Solidity
|
||||
* `solc`
|
||||
* `solhint`
|
||||
* `solium`
|
||||
* SQL
|
||||
* `pgformatter`
|
||||
* `sqlfmt`
|
||||
* `sqlformat`
|
||||
* `sqlint`
|
||||
* Stylus
|
||||
* `stylelint`
|
||||
@ -457,6 +469,7 @@ Notes:
|
||||
* `eslint`
|
||||
* `fecs`
|
||||
* `prettier`
|
||||
* `standard`
|
||||
* `tslint`
|
||||
* `tsserver`
|
||||
* `typecheck`
|
||||
|
@ -16,6 +16,33 @@ prettier *ale-typescript-prettier*
|
||||
See |ale-javascript-prettier| for information about the available options.
|
||||
|
||||
|
||||
===============================================================================
|
||||
standard *ale-typescript-standard*
|
||||
|
||||
g:ale_typescript_standard_executable *g:ale_typescript_standard_executable*
|
||||
*b:ale_typescript_standard_executable*
|
||||
Type: |String|
|
||||
Default: `'standard'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
g:ale_typescript_standard_options *g:ale_typescript_standard_options*
|
||||
*b:ale_typescript_standard_options*
|
||||
Type: |String|
|
||||
Default: `''`
|
||||
|
||||
This variable can be set to pass additional options to standard.
|
||||
|
||||
|
||||
g:ale_typescript_standard_use_global *g:ale_typescript_standard_use_global*
|
||||
*b:ale_typescript_standard_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
|
||||
===============================================================================
|
||||
tslint *ale-typescript-tslint*
|
||||
|
||||
|
@ -9,7 +9,8 @@ CONTENTS *ale-contents*
|
||||
1. Introduction.........................|ale-introduction|
|
||||
2. Supported Languages & Tools..........|ale-support|
|
||||
3. Linting..............................|ale-lint|
|
||||
3.1 Other Sources.....................|ale-lint-other-sources|
|
||||
3.1 Adding Language Servers...........|ale-lint-language-servers|
|
||||
3.2 Other Sources.....................|ale-lint-other-sources|
|
||||
4. Fixing Problems......................|ale-fix|
|
||||
5. Language Server Protocol Support.....|ale-lsp|
|
||||
5.1 Completion........................|ale-completion|
|
||||
@ -147,7 +148,48 @@ ALE offers several options for controlling which linters are run.
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
3.1 Other Sources *ale-lint-other-sources*
|
||||
3.1 Adding Language Servers *ale-lint-language-servers*
|
||||
|
||||
ALE comes with many default configurations for language servers, so they can
|
||||
be detected and run automatically. ALE can connect to other language servers
|
||||
by defining a new linter for a filetype. New linters can be defined in |vimrc|,
|
||||
in plugin files, or `ale_linters` directories in |runtimepath|.
|
||||
|
||||
See |ale-linter-loading-behavior| for more information on loading linters.
|
||||
|
||||
A minimal configuration for a language server linter might look so. >
|
||||
|
||||
call ale#linter#Define('filetype_here', {
|
||||
\ 'name': 'any_name_you_want',
|
||||
\ 'lsp': 'stdio',
|
||||
\ 'executable': '/path/to/executable',
|
||||
\ 'command': '%e run',
|
||||
\ '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. >
|
||||
|
||||
call ale#linter#Define('filetype_here', {
|
||||
\ 'name': 'any_name_you_want',
|
||||
\ 'lsp': 'socket',
|
||||
\ 'address': 'servername:1234',
|
||||
\ 'project_root': '/path/to/root_of_project',
|
||||
\})
|
||||
<
|
||||
Most of the options for a language server can be replaced with a |Funcref|
|
||||
for a function accepting a buffer number for dynamically computing values
|
||||
such as the executable path, the project path, the server address, etc,
|
||||
most of which can also be determined based on executing some other
|
||||
asynchronous task. See |ale#command#Run()| for computing linter options
|
||||
based on asynchronous results.
|
||||
|
||||
See |ale#linter#Define()| for a detailed explanation of all of the options
|
||||
for configuring linters.
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
3.2 Other Sources *ale-lint-other-sources*
|
||||
|
||||
Problems for a buffer can be taken from other sources and rendered by ALE.
|
||||
This allows ALE to be used in combination with other plugins which also want
|
||||
@ -376,6 +418,10 @@ The |ALEComplete| command can be used to show completion suggestions manually,
|
||||
even when |g:ale_completion_enabled| is set to `0`. For manually requesting
|
||||
completion information with Deoplete, consult Deoplete's documentation.
|
||||
|
||||
When working with TypeScript files, ALE by can support automatic imports
|
||||
from external modules. This behavior can be enabled by setting the
|
||||
|g:ale_completion_tsserver_autoimport| variable to `1`.
|
||||
|
||||
*ale-completion-completeopt-bug*
|
||||
|
||||
ALE Automatic completion implementation replaces |completeopt| before opening
|
||||
@ -386,7 +432,42 @@ vimrc, and your issues should go away. >
|
||||
|
||||
set completeopt=menu,menuone,preview,noselect,noinsert
|
||||
<
|
||||
*ale-symbols*
|
||||
|
||||
ALE provides a set of basic completion symbols. If you want to replace those
|
||||
symbols with others, you can set the variable |g:ale_completion_symbols| with
|
||||
a mapping of the type of completion to the symbol or other string that you
|
||||
would like to use. An example here shows the available options for symbols >
|
||||
|
||||
let g:ale_completion_symbols = {
|
||||
\ 'text': '',
|
||||
\ 'method': '',
|
||||
\ 'function': '',
|
||||
\ 'constructor': '',
|
||||
\ 'field': '',
|
||||
\ 'variable': '',
|
||||
\ 'class': '',
|
||||
\ 'interface': '',
|
||||
\ 'module': '',
|
||||
\ 'property': '',
|
||||
\ 'unit': 'unit',
|
||||
\ 'value': 'val',
|
||||
\ 'enum': '',
|
||||
\ 'keyword': 'keyword',
|
||||
\ 'snippet': '',
|
||||
\ 'color': 'color',
|
||||
\ 'file': '',
|
||||
\ 'reference': 'ref',
|
||||
\ 'folder': '',
|
||||
\ 'enum member': '',
|
||||
\ 'constant': '',
|
||||
\ 'struct': '',
|
||||
\ 'event': 'event',
|
||||
\ 'operator': '',
|
||||
\ 'type_parameter': 'type param',
|
||||
\ '<default>': 'v'
|
||||
\ }
|
||||
<
|
||||
-------------------------------------------------------------------------------
|
||||
5.2 Go To Definition *ale-go-to-definition*
|
||||
|
||||
@ -597,6 +678,16 @@ b:ale_completion_enabled *b:ale_completion_enabled*
|
||||
See |ale-completion|
|
||||
|
||||
|
||||
g:ale_completion_tsserver_autoimport *g:ale_completion_tsserver_autoimport*
|
||||
|
||||
Type: Number
|
||||
Default: `0`
|
||||
|
||||
When this option is set to `0`, ALE will not try to automatically import
|
||||
completion results from external modules. It can be enabled by setting it
|
||||
to `1`.
|
||||
|
||||
|
||||
g:ale_completion_excluded_words *g:ale_completion_excluded_words*
|
||||
*b:ale_completion_excluded_words*
|
||||
Type: |List|
|
||||
@ -615,6 +706,47 @@ g:ale_completion_excluded_words *g:ale_completion_excluded_words*
|
||||
let b:ale_completion_excluded_words = ['it', 'describe']
|
||||
<
|
||||
|
||||
g:ale_completion_symbols *g:ale_completion_symbols*
|
||||
|
||||
Type: |Dictionary|
|
||||
|
||||
|
||||
A mapping from completion types to symbols for completions. See
|
||||
|ale-symbols| for more information.
|
||||
|
||||
By default, this mapping only uses built in Vim completion kinds, but it can
|
||||
be updated to use any unicode character for the completion kind. For
|
||||
example: >
|
||||
let g:ale_completion_symbols = {
|
||||
\ 'text': '',
|
||||
\ 'method': '',
|
||||
\ 'function': '',
|
||||
\ 'constructor': '',
|
||||
\ 'field': '',
|
||||
\ 'variable': '',
|
||||
\ 'class': '',
|
||||
\ 'interface': '',
|
||||
\ 'module': '',
|
||||
\ 'property': '',
|
||||
\ 'unit': 'v',
|
||||
\ 'value': 'v',
|
||||
\ 'enum': 't',
|
||||
\ 'keyword': 'v',
|
||||
\ 'snippet': 'v',
|
||||
\ 'color': 'v',
|
||||
\ 'file': 'v',
|
||||
\ 'reference': 'v',
|
||||
\ 'folder': 'v',
|
||||
\ 'enum_member': 'm',
|
||||
\ 'constant': 'm',
|
||||
\ 'struct': 't',
|
||||
\ 'event': 'v',
|
||||
\ 'operator': 'f',
|
||||
\ 'type_parameter': 'p',
|
||||
\ '<default>': 'v'
|
||||
\ })
|
||||
<
|
||||
|
||||
g:ale_completion_max_suggestions *g:ale_completion_max_suggestions*
|
||||
|
||||
Type: |Number|
|
||||
@ -745,6 +877,15 @@ g:ale_echo_msg_info_str *g:ale_echo_msg_info_str*
|
||||
The string used for `%severity%` for info. See |g:ale_echo_msg_format|
|
||||
|
||||
|
||||
g:ale_echo_msg_log_str *g:ale_echo_msg_log_str*
|
||||
|
||||
Type: |String|
|
||||
Default: `'Log'`
|
||||
|
||||
The string used for `%severity%` for log, used only for handling LSP show
|
||||
message requests. See |g:ale_lsp_show_message_format|
|
||||
|
||||
|
||||
g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
|
||||
|
||||
Type: |String|
|
||||
@ -1027,9 +1168,12 @@ g:ale_linter_aliases *g:ale_linter_aliases*
|
||||
{
|
||||
\ 'Dockerfile': 'dockerfile',
|
||||
\ 'csh': 'sh',
|
||||
\ 'javascriptreact': ['javascript', 'jsx'],
|
||||
\ 'plaintex': 'tex',
|
||||
\ 'rmarkdown': 'r',
|
||||
\ 'rmd': 'r',
|
||||
\ 'systemverilog': 'verilog',
|
||||
\ 'typescriptreact': ['typescript', 'tsx'],
|
||||
\ 'verilog_systemverilog': ['verilog_systemverilog', 'verilog'],
|
||||
\ 'vimwiki': 'markdown',
|
||||
\ 'vue': ['vue', 'javascript'],
|
||||
@ -1192,6 +1336,47 @@ b:ale_loclist_msg_format *b:ale_loclist_msg_format*
|
||||
|
||||
The strings for configuring `%severity%` are also used for this option.
|
||||
|
||||
|
||||
g:ale_lsp_show_message_format *g:ale_lsp_show_message_format*
|
||||
|
||||
Type: |String|
|
||||
Default: `'%severity%:%linter%: %s'`
|
||||
|
||||
This variable defines the format that messages received from an LSP will
|
||||
have when echoed. The following sequences of characters will be replaced.
|
||||
|
||||
`%s` - replaced with the message text
|
||||
`%linter%` - replaced with the name of the linter
|
||||
`%severity%` - replaced with the severity of the message
|
||||
|
||||
The strings for `%severity%` levels "error", "info" and "warning" are shared
|
||||
with |g:ale_echo_msg_format|. Severity "log" is unique to
|
||||
|g:ale_lsp_show_message_format| and it can be configured via
|
||||
|
||||
|g:ale_echo_msg_log_str| - Defaults to `'Log'`
|
||||
|
||||
Please note that |g:ale_lsp_show_message_format| *can not* be configured
|
||||
separately for each buffer like |g:ale_echo_msg_format| can.
|
||||
|
||||
|
||||
g:ale_lsp_show_message_severity *g:ale_lsp_show_message_severity*
|
||||
|
||||
Type: |String|
|
||||
Default: `'error'`
|
||||
|
||||
This variable defines the minimum severity level an LSP message needs to be
|
||||
displayed. Messages below this level are discarded; please note that
|
||||
messages with `Log` severity level are always discarded.
|
||||
|
||||
Possible values follow the LSP spec `MessageType` definition:
|
||||
|
||||
`'error'` - Displays only errors.
|
||||
`'warning'` - Displays errors and warnings.
|
||||
`'information'` - Displays errors, warnings and infos
|
||||
`'log'` - Same as `'information'`
|
||||
`'disabled'` - Doesn't display any information at all.
|
||||
|
||||
|
||||
g:ale_lsp_root *g:ale_lsp_root*
|
||||
b:ale_lsp_root *b:ale_lsp_root*
|
||||
|
||||
@ -1317,6 +1502,27 @@ g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
|
||||
will not set buffer variables per |g:ale_pattern_options|.
|
||||
|
||||
|
||||
g:ale_rename_tsserver_find_in_comments *g:ale_rename_tsserver_find_in_comments*
|
||||
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
If enabled, this option will tell tsserver to find and replace text in
|
||||
comments when calling |ALERename|. It can be enabled by settings the value
|
||||
to `1`.
|
||||
|
||||
|
||||
g:ale_rename_tsserver_find_in_strings *g:ale_rename_tsserver_find_in_strings*
|
||||
|
||||
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
If enabled, this option will tell tsserver to find and replace text in
|
||||
strings when calling |ALERename|. It can be enabled by settings the value to
|
||||
`1`.
|
||||
|
||||
|
||||
g:ale_set_balloons *g:ale_set_balloons*
|
||||
*b:ale_set_balloons*
|
||||
|
||||
@ -1437,8 +1643,8 @@ g:ale_set_signs *g:ale_set_signs*
|
||||
|ALEWarningLine| - All items with `'type': 'W'`
|
||||
|ALEInfoLine| - All items with `'type': 'I'`
|
||||
|
||||
With Neovim 0.3.2 or higher, ALE uses `numhl` option to highlight 'number'
|
||||
column. It uses the following highlight groups.
|
||||
With Neovim 0.3.2 or higher, ALE can use the `numhl` option to highlight the
|
||||
'number' column. It uses the following highlight groups.
|
||||
|
||||
|ALEErrorSignLineNr| - Items with `'type': 'E'`
|
||||
|ALEWarningSignLineNr| - Items with `'type': 'W'`
|
||||
@ -1446,6 +1652,9 @@ g:ale_set_signs *g:ale_set_signs*
|
||||
|ALEStyleErrorSignLineNr| - Items with `'type': 'E'` and `'sub_type': 'style'`
|
||||
|ALEStyleWarningSignLineNr| - Items with `'type': 'W'` and `'sub_type': 'style'`
|
||||
|
||||
To enable line number highlighting |g:ale_sign_highlight_linenrs| must be
|
||||
set to `1` before ALE is loaded.
|
||||
|
||||
The markers for the highlights can be customized with the following options:
|
||||
|
||||
|g:ale_sign_error|
|
||||
@ -1460,6 +1669,16 @@ g:ale_set_signs *g:ale_set_signs*
|
||||
To limit the number of signs ALE will set, see |g:ale_max_signs|.
|
||||
|
||||
|
||||
g:ale_sign_priority *g:ale_sign_priority*
|
||||
|
||||
Type: |Number|
|
||||
Default: `30`
|
||||
|
||||
From Neovim 0.4.0 and Vim 8.1, ALE can set sign priority to all signs. The
|
||||
larger this value is, the higher priority ALE signs have over other plugin
|
||||
signs. See |sign-priority| for further details on how priority works.
|
||||
|
||||
|
||||
g:ale_shell *g:ale_shell*
|
||||
|
||||
Type: |String|
|
||||
@ -1552,6 +1771,16 @@ g:ale_sign_warning *g:ale_sign_warning*
|
||||
The sign for warnings in the sign gutter.
|
||||
|
||||
|
||||
g:ale_sign_highlight_linenrs *g:ale_sign_highlight_linenrs*
|
||||
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
When set to `1`, this option enables highlighting problems on the 'number'
|
||||
column in Vim versions that support `numhl` highlights. This option must be
|
||||
configured before ALE is loaded.
|
||||
|
||||
|
||||
g:ale_update_tagstack *g:ale_update_tagstack*
|
||||
*b:ale_update_tagstack*
|
||||
Type: |Number|
|
||||
@ -1606,6 +1835,8 @@ g:ale_virtualtext_cursor *g:ale_virtualtext_cursor*
|
||||
Type: |Number|
|
||||
Default: `0`
|
||||
|
||||
This option only has any effect in NeoVim.
|
||||
|
||||
When this option is set to `1`, a message will be shown when a cursor is
|
||||
near a warning or error. ALE will attempt to find the warning or error at a
|
||||
column nearest to the cursor when the cursor is resting on a line which
|
||||
@ -1954,6 +2185,14 @@ g:ale_languagetool_executable *g:ale_languagetool_executable*
|
||||
The executable to run for languagetool.
|
||||
|
||||
|
||||
g:ale_languagetool_options *g:ale_languagetool_options*
|
||||
*b:ale_languagetool_options*
|
||||
Type: |String|
|
||||
Default: `'--autoDetect'`
|
||||
|
||||
This variable can be set to pass additional options to languagetool.
|
||||
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
7.3. Options for write-good *ale-write-good-options*
|
||||
|
||||
@ -2053,6 +2292,7 @@ documented in additional help files.
|
||||
nvcc..................................|ale-cuda-nvcc|
|
||||
clang-format..........................|ale-cuda-clangformat|
|
||||
d.......................................|ale-d-options|
|
||||
dfmt..................................|ale-d-dfmt|
|
||||
dls...................................|ale-d-dls|
|
||||
uncrustify............................|ale-d-uncrustify|
|
||||
dart....................................|ale-dart-options|
|
||||
@ -2129,6 +2369,7 @@ documented in additional help files.
|
||||
terraform-fmt.........................|ale-hcl-terraform-fmt|
|
||||
html....................................|ale-html-options|
|
||||
fecs..................................|ale-html-fecs|
|
||||
html-beautify.........................|ale-html-beautify|
|
||||
htmlhint..............................|ale-html-htmlhint|
|
||||
tidy..................................|ale-html-tidy|
|
||||
prettier..............................|ale-html-prettier|
|
||||
@ -2136,6 +2377,8 @@ documented in additional help files.
|
||||
write-good............................|ale-html-write-good|
|
||||
idris...................................|ale-idris-options|
|
||||
idris.................................|ale-idris-idris|
|
||||
ink.....................................|ale-ink-options|
|
||||
ink-language-server...................|ale-ink-language-server|
|
||||
ispc....................................|ale-ispc-options|
|
||||
ispc..................................|ale-ispc-ispc|
|
||||
java....................................|ale-java-options|
|
||||
@ -2191,6 +2434,12 @@ documented in additional help files.
|
||||
mmc...................................|ale-mercury-mmc|
|
||||
nasm....................................|ale-nasm-options|
|
||||
nasm..................................|ale-nasm-nasm|
|
||||
nim.....................................|ale-nim-options|
|
||||
nimcheck..............................|ale-nim-nimcheck|
|
||||
nimlsp................................|ale-nim-nimlsp|
|
||||
nimpretty.............................|ale-nim-nimpretty|
|
||||
nix.....................................|ale-nix-options|
|
||||
nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
|
||||
nroff...................................|ale-nroff-options|
|
||||
write-good............................|ale-nroff-write-good|
|
||||
objc....................................|ale-objc-options|
|
||||
@ -2246,6 +2495,7 @@ documented in additional help files.
|
||||
puppet-languageserver.................|ale-puppet-languageserver|
|
||||
purescript..............................|ale-purescript-options|
|
||||
purescript-language-server............|ale-purescript-language-server|
|
||||
purty.................................|ale-purescript-purty|
|
||||
pyrex (cython)..........................|ale-pyrex-options|
|
||||
cython................................|ale-pyrex-cython|
|
||||
python..................................|ale-python-options|
|
||||
@ -2281,6 +2531,7 @@ documented in additional help files.
|
||||
write-good............................|ale-restructuredtext-write-good|
|
||||
ruby....................................|ale-ruby-options|
|
||||
brakeman..............................|ale-ruby-brakeman|
|
||||
debride...............................|ale-ruby-debride|
|
||||
rails_best_practices..................|ale-ruby-rails_best_practices|
|
||||
reek..................................|ale-ruby-reek|
|
||||
rubocop...............................|ale-ruby-rubocop|
|
||||
@ -2298,6 +2549,7 @@ documented in additional help files.
|
||||
sasslint..............................|ale-sass-sasslint|
|
||||
stylelint.............................|ale-sass-stylelint|
|
||||
scala...................................|ale-scala-options|
|
||||
metals................................|ale-scala-metals|
|
||||
sbtserver.............................|ale-scala-sbtserver|
|
||||
scalafmt..............................|ale-scala-scalafmt|
|
||||
scalastyle............................|ale-scala-scalastyle|
|
||||
@ -2313,6 +2565,7 @@ documented in additional help files.
|
||||
sml.....................................|ale-sml-options|
|
||||
smlnj.................................|ale-sml-smlnj|
|
||||
solidity................................|ale-solidity-options|
|
||||
solc..................................|ale-solidity-solc|
|
||||
solhint...............................|ale-solidity-solhint|
|
||||
solium................................|ale-solidity-solium|
|
||||
spec....................................|ale-spec-options|
|
||||
@ -2320,6 +2573,7 @@ documented in additional help files.
|
||||
sql.....................................|ale-sql-options|
|
||||
pgformatter...........................|ale-sql-pgformatter|
|
||||
sqlfmt................................|ale-sql-sqlfmt|
|
||||
sqlformat.............................|ale-sql-sqlformat|
|
||||
stylus..................................|ale-stylus-options|
|
||||
stylelint.............................|ale-stylus-stylelint|
|
||||
sugarss.................................|ale-sugarss-options|
|
||||
@ -2347,6 +2601,7 @@ documented in additional help files.
|
||||
typescript..............................|ale-typescript-options|
|
||||
eslint................................|ale-typescript-eslint|
|
||||
prettier..............................|ale-typescript-prettier|
|
||||
standard..............................|ale-typescript-standard|
|
||||
tslint................................|ale-typescript-tslint|
|
||||
tsserver..............................|ale-typescript-tsserver|
|
||||
vala....................................|ale-vala-options|
|
||||
@ -2521,6 +2776,18 @@ ALEHover *ALEHover*
|
||||
A plug mapping `<Plug>(ale_hover)` is defined for this command.
|
||||
|
||||
|
||||
ALEOrganizeImports *ALEOrganizeImports*
|
||||
|
||||
Organize imports using tsserver. Currently not implemented for LSPs.
|
||||
|
||||
|
||||
ALERename *ALERename*
|
||||
|
||||
Rename a symbol using TypeScript server or Language Server.
|
||||
|
||||
The user will be prompted for a new name.
|
||||
|
||||
|
||||
ALESymbolSearch `<query>` *ALESymbolSearch*
|
||||
|
||||
Search for symbols in the workspace, taken from any available LSP linters.
|
||||
|
Reference in New Issue
Block a user