xtralab 0.14.1 → 0.15.1

package/lib/fileBrowser/gitStatus.d.ts

@@ -1,13 +1,8 @@
 import type { GitStatusEntry } from '@pierre/trees';
 /**
- * Fetch the porcelain status for `repoPath` and convert it into a flat list
- * of `GitStatusEntry` values consumable by `FileTree.setGitStatus`. Returns
- * an empty array when the path is not in a git repo, the request fails, or
- * the server reports a non-zero exit — the file browser must still work
- * without git, so any error here is a no-op rather than a thrown exception.
- *
- * Files that have both a staged and an unstaged change are collapsed into a
- * single entry: the unstaged status wins because that mirrors what is
- * actually different on disk and matches VS Code's tree decoration behavior.
+ * Fetch the porcelain status for `repoPath` as `GitStatusEntry` values.
+ * Any failure yields an empty array — the file browser must work without
+ * git. A file both staged and unstaged gets one entry, the unstaged status
+ * winning (mirrors what is on disk, matching VS Code).
  */
 export declare function loadGitStatusEntries(repoPath: string): Promise<GitStatusEntry[]>;

package/lib/fileBrowser/gitStatus.js

@@ -1,10 +1,8 @@
 import { expandStatusFiles, status } from '../git/api';
 /**
- * Translate a `jupyterlab_git` porcelain status into the closest
- * `@pierre/trees` `GitStatus` enum value. The tree library only supports the
- * six common statuses (added, deleted, ignored, modified, renamed, untracked)
- * so the rare ones (unmerged, typechange, unknown) collapse onto `modified`
- * — they all denote a pending change the user should see decorated.
+ * Translate a `jupyterlab_git` porcelain status into a `@pierre/trees`
+ * `GitStatus`. The tree only supports the six common statuses, so the rare
+ * ones (unmerged, typechange, unknown) collapse onto `modified`.
  */
 function toTreeStatus(value) {
     switch (value) {
@@ -22,15 +20,10 @@ function toTreeStatus(value) {
     }
 }
 /**
- * Fetch the porcelain status for `repoPath` and convert it into a flat list
- * of `GitStatusEntry` values consumable by `FileTree.setGitStatus`. Returns
- * an empty array when the path is not in a git repo, the request fails, or
- * the server reports a non-zero exit — the file browser must still work
- * without git, so any error here is a no-op rather than a thrown exception.
- *
- * Files that have both a staged and an unstaged change are collapsed into a
- * single entry: the unstaged status wins because that mirrors what is
- * actually different on disk and matches VS Code's tree decoration behavior.
+ * Fetch the porcelain status for `repoPath` as `GitStatusEntry` values.
+ * Any failure yields an empty array — the file browser must work without
+ * git. A file both staged and unstaged gets one entry, the unstaged status
+ * winning (mirrors what is on disk, matching VS Code).
  */
 export async function loadGitStatusEntries(repoPath) {
     try {
@@ -39,9 +32,6 @@ export async function loadGitStatusEntries(repoPath) {
             return [];
         }
         const changes = expandStatusFiles(result.files);
-        // Collapse staged + unstaged into one decoration per file. Prefer the
-        // unstaged group when both exist; otherwise keep whichever group is
-        // present.
         const byPath = new Map();
         for (const change of changes) {
             if (change.group === 'unstaged' || !byPath.has(change.path)) {

package/lib/fileBrowser/gitignore.d.ts

@@ -8,22 +8,9 @@ import type { GitStatusEntry } from '@pierre/trees';
  */
 export declare function loadGitignoreMatcher(contentsManager: Contents.IManager): Promise<Ignore | null>;
 /**
- * Build `GitStatusEntry`s for the canonical paths that match the given
- * gitignore matcher.
- *
- * `@pierre/trees` propagates the `ignored` style from a directory entry
- * down to every descendant via its internal `ignoredDirectoryPaths` set, so
- * we only emit one entry per ignored subtree root: emitting descendants
- * would also pollute the library's `directoriesWithChanges` set, causing
- * parent directories of nested ignored items to render a "contains git
- * status items" dot.
- *
- * Paths are sorted lexicographically so a directory always precedes its
- * descendants, allowing a simple ancestor-suppression check via
- * `path.startsWith(dir)`. The trailing slash on canonical directory paths
- * (required by `@pierre/trees`, also recognized by `ignore` as the
- * "directory" indicator) keeps the prefix check from accidentally matching
- * sibling paths that happen to share a name prefix (e.g. `node_modules_old`
- * vs `node_modules/`).
+ * One `GitStatusEntry` per ignored subtree root: descendant entries would
+ * pollute the tree's `directoriesWithChanges` set (bogus dots on parents),
+ * and `ignored` already propagates downward. The trailing slash on directory
+ * paths keeps the sorted `startsWith` ancestor check off name-prefix siblings.
  */
 export declare function buildIgnoredEntries(matcher: Ignore, canonicalPaths: Iterable<string>): GitStatusEntry[];

package/lib/fileBrowser/gitignore.js

@@ -1,9 +1,4 @@
 import ignore from 'ignore';
-/**
- * The path of the workspace `.gitignore` file. Loaded relative to the
- * Jupyter contents root, which matches the directory the gitignore patterns
- * are evaluated against — patterns and tested paths share the same base.
- */
 const GITIGNORE_PATH = '.gitignore';
 /**
  * Load the workspace `.gitignore` and return an `ignore` matcher built from
@@ -20,9 +15,6 @@ export async function loadGitignoreMatcher(contentsManager) {
         });
     }
     catch (_a) {
-        // The most common failure here is `.gitignore` simply not existing.
-        // Other transient errors (permission denied, server unreachable) are
-        // also treated as "no matcher" so the file browser still works.
         return null;
     }
     if (model.type !== 'file' || typeof model.content !== 'string') {
@@ -34,23 +26,10 @@ export async function loadGitignoreMatcher(contentsManager) {
     return ignore().add(model.content);
 }
 /**
- * Build `GitStatusEntry`s for the canonical paths that match the given
- * gitignore matcher.
- *
- * `@pierre/trees` propagates the `ignored` style from a directory entry
- * down to every descendant via its internal `ignoredDirectoryPaths` set, so
- * we only emit one entry per ignored subtree root: emitting descendants
- * would also pollute the library's `directoriesWithChanges` set, causing
- * parent directories of nested ignored items to render a "contains git
- * status items" dot.
- *
- * Paths are sorted lexicographically so a directory always precedes its
- * descendants, allowing a simple ancestor-suppression check via
- * `path.startsWith(dir)`. The trailing slash on canonical directory paths
- * (required by `@pierre/trees`, also recognized by `ignore` as the
- * "directory" indicator) keeps the prefix check from accidentally matching
- * sibling paths that happen to share a name prefix (e.g. `node_modules_old`
- * vs `node_modules/`).
+ * One `GitStatusEntry` per ignored subtree root: descendant entries would
+ * pollute the tree's `directoriesWithChanges` set (bogus dots on parents),
+ * and `ignored` already propagates downward. The trailing slash on directory
+ * paths keeps the sorted `startsWith` ancestor check off name-prefix siblings.
  */
 export function buildIgnoredEntries(matcher, canonicalPaths) {
     const sorted = Array.from(canonicalPaths).sort();

package/lib/fileBrowser/icons.d.ts

@@ -1,26 +1,16 @@
 import { LabIcon } from '@jupyterlab/ui-components';
 import type { FileTreeIconConfig } from '@pierre/trees';
 /**
- * The glyph used as the xtralab file browser's sidebar tab icon. Defined as a
- * `LabIcon` (rather than the default `folderIcon` from
- * `@jupyterlab/ui-components`) so the xtralab browser is visually distinguishable
- * from JupyterLab's built-in file browser, which also lives in the left
- * sidebar.
- *
- * Source: `file-tree` from SVG Repo (https://www.svgrepo.com/svg/371275/file-tree).
- * The original `fill="#444"` is replaced with `fill="currentColor"` and the
- * root element is given the `jp-icon3` class so the icon picks up JupyterLab's
- * theme color and the sidebar's inverse-color painting automatically.
+ * Sidebar tab icon, distinct from the core `folderIcon` so the xtralab
+ * browser is distinguishable from the built-in one. `file-tree` from SVG Repo
+ * (https://www.svgrepo.com/svg/371275/file-tree), refit to follow the theme
+ * (`currentColor`, `jp-icon3`) and padded to the size of the stock glyphs.
  */
 export declare const xtralabFileBrowserIcon: LabIcon;
 /**
- * Icon configuration for the xtralab file browser. Keeps the default `complete`
- * built-in icon set (the colored language icons) and layers a Jupyter notebook
- * symbol on top so `.ipynb` files render with the JupyterLab notebook glyph.
- *
- * `set` must be set explicitly: when a config object includes any custom
- * overrides without `set`, `@pierre/trees` defaults `set` to `'none'`, which
- * disables the built-in icons entirely.
+ * Icon config: the built-in `complete` set plus the Jupyter notebook symbol
+ * for `.ipynb`. `set` must be explicit — with any custom overrides present,
+ * `@pierre/trees` defaults it to `'none'`, disabling the built-in icons.
  */
 export declare const FILE_BROWSER_ICONS: FileTreeIconConfig;
 /**

package/lib/fileBrowser/icons.js

@@ -2,36 +2,22 @@ var _a;
 import { LabIcon, fileIcon } from '@jupyterlab/ui-components';
 import { createFileTreeIconResolver, getBuiltInSpriteSheet } from '@pierre/trees';
 /**
- * The glyph used as the xtralab file browser's sidebar tab icon. Defined as a
- * `LabIcon` (rather than the default `folderIcon` from
- * `@jupyterlab/ui-components`) so the xtralab browser is visually distinguishable
- * from JupyterLab's built-in file browser, which also lives in the left
- * sidebar.
- *
- * Source: `file-tree` from SVG Repo (https://www.svgrepo.com/svg/371275/file-tree).
- * The original `fill="#444"` is replaced with `fill="currentColor"` and the
- * root element is given the `jp-icon3` class so the icon picks up JupyterLab's
- * theme color and the sidebar's inverse-color painting automatically.
+ * Sidebar tab icon, distinct from the core `folderIcon` so the xtralab
+ * browser is distinguishable from the built-in one. `file-tree` from SVG Repo
+ * (https://www.svgrepo.com/svg/371275/file-tree), refit to follow the theme
+ * (`currentColor`, `jp-icon3`) and padded to the size of the stock glyphs.
  */
 export const xtralabFileBrowserIcon = new LabIcon({
     name: 'xtralab:file-browser',
-    svgstr: `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" class="jp-icon3" fill="currentColor">
+    svgstr: `<svg xmlns="http://www.w3.org/2000/svg" viewBox="-2 -2 20 20" class="jp-icon3" fill="currentColor">
   <path d="M16 10v-4h-11v1h-2v-3h9v-4h-12v4h2v10h3v2h11v-4h-11v1h-2v-5h2v2z"/>
 </svg>`
 });
 /**
- * Sprite sheet injected into the `@pierre/trees` shadow DOM. Contains a single
- * `<symbol>` for the Jupyter notebook icon, drawn from the JupyterLab core
- * notebook icon (`@jupyterlab/ui-components/style/icons/filetype/notebook.svg`).
- *
- * `@pierre/trees` does not ship a Jupyter token, so `.ipynb` files would
- * otherwise fall through to the generic file icon. The symbol id below is
- * referenced from `byFileExtension` in {@link FILE_BROWSER_ICONS}.
- *
- * The orange `#EF6C00` fill is set as a presentation attribute on the inner
- * `<g>` so it survives the `fill: currentColor` rule the tree applies on the
- * icon container — the inherited color does not override a presentation
- * attribute set directly on a child.
+ * Sprite sheet injected into the tree's shadow DOM: the JupyterLab notebook
+ * glyph, since `@pierre/trees` ships no Jupyter token. The `#EF6C00` fill is
+ * a presentation attribute on the inner `<g>` so it survives the tree's
+ * `fill: currentColor` rule on the icon container.
  */
 const JUPYTER_NOTEBOOK_SPRITE_SHEET = `<svg data-icon-sprite aria-hidden="true" width="0" height="0">
   <symbol id="jupyter-notebook" viewBox="0 0 22 22">
@@ -42,13 +28,9 @@ const JUPYTER_NOTEBOOK_SPRITE_SHEET = `<svg data-icon-sprite aria-hidden="true"
   </symbol>
 </svg>`;
 /**
- * Icon configuration for the xtralab file browser. Keeps the default `complete`
- * built-in icon set (the colored language icons) and layers a Jupyter notebook
- * symbol on top so `.ipynb` files render with the JupyterLab notebook glyph.
- *
- * `set` must be set explicitly: when a config object includes any custom
- * overrides without `set`, `@pierre/trees` defaults `set` to `'none'`, which
- * disables the built-in icons entirely.
+ * Icon config: the built-in `complete` set plus the Jupyter notebook symbol
+ * for `.ipynb`. `set` must be explicit — with any custom overrides present,
+ * `@pierre/trees` defaults it to `'none'`, disabling the built-in icons.
  */
 export const FILE_BROWSER_ICONS = {
     set: 'complete',
@@ -58,39 +40,19 @@ export const FILE_BROWSER_ICONS = {
         ipynb: 'jupyter-notebook'
     }
 };
-/**
- * Concatenated sprite-sheet text. Combines the built-in sheet for the active
- * icon set with our custom Jupyter notebook sheet so {@link extractSymbol}
- * can find the body of any symbol the tree itself can render.
- */
 const COMBINED_SPRITE_SHEETS = [
     getBuiltInSpriteSheet((_a = FILE_BROWSER_ICONS.set) !== null && _a !== void 0 ? _a : 'complete'),
     JUPYTER_NOTEBOOK_SPRITE_SHEET
 ].join('\n');
-/**
- * Resolver instance reused across calls to {@link getTreeIcon}. The resolver
- * is pure relative to the icon config, so building it once at module load
- * avoids re-walking the icon rules on every diff that opens.
- */
 const treeIconResolver = createFileTreeIconResolver(FILE_BROWSER_ICONS);
 /**
- * Cache of LabIcons keyed by the resolved sprite symbol id (e.g.
- * `file-tree-builtin-python`). All Python files share the same icon, so
- * caching by symbol id prevents repeated LabIcon registration warnings and
- * keeps the JupyterLab icon registry small.
+ * LabIcons keyed by resolved symbol id — re-registering a LabIcon under the
+ * same name logs warnings.
  */
 const TREE_ICON_CACHE = new Map();
-/**
- * Extract the inner SVG markup and viewBox of the `<symbol>` with the given
- * id from {@link COMBINED_SPRITE_SHEETS}. Returns `null` if no matching
- * symbol exists, in which case the caller falls back to JupyterLab's default
- * file icon.
- */
 function extractSymbol(symbolId) {
     var _a;
-    // Match a `<symbol>` whose `id` attribute equals `symbolId` (allowing other
-    // attributes in any order). The `[\s\S]*?` body is non-greedy so we stop
-    // at the first matching `</symbol>` even when multiple symbols sit
+    // Non-greedy body: stop at the first `</symbol>` when symbols sit
     // back-to-back in the sheet.
     const escaped = symbolId.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
     const symbolRegex = new RegExp(`<symbol\\b[^>]*\\bid="${escaped}"[^>]*>([\\s\\S]*?)</symbol>`, 'i');
@@ -105,14 +67,10 @@ function extractSymbol(symbolId) {
     };
 }
 /**
- * Fallback colors for the built-in file icons, keyed by the icon token
- * `@pierre/trees` resolves for a path (e.g. `python`, `typescript`).
- *
- * The tree only exposes these as `--trees-file-icon-color-<token>` CSS
- * variables scoped to its shadow host, so they resolve to nothing for the
- * standalone {@link LabIcon}s {@link getTreeIcon} builds for main-area tabs.
- * Mirroring them here lets {@link getBuiltInFileIconColor} bottom out in a
- * real color. Each is a `light-dark(…)` pair for dark themes.
+ * Fallback colors keyed by the tree's icon token. The tree exposes its colors
+ * only as `--trees-file-icon-color-*` vars scoped to its shadow host, so the
+ * standalone LabIcons built for main-area tabs need these literals;
+ * `light-dark(…)` covers dark themes.
  */
 const BUILT_IN_FILE_ICON_COLOR_FALLBACKS = {
     astro: 'light-dark(#a631be, #d568ea)',
@@ -167,11 +125,8 @@ const BUILT_IN_FILE_ICON_COLOR_FALLBACKS = {
     zip: 'light-dark(#d47628, #ffa359)'
 };
 /**
- * Color the file tree would paint for the built-in icon `token`, as a
- * self-contained CSS value usable outside the tree's shadow DOM: the tree's
- * `--trees-file-icon-color-*` properties when in scope, else the literal from
- * {@link BUILT_IN_FILE_ICON_COLOR_FALLBACKS}. Returns `undefined` for unknown
- * tokens.
+ * The tree's color for `token` as a self-contained CSS value: its CSS vars
+ * when in scope, else the mirrored literal. `undefined` for unknown tokens.
  */
 function getBuiltInFileIconColor(token) {
     const fallback = BUILT_IN_FILE_ICON_COLOR_FALLBACKS[token];
@@ -180,9 +135,6 @@ function getBuiltInFileIconColor(token) {
     }
     return `var(--trees-file-icon-color-${token}, var(--trees-file-icon-color, ${fallback}))`;
 }
-/**
- * Resolve a tree glyph into a standalone `LabIcon`.
- */
 function resolveTreeIcon(filePath) {
     var _a;
     const resolved = treeIconResolver.resolveIcon('file-tree-icon-file', filePath);
@@ -196,22 +148,15 @@ function resolveTreeIcon(filePath) {
     if (symbol === null) {
         return { icon: null, specific };
     }
-    // Built-in language icons paint with `fill="currentColor"` so the colored
-    // tier of the tree can recolor them by setting `color` on the host
-    // element. Reproduce that here by setting the same color value as an
-    // inline `style="color: …"` on the outer `<svg>`. `getBuiltInFileIconColor`
-    // returns a `var(--trees-…)` chain that bottoms out in `light-dark(…)`,
-    // which respects the page's `color-scheme` declaration so dark themes pick
-    // up the brighter variants automatically.
+    // Built-in glyphs paint with `fill="currentColor"`; an inline `color`
+    // style reproduces the tree's colored tier outside its shadow DOM.
     const colored = FILE_BROWSER_ICONS.colored === true;
     const color = colored && resolved.token !== undefined
         ? getBuiltInFileIconColor(resolved.token)
         : undefined;
     const styleAttr = color !== undefined ? ` style="color: ${color};"` : '';
-    // Prefer a viewBox the resolver supplies (custom sprite overrides may set
-    // one), then fall back to the symbol's own viewBox so 22x22 sprites like
-    // the Jupyter notebook glyph render at the right scale rather than being
-    // cropped to a 16x16 box.
+    // Prefer the resolver's viewBox, then the symbol's own, so 22x22 sprites
+    // like the notebook glyph aren't cropped to a 16x16 box.
     const viewBox = (_a = resolved.viewBox) !== null && _a !== void 0 ? _a : symbol.viewBox;
     const svgstr = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="${viewBox}"${styleAttr}>${symbol.inner}</svg>`;
     const icon = new LabIcon({

package/lib/fileBrowser/index.js

@@ -1,10 +1,10 @@
 import { ILayoutRestorer } from '@jupyterlab/application';
-import { ICommandPalette } from '@jupyterlab/apputils';
+import { ICommandPalette, IMovableSectionRegistry } from '@jupyterlab/apputils';
 import { IDocumentManager } from '@jupyterlab/docmanager';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
-import { ITranslator } from '@jupyterlab/translation';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { populateToolbar, registerCommands } from './commands';
-import { XtralabFileBrowser } from './widget';
+import { FILE_BROWSER_ID, XtralabFileBrowser } from './widget';
 const PLUGIN_ID = 'xtralab:plugin';
 /**
  * The file browser plugin. Adds a `@pierre/trees`-powered file browser to the
@@ -15,25 +15,56 @@ const plugin = {
     description: 'A path-first file browser for JupyterLab built on @pierre/trees.',
     autoStart: true,
     requires: [IDocumentManager],
-    optional: [ILayoutRestorer, ISettingRegistry, ICommandPalette, ITranslator],
-    activate: (app, docManager, restorer, settingRegistry, palette, translator) => {
+    optional: [
+        ILayoutRestorer,
+        ISettingRegistry,
+        ICommandPalette,
+        ITranslator,
+        IMovableSectionRegistry
+    ],
+    activate: (app, docManager, restorer, settingRegistry, palette, translator, movableSections) => {
         const browser = new XtralabFileBrowser({
             contentsManager: app.serviceManager.contents,
             docManager,
             onOpenFile: (serverPath) => {
                 void app.commands.execute('docmanager:open', { path: serverPath });
-            }
+            },
+            translator: translator !== null && translator !== void 0 ? translator : undefined
         });
-        // Ranks just under the Terminals panel in the left sidebar. The shipped
-        // `layout` setting assigns the default ranks (rank only, no area pin),
-        // so this browser stays movable via the "Move Widget" context menu; the
-        // `rank` here is the in-code fallback for when that setting is absent.
+        // Rank-only fallback for when the shipped `layout` setting is absent;
+        // no area pin, so the browser stays movable via "Move Widget".
         app.shell.add(browser, 'left', { rank: 2 });
         if (restorer) {
             restorer.add(browser, browser.id);
         }
         registerCommands({ app, browser, docManager, palette, translator });
         populateToolbar({ app, browser });
+        if (movableSections) {
+            const label = (translator !== null && translator !== void 0 ? translator : nullTranslator)
+                .load('jupyterlab')
+                .__('Files');
+            movableSections.registerSource(FILE_BROWSER_ID, label, browser);
+            movableSections.registerTarget(FILE_BROWSER_ID, label, browser);
+            // Only a user move should switch the sidebar, not the startup restoration.
+            let settled = false;
+            void app.restored.then(() => {
+                settled = true;
+            });
+            browser.contentChanged.connect(() => {
+                if (browser.isEmpty) {
+                    if (browser.parent) {
+                        browser.parent = null;
+                    }
+                }
+                else if (!browser.parent) {
+                    app.shell.add(browser, 'left', { rank: 2 });
+                    if (settled) {
+                        app.shell.activateById(browser.id);
+                    }
+                }
+            });
+            browser.announceSections();
+        }
         if (settingRegistry) {
             settingRegistry.load(PLUGIN_ID).catch(reason => {
                 console.error('Failed to load settings for xtralab.', reason);