ZDDC/CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Authoritative docs — read these first

This repo already has two thorough agent-facing references. Always consult them before working — they cover details intentionally omitted here:

• AGENTS.md — commands, build-system rules, per-tool parser quirks, testing gotchas, git/worktree workflow, release process, zddc-server notes
• ARCHITECTURE.md — single-file HTML pattern rationale, JS module/state patterns, per-tool architecture, security model

If something in this CLAUDE.md conflicts with those, those win — and please update them rather than letting drift accumulate.

Repo shape

This is a monorepo of independent tools, not one application:

• archive/, transmittal/, classifier/, mdedit/, landing/ — five self-contained HTML tools, each compiled to a single inlined HTML file in its own dist/. Naming: the first four output dist/tool.html; landing/ outputs dist/index.html (it's the project picker served at the root of zddc-server).
• zddc/ — Go HTTP server (separate sub-project; Go 1.24+). Serves ZDDC_ROOT/index.html at GET / as the landing page; Accept: application/json on / returns the ACL-filtered project list. Cross-compiled binaries are committed to the website orphan branch (LFS-tracked) and served from zddc.varasys.io/releases/ (no Codeberg release assets); the helm/ charts in this repo build from source at deploy time.
• shared/ — base.css plus shared JS modules (zddc.js, hash.js, zddc-filter.js, theme.js, help.js) included by every tool's build, and build-lib.sh (POSIX sh helpers sourced by every tool's build.sh AND by the top-level build for lockstep release helpers).
• website orphan branch (same Codeberg repo) — committed static site: index.html (root URL, hand-edited intro), releases/<tool>_v<X.Y.Z>.html (immutable per-version archives), releases/<tool>_v<X.Y>.html and _v<X>.html (symlinks), releases/<tool>_{stable,beta,alpha}.html (channel mirrors), releases/zddc-server_v<X.Y.Z>_<platform> (per-version cross-compiled binaries; LFS-tracked), releases/zddc-server_<channel>_<platform> (binary symlinks following the same cascade), releases/zddc-server_<X>.html (per-version / per-channel stub pages that fan out the four platform downloads in one matrix-cell link), releases/index.html (matrix table regenerated by build.sh). Working dir: ~/src/zddc-website/ (a git worktree of the website branch — git -C ~/src/zddc worktree add ~/src/zddc-website website). Caddy: the zddc.varasys.io:8443 vhost bind-mounts ~/src/zddc-website and serves from there. Install model: local use is a download from /releases/. Server use is zddc-server, which has the current-stable build of all five tools baked in via //go:embed (compile-time default). Tools auto-served at folder-name-driven paths: archive everywhere, classifier in Incoming/Working/Staging subtrees, mdedit in Working subtrees, transmittal in Staging subtrees, landing only at root. Override via .zddc apps: cascade entry (channel/version/URL/path) — fetched once, cached at <ZDDC_ROOT>/_app/. Drop a real .html file at any path to override.
• helm/ — example Helm charts for zddc-server (zddc-server-prod/, zddc-server-dev/). Both compile from source via init container. Operators copy values.yaml.example and customize. No secrets in repo.
• tests/ — Playwright specs (Chromium only, requires File System Access API). tests/schema.spec.js validates transmittal.schema.json against canonical fixtures via ajv (only dev dep besides Playwright)

Most-used commands

# Lockstep release driver. Every invocation is a publish action;
# alpha is the default since "alpha = active dev iteration".
./build                              # cut alpha (default)
./build beta                         # cut beta — cascades alpha → beta
./build release                      # cut stable — coordinated next version, cascades all
./build release X.Y.Z                # cut stable at explicit version
./build help                         # usage

sh tool/build.sh                     # build one HTML tool's dist/ (no channel write)
sh tool/build.sh --release [...]     # single-tool release (rare; prefer the lockstep ./build)
./freshen-channel <tool> <channel>   # rebuild one tool's alpha/beta from its current stable tag

npm test                             # all Playwright specs (build first!)
npx playwright test <tool>           # one spec
./dev-server start  # stop           # cache-busting HTTP on :8000

# zddc/ Go server (sub-project)
(cd zddc && go test ./...)           # unit tests (Go 1.24+)

No lint/typecheck/format commands exist for the HTML tools — vanilla JS + POSIX sh by design.

Things that bite if you forget

• dist/ is gitignored. tool/dist/<tool>.html is the canonical built artifact for testing and as the source for --release writes. Never hand-edit a dist/ file.
• Lockstep releases. Every release cut bumps all six artifacts (5 HTML tools + zddc-server) to the same version, even if a tool didn't change. The coordinated next-stable target is max(latest tag across all tools) + 1. Per-tool independent versions are no longer the norm — ./build release is the canonical path. Workflow: alpha = active dev, beta = ready for general testing, stable = ready to ship.
• Release artifacts live on the website orphan branch. The build pipeline writes them to ${ZDDC_DEPLOY_RELEASES_DIR:-$HOME/src/zddc-website/releases} — a git worktree of that branch, served by Caddy directly. HTML tools: per-version <tool>_v<X.Y.Z>.html (real immutable files) + partial-version pins + channel mirrors (symlinks). zddc-server: zddc-server_v<X.Y.Z>_<platform> per-version binaries (LFS), zddc-server_v<X.Y>_<platform> / _v<X>_<platform> / _<channel>_<platform> symlinks, plus zddc-server_<X>.html stub pages that surface the four platform downloads in one matrix-cell link. Same cascade rule for both: stable cut → beta + alpha both reset to stable; beta cut → alpha cascades to beta.
• No tags for alpha/beta. Channel URLs are stable URLs by design — appending counter tags would defeat the purpose. The on-page label encodes <date> · <sha> for traceability. Stable cuts get clean <tool>-vX.Y.Z tags for every tool (six tags per cut, all sharing the same X.Y.Z).
• Pre-release semver in the on-page label. Plain dev builds and --release alpha|beta cuts embed vX.Y.Z-{alpha,beta} in {{BUILD_LABEL}} where X.Y.Z is the next-stable target. Plain dev adds a full timestamp + -dirty marker; --release alpha|beta is date-only.
• Channel-link verifier. Every ./build ends with a check that every <tool>_{stable,beta,alpha}.html (and zddc-server's per-platform binary mirrors + stub pages) resolves. Bootstrap-friendly: skips zddc-server checks until the first --release cut materializes the binaries.
• sh tool/build.sh is a single-tool dev build. Writes dist/<tool>.html only; no new per-version files / symlink updates in the website worktree. Useful for iterating on one tool without cutting alpha for the whole suite. To publish, run ./build (cuts alpha for everything together). Release artifacts always land in ${ZDDC_DEPLOY_RELEASES_DIR:-~/src/zddc-website/releases}; nothing is pushed automatically — commit + push the website branch when you want to publish.
• Always build before running tests — Playwright opens dist/tool.html via file://.
• </ in JS string/template literals breaks inline <script> embedding. shared/build-lib.sh provides escape_js_close_tags; every tool's build.sh runs JS through it before inlining.
• All ZDDC parsing/formatting/hashing goes through window.zddc (from shared/zddc.js + shared/hash.js + shared/zddc-filter.js). API: parseFilename, parseFolder, parseRevision, formatFilename, formatFolder, compareRevisions, isValidStatus, splitExtension, joinExtension, crypto.{sha256Hex, sha256String, sha256File, bytesToHex}, filter.{parse, matches}. File objects across tools use trackingNumber (string) and extension (string, no leading dot — use zddc.joinExtension(name, ext) to build a filename). Add edge cases to tests/zddc.spec.js, not per-tool tests.
• Two globals only: window.app (per-tool app state + modules) and window.zddc (shared library). No others — anything that crosses tool boundaries goes through one of these.
• Worktrees live at ~/src/zddc-<branch>. Check git worktree list before starting a feature branch; never git checkout/switch inside a worktree another agent might be using.
• Build scripts are POSIX sh with set -eu, not bash. concat_files takes positional args only.