mirror of
https://github.com/dense-analysis/ale.git
synced 2025-12-28 14:56:52 +08:00
Merge branch 'master' into dhall
This commit is contained in:
38
doc/ale.txt
38
doc/ale.txt
@@ -147,6 +147,8 @@ ALE offers several options for controlling which linters are run.
|
||||
* Disabling only a subset of linters. - |g:ale_linters_ignore|
|
||||
* Disabling LSP linters and `tsserver`. - |g:ale_disable_lsp|
|
||||
|
||||
You can stop ALE any currently running linters with the |ALELintStop| command.
|
||||
Any existing problems will be kept.
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
3.1 Linting On Other Machines *ale-lint-other-machines*
|
||||
@@ -177,8 +179,11 @@ script like so. >
|
||||
|
||||
#!/usr/bin/env bash
|
||||
|
||||
exec docker run --rm -v "$(pwd):/data" cytopia/pylint "$@"
|
||||
exec docker run -i --rm -v "$(pwd):/data" cytopia/pylint "$@"
|
||||
<
|
||||
|
||||
You will run to run Docker commands with `-i` in order to read from stdin.
|
||||
|
||||
With the above script in mind, you might configure ALE to lint your Python
|
||||
project with `pylint` by providing the path to the script to execute, and
|
||||
mappings which describe how to between the two file systems in your
|
||||
@@ -532,6 +537,9 @@ potential completion result which includes additional text to insert into the
|
||||
current buffer, which ALE will assume is code for an import line. This command
|
||||
can be useful when your code already contains something you need to import.
|
||||
|
||||
You can execute other commands whenever ALE inserts some completion text with
|
||||
the |ALECompletePost| event.
|
||||
|
||||
When working with TypeScript files, ALE can remove warnings from your
|
||||
completions by setting the |g:ale_completion_tsserver_remove_warnings|
|
||||
variable to 1.
|
||||
@@ -2980,6 +2988,10 @@ ALEFix *ALEFix*
|
||||
|
||||
Fix problems with the current buffer. See |ale-fix| for more information.
|
||||
|
||||
If the command is run with a bang (`:ALEFix!`), all warnings will be
|
||||
suppressed, including warnings about no fixers being defined, and warnings
|
||||
about not being able to apply fixes to a file because it has been changed.
|
||||
|
||||
A plug mapping `<Plug>(ale_fix)` is defined for this command.
|
||||
|
||||
|
||||
@@ -3119,6 +3131,13 @@ ALELint *ALELint*
|
||||
A plug mapping `<Plug>(ale_lint)` is defined for this command.
|
||||
|
||||
|
||||
ALELintStop *ALELintStop*
|
||||
|
||||
Stop any currently running jobs for checking the current buffer.
|
||||
|
||||
Any problems from previous linter results will continue to be shown.
|
||||
|
||||
|
||||
ALEPrevious *ALEPrevious*
|
||||
ALEPreviousWrap *ALEPreviousWrap*
|
||||
ALENext *ALENext*
|
||||
@@ -3984,6 +4003,23 @@ g:ale_want_results_buffer *g:ale_want_results_buffer*
|
||||
figure out which buffer other sources should lint.
|
||||
|
||||
|
||||
ALECompletePost *ALECompletePost-autocmd*
|
||||
*ALECompletePost*
|
||||
|
||||
This |User| autocmd is triggered after ALE inserts an item on
|
||||
|CompleteDone|. This event can be used to run commands after a buffer
|
||||
is changed by ALE as the result of completion. For example, |ALEFix| can
|
||||
be configured to run automatically when completion is done: >
|
||||
|
||||
augroup FixAfterComplete
|
||||
autocmd!
|
||||
" Run ALEFix when completion items are added.
|
||||
autocmd User ALECompletePost ALEFix!
|
||||
" If ALE starts fixing a file, stop linters running for now.
|
||||
autocmd User ALEFixPre ALELintStop
|
||||
augroup END
|
||||
<
|
||||
|
||||
ALELintPre *ALELintPre-autocmd*
|
||||
*ALELintPre*
|
||||
ALELintPost *ALELintPost-autocmd*
|
||||
|
||||
Reference in New Issue
Block a user