Merge pull request #387 from krassowski/fix-379-syntax-highlighting-restoration

Fix syntax highlighting not being deactivated

Author: krassowski

CHANGELOG.md

@@ -1,5 +1,13 @@
 ## CHANGELOG
 
+### `@krassowski/jupyterlab-lsp 2.0.8` (unreleased)
+
+- bug fixes
+
+  - custom cell syntax highlighting is now properly removed when no longer needed ([#387])
+
+[#387]: https://github.com/krassowski/jupyterlab-lsp/issues/387
+
 ### `@krassowski/jupyterlab-lsp 2.0.7` (2020-09-18)
 
 - bug fixes

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/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;
   }
 }