Don't expose disabled code actions

Author: rchl

plugin/code_actions.py

@@ -56,9 +56,12 @@ def create_collector(self, config_name: str) -> Callable[[CodeActionsResponse],
 
     def _collect_response(self, config_name: str, actions: CodeActionsResponse) -> None:
         self._response_count += 1
-        self._commands_by_config[config_name] = actions or []
+        self._commands_by_config[config_name] = self._get_enabled_actions(actions or [])
         self._notify_if_all_finished()
 
+    def _get_enabled_actions(self, actions: List[CodeActionOrCommand]) -> List[CodeActionOrCommand]:
+        return [action for action in actions if not action.get('disabled')]
+
     def _notify_if_all_finished(self) -> None:
         if self._all_requested and self._request_count == self._response_count:
             # Call back on Sublime's async thread

plugin/core/protocol.py

@@ -164,11 +164,17 @@ class SemanticTokenModifiers:
 }, total=True)
 
 
+CodeActionDisabledInformation = TypedDict('CodeActionDisabledInformation', {
+    'reason': str
+}, total=True)
+
+
 CodeAction = TypedDict('CodeAction', {
     'title': str,
     'kind': Optional[str],
     'diagnostics': Optional[List[Any]],
     'isPreferred': Optional[bool],
+    'disabled': Optional[CodeActionDisabledInformation],
     'edit': Optional[dict],
     'command': Optional[Command],
 }, total=True)

plugin/core/sessions.py

@@ -317,6 +317,7 @@ def get_initialize_params(variables: Dict[str, str], workspace_folders: List[Wor
                 }
             },
             "dataSupport": True,
+            "disabledSupport": True,
             "resolveSupport": {
                 "properties": [
                     "edit"

tests/test_code_actions.py

@@ -59,6 +59,17 @@ def create_test_code_action2(command_name: str, command_args: Optional[List[Any]
     return action
 
 
+def create_disabled_code_action(view: sublime.View, version: int, edits: List[Tuple[str, Range]]) -> Dict[str, Any]:
+    action = {
+        "title": "Fix errors",
+        "edit": create_code_action_edit(view, version, edits),
+        "disabled": {
+            "reason": "Do not use"
+        },
+    }
+    return action
+
+
 def create_test_diagnostics(diagnostics: List[Tuple[str, Range]]) -> Dict:
     def diagnostic_to_lsp(diagnostic: Tuple[str, Range]) -> Dict:
         message, range = diagnostic
@@ -299,6 +310,22 @@ def test_requests_with_no_diagnostics(self) -> Generator:
         self.assertEquals(annotations_range[0].a, 3)
         self.assertEquals(annotations_range[0].b, 0)
 
+    def test_excludes_disabled_code_actions(self) -> Generator:
+        initial_content = 'a\n'
+        self.insert_characters(initial_content)
+        yield from self.await_message("textDocument/didChange")
+        code_action = create_disabled_code_action(
+            self.view,
+            self.view.change_count(),
+            [(';', Range(Point(0, 0), Point(0, 1)))]
+        )
+        self.set_response('textDocument/codeAction', [code_action])
+        self.view.run_command('lsp_selection_set', {"regions": [(0, 1)]})  # Select a
+        yield 100
+        yield from self.await_message('textDocument/codeAction')
+        code_action_ranges = self.view.get_regions(SessionView.CODE_ACTIONS_KEY)
+        self.assertEquals(len(code_action_ranges), 0)
+
     def test_extends_range_to_include_diagnostics(self) -> Generator:
         self.insert_characters('x diagnostic')
         yield from self.await_message("textDocument/didChange")