Add completion settings (Hinterland mode, documentation, suppression)

Author: krassowski

packages/jupyterlab-lsp/schema/plugin.json

@@ -1,12 +1,55 @@
 {
+  "jupyter.lab.setting-icon": "lsp:diagnostics",
+  "jupyter.lab.setting-icon-label": "Language integration",
   "title": "Language Server",
   "description": "Language Server Protocol settings.",
   "type": "object",
+  "definitions": {
+    "language-server": {
+      "title": "Language Server",
+      "description": "Client and server configurations for a single language server",
+      "type": "object",
+      "default": {},
+      "properties": {
+        "serverSettings": {
+          "title": "Language Server Configurations",
+          "description": "Configuration to be sent to language server over LSP when initialized: see the specific language server's documentation for more",
+          "type": "object",
+          "default": {}
+        }
+      }
+    },
+    "features": {
+      "title": "Code Intelligence Features Configuration",
+      "description": "Configuration for the implementation of the LSP features",
+      "type": "object",
+      "properties": {
+        "completion": {
+          "type": "object",
+          "properties": {
+            "showDocumentation": {
+              "type": "boolean",
+              "default": true
+            },
+            "continuousHinting": {
+              "type": "boolean",
+              "default": false
+            },
+            "suppressInvokeIn": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
   "properties": {
     "language_servers": {
       "title": "Language Server",
       "description": "Language-server specific configuration, keyed by implementation, e.g: \n\npyls: {\n  serverSettings: {\n    pyls: {\n      plugins: {\n        pydocstyle: {\n          enabled: true\n        },\n        pyflakes: {\n          enabled: false\n        },\n        flake8: {\n          enabled: true\n        }\n      }\n    }\n  }\n}\n\nAlternatively, using VSCode's naming convention:\n\npyls: {\n  serverSettings: {\n    \"pyls.plugins.pydocstyle.enabled\": true,\n    \"pyls.plugins.pyflakes.enabled\": false,\n    \"pyls.plugins.flake8.enabled\": true\n  }\n}",
-      "type": "object",
       "default": {},
       "patternProperties": {
         ".*": {
@@ -16,20 +59,16 @@
       "additionalProperties": {
         "$ref": "#/definitions/language-server"
       }
-    }
-  },
-  "definitions": {
-    "language-server": {
-      "title": "Language Server",
-      "description": "Client and server configurations for a single language server",
-      "type": "object",
-      "default": {},
-      "properties": {
-        "serverSettings": {
-          "title": "Language Server Configurations",
-          "description": "Configuration to be sent to language server over LSP when initialized: see the specific language server's documentation for more",
-          "type": "object",
-          "default": {}
+    },
+    "features": {
+      "title": "LSP features",
+      "description": "Client-side features configuration",
+      "$ref": "#/definitions/features",
+      "default": {
+        "completion": {
+          "showDocumentation": true,
+          "continuousHinting": false,
+          "suppressInvokeIn": ["comment", "string"]
         }
       }
     }

packages/jupyterlab-lsp/src/adapters/codemirror/cm_adapter.spec.ts

@@ -7,9 +7,17 @@ import {
 } from '../jupyterlab/jl_adapter';
 import { IRootPosition } from '../../positioning';
 import * as CodeMirror from 'codemirror';
-import { CodeMirrorLSPFeature } from './feature';
+import { CodeMirrorLSPFeature, IFeatureSettings } from './feature';
 import { FileEditorFeatureTestEnvironment } from './testutils';
 
+export class DummySettings implements IFeatureSettings {
+  get(setting: string): any {
+  }
+
+  set(setting: string, value: any): void {
+  }
+}
+
 describe('CodeMirrorAdapter', () => {
   let env: FileEditorFeatureTestEnvironment;
 
@@ -46,7 +54,8 @@ describe('CodeMirrorAdapter', () => {
         virtual_editor.virtual_document,
         connection,
         dummy_components_manager,
-        new StatusMessage()
+        new StatusMessage(),
+        new DummySettings()
       );
 
       let adapter = new CodeMirrorAdapter(

packages/jupyterlab-lsp/src/adapters/codemirror/feature.spec.ts

@@ -22,6 +22,7 @@ import { language_specific_overrides } from '../../magics/defaults';
 import { foreign_code_extractors } from '../../extractors/defaults';
 import { NotebookModel } from '@jupyterlab/notebook';
 import { PageConfig } from '@jupyterlab/coreutils';
+import { DummySettings } from "./cm_adapter.spec";
 
 const js_fib_code = `function fib(n) {
   return n<2?n:fib(n-1)+fib(n-2);
@@ -119,7 +120,8 @@ describe('Feature', () => {
         virtual_editor.virtual_document,
         connection,
         dummy_components_manager,
-        new StatusMessage()
+        new StatusMessage(),
+        new DummySettings()
       );
     }
 

packages/jupyterlab-lsp/src/adapters/codemirror/feature.ts

@@ -91,6 +91,11 @@ export interface ILSPFeature {
   ): void;
 }
 
+export interface IFeatureSettings {
+  get(setting: string): any;
+  set(setting: string, value: any): void;
+}
+
 export interface IEditorRange {
   start: IEditorPosition;
   end: IEditorPosition;
@@ -124,7 +129,8 @@ export abstract class CodeMirrorLSPFeature implements ILSPFeature {
     public virtual_document: VirtualDocument,
     public connection: LSPConnection,
     public jupyterlab_components: IJupyterLabComponentsManager,
-    public status_message: StatusMessage
+    public status_message: StatusMessage,
+    public settings: IFeatureSettings
   ) {
     this.editor_handlers = new Map();
     this.connection_handlers = new Map();

packages/jupyterlab-lsp/src/adapters/codemirror/features/completion.ts

@@ -23,6 +23,13 @@ export class Completion extends CodeMirrorLSPFeature {
   afterChange(change: CodeMirror.EditorChange): void {
     // TODO: maybe the completer could be kicked off in the handleChange() method directly; signature help still
     //  requires an up-to-date virtual document on the LSP side, so we need to wait for sync.
+    if (change.text && change.text[0].length == 1 && this.settings.get('continuousHinting') as boolean) {
+      this.jupyterlab_components.invoke_completer(
+        CompletionTriggerKind.Invoked
+      )
+      return;
+    }
+
     let last_character = this.extract_last_character(change);
     if (this.completionCharacters.indexOf(last_character) > -1) {
       this.virtual_editor.console.log(

packages/jupyterlab-lsp/src/adapters/jupyterlab/components/completion.ts

@@ -21,6 +21,7 @@ import { LSPConnection } from '../../../connection';
 import { Session } from '@jupyterlab/services';
 import ICompletionItemsResponseType = CompletionHandler.ICompletionItemsResponseType;
 import { kernelIcon } from '@jupyterlab/ui-components';
+import { IFeatureSettings } from "../../codemirror/feature";
 
 /**
  * A LSP connector for completion handlers.
@@ -33,22 +34,27 @@ export class LSPConnector
   private _context_connector: ContextConnector;
   private _kernel_connector: KernelConnector;
   private _kernel_and_context_connector: CompletionConnector;
-  protected options: LSPConnector.IOptions;
 
   // signal that this is the new type connector (providing completion items)
   responseType = ICompletionItemsResponseType;
 
   virtual_editor: VirtualEditor;
   private trigger_kind: CompletionTriggerKind;
-  // TODO expose this in user settings
-  private suppress_auto_invoke_in = ['comment', 'string'];
+
+  private get suppress_auto_invoke_in(): string[] {
+    return this.options.settings.get("suppressInvokeIn")
+  }
+
+  private get should_show_documentation(): boolean {
+    return this.options.settings.get("showDocumentation")
+  }
 
   /**
    * Create a new LSP connector for completion requests.
    *
    * @param options - The instantiation options for the LSP connector.
    */
-  constructor(options: LSPConnector.IOptions) {
+  constructor(protected options: LSPConnector.IOptions) {
     this._editor = options.editor;
     this._connections = options.connections;
     this.virtual_editor = options.virtual_editor;
@@ -60,7 +66,6 @@ export class LSPConnector
         kernel_options
       );
     }
-    this.options = options;
   }
 
   dispose() {
@@ -216,14 +221,17 @@ export class LSPConnector
     let prefix = token.value.slice(0, position_in_token + 1);
     let all_non_prefixed = true;
     let items: CompletionHandler.ICompletionItem[] = [];
+    const show_documentation = this.should_show_documentation;
     lspCompletionItems.forEach(match => {
       let completionItem = {
         label: match.label,
         insertText: match.insertText,
         type: match.kind ? completionItemKindNames[match.kind] : '',
-        documentation: lsProtocol.MarkupContent.is(match.documentation)
+        documentation: show_documentation ? (
+          lsProtocol.MarkupContent.is(match.documentation)
           ? match.documentation.value
-          : match.documentation,
+          : match.documentation
+        ) : null,
         filterText: match.filterText,
         deprecated: match.deprecated,
         data: { ...match }
@@ -386,6 +394,8 @@ export namespace LSPConnector {
      */
     connections: Map<VirtualDocument.id_path, LSPConnection>;
 
+    settings: IFeatureSettings;
+
     session?: Session.ISessionConnection;
   }
 }

packages/jupyterlab-lsp/src/adapters/jupyterlab/file_editor.ts

@@ -3,14 +3,11 @@ import { FileEditor } from '@jupyterlab/fileeditor';
 import { IDocumentWidget } from '@jupyterlab/docregistry';
 import { FileEditorJumper } from '@krassowski/jupyterlab_go_to_definition/lib/jumpers/fileeditor';
 import * as CodeMirror from 'codemirror';
-import { JupyterFrontEnd } from '@jupyterlab/application';
-import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { CodeMirrorEditor } from '@jupyterlab/codemirror';
-import { ICompletionManager } from '@jupyterlab/completer';
 import { LSPConnector } from './components/completion';
 import { CodeEditor } from '@jupyterlab/codeeditor';
 import { VirtualFileEditor } from '../../virtual/editors/file_editor';
-import { DocumentConnectionManager } from '../../connection_manager';
+import { LSPExtension } from "../../index";
 
 export class FileEditorAdapter extends JupyterLabWidgetAdapter {
   editor: FileEditor;
@@ -44,19 +41,14 @@ export class FileEditorAdapter extends JupyterLabWidgetAdapter {
   }
 
   constructor(
+    extension: LSPExtension,
     editor_widget: IDocumentWidget<FileEditor>,
-    jumper: FileEditorJumper,
-    app: JupyterFrontEnd,
-    protected completion_manager: ICompletionManager,
-    rendermime_registry: IRenderMimeRegistry,
-    connection_manager: DocumentConnectionManager
+    jumper: FileEditorJumper
   ) {
     super(
-      app,
+      extension,
       editor_widget,
-      rendermime_registry,
       'completer:invoke-file',
-      connection_manager
     );
     this.jumper = jumper;
     this.editor = editor_widget.content;
@@ -84,9 +76,10 @@ export class FileEditorAdapter extends JupyterLabWidgetAdapter {
     this.current_completion_connector = new LSPConnector({
       editor: this.editor.editor,
       connections: this.connection_manager.connections,
-      virtual_editor: this.virtual_editor
+      virtual_editor: this.virtual_editor,
+      settings: this.completion_settings,
     });
-    this.completion_manager.register({
+    this.extension.completion_manager.register({
       connector: this.current_completion_connector,
       editor: this.editor.editor,
       parent: this.widget

packages/jupyterlab-lsp/src/adapters/jupyterlab/jl_adapter.ts

@@ -22,7 +22,7 @@ import { Diagnostics } from '../codemirror/features/diagnostics';
 import { Highlights } from '../codemirror/features/highlights';
 import { Hover } from '../codemirror/features/hover';
 import { Signature } from '../codemirror/features/signature';
-import { ILSPFeatureConstructor, ILSPFeature } from '../codemirror/feature';
+import { ILSPFeatureConstructor, ILSPFeature, IFeatureSettings } from '../codemirror/feature';
 import { JumpToDefinition } from '../codemirror/features/jump_to';
 import { ICommandContext } from '../../command_manager';
 import { JSONObject } from '@lumino/coreutils';
@@ -32,6 +32,35 @@ import {
   ISocketConnectionOptions
 } from '../../connection_manager';
 import { Rename } from '../codemirror/features/rename';
+import { LSPExtension } from "../../index";
+import { ISettingRegistry } from "@jupyterlab/settingregistry";
+
+
+class LabFeatureSettings implements IFeatureSettings {
+
+  private key = 'features';
+
+  constructor(private extension: LSPExtension, protected feature_name: string) {}
+
+  protected get lab_settings(): ISettingRegistry.ISettings {
+    return this.extension.settings;
+  }
+
+  protected get_obj(): any {
+    return (this.lab_settings.get(this.key).composite as any)[this.feature_name.toLowerCase()];
+  }
+
+  get(setting: string) {
+    return this.get_obj()[setting];
+  }
+
+  set(setting: string, value: any) {
+    let obj = this.get_obj();
+    obj[setting] = value;
+    this.lab_settings.set(this.key, obj).catch(console.warn)
+  }
+}
+
 
 export const lsp_features: Array<ILSPFeatureConstructor> = [
   Completion,
@@ -119,18 +148,28 @@ export abstract class JupyterLabWidgetAdapter
   public status_message: StatusMessage;
   public isDisposed = false;
 
+  protected app: JupyterFrontEnd;
+  protected rendermime_registry: IRenderMimeRegistry;
+  /**
+   * Completions are extraordinary in that they require separate settings for the completion component
+   * which is heavily integrated with JupyterLab rather than with the CodeMirror
+   * @protected
+   */
+  protected completion_settings: IFeatureSettings;
+
   protected constructor(
-    protected app: JupyterFrontEnd,
+    protected extension: LSPExtension,
     protected widget: IDocumentWidget,
-    protected rendermime_registry: IRenderMimeRegistry,
     invoke: string,
-    connection_manager: DocumentConnectionManager
   ) {
+    this.app = extension.app;
+    this.rendermime_registry = extension.rendermime_registry;
+    this.connection_manager = extension.connection_manager;
     this.document_connected = new Signal(this);
     this.invoke_command = invoke;
     this.adapters = new Map();
     this.status_message = new StatusMessage();
-    this.connection_manager = connection_manager;
+    this.completion_settings = new LabFeatureSettings(this.extension, 'completion')
 
     // set up signal connections
     this.widget.context.saveState.connect(this.on_save_state, this);
@@ -473,7 +512,8 @@ export abstract class JupyterLabWidgetAdapter
         virtual_document,
         connection,
         this,
-        this.status_message
+        this.status_message,
+        new LabFeatureSettings(this.extension, feature_type.name)
       );
       adapter_features.push(feature);
     }