xtralab 0.1.0

package/src/git/icons.ts

@@ -0,0 +1,20 @@
+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/index.ts

@@ -0,0 +1,109 @@
+import {
+  ILayoutRestorer,
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import {
+  Dialog,
+  ICommandPalette,
+  IThemeManager,
+  WidgetTracker,
+  showDialog,
+  showErrorMessage
+} from '@jupyterlab/apputils';
+import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+
+import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
+
+import { CommandArguments, CommandIDs, registerGitCommands } from './commands';
+import { DiffContentWidget, diffWidgetId } from './diffWidget';
+import type { MainAreaWidget } from '@jupyterlab/apputils';
+import { GitPanel } from './panel';
+import { IFileChange } from './tokens';
+
+const GIT_PLUGIN_ID = 'xtralab:git';
+const GIT_DIFF_TRACKER_NAMESPACE = 'xtralab-git-diff';
+
+/**
+ * The git plugin. Adds a VS Code-style "Source Control" panel to the
+ * JupyterLab left sidebar and opens file diffs in the main area when the
+ * user clicks an entry in the panel. Backed by the `jupyterlab_git` server
+ * extension's REST API; the bundled `@jupyterlab/git` frontend is disabled
+ * via `package.json`'s `jupyterlab.disabledExtensions` so the two panels do
+ * not coexist.
+ */
+const plugin: JupyterFrontEndPlugin<void> = {
+  id: GIT_PLUGIN_ID,
+  description:
+    'A VS Code-style git changes panel and diff viewer powered by jupyterlab-git and @pierre/diffs.',
+  autoStart: true,
+  optional: [
+    ILayoutRestorer,
+    IThemeManager,
+    ICommandPalette,
+    IRenderMimeRegistry
+  ],
+  activate: (
+    app: JupyterFrontEnd,
+    restorer: ILayoutRestorer | null,
+    themeManager: IThemeManager | null,
+    commandPalette: ICommandPalette | null,
+    rendermime: IRenderMimeRegistry | null
+  ): void => {
+    // Match the panel's repo path: empty string means "use the JupyterLab
+    // server's root and let git resolve the enclosing repo".
+    const repoPath = '';
+
+    // Track open diff widgets so the layout restorer can recreate them on
+    // reload, and so the openDiff handler can reveal an already-open diff
+    // for the same file instead of creating a duplicate.
+    const tracker = new WidgetTracker<MainAreaWidget<DiffContentWidget>>({
+      namespace: GIT_DIFF_TRACKER_NAMESPACE
+    });
+
+    const findDiff = (
+      change: IFileChange
+    ): MainAreaWidget<DiffContentWidget> | undefined => {
+      const id = diffWidgetId(change);
+      return tracker.find(widget => widget.id === id) ?? undefined;
+    };
+
+    const panel = new GitPanel({
+      openDiff: change => {
+        const args: CommandArguments.IOpenDiff = { repoPath, change };
+        void app.commands.execute(
+          CommandIDs.openDiff,
+          args as unknown as ReadonlyPartialJSONObject
+        );
+      },
+      confirm: async (title, body, accept) => {
+        const result = await showDialog({
+          title,
+          body,
+          buttons: [Dialog.cancelButton(), Dialog.warnButton({ label: accept })]
+        });
+        return result.button.accept === true;
+      },
+      showError: showErrorMessage
+    });
+
+    app.shell.add(panel, 'left', { rank: 800 });
+    if (restorer !== null) {
+      restorer.add(panel, panel.id);
+    }
+
+    registerGitCommands({
+      app,
+      panel,
+      themeManager,
+      commandPalette,
+      contentsManager: app.serviceManager.contents,
+      rendermime,
+      onChanged: () => panel.refresh(),
+      trackDiff: widget => tracker.add(widget),
+      findDiff
+    });
+  }
+};
+
+export default plugin;