Add completion settings (Hinterland mode, documentation, suppression)

CHANGELOG.md

@@ -7,12 +7,16 @@
   - support for JupyterLab 2.2 ([#301][])
   - completer now displays server-provided documentation,
     and a kernel icon for kernel suggestions without type information ([#301][])
+  - the documentation by the completer can be turned on or off ([#315])
+  - continuous hinting (Hinterland mode) can be enabled in settings ([#315])
+  - tokens in which the completer should not be triggered can be changed ([#315])
 
 - bug fixes
 
   - path-autocompletion issues were resolved upstream an this release adopts these changes
 
 [#301]: https://github.com/krassowski/jupyterlab-lsp/pull/301
+[#315]: https://github.com/krassowski/jupyterlab-lsp/pull/315
 
 ### `@krassowski/jupyterlab-lsp 1.1.2` (2020-08-05)
 

packages/jupyterlab-lsp/schema/plugin.json

@@ -1,12 +1,58 @@
 {
+  "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,
+              "description": "Whether to show documentation box next to the completion suggestions."
+            },
+            "continuousHinting": {
+              "type": "boolean",
+              "default": false,
+              "description": "Whether to enable continuous hinting (Hinterland mode)."
+            },
+            "suppressInvokeIn": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "An array of CodeMirror tokens for which the auto-invoke should be suppressed. The token names vary between languages (modes)."
+            }
+          }
+        }
+      }
+    }
+  },
   "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 +62,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

@@ -8,7 +8,7 @@ import {
 import { IRootPosition } from '../../positioning';
 import * as CodeMirror from 'codemirror';
 import { CodeMirrorLSPFeature } from './feature';
-import { FileEditorFeatureTestEnvironment } from './testutils';
+import { DummySettings, FileEditorFeatureTestEnvironment } from './testutils';
 
 describe('CodeMirrorAdapter', () => {
   let env: FileEditorFeatureTestEnvironment;
@@ -46,7 +46,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

@@ -8,6 +8,7 @@ import {
 import { CodeMirrorLSPFeature } from './feature';
 import {
   code_cell,
+  DummySettings,
   FeatureTestEnvironment,
   FileEditorFeatureTestEnvironment,
   getCellsJSON,
@@ -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,17 @@ 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/codemirror/testutils.ts

@@ -3,7 +3,11 @@ import {
   CodeMirrorEditorFactory
 } from '@jupyterlab/codemirror';
 import { VirtualEditor } from '../../virtual/editor';
-import { CodeMirrorLSPFeature, ILSPFeatureConstructor } from './feature';
+import {
+  CodeMirrorLSPFeature,
+  IFeatureSettings,
+  ILSPFeatureConstructor
+} from './feature';
 import { LSPConnection } from '../../connection';
 import { CodeEditor } from '@jupyterlab/codeeditor';
 import { VirtualFileEditor } from '../../virtual/editors/file_editor';
@@ -19,11 +23,11 @@ import { IOverridesRegistry } from '../../magics/overrides';
 import { IForeignCodeExtractorsRegistry } from '../../extractors/types';
 import * as nbformat from '@jupyterlab/nbformat';
 import { ICellModel } from '@jupyterlab/cells';
-import createNotebook = NBTestUtils.createNotebook;
 import { CodeMirrorAdapter } from './cm_adapter';
 import { VirtualDocument } from '../../virtual/document';
 import { LanguageServerManager } from '../../manager';
 import { DocumentConnectionManager } from '../../connection_manager';
+import createNotebook = NBTestUtils.createNotebook;
 
 interface IFeatureTestEnvironment {
   host: HTMLElement;
@@ -276,3 +280,13 @@ export async function synchronize_content(
     console.warn(e);
   }
 }
+
+export class DummySettings implements IFeatureSettings {
+  get(setting: string): any {
+    return null;
+  }
+
+  set(setting: string, value: any): void {
+    return;
+  }
+}

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)
-          ? match.documentation.value
-          : match.documentation,
+        documentation: show_documentation
+          ? lsProtocol.MarkupContent.is(match.documentation)
+            ? match.documentation.value
+            : 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,20 +41,11 @@ 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,
-      editor_widget,
-      rendermime_registry,
-      'completer:invoke-file',
-      connection_manager
-    );
+    super(extension, editor_widget, 'completer:invoke-file');
     this.jumper = jumper;
     this.editor = editor_widget.content;
 
@@ -84,9 +72,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