xtralab 0.4.0 → 0.5.0

package/lib/git/panelComponent.js

@@ -1,320 +0,0 @@
-import * as React from 'react';
-import { Poll } from '@lumino/polling';
-import { add, addAll, checkout, porcelainToFileChanges, reset, resetAll, showTopLevel, status } from './api';
-/**
- * The polling interval for the panel. We refresh the status periodically so
- * out-of-band changes (e.g. the user runs `git add` from a terminal) become
- * visible without requiring a manual refresh.
- */
-const STATUS_POLL_INTERVAL_MS = 5000;
-/**
- * Upper bound on the poll's exponential backoff when status requests fail
- * repeatedly. Matches the default JupyterLab file browser's `max`: long
- * enough that a server outage stops hammering the API, short enough that
- * a transient failure heals on its own.
- */
-const STATUS_POLL_MAX_MS = 300000;
-/**
- * Top-level React component rendered inside the {@link GitPanel} widget.
- * Owns the polling + refresh wiring around the `/git/status` endpoint and
- * the small bit of UI state that controls section collapse and the
- * in-flight per-file action spinners.
- */
-export function GitPanelComponent(props) {
-    const { handlers, refreshSignal } = props;
-    const [state, setState] = React.useState({
-        loading: true,
-        result: null,
-        error: null
-    });
-    // The absolute filesystem path of the resolved git top-level. Used purely
-    // for display in the panel header.
-    const [topLevel, setTopLevel] = React.useState(null);
-    // Per-action spinner gating: keyed by `${group}:${path}`, value is the
-    // action currently in flight. Lets the row render a disabled state on
-    // exactly the file that is being mutated, without locking the whole panel.
-    const [pendingActions, setPendingActions] = React.useState({});
-    const [stagedCollapsed, setStagedCollapsed] = React.useState(false);
-    const [changesCollapsed, setChangesCollapsed] = React.useState(false);
-    // The repo path passed to every API call. We use the JupyterLab server's
-    // root (the empty string) and let `git` resolve the enclosing repo on the
-    // server side. This works as long as the server was started inside a git
-    // repo — the common case.
-    const repoPath = '';
-    const refresh = React.useCallback(async () => {
-        var _a;
-        try {
-            const [topLevelResult, statusResult] = await Promise.all([
-                showTopLevel(repoPath),
-                status(repoPath)
-            ]);
-            setTopLevel(topLevelResult);
-            if (statusResult.code !== 0) {
-                setState({
-                    loading: false,
-                    result: null,
-                    error: (_a = statusResult.message) !== null && _a !== void 0 ? _a : 'Failed to load git status'
-                });
-                return;
-            }
-            setState({ loading: false, result: statusResult, error: null });
-        }
-        catch (err) {
-            setState({
-                loading: false,
-                result: null,
-                error: err instanceof Error ? err.message : String(err)
-            });
-        }
-    }, [repoPath]);
-    // Initial load + polling. Driven by a Lumino `Poll` so the panel stops
-    // hitting the git endpoint while the JupyterLab tab is hidden, and so
-    // repeated failures back off exponentially instead of spinning at 5s.
-    // External refresh triggers (toolbar button, plugin-level events) call
-    // `poll.refresh()` to schedule an immediate tick instead of running
-    // `refresh()` directly — that keeps the panel from issuing two parallel
-    // status requests when an automatic tick happens to land at the same
-    // time as an external trigger.
-    React.useEffect(() => {
-        const poll = new Poll({
-            name: '@xtralab/git:panelStatus',
-            factory: () => refresh(),
-            frequency: {
-                interval: STATUS_POLL_INTERVAL_MS,
-                backoff: true,
-                max: STATUS_POLL_MAX_MS
-            },
-            standby: 'when-hidden'
-        });
-        const handler = () => {
-            void poll.refresh();
-        };
-        refreshSignal.connect(handler);
-        return () => {
-            refreshSignal.disconnect(handler);
-            poll.dispose();
-        };
-    }, [refresh, refreshSignal]);
-    const runAction = React.useCallback(async (change, action, run) => {
-        const key = `${change.group}:${change.path}`;
-        setPendingActions(prev => ({ ...prev, [key]: action }));
-        try {
-            await run();
-            await refresh();
-        }
-        catch (err) {
-            await handlers.showError('Git operation failed', err instanceof Error ? err : new Error(String(err)));
-        }
-        finally {
-            setPendingActions(prev => {
-                const next = { ...prev };
-                delete next[key];
-                return next;
-            });
-        }
-    }, [handlers, refresh]);
-    const onStage = React.useCallback((change) => runAction(change, 'stage', () => add(repoPath, change.path)), [repoPath, runAction]);
-    const onUnstage = React.useCallback((change) => runAction(change, 'unstage', () => reset(repoPath, change.path)), [repoPath, runAction]);
-    const onDiscard = React.useCallback(async (change) => {
-        const verb = change.status === 'untracked' ? 'remove' : 'restore';
-        const accepted = await handlers.confirm(verb === 'remove' ? 'Remove file' : 'Discard changes', verb === 'remove'
-            ? `Permanently remove ${change.path}? This cannot be undone.`
-            : `Discard all changes to ${change.path}? This will revert the file to its last staged version and cannot be undone.`, verb === 'remove' ? 'Remove' : 'Discard');
-        if (!accepted) {
-            return;
-        }
-        // The git extension's `checkout` endpoint without a branch reverts the
-        // working tree copy of the file to the index. For untracked files we
-        // can't checkout, so the user is told the action is unsupported and we
-        // bail out — they can delete the file via the file browser instead.
-        if (change.status === 'untracked') {
-            await handlers.showError('Cannot discard untracked file', new Error('Untracked files cannot be discarded from the git panel — delete them from the file browser instead.'));
-            return;
-        }
-        await runAction(change, 'discard', () => checkout(repoPath, change.path));
-    }, [handlers, repoPath, runAction]);
-    const onStageAll = React.useCallback(async () => {
-        try {
-            await addAll(repoPath);
-            await refresh();
-        }
-        catch (err) {
-            await handlers.showError('Stage all failed', err instanceof Error ? err : new Error(String(err)));
-        }
-    }, [handlers, refresh, repoPath]);
-    const onUnstageAll = React.useCallback(async () => {
-        try {
-            await resetAll(repoPath);
-            await refresh();
-        }
-        catch (err) {
-            await handlers.showError('Unstage all failed', err instanceof Error ? err : new Error(String(err)));
-        }
-    }, [handlers, refresh, repoPath]);
-    // Categorize the porcelain entries into the two visible groups. Because
-    // `porcelainToFileChanges` may emit two changes per file (one staged, one
-    // unstaged), the same file can show up in both lists when it has been
-    // partially staged.
-    const { staged, unstaged } = React.useMemo(() => {
-        const stagedAcc = [];
-        const unstagedAcc = [];
-        if (state.result === null) {
-            return { staged: stagedAcc, unstaged: unstagedAcc };
-        }
-        for (const file of state.result.files) {
-            for (const change of porcelainToFileChanges(file)) {
-                if (change.group === 'staged') {
-                    stagedAcc.push(change);
-                }
-                else {
-                    unstagedAcc.push(change);
-                }
-            }
-        }
-        stagedAcc.sort((a, b) => a.path.localeCompare(b.path));
-        unstagedAcc.sort((a, b) => a.path.localeCompare(b.path));
-        return { staged: stagedAcc, unstaged: unstagedAcc };
-    }, [state.result]);
-    return (React.createElement("div", { className: "jp-xtralab-GitPanel-content" },
-        React.createElement(PanelHeader, { topLevel: topLevel, result: state.result, loading: state.loading, error: state.error, onRefresh: () => void refresh() }),
-        state.error !== null ? (React.createElement("div", { className: "jp-xtralab-GitPanel-error" }, state.error)) : (React.createElement(React.Fragment, null,
-            React.createElement(ChangeSection, { label: "Staged Changes", count: staged.length, collapsed: stagedCollapsed, onToggleCollapsed: () => setStagedCollapsed(c => !c), actions: staged.length > 0
-                    ? [
-                        {
-                            label: 'Unstage all changes',
-                            symbol: '−',
-                            onClick: onUnstageAll
-                        }
-                    ]
-                    : undefined }, staged.map(change => (React.createElement(ChangeRow, { key: `${change.group}:${change.path}`, change: change, pendingAction: pendingActions[`${change.group}:${change.path}`], onClick: event => handlers.openDiff(change, {
-                    pin: event.ctrlKey || event.metaKey
-                }), actions: [
-                    {
-                        label: 'Unstage changes',
-                        symbol: '−',
-                        onClick: () => void onUnstage(change)
-                    }
-                ] })))),
-            React.createElement(ChangeSection, { label: "Changes", count: unstaged.length, collapsed: changesCollapsed, onToggleCollapsed: () => setChangesCollapsed(c => !c), actions: unstaged.length > 0
-                    ? [
-                        {
-                            label: 'Stage all changes',
-                            symbol: '+',
-                            onClick: onStageAll
-                        }
-                    ]
-                    : undefined }, unstaged.map(change => (React.createElement(ChangeRow, { key: `${change.group}:${change.path}`, change: change, pendingAction: pendingActions[`${change.group}:${change.path}`], onClick: event => handlers.openDiff(change, {
-                    pin: event.ctrlKey || event.metaKey
-                }), actions: [
-                    {
-                        label: 'Discard changes',
-                        symbol: '⟲',
-                        onClick: () => void onDiscard(change)
-                    },
-                    {
-                        label: 'Stage changes',
-                        symbol: '+',
-                        onClick: () => void onStage(change)
-                    }
-                ] })))),
-            staged.length === 0 && unstaged.length === 0 && !state.loading ? (React.createElement("div", { className: "jp-xtralab-GitPanel-empty" }, "No changes detected.")) : null))));
-}
-function PanelHeader(props) {
-    var _a;
-    const { topLevel, result, loading, error, onRefresh } = props;
-    const repoName = topLevel !== null
-        ? ((_a = topLevel
-            .split('/')
-            .filter(s => s.length > 0)
-            .pop()) !== null && _a !== void 0 ? _a : topLevel)
-        : null;
-    return (React.createElement("div", { className: "jp-xtralab-GitPanel-header" },
-        React.createElement("div", { className: "jp-xtralab-GitPanel-headerInfo" },
-            repoName !== null ? (React.createElement("div", { className: "jp-xtralab-GitPanel-repo", title: topLevel !== null && topLevel !== void 0 ? topLevel : '' }, repoName)) : null,
-            (result === null || result === void 0 ? void 0 : result.branch) !== undefined && (result === null || result === void 0 ? void 0 : result.branch) !== null ? (React.createElement("div", { className: "jp-xtralab-GitPanel-branch" },
-                result.branch,
-                result.ahead > 0 ? React.createElement("span", null,
-                    " \u2191",
-                    result.ahead) : null,
-                result.behind > 0 ? React.createElement("span", null,
-                    " \u2193",
-                    result.behind) : null)) : null),
-        React.createElement("button", { type: "button", className: "jp-xtralab-GitPanel-iconButton", title: "Refresh", disabled: loading && error === null, onClick: onRefresh }, "\u27F3")));
-}
-function ChangeSection(props) {
-    const { label, count, collapsed, onToggleCollapsed, actions, children } = props;
-    return (React.createElement("div", { className: "jp-xtralab-GitPanel-section" },
-        React.createElement("div", { className: "jp-xtralab-GitPanel-sectionHeader", onClick: onToggleCollapsed },
-            React.createElement("span", { className: "jp-xtralab-GitPanel-sectionChevron" }, collapsed ? '▸' : '▾'),
-            React.createElement("span", { className: "jp-xtralab-GitPanel-sectionLabel" }, label),
-            actions !== undefined ? (React.createElement("span", { className: "jp-xtralab-GitPanel-sectionActions" }, actions.map(action => (React.createElement("button", { key: action.label, type: "button", className: "jp-xtralab-GitPanel-iconButton", title: action.label, onClick: event => {
-                    event.stopPropagation();
-                    action.onClick();
-                } }, action.symbol))))) : null,
-            React.createElement("span", { className: "jp-xtralab-GitPanel-sectionCount" }, count)),
-        !collapsed ? (React.createElement("div", { className: "jp-xtralab-GitPanel-sectionBody" }, children)) : null));
-}
-function ChangeRow(props) {
-    const { change, pendingAction, onClick, actions } = props;
-    const filename = basename(change.path);
-    const dirname = dirnameOrEmpty(change.path);
-    return (React.createElement("div", { className: "jp-xtralab-GitPanel-row", "data-status": change.status, title: change.from !== undefined
-            ? `${change.from} → ${change.path}`
-            : change.path, onClick: onClick },
-        React.createElement("span", { className: "jp-xtralab-GitPanel-rowLabel" },
-            React.createElement("span", { className: "jp-xtralab-GitPanel-rowName" }, filename),
-            dirname !== '' ? (React.createElement("span", { className: "jp-xtralab-GitPanel-rowPath" }, dirname)) : null),
-        React.createElement("span", { className: "jp-xtralab-GitPanel-rowActions", "data-pending": pendingAction !== undefined }, actions.map(action => (React.createElement("button", { key: action.label, type: "button", className: "jp-xtralab-GitPanel-iconButton", title: action.label, disabled: pendingAction !== undefined, onClick: event => {
-                event.stopPropagation();
-                action.onClick();
-            } }, action.symbol)))),
-        React.createElement("span", { className: "jp-xtralab-GitPanel-rowBadge", "data-status": change.status, title: statusTooltip(change.status) }, statusBadge(change.status))));
-}
-function statusBadge(status) {
-    switch (status) {
-        case 'modified':
-            return 'M';
-        case 'added':
-            return 'A';
-        case 'deleted':
-            return 'D';
-        case 'renamed':
-            return 'R';
-        case 'untracked':
-            return 'U';
-        case 'unmerged':
-            return '!';
-        case 'typechange':
-            return 'T';
-        default:
-            return '?';
-    }
-}
-function statusTooltip(status) {
-    switch (status) {
-        case 'modified':
-            return 'Modified';
-        case 'added':
-            return 'Added';
-        case 'deleted':
-            return 'Deleted';
-        case 'renamed':
-            return 'Renamed';
-        case 'untracked':
-            return 'Untracked';
-        case 'unmerged':
-            return 'Unmerged (conflict)';
-        case 'typechange':
-            return 'Type changed';
-        default:
-            return 'Unknown';
-    }
-}
-function basename(path) {
-    const idx = path.lastIndexOf('/');
-    return idx < 0 ? path : path.slice(idx + 1);
-}
-function dirnameOrEmpty(path) {
-    const idx = path.lastIndexOf('/');
-    return idx < 0 ? '' : path.slice(0, idx);
-}

package/src/git/icons.ts

@@ -1,20 +0,0 @@
-import { LabIcon } from '@jupyterlab/ui-components';
-
-/**
- * The branch glyph used as the git panel's sidebar tab icon. Defined as a
- * `LabIcon` (rather than a CSS-only mask) so it picks up JupyterLab's icon
- * recoloring and inverse-color sidebar painting automatically.
- *
- * Source: `git-branch` from SVG Repo (https://www.svgrepo.com/svg/377352/git-branch),
- * part of the same Pixelarticons family as the xtralab file browser's `file-tree`
- * icon, so the two sidebar tab glyphs read as a matched set. The original
- * `fill="#000000"` 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.
- */
-export const gitIcon = new LabIcon({
-  name: 'xtralab:git',
-  svgstr: `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="jp-icon3" fill="currentColor">
-  <path d="M5 2h2v12h3v3h7v-7h-3V2h8v8h-3v9h-9v3H2v-8h3V2zm15 6V4h-4v4h4zM8 19v-3H4v4h4v-1z"/>
-</svg>`
-});

package/src/git/panel.tsx

@@ -1,56 +0,0 @@
-import * as React from 'react';
-
-import { ReactWidget } from '@jupyterlab/ui-components';
-import { Signal, ISignal } from '@lumino/signaling';
-
-import { gitIcon } from './icons';
-import { GitPanelComponent, IGitPanelHandlers } from './panelComponent';
-
-/**
- * The id and CSS class used for the git panel widget. The id ends up as the
- * sidebar tab id (so layout restoration can find the widget) and the CSS
- * class lets per-panel styles attach without leaking to other widgets.
- */
-export const GIT_PANEL_ID = 'xtralab:git-panel';
-export const GIT_PANEL_CSS_CLASS = 'jp-xtralab-GitPanel';
-
-/**
- * The lumino host widget for the git changes panel. Owns the `refresh`
- * signal that the React component listens to, and exposes a typed callback
- * surface (`handlers`) the React component uses to react to user actions.
- */
-export class GitPanel extends ReactWidget {
-  constructor(handlers: IGitPanelHandlers) {
-    super();
-    this.id = GIT_PANEL_ID;
-    this.title.icon = gitIcon;
-    this.title.caption = 'Git Changes';
-    this.addClass(GIT_PANEL_CSS_CLASS);
-    this._handlers = handlers;
-  }
-
-  /**
-   * Public refresh hook called by the plugin when something happened that
-   * invalidates the current view (the user clicked the toolbar refresh, the
-   * file browser refreshed, a focused notebook saved, …).
-   */
-  refresh(): void {
-    this._refreshRequested.emit();
-  }
-
-  get refreshRequested(): ISignal<this, void> {
-    return this._refreshRequested;
-  }
-
-  protected render(): React.ReactElement {
-    return (
-      <GitPanelComponent
-        handlers={this._handlers}
-        refreshSignal={this._refreshRequested}
-      />
-    );
-  }
-
-  private _handlers: IGitPanelHandlers;
-  private _refreshRequested = new Signal<this, void>(this);
-}