Add argument "include_declaration" to "lsp_symbol_references" (#2275)

sublimelsp · May 30, 2023 · 53c75bf · 53c75bf
1 parent 9ec8001
commit 53c75bf
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/Default.sublime-keymap b/Default.sublime-keymap
@@ -63,7 +63,7 @@
     {
         "keys": ["shift+f12"],
         "command": "lsp_symbol_references",
-        "args": {"side_by_side": false, "force_group": true, "fallback": false, "group": -1},
+        "args": {"side_by_side": false, "force_group": true, "fallback": false, "group": -1, "include_declaration": false},
         "context": [{"key": "lsp.session_with_capability", "operand": "referencesProvider"}]
     },
     // Find References (side-by-side)

diff --git a/docs/src/keyboard_shortcuts.md b/docs/src/keyboard_shortcuts.md
@@ -9,7 +9,7 @@ Refer to the [Customization section](customization.md#keyboard-shortcuts-key-bin
 | ------- | -------- | ------- |
 | Auto Complete | <kbd>ctrl</kbd> <kbd>space</kbd> (also on macOS) | `auto_complete`
 | Expand Selection | unbound | `lsp_expand_selection`
-| Find References | <kbd>shift</kbd> <kbd>f12</kbd> | `lsp_symbol_references`
+| Find References | <kbd>shift</kbd> <kbd>f12</kbd> | `lsp_symbol_references` (supports optional args: `{"include_declaration": true/false}`)
 | Follow Link | unbound | `lsp_open_link`
 | Format File | unbound | `lsp_format_document`
 | Format Selection | unbound | `lsp_format_document_range`

diff --git a/plugin/references.py b/plugin/references.py
@@ -30,7 +30,8 @@ def is_enabled(
         side_by_side: bool = False,
         force_group: bool = True,
         fallback: bool = False,
-        group: int = -1
+        group: int = -1,
+        include_declaration: bool = False
     ) -> bool:
         return fallback or super().is_enabled(event, point)
 
@@ -41,7 +42,8 @@ def is_visible(
         side_by_side: bool = False,
         force_group: bool = True,
         fallback: bool = False,
-        group: int = -1
+        group: int = -1,
+        include_declaration: bool = False
     ) -> bool:
         if self.applies_to_context_menu(event):
             return self.is_enabled(event, point, side_by_side, fallback)
@@ -55,7 +57,8 @@ def run(
         side_by_side: bool = False,
         force_group: bool = True,
         fallback: bool = False,
-        group: int = -1
+        group: int = -1,
+        include_declaration: bool = False
     ) -> None:
         session = self.best_session(self.capability)
         file_path = self.view.file_name()
@@ -65,7 +68,9 @@ def run(
             params = {
                 'textDocument': position_params['textDocument'],
                 'position': position_params['position'],
-                'context': {"includeDeclaration": False},
+                'context': {
+                    "includeDeclaration": include_declaration,
+                },
             }
             request = Request("textDocument/references", params, self.view, progress=True)
             word_range = self.view.word(pos)