Use ModeChanged events instead of InsertLeave emulation #4919 #4738
Some checks are pending
CI / build_image (push) Waiting to run
CI / test_ale (--linters-only) (push) Blocked by required conditions
CI / test_ale (--neovim-06-only) (push) Blocked by required conditions
CI / test_ale (--neovim-08-only) (push) Blocked by required conditions
CI / test_ale (--vim-80-only) (push) Blocked by required conditions
CI / test_ale (--vim-90-only) (push) Blocked by required conditions

`ModeChanged` looks like a more reliable way to detect an "exit insert mode" event and is a lot simpler (doesn't need a timer). Also, it can detect some other transitions like `\<C-o\>` in insert mode.
The `ModeChanged` event is available in:

* [Vim 8.2.3430](f1e8876fa2)
* [NeoVim 0.7.0](69bd1e4e36)

---------

Co-authored-by: Dmitry Zolotukhin <zlogic@gmail.com>
This commit is contained in:
w0rp
2025-03-10 21:28:20 +00:00
committed by GitHub
parent 3611c32d60
commit 0f71d4c494
3 changed files with 61 additions and 17 deletions

View File

@@ -94,11 +94,17 @@ Execute (All events should be set up when everything is on):
\ 'FileChangedShellPost * call ale#events#FileChangedEvent(str2nr(expand(''<abuf>'')))',
\ 'FileType * call ale#events#FileTypeEvent( str2nr(expand(''<abuf>'')), expand(''<amatch>''))',
\ ] + (
\ maparg("\<C-c>", 'i') isnot# '<Esc>'
\ ? ['InsertEnter * call ale#events#InsertEnterEvent(str2nr(expand(''<abuf>'')))']
\ maparg("\<C-c>", 'i') isnot# '<Esc>' && !exists('##ModeChanged')
\ ? [
\ 'InsertEnter * call ale#events#InsertEnterEvent(str2nr(expand(''<abuf>'')))',
\ 'InsertLeave * call ale#events#InsertLeaveEvent(str2nr(expand(''<abuf>'')))',
\ ]
\ : []
\ ) + (
\ exists('##ModeChanged')
\ ? ['ModeChanged i*:* call ale#events#InsertLeaveEvent(str2nr(expand(''<abuf>'')))']
\ : []
\ ) + [
\ 'InsertLeave * call ale#events#InsertLeaveEvent(str2nr(expand(''<abuf>'')))',
\ 'TextChanged * call ale#Queue(ale#Var(str2nr(expand(''<abuf>'')), ''lint_delay''))',
\ 'TextChangedI * call ale#Queue(ale#Var(str2nr(expand(''<abuf>'')), ''lint_delay''))',
\ ],
@@ -185,25 +191,40 @@ Execute (g:ale_lint_on_text_changed = 'insert' should bind only TextChangedI):
\ ],
\ filter(CheckAutocmd('ALEEvents'), 'v:val =~ ''^TextChanged''')
Execute (g:ale_lint_on_insert_leave = 1 should bind InsertLeave):
Execute (g:ale_lint_on_insert_leave = 1 should bind InsertLeave or ModeChanged if available):
let g:ale_lint_on_insert_leave = 1
let g:ale_echo_cursor = 0
" CI at least should run this check.
" There isn't an easy way to save an restore a mapping during running the test.
if maparg("\<C-c>", 'i') isnot# '<Esc>'
if maparg("\<C-c>", 'i') isnot# '<Esc>' && !exists('##ModeChanged')
AssertEqual
\ [
\ 'InsertEnter * call ale#events#InsertEnterEvent(str2nr(expand(''<abuf>'')))',
\ ],
\ filter(CheckAutocmd('ALEEvents'), 'v:val =~ ''^InsertEnter''')
else
" If the ModeChanged event is available, starting the timer in InsertEnter is not necessary.
AssertEqual
\ [
\ ],
\ filter(CheckAutocmd('ALEEvents'), 'v:val =~ ''^InsertEnter''')
endif
AssertEqual
\ [
\ 'InsertLeave * call ale#events#InsertLeaveEvent(str2nr(expand(''<abuf>'')))',
\ ],
\ filter(CheckAutocmd('ALEEvents'), 'v:val =~ ''^InsertLeave''')
if !exists('##ModeChanged')
" If the ModeChanged event is not available, bind InsertLeave.
AssertEqual
\ [
\ 'InsertLeave * call ale#events#InsertLeaveEvent(str2nr(expand(''<abuf>'')))',
\ ],
\ filter(CheckAutocmd('ALEEvents'), 'v:val =~ ''^InsertLeave''')
else
AssertEqual
\ [
\ 'ModeChanged i*:* call ale#events#InsertLeaveEvent(str2nr(expand(''<abuf>'')))',
\ ],
\ filter(CheckAutocmd('ALEEvents'), 'v:val =~ ''^ModeChanged''')
endif
Execute (g:ale_lint_on_filetype_changed = 1 should bind the FileType event):
let g:ale_lint_on_filetype_changed = 1

View File

@@ -158,9 +158,9 @@ Execute(The message at the cursor should be shown when linting ends):
AssertEqual 'semi: Missing semicolon.', g:last_message
Execute(The message at the cursor should be shown on InsertLeave):
Execute(The message at the cursor should be shown when leaving insert mode):
call cursor(2, 9)
doautocmd InsertLeave
call feedkeys("i\<Esc>", 'tnix')
AssertEqual 'space-infix-ops: Infix operators must be spaced.', g:last_message