Backport PR jupyterlab#14664: Fix semantic commands enabled status

meeseeksmachine · Aug 3, 2023 · 7ece176 · 7ece176
1 parent d3bf456
commit 7ece176
Show file tree

Hide file tree

Showing 17 changed files with 105 additions and 28 deletions.
diff --git a/galata/test/documentation/debugger.test.ts b/galata/test/documentation/debugger.test.ts
@@ -77,7 +77,7 @@ test.describe('Debugger', () => {
     await createNotebook(page);
 
     const runButton = await page.waitForSelector(
-      '.jp-Toolbar-item >> [data-command="runmenu:run"]'
+      '.jp-Toolbar-item >> [data-command="notebook:run-cell-and-select-next"]'
     );
 
     // Inject mouse pointer

diff --git a/...ion/general.test.ts-snapshots/file-formats-html-display-documentation-linux.png b/...ion/general.test.ts-snapshots/file-formats-html-display-documentation-linux.png
diff --git a/...entation/general.test.ts-snapshots/interface-jupyterlab-documentation-linux.png b/...entation/general.test.ts-snapshots/interface-jupyterlab-documentation-linux.png
diff --git a/packages/application-extension/schema/top-bar.json b/packages/application-extension/schema/top-bar.json
@@ -55,6 +55,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/apputils-extension/src/index.ts b/packages/apputils-extension/src/index.ts
@@ -612,10 +612,11 @@ const utilityCommands: JupyterFrontEndPlugin<void> = {
     commands.addCommand(CommandIDs.runAllEnabled, {
       label: trans.__('Run All Enabled Commands Passed as Args'),
       execute: async args => {
-        const commands: string[] = args.commands as string[];
+        const commands: string[] = (args.commands as string[]) ?? [];
         const commandArgs: any = args.args;
         const argList = Array.isArray(args);
-        const errorIfNotEnabled: boolean = args.errorIfNotEnabled as boolean;
+        const errorIfNotEnabled: boolean =
+          (args.errorIfNotEnabled as boolean) ?? false;
         for (let i = 0; i < commands.length; i++) {
           const cmd = commands[i];
           const arg = argList ? commandArgs[i] : commandArgs;
@@ -627,6 +628,15 @@ const utilityCommands: JupyterFrontEndPlugin<void> = {
             }
           }
         }
+      },
+      isEnabled: args => {
+        const commands: string[] = (args.commands as string[]) ?? [];
+        const commandArgs: any = args.args;
+        const argList = Array.isArray(args);
+
+        return commands.some((cmd, idx) =>
+          app.commands.isEnabled(cmd, argList ? commandArgs[idx] : commandArgs)
+        );
       }
     });
 

diff --git a/packages/apputils/src/toolbar/registry.ts b/packages/apputils/src/toolbar/registry.ts
@@ -143,6 +143,7 @@ export function createDefaultFactory(
           command: tId,
           args: tArgs,
           label: tLabel,
+          caption: tCaption,
           icon: tIcon
         } = toolbarItem;
         const id = tId ?? '';
@@ -156,7 +157,8 @@ export function createDefaultFactory(
           id,
           args,
           icon,
-          label
+          label,
+          caption: tCaption as string
         });
       }
       case 'spacer':

diff --git a/packages/cell-toolbar-extension/schema/plugin.json b/packages/cell-toolbar-extension/schema/plugin.json
@@ -70,6 +70,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/csvviewer-extension/schema/csv.json b/packages/csvviewer-extension/schema/csv.json
@@ -51,6 +51,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/csvviewer-extension/schema/tsv.json b/packages/csvviewer-extension/schema/tsv.json
@@ -51,6 +51,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/filebrowser-extension/schema/widget.json b/packages/filebrowser-extension/schema/widget.json
@@ -95,6 +95,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/fileeditor-extension/schema/plugin.json b/packages/fileeditor-extension/schema/plugin.json
@@ -232,6 +232,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/fileeditor-extension/src/commands.ts b/packages/fileeditor-extension/src/commands.ts
@@ -1278,7 +1278,7 @@ export namespace Commands {
 
     // Add a code runner to the run menu.
     if (consoleTracker) {
-      addCodeRunnersToRunMenu(menu, consoleTracker);
+      addCodeRunnersToRunMenu(menu, consoleTracker, isEnabled);
     }
   }
 
@@ -1303,24 +1303,26 @@ export namespace Commands {
    */
   export function addCodeRunnersToRunMenu(
     menu: IMainMenu,
-    consoleTracker: IConsoleTracker
+    consoleTracker: IConsoleTracker,
+    isEnabled: () => boolean
   ): void {
-    const isEnabled = (current: IDocumentWidget<FileEditor>) =>
+    const isEnabled_ = (current: IDocumentWidget<FileEditor>) =>
+      isEnabled() &&
       current.context &&
       !!consoleTracker.find(
         widget => widget.sessionContext.session?.path === current.context.path
       );
     menu.runMenu.codeRunners.restart.add({
       id: CommandIDs.restartConsole,
-      isEnabled
+      isEnabled: isEnabled_
     });
     menu.runMenu.codeRunners.run.add({
       id: CommandIDs.runCode,
-      isEnabled
+      isEnabled: isEnabled_
     });
     menu.runMenu.codeRunners.runAll.add({
       id: CommandIDs.runAllCode,
-      isEnabled
+      isEnabled: isEnabled_
     });
   }
 

diff --git a/packages/htmlviewer-extension/schema/plugin.json b/packages/htmlviewer-extension/schema/plugin.json
@@ -60,6 +60,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/notebook-extension/schema/panel.json b/packages/notebook-extension/schema/panel.json
@@ -13,12 +13,20 @@
       { "name": "cut", "command": "notebook:cut-cell", "rank": 21 },
       { "name": "copy", "command": "notebook:copy-cell", "rank": 22 },
       { "name": "paste", "command": "notebook:paste-cell-below", "rank": 23 },
-      { "name": "run", "command": "runmenu:run", "rank": 30 },
-      { "name": "interrupt", "command": "kernelmenu:interrupt", "rank": 31 },
-      { "name": "restart", "command": "kernelmenu:restart", "rank": 32 },
+      {
+        "name": "run",
+        "command": "notebook:run-cell-and-select-next",
+        "rank": 30
+      },
+      {
+        "name": "interrupt",
+        "command": "notebook:interrupt-kernel",
+        "rank": 31
+      },
+      { "name": "restart", "command": "notebook:restart-kernel", "rank": 32 },
       {
         "name": "restart-and-run",
-        "command": "runmenu:restart-and-run-all",
+        "command": "notebook:restart-run-all",
         "rank": 33
       },
       { "name": "cellType", "rank": 40 },
@@ -72,6 +80,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/notebook-extension/src/index.ts b/packages/notebook-extension/src/index.ts
@@ -103,7 +103,10 @@ import {
   moveDownIcon,
   moveUpIcon,
   notebookIcon,
-  pasteIcon
+  pasteIcon,
+  refreshIcon,
+  runIcon,
+  stopIcon
 } from '@jupyterlab/ui-components';
 import { ArrayExt } from '@lumino/algorithm';
 import { CommandRegistry } from '@lumino/commands';
@@ -2183,7 +2186,8 @@ function addCommands(
         );
       }
     },
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled()),
+    icon: args => (args.toolbar ? runIcon : undefined)
   });
   commands.addCommand(CommandIDs.run, {
     label: args => {
@@ -2326,7 +2330,8 @@ function addCommands(
         return sessionDialogs.restart(current.sessionContext);
       }
     },
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled()),
+    icon: args => (args.toolbar ? refreshIcon : undefined)
   });
   commands.addCommand(CommandIDs.shutdown, {
     label: trans.__('Shut Down Kernel'),
@@ -2421,8 +2426,8 @@ function addCommands(
         await commands.execute(CommandIDs.runAll);
       }
     },
-    isEnabled,
-    icon: fastForwardIcon
+    isEnabled: args => (args.toolbar ? true : isEnabled()),
+    icon: args => (args.toolbar ? fastForwardIcon : undefined)
   });
   commands.addCommand(CommandIDs.clearAllOutputs, {
     label: trans.__('Clear Outputs of All Cells'),
@@ -2464,7 +2469,8 @@ function addCommands(
         return kernel.interrupt();
       }
     },
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled()),
+    icon: args => (args.toolbar ? stopIcon : undefined)
   });
   commands.addCommand(CommandIDs.toCode, {
     label: trans.__('Change to Code Cell Type'),
@@ -2524,7 +2530,7 @@ function addCommands(
       }
     },
     icon: args => (args.toolbar ? cutIcon : undefined),
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.copy, {
     label: args => {
@@ -2551,7 +2557,7 @@ function addCommands(
       }
     },
     icon: args => (args.toolbar ? copyIcon : undefined),
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.pasteBelow, {
     label: args => {
@@ -2578,7 +2584,7 @@ function addCommands(
       }
     },
     icon: args => (args.toolbar ? pasteIcon : undefined),
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.pasteAbove, {
     label: args => {
@@ -2631,7 +2637,7 @@ function addCommands(
       }
     },
     icon: args => (args.toolbar ? duplicateIcon : undefined),
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.pasteAndReplace, {
     label: args => {
@@ -2676,7 +2682,7 @@ function addCommands(
         return NotebookActions.deleteCells(current.content);
       }
     },
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.split, {
     label: trans.__('Split Cell'),
@@ -2733,7 +2739,7 @@ function addCommands(
       }
     },
     icon: args => (args.toolbar ? addAboveIcon : undefined),
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.insertBelow, {
     label: trans.__('Insert Cell Below'),
@@ -2746,7 +2752,7 @@ function addCommands(
       }
     },
     icon: args => (args.toolbar ? addBelowIcon : undefined),
-    isEnabled
+    isEnabled: args => (args.toolbar ? true : isEnabled())
   });
   commands.addCommand(CommandIDs.selectAbove, {
     label: trans.__('Select Cell Above'),

diff --git a/packages/settingregistry/src/plugin-schema.json b/packages/settingregistry/src/plugin-schema.json
@@ -287,6 +287,11 @@
           "description": "If defined, it will override the command label",
           "type": "string"
         },
+        "caption": {
+          "title": "Item caption",
+          "description": "If defined, it will override the command caption",
+          "type": "string"
+        },
         "type": {
           "title": "Item type",
           "type": "string",

diff --git a/packages/ui-components/src/components/toolbar.tsx b/packages/ui-components/src/components/toolbar.tsx
@@ -825,6 +825,10 @@ export namespace CommandToolbarButtonComponent {
      * Overrides command label
      */
     label?: string;
+    /**
+     * Overrides command caption
+     */
+    caption?: string;
   }
 }
 
@@ -1089,7 +1093,7 @@ namespace Private {
       dataset: { 'data-command': options.id },
       icon,
       iconClass,
-      tooltip,
+      tooltip: options.caption ?? tooltip,
       onClick,
       enabled,
       label: options.label ?? label