Merge remote-tracking branch 'upstream/master' into bump-deps

Author: bollwyvl

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,7 +12,7 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
 
 ## Description
 
-<!--Describe the bug clearly and concisely. Include screenshots if possible-->
+<!--Describe the bug clearly and concisely. Include screenshots (or even better - gifs) if possible-->
 
 ## Reproduce
 
@@ -52,7 +52,7 @@ You may want to sanitize the paths in the output.
 </pre>
 </details>
 
-<!--The more contet you provide, the more we can help!-->
+<!--The more content you provide, the more we can help!-->
 
 <details><summary>Troubleshoot Output</summary>
 <pre>
@@ -67,8 +67,14 @@ Paste the output from your command line running `jupyter lab` here, use `--debug
 </pre>
 </details>
 
-<details><summary>Browser Output</summary>
+<details><summary>Browser Output (recommended for all interface issues)</summary>
 <pre>
-Paste the output from your browser Javascript console here.
+Paste the output from your browser JavaScript console replacing the text in here.
+
+To learn how to open the developer tools in your browser:
+https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#How_to_open_the_devtools_in_your_browser
+If too many messagess accumulated after many hours of working in JupyterLab,
+consider refreshing the window and then reproducing the bug to reduce the noise in the logs.
+
 </pre>
 </details>

.github/workflows/job.test.yml

@@ -14,7 +14,7 @@ defaults:
 env:
   # TODO extract these from files instead
   PY_JLSP_VERSION: 0.9.2
-  JS_JLLSP_VERSION: 2.0.7
+  JS_JLLSP_VERSION: 2.0.8
   JS_JLG2D_VERSION: 1.0.0
 
   PYTHONUNBUFFERED: 1

CHANGELOG.md

@@ -1,5 +1,19 @@
 ## CHANGELOG
 
+### `@krassowski/jupyterlab-lsp 2.0.8` (2020-10-25)
+
+- bug fixes
+
+  - custom cell syntax highlighting is now properly removed when no longer needed ([#387])
+  - the completer in continuous hinting now works well with the pasted text ([#389])
+  - continuous hinting suggestions will no longer show up if the only hint is the same as the current token ([#391])
+  - available options for hover modifier keys are now listed in the setting descriptions ([#377])
+
+[#377]: https://github.com/krassowski/jupyterlab-lsp/issues/377
+[#387]: https://github.com/krassowski/jupyterlab-lsp/issues/387
+[#389]: https://github.com/krassowski/jupyterlab-lsp/issues/389
+[#391]: https://github.com/krassowski/jupyterlab-lsp/issues/391
+
 ### `@krassowski/jupyterlab-lsp 2.0.7` (2020-09-18)
 
 - bug fixes

atest/05_Features/Completion.robot

@@ -47,6 +47,14 @@ Works In File Editor
     Completer Should Suggest    add
     [Teardown]    Clean Up After Working With File    completion.py
 
+Continious Hinting Works
+    Configure JupyterLab Plugin    {"continuousHinting": true}    plugin id=${COMPLETION PLUGIN ID}
+    Prepare File for Editing    Python    completion    completion.py
+    Place Cursor In File Editor At    9    2
+    Capture Page Screenshot    01-editor-ready.png
+    Press Keys    None    d
+    Completer Should Suggest    addition
+
 Autocompletes If Only One Option
     Enter Cell Editor    3    line=1
     Press Keys    None    cle
@@ -149,8 +157,8 @@ VSCode Dark Theme Works
     Configure JupyterLab Plugin    {"theme": "vscode"}    plugin id=${COMPLETION PLUGIN ID}
     Capture Page Screenshot    01-configured.png
     Open ${file} in ${MENU NOTEBOOK}
-    Enter Cell Editor    1    line=2
     Wait Until Fully Initialized
+    Enter Cell Editor    1    line=2
     Trigger Completer
     Capture Page Screenshot    02-completions-shown.png
     Completer Should Suggest    TabError

atest/05_Features/Syntax_highlighting.robot

@@ -24,13 +24,29 @@ Highlighing Mode Works For Multiple Documents
     ${mode} =    Get Mode Of A Cell    6
     should be equal    ${mode['name']}    javascript
 
+Highlighting Mode Changes Back And Forth After Edits
+    ${mode} =    Get Mode Of A Cell    2
+    should be equal    ${mode['name']}    markdown
+    Enter Cell Editor    2    line=1
+    Press Keys    None    BACKSPACE
+    Capture Page Screenshot    backapse.png
+    wait until keyword succeeds    5x    2s    Mode Of A Cell Should Equal    2    ipython
+    Enter Cell Editor    2    line=1
+    Press Keys    None    n
+    wait until keyword succeeds    5x    2s    Mode Of A Cell Should Equal    2    markdown
+
 *** Keywords ***
 Get Mode Of A Cell
-    [Arguments]    ${cell_nr}
-    Click Element    css:.jp-Cell:nth-child(${cell_nr})
-    Wait Until Page Contains Element    css:.jp-Cell:nth-child(${cell_nr}) .CodeMirror-focused
-    ${mode} =    Execute JavaScript    return document.querySelector('.jp-Cell:nth-child(${cell_nr}) .CodeMirror').CodeMirror.getMode()
+    [Arguments]    ${cell_number}
+    Click Element    css:.jp-Cell:nth-child(${cell_number})
+    Wait Until Page Contains Element    css:.jp-Cell:nth-child(${cell_number}) .CodeMirror-focused
+    ${mode} =    Execute JavaScript    return document.querySelector('.jp-Cell:nth-child(${cell_number}) .CodeMirror').CodeMirror.getMode()
     [Return]    ${mode}
 
 Setup Highlighting Test
     Setup Notebook    Python    Syntax highlighting.ipynb
+
+Mode Of A Cell Should Equal
+    [Arguments]    ${cell_number}    ${expected_mode}
+    ${mode} =    Get Mode Of A Cell    ${cell_number}
+    should be equal    ${mode['name']}    ${expected_mode}

packages/jupyterlab-lsp/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krassowski/jupyterlab-lsp",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "description": "Language Server Protocol integration for JupyterLab",
   "keywords": [
     "jupyter",

packages/jupyterlab-lsp/src/editor_integration/codemirror.ts

@@ -230,7 +230,8 @@ export abstract class CodeMirrorIntegration
 
   protected extract_last_character(change: CodeMirror.EditorChange): string {
     if (change.origin === 'paste') {
-      return change.text[0][change.text.length - 1];
+      let last_line = change.text[change.text.length - 1];
+      return last_line[last_line.length - 1];
     } else {
       return change.text[0][0];
     }

packages/jupyterlab-lsp/src/features/completion/completion_handler.ts

@@ -205,7 +205,7 @@ export class LSPConnector
     }
 
     return promise.then(reply => {
-      reply = this.suppress_if_needed(reply);
+      reply = this.suppress_if_needed(reply, token);
       this.trigger_kind = CompletionTriggerKind.Invoked;
       return reply;
     });
@@ -413,9 +413,17 @@ export class LSPConnector
     return Promise.resolve(undefined);
   }
 
-  private suppress_if_needed(reply: CompletionHandler.ICompletionItemsReply) {
+  private suppress_if_needed(
+    reply: CompletionHandler.ICompletionItemsReply,
+    token: CodeEditor.IToken
+  ) {
     if (this.trigger_kind == AdditionalCompletionTriggerKinds.AutoInvoked) {
-      if (reply.start == reply.end) {
+      if (
+        // do not auto-invoke if no match found
+        reply.start == reply.end ||
+        // do not auto-invoke if only one match found and this match is exactly the same as the current token
+        (reply.items.length === 1 && reply.items[0].insertText === token.value)
+      ) {
         return {
           start: reply.start,
           end: reply.end,

packages/jupyterlab-lsp/src/features/syntax_highlighting.ts

@@ -29,10 +29,12 @@ const FEATURE_ID = PLUGIN_ID + ':syntax_highlighting';
 export class CMSyntaxHighlighting extends CodeMirrorIntegration {
   lab_integration: SyntaxLabIntegration;
   settings: IFeatureSettings<LSPSyntaxHighlightingSettings>;
+  editors_with_active_highlight: Set<CodeMirrorEditor>;
 
   constructor(options: IEditorIntegrationOptions) {
     super(options);
     this.virtual_document.changed.connect(this.update_mode.bind(this), this);
+    this.editors_with_active_highlight = new Set();
   }
 
   private get_mode(language: string) {
@@ -52,10 +54,12 @@ export class CMSyntaxHighlighting extends CodeMirrorIntegration {
 
   update_mode() {
     let root = this.virtual_document;
+    let editors_with_current_highlight = new Set<CodeMirrorEditor>();
+
     for (let map of root.foreign_document_maps) {
       for (let [range, block] of map.entries()) {
-        let ce_editor = block.editor;
-        let editor = (ce_editor as CodeMirrorEditor).editor;
+        let ce_editor = block.editor as CodeMirrorEditor;
+        let editor = ce_editor.editor;
         let lines = editor.getValue('\n');
         let total_area = lines.concat('').length;
 
@@ -75,13 +79,24 @@ export class CMSyntaxHighlighting extends CodeMirrorIntegration {
 
         // change the mode if the majority of the code is the foreign code
         if (coverage > this.settings.composite.foreignCodeThreshold) {
+          editors_with_current_highlight.add(ce_editor);
           let old_mode = editor.getOption('mode');
           if (old_mode != mode.mime) {
             editor.setOption('mode', mode.mime);
           }
         }
       }
     }
+
+    if (editors_with_current_highlight != this.editors_with_active_highlight) {
+      for (let ce_editor of this.editors_with_active_highlight) {
+        if (!editors_with_current_highlight.has(ce_editor)) {
+          ce_editor.editor.setOption('mode', ce_editor.model.mimeType);
+        }
+      }
+    }
+
+    this.editors_with_active_highlight = editors_with_current_highlight;
   }
 }
 

packages/metapackage/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krassowski/jupyterlab-lsp-metapackage",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "description": "JupyterLab LSP - Meta Package. All of the packages used by JupyterLab LSP",
   "homepage": "https://github.com/krassowski/jupyterlab-lsp",
   "bugs": {