hasufell/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

#817 - Document the buffer toggling options, and define plug mappings for everything

Browse Source
This commit is contained in:
w0rp 2017-10-29 10:55:02 +00:00
parent 5fc2b98b73
commit 1aa737cdc9
2 changed files with 33 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/ale.txt
View File

@ -1447,13 +1447,36 @@ ALELast *ALELast*
ALEToggle *ALEToggle* ALEToggle *ALEToggle*
ALEEnable *ALEEnable* ALEEnable *ALEEnable*
ALEDisable *ALEDisable* ALEDisable *ALEDisable*
ALEToggleBuffer *ALEToggleBuffer*
ALEEnableBuffer *ALEEnableBuffer*
ALEDisableBuffer *ALEDisableBuffer*
Enable or disable ALE, including all of its autocmd events, loclist items, `ALEToggle`, `ALEEnable`, and `ALEDisable` enable or disable ALE linting,
quickfix items, signs, current jobs, etc. Executing any of those commands including all of its autocmd events, loclist items, quickfix items, signs,
will change the |g:ale_enabled| variable. current jobs, etc., globally. Executing any of these commands will change
the |g:ale_enabled| variable.
For convenience, a plug mapping `<Plug>(ale_toggle)` is defined for the ALE can be disabled or enabled for only a single buffer with
|ALEToggle| command. `ALEToggleBuffer`, `ALEEnableBuffer`, and `ALEDisableBuffer`. Disabling ALE
for a buffer will not remove autocmd events, but will prevent ALE from
checking for problems and reporting problems for whatever buffer the
`ALEDisableBuffer` or `ALEToggleBuffer` command is executed from. These
commands can be used for temporarily disabling ALE for a buffer. These
commands will modify the |b:ale_enabled| variable.
ALE linting cannot be enabled for a single buffer when it is disabled
globally, as disabling ALE globally removes the autocmd events needed to
perform linting with.
The following plug mappings are defined, for conveniently defining
keybinds:
|ALEToggle| - `<Plug>(ale_toggle)`
|ALEEnable| - `<Plug>(ale_enable)`
|ALEDisable| - `<Plug>(ale_disable)`
|ALEToggleBuffer| - `<Plug>(ale_toggle_buffer)`
|ALEEnableBuffer| - `<Plug>(ale_enable_buffer)`
|ALEDisableBuffer| - `<Plug>(ale_disable_buffer)`
ALEDetail *ALEDetail* ALEDetail *ALEDetail*

5
plugin/ale.vim
View File

@ -250,6 +250,11 @@ nnoremap <silent> <Plug>(ale_next_wrap) :ALENextWrap<Return>
nnoremap <silent> <Plug>(ale_first) :ALEFirst<Return> nnoremap <silent> <Plug>(ale_first) :ALEFirst<Return>
nnoremap <silent> <Plug>(ale_last) :ALELast<Return> nnoremap <silent> <Plug>(ale_last) :ALELast<Return>
nnoremap <silent> <Plug>(ale_toggle) :ALEToggle<Return> nnoremap <silent> <Plug>(ale_toggle) :ALEToggle<Return>
nnoremap <silent> <Plug>(ale_enable) :ALEEnable<Return>
nnoremap <silent> <Plug>(ale_disable) :ALEDisable<Return>
nnoremap <silent> <Plug>(ale_toggle_buffer) :ALEToggleBuffer<Return>
nnoremap <silent> <Plug>(ale_enable_buffer) :ALEEnableBuffer<Return>
nnoremap <silent> <Plug>(ale_disable_buffer) :ALEDisableBuffer<Return>
nnoremap <silent> <Plug>(ale_lint) :ALELint<Return> nnoremap <silent> <Plug>(ale_lint) :ALELint<Return>
nnoremap <silent> <Plug>(ale_detail) :ALEDetail<Return> nnoremap <silent> <Plug>(ale_detail) :ALEDetail<Return>
nnoremap <silent> <Plug>(ale_fix) :ALEFix<Return> nnoremap <silent> <Plug>(ale_fix) :ALEFix<Return>