@jupyter-notebook/console-extension 7.6.0-alpha.1 → 7.6.0-alpha.3

package/lib/index.js

@@ -1,9 +1,13 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 import { IRouter, } from '@jupyterlab/application';
+import { ICommandPalette } from '@jupyterlab/apputils';
 import { IConsoleTracker } from '@jupyterlab/console';
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { INotebookPathOpener, defaultNotebookPathOpener, } from '@jupyter-notebook/application';
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import { consoleIcon } from '@jupyterlab/ui-components';
+import { INotebookPathOpener, INotebookShell, defaultNotebookPathOpener, } from '@jupyter-notebook/application';
 import { find } from '@lumino/algorithm';
 /**
  * A plugin to open consoles in a new tab
@@ -36,18 +40,38 @@ const opener = {
     },
 };
 /**
- * Open consoles in a new tab.
+ * Open consoles in a new tab or in the side panel (scratchpad like).
  */
 const redirect = {
     id: '@jupyter-notebook/console-extension:redirect',
     requires: [IConsoleTracker],
-    optional: [INotebookPathOpener],
+    optional: [INotebookPathOpener, INotebookShell, INotebookTracker],
     autoStart: true,
     description: 'Open consoles in a new tab',
-    activate: (app, tracker, notebookPathOpener) => {
+    activate: (app, tracker, notebookPathOpener, notebookShell, notebookTracker) => {
         const baseUrl = PageConfig.getBaseUrl();
         const opener = notebookPathOpener !== null && notebookPathOpener !== void 0 ? notebookPathOpener : defaultNotebookPathOpener;
         tracker.widgetAdded.connect(async (send, console) => {
+            var _a, _b, _c, _d;
+            // Check if we should open the console in side panel:
+            //  - this is a notebook view
+            //  - the notebook and the console share the same kernel
+            // Otherwise, the console opens in a new tab.
+            if (notebookShell && notebookTracker) {
+                const notebook = notebookTracker.currentWidget;
+                // Wait for the notebook and console to be ready.
+                await Promise.all([
+                    notebook === null || notebook === void 0 ? void 0 : notebook.sessionContext.ready,
+                    console.sessionContext.ready,
+                ]);
+                const notebookKernelId = (_b = (_a = notebook === null || notebook === void 0 ? void 0 : notebook.sessionContext.session) === null || _a === void 0 ? void 0 : _a.kernel) === null || _b === void 0 ? void 0 : _b.id;
+                const consoleKernelId = (_d = (_c = console.sessionContext.session) === null || _c === void 0 ? void 0 : _c.kernel) === null || _d === void 0 ? void 0 : _d.id;
+                if (notebookKernelId === consoleKernelId) {
+                    notebookShell.add(console, 'right');
+                    notebookShell.expandRight(console.id);
+                    return;
+                }
+            }
             const { sessionContext } = console;
             await sessionContext.ready;
             const widget = find(app.shell.widgets('main'), (w) => w.id === console.id);
@@ -65,8 +89,97 @@ const redirect = {
         });
     },
 };
+/**
+ * Open consoles in the side panel.
+ */
+const scratchpadConsole = {
+    id: '@jupyter-notebook/console-extension:scratchpad-console',
+    requires: [INotebookTracker],
+    optional: [INotebookShell, ICommandPalette, ITranslator],
+    autoStart: true,
+    description: 'Open scratchpad console in side panel',
+    activate: (app, tracker, notebookShell, palette, translator) => {
+        const { commands } = app;
+        const manager = app.serviceManager;
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('notebook');
+        const command = 'scratchpad-console:open';
+        commands.addCommand(command, {
+            label: (args) => args['isPalette']
+                ? trans.__('Open a scratchpad console')
+                : trans.__('Scratchpad console'),
+            isVisible: () => !!tracker.currentWidget,
+            icon: (args) => (args['isPalette'] ? undefined : consoleIcon),
+            execute: async (args) => {
+                var _a, _b, _c, _d;
+                if (!notebookShell) {
+                    return;
+                }
+                const consoleId = scratchpadConsole.id;
+                const sidebar = notebookShell.rightHandler;
+                // Close the console if it is already opened (shortcut only).
+                if (sidebar.isVisible && ((_a = sidebar.currentWidget) === null || _a === void 0 ? void 0 : _a.id) === consoleId) {
+                    if (!args.isPalette && !args.isMenu) {
+                        notebookShell.collapseRight();
+                        (_b = notebookShell.currentWidget) === null || _b === void 0 ? void 0 : _b.activate();
+                    }
+                    return;
+                }
+                let panel = sidebar.widgets.find((w) => w.id === consoleId);
+                // Create the widget if it is not already in the right area.
+                if (!panel) {
+                    const notebook = tracker.currentWidget;
+                    if (!notebook) {
+                        return;
+                    }
+                    const notebookSessionContext = notebook.sessionContext;
+                    await Promise.all([notebookSessionContext.ready, manager.ready]);
+                    const id = (_d = (_c = notebookSessionContext.session) === null || _c === void 0 ? void 0 : _c.kernel) === null || _d === void 0 ? void 0 : _d.id;
+                    const kernelPref = notebookSessionContext.kernelPreference;
+                    panel = await commands.execute('console:create', {
+                        kernelPreference: { ...kernelPref, id },
+                    });
+                    if (!panel) {
+                        console.error('An error occurred during scratchpad console creation');
+                        return;
+                    }
+                    panel.title.caption = trans.__('Console');
+                    panel.id = consoleId;
+                }
+                else {
+                    notebookShell.expandRight(consoleId);
+                }
+            },
+            describedBy: {
+                args: {
+                    type: 'object',
+                    properties: {
+                        isPalette: {
+                            type: 'boolean',
+                            description: trans.__('Whether the command is executed from the palette'),
+                        },
+                        isMenu: {
+                            type: 'boolean',
+                            description: trans.__('Whether the command is executed from the menu'),
+                        },
+                    },
+                },
+            },
+        });
+        if (palette) {
+            palette.addItem({
+                category: 'Notebook Console',
+                command,
+                args: { isPalette: true },
+            });
+        }
+    },
+};
 /**
  * Export the plugins as default.
  */
-const plugins = [opener, redirect];
+const plugins = [
+    opener,
+    redirect,
+    scratchpadConsole,
+];
 export default plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/console-extension",
-  "version": "7.6.0-alpha.1",
+  "version": "7.6.0-alpha.3",
   "description": "Jupyter Notebook - Console Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -38,11 +38,17 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/application": "^7.6.0-alpha.1",
-    "@jupyterlab/application": "~4.6.0-alpha.1",
-    "@jupyterlab/console": "~4.6.0-alpha.1",
-    "@jupyterlab/coreutils": "~6.6.0-alpha.1",
-    "@lumino/algorithm": "^2.0.4"
+    "@jupyter-notebook/application": "^7.6.0-alpha.3",
+    "@jupyterlab/application": "~4.6.0-alpha.3",
+    "@jupyterlab/apputils": "~4.7.0-alpha.3",
+    "@jupyterlab/console": "~4.6.0-alpha.3",
+    "@jupyterlab/coreutils": "~6.6.0-alpha.3",
+    "@jupyterlab/notebook": "~4.6.0-alpha.3",
+    "@jupyterlab/translation": "~4.6.0-alpha.3",
+    "@jupyterlab/ui-components": "~4.6.0-alpha.3",
+    "@lumino/algorithm": "^2.0.4",
+    "@lumino/coreutils": "^2.2.2",
+    "@lumino/widgets": "^2.7.2"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",
@@ -52,7 +58,8 @@
     "access": "public"
   },
   "jupyterlab": {
-    "extension": true
+    "extension": true,
+    "schemaDir": "schema"
   },
   "styleModule": "style/index.js"
 }

package/schema/scratchpad-console.json

@@ -0,0 +1,38 @@
+{
+  "title": "Jupyter Notebook Scratchpad Console",
+  "description": "Jupyter Notebook Scratchpad Console",
+  "jupyter.lab.menus": {
+    "main": [
+      {
+        "id": "jp-mainmenu-file",
+        "items": [
+          {
+            "type": "submenu",
+            "submenu": {
+              "id": "jp-mainmenu-file-new",
+              "items": [
+                {
+                  "command": "scratchpad-console:open",
+                  "rank": 2,
+                  "args": {
+                    "isMenu": true
+                  }
+                }
+              ]
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "jupyter.lab.shortcuts": [
+    {
+      "command": "scratchpad-console:open",
+      "keys": ["Accel B"],
+      "selector": "body"
+    }
+  ],
+  "properties": {},
+  "additionalProperties": false,
+  "type": "object"
+}