Merge pull request #689 from jupyter-lsp/allow-to-disable-features

Allow to disable specific features

Author: krassowski

CHANGELOG.md

@@ -130,6 +130,12 @@
           ]
         }
       }
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/schema/completion.json

@@ -29,6 +29,12 @@
       },
       "default": [],
       "description": "Regular expressions matching messages of diagnostics which should not be shown in the panel nor highlighted in the editor."
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/schema/diagnostics.json

@@ -16,6 +16,12 @@
       "type": "boolean",
       "default": false,
       "description": "Whether the highlights should disappear after the focus leaves the editor/cell"
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/schema/highlights.json

@@ -23,6 +23,12 @@
       "type": "number",
       "default": 25,
       "description": "Up to how many hover responses should be cached at any given time. The cache being is invalidated after any change in the editor."
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/schema/hover.json

@@ -11,6 +11,12 @@
       "enum": ["Alt", "Control", "Shift", "Meta", "AltGraph", "Accel"],
       "default": "Alt",
       "description": "Keyboard key which needs to be pressed with click to jump. The allowed keys are Alt, Control, Shift, Accel, and AltGraph. Accel corresponds to Control or Meta (Command on Mac). Linux user: Meta key is also supported. Safari users: Meta key is also supported, AltGraph is not supported. To see which physical keys are mapped, visit: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState"
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": [

packages/jupyterlab-lsp/schema/jump_to.json

@@ -4,7 +4,14 @@
   "title": "Code Rename",
   "description": "LSP Rename settings.",
   "type": "object",
-  "properties": {},
+  "properties": {
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
+    }
+  },
   "jupyter.lab.shortcuts": [
     {
       "command": "lsp:rename-symbol-notebook",

packages/jupyterlab-lsp/schema/rename.json

@@ -19,6 +19,12 @@
       "type": "number",
       "default": 12,
       "description": "The number of documentation lines to show without collapsing into the details section."
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/schema/signature.json

@@ -10,6 +10,12 @@
       "type": "number",
       "default": 0.5,
       "description": "If a code editor includes a code fragment in another language (for example a %%markdown magic in IPython) with appropriate foreign code extractor defined, and the extend of this code (coverage of the editor) passes the threshold, the syntax highlighting (i.e. the mode) will change to provide highlighting for the language of the foreign code."
+    },
+    "disable": {
+      "title": "Disable",
+      "type": "boolean",
+      "default": false,
+      "description": "Disable this feature. Requires reloading JupyterLab to apply changes."
     }
   },
   "jupyter.lab.shortcuts": []

packages/jupyterlab-lsp/schema/syntax_highlighting.json

@@ -56,13 +56,15 @@ export interface IFeatureCommand {
 export interface IFeatureSettings<T> {
   readonly composite: T;
   readonly changed: Signal<IFeatureSettings<T>, void>;
+  readonly ready?: Promise<void>;
 
   set(setting: keyof T, value: any): void;
 }
 
 export class FeatureSettings<T> implements IFeatureSettings<T> {
   protected settings: ISettingRegistry.ISettings;
   public changed: Signal<FeatureSettings<T>, void>;
+  public ready: Promise<void>;
 
   constructor(protected settingRegistry: ISettingRegistry, featureID: string) {
     this.changed = new Signal(this);
@@ -71,17 +73,20 @@ export class FeatureSettings<T> implements IFeatureSettings<T> {
         `${featureID} settings schema could not be found and was not loaded`
       );
     } else {
-      settingRegistry
-        .load(featureID)
-        .then(settings => {
-          this.settings = settings;
-          this.changed.emit();
-          settings.changed.connect(() => {
+      this.ready = new Promise(accept => {
+        settingRegistry
+          .load(featureID)
+          .then(settings => {
             this.settings = settings;
+            accept();
             this.changed.emit();
-          });
-        })
-        .catch(console.warn);
+            settings.changed.connect(() => {
+              this.settings = settings;
+              this.changed.emit();
+            });
+          })
+          .catch(console.warn);
+      });
     }
   }