Merge pull request #487 from krassowski/completer-improvements

Completer improvements: kernel type mapping and dynamic documentation

Author: krassowski

CHANGELOG.md

@@ -1,6 +1,11 @@
 ## CHANGELOG
 
-### `@krassowski/jupyterlab-lsp 3.1.1` (unreleased)
+### `@krassowski/jupyterlab-lsp 3.2.0` (unreleased)
+
+- features:
+
+  - documentation panel in completer now works for R language too: implemented `completionItem/resolve` ([#487])
+  - kernel types returned by IPython and IJulia are now mapped to LSP types; you can customize the mappings in settings ([#487])
 
 - bug fixes:
 
@@ -14,6 +19,7 @@
   - `PythonModuleSpec` no longer raises exception when the server module does not exist ([#485])
 
 [#485]: https://github.com/krassowski/jupyterlab-lsp/pull/485
+[#487]: https://github.com/krassowski/jupyterlab-lsp/pull/487
 
 ### `@krassowski/jupyterlab-lsp 3.1.0` (2021-01-17)
 

atest/05_Features/Completion.robot

@@ -7,6 +7,7 @@ Resource          ../Keywords.robot
 
 *** Variables ***
 ${COMPLETER_BOX}    css:.jp-Completer.jp-HoverBox
+${DOCUMENTATION_PANEL}    css:.jp-Completer-docpanel
 
 *** Test Cases ***
 Works With Kernel Running
@@ -227,6 +228,15 @@ Completes Large Namespaces
     Completer Should Suggest    abs    timeout=30s
     [Teardown]    Clean Up After Working With File    completion.R
 
+Shows Documentation With CompletionItem Resolve
+    [Setup]    Prepare File for Editing    R    completion    completion.R
+    Place Cursor In File Editor At    8    12
+    Wait Until Fully Initialized
+    Trigger Completer
+    Completer Should Suggest    print.default
+    Completer Should Include Documentation    the default method of the
+    [Teardown]    Clean Up After Working With File    completion.R
+
 *** Keywords ***
 Setup Completion Test
     Setup Notebook    Python    Completion.ipynb
@@ -275,3 +285,8 @@ Trigger Completer
     [Arguments]    ${timeout}=35s
     Press Keys    None    TAB
     Wait Until Page Contains Element    ${COMPLETER_BOX}    timeout=${timeout}
+
+Completer Should Include Documentation
+    [Arguments]    ${text}
+    Wait Until Page Contains Element    ${DOCUMENTATION_PANEL}    timeout=10s
+    Element Should Contain    ${DOCUMENTATION_PANEL}    ${text}

atest/examples/completion.R

@@ -4,3 +4,5 @@ tools::
 datasets:::
 # `base:::<tab>` → works
 base:::
+# `print.defaul<tab>` → shows documentation for `print.default`
+print.defaul

packages/completion-theme/src/index.ts

@@ -12,7 +12,8 @@ import {
   ILSPCompletionThemeManager,
   PLUGIN_ID,
   COMPLETER_THEME_PREFIX,
-  KernelKind
+  KernelKind,
+  CompletionItemKindStrings
 } from './types';
 import { render_themes_list } from './about';
 import '../style/index.css';
@@ -22,10 +23,12 @@ export class CompletionThemeManager implements ILSPCompletionThemeManager {
   protected themes: Map<string, ICompletionTheme>;
   private current_theme_id: string;
   private icons_cache: Map<string, LabIcon>;
+  private icon_overrides: Record<string, CompletionItemKindStrings>;
 
   constructor(protected themeManager: IThemeManager) {
     this.themes = new Map();
     this.icons_cache = new Map();
+    this.icon_overrides = {};
     themeManager.themeChanged.connect(this.update_icons_set, this);
   }
 
@@ -78,12 +81,16 @@ export class CompletionThemeManager implements ILSPCompletionThemeManager {
     }
     let options = this.current_theme.icons.options || {};
     if (type) {
+      if (type in this.icon_overrides) {
+        type = this.icon_overrides[type];
+      }
       type =
         type.substring(0, 1).toUpperCase() + type.substring(1).toLowerCase();
     }
     if (this.current_icons.has(type)) {
       return this.current_icons.get(type).bindprops(options);
     }
+
     if (type === KernelKind) {
       return kernelIcon;
     }
@@ -144,6 +151,12 @@ export class CompletionThemeManager implements ILSPCompletionThemeManager {
       buttons: [Dialog.okButton()]
     }).catch(console.warn);
   }
+
+  set_icons_overrides(
+    iconOverrides: Record<string, CompletionItemKindStrings>
+  ) {
+    this.icon_overrides = iconOverrides;
+  }
 }
 
 const LSP_CATEGORY = 'Language server protocol';

packages/completion-theme/src/types.ts

@@ -116,6 +116,10 @@ export interface ILSPCompletionThemeManager {
   get_iconset(
     theme: ICompletionTheme
   ): Map<keyof ICompletionIconSet, LabIcon.ILabIcon>;
+
+  set_icons_overrides(
+    map: Record<string, CompletionItemKindStrings | 'Kernel'>
+  ): void;
 }
 
 export const ILSPCompletionThemeManager = new Token<ILSPCompletionThemeManager>(

packages/completion-theme/style/index.css

@@ -23,3 +23,8 @@
 .jp-Completer-docpanel {
   overflow: auto;
 }
+
+.lsp-completer-placeholder:after {
+  content: 'Loading...';
+  color: #7f7f7f;
+}

packages/jupyterlab-lsp/schema/completion.json

@@ -31,6 +31,54 @@
       "type": ["string", "null"],
       "default": "vscode",
       "description": "The identifier of a completer theme with icons which indicate the kind of completion. Set to null to disable icons."
+    },
+    "typesMap": {
+      "title": "Mapping of custom kernel types to valid completion kind names",
+      "description": "Mapping used for icon selection. Accepted values are the names of CompletionItemKind and 'Kernel' literal. The defaults aim to provide good initial experience for Julia, Python and R kernels.",
+      "type": "object",
+      "default": {
+        "<unknown>": "Kernel",
+        "instance": "Value",
+        "path": "File",
+        "param": "Variable",
+        "missing": "Constant",
+        "nothing": "Constant",
+        "undefinitializer": "Constant",
+        "base.devnull": "Constant"
+      },
+      "patternProperties": {
+        "^.*$": {
+          "type": "string",
+          "enum": [
+            "Kernel",
+            "Text",
+            "Method",
+            "Function",
+            "Constructor",
+            "Field",
+            "Variable",
+            "Class",
+            "Interface",
+            "Module",
+            "Property",
+            "Unit",
+            "Value",
+            "Enum",
+            "Keyword",
+            "Snippet",
+            "Color",
+            "File",
+            "Reference",
+            "Folder",
+            "EnumMember",
+            "Constant",
+            "Struct",
+            "Event",
+            "Operator",
+            "TypeParameter"
+          ]
+        }
+      }
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/src/connection.ts

@@ -4,10 +4,10 @@
 // Introduced modifications are BSD licenced, copyright JupyterLab development team.
 import * as lsProtocol from 'vscode-languageserver-protocol';
 import {
+  IDocumentInfo,
   ILspOptions,
   IPosition,
-  LspWsConnection,
-  IDocumentInfo
+  LspWsConnection
 } from 'lsp-ws-connection';
 import { until_ready } from './utils';
 
@@ -138,4 +138,21 @@ export class LSPConnection extends LspWsConnection {
     );
     documentInfo.version++;
   }
+
+  async getCompletionResolve(completionItem: lsProtocol.CompletionItem) {
+    if (!this.isReady || !this.isCompletionResolveProvider()) {
+      return;
+    }
+    return this.connection.sendRequest<lsProtocol.CompletionItem>(
+      'completionItem/resolve',
+      completionItem
+    );
+  }
+
+  /**
+   * Does support completionItem/resolve?.
+   */
+  public isCompletionResolveProvider(): boolean {
+    return this.serverCapabilities?.completionProvider?.resolveProvider;
+  }
 }