Add new completion API

LSP.sublime-settings

@@ -62,13 +62,6 @@
   // or just after trigger characters only otherwise.
   "complete_all_chars": true,
 
-  // Controls which hints the completion panel displays
-  // "auto": completion details if available or kind otherwise
-  // "detail": completion details if available
-  // "kind": completion kind if available
-  // "none": completion item label only
-  "completion_hint_type": "auto",
-
   // Disable Sublime Text's explicit and word completion.
   "only_show_lsp_completions": false,
 

docs/features.md

@@ -72,7 +72,6 @@ Add these settings to your Sublime settings, Syntax-specific settings and/or in
 
 * `complete_all_chars` `true` *request completions for all characters, not just trigger characters*
 * `only_show_lsp_completions` `false` *disable sublime word completion and snippets from autocomplete lists*
-* `completion_hint_type` `"auto"` *override automatic completion hints with "detail", "kind" or "none"*
 * `show_references_in_quick_panel` `false` *show symbol references in Sublime's quick panel instead of the bottom panel*
 * `show_view_status` `true` *show permanent language server status in the status bar*
 * `auto_show_diagnostics_panel` `always` (`never`, `saved`) *open the diagnostics panel automatically if there are diagnostics*

plugin/core/completion.py

@@ -1,76 +1,61 @@
-from .protocol import CompletionItemKind, Range
-from .types import Settings
-from .logging import debug
+import sublime
 from .typing import Tuple, Optional, Dict, List, Union
 
 
-completion_item_kind_names = {v: k for k, v in CompletionItemKind.__dict__.items()}
-
-
-def get_completion_hint(item: dict, settings: Settings) -> Optional[str]:
-    # choose hint based on availability and user preference
-    hint = None
-    if settings.completion_hint_type == "auto":
-        hint = item.get("detail")
-        if not hint:
-            kind = item.get("kind")
-            if kind:
-                hint = completion_item_kind_names[kind]
-    elif settings.completion_hint_type == "detail":
-        hint = item.get("detail")
-    elif settings.completion_hint_type == "kind":
-        kind = item.get("kind")
-        if kind:
-            hint = completion_item_kind_names.get(kind)
-    return hint
-
-
-def format_completion(item: dict, word_col: int, settings: Settings) -> Tuple[str, str]:
-    # Sublime handles snippets automatically, so we don't have to care about insertTextFormat.
-    trigger = item["label"]
-
-    hint = get_completion_hint(item, settings)
-
-    # label is an alternative for insertText if neither textEdit nor insertText is provided
-    replacement = text_edit_text(item, word_col) or item.get("insertText") or trigger
-
-    if replacement[0] != trigger[0]:
-        # fix some common cases when server sends different start on label and replacement.
-        if replacement[0] == '$':
-            trigger = '$' + trigger  # add missing $
-        elif replacement[0] == '-':
-            trigger = '-' + trigger  # add missing -
-        elif trigger[0] == ':':
-            replacement = ':' + replacement  # add missing :
-        elif trigger[0] == '$':
-            trigger = trigger[1:]  # remove leading $
-        elif trigger[0] == ' ' or trigger[0] == '•':
-            trigger = trigger[1:]  # remove clangd insertion indicator
-        else:
-            debug("WARNING: Replacement prefix does not match trigger '{}'".format(trigger))
-
-    if len(replacement) > 0 and replacement[0] == '$':  # sublime needs leading '$' escaped.
-        replacement = '\\$' + replacement[1:]
-    # only return trigger with a hint if available
-    return "\t  ".join((trigger, hint)) if hint else trigger, replacement
-
-
-def text_edit_text(item: dict, word_col: int) -> Optional[str]:
-    text_edit = item.get('textEdit')
-    if text_edit:
-        edit_range, edit_text = text_edit.get("range"), text_edit.get("newText")
-        if edit_range and edit_text:
-            edit_range = Range.from_lsp(edit_range)
-
-            # debug('textEdit from col {}, {} applied at col {}'.format(
-            #     edit_range.start.col, edit_range.end.col, word_col))
-
-            if edit_range.start.col <= word_col:
-                # if edit starts at current word, we can use it.
-                # if edit starts before current word, use the whole thing and we'll fix it up later.
-                return edit_text
-
-    return None
+compleiton_kinds = {
+    1: (sublime.KIND_ID_MARKUP, "Ξ", "Text"),
+    2: (sublime.KIND_ID_FUNCTION, "λ", "Method"),
+    3: (sublime.KIND_ID_FUNCTION, "λ", "Function"),
+    4: (sublime.KIND_ID_FUNCTION, "c", "Constructor"),
+    5: (sublime.KIND_ID_VARIABLE, "f", "Field"),
+    6: (sublime.KIND_ID_VARIABLE, "v", "Variable"),
+    7: (sublime.KIND_ID_TYPE, "c", "Class"),
+    8: (sublime.KIND_ID_TYPE, "i", "Interface"),
+    9: (sublime.KIND_ID_NAMESPACE, "◪", "Module"),
+    10: (sublime.KIND_ID_VARIABLE, "ρ", "Property"),
+    11: (sublime.KIND_ID_VARIABLE, "u", "Unit"),
+    12: (sublime.KIND_ID_VARIABLE, "ν", "Value"),
+    13: (sublime.KIND_ID_TYPE, "ε", "Enum"),
+    14: (sublime.KIND_ID_KEYWORD, "κ", "Keyword"),
+    15: (sublime.KIND_ID_SNIPPET, "s", "Snippet"),
+    16: (sublime.KIND_ID_AMBIGUOUS, "c", "Color"),
+    17: (sublime.KIND_ID_AMBIGUOUS, "#", "File"),
+    18: (sublime.KIND_ID_AMBIGUOUS, "⇢", "Reference"),
+    19: (sublime.KIND_ID_AMBIGUOUS, "ƒ", "Folder"),
+    20: (sublime.KIND_ID_TYPE, "ε", "EnumMember"),
+    21: (sublime.KIND_ID_VARIABLE, "π", "Constant"),
+    22: (sublime.KIND_ID_TYPE, "s", "Struct"),
+    23: (sublime.KIND_ID_FUNCTION, "e", "Event"),
+    24: (sublime.KIND_ID_KEYWORD, "ο", "Operator"),
+    25: (sublime.KIND_ID_TYPE, "τ", "Type Parameter")
+}
+
+
+def format_completion(item: dict) -> sublime.CompletionItem:
+    trigger = item.get('label') or ""
+    annotation = item.get('detail') or ""
+    kind = sublime.KIND_AMBIGUOUS
+
+    item_kind = item.get("kind")
+    if item_kind:
+        kind = compleiton_kinds.get(item_kind, sublime.KIND_AMBIGUOUS)
+
+    is_deprecated = item.get("deprecated", False)
+    if is_deprecated:
+        list_kind = list(kind)
+        list_kind[1] = '⚠'
+        list_kind[2] = "⚠ {} - Deprecated".format(list_kind[2])
+        kind = tuple(list_kind)  # type: ignore
+
+    return sublime.CompletionItem.command_completion(
+        trigger,
+        command="lsp_select_completion_item",
+        args={
+            "item": item
+        },
+        annotation=annotation,
+        kind=kind
+    )
 
 
 def parse_completion_response(response: Optional[Union[Dict, List]]) -> Tuple[List[Dict], bool]:

plugin/core/protocol.py

@@ -79,6 +79,11 @@ class CompletionItemKind(object):
 completion_item_kinds = list(range(CompletionItemKind.Text, CompletionItemKind.TypeParameter + 1))
 
 
+class InsertTextFormat:
+    PlainText = 1
+    Snippet = 2
+
+
 class DocumentHighlightKind(object):
     Unknown = 0
     Text = 1

plugin/core/sessions.py

@@ -31,7 +31,8 @@ def get_initialize_params(workspace_folders: List[WorkspaceFolder], designated_f
                 },
                 "completion": {
                     "completionItem": {
-                        "snippetSupport": True
+                        "snippetSupport": True,
+                        "deprecatedSupport": True
                     },
                     "completionItemKind": {
                         "valueSet": completion_item_kinds

plugin/core/settings.py

@@ -76,7 +76,6 @@ def update_settings(settings: Settings, settings_obj: sublime.Settings) -> None:
     settings.show_symbol_action_links = read_bool_setting(settings_obj, "show_symbol_action_links", False)
     settings.only_show_lsp_completions = read_bool_setting(settings_obj, "only_show_lsp_completions", False)
     settings.complete_all_chars = read_bool_setting(settings_obj, "complete_all_chars", True)
-    settings.completion_hint_type = read_str_setting(settings_obj, "completion_hint_type", "auto")
     settings.show_references_in_quick_panel = read_bool_setting(settings_obj, "show_references_in_quick_panel", False)
     settings.disabled_capabilities = read_array_setting(settings_obj, "disabled_capabilities", [])
     settings.log_debug = read_bool_setting(settings_obj, "log_debug", False)

plugin/core/types.py

@@ -23,7 +23,6 @@ def __init__(self) -> None:
         self.show_code_actions_bulb = False
         self.show_symbol_action_links = False
         self.complete_all_chars = False
-        self.completion_hint_type = "auto"
         self.show_references_in_quick_panel = False
         self.disabled_capabilities = []  # type: List[str]
         self.log_debug = True

stubs/sublime.pyi

@@ -55,6 +55,7 @@ CLASS_LINE_END = ...  # type: int
 CLASS_EMPTY_LINE = ...  # type: int
 INHIBIT_WORD_COMPLETIONS = ...  # type: int
 INHIBIT_EXPLICIT_COMPLETIONS = ...  # type: int
+DYNAMIC_COMPLETIONS = ...  # type: int
 DIALOG_CANCEL = ...  # type: int
 DIALOG_YES = ...  # type: int
 DIALOG_NO = ...  # type: int
@@ -67,6 +68,24 @@ UI_ELEMENT_OPEN_FILES = ...  # type: int
 LAYOUT_INLINE = ...  # type: int
 LAYOUT_BELOW = ...  # type: int
 LAYOUT_BLOCK = ...  # type: int
+KIND_ID_AMBIGUOUS = ...  # type: int
+KIND_ID_KEYWORD = ...  # type: int
+KIND_ID_TYPE = ...  # type: int
+KIND_ID_FUNCTION = ...  # type: int
+KIND_ID_NAMESPACE = ...  # type: int
+KIND_ID_NAVIGATION = ...  # type: int
+KIND_ID_MARKUP = ...  # type: int
+KIND_ID_VARIABLE = ...  # type: int
+KIND_ID_SNIPPET = ...  # type: int
+KIND_AMBIGUOUS = ...  # type: Tuple[int, str, str]
+KIND_KEYWORD = ...  # type: Tuple[int, str, str]
+KIND_TYPE = ...  # type: Tuple[int, str, str]
+KIND_FUNCTION = ...  # type: Tuple[int, str, str]
+KIND_NAMESPACE = ...  # type: Tuple[int, str, str]
+KIND_NAVIGATION = ...  # type: Tuple[int, str, str]
+KIND_MARKUP = ...  # type: Tuple[int, str, str]
+KIND_VARIABLE = ...  # type: Tuple[int, str, str]
+KIND_SNIPPET = ...  # type: Tuple[int, str, str]
 
 
 class Settings:
@@ -238,6 +257,22 @@ def get_macro() -> Sequence[dict]:
     ...
 
 
+class CompletionItem:
+    @classmethod
+    def command_completion(cls,
+                           trigger: str,
+                           command: str,
+                           args: dict = {},
+                           annotation: str = "",
+                           kind: Tuple[int, str, str] = KIND_AMBIGUOUS
+                           ) -> 'CompletionItem':
+        ...
+
+class CompletionList:
+    def set_completions(self, completions: List[CompletionItem], flags: int = 0) -> None:
+        ...
+
+
 class Window:
     window_id = ...  # type: int
     settings_object = ...  # type: Settings
@@ -491,7 +526,7 @@ class Selection(Sized):
     def clear(self) -> None:
         ...
 
-    def add(self, x: Region) -> None:
+    def add(self, x: Union[Region, int]) -> None:
         ...
 
     def add_all(self, regions: Sequence[Region]) -> None:

tests/test_completion.py

@@ -1,5 +1,4 @@
 from LSP.plugin.completion import CompletionHandler
-from LSP.plugin.completion import CompletionState
 from LSP.plugin.core.registry import is_supported_view
 from setup import CI, SUPPORTED_SYNTAX, TextDocumentTestCase, add_config, remove_config, text_config
 from unittesting import DeferrableTestCase
@@ -181,7 +180,6 @@ def test_simple_label(self) -> 'Generator':
 
             # now wait for server response
             yield from self.await_message('textDocument/completion')
-            self.assertEquals(handler.state, CompletionState.IDLE)
             self.assertEquals(len(handler.completions), 2)
 
             # verify insertion works

tests/test_completion_core.py

@@ -2,7 +2,6 @@
 from os import path
 import json
 from LSP.plugin.core.completion import format_completion, parse_completion_response
-from LSP.plugin.core.types import Settings
 try:
     from typing import Optional, Dict
     assert Optional and Dict
@@ -19,9 +18,6 @@ def load_completion_sample(name: str) -> 'Dict':
 intelephense_completion_sample = load_completion_sample("intelephense_completion_sample")
 
 
-settings = Settings()
-
-
 class CompletionResponseParsingTests(unittest.TestCase):
 
     def test_no_response(self):
@@ -40,15 +36,13 @@ def test_incomplete_dict_response(self):
 class CompletionFormattingTests(unittest.TestCase):
 
     def test_only_label_item(self):
-        result = format_completion({"label": "asdf"}, 0, settings)
+        result = format_completion({"label": "asdf"})
         self.assertEqual(len(result), 2)
         self.assertEqual("asdf", result[0])
         self.assertEqual("asdf", result[1])
 
     def test_prefers_insert_text(self):
-        result = format_completion(
-            {"label": "asdf", "insertText": "Asdf"},
-            0, settings)
+        result = format_completion({"label": "asdf", "insertText": "Asdf"})
         self.assertEqual(len(result), 2)
         self.assertEqual("asdf", result[0])
         self.assertEqual("Asdf", result[1])
@@ -68,7 +62,7 @@ def test_ignores_text_edit(self):
             }
         }
 
-        result = format_completion(item, 0, settings)
+        result = format_completion(item)
         self.assertEqual(len(result), 2)
         self.assertEqual("$true", result[0])
         self.assertEqual("\\$true", result[1])
@@ -93,12 +87,12 @@ def test_use_label_as_is(self):
             }
         }
         last_col = 1
-        result = format_completion(item, last_col, settings)
+        result = format_completion(item)
         self.assertEqual(result, ('const\t  Keyword', 'const'))
 
     def test_text_edit_intelephense(self):
         last_col = 1
-        result = [format_completion(item, last_col, settings) for item in intelephense_completion_sample]
+        result = [format_completion(item) for item in intelephense_completion_sample]
         self.assertEqual(
             result,
             [
@@ -125,7 +119,7 @@ def test_text_edit_clangd(self):
         # handler.last_location = 1
         # handler.last_prefix = ""
         last_col = 1
-        result = [format_completion(item, last_col, settings) for item in clangd_completion_sample]
+        result = [format_completion(item) for item in clangd_completion_sample]
         # We should prefer textEdit over insertText. This test covers that.
         self.assertEqual(
             result, [('argc\t  int', 'argc'), ('argv\t  const char **', 'argv'),
@@ -150,7 +144,7 @@ def test_text_edit_clangd(self):
 
     def test_missing_text_edit_but_we_do_have_insert_text_for_pyls(self):
         last_col = 1
-        result = [format_completion(item, last_col, settings) for item in pyls_completion_sample]
+        result = [format_completion(item) for item in pyls_completion_sample]
         self.assertEqual(
             result,
             [