@young1lin/dsh-ui-gitworkbench 0.1.0

package/lib/style-store.js

@@ -0,0 +1,123 @@
+/**
+ * Per-project and global drawer styling: a background image and custom CSS.
+ *
+ * These live on the host rather than in the browser for two reasons. A project
+ * setting belongs to the project, so it must survive a different browser or a
+ * cleared origin; and a background image is far larger than a localStorage
+ * origin quota is willing to hold.
+ *
+ * The file is a durable boundary: everything read back is validated here, and
+ * anything unrecognized is dropped rather than propagated. The image in
+ * particular is interpolated into a CSS `url()` by the client, so it is held to
+ * a base64 `data:` URL with no character that could close the function and
+ * continue the stylesheet.
+ */
+import { join } from 'node:path';
+/** No image, no CSS, and the defaults the sliders open on. */
+export const DEFAULT_STYLE = { css: '', image: '', blur: 18, veil: 78 };
+/** Largest accepted image data URL. A 2560px JPEG lands far below this; the cap
+ *  exists so a hand-edited file cannot make every drawer open drag megabytes. */
+export const STYLE_IMAGE_MAX = 3_000_000;
+/** Largest accepted custom stylesheet. */
+export const STYLE_CSS_MAX = 200_000;
+/** Largest accepted blur radius, in px. */
+export const STYLE_BLUR_MAX = 60;
+/**
+ * Images this plugin will render.
+ *
+ * Deliberately narrow: the client interpolates the value into `url("…")`, and a
+ * base64 alphabet cannot contain a quote, a parenthesis, a backslash or a
+ * semicolon, so a stored value can never close the function and append rules of
+ * its own. It is also exactly what a canvas `toDataURL` produces, so nothing a
+ * user can select through the picker is rejected.
+ */
+const IMAGE_PATTERN = /^data:image\/(?:png|jpeg|webp|gif|avif);base64,[A-Za-z0-9+/]+={0,2}$/;
+/**
+ * @param home - the user's home directory.
+ * @returns the style file's path, forward-slashed.
+ */
+export function stylePath(home) {
+    return join(home, '.dsh', 'gitworkbench-style.json').replace(/\\/g, '/');
+}
+/**
+ * @param value - a number from a file or an RPC argument.
+ * @param min - lower bound.
+ * @param max - upper bound.
+ * @param fallback - used when the value is not a finite number.
+ * @returns the value clamped into range.
+ */
+function clampNumber(value, min, max, fallback) {
+    if (typeof value !== 'number' || !Number.isFinite(value))
+        return fallback;
+    return Math.min(Math.max(value, min), max);
+}
+/**
+ * Narrow an arbitrary value to a complete, in-range style entry.
+ * @param value - parsed JSON or an RPC argument.
+ * @returns a valid entry; every rejected field falls back to its default.
+ */
+export function sanitizeEntry(value) {
+    if (typeof value !== 'object' || value === null)
+        return DEFAULT_STYLE;
+    const record = value;
+    const css = typeof record['css'] === 'string' && record['css'].length <= STYLE_CSS_MAX ? record['css'] : '';
+    const raw = record['image'];
+    const image = typeof raw === 'string' && raw.length <= STYLE_IMAGE_MAX && IMAGE_PATTERN.test(raw) ? raw : '';
+    return {
+        css,
+        image,
+        blur: clampNumber(record['blur'], 0, STYLE_BLUR_MAX, DEFAULT_STYLE.blur),
+        veil: clampNumber(record['veil'], 0, 100, DEFAULT_STYLE.veil),
+    };
+}
+/**
+ * @returns a style file with nothing configured.
+ */
+export function emptyStyleFile() {
+    return { v: 1, global: DEFAULT_STYLE, projects: {} };
+}
+/**
+ * @param entry - a style entry.
+ * @returns whether it configures anything at all; an entry that does not is not
+ *   worth storing, and storing it would shadow the global scope with nothing.
+ */
+export function isBlankEntry(entry) {
+    return entry.css.length === 0 && entry.image.length === 0;
+}
+/**
+ * Parse the style file, dropping anything malformed.
+ * @param raw - the file's text.
+ * @returns a valid style file; a corrupt one reads as empty rather than failing.
+ */
+export function parseStyle(raw) {
+    try {
+        const parsed = JSON.parse(raw);
+        if (parsed?.v !== 1)
+            return emptyStyleFile();
+        const projects = {};
+        if (typeof parsed.projects === 'object' && parsed.projects !== null) {
+            for (const [root, entry] of Object.entries(parsed.projects)) {
+                if (root.length > 0)
+                    projects[root] = sanitizeEntry(entry);
+            }
+        }
+        return { v: 1, global: sanitizeEntry(parsed.global), projects };
+    }
+    catch {
+        // A half-written or hand-edited file must not take the drawer down with it.
+        return emptyStyleFile();
+    }
+}
+/**
+ * @param readText - reads a file's text.
+ * @param path - the style file's path.
+ * @returns the stored styles, or an empty file when absent or unreadable.
+ */
+export async function loadStyle(readText, path) {
+    try {
+        return parseStyle(await readText(path));
+    }
+    catch {
+        return emptyStyleFile();
+    }
+}

package/lib/worktree.js

@@ -0,0 +1,112 @@
+// src/worktree.ts — Task 1 delivers only the binding storage; later tasks append.
+import { join } from 'node:path';
+import { saveJsonAtomic } from './atomic-json.js';
+const BINDINGS_FIELDS = ['repoRoot', 'worktreePath', 'name', 'enteredAt'];
+function emptyFile() { return { v: 1, bindings: {} }; }
+function isBinding(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    const record = value;
+    if (!BINDINGS_FIELDS.every(field => typeof record[field] === 'string' && record[field].length > 0))
+        return false;
+    // Absent is normal; present-but-malformed is corruption, and dropping the
+    // whole record beats trusting half of it.
+    const base = record['baseCommit'];
+    return base === undefined || (typeof base === 'string' && base.length > 0);
+}
+export function bindingsPath(home) {
+    return join(home, '.dsh', 'gitworkbench-worktree-bindings.json').replace(/\\/g, '/');
+}
+export function parseBindings(raw) {
+    try {
+        const parsed = JSON.parse(raw);
+        if (parsed?.v !== 1 || typeof parsed.bindings !== 'object' || parsed.bindings === null)
+            return emptyFile();
+        const out = emptyFile();
+        for (const [sessionId, value] of Object.entries(parsed.bindings)) {
+            if (sessionId.length > 0 && isBinding(value))
+                out.bindings[sessionId] = value;
+        }
+        return out;
+    }
+    catch {
+        return emptyFile();
+    }
+}
+export async function loadBindings(readText, path) {
+    try {
+        return parseBindings(await readText(path));
+    }
+    catch {
+        return emptyFile();
+    }
+}
+export async function saveBindings(ensureDir, writeText, rename, path, file) {
+    await saveJsonAtomic(ensureDir, writeText, rename, path, file);
+}
+// ---- Task 2: worktree name/branch/path derivation + porcelain parsing ----
+const NAME_PATTERN = /^[A-Za-z0-9._-]{1,40}$/;
+export function sanitizeName(raw, rng) {
+    if (raw !== undefined && NAME_PATTERN.test(raw) && raw !== '.' && raw !== '..')
+        return raw;
+    return `wt-${rng()}`;
+}
+export function branchFor(name) { return `wt/${name}`; }
+/** Longest ref name accepted — well past any real branch, short of a payload. */
+const REF_MAX_LENGTH = 200;
+/** The character set git allows in a branch or tag name. */
+const REF_CHARS = /^[A-Za-z0-9._/-]+$/;
+/**
+ * Decide whether a ref name from an untrusted caller may be passed to git.
+ *
+ * A ref arrives from the browser as free text and becomes a POSITIONAL argument,
+ * so three things are rejected before it gets there: a leading `-`, which git
+ * would read as an option rather than a ref; `..`, which is range syntax and
+ * would silently change what a comparison covers; and any character outside the
+ * set git accepts in a ref name.
+ * @param ref - candidate ref name.
+ * @returns true when the value is safe to pass to git as a ref.
+ */
+export function isRefName(ref) {
+    return typeof ref === 'string'
+        && ref.length > 0 && ref.length <= REF_MAX_LENGTH
+        && !ref.startsWith('-')
+        && !ref.includes('..')
+        && REF_CHARS.test(ref);
+}
+export function worktreeDir(repoRoot, name) {
+    return `${repoRoot.replace(/\/+$/, '')}/.agents/worktrees/${name}`;
+}
+export function parseWorktreeList(porcelain) {
+    const out = [];
+    let path = '';
+    let head = '';
+    let branch = '';
+    const flush = () => {
+        if (path.length > 0 && head.length > 0 && branch.length > 0) {
+            out.push({ path, head, branch });
+        }
+        path = '';
+        head = '';
+        branch = '';
+    };
+    for (const line of porcelain.split('\n')) {
+        if (line.length === 0) {
+            flush();
+            continue;
+        }
+        if (line.startsWith('worktree '))
+            path = line.slice('worktree '.length);
+        else if (line.startsWith('HEAD '))
+            head = line.slice('HEAD '.length);
+        else if (line.startsWith('branch refs/heads/'))
+            branch = line.slice('branch refs/heads/'.length);
+        else if (line === 'detached') {
+            path = '';
+            head = '';
+            branch = '';
+        }
+    }
+    flush();
+    return out;
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@young1lin/dsh-ui-gitworkbench",
+  "version": "0.1.0",
+  "description": "Out-of-tree dsh web UI plugin: a session-header git workbench chip opening a drawer with the file tree, per-file diff, history, compare, staging, commit, and sync (fetch/pull/push).",
+  "type": "module",
+  "main": "lib/index.js",
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "lib",
+    "!lib/*.map",
+    "src",
+    "scripts/install.sh",
+    "scripts/install.ps1",
+    "README.md",
+    "README_EN.md",
+    "AGENTS.md",
+    "LICENSE",
+    "cordis.patch.yml"
+  ],
+  "exports": {
+    ".": {
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "default": "./lib/client.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "platform": "web",
+      "inject": [
+        "@deepseek-ai/dsh-client-runtime",
+        "@deepseek-ai/dsh-client-ui-slots",
+        "@deepseek-ai/dsh-client-ui-primitives"
+      ]
+    }
+  },
+  "scripts": {
+    "bundle": "tsc -p tsconfig.json && tsc -p tsconfig.client.json && tsdown",
+    "bundle:publish": "tsc -p tsconfig.json && tsc -p tsconfig.client.json && tsdown --no-sourcemap",
+    "typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.client.json",
+    "test": "vitest run",
+    "watch": "tsdown --watch",
+    "prepack": "npm run bundle:publish"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/young1lin/dsh-ui-gitworkbench.git"
+  },
+  "homepage": "https://github.com/young1lin/dsh-ui-gitworkbench#readme",
+  "bugs": {
+    "url": "https://github.com/young1lin/dsh-ui-gitworkbench/issues"
+  },
+  "packageManager": "pnpm@10.20.0",
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "*",
+    "@deepseek-ai/dsh-client-runtime": "*",
+    "@deepseek-ai/dsh-client-ui-slots": "*",
+    "@deepseek-ai/dsh-tools": "*",
+    "@deepseek-ai/dsh-typert-protocol": "*",
+    "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "~18.3.1",
+    "lightningcss": "^1.33.0",
+    "react": "^18.2.0",
+    "tsdown": "0.22.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10"
+  },
+  "dependencies": {
+    "@shikijs/langs": "4.3.1",
+    "shiki": "4.3.1"
+  }
+}

package/scripts/install.ps1

@@ -0,0 +1,240 @@
+# =============================================================================
+# dsh-ui-gitworkbench one-shot installer (official CLI path; pwsh 7 / PS 5.1)
+#
+# Installs the npm package and mounts it through the official plugin command:
+#   dsh plugin --profile web add @young1lin/dsh-ui-gitworkbench@<version>
+#
+# The package declares dsh.bundle.patch (cordis.patch.yml), so the CLI's bundle
+# coordination registers it into the profile's dsh.profile.bundles and mounts
+# the host half on next start -- no manual cordis.patch.yml mount entry.
+#
+# Usage:
+#   irm https://raw.githubusercontent.com/young1lin/dsh-ui-gitworkbench/main/scripts/install.ps1 | iex
+#   & ([scriptblock]::Create((irm '<raw url>'))) -Version 0.1.0 -Restart
+#   powershell -ExecutionPolicy Bypass -File install.ps1 -DryRun
+#
+# Parameters:
+#   -Version    npm version/range; default latest (resolved against the registry).
+#   -Restart    After install, try `pm2 restart dsh-web` (hint only when pm2 is absent).
+#   -DryRun     Print the planned steps, write nothing.
+#
+# Environment (all optional):
+#   DSH_HOME    default %USERPROFILE%\.dsh
+#   REGISTRY    default https://registry.npmjs.org
+#   DSH_CMD     default: dsh on PATH, else npx -y --package @deepseek-ai/dsh
+#
+# Notes:
+# - pnpm 11 minimumReleaseAge rejects versions published <24h ago. The script
+#   pre-writes minimumReleaseAgeExclude for this package (idempotent) so a
+#   fresh release installs on first try.
+# - Older installs used a manual link: dependency + cordis.patch.yml mount
+#   entry. The script removes both idempotently (double mounting = two host
+#   halves and two chips).
+# =============================================================================
+param(
+  [string]$Version = '',
+  [switch]$Restart,
+  [switch]$DryRun
+)
+
+$PKG = '@young1lin/dsh-ui-gitworkbench'
+$REGISTRY = if ($env:REGISTRY) { $env:REGISTRY } else { 'https://registry.npmjs.org' }
+
+if ($env:DSH_HOME) {
+  $DSH_HOME = $env:DSH_HOME
+} elseif ($env:USERPROFILE) {
+  $DSH_HOME = Join-Path $env:USERPROFILE '.dsh'
+} else {
+  $DSH_HOME = Join-Path $HOME '.dsh'
+}
+$PROFILE_DIR = Join-Path $DSH_HOME 'profiles\web'
+$WS_YML = Join-Path $PROFILE_DIR 'pnpm-workspace.yaml'
+$PATCH_YML = Join-Path $PROFILE_DIR 'cordis.patch.yml'
+
+function Say([string]$m)  { Write-Host "[install] $m" -ForegroundColor Green }
+function Warn([string]$m) { Write-Host "[warn] $m" -ForegroundColor Yellow }
+function Die([string]$m)  { Write-Host "[error] $m" -ForegroundColor Red; exit 1 }
+
+function Resolve-Spec {
+  param([string]$Given)
+  if ([string]::IsNullOrWhiteSpace($Given) -or $Given -eq 'latest') {
+    # Accept only exit-code-0 output that looks like a version: on a 404 the
+    # registry query fails, and PS 5.1 can wrap stderr remnants (e.g. a
+    # help-remedy line) into the captured pipeline -- a truthiness check once
+    # resolved "latest" to the garbage string "npm help".
+    foreach ($tool in @('npm', 'pnpm')) {
+      if (Get-Command $tool -ErrorAction SilentlyContinue) {
+        $raw = & $tool view $PKG version "--registry=$REGISTRY" 2>$null
+        if ($LASTEXITCODE -eq 0) {
+          $v = ([string]($raw | Select-Object -Last 1)).Trim()
+          if ($v -match '^\d+\.\d+\.\d+') { return $v }
+        }
+      }
+    }
+    Warn 'Cannot resolve latest version (npm/pnpm query failed); falling back to latest.'
+    Warn 'If you know the version, pass it explicitly: -Version 0.1.0'
+    return 'latest'
+  }
+  return $Given
+}
+
+function Get-DshCli {
+  if ($env:DSH_CMD) { return $env:DSH_CMD }
+  if (Get-Command dsh -ErrorAction SilentlyContinue) { return 'dsh' }
+  if (Get-Command npx -ErrorAction SilentlyContinue) { return 'npx' }
+  return $null
+}
+
+if (-not (Get-Command node -ErrorAction SilentlyContinue)) {
+  Die 'node not found (DSH needs Node.js >= 20). Install Node.js first.'
+}
+if (-not (Test-Path $PROFILE_DIR)) {
+  Die "Profile directory not found: $PROFILE_DIR (run dsh web once first)"
+}
+if (-not (Test-Path $WS_YML)) {
+  Die "$WS_YML not found (initialize the web profile first)"
+}
+
+$SPEC = Resolve-Spec $Version
+$CLI = Get-DshCli
+if (-not $CLI) {
+  Die 'Neither dsh nor npx found. Install DSH (and Node/npm), or set DSH_CMD.'
+}
+$cliDisplay = if ($CLI -eq 'npx') { 'npx -y --package @deepseek-ai/dsh dsh' } else { $CLI }
+Say "Target: $cliDisplay plugin --profile web add $PKG@$SPEC (profile: $PROFILE_DIR)"
+
+if ($DryRun) {
+  Say "[dry-run] step 1: ensure $WS_YML has minimumReleaseAgeExclude ($PKG)"
+  Say "[dry-run] step 2: run $CLI plugin --profile web add $PKG@$SPEC (install + bundle registration)"
+  Say "[dry-run] step 3: verify dsh.profile.bundles contains $PKG"
+  Say "[dry-run] step 4: idempotently drop the old manual gitworkbench mount entry in $PATCH_YML (if any)"
+  if ($Restart) { Say '[dry-run] step 5: pm2 restart dsh-web' } else { Say '[dry-run] step 5: prompt for manual DSH restart' }
+  exit 0
+}
+
+# Step 1: pre-write workspace settings (idempotent) so pnpm 11 accepts a
+# version published less than 24h ago.
+$wsScript = @'
+const fs = require("fs");
+const p = process.argv[2];
+const pkg = process.argv[3];
+let t = fs.readFileSync(p, "utf8");
+const before = t;
+if (!new RegExp("^\\s*-\\s+" + pkg.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") + "\\s*$", "m").test(t)) {
+  if (/^\s*minimumReleaseAgeExclude:\s*$/m.test(t)) {
+    t = t.replace(/^(\s*minimumReleaseAgeExclude:\s*)$/m, "$1\n  - " + pkg);
+  } else {
+    t += "\nminimumReleaseAgeExclude:\n  - " + pkg + "\n";
+  }
+}
+if (t !== before) fs.writeFileSync(p, t);
+console.log(t === before ? "unchanged" : "updated");
+'@
+# PS 5.1 mangles embedded double quotes when a multi-line script is passed to
+# `node -e` through the Windows command line; a temp file sidesteps that.
+$wsJs = Join-Path $env:TEMP ("dshgw-ws-" + [guid]::NewGuid().ToString("N") + ".js")
+Set-Content -LiteralPath $wsJs -Value $wsScript -Encoding UTF8
+$wsOut = node $wsJs "$WS_YML" "$PKG" 2>&1
+$wsCode = $LASTEXITCODE
+Remove-Item -LiteralPath $wsJs -Force -ErrorAction SilentlyContinue
+$wsResult = (($wsOut | Out-String)).Trim()
+if ($wsCode -ne 0) { Die "Failed to update $WS_YML (node exit $wsCode): $wsResult" }
+if ($wsResult -eq 'updated') {
+  Say "Ensured ${WS_YML}: minimumReleaseAgeExclude ($PKG)"
+} else {
+  Say 'Workspace settings already fine, skipped'
+}
+
+# Step 2: official CLI install + bundle registration (mount included)
+if ($CLI -eq 'dsh') {
+  $cliArgs = @('plugin', '--profile', 'web', 'add', "$PKG@$SPEC")
+} else {
+  $cliArgs = @('-y', '--package', '@deepseek-ai/dsh', 'dsh', 'plugin', '--profile', 'web', 'add', "$PKG@$SPEC")
+}
+Say "Running $cliDisplay plugin --profile web add $PKG@$SPEC ..."
+$addOut = & $CLI @cliArgs 2>&1
+$addCode = $LASTEXITCODE
+$addOut | ForEach-Object { $_ }
+if ($addCode -ne 0) {
+  Warn 'dsh plugin add failed. Likely causes:'
+  Warn '  - network/auth: npm registry unreachable or auth required.'
+  Warn "  - dependency conflict: retry manually: cd $PROFILE_DIR; pnpm install"
+  exit 1
+}
+
+# Step 3: verify the bundle got registered (the sign mounting took effect)
+$pkgJson = Get-Content -Raw (Join-Path $PROFILE_DIR 'package.json') | ConvertFrom-Json
+$bundles = $pkgJson.dsh.profile.bundles
+if ($bundles -notcontains $PKG) {
+  Warn "$PKG missing from dsh.profile.bundles -- bundle registration failed."
+  exit 1
+}
+Say "Bundle registered: dsh.profile.bundles contains $PKG (mounts on next start)"
+
+# Step 4: idempotently remove an old manual mount entry (double-mount guard)
+if (Test-Path $PATCH_YML) {
+  $mountScript = @'
+const fs = require("fs");
+const p = process.argv[2];
+const lines = fs.readFileSync(p, "utf8").split("\n");
+const out = [];
+let i = 0;
+let removed = false;
+while (i < lines.length) {
+  const line = lines[i];
+  if (/^[ \t]*- insert:\s*$/.test(line)) {
+    const block = [line];
+    let j = i + 1;
+    while (j < lines.length && lines[j].trim() !== "" && !/^-\s/.test(lines[j])) {
+      block.push(lines[j]);
+      j++;
+    }
+    if (block.some((l) => /id:\s*ui-gitworkbench\b/.test(l) || /name:\s*'\@young1lin\/dsh-ui-gitworkbench'/.test(l))) {
+      while (out.length && /^[ \t]*#/.test(out[out.length - 1])) out.pop();
+      i = j;
+      removed = true;
+      continue;
+    }
+  }
+  out.push(line);
+  i++;
+}
+if (!removed) {
+  console.log("none");
+} else {
+  const t = out.join("\n").replace(/\n{3,}/g, "\n\n");
+  fs.writeFileSync(p, t);
+  console.log("removed");
+}
+'@
+  $mountJs = Join-Path $env:TEMP ("dshgw-mount-" + [guid]::NewGuid().ToString("N") + ".js")
+  Set-Content -LiteralPath $mountJs -Value $mountScript -Encoding UTF8
+  $mountOut = node $mountJs "$PATCH_YML" 2>&1
+  $mountCode = $LASTEXITCODE
+  Remove-Item -LiteralPath $mountJs -Force -ErrorAction SilentlyContinue
+  $mountResult = (($mountOut | Out-String)).Trim()
+  if ($mountCode -ne 0) { Die "Failed to update $PATCH_YML (node exit $mountCode): $mountResult" }
+  if ($mountResult -eq 'removed') {
+    Say "Removed the old manual gitworkbench mount entry from $PATCH_YML (bundle channel takes over)"
+  } else {
+    Say 'No stale manual mount entry, skipped'
+  }
+}
+
+Say "Install complete: $PKG@$SPEC"
+
+# Step 5: restart guidance
+if ($Restart) {
+  if (Get-Command pm2 -ErrorAction SilentlyContinue) {
+    Say 'Restarting dsh-web (pm2)...'
+    pm2 restart dsh-web
+    if ($LASTEXITCODE -ne 0) { Warn 'pm2 restart failed; restart DSH manually' }
+  } else {
+    Warn 'pm2 not found; restart DSH manually (e.g. pm2 restart dsh-web, or dsh web)'
+  }
+} else {
+  Say 'Next: restart DSH and hard-refresh (Ctrl+Shift+R / Cmd+Shift+R).'
+  if (Get-Command pm2 -ErrorAction SilentlyContinue) {
+    Say 'Available here: pm2 restart dsh-web (briefly drops the current page session)'
+  }
+}