xtralab 0.11.1 → 0.12.0

package/lib/walkthrough/panel.d.ts

@@ -4,12 +4,16 @@ import type { CommandRegistry } from '@lumino/commands';
 import type { ReadonlyPartialJSONValue } from '@lumino/coreutils';
 import type { Message } from '@lumino/messaging';
 import { Panel } from '@lumino/widgets';
-/** A rich visual embedded in a step (rendered through the rendermime registry). */
+/**
+ * A rich visual embedded in a step (rendered through the rendermime registry).
+ */
 export interface IWalkthroughMedia {
     mimeType: string;
     data: ReadonlyPartialJSONValue;
 }
-/** One step of a walkthrough. Every field is optional, but a step needs at least one. */
+/**
+ * One step of a walkthrough. Every field is optional, but a step needs at least one.
+ */
 export interface IWalkthroughStep {
     title?: string;
     body?: string;
@@ -36,7 +40,9 @@ export declare namespace WalkthroughPanel {
  */
 export declare class WalkthroughPanel extends Panel {
     constructor(options: WalkthroughPanel.IOptions);
-    /** Remove every step, leaving an empty panel. */
+    /**
+     * Remove every step, leaving an empty panel.
+     */
     clear(): void;
     /**
      * Dispose on close (e.g. the close button when the panel has been dragged to
@@ -44,7 +50,9 @@ export declare class WalkthroughPanel extends Panel {
      * next `xtralab:walkthrough` call recreates the panel in the side area.
      */
     protected onCloseRequest(msg: Message): void;
-    /** Append a step and scroll it into view. */
+    /**
+     * Append a step and scroll it into view.
+     */
     addStep(step: IWalkthroughStep): Promise<void>;
     private _render;
     private _jumpButton;

package/lib/walkthrough/panel.js

@@ -1,6 +1,8 @@
 import { fileIcon } from '@jupyterlab/ui-components';
 import { Panel, Widget } from '@lumino/widgets';
-/** Command the jump links dispatch; keeps the panel decoupled from the plugin. */
+/**
+ * Command the jump links dispatch; keeps the panel decoupled from the plugin.
+ */
 const HIGHLIGHT_LINES_COMMAND = 'xtralab:highlight-lines';
 /**
  * A read-only, scrollable column of walkthrough steps for the side area.
@@ -19,7 +21,9 @@ export class WalkthroughPanel extends Panel {
         this._trans = options.trans;
         this.addClass('jp-xtralab-Walkthrough');
     }
-    /** Remove every step, leaving an empty panel. */
+    /**
+     * Remove every step, leaving an empty panel.
+     */
     clear() {
         while (this.widgets.length > 0) {
             this.widgets[0].dispose();
@@ -34,7 +38,9 @@ export class WalkthroughPanel extends Panel {
         super.onCloseRequest(msg);
         this.dispose();
     }
-    /** Append a step and scroll it into view. */
+    /**
+     * Append a step and scroll it into view.
+     */
     async addStep(step) {
         const card = new Panel();
         card.addClass('jp-xtralab-Walkthrough-step');

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "xtralab",
-    "version": "0.11.1",
+    "version": "0.12.0",
     "description": "An opinionated JupyterLab meta-package that bundles a curated set of extensions, ships a path-first file browser, renders jupyterlab-git's text, notebook and image diffs with its own viewers, and applies a quieter default workspace configuration.",
     "keywords": [
         "jupyter",
@@ -58,65 +58,61 @@
         "watch:labextension": "jupyter-builder watch ."
     },
     "dependencies": {
-        "@codemirror/language": "^6.12.1",
-        "@codemirror/state": "^6.5.4",
-        "@codemirror/view": "^6.39.14",
-        "@jupyterlab/application": "^4.6.0-beta.0",
-        "@jupyterlab/apputils": "^4.7.0-beta.0",
-        "@jupyterlab/codemirror": "^4.6.0-beta.0",
-        "@jupyterlab/coreutils": "^6.6.0-beta.0",
-        "@jupyterlab/docmanager": "^4.6.0-beta.0",
-        "@jupyterlab/docregistry": "^4.6.0-beta.0",
-        "@jupyterlab/git": "^0.54.0-a1",
-        "@jupyterlab/launcher": "^4.6.0-beta.0",
-        "@jupyterlab/mainmenu": "^4.6.0-beta.0",
-        "@jupyterlab/nbformat": "^4.6.0-beta.0",
-        "@jupyterlab/outputarea": "^4.6.0-beta.0",
-        "@jupyterlab/rendermime": "^4.6.0-beta.0",
-        "@jupyterlab/services": "^7.6.0-beta.0",
-        "@jupyterlab/settingregistry": "^4.6.0-beta.0",
-        "@jupyterlab/terminal": "^4.6.0-beta.0",
-        "@jupyterlab/translation": "^4.6.0-beta.0",
-        "@jupyterlab/ui-components": "^4.6.0-beta.0",
-        "@lumino/algorithm": "^2.0.0",
-        "@lumino/commands": "^2.0.0",
-        "@lumino/coreutils": "^2.0.0",
-        "@lumino/disposable": "^2.0.0",
-        "@lumino/dragdrop": "^2.0.0",
-        "@lumino/messaging": "^2.0.0",
+        "@codemirror/language": "^6.12.3",
+        "@codemirror/state": "^6.7.0",
+        "@codemirror/view": "^6.43.2",
+        "@jupyterlab/application": "^4.6.0",
+        "@jupyterlab/apputils": "^4.7.0",
+        "@jupyterlab/codemirror": "^4.6.0",
+        "@jupyterlab/coreutils": "^6.6.0",
+        "@jupyterlab/docmanager": "^4.6.0",
+        "@jupyterlab/docregistry": "^4.6.0",
+        "@jupyterlab/fileeditor": "^4.6.0",
+        "@jupyterlab/git": "^0.54.0",
+        "@jupyterlab/mainmenu": "^4.6.0",
+        "@jupyterlab/nbformat": "^4.6.0",
+        "@jupyterlab/notebook": "^4.6.0",
+        "@jupyterlab/outputarea": "^4.6.0",
+        "@jupyterlab/rendermime": "^4.6.0",
+        "@jupyterlab/services": "^7.6.0",
+        "@jupyterlab/settingregistry": "^4.6.0",
+        "@jupyterlab/statedb": "^4.6.0",
+        "@jupyterlab/terminal": "^4.6.0",
+        "@jupyterlab/translation": "^4.6.0",
+        "@jupyterlab/ui-components": "^4.6.0",
+        "@lumino/algorithm": "^2.0.4",
+        "@lumino/commands": "^2.3.3",
+        "@lumino/coreutils": "^2.2.2",
+        "@lumino/disposable": "^2.1.5",
+        "@lumino/dragdrop": "^2.1.8",
+        "@lumino/messaging": "^2.0.4",
         "@lumino/polling": "^2.1.5",
-        "@lumino/signaling": "^2.0.0",
-        "@lumino/widgets": "^2.0.0",
-        "@pierre/diffs": "^1.2.7",
+        "@lumino/signaling": "^2.1.5",
+        "@lumino/widgets": "^2.8.0",
+        "@pierre/diffs": "^1.2.11",
         "@pierre/trees": "1.0.0-beta.4",
         "detect-indent": "^7.0.2",
         "ignore": "^5.3.2",
-        "react": "^18.2.0",
-        "react-dom": "^18.2.0"
+        "react": "^18.3.1"
     },
     "devDependencies": {
-        "@jupyter/builder": "^1.0.0-beta.1",
-        "@types/json-schema": "^7.0.11",
-        "@types/react": "^18.0.26",
-        "@types/react-addons-linked-state-mixin": "^0.14.22",
-        "@typescript-eslint/eslint-plugin": "^6.1.0",
-        "@typescript-eslint/parser": "^6.1.0",
-        "css-loader": "^6.7.1",
-        "eslint": "^8.36.0",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-plugin-prettier": "^5.0.0",
-        "npm-run-all2": "^7.0.1",
-        "prettier": "^3.0.0",
-        "rimraf": "^5.0.1",
-        "source-map-loader": "^1.0.2",
-        "style-loader": "^3.3.1",
-        "stylelint": "^15.10.1",
+        "@jupyter/builder": "^1.0.2",
+        "@types/react": "^18.3.31",
+        "@typescript-eslint/eslint-plugin": "^6.21.0",
+        "@typescript-eslint/parser": "^6.21.0",
+        "eslint": "^8.57.1",
+        "eslint-config-prettier": "^8.10.2",
+        "eslint-plugin-prettier": "^5.5.6",
+        "npm-run-all2": "^7.0.2",
+        "prettier": "^3.8.4",
+        "rimraf": "^5.0.10",
+        "stylelint": "^15.11.0",
         "stylelint-config-recommended": "^13.0.0",
         "stylelint-config-standard": "^34.0.0",
-        "stylelint-csstree-validator": "^3.0.0",
-        "stylelint-prettier": "^4.0.0",
+        "stylelint-csstree-validator": "^3.1.0",
+        "stylelint-prettier": "^4.1.0",
         "typescript": "~5.5.4",
-        "yjs": "^13.5.0"
+        "yjs": "^13.6.31"
     },
     "pnpm": {
         "ignoredBuiltDependencies": [
@@ -153,6 +149,8 @@
         "dist",
         "coverage",
         "**/*.d.ts",
+        "docs",
+        "ui-tests",
         "desktop/out",
         "desktop/dist",
         "desktop/python/wheels",

package/schema/command-bar.json

@@ -0,0 +1,10 @@
+{
+  "title": "xtralab Command Bar",
+  "description": "The search-bar-styled pill in the top bar that opens the omnibox.",
+  "jupyter.lab.toolbars": {
+    "TopBar": [{ "name": "omnibox", "rank": 100 }]
+  },
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

package/schema/omnibox.json

@@ -0,0 +1,15 @@
+{
+  "title": "xtralab Omnibox",
+  "description": "The launcher overlay that searches files and commands and prompts agents.",
+  "type": "object",
+  "properties": {
+    "maxNumberRecents": {
+      "type": "integer",
+      "title": "Recent items number",
+      "description": "Number of recently used commands and files (each) the omnibox remembers and shows at the top before you type a query. Set to 0 to disable recent items.",
+      "default": 5,
+      "minimum": 0
+    }
+  },
+  "additionalProperties": false
+}

package/src/agentSessions.ts

@@ -28,10 +28,14 @@ export interface IAgentSessions {
    */
   get(sessionName: string): string | null;
 
-  /** Record that a session was launched as the given agent command. */
+  /**
+   * Record that a session was launched as the given agent command.
+   */
   set(sessionName: string, command: string): void;
 
-  /** Forget a session — called when it shuts down so the map stays bounded. */
+  /**
+   * Forget a session — called when it shuts down so the map stays bounded.
+   */
   delete(sessionName: string): void;
 
   /**

package/src/askAgent/editorSelection.ts

@@ -0,0 +1,138 @@
+import type { JupyterFrontEnd } from '@jupyterlab/application';
+import { CodeMirrorEditor } from '@jupyterlab/codemirror';
+import { FileEditor } from '@jupyterlab/fileeditor';
+import { NotebookPanel } from '@jupyterlab/notebook';
+import type { EditorView } from '@codemirror/view';
+import type { Widget } from '@lumino/widgets';
+
+import type { IAskAgentContext, IAskAgentRequest } from './tokens';
+
+/**
+ * A CodeMirror view a selection can be asked about, plus the context needed
+ * to describe it to an agent: the document path and, for notebooks, which
+ * cell the view belongs to.
+ */
+interface IEditorTarget {
+  view: EditorView;
+  path: string;
+  cell?: {
+    index: number;
+    type: string;
+  };
+}
+
+/**
+ * Resolve the CodeMirror view a selection in `widget` would live in, or
+ * `null` when the widget holds no such editor. Two widget shapes are
+ * recognized:
+ *
+ * - a notebook panel, where the active cell carries the editor and
+ *   `activeCellIndex` names its 0-based position in the nbformat `cells`
+ *   array. A rendered markdown cell keeps its (hidden) editor, but a
+ *   selection in the rendered HTML never passes {@link domSelectionInView},
+ *   so no pill appears there; and
+ * - a document widget whose content is a `FileEditor`. The wrapper is not
+ *   checked with `instanceof DocumentWidget`: `@jupyterlab/docregistry` is
+ *   not a core singleton, so another copy of the class could be in play.
+ *   `FileEditor` and `NotebookPanel` come from singleton packages.
+ */
+export function resolveEditorTarget(
+  widget: Widget | null
+): IEditorTarget | null {
+  if (widget instanceof NotebookPanel) {
+    const cell = widget.content.activeCell;
+    if (cell !== null && cell.editor instanceof CodeMirrorEditor) {
+      return {
+        view: cell.editor.editor,
+        path: widget.context.path,
+        cell: { index: widget.content.activeCellIndex, type: cell.model.type }
+      };
+    }
+    return null;
+  }
+
+  const content = (widget as { content?: unknown } | null)?.content;
+  if (
+    content instanceof FileEditor &&
+    content.editor instanceof CodeMirrorEditor
+  ) {
+    return { view: content.editor.editor, path: content.context.path };
+  }
+
+  return null;
+}
+
+/**
+ * Whether the current DOM selection lives inside `view`. Guards the
+ * selection-change listener against selections made elsewhere (a terminal,
+ * a sidebar, another notebook cell) while the widget owning `view` happens
+ * to be the shell's current widget.
+ */
+export function domSelectionInView(
+  view: EditorView,
+  selection: Selection
+): boolean {
+  const node = selection.anchorNode;
+  const element =
+    node instanceof Element ? node : (node?.parentElement ?? null);
+  return element !== null && view.dom.contains(element);
+}
+
+/**
+ * Build an ask-agent request from the current selection in the shell's
+ * current widget — a file editor or the active notebook cell — or return
+ * `null` when that widget holds no CodeMirror document editor.
+ *
+ * With `allowEmpty`, a collapsed selection falls back to the cursor's line
+ * (used by the command/shortcut path so it works without a mouse
+ * selection); otherwise an empty selection yields `null`.
+ */
+export function editorAskRequest(
+  app: JupyterFrontEnd,
+  options: { allowEmpty?: boolean } = {}
+): IAskAgentRequest | null {
+  const target = resolveEditorTarget(app.shell.currentWidget);
+  if (target === null) {
+    return null;
+  }
+
+  const { view, path, cell } = target;
+  const { state } = view;
+  const main = state.selection.main;
+  if (main.empty && options.allowEmpty !== true) {
+    return null;
+  }
+
+  const startLine = state.doc.lineAt(main.from).number;
+  let endLine: number;
+  let text: string;
+  if (main.empty) {
+    endLine = startLine;
+    text = state.doc.lineAt(main.from).text;
+  } else {
+    // A selection that ends exactly at the start of a line (the common
+    // "drag over whole lines" gesture) should not count that line.
+    const endPos =
+      main.to === state.doc.lineAt(main.to).from ? main.to - 1 : main.to;
+    endLine = state.doc.lineAt(endPos).number;
+    text = state.sliceDoc(main.from, main.to);
+  }
+
+  // Anchor the popup at the selection head (where the cursor ended up).
+  // `coordsAtPos` returns `null` for positions scrolled out of view.
+  const coords = view.coordsAtPos(main.head);
+  const anchor = coords
+    ? new DOMRect(
+        coords.left,
+        coords.top,
+        Math.max(1, coords.right - coords.left),
+        Math.max(1, coords.bottom - coords.top)
+      )
+    : null;
+
+  const context: IAskAgentContext = { path, startLine, endLine, text };
+  if (cell !== undefined) {
+    context.cell = cell;
+  }
+  return { context, anchor };
+}

package/src/askAgent/icons.ts

@@ -0,0 +1,16 @@
+import { LabIcon } from '@jupyterlab/ui-components';
+
+/**
+ * Four-point sparkle used by the ask-agent affordances (selection pill,
+ * command palette entry). Drawn in-repo; the `jp-icon3` class lets the
+ * active theme recolor the glyph like other JupyterLab UI icons.
+ */
+export const askAgentIcon = new LabIcon({
+  name: 'xtralab:ask-agent',
+  svgstr: `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16">
+  <g class="jp-icon3" fill="#616161">
+    <path d="M6 1l1 4 4 1-4 1-1 4-1-4-4-1 4-1 1-4z"/>
+    <path d="M12 9l.7 2.3L15 12l-2.3.7L12 15l-.7-2.3L9 12l2.3-.7L12 9z"/>
+  </g>
+</svg>`
+});