Close #3333 - Add an ALECompletePost event

Add an `ALECompletePost` event along with everything needed to make it useful for its primary purpose: fixing code after inserting completions. * `ALEFix` can now be called with a bang (`!`) to suppress errors. * A new `ALELintStop` command lets you stop linting, and start it later.
2025-12-06 12:44:23 +08:00 · 2020-09-08 21:40:10 +01:00
parent b4b75126f9
commit 7d90ff56d9
12 changed files with 273 additions and 92 deletions
--- a/test/completion/test_complete_events.vader
+++ b/test/completion/test_complete_events.vader
@@ -0,0 +1,35 @@
+Before:
+  let g:complete_post_triggered = 0
+
+  augroup VaderTest
+    autocmd!
+    autocmd User ALECompletePost let g:complete_post_triggered = 1
+  augroup END
+
+After:
+  unlet! b:ale_completion_info
+  unlet! g:complete_post_triggered
+
+  augroup VaderTest
+    autocmd!
+  augroup END
+
+  augroup! VaderTest
+
+Execute(ALECompletePost should not be triggered when completion is cancelled):
+  call ale#completion#HandleUserData({})
+
+  Assert !g:complete_post_triggered
+
+Execute(ALECompletePost should not be triggered when tools other than ALE insert completions):
+  call ale#completion#HandleUserData({'user_data': ''})
+  call ale#completion#HandleUserData({'user_data': '{}'})
+
+  Assert !g:complete_post_triggered
+
+Execute(ALECompletePost should be triggered when ALE inserts completions):
+  call ale#completion#HandleUserData({
+  \ 'user_data': json_encode({'_ale_completion_item': 1}),
+  \})
+
+  Assert g:complete_post_triggered
--- a/test/completion/test_completion_events.vader
+++ b/test/completion/test_completion_events.vader
@@ -407,41 +407,75 @@ Execute(HandleUserData should call ale#code_action#HandleCodeAction):
  AssertEqual g:handle_code_action_called, 0

  call ale#completion#HandleUserData({
-  \  'user_data': ''
+  \ 'user_data': ''
  \})
  AssertEqual g:handle_code_action_called, 0

  call ale#completion#HandleUserData({
-  \  'user_data': '{}'
+  \ 'user_data': json_encode({}),
  \})
  AssertEqual g:handle_code_action_called, 0

  call ale#completion#HandleUserData({
-  \  'user_data': '{"codeActions": []}'
+  \ 'user_data': json_encode({
+  \   '_ale_completion_item': 1,
+  \   'code_actions': [],
+  \ }),
  \})
  AssertEqual g:handle_code_action_called, 0

  call ale#completion#HandleUserData({
-  \  'user_data': '{"codeActions": [{"description":"", "changes": []}]}'
+  \ 'user_data': json_encode({
+  \   '_ale_completion_item': 1,
+  \   'code_actions': [
+  \     {'description': '', 'changes': []},
+  \   ],
+  \ }),
  \})
  AssertEqual g:handle_code_action_called, 1

  let b:ale_completion_info = {'source': 'ale-automatic'}
  call ale#completion#HandleUserData({
-  \  'user_data': '{"codeActions": [{"description":"", "changes": []}]}'
+  \ 'user_data': json_encode({
+  \   '_ale_completion_item': 1,
+  \   'code_actions': [
+  \     {'description': '', 'changes': []},
+  \   ],
+  \ }),
  \})
  AssertEqual g:handle_code_action_called, 2

  let b:ale_completion_info = {'source': 'ale-callback'}
  call ale#completion#HandleUserData({
-  \  'user_data': '{"codeActions": [{"description":"", "changes": []}]}'
+  \ 'user_data': json_encode({
+  \   '_ale_completion_item': 1,
+  \   'code_actions': [
+  \     {'description': '', 'changes': []},
+  \   ],
+  \ }),
  \})
  AssertEqual g:handle_code_action_called, 3

+  let b:ale_completion_info = {'source': 'ale-omnifunc'}
+  call ale#completion#HandleUserData({
+  \ 'user_data': json_encode({
+  \   '_ale_completion_item': 1,
+  \   'code_actions': [
+  \     {'description': '', 'changes': []},
+  \   ],
+  \ }),
+  \})
+  AssertEqual g:handle_code_action_called, 4
+
 Execute(ale#code_action#HandleCodeAction should not be called when when source is not ALE):
  call MockHandleCodeAction()
  let b:ale_completion_info = {'source': 'syntastic'}
  call ale#completion#HandleUserData({
-  \  'user_data': '{"codeActions": [{"description":"", "changes": []}]}'
+  \ 'user_data': json_encode({
+  \   '_ale_completion_item': 1,
+  \   'code_actions': [
+  \     {'description': '', 'changes': []},
+  \   ],
+  \ }),
  \})
  AssertEqual g:handle_code_action_called, 0
--- a/test/completion/test_lsp_completion_parsing.vader
+++ b/test/completion/test_lsp_completion_parsing.vader
@@ -12,34 +12,34 @@ After:
 Execute(Should handle Rust completion results correctly):
  AssertEqual
  \ [
-  \   {'word': 'new', 'menu': 'pub fn new() -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'with_capacity', 'menu': 'pub fn with_capacity(capacity: usize) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_utf8', 'menu': 'pub fn from_utf8(vec: Vec<u8>) -> Result<String, FromUtf8Error>', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_utf8_lossy', 'menu': 'pub fn from_utf8_lossy<''a>(v: &''a [u8]) -> Cow<''a, str>', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_utf16', 'menu': 'pub fn from_utf16(v: &[u16]) -> Result<String, FromUtf16Error>', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_utf16_lossy', 'menu': 'pub fn from_utf16_lossy(v: &[u16]) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_raw_parts', 'menu': 'pub unsafe fn from_raw_parts(buf: *mut u8, length: usize, capacity: usize) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_utf8_unchecked', 'menu': 'pub unsafe fn from_utf8_unchecked(bytes: Vec<u8>) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = &''a char>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = &''a str>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = Cow<''a, str>>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'Searcher', 'menu': 'type Searcher = <&''b str as Pattern<''a>>::Searcher;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'default', 'menu': 'fn default() -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = String;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Target', 'menu': 'type Target = str;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'Err', 'menu': 'type Err = ParseError;', 'info': '', 'kind': 't', 'icase': 1},
-  \   {'word': 'from_str', 'menu': 'fn from_str(s: &str) -> Result<String, ParseError>', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from', 'menu': 'fn from(s: &''a str) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from', 'menu': 'fn from(s: Box<str>) -> String', 'info': '', 'kind': 'f', 'icase': 1},
-  \   {'word': 'from', 'menu': 'fn from(s: Cow<''a, str>) -> String', 'info': '', 'kind': 'f', 'icase': 1},
+  \   {'word': 'new', 'menu': 'pub fn new() -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'with_capacity', 'menu': 'pub fn with_capacity(capacity: usize) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_utf8', 'menu': 'pub fn from_utf8(vec: Vec<u8>) -> Result<String, FromUtf8Error>', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_utf8_lossy', 'menu': 'pub fn from_utf8_lossy<''a>(v: &''a [u8]) -> Cow<''a, str>', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_utf16', 'menu': 'pub fn from_utf16(v: &[u16]) -> Result<String, FromUtf16Error>', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_utf16_lossy', 'menu': 'pub fn from_utf16_lossy(v: &[u16]) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_raw_parts', 'menu': 'pub unsafe fn from_raw_parts(buf: *mut u8, length: usize, capacity: usize) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_utf8_unchecked', 'menu': 'pub unsafe fn from_utf8_unchecked(bytes: Vec<u8>) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = &''a char>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = &''a str>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_iter', 'menu': 'fn from_iter<I: IntoIterator<Item = Cow<''a, str>>>(iter: I) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Searcher', 'menu': 'type Searcher = <&''b str as Pattern<''a>>::Searcher;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'default', 'menu': 'fn default() -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = String;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Output', 'menu': 'type Output = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Target', 'menu': 'type Target = str;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'Err', 'menu': 'type Err = ParseError;', 'info': '', 'kind': 't', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from_str', 'menu': 'fn from_str(s: &str) -> Result<String, ParseError>', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from', 'menu': 'fn from(s: &''a str) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from', 'menu': 'fn from(s: Box<str>) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'from', 'menu': 'fn from(s: Cow<''a, str>) -> String', 'info': '', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \],
  \ ale#completion#ParseLSPCompletions({
  \   "jsonrpc":"2.0",
@@ -195,7 +195,7 @@ Execute(Should handle Python completion results correctly):

  AssertEqual
  \ [
-  \ {'word': 'what', 'menu': 'example-python-project.bar.Bar', 'info': "what()\n\n", 'kind': 'f', 'icase': 1},
+  \   {'word': 'what', 'menu': 'example-python-project.bar.Bar', 'info': "what()\n\n", 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \ ],
  \ ale#completion#ParseLSPCompletions({
  \    "jsonrpc":"2.0",
@@ -399,7 +399,7 @@ Execute(Should handle Python completion results correctly):
  \    }
  \ })

-Execute(Should handle Python completion results correctly):
+Execute(Should handle extra Python completion results correctly):
  let b:ale_completion_info = {
  \ 'completion_filter': 'ale#completion#python#CompletionItemFilter',
  \ 'prefix': 'mig',
@@ -407,8 +407,8 @@ Execute(Should handle Python completion results correctly):

  AssertEqual
  \ [
-  \   {'word': 'migrations', 'menu': 'xxx', 'info': 'migrations', 'kind': 'f', 'icase': 1},
-  \   {'word': 'MigEngine', 'menu': 'xxx', 'info': 'mig engine', 'kind': 'f', 'icase': 1},
+  \   {'word': 'migrations', 'menu': 'xxx', 'info': 'migrations', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
+  \   {'word': 'MigEngine', 'menu': 'xxx', 'info': 'mig engine', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \ ],
  \ ale#completion#ParseLSPCompletions({
  \   'jsonrpc': '2.0',
@@ -441,7 +441,7 @@ Execute(Should handle Python completion results correctly):
 Execute(Should handle missing keys):
  AssertEqual
  \ [
-  \   {'word': 'x', 'menu': '', 'info': '', 'kind': 'v', 'icase': 1},
+  \   {'word': 'x', 'menu': '', 'info': '', 'kind': 'v', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \ ],
  \ ale#completion#ParseLSPCompletions({
  \   'jsonrpc': '2.0',
@@ -459,7 +459,7 @@ Execute(Should handle missing keys):
 Execute(Should handle documentation in the markdown format):
  AssertEqual
  \ [
-  \   {'word': 'migrations', 'menu': 'xxx', 'info': 'Markdown documentation', 'kind': 'f', 'icase': 1},
+  \   {'word': 'migrations', 'menu': 'xxx', 'info': 'Markdown documentation', 'kind': 'f', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \ ],
  \ ale#completion#ParseLSPCompletions({
  \   'jsonrpc': '2.0',
@@ -483,7 +483,7 @@ Execute(Should handle documentation in the markdown format):
 Execute(Should handle completion messages with textEdit objects):
  AssertEqual
  \ [
-  \   {'word': 'next_callback', 'menu': 'PlayTimeCallback', 'info': '', 'kind': 'v', 'icase': 1},
+  \   {'word': 'next_callback', 'menu': 'PlayTimeCallback', 'info': '', 'kind': 'v', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \ ],
  \ ale#completion#ParseLSPCompletions({
  \   'id': 226,
@@ -514,7 +514,7 @@ Execute(Should handle completion messages with textEdit objects):
 Execute(Should handle completion messages with the deprecated insertText attribute):
  AssertEqual
  \ [
-  \   {'word': 'next_callback', 'menu': 'PlayTimeCallback', 'info': '', 'kind': 'v', 'icase': 1},
+  \   {'word': 'next_callback', 'menu': 'PlayTimeCallback', 'info': '', 'kind': 'v', 'icase': 1, 'user_data': json_encode({'_ale_completion_item': 1})},
  \ ],
  \ ale#completion#ParseLSPCompletions({
  \   'id': 226,
@@ -547,7 +547,8 @@ Execute(Should handle completion messages with additionalTextEdits when ale_comp
  \     'kind': 'v',
  \     'icase': 1,
  \     'user_data': json_encode({
-  \       'codeActions': [
+  \       '_ale_completion_item': 1,
+  \       'code_actions': [
  \         {
  \           'description': 'completion',
  \           'changes': [
@@ -658,6 +659,7 @@ Execute(Should still handle completion messages with empty additionalTextEdits w
  \     'info': '',
  \     'kind': 'v',
  \     'icase': 1,
+  \     'user_data': json_encode({'_ale_completion_item': 1}),
  \   }
  \ ],
  \ ale#completion#ParseLSPCompletions({
--- a/test/completion/test_tsserver_completion_parsing.vader
+++ b/test/completion/test_tsserver_completion_parsing.vader
@@ -90,6 +90,7 @@ Execute(TypeScript completion details responses should be parsed correctly):
  \     'info': '',
  \     'kind': 'v',
  \     'icase': 1,
+  \     'user_data': json_encode({'_ale_completion_item': 1}),
  \     'dup': g:ale_completion_autoimport,
  \   },
  \   {
@@ -98,6 +99,7 @@ Execute(TypeScript completion details responses should be parsed correctly):
  \     'info': 'foo bar baz',
  \     'kind': 'v',
  \     'icase': 1,
+  \     'user_data': json_encode({'_ale_completion_item': 1}),
  \     'dup': g:ale_completion_autoimport,
  \   },
  \   {
@@ -106,6 +108,7 @@ Execute(TypeScript completion details responses should be parsed correctly):
  \     'info': '',
  \     'kind': 'v',
  \     'icase': 1,
+  \     'user_data': json_encode({'_ale_completion_item': 1}),
  \     'dup': g:ale_completion_autoimport,
  \   },
  \ ],
@@ -179,7 +182,8 @@ Execute(Entries without details should be included in the responses):
  \     'kind': 'v',
  \     'icase': 1,
  \     'user_data': json_encode({
-  \         'codeActions': [{
+  \         '_ale_completion_item': 1,
+  \         'code_actions': [{
  \             'description': 'import { def } from "./Foo";',
  \             'changes': [],
  \         }],
@@ -192,6 +196,7 @@ Execute(Entries without details should be included in the responses):
  \     'info': 'foo bar baz',
  \     'kind': 'v',
  \     'icase': 1,
+  \     'user_data': json_encode({'_ale_completion_item': 1}),
  \     'dup': g:ale_completion_autoimport,
  \   },
  \   {
@@ -199,6 +204,7 @@ Execute(Entries without details should be included in the responses):
  \     'menu': '',
  \     'info': '',
  \     'kind': 'v',
+  \     'user_data': json_encode({'_ale_completion_item': 1}),
  \     'icase': 1,
  \   },
  \ ],
@@ -260,7 +266,8 @@ Execute(Default imports should be handled correctly):
  \     'kind': 't',
  \     'icase': 1,
  \     'user_data': json_encode({
-  \         'codeActions': [{
+  \         '_ale_completion_item': 1,
+  \         'code_actions': [{
  \             'description': 'Import default ''abcd'' from module "./foo"',
  \             'changes': [],
  \         }],