mirror of
https://github.com/dense-analysis/ale.git
synced 2026-01-27 05:12:16 +08:00
Merge remote-tracking branch 'upstream/master'
This commit is contained in:
@@ -6,7 +6,7 @@ ALE Elixir Integration *ale-elixir-options*
|
||||
mix *ale-elixir-mix*
|
||||
|
||||
|
||||
The `mix` linter is disabled by default, as it can bee too expensive to run.
|
||||
The `mix` linter is disabled by default, as it can be too expensive to run.
|
||||
See `:help g:ale_linters`
|
||||
|
||||
|
||||
|
||||
@@ -14,7 +14,8 @@ ember-template-lint *ale-handlebars-embertemplatelint*
|
||||
|
||||
g:ale_handlebars_embertemplatelint_executable
|
||||
*g:ale_handlebars_embertemplatelint_executable*
|
||||
Type: |String| *b:ale_handlebars_embertemplatelint_executable*
|
||||
*b:ale_handlebars_embertemplatelint_executable*
|
||||
Type: |String|
|
||||
Default: `'ember-template-lint'`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
@@ -22,7 +23,8 @@ g:ale_handlebars_embertemplatelint_executable
|
||||
|
||||
g:ale_handlebars_embertemplatelint_use_global
|
||||
*g:ale_handlebars_embertemplatelint_use_global*
|
||||
Type: |Number| *b:ale_handlebars_embertemplatelint_use_global*
|
||||
*b:ale_handlebars_embertemplatelint_use_global*
|
||||
Type: |Number|
|
||||
Default: `get(g:, 'ale_use_global_executables', 0)`
|
||||
|
||||
See |ale-integrations-local-executables|
|
||||
|
||||
66
doc/ale.txt
66
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
|
||||
@@ -526,6 +531,15 @@ completion information with Deoplete, consult Deoplete's documentation.
|
||||
ALE by can support automatic imports from external modules. This behavior can
|
||||
be enabled by setting the |g:ale_completion_autoimport| variable to `1`.
|
||||
|
||||
You can manually request imports for symbols at the cursor with the
|
||||
|ALEImport| command. The word at the cursor must be an exact match for some
|
||||
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.
|
||||
@@ -2971,6 +2985,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.
|
||||
|
||||
|
||||
@@ -3053,6 +3071,23 @@ ALEHover *ALEHover*
|
||||
A plug mapping `<Plug>(ale_hover)` is defined for this command.
|
||||
|
||||
|
||||
ALEImport *ALEImport*
|
||||
|
||||
Try to import a symbol using `tsserver` or a Language Server.
|
||||
|
||||
ALE will look for completions for the word at the cursor which contain
|
||||
additional text edits that possible insert lines to import the symbol. The
|
||||
first match with additional text edits will be used, and may add other code
|
||||
to the current buffer other than import lines.
|
||||
|
||||
If linting is enabled, and |g:ale_lint_on_text_changed| is set to ever check
|
||||
buffers when text is changed, the buffer will be checked again after changes
|
||||
are made.
|
||||
|
||||
A Plug mapping `<Plug>(ale_import)` is defined for this command. This
|
||||
mapping should only be bound for normal mode.
|
||||
|
||||
|
||||
ALEOrganizeImports *ALEOrganizeImports*
|
||||
|
||||
Organize imports using tsserver. Currently not implemented for LSPs.
|
||||
@@ -3060,9 +3095,10 @@ ALEOrganizeImports *ALEOrganizeImports*
|
||||
|
||||
ALERename *ALERename*
|
||||
|
||||
Rename a symbol using TypeScript server or Language Server.
|
||||
Rename a symbol using `tsserver` or a Language Server.
|
||||
|
||||
The user will be prompted for a new name.
|
||||
The symbol where the cursor is resting will be the symbol renamed, and a
|
||||
prompt will open to request a new name.
|
||||
|
||||
|
||||
ALERepeatSelection *ALERepeatSelection*
|
||||
@@ -3092,6 +3128,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*
|
||||
@@ -3957,6 +4000,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