Add a scratch-pad console to the notebook

app/package.json

@@ -226,7 +226,6 @@
         "@jupyter-notebook/notebook-extension": true,
         "@jupyter-notebook/terminal-extension": true,
         "@jupyterlab/application-extension": [
-          "@jupyterlab/application-extension:commands",
           "@jupyterlab/application-extension:context-menu",
           "@jupyterlab/application-extension:faviconbusy",
           "@jupyterlab/application-extension:router",
@@ -313,6 +312,9 @@
         "@jupyterlab/video-extension": true
       },
       "/tree": {
+        "@jupyterlab/application-extension": [
+          "@jupyterlab/application-extension:commands"
+        ],
         "@jupyterlab/cell-toolbar-extension": true,
         "@jupyterlab/extensionmanager-extension": true,
         "@jupyterlab/filebrowser-extension": [

packages/console-extension/package.json

@@ -40,9 +40,15 @@
   "dependencies": {
     "@jupyter-notebook/application": "^7.6.0-alpha.0",
     "@jupyterlab/application": "~4.6.0-alpha.0",
+    "@jupyterlab/apputils": "~4.7.0-alpha.0",
     "@jupyterlab/console": "~4.6.0-alpha.0",
     "@jupyterlab/coreutils": "~6.6.0-alpha.0",
-    "@lumino/algorithm": "^2.0.4"
+    "@jupyterlab/notebook": "~4.6.0-alpha.0",
+    "@jupyterlab/translation": "~4.6.0-alpha.0",
+    "@jupyterlab/ui-components": "~4.6.0-alpha.0",
+    "@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"
 }

packages/console-extension/schema/scratch-pad.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": "scratch-pad-console:open",
+                  "rank": 2,
+                  "args": {
+                    "isMenu": true
+                  }
+                }
+              ]
+            }
+          }
+        ]
+      }
+    ]
+  },
+  "jupyter.lab.shortcuts": [
+    {
+      "command": "scratch-pad-console:open",
+      "keys": ["Accel B"],
+      "selector": "body"
+    }
+  ],
+  "properties": {},
+  "additionalProperties": false,
+  "type": "object"
+}

packages/console-extension/src/index.ts

@@ -7,17 +7,40 @@ import {
   JupyterFrontEndPlugin,
 } from '@jupyterlab/application';
 
+import { ICommandPalette } from '@jupyterlab/apputils';
+
 import { IConsoleTracker } from '@jupyterlab/console';
 
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 
+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';
 
+import { ReadonlyJSONObject } from '@lumino/coreutils';
+
+import { Widget } from '@lumino/widgets';
+
+const COMMANDS_TO_PATCH = [
+  'console:clear',
+  'console:run-unforced',
+  'console:run-forced',
+  'console:linebreak',
+  'console:interrupt-kernel',
+  'console:restart-kernel',
+  'console:change-kernel',
+];
+
 /**
  * A plugin to open consoles in a new tab
  */
@@ -53,23 +76,58 @@ const opener: JupyterFrontEndPlugin<void> = {
 };
 
 /**
- * Open consoles in a new tab.
+ * Open consoles in a new tab or in the side panel (scratch-pad like).
  */
 const redirect: JupyterFrontEndPlugin<void> = {
   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: JupyterFrontEnd,
     tracker: IConsoleTracker,
-    notebookPathOpener: INotebookPathOpener | null
+    notebookPathOpener: INotebookPathOpener | null,
+    notebookShell: INotebookShell | null,
+    notebookTracker: INotebookTracker | null
   ) => {
     const baseUrl = PageConfig.getBaseUrl();
     const opener = notebookPathOpener ?? defaultNotebookPathOpener;
 
     tracker.widgetAdded.connect(async (send, console) => {
+      // 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?.sessionContext.ready,
+          console.sessionContext.ready,
+        ]);
+        const notebookKernelId = notebook?.sessionContext.session?.kernel?.id;
+        const consoleKernelId = console.sessionContext.session?.kernel?.id;
+
+        if (notebookKernelId === consoleKernelId) {
+          notebookShell.add(console, 'right');
+          notebookShell.expandRight(console.id);
+
+          // Some commands needs to be patched to be enabled.
+          // TODO: fix it upstream in jupyterlab.
+          app.commands
+            .listCommands()
+            .filter((id) => COMMANDS_TO_PATCH.includes(id))
+            .forEach((id) => {
+              (app.commands as any)._commands.get(id).isEnabled = () =>
+                tracker.currentWidget !== null &&
+                tracker.currentWidget.node.contains(document.activeElement);
+            });
+          return;
+        }
+      }
+
       const { sessionContext } = console;
       await sessionContext.ready;
       const widget = find(
@@ -92,9 +150,121 @@ const redirect: JupyterFrontEndPlugin<void> = {
   },
 };
 
+/**
+ * Open consoles in the side panel.
+ */
+const scratchPadConsole: JupyterFrontEndPlugin<void> = {
+  id: '@jupyter-notebook/console-extension:scratch-pad',
+  requires: [INotebookTracker],
+  optional: [INotebookShell, ICommandPalette, ITranslator],
+  autoStart: true,
+  description: 'Open consoles in a new tab',
+  activate: (
+    app: JupyterFrontEnd,
+    tracker: INotebookTracker,
+    notebookShell: INotebookShell | null,
+    palette: ICommandPalette | null,
+    translator: ITranslator | null
+  ) => {
+    const { commands } = app;
+    const manager = app.serviceManager;
+
+    const trans = (translator ?? nullTranslator).load('notebook');
+
+    const command = 'scratch-pad-console:open';
+    commands.addCommand(command, {
+      label: (args) =>
+        args['isPalette']
+          ? trans.__('Open a scratch-pad console')
+          : trans.__('Scratch-pad console'),
+      isVisible: () => !!tracker.currentWidget,
+      icon: (args) => (args['isPalette'] ? undefined : consoleIcon),
+      execute: async (args) => {
+        if (!notebookShell) {
+          return;
+        }
+        const consoleId = scratchPadConsole.id;
+        const sidebar = notebookShell.rightHandler;
+
+        // Close the console if it is already opened (shortcut only).
+        if (sidebar.isVisible && sidebar.currentWidget?.id === consoleId) {
+          if (!args.isPalette && !args.isMenu) {
+            notebookShell.collapseRight();
+            notebookShell.currentWidget?.activate();
+          }
+          return;
+        }
+
+        let panel: Widget | undefined = 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 = notebookSessionContext.session?.kernel?.id;
+          const kernelPref = notebookSessionContext.kernelPreference;
+
+          panel = await commands.execute('console:create', {
+            kernelPreference: { ...kernelPref, id } as ReadonlyJSONObject,
+          });
+
+          if (!panel) {
+            console.log('An error occurred during console widget creation');
+            return;
+          }
+
+          panel.title.caption = trans.__('Console');
+          panel.id = consoleId;
+        } else {
+          notebookShell.expandRight(consoleId);
+        }
+      },
+      describedBy: {
+        args: {
+          type: 'object',
+          properties: {
+            isPalette: {
+              type: 'boolean',
+              description: trans.__(
+                trans.__('Whether the command is executed from the palette')
+              ),
+            },
+            isMenu: {
+              type: 'boolean',
+              description: trans.__(
+                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: JupyterFrontEndPlugin<any>[] = [opener, redirect];
+const plugins: JupyterFrontEndPlugin<any>[] = [
+  opener,
+  redirect,
+  scratchPadConsole,
+];
 
 export default plugins;

yarn.lock

@@ -2383,9 +2383,15 @@ __metadata:
   dependencies:
     "@jupyter-notebook/application": ^7.6.0-alpha.0
     "@jupyterlab/application": ~4.6.0-alpha.0
+    "@jupyterlab/apputils": ~4.7.0-alpha.0
     "@jupyterlab/console": ~4.6.0-alpha.0
     "@jupyterlab/coreutils": ~6.6.0-alpha.0
+    "@jupyterlab/notebook": ~4.6.0-alpha.0
+    "@jupyterlab/translation": ~4.6.0-alpha.0
+    "@jupyterlab/ui-components": ~4.6.0-alpha.0
     "@lumino/algorithm": ^2.0.4
+    "@lumino/coreutils": ^2.2.2
+    "@lumino/widgets": ^2.7.2
     rimraf: ^3.0.2
     typescript: ~5.5.4
   languageName: unknown