Optionally fallback to goto_definition in lsp_symbol_definition (#1986)

Author: timfjord

Default.sublime-keymap

@@ -171,7 +171,8 @@
     // {
     //     "command": "lsp_symbol_definition",
     //     "args": {
-    //         "side_by_side": false
+    //         "side_by_side": false,
+    //         "fallback": false
     //     },
     //     "keys": [
     //         "f12"

docs/src/features.md

@@ -31,6 +31,9 @@ In addition to the basic "Goto Definition", the protocol also provides further r
 - Goto Declaration
 - Goto Implementation
 
+Additionally, the LSP's "Goto Definition" command can fall back to the built-in Sublime's "Goto Definition" if the `fallback` argument is set to `true`.
+This way, when there are no results found the built-in "Goto Definition" command will be triggered.
+
 ## Find References
 
 [Example GIF 1](https://user-images.githubusercontent.com/6579999/128551752-b37fe407-148c-41cf-b1e4-6fe96ed0f77c.gif)

plugin/goto.py

@@ -15,53 +15,74 @@
 class LspGotoCommand(LspTextCommand):
 
     method = ''
+    fallback_command = ''
 
-    def is_enabled(self, event: Optional[dict] = None, point: Optional[int] = None, side_by_side: bool = False) -> bool:
-        return super().is_enabled(event, point)
+    def is_enabled(
+        self,
+        event: Optional[dict] = None,
+        point: Optional[int] = None,
+        side_by_side: bool = False,
+        fallback: bool = False
+    ) -> bool:
+        return fallback or super().is_enabled(event, point)
 
     def run(
         self,
         _: sublime.Edit,
         event: Optional[dict] = None,
         point: Optional[int] = None,
-        side_by_side: bool = False
+        side_by_side: bool = False,
+        fallback: bool = False
     ) -> None:
         session = self.best_session(self.capability)
         position = get_position(self.view, event, point)
         if session and position is not None:
             params = text_document_position_params(self.view, position)
             request = Request(self.method, params, self.view, progress=True)
-            session.send_request(request, functools.partial(self._handle_response_async, session, side_by_side))
+            session.send_request(
+                request, functools.partial(self._handle_response_async, session, side_by_side, fallback)
+            )
+        else:
+            self._handle_no_results(fallback, side_by_side)
 
     def _handle_response_async(
         self,
         session: Session,
         side_by_side: bool,
+        fallback: bool,
         response: Union[None, Location, List[Location], List[LocationLink]]
     ) -> None:
         if isinstance(response, dict):
             self.view.run_command("add_jump_record", {"selection": [(r.a, r.b) for r in self.view.sel()]})
             open_location_async(session, response, side_by_side)
         elif isinstance(response, list):
             if len(response) == 0:
-                window = self.view.window()
-                if window:
-                    window.status_message("No results found")
+                self._handle_no_results(fallback, side_by_side)
             elif len(response) == 1:
                 self.view.run_command("add_jump_record", {"selection": [(r.a, r.b) for r in self.view.sel()]})
                 open_location_async(session, response[0], side_by_side)
             else:
                 self.view.run_command("add_jump_record", {"selection": [(r.a, r.b) for r in self.view.sel()]})
                 sublime.set_timeout(functools.partial(LocationPicker, self.view, session, response, side_by_side))
         else:
-            window = self.view.window()
-            if window:
-                window.status_message("No results found")
+            self._handle_no_results(fallback, side_by_side)
+
+    def _handle_no_results(self, fallback: bool = False, side_by_side: bool = False) -> None:
+        window = self.view.window()
+
+        if not window:
+            return
+
+        if fallback and self.fallback_command:
+            window.run_command(self.fallback_command, {"side_by_side": side_by_side})
+        else:
+            window.status_message("No results found")
 
 
 class LspSymbolDefinitionCommand(LspGotoCommand):
     method = "textDocument/definition"
     capability = method_to_capability(method)[0]
+    fallback_command = "goto_definition"
 
 
 class LspSymbolTypeDefinitionCommand(LspGotoCommand):