Merge pull request #294 from loichuder/doc-search

Add extension for document-scoped search

app/index.js

@@ -84,6 +84,7 @@ async function main() {
     require('@retrolab/application-extension'),
     require('@retrolab/console-extension'),
     require('@retrolab/docmanager-extension'),
+    require('@retrolab/documentsearch-extension'),
     require('@retrolab/help-extension'),
     require('@retrolab/notebook-extension'),
     // to handle opening new tabs after creating a new terminal
@@ -123,6 +124,9 @@ async function main() {
       ].includes(id)
     ),
     require('@jupyterlab/docprovider-extension'),
+    require('@jupyterlab/documentsearch-extension').default.filter(({ id }) =>
+      ['@jupyterlab/documentsearch:plugin'].includes(id)
+    ),
     require('@jupyterlab/filebrowser-extension').default.filter(({ id }) =>
       ['@jupyterlab/filebrowser-extension:factory'].includes(id)
     ),

app/package.json

@@ -27,6 +27,8 @@
     "@jupyterlab/docmanager-extension": "~3.2.0",
     "@jupyterlab/docprovider": "~3.2.0",
     "@jupyterlab/docprovider-extension": "~3.2.0",
+    "@jupyterlab/documentsearch": "~3.2.4",
+    "@jupyterlab/documentsearch-extension": "~3.2.4",
     "@jupyterlab/filebrowser": "~3.2.0",
     "@jupyterlab/filebrowser-extension": "~3.2.0",
     "@jupyterlab/fileeditor": "~3.2.0",
@@ -78,6 +80,7 @@
     "@retrolab/application-extension": "~0.3.13",
     "@retrolab/console-extension": "~0.3.13",
     "@retrolab/docmanager-extension": "~0.3.13",
+    "@retrolab/documentsearch-extension": "~0.3.13",
     "@retrolab/help-extension": "~0.3.13",
     "@retrolab/notebook-extension": "~0.3.13",
     "@retrolab/terminal-extension": "~0.3.13",
@@ -97,6 +100,7 @@
     "@jupyterlab/coreutils": "~5.2.0",
     "@jupyterlab/docmanager-extension": "^3.2.0",
     "@jupyterlab/docprovider-extension": "^3.2.0",
+    "@jupyterlab/documentsearch-extension": "^3.2.0",
     "@jupyterlab/filebrowser-extension": "^3.2.0",
     "@jupyterlab/fileeditor-extension": "^3.2.0",
     "@jupyterlab/hub-extension": "^3.2.0",
@@ -119,6 +123,7 @@
     "@retrolab/application-extension": "^0.3.13",
     "@retrolab/console-extension": "^0.3.13",
     "@retrolab/docmanager-extension": "^0.3.13",
+    "@retrolab/documentsearch-extension": "^0.3.13",
     "@retrolab/help-extension": "^0.3.13",
     "@retrolab/notebook-extension": "^0.3.13",
     "@retrolab/terminal-extension": "^0.3.13",
@@ -153,6 +158,7 @@
       "@retrolab/application-extension",
       "@retrolab/console-extension",
       "@retrolab/docmanager-extension",
+      "@retrolab/documentsearch-extension",
       "@retrolab/help-extension",
       "@retrolab/notebook-extension",
       "@retrolab/terminal-extension",
@@ -163,6 +169,7 @@
       "@jupyterlab/completer-extension",
       "@jupyterlab/console-extension",
       "@jupyterlab/docmanager-extension",
+      "@jupyterlab/documentsearch-extension",
       "@jupyterlab/filebrowser-extension",
       "@jupyterlab/fileeditor-extension",
       "@jupyterlab/hub-extension",
@@ -188,6 +195,7 @@
       "@jupyterlab/coreutils",
       "@jupyterlab/docmanager",
       "@jupyterlab/docprovider",
+      "@jupyterlab/documentsearch",
       "@jupyterlab/filebrowser",
       "@jupyterlab/fileeditor",
       "@jupyterlab/mainmenu",

packages/_metapackage/package.json

@@ -24,6 +24,7 @@
     "@retrolab/application-extension": "file:../application-extension",
     "@retrolab/console-extension": "file:../console-extension",
     "@retrolab/docmanager-extension": "file:../docmanager-extension",
+    "@retrolab/documentsearch-extension": "file:../documentsearch-extension",
     "@retrolab/help-extension": "file:../help-extension",
     "@retrolab/lab-extension": "file:../lab-extension",
     "@retrolab/notebook-extension": "file:../notebook-extension",

packages/_metapackage/src/index.ts

@@ -2,6 +2,7 @@ import '@retrolab/application';
 import '@retrolab/application-extension';
 import '@retrolab/console-extension';
 import '@retrolab/docmanager-extension';
+import '@retrolab/documentsearch-extension';
 import '@retrolab/help-extension';
 import '@retrolab/lab-extension';
 import '@retrolab/notebook-extension';

packages/_metapackage/tsconfig.json

@@ -10,6 +10,7 @@
     { "path": "../application-extension" },
     { "path": "../console-extension" },
     { "path": "../docmanager-extension" },
+    { "path": "../documentsearch-extension" },
     { "path": "../help-extension" },
     { "path": "../lab-extension" },
     { "path": "../notebook-extension" },

packages/documentsearch-extension/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@retrolab/documentsearch-extension",
+  "version": "0.3.13",
+  "description": "RetroLab - Document Search Extension",
+  "homepage": "https://github.com/jupyterlab/retrolab",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/retrolab/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/retrolab.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",
+    "prepublishOnly": "npm run build",
+    "watch": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@jupyterlab/application": "^3.2.0",
+    "@retrolab/application": "^0.3.13",
+    "@jupyterlab/documentsearch": "^3.2.0",
+    "@lumino/widgets": "^1.23.0"
+  },
+  "devDependencies": {
+    "rimraf": "~3.0.0",
+    "typescript": "~4.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "extension": true
+  },
+  "styleModule": "style/index.js"
+}

packages/documentsearch-extension/src/index.ts

@@ -0,0 +1,92 @@
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+
+import { ISearchProviderRegistry } from '@jupyterlab/documentsearch';
+
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+
+import { Widget } from '@lumino/widgets';
+
+import { IRetroShell } from '@retrolab/application';
+
+const SEARCHABLE_CLASS = 'jp-mod-searchable';
+
+/**
+ * A plugin to programmatically disable the Crtl-F shortcut in RetroLab
+ * See https://github.com/jupyterlab/retrolab/pull/294 and
+ * https://github.com/jupyterlab/jupyterlab/issues/11754 for more context.
+ */
+const disableShortcut: JupyterFrontEndPlugin<void> = {
+  id: '@retrolab/documentsearch-extension:disableShortcut',
+  requires: [ISettingRegistry],
+  autoStart: true,
+  activate: async (app: JupyterFrontEnd, registry: ISettingRegistry) => {
+    const docSearchShortcut = registry.plugins[
+      '@jupyterlab/documentsearch-extension:plugin'
+    ]?.schema['jupyter.lab.shortcuts']?.find(
+      shortcut => shortcut.command === 'documentsearch:start'
+    );
+
+    if (docSearchShortcut) {
+      docSearchShortcut.disabled = true;
+      docSearchShortcut.keys = [];
+    }
+  }
+};
+
+/**
+ * A plugin to add document search functionalities.
+ */
+const retroShellWidgetListener: JupyterFrontEndPlugin<void> = {
+  id: '@retrolab/documentsearch-extension:retroShellWidgetListener',
+  requires: [IRetroShell, ISearchProviderRegistry],
+  autoStart: true,
+  activate: (
+    app: JupyterFrontEnd,
+    retroShell: IRetroShell,
+    registry: ISearchProviderRegistry
+  ) => {
+    // If a given widget is searchable, apply the searchable class.
+    // If it's not searchable, remove the class.
+    const transformWidgetSearchability = (widget: Widget | null) => {
+      if (!widget) {
+        return;
+      }
+      const providerForWidget = registry.getProviderForWidget(widget);
+      if (providerForWidget) {
+        widget.addClass(SEARCHABLE_CLASS);
+      }
+      if (!providerForWidget) {
+        widget.removeClass(SEARCHABLE_CLASS);
+      }
+    };
+
+    // Update searchability of the active widget when the registry
+    // changes, in case a provider for the current widget was added
+    // or removed
+    registry.changed.connect(() =>
+      transformWidgetSearchability(retroShell.currentWidget)
+    );
+
+    // Apply the searchable class only to the active widget if it is actually
+    // searchable. Remove the searchable class from a widget when it's
+    // no longer active.
+    retroShell.currentChanged.connect((_, args) => {
+      if (retroShell.currentWidget) {
+        transformWidgetSearchability(retroShell.currentWidget);
+      }
+    });
+  }
+};
+
+/**
+ * Export the plugins as default.
+ */
+const plugins: JupyterFrontEndPlugin<any>[] = [
+  disableShortcut,
+  retroShellWidgetListener
+];
+
+export default plugins;

packages/documentsearch-extension/style/index.css

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

packages/documentsearch-extension/style/index.js

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

packages/documentsearch-extension/tsconfig.json

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