[WIP] Adding classic shortcuts extension

app/package.json

@@ -14,6 +14,7 @@
     "@codemirror/view": "~6.15.3",
     "@jupyter-notebook/application": "~7.0.4",
     "@jupyter-notebook/application-extension": "~7.0.4",
+    "@jupyter-notebook/classic-shortcuts-extension": "~7.0.4",
     "@jupyter-notebook/console-extension": "~7.0.4",
     "@jupyter-notebook/docmanager-extension": "~7.0.4",
     "@jupyter-notebook/documentsearch-extension": "~7.0.4",
@@ -118,6 +119,7 @@
   "dependencies": {
     "@jupyter-notebook/application": "^7.0.4",
     "@jupyter-notebook/application-extension": "^7.0.4",
+    "@jupyter-notebook/classic-shortcuts-extension": "7.0.4",
     "@jupyter-notebook/console-extension": "^7.0.4",
     "@jupyter-notebook/docmanager-extension": "^7.0.4",
     "@jupyter-notebook/documentsearch-extension": "^7.0.4",
@@ -205,6 +207,7 @@
     "plugins": {
       "/": {
         "@jupyter-notebook/application-extension": true,
+        "@jupyter-notebook/classic-shortcuts-extension": true,
         "@jupyter-notebook/console-extension": true,
         "@jupyter-notebook/docmanager-extension": true,
         "@jupyter-notebook/documentsearch-extension": true,

packages/_metapackage/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@jupyter-notebook/application": "^7.0.4",
     "@jupyter-notebook/application-extension": "^7.0.4",
+    "@jupyter-notebook/classic-shortcuts-extension": "^7.0.4",
     "@jupyter-notebook/console-extension": "^7.0.4",
     "@jupyter-notebook/docmanager-extension": "^7.0.4",
     "@jupyter-notebook/documentsearch-extension": "^7.0.4",

packages/_metapackage/src/index.ts

@@ -1,5 +1,6 @@
 import '@jupyter-notebook/application';
 import '@jupyter-notebook/application-extension';
+import '@jupyter-notebook/classic-shortcuts-extension';
 import '@jupyter-notebook/console-extension';
 import '@jupyter-notebook/docmanager-extension';
 import '@jupyter-notebook/documentsearch-extension';

packages/_metapackage/tsconfig.json

@@ -8,6 +8,7 @@
   "references": [
     { "path": "../application" },
     { "path": "../application-extension" },
+    { "path": "../classic-shortcuts-extension" },
     { "path": "../console-extension" },
     { "path": "../docmanager-extension" },
     { "path": "../documentsearch-extension" },

packages/classic-shortcuts-extension/package.json

@@ -0,0 +1,57 @@
+{
+    "name": "@jupyter-notebook/classic-shortcuts-extension",
+    "version": "7.0.4",
+    "description": "Jupyter Notebook - Classic Shortcuts Extension",
+    "homepage": "https://github.com/jupyter/notebook",
+    "bugs": {
+        "url": "https://github.com/jupyter/notebook/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/jupyter/notebook.git"
+    },
+    "license": "BSD-3-Clause",
+    "author": "Project Jupyter",
+    "sideEffects": [
+        "style/**/*.css",
+        "style/index.js"
+    ],
+    "main": "lib/index.js",
+    "types": "lib/index.d.ts",
+    "style": "style/index.css",
+    "directories": {
+        "lib": "lib/"
+    },
+    "files": [
+        "lib/*.d.ts",
+        "lib/*.js.map",
+        "lib/*.js",
+        "schema/*.json",
+        "style/**/*.css",
+        "style/index.js"
+    ],
+    "scripts": {
+        "build": "tsc -b",
+        "build:prod": "tsc -b",
+        "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
+        "docs": "typedoc src",
+        "watch": "tsc -b --watch"
+    },
+    "dependencies": {
+        "@jupyter-notebook/application": "^7.0.4",
+        "@jupyterlab/application": "^4.0.6",
+        "@jupyterlab/apputils": "^4.1.6"
+    },
+    "devDependencies": {
+        "rimraf": "^3.0.2",
+        "typescript": "~5.0.2"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "jupyterlab": {
+        "extension": true,
+        "schemaDir": "schema"
+    },
+    "styleModule": "style/index.js"
+}

packages/classic-shortcuts-extension/schema/plugin.json

@@ -0,0 +1,44 @@
+{
+  "jupyter.lab.shortcuts": [
+    {
+      "command": "documentsearch:startWithReplace",
+      "keys": ["F"],
+      "selector": ".jp-mod-searchable :focus:not(:read-write)"
+    },
+    {
+      "command": "apputils:display-shortcuts",
+      "keys": ["H"],
+      "selector": "body :focus:not(:read-write)"
+    },
+    {
+      "command": "apputils:activate-command-palette",
+      "keys": ["P"],
+      "selector": "body :focus:not(:read-write)"
+    },
+    {
+      "command": "classic:toggle-output-scrolling",
+      "keys": ["Shift O"],
+      "selector": "body :focus:not(:read-write)"
+    },
+    {
+      "command": "classic:toggle-collapse-output",
+      "keys": ["O"],
+      "selector": "body :focus:not(:read-write)"
+    },
+    {
+      "command": "notebook:toggle-all-cell-line-numbers",
+      "keys": ["L"],
+      "selector": "body :focus:not(:read-write)"
+    },
+    {
+      "command": "filebrowser:paste",
+      "keys": ["Shift V"],
+      "selector": ".jp-DirListing-content .jp-DirListing-itemText"
+    }
+  ],
+  "title": "Jupyter Notebook Classic Shortcuts Extension Entries",
+  "description": "Jupyter Notebook Classic Shortcuts Extension Entries",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

packages/classic-shortcuts-extension/src/index.tsx

@@ -0,0 +1,106 @@
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin,
+} from '@jupyterlab/application';
+
+import { ICommandPalette } from '@jupyterlab/apputils';
+
+/**
+ * Initialization the functionality for the Classic Shortcuts extension.
+ */
+const classicShortcutsPlugin: JupyterFrontEndPlugin<void> = {
+  id: 'classic-shortcuts:plugin',
+  description: 'A JupyterLab extension.',
+  autoStart: false,
+  requires: [ICommandPalette],
+  activate: (app: JupyterFrontEnd, palette: ICommandPalette) => {
+    const { commands } = app;
+
+    const toggle_collapse_output_command = 'classic:toggle-collapse-output';
+    const toggle_autoscroll_output_command = 'classic:toggle-output-scrolling';
+    const toggle_line_numbers_command = 'classic:toggle-line-numbers';
+
+    // Add a command to enable/disable collapse output
+    commands.addCommand(toggle_collapse_output_command, {
+      label: 'Execute classic:toggle-collapse-output Command',
+      caption: 'Execute classic:toggle-collapse-output Command',
+      execute: (args: any) => {
+        console.log('classic:toggle-collapse-output has been called');
+
+        const searchActive = document.querySelector(
+          '.jp-mod-active.jp-mod-selected'
+        );
+        if (searchActive?.children) {
+          for (let i = 0; i < searchActive?.children.length; i++) {
+            const outputArea = searchActive.children[i].querySelector(
+              '.jp-Cell-outputArea'
+            );
+            const placeholderArea = searchActive.children[i].querySelector(
+              '.jp-OutputPlaceholder'
+            );
+
+            if (outputArea) {
+              commands.execute('notebook:hide-cell-outputs');
+            }
+
+            if (placeholderArea) {
+              commands.execute('notebook:show-cell-outputs');
+            }
+          }
+        }
+      },
+    });
+
+    // Add a command to enable/disable autscroll output
+    commands.addCommand(toggle_autoscroll_output_command, {
+      label: 'Execute classic:toggle-output-scrolling Command',
+      caption: 'Execute classic:toggle-output-scrolling Command',
+      execute: (args: any) => {
+        console.log('classic:toggle-output-scrolling has been called.');
+        // if the output has auto-scroll enabled, disable it and vice-versa
+        const searchActive = document.querySelector(
+          '.jp-mod-active.jp-mod-selected.jp-mod-outputsScrolled'
+        );
+        if (searchActive) {
+          commands.execute('notebook:disable-output-scrolling');
+        } else {
+          commands.execute('notebook:enable-output-scrolling');
+        }
+      },
+    });
+
+    // Add a command to enable/disable line numbers
+    commands.addCommand(toggle_line_numbers_command, {
+      label: 'Execute classic:toggle-line-numbers Command',
+      caption: 'Execute classic:toggle-line-numbers Command',
+      execute: (args: any) => {
+        console.log('classic:toggle-line-numbers has been called.');
+        // if the output has auto-scroll enabled, disable it and vice-versa
+        const searchActive = document.querySelector(
+          '.jp-mod-active.jp-mod-selected'
+        );
+        if (searchActive) {
+          commands.execute('notebook:disable-output-scrolling');
+        }
+      },
+    });
+
+    // Add the commands to the command palette
+    const category = 'Classic Notebook Shortcuts';
+    palette.addItem({
+      command: toggle_collapse_output_command,
+      category,
+      args: { origin: 'from palette ' },
+    });
+
+    palette.addItem({
+      command: toggle_autoscroll_output_command,
+      category,
+      args: { origin: 'from palette ' },
+    });
+
+    console.log('Classic Shortcuts extension is activated!');
+  },
+};
+
+export default classicShortcutsPlugin;

packages/classic-shortcuts-extension/style/index.css

@@ -0,0 +1 @@
+@import url('./base.css');

packages/classic-shortcuts-extension/style/index.js

@@ -0,0 +1 @@
+import './base.css';

packages/classic-shortcuts-extension/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "../../tsconfigbase",
+    "compilerOptions": {
+      "outDir": "lib",
+      "rootDir": "src"
+    },
+    "include": ["src/**/*"]
+  }