summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-cs.txt23
-rw-r--r--doc/ale-d.txt9
-rw-r--r--doc/ale-development.txt11
-rw-r--r--doc/ale-ink.txt40
-rw-r--r--doc/ale-nix.txt24
-rw-r--r--doc/ale-ruby.txt26
-rw-r--r--doc/ale-solidity.txt12
-rw-r--r--doc/ale-sql.txt18
-rw-r--r--doc/ale-supported-languages-and-tools.txt7
-rw-r--r--doc/ale.txt139
10 files changed, 284 insertions, 25 deletions
diff --git a/doc/ale-cs.txt b/doc/ale-cs.txt
index abcc43eb..bb13863f 100644
--- a/doc/ale-cs.txt
+++ b/doc/ale-cs.txt
@@ -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.
diff --git a/doc/ale-d.txt b/doc/ale-d.txt
index 55596062..72349a20 100644
--- a/doc/ale-d.txt
+++ b/doc/ale-d.txt
@@ -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*
diff --git a/doc/ale-development.txt b/doc/ale-development.txt
index 16b16483..faa570c1 100644
--- a/doc/ale-development.txt
+++ b/doc/ale-development.txt
@@ -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:
diff --git a/doc/ale-ink.txt b/doc/ale-ink.txt
new file mode 100644
index 00000000..9412a09f
--- /dev/null
+++ b/doc/ale-ink.txt
@@ -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:
diff --git a/doc/ale-nix.txt b/doc/ale-nix.txt
new file mode 100644
index 00000000..5b2bd6cb
--- /dev/null
+++ b/doc/ale-nix.txt
@@ -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:
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index e373ab8e..a27a20b2 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -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.
===============================================================================
diff --git a/doc/ale-solidity.txt b/doc/ale-solidity.txt
index 4b74a27a..b6e48675 100644
--- a/doc/ale-solidity.txt
+++ b/doc/ale-solidity.txt
@@ -3,6 +3,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*
Solhint should work out-of-the-box. You can further configure it using a
diff --git a/doc/ale-sql.txt b/doc/ale-sql.txt
index f9bc6ac2..2807271b 100644
--- a/doc/ale-sql.txt
+++ b/doc/ale-sql.txt
@@ -40,4 +40,22 @@ g:ale_sql_sqlfmt_options *g:ale_sql_sqlfmt_options*
===============================================================================
+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:
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index d001489d..a0a346e5 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -103,6 +103,7 @@ Notes:
* Cython (pyrex filetype)
* `cython`
* D
+ * `dfmt`
* `dls`
* `dmd`
* `uncrustify`
@@ -200,6 +201,8 @@ Notes:
* `write-good`
* Idris
* `idris`
+* Ink
+ * `ink-language-server`
* ISPC
* `ispc`!!
* Java
@@ -281,6 +284,7 @@ Notes:
* `nim check`!!
* nix
* `nix-instantiate`
+ * `nixpkgs-fmt`
* nroff
* `alex`!!
* `proselint`
@@ -388,6 +392,7 @@ Notes:
* `rpmlint`
* Ruby
* `brakeman`
+ * `debride`
* `rails_best_practices`!!
* `reek`
* `rubocop`
@@ -421,11 +426,13 @@ Notes:
* SML
* `smlnj`
* Solidity
+ * `solc`
* `solhint`
* `solium`
* SQL
* `pgformatter`
* `sqlfmt`
+ * `sqlformat`
* `sqlint`
* Stylus
* `stylelint`
diff --git a/doc/ale.txt b/doc/ale.txt
index a95b0518..3282cbfd 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -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': 'stdio',
+ \ '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
@@ -597,6 +643,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|
@@ -1027,9 +1083,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'],
@@ -1317,6 +1376,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 +1517,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 +1526,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 +1543,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 +1645,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|
@@ -1954,6 +2057,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 +2164,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|
@@ -2136,6 +2248,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 +2305,8 @@ documented in additional help files.
mmc...................................|ale-mercury-mmc|
nasm....................................|ale-nasm-options|
nasm..................................|ale-nasm-nasm|
+ nix.....................................|ale-nix-options|
+ nixpkgs-fmt...........................|ale-nix-nixpkgs-fmt|
nroff...................................|ale-nroff-options|
write-good............................|ale-nroff-write-good|
objc....................................|ale-objc-options|
@@ -2281,6 +2397,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|
@@ -2314,6 +2431,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|
@@ -2321,6 +2439,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|
@@ -2522,6 +2641,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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-15 03:32:11 +0000