diff --git a/.claude/rules/credential-routing.md b/.claude/rules/credential-routing.md index abf7123..2029815 100644 --- a/.claude/rules/credential-routing.md +++ b/.claude/rules/credential-routing.md @@ -20,7 +20,7 @@ Requires the `warden` CLI from `~/ops-warden` (`uv tool install .` or `uv run wa | Agent runtime | How to orient | | --- | --- | | **Codex / Grok** (shell, HTTP State Hub) | `warden route` commands above; inbox `to_agent=whynot-design` is for coordination, not secret vending | -| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workstreams; **still** use `warden route` for credential ownership | +| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workplans; **still** use `warden route` for credential ownership | | **llm-connect** (inference service) | Never put secret retrieval in prompts; route custody to OpenBao/operator paths surfaced by `warden route` | ### Quick routing table diff --git a/.claude/rules/first-session.md b/.claude/rules/first-session.md index f509699..7eb9bbd 100644 --- a/.claude/rules/first-session.md +++ b/.claude/rules/first-session.md @@ -1,6 +1,6 @@ ## First Session Protocol -Triggered when `get_domain_summary("consumer")` shows **no workstreams**. +Triggered when `get_domain_summary("consumer")` shows **no workplans**. The project is registered but work has not yet been structured. **Step 1 — Read, don't write** @@ -11,27 +11,31 @@ The project is registered but work has not yet been structured. **Step 2 — Survey in-progress work** Look for TODOs, open branches, half-finished files. Note done vs. started but incomplete. -**Step 3 — Propose workstreams to Bernd** -Propose 1–3 workstreams — each a coherent strand, weeks to months, anchored to a +**Step 3 — Propose workplans to Bernd** +Propose 1–3 workplans — each a coherent strand, weeks to months, anchored to a roadmap phase. **Wait for approval before creating.** -**Step 4 — Create workplan file first, then DB record (ADR-001)** +**Step 4 — Write the workplan file; fix-consistency registers it (ADR-001)** ``` -workplans/WHYNOT-WP-NNNN-.md ← write this first +workplans/WHYNOT-WP-NNNN-.md ← write this, commit it ``` -Then register in the hub: -``` -create_workstream(topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", title="...", owner="...", description="...") -create_task(workstream_id="", title="...", priority="high|medium|low") +Then register by running the consistency check — do **not** call +`create_workplan`/`create_task` yourself; manual registration duplicates what +C-06 creates from the file: +```bash +statehub fix-consistency --repo whynot-design ``` +C-06 creates the hub workplan + tasks and writes `state_hub_workstream_id` +(legacy frontmatter name — holds the workplan UUID) and `state_hub_task_id` +back into the file. **Step 5 — Record the setup** ``` add_progress_event( - summary="First session: structured consumer into N workstreams, M tasks", + summary="First session: structured consumer into N workplans, M tasks", event_type="milestone", topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", - detail={"workstreams": [...], "tasks_created": M} + detail={"workplans": [...], "tasks_created": M} ) ``` diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md index e940ac0..a54b79d 100644 --- a/.claude/rules/session-protocol.md +++ b/.claude/rules/session-protocol.md @@ -44,7 +44,7 @@ For each file with `status: ready`, `active`, or `blocked`, note pending **Step 4 — Present brief** -1. **Active workstreams** for `consumer` — title, task counts, blocking decisions +1. **Active workplans** for `consumer` — title, task counts, blocking decisions 2. **Pending tasks** from `workplans/` + any `[repo:whynot-design]` hub tasks 3. **Goal guidance** — if `goal_guidance` in summary: - `needs_workplan`: surface as top action — *"Repo goal '{title}' has no workplan yet"* @@ -52,33 +52,40 @@ For each file with `status: ready`, `active`, or `blocked`, note pending 4. **Suggested next action** — highest-priority open item 5. **SBOM status** — flag if `last_sbom_at` is unset for this repo -If no workstreams: follow First Session Protocol (`first-session.md`). +If no workplans: follow First Session Protocol (`first-session.md`). **During work:** `record_decision()` · `add_progress_event()` · `resolve_decision()` -> State Hub is a *read model*. Bootstrap tools (`create_workstream`, `create_task`) -> are First Session Protocol only. Work structure belongs in repo files (ADR-001). +> State Hub is a *read model*. **Never register workplans or tasks by hand** +> (`create_workplan`, `create_task`) — write the workplan file in `workplans/` +> and run `fix-consistency`; C-06 registers the workplan and tasks and writes +> IDs back into the file. Manual registration creates duplicates when +> fix-consistency runs. Work structure belongs in repo files (ADR-001). +> +> Legacy: `create_workstream` and `/workstreams/` remain as metered aliases — +> see `workplan-convention.md` (compatibility footnote). **Session close:** With MCP tools: ``` -add_progress_event(summary="...", topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", workstream_id="") +add_progress_event(summary="...", topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", workplan_id="") ``` Without MCP tools: ```bash curl -s -X POST http://127.0.0.1:8000/progress/ \ -H "Content-Type: application/json" \ - -d '{"topic_id":"cee7bedf-2b48-46ef-8601-006474f2ad7a","workstream_id":"","event_type":"note","summary":"what changed","author":"codex"}' + -d '{"topic_id":"cee7bedf-2b48-46ef-8601-006474f2ad7a","workplan_id":"","event_type":"note","summary":"what changed","author":"codex"}' ``` -If workplan files were modified, ensure the local copy is up to date first: +If workplan files were modified, ensure the local copy is up to date first, +then sync from the repo checkout: ```bash -git -C pull --ff-only -cd ~/state-hub && make fix-consistency REPO=whynot-design +git pull --ff-only +statehub fix-consistency ``` For repos where implementation runs on a remote machine (e.g. CoulombCore), -use the combined target which pulls before fixing: +use the pull-before-fix mode from any shell with the State Hub CLI: ```bash -cd ~/state-hub && make fix-consistency-remote REPO=whynot-design +statehub fix-consistency --repo whynot-design --remote ``` **C-15** (DB task ahead of file) is normal in multi-machine workflows — writeback will sync the file to match DB. **C-16** (repo behind remote) blocks all writes diff --git a/.claude/rules/stack-and-commands.md b/.claude/rules/stack-and-commands.md index 0250439..1260e40 100644 --- a/.claude/rules/stack-and-commands.md +++ b/.claude/rules/stack-and-commands.md @@ -18,10 +18,38 @@ npx playwright test -g "inbox" # run a single visual test by name make # list make targets (help is the default goal) make designbook-sync # after a /design-sync pull, record changes + last-sync time → RecentChanges.md make designbook-check # ask Claude Design (via llm-connect) if the cloud is newer; warn if mirror is stale +make ir # extract the technology-neutral IR (ir/) from designbook/ (React → IR) +make adapt-lit # project IR onto Lit: regen tokens + scaffold stubs + drift reports (exit 3 on drift) +make parity-lit # render every (Playwright) + assert contract/visual parity (exit 4 on fail) +make designbook-refresh # the refresh loop: check→pull→sync→ir→adapt-lit→(drift triage)→parity. ARGS="--no-pull" etc. make recent-changes # regenerate RecentChanges.md (alias; ARGS="--range main..HEAD" supported) make sync-styles # = node scripts/sync-shared-styles.mjs ``` +### Keeping Lit current with the designbook — the refresh loop (WHYNOT-WP-0002) + +`make designbook-refresh` is the single routine that re-propagates a cloud designbook +change down to the Lit stack. It runs the automatable steps and **stops for you** when +drift needs a human decision: + +``` +1 designbook-check → has the cloud moved? (best-effort: needs llm-connect) +2 designbook-pull → pull React designbook→designbook/ (best-effort: needs `claude` binary) +3 designbook-sync → record the diff → RecentChanges.md +4 ir → re-extract ir/ (review the git diff — the blueprint change) +5 adapt-lit → regen tokens, scaffold new stubs, emit drift reports +6 ‹you› resolve drift ← STOP if step 5 exits 3 (adapters/lit/drift/*.md) +7 parity-lit → confirm contract + visual parity +``` + +Exit codes propagate the adapter contract: **3** = stop for drift triage (step 6), +**4** = parity failure. Steps 1–3 are best-effort (a network/`claude`/llm-connect +gap warns and continues; the IR just re-extracts from the current mirror). After +resolving drift, re-run `make designbook-refresh --no-pull` (via `ARGS=`) to re-check +and reach parity. Drift resolution itself is governed by +`.claude/rules/designbook-propagation.md` (fix the stack, or change the language in +Claude Design and re-propagate — never a stack→React back-edit). + There is no unit-test suite — correctness is verified by full-page Playwright screenshot diffs of the two `examples/` pages (`tests/visual/ui-kit.spec.mjs`, `maxDiffPixelRatio: 0.005`). Any visual change needs `pnpm test:visual:update` + baseline review. ## Integrating the designbook diff --git a/.claude/rules/workplan-convention.md b/.claude/rules/workplan-convention.md index 228513c..5e686a4 100644 --- a/.claude/rules/workplan-convention.md +++ b/.claude/rules/workplan-convention.md @@ -5,7 +5,7 @@ ID prefix: `WHYNOT-WP-` Work items originate as files in this repo **before** being registered in the hub. -Canonical workplan/workstream frontmatter statuses are: +Canonical workplan frontmatter statuses are: `proposed`, `ready`, `active`, `blocked`, `backlog`, `finished`, `archived`. Use `proposed` for a newly drafted plan, `ready` after review against current repo state, and `finished` when implementation is complete. `stalled` and @@ -16,14 +16,15 @@ prefix: `YYMMDD-WHYNOT-WP-NNNN-.md`. The frontmatter id remains unchanged; the prefix is only for quick visual reference. Small opportunistic tasks discovered during another session use **Ad Hoc Tasks**: -`workplans/ADHOC-YYYY-MM-DD.md`, workstream slug `adhoc-YYYY-MM-DD`, and task ids +`workplans/ADHOC-YYYY-MM-DD.md`, workplan slug `adhoc-YYYY-MM-DD`, and task ids `ADHOC-YYYY-MM-DD-T01`, `T02`, etc. Use adhocs only for low-risk work completed directly. Promote anything requiring analysis, design, approval, dependencies, or multiple planned phases into a normal workplan. Ecosystem todos from other agents arrive as `[repo:whynot-design]` hub tasks — -visible at session start. Pick one up by creating the workplan file, then registering -the workstream. +visible at session start. Pick one up by creating the workplan file, committing, +and running `statehub fix-consistency` — C-06 registers the workplan in the hub. +Never register by hand with `create_workplan` (legacy MCP alias: `create_workstream`). Task blocks use this shape: @@ -37,4 +38,18 @@ state_hub_task_id: "" # written by fix-consistency — do not edit Status progression is `todo` → `progress` → `done`; use `wait` for waiting or blocked work and `cancel` for stopped work. +Workplan frontmatter carries `state_hub_workstream_id` — a legacy field name +kept for compatibility; it holds the hub workplan UUID and is written by +fix-consistency. Do not edit or rename it. + +### Legacy terminology (compatibility footnote) + +**Workplan** is the fleet term — see +`the-custodian/canon/standards/workplan-terminology-fleet_v0.1.md`. +**Workplan** is legacy only: some API routes (`/workstreams/`), params +(`workstream_id`), MCP aliases (`create_workstream`), and the frontmatter field +above remain until `STATE-WP-0069` retires them via legacy-meter. Treat those +identifiers as workplan IDs. Prefer `GET /workplans/` and `workplan_id` in new +examples and scripts. + diff --git a/.custodian-brief.md b/.custodian-brief.md index 56f5098..6d98967 100644 --- a/.custodian-brief.md +++ b/.custodian-brief.md @@ -1,23 +1,18 @@ # Custodian Brief — whynot-design -**Domain:** infotech -**Last synced:** 2026-06-27 18:11 UTC +**Domain:** consumer +**Last synced:** 2026-08-29 12:49 UTC **State Hub:** http://127.0.0.1:8000 *(adjust if running on a remote machine)* ## Active Workstreams -### Downstream consumption: versioned IR releases + consumer drift-check -Progress: 8/9 done | workstream_id: `41fed928-f44a-48f4-9870-120310fbf071` - -**Open tasks:** -- ! Publish to the Gitea npm registry `dbd3a2e6` - *(wait: Config + docs + packaging done (private:false, publishConfig, lit→peerDep, repository.url, .npmrc, PUBLISHING.md, ir/ in files+exports; npm pack --dry-run validated). Remaining: actual `npm publish` + `npm i` install-verify — blocked on a Gitea NPM_AUTH_TOKEN (operator/OpenBao-owned; warden route CLI not available here) and an explicit outward-publish go-ahead (publish is immutable).)* +*(none — repo may need first-session setup)* --- ## MCP Orientation (when available) If the state-hub MCP server is reachable, call: -`get_domain_summary("infotech")` +`get_domain_summary("consumer")` This provides richer cross-domain context. If the MCP call fails, use this file as your orientation source. diff --git a/.forgejo/workflows/ci-smoke.yaml b/.forgejo/workflows/ci-smoke.yaml new file mode 100644 index 0000000..bd44c56 --- /dev/null +++ b/.forgejo/workflows/ci-smoke.yaml @@ -0,0 +1,29 @@ +# Canonical CI smoke template (tier 1 routing drill). +# Copy to: .forgejo/workflows/ci-smoke.yaml in consumer repos. +name: CI Smoke + +on: + push: + branches: + - main + workflow_dispatch: + +jobs: + host-smoke: + runs-on: self-hosted + steps: + - name: Routing probe (host runner) + run: | + set -eu + echo "repository=${GITHUB_REPOSITORY:-unknown}" + echo "sha=${GITHUB_SHA:-unknown}" + echo "runner=${RUNNER_NAME:-unknown}" + uname -a + + container-smoke: + runs-on: ubuntu-latest + steps: + - name: Routing probe (container label) + run: | + set -eu + echo "container-smoke ok for ${GITHUB_REPOSITORY:-unknown}" \ No newline at end of file diff --git a/.generated-work-records.json b/.generated-work-records.json new file mode 100644 index 0000000..2fa4e41 --- /dev/null +++ b/.generated-work-records.json @@ -0,0 +1 @@ +{"version":1,"repo_slug":"whynot-design"} diff --git a/.generated-work-records.mk b/.generated-work-records.mk new file mode 100644 index 0000000..326f09b --- /dev/null +++ b/.generated-work-records.mk @@ -0,0 +1,8 @@ +# Explicit opt-in recipe; no environment files or external make includes. +CUSTODIAN_SOURCE ?= /home/worsch/the-custodian +GENERATED_REPO_SLUG ?= whynot-design +.PHONY: generated-work-records generated-work-records-check +generated-work-records: + python3 "$(CUSTODIAN_SOURCE)/scripts/generate_staged_work_records.py" --repo . --repo-slug "$(GENERATED_REPO_SLUG)" +generated-work-records-check: + python3 "$(CUSTODIAN_SOURCE)/scripts/generate_staged_work_records.py" --repo . --repo-slug "$(GENERATED_REPO_SLUG)" --check diff --git a/.gitignore b/.gitignore index 25bd05c..3b1f325 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,7 @@ __pycache__ # Editor .vscode .idea + +# Adapter parity render-smoke screenshots (regenerated by make parity-lit; the +# committed result is adapters/lit/parity/_parity.json) +adapters/lit/parity/*.png diff --git a/.npmrc b/.npmrc index 8c0c82b..151ba3c 100644 --- a/.npmrc +++ b/.npmrc @@ -1,6 +1,6 @@ -# @whynot/* is published to and installed from the coulomb Gitea npm registry. +# @whynot/* is published to and installed from the coulomb Forgejo npm registry. # The auth token is NOT stored here — set NPM_AUTH_TOKEN in your shell/CI. # It is operator/OpenBao-owned (credential-routing.md: tokens route, never vend); -# obtain a Gitea package token from the operator. Publish flow: see PUBLISHING.md. -@whynot:registry=https://gitea.coulomb.social/api/packages/coulomb/npm/ -//gitea.coulomb.social/api/packages/coulomb/npm/:_authToken=${NPM_AUTH_TOKEN} +# obtain a Forgejo package token through the governed lane. Publish flow: see PUBLISHING.md. +@whynot:registry=https://forgejo.coulomb.social/api/packages/coulomb/npm/ +//forgejo.coulomb.social/api/packages/coulomb/npm/:_authToken=${NPM_AUTH_TOKEN} diff --git a/AGENTS.md b/AGENTS.md index db4164b..e1f7112 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -19,7 +19,13 @@ there is no MCP server for Codex agents. | Context | URL | |---------|-----| | Local workstation | `http://127.0.0.1:8000` | -| Remote via tunnel | `http://127.0.0.1:18000` | +| Remote (railiance01, in-cluster) | `http://10.43.68.154:8000` | +| Optional local edge relay | http://127.0.0.1:18080 | + +When an operator has enabled the edge relay, set API_BASE to the relay URL. +Queueable writes return an explicit queued receipt if the central hub is +unreachable. Treat that as pending local evidence, then ask the operator to run +statehub outbox status/replay after connectivity returns. ### Orient at session start @@ -27,8 +33,8 @@ there is no MCP server for Codex agents. # Offline brief — works without hub connection cat .custodian-brief.md -# Active workstreams for this domain -curl -s "http://127.0.0.1:8000/workstreams/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" \ +# Active workplans for this domain +curl -s "http://127.0.0.1:8000/workplans/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" \ | python3 -m json.tool # Check inbox @@ -51,12 +57,12 @@ curl -s -X POST http://127.0.0.1:8000/progress/ \ "summary": "what was done", "event_type": "note", "author": "codex", - "workstream_id": "", + "workplan_id": "", "task_id": "" }' ``` -Omit `workstream_id` / `task_id` when not applicable. +Omit `workplan_id` / `task_id` when not applicable. ### Update task status @@ -80,7 +86,7 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ ## Session Protocol **Start:** -1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe) +1. `cat .custodian-brief.md` — domain goal and open workplans (offline-safe) 2. Check inbox: `GET /messages/?to_agent=whynot-design&unread_only=true`; mark read 3. Scan workplans: `ls workplans/` — note `status: ready`, `active`, or `blocked` files and open tasks 4. Check human-needed tasks: `GET /tasks/?needs_human=true` @@ -92,12 +98,12 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ **Close:** 1. Update workplan file task statuses to reflect progress 2. Log: `POST /progress/` with a summary of what changed -3. Note for the custodian operator: after workplan file changes, run from - `~/state-hub`: +3. After workplan file changes, run: ```bash - make fix-consistency REPO=whynot-design + statehub fix-consistency ``` - This syncs task status from files into the hub DB. + Coding agents should run this directly; ask the operator only if the CLI or + State Hub API is unavailable. This syncs task status from files into the hub DB. --- @@ -123,7 +129,7 @@ Requires the `warden` CLI from `~/ops-warden` (`uv tool install .` or `uv run wa | Agent runtime | How to orient | | --- | --- | | **Codex / Grok** (shell, HTTP State Hub) | `warden route` commands above; inbox `to_agent=whynot-design` is for coordination, not secret vending | -| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workstreams; **still** use `warden route` for credential ownership | +| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workplans; **still** use `warden route` for credential ownership | | **llm-connect** (inference service) | Never put secret retrieval in prompts; route custody to OpenBao/operator paths surfaced by `warden route` | ### Quick routing table diff --git a/BOOTSTRAP.md b/BOOTSTRAP.md index 5eb7aff..5e7cea1 100644 --- a/BOOTSTRAP.md +++ b/BOOTSTRAP.md @@ -19,7 +19,7 @@ ls -la # .gitea/ .github/ scripts/ tests/ # 3. Replace placeholder host names. -# Search-and-replace `gitea.example.com` with your actual Gitea host in: +# Search-and-replace `forgejo.example.com` with your actual Forgejo host in: # - package.json # - .npmrc # - .gitea/workflows/ci.yml (and .github/ if you keep that) @@ -54,8 +54,8 @@ git push ## Notes -- The `git+ssh` URL in `package.json` (`gitea.example.com/whynot/whynot-design.git`) is a placeholder. Replace with your actual Gitea host. -- The same goes for `.npmrc` and the registry URL in `.gitea/workflows/ci.yml` (commented out — uncomment when you stand up a Gitea Packages registry). +- The `git+ssh` URL in `package.json` (`forgejo.example.com/whynot/whynot-design.git`) is a placeholder. Replace with your actual Forgejo host. +- The same goes for `.npmrc` and the registry URL in `.gitea/workflows/ci.yml` (commented out — uncomment when you stand up a Forgejo Packages registry). - `.gitea/workflows/ci.yml` and `.github/workflows/ci.yml` are identical. Keep whichever your forge uses and delete the other. - The `examples/showcase/index.html` page uses `importmap` to load Lit from esm.sh **for the standalone-no-build case**. When you have a bundler in the consuming app, the bundler resolves `lit` from `node_modules` and the importmap is irrelevant. diff --git a/CHANGELOG.md b/CHANGELOG.md index d86ecb4..d481f38 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,49 @@ Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Version ## [Unreleased] +## [0.4.2] — 2026-09-04 + +### Changed + +- **Forgejo is now the canonical package registry** (WHYNOT-WP-0004). Package, + consumer, and release configuration consistently use + `https://forgejo.coulomb.social/api/packages/coulomb/npm/`; the legacy Gitea + publication remains historical evidence only. + +### Added + +- **Lit adapter completed + refresh pipeline** (WHYNOT-WP-0002, Phases 3–6). The + one-way `React → designbook/ → ir/ → adapters/lit` pipeline is now end-to-end: + - `make adapt-lit` gains **component scaffold + drift** (T07): parses + `src/elements/*.js`, compares each `` to its IR contract, and writes + per-component drift reports + a machine roll-up (`adapters/lit/drift/`), with + write-once stubs (`adapters/lit/stubs/`) for new components — never overwriting + hand-authored sources. Severity split: actionable drift gates (exit 3); + `non-portable`/`prop-extra` are informational. + - `make parity-lit` (T08): renders every `` in a real browser and asserts + **contract + visual parity**, writing `adapters/lit/parity/_parity.json` + (exit 4 on failure). + - `make designbook-refresh` (T09): the refresh orchestrator + (check→pull→sync→ir→adapt-lit→drift-triage→parity) honouring the adapter + exit-code contract, plus a drift-resolution runbook in `designbook/README.md`. + - `make adapt-plain-css` (T10): a deliberately-unfinished second-adapter **smoke** + proving the IR/adapter seam — a non-Lit adapter consuming the same `ir/` with the + same contract shapes and zero `ir/` changes. +- **Drift triage resolved — `make designbook-refresh` is green** (0 drift, parity pass). + The three surfaced divergences were resolved without any stack→React back-edit: + a documented `TAG_OVERRIDES` in the extractor maps `PipelineStrip → wn-pipeline` + (the tag is an IR-projection detail); the drift detector now recognises a prop + honoured by a same-named named slot (`` `actions`); and an auditable + `adapters/lit/drift.accepted.json` registry records the intentional Sidebar + composition divergence (`current` key ↔ per-item `active`) as a justified, + non-gating note. + +## [0.4.1] — 2026-07-03 + +Republished to the coulomb Gitea npm registry through the native +`secrets-engine exec` pilot closeout (SECRETS-WP-0003). No package content +changes from `0.4.0`. + ## [0.4.0] — 2026-06-28 ### Fixed diff --git a/CLAUDE.md b/CLAUDE.md index a1f48b6..e384c56 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -6,7 +6,6 @@ @.claude/rules/first-session.md @.claude/rules/workplan-convention.md @.claude/rules/stack-and-commands.md -@.claude/rules/designbook-propagation.md @.claude/rules/architecture.md @.claude/rules/repo-boundary.md @.claude/rules/credential-routing.md diff --git a/CONSUMING.md b/CONSUMING.md index 45316ba..ee45762 100644 --- a/CONSUMING.md +++ b/CONSUMING.md @@ -23,12 +23,12 @@ This is the inverse of whynot-design's own upstream machinery ## 1. Pin a version -`@whynot/design` is published to the coulomb Gitea npm registry. Pin an exact +`@whynot/design` is published to the coulomb Forgejo npm registry. Pin an exact tagged version; your lockfile becomes the real pin. ```bash # .npmrc in your repo (see PUBLISHING.md for the read-token routing) -# @whynot:registry=https://gitea.coulomb.social/api/packages/coulomb/npm/ +# @whynot:registry=https://forgejo.coulomb.social/api/packages/coulomb/npm/ npm i @whynot/design@0.3.0 lit ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0632878..a946b5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,7 +73,7 @@ After PR merge: 1. Bump `package.json` version following the [versioning rules in `DesignSystemIntroduction.md` §5](./DesignSystemIntroduction.md#5-versioning-discipline). 2. Move the `## [Unreleased]` block in `CHANGELOG.md` under a new `## [vX.Y.Z] — YYYY-MM-DD` header. 3. Tag: `git tag vX.Y.Z && git push --tags`. -4. CI's release workflow attaches the CHANGELOG slice to the Gitea release. (If publishing to a registry, this is where `npm publish` runs.) +4. CI's release workflow attaches the CHANGELOG slice to the Forgejo release. (If publishing to a registry, this is where `npm publish` runs.) 5. Renovate picks up the new tag in consumer repos within ~24h. Or manually: ```sh diff --git a/DesignSystemIntroduction.md b/DesignSystemIntroduction.md index ad77028..c904c2a 100644 --- a/DesignSystemIntroduction.md +++ b/DesignSystemIntroduction.md @@ -112,15 +112,15 @@ In order of effort: **a) pnpm workspaces (recommended for now)** — put `whynot-design` and your consuming app in the same monorepo (or use `file:` / `link:` references). Zero registry, zero auth, instant updates. -**b) Install directly from Gitea** — no registry needed. +**b) Install directly from Forgejo** — no registry needed. ```sh -pnpm add git+ssh://git@gitea.example.com/whynot/whynot-design.git#v0.2.0 +pnpm add git+ssh://git@forgejo.coulomb.social/coulomb/whynot-design.git#v0.2.0 ``` Pin to a tag, not `main`. Tag-pinning is the entire versioning discipline at A1. -When you outgrow either (second team needs read access without cloning, semver resolution becomes valuable), publish to **Gitea Packages** (native npm protocol) or a private Verdaccio. +When you outgrow either (second team needs read access without cloning, semver resolution becomes valuable), publish to **Forgejo Packages** (native npm protocol) or a private Verdaccio. ### 4.2 What a consumer imports @@ -345,7 +345,7 @@ This staging is exactly the *"low-cost learning first"* posture in `whynot-contr For whoever is bootstrapping this repo right now: -- [ ] Push the seed contents to `gitea.coulomb.social/coulomb/whynot-design`. +- [ ] Push the seed contents to `forgejo.coulomb.social/coulomb/whynot-design`. - [ ] Cut the first real tag with `make release VERSION=x.y.z` (see §6 — *Release ritual*) so consumers can pin. - [ ] Add the repo as a remote dependency in **one** consuming app (the Django one) and verify imports work end-to-end. Follow [`MultiFrameworkSupport.md` §Django](./MultiFrameworkSupport.md#django-server-rendered-templates--htmx). - [ ] Open one trivial PR against `whynot-design` (e.g. a CHANGELOG typo) to confirm CI passes end-to-end. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7e08e28 --- /dev/null +++ b/LICENSE @@ -0,0 +1,151 @@ +# Target Revenue Source License + +**Version 1.0, Candidate 1 (V1C1)** + +--- + +> **PRELIMINARY CANDIDATE — SUBJECT TO CHANGE — NOT FINAL** +> +> This repository is governed by the Target Revenue Source License +> (TRSL), Version 1, Candidate 1. This is the framework's first working +> candidate, adopted as the org's preliminary operating license across +> all repos (maintainer decision, 2026-07-29) during the build/alpha +> stage — see `SCOPE.md` §1 and Appendix A of the canonical text (link +> below) for the alpha/beta risk-acceptance decision this reflects and +> what it does and does not mean. Full specialist legal review is +> explicitly deferred until the framework moves out of beta. +> +> **Canonical source, full candidate-status banner, and Appendix A +> (non-normative candidate notes tracking every open item):** the +> `coulomb` org's `target-revenue` repository, +> `specs/TargetRevenueSourceLicense-V1C1.md` — this file is the operative +> legal text (Preamble through Section 11) only; the canonical document +> is authoritative if this copy and that document ever diverge. + +--- + +## Preamble + +This Target Revenue Source License ("**License**") governs the Software identified in the applicable Phase Manifest. It implements the Target Revenue Framework: a defined development Phase accumulates Development Credit and Remission Credit against an immutable Initial Target until the Milestone Release automatically and irrevocably converts to a declared permissive Future License. + +Commercial beneficiaries fund the creation and early availability of a software improvement; once the declared target is satisfied, the governed release becomes permissively open source. + +## 1. Definitions + +Capitalized terms used in this License have the meanings given below. Where a term is also defined in the Phase Manifest or Target Ledger for a specific Phase, the Phase Manifest and Target Ledger govern the *values* (amounts, dates, identifiers) and this License governs the *legal effect* of those values — the two must not be read as conflicting definitions of the same concept. + +**"Commercial Entitlement"** means a right, purchased or otherwise granted under a Commercial Use Agreement, to make Commercial Use of the Software during a Phase. + +**"Commercial Use"** means billing, invoicing, or otherwise charging any customer a fee, subscription, license fee, or other consideration for or in connection with use of the Software, at any time before the Conversion Event for the applicable Phase, regardless of whether the person or organization billed would otherwise qualify for Noncommercial Use. Commercial Use occurs by virtue of such billing alone, whether or not the resulting payment is registered with the Trust Service; in particular, billing a customer for pre-conversion use of the Software without recording the corresponding payment in the applicable Phase's Target Ledger is Commercial Use without a valid Commercial Entitlement — a violation of Section 3, addressed under Section 7 and, where applicable, the Enforcement Network described in the canonical repository's `specs/EnforcementNetworkConcept.md`. + +**"Commercial Use Agreement"** means the separate agreement, referenced by the applicable Phase Manifest, under which a Commercial Entitlement is purchased or granted. This License does not itself set pricing, metering, or payment terms — those are governed by the Commercial Use Agreement. + +**"Conversion Event"** means the moment the Outstanding Target for a Phase reaches zero, as computed from the Phase Manifest and Target Ledger per the Target Ledger Specification. The Conversion Event occurs automatically and is not conditioned on any declaration, attestation, or other act by the Licensor or any Trust Service. + +**"Development Credit"** means the portion of a collected and settled payment explicitly allocated toward satisfying the Initial Target of a specific Phase, as recorded in that Phase's Target Ledger. + +**"Future License"** means the permissive license identified in the applicable Phase Manifest, being either the MIT License or the Apache License, Version 2.0, which applies to the Milestone Release upon the Conversion Event. + +**"Initial Target"** means the immutable monetary target declared for a Phase in its Phase Manifest. + +**"Licensor"** means **Binky Hedgehog GmbH**, the party that publishes the Phase Manifest and holds the rights necessary to grant this License and the Future License for the Milestone Release. + +**"Milestone Release"** means the precisely identified software release designated in the applicable Phase Manifest, identified by an immutable source revision, release artifact, or cryptographic digest. + +**"Noncommercial Use"** means use of the Software for personal purposes, private study, hobby or amateur projects; use by any charitable organization, educational institution, public research organization, or government institution acting in a non-revenue-generating capacity; or other use of a materially similar character. + +**"Outstanding Target"** means, at any time, `max(0, Initial Target − cumulative Development Credit − cumulative Remission Credit)` for a Phase, as computed from that Phase's Target Ledger. + +**"Phase"** means a bounded development undertaking governed by one Initial Target, one Milestone Release, one degeneration policy, and one Future License declaration, as declared in a Phase Manifest. + +**"Phase Manifest"** means the published, immutable declaration identifying a Phase, its Milestone Release, Initial Target, Future License, degeneration policy, and Target Ledger location, as specified in the Phase Manifest Specification. + +**"Remission Credit"** means a transparent, non-revenue reduction of a Phase's Outstanding Target, generated under that Phase's published degeneration policy and recorded in the Target Ledger. + +**"Settled Payment"** means a payment that has cleared through its payment processor and is no longer subject to reversal in the ordinary course (chargeback, dispute, or equivalent), as further specified by the applicable Commercial Use Agreement or monetization extension. + +**"Software"** means the source code, object code, and associated documentation of the Milestone Release identified in the applicable Phase Manifest. + +**"Target Ledger"** means the append-only record of Development Credit, Remission Credit, and correction entries for a Phase, as specified in the Target Ledger Specification. + +**"You"** or **"Licensee"** means the individual or entity exercising rights under this License. + +## 2. Grant of Rights for Noncommercial Use + +Subject to the terms of this License, the Licensor grants You a worldwide, royalty-free, non-exclusive license, during the applicable Phase, to: + +(a) use, reproduce, and study the Software for any Noncommercial Use; + +(b) modify the Software and create derivative works of it for any Noncommercial Use; and + +(c) redistribute the Software and Your modifications, in source or object form, for any Noncommercial Use, provided that You include this License, unmodified, with any such redistribution, and that You do not remove or alter any copyright, patent, trademark, or attribution notices contained in the Software. + +This grant does not extend to Commercial Use. Commercial Use requires a Commercial Entitlement under Section 3. + +## 3. Commercial Use + +You may not make Commercial Use of the Software during the applicable Phase unless You hold a valid, current Commercial Entitlement under a Commercial Use Agreement with the Licensor covering the applicable Phase. A Commercial Entitlement granted under one Phase's Commercial Use Agreement does not extend to a later Phase's Milestone Release unless the Commercial Use Agreement expressly says so. + +This Section 3 states the existence and boundary of the commercial-use restriction. It does not itself set pricing, invoicing, metering, audit rights, or payment terms — those are governed exclusively by the applicable Commercial Use Agreement. + +## 4. Patent License + +Subject to the terms of this License, each contributor to the Software grants You, during the applicable Phase and solely to the extent of rights granted under Sections 2 and 3, a perpetual (subject to the termination below), worldwide, non-exclusive, no-charge, royalty-free patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Software, limited to those patent claims licensable by that contributor that are necessarily infringed by their contribution(s) alone or by combination of their contribution(s) with the Software. + +If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Software or a contribution incorporated within it constitutes direct or contributory patent infringement, then any patent licenses granted to You under this Section 4 for the Software shall terminate as of the date such litigation is filed. + +## 5. Automatic Conversion to the Future License + +**5.1 Automatic effect.** Upon the Conversion Event for a Phase, the rights and restrictions in Sections 3 (Commercial Use) of this License, as they apply to that Phase's Milestone Release, terminate automatically. In their place, the Milestone Release is licensed under the Future License identified in that Phase's Phase Manifest, effective as of the Conversion Event, without any further act, declaration, or attestation required by the Licensor, any Trust Service, or any other party. + +**5.2 Irrevocability.** Once a valid Conversion Event has occurred for a Phase, no subsequent refund, chargeback, accounting correction, dispute, or termination of this License for an unrelated breach shall revoke, suspend, or otherwise impair the Future License grant for that Phase's Milestone Release. Any shortfall or dispute arising after a Conversion Event is a commercial or accounting matter between the relevant parties and does not reinstate a commercial-use restriction over already-converted Software. + +**5.3 Prior freedom preserved.** A later Phase covering subsequent improvements to the Software does not restrict, withdraw, or otherwise affect the rights granted under the Future License for an earlier Phase's already-converted Milestone Release. + +**5.4 Evidence, not cause.** A Trust Service may publish a Conversion Attestation documenting a Conversion Event. Such an attestation is evidence that the Conversion Event occurred; it is not a condition of, and its absence or delay does not postpone, the automatic effect described in Section 5.1. Any person may independently verify whether a Conversion Event has occurred directly from the Phase Manifest and Target Ledger. + +## 6. Successive Phases + +The Licensor may declare a new Phase covering subsequent improvements to the Software following a Milestone Release's Conversion Event. Each Phase is independently governed by its own Phase Manifest, Initial Target, degeneration policy, and Target Ledger. Nothing in a later Phase's Phase Manifest may be construed to reduce or withdraw rights already granted under Section 5 for an earlier Phase's Milestone Release. + +## 7. Term and Termination + +**7.1 Term.** This License applies to the Software for the duration of the applicable Phase, and, for the Milestone Release, indefinitely following that Phase's Conversion Event under the Future License. + +**7.2 Termination for breach.** If You breach Section 3 (Commercial Use) or Section 2(c) (redistribution notice requirement), the Licensor may terminate this License as to You. Before such termination becomes effective, the Licensor shall provide You written notice of the breach; if You cure the breach within thirty (30) days of that notice, this License continues in effect. A second breach of the same provision within twelve (12) months may be terminated immediately without a further cure opportunity. + +**7.3 Effect of termination.** Termination under this Section 7 affects only Your rights under Sections 2 and 3 for the Phase in which the breach occurred. It does not affect any rights already vested under Section 5 (Automatic Conversion) for a Milestone Release whose Conversion Event has already occurred, per Section 5.2. + +**7.4 Public record of breach and resolution.** The Licensor shall cause the Trust Service to publish, as part of the public record for the affected Phase, notice of: (a) any breach notice issued under Section 7.2, stating the general nature of the breach and the date of notice; (b) whether the breach was cured within the applicable cure period, and the date of cure; and (c) any termination determination made under this Section 7, including its effective date and scope. This public record exists to give the ecosystem a transparent, verifiable conformity signal for the Phase, distinct from and in addition to the Development Credit and Remission Credit facts already published under Section 5.4 and the Target Ledger Specification. + +A breach that You dispute, and that has not been finally determined, shall be recorded as **alleged**; it shall be recorded as **determined** only once the cure period has run without cure, or the dispute has been resolved against You under the applicable Commercial Use Agreement's dispute process, if any. The Trust Service shall update the record promptly upon resolution in either direction. Recording an alleged or determined breach under this Section 7.4 is a ministerial act of publishing the Licensor's determination (or a dispute process's outcome); it does not give the Trust Service discretionary authority to decide whether a breach occurred, consistent with Section 5.4's evidence-not-cause principle. + +Whether, and under what conditions, the public record identifies a Commercial Entitlement holder by name is governed exclusively by the applicable Commercial Use Agreement, which the Licensor and that Commercial Entitlement holder negotiate and agree to directly. This License does not itself set a naming default. Where no Commercial Use Agreement addresses the question, or where the affected party has no Commercial Use Agreement at all (for example, a Section 2(c) breach by a Noncommercial Use licensee), the public record states the Phase and breach category only, without naming the party. + +## 8. Disclaimer of Warranty + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. THE LICENSOR DOES NOT WARRANT THAT THE SOFTWARE WILL BE ERROR-FREE OR THAT ANY PHASE WILL REACH ITS CONVERSION EVENT. + +## 9. Limitation of Liability + +IN NO EVENT SHALL THE LICENSOR OR ANY CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE, EXCEPT TO THE EXTENT SUCH LIMITATION IS PROHIBITED BY APPLICABLE LAW. + +## 10. Trademarks + +This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary attribution. + +## 11. General Provisions + +**11.1 Governing law and venue.** Adopted for alpha/beta 2026-07-29: disputes arising under this License shall be resolved by binding arbitration, seated at a neutral, arbitration-mature venue (Singapore or London are the two candidates concretely supported by current research), rather than by litigation in a national court. The specific arbitral institution and substantive governing law remain a per-deployment blank pending final selection; they are not fixed by this candidate. See the canonical repository's `history/260729-TRSL-Jurisdiction-Synthesis.md` §2. + +**11.2 Severability.** If any provision of this License is held unenforceable, the remaining provisions remain in full force, and the unenforceable provision shall be reformed to the minimum extent necessary to make it enforceable. + +**11.3 No waiver.** Failure to enforce any provision of this License is not a waiver of future enforcement of that or any other provision. + +**11.4 Entire agreement (as to licensing).** This License, together with the applicable Phase Manifest and, where applicable, the Commercial Use Agreement, constitutes the entire agreement between You and the Licensor regarding the Software's licensing terms. Operations, service, and consulting arrangements are governed by separate agreements, if any, and are not part of this License. + +**11.5 Definitions control.** Marketing materials, documentation, or other non-normative communications about the Software must not describe pre-Conversion-Event Software as "Open Source," "free software," or "open core." Pre-conversion Noncommercial Use is **source-available**; pre-conversion Commercial Use requires a **Commercial Entitlement**; only post-conversion Software may be described as Open Source, under the Future License. + +--- + +**No Phase is currently declared for this repository under this License.** Until a Phase Manifest is published and registered with the Trust Service for a Milestone Release in this repository, Sections 2–7 above have no operative subject matter here — this License establishes the governing framework in advance of that declaration, consistent with the org-wide rollout decision recorded in `target-revenue`'s `workplans/TREV-WP-0008-governance-and-pilot-rollout.md`. diff --git a/Makefile b/Makefile index a04c9d6..0aca222 100644 --- a/Makefile +++ b/Makefile @@ -34,6 +34,15 @@ ir: ## Extract the technology-neutral IR (ir/) from the designbook mirror. One-w adapt-lit: ## Project the IR onto the Lit stack: regen tokens (full gen), scaffold + drift (T07). $(NODE) adapters/lit/adapt.mjs +parity-lit: ## Confirm Lit elements honour the IR contract + render (browser). Exit 4 on parity failure. + $(NODE) adapters/lit/parity.mjs + +designbook-refresh: ## Refresh routine: check->pull->sync->ir->adapt-lit->(drift triage)->parity. ARGS=--no-pull etc. + $(NODE) scripts/designbook-refresh.mjs $(ARGS) + +adapt-plain-css: ## Second-adapter SMOKE: prove a non-Lit adapter consumes the same ir/ (WHYNOT-WP-0002 T10). + $(NODE) adapters/plain-css/adapt.mjs + recent-changes: ## Regenerate RecentChanges.md (alias of the reporter; --range supported). $(NODE) scripts/designbook-sync.mjs $(ARGS) diff --git a/MultiFrameworkSupport.md b/MultiFrameworkSupport.md index 8a75e5f..5aafcdb 100644 --- a/MultiFrameworkSupport.md +++ b/MultiFrameworkSupport.md @@ -109,7 +109,7 @@ This is the canonical non-React case and worth covering in detail. ```sh # In the Django app's repo. -pnpm add git+ssh://git@gitea.example.com/whynot/whynot-design.git#v0.2.0 +pnpm add git+ssh://git@forgejo.coulomb.social/coulomb/whynot-design.git#v0.2.0 # Or vendor without Node tooling — copy three files: mkdir -p myapp/static/whynot diff --git a/PUBLISHING.md b/PUBLISHING.md index 08743cd..49c9ee5 100644 --- a/PUBLISHING.md +++ b/PUBLISHING.md @@ -1,24 +1,25 @@ # Publishing `@whynot/design` -`@whynot/design` is published to the **coulomb Gitea npm registry** so consuming +`@whynot/design` is published to the **coulomb Forgejo npm registry** so consuming repos can pin a version (`npm i @whynot/design@x.y.z`) and track it at their own pace (WHYNOT-WP-0003). The git tag cut by `make release` (see `DesignSystemIntroduction.md` §6) is the version; publishing makes that version installable. -- Registry: `https://gitea.coulomb.social/api/packages/coulomb/npm/` +- Registry: `https://forgejo.coulomb.social/api/packages/coulomb/npm/` - `package.json` `publishConfig.registry` already points `npm publish` here. - `lit` is a **peerDependency** — consumers install it themselves so their bundler dedupes to a single `lit` instance. ## The token (never commit it) -Publishing and installing `@whynot/*` need a Gitea package token. It is **not stored in +Publishing and installing `@whynot/*` need a Forgejo package token. It is **not stored in this repo** — per `.claude/rules/credential-routing.md`, tokens are routed, not vended: -a Gitea package token is operator/OpenBao-owned (`railiance-platform`). Obtain one from -the operator and export it: +a Forgejo package token is operator/OpenBao-owned (`railiance-platform`). Use the +`whynot-design-npm-publish` governed lane for publishing; interactive operators may +export a value obtained through the same route: ```sh -export NPM_AUTH_TOKEN=… # Gitea package token; never paste into git/chat/logs +export NPM_AUTH_TOKEN=… # Forgejo package token; never paste into git/chat/logs ``` `.npmrc` (committed) references it via `${NPM_AUTH_TOKEN}` — no secret lives in the file. @@ -42,8 +43,8 @@ then install the package plus the `lit` peer: ```ini # .npmrc -@whynot:registry=https://gitea.coulomb.social/api/packages/coulomb/npm/ -//gitea.coulomb.social/api/packages/coulomb/npm/:_authToken=${NPM_AUTH_TOKEN} +@whynot:registry=https://forgejo.coulomb.social/api/packages/coulomb/npm/ +//forgejo.coulomb.social/api/packages/coulomb/npm/:_authToken=${NPM_AUTH_TOKEN} ``` ```sh diff --git a/README.md b/README.md index 9147755..5b5c9fa 100644 --- a/README.md +++ b/README.md @@ -38,18 +38,18 @@ Framework-agnostic by design. Consumers do **not** re-implement components per f ### Node-tooled consumer (React, Vite, Next, Vue, …) -Install from the coulomb Gitea npm registry (add the scope to your `.npmrc` first — see +Install from the coulomb Forgejo npm registry (add the scope to your `.npmrc` first — see [`PUBLISHING.md`](./PUBLISHING.md) for the token). `lit` is a peer dependency: ```ini # .npmrc -@whynot:registry=https://gitea.coulomb.social/api/packages/coulomb/npm/ -//gitea.coulomb.social/api/packages/coulomb/npm/:_authToken=${NPM_AUTH_TOKEN} +@whynot:registry=https://forgejo.coulomb.social/api/packages/coulomb/npm/ +//forgejo.coulomb.social/api/packages/coulomb/npm/:_authToken=${NPM_AUTH_TOKEN} ``` ```sh npm i @whynot/design@0.3.0 lit -# or pin straight from git: pnpm add git+ssh://git@gitea.coulomb.social/coulomb/whynot-design.git#v0.3.0 +# or pin straight from git: pnpm add git+ssh://git@forgejo.coulomb.social/coulomb/whynot-design.git#v0.3.0 ``` ```js diff --git a/RecentChanges.md b/RecentChanges.md index 25c512a..e8ce232 100644 --- a/RecentChanges.md +++ b/RecentChanges.md @@ -2,7 +2,7 @@ Snapshot of the last designbook integration. Regenerated by `make designbook-sync`. -- Generated: 2026-06-23T19:25:28Z +- Generated: 2026-06-30T07:48:39Z - Compared: working tree (uncommitted) - Last /design-sync: 2026-06-23T19:25:28Z @@ -10,48 +10,6 @@ Snapshot of the last designbook integration. Regenerated by `make designbook-syn > into `CHANGELOG.md` under `## [Unreleased]` before releasing; that is the file CI > enforces (`pnpm check`). The designbook itself is synced via `/design-sync`, not this script. -## Changed files +## No changes -### Designbook -- `ADDED ` designbook/_ds_bundle.js (+1396 / -0) -- `ADDED ` designbook/_ds_manifest.json (+1 / -0) -- `ADDED ` designbook/.design-pull.json (+18 / -0) -- `ADDED ` designbook/colors_and_type.css (+293 / -0) -- `ADDED ` designbook/preview/brand-iconography.html (+36 / -0) -- `ADDED ` designbook/preview/brand-lockups.html (+26 / -0) -- `ADDED ` designbook/preview/brand-logo.html (+21 / -0) -- `ADDED ` designbook/preview/brand-wireframe-motif.html (+43 / -0) -- `ADDED ` designbook/preview/colors-accent.html (+33 / -0) -- `ADDED ` designbook/preview/colors-borders.html (+25 / -0) -- `ADDED ` designbook/preview/colors-neutrals.html (+36 / -0) -- `ADDED ` designbook/preview/colors-signal.html (+25 / -0) -- `ADDED ` designbook/preview/colors-status-functional.html (+31 / -0) -- `ADDED ` designbook/preview/comp-buttons.html (+40 / -0) -- `ADDED ` designbook/preview/comp-empty-placeholder.html (+38 / -0) -- `ADDED ` designbook/preview/comp-inputs.html (+30 / -0) -- `ADDED ` designbook/preview/comp-labels-tags.html (+44 / -0) -- `ADDED ` designbook/preview/comp-left-nav.html (+85 / -0) -- `ADDED ` designbook/preview/comp-pipeline.html (+30 / -0) -- `ADDED ` designbook/preview/comp-prototype-card.html (+46 / -0) -- `ADDED ` designbook/preview/comp-topnav.html (+37 / -0) -- `ADDED ` designbook/preview/page-beta-invitation.html (+104 / -0) -- `ADDED ` designbook/preview/page-landing-auth.html (+224 / -0) -- `ADDED ` designbook/preview/page-prototype-detail.html (+158 / -0) -- `ADDED ` designbook/preview/page-signals-dashboard.html (+135 / -0) -- `ADDED ` designbook/preview/spacing-elevation.html (+26 / -0) -- `ADDED ` designbook/preview/spacing-radii.html (+24 / -0) -- `ADDED ` designbook/preview/spacing-scale.html (+28 / -0) -- `ADDED ` designbook/preview/type-body.html (+23 / -0) -- `ADDED ` designbook/preview/type-display.html (+23 / -0) -- `ADDED ` designbook/preview/type-headings.html (+20 / -0) -- `ADDED ` designbook/preview/type-mono-eyebrows.html (+42 / -0) -- `ADDED ` designbook/preview/type-serif-quote.html (+17 / -0) -- `ADDED ` designbook/REACT_CANONICAL_DECISION.md (+60 / -0) -- `ADDED ` designbook/styles.css (+9 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/Atoms.jsx (+102 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/Chrome.jsx (+163 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/data.jsx (+71 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/DocView.jsx (+102 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/index.html (+77 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/README.md (+31 / -0) -- `ADDED ` designbook/ui_kits/whynot-control/Screens.jsx (+274 / -0) +The design surface is unchanged since the last sync. \ No newline at end of file diff --git a/SCOPE.md b/SCOPE.md index 198ae3f..6ac4330 100644 --- a/SCOPE.md +++ b/SCOPE.md @@ -23,10 +23,26 @@ whynot-design exists to provide the capability described in INTENT.md. ## Current State -- Status: active; implementation and stability should be verified by the repo agent. +- Status: the visual language is published as `@whynot/design`. Bootstrap + (WHYNOT-WP-0001), the IR/adapter pipeline (WHYNOT-WP-0002), and + downstream consumption (WHYNOT-WP-0003) are finished. +- Open residual: WHYNOT-IN-0001 (consumer npm-read lane). ## Getting Oriented - Start with: INTENT.md - Agent instructions: AGENTS.md - Workplans: workplans/ + +## Generated work-record index + +This repository opts into staged-source WORK-RECORDS.md generation through +`.generated-work-records.json` and the isolated `.generated-work-records.mk` +recipe. `make generated-work-records` reuses the State Hub renderer through +the Custodian adapter; `make generated-work-records-check` verifies byte-exact +agreement with staged Markdown. The pre-commit hook uses the isolated recipe, +preserves unstaged index edits by refusing them, and retains the generated-only +commit guard. It does not contact the hub, alter workplan statuses, or grant +deployment authority. This consumes shared tooling; it does not make this +repository the provider of the generator capability. + diff --git a/WORK-RECORDS.md b/WORK-RECORDS.md new file mode 100644 index 0000000..b3efcf4 --- /dev/null +++ b/WORK-RECORDS.md @@ -0,0 +1,31 @@ +# Work Records — whynot-design + +> Generated by `statehub fix-consistency` (CUST-WP-0061-T04, work-record +> stage 3). Do not edit by hand — edit the source file/block listed for +> each record and re-run fix-consistency to refresh this index. Archived +> workplans are omitted; closed decisions/intakes/engagements stay listed +> so recently-resolved work is still visible. [auto] + +| Kind | ID | Status | Lane | Source | +| --- | --- | --- | --- | --- | +| workplan | WHYNOT-WP-0001 | finished | — | workplans/WHYNOT-WP-0001-statehub-bootstrap.md | +| workplan | WHYNOT-WP-0002 | finished | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| workplan | WHYNOT-WP-0004 | finished | — | workplans/WHYNOT-WP-0004-forgejo-npm-migration.md | +| task | WHYNOT-WP-0001-T01 | done | — | workplans/WHYNOT-WP-0001-statehub-bootstrap.md | +| task | WHYNOT-WP-0001-T02 | done | — | workplans/WHYNOT-WP-0001-statehub-bootstrap.md | +| task | WHYNOT-WP-0001-T03 | done | — | workplans/WHYNOT-WP-0001-statehub-bootstrap.md | +| task | WHYNOT-WP-0002-T01 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T02 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T03 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T04 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T05 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T06 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T07 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T08 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T09 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T10 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0002-T11 | done | — | workplans/WHYNOT-WP-0002-designbook-stack-adapters.md | +| task | WHYNOT-WP-0004-T01 | done | — | workplans/WHYNOT-WP-0004-forgejo-npm-migration.md | +| task | WHYNOT-WP-0004-T02 | done | — | workplans/WHYNOT-WP-0004-forgejo-npm-migration.md | +| task | WHYNOT-WP-0004-T03 | done | — | workplans/WHYNOT-WP-0004-forgejo-npm-migration.md | +| intake | WHYNOT-IN-0001 | open | yellow | intakes/intakes.md | diff --git a/adapters/lit/README.md b/adapters/lit/README.md index 828a2dd..9c81187 100644 --- a/adapters/lit/README.md +++ b/adapters/lit/README.md @@ -13,8 +13,35 @@ Per the contract, an adapter is **scaffold + drift-detect**, never a rewrite: | Concern | Behaviour | Status | |---|---|---| | **Tokens** | **Fully generated** from `ir/tokens.json` into the `:root` block of `src/styles/colors_and_type.css`, between `@generated tokens` markers. Deterministic — re-running with an unchanged IR is a byte-identical no-op. The hand-authored type/utility CSS after the block is preserved. | **done (T06)** | -| **New component** | Generate a `` Lit stub from the IR contract's prop→attribute map + a behaviour `TODO`. | T07 | -| **Changed component** | Emit a **drift report** (`adapters/lit/drift/.md`) — never overwrite the hand-authored element. | T07 | +| **New component** | Generate a `` Lit stub (`adapters/lit/stubs/.js`) from the IR contract's prop→attribute map + a behaviour `TODO`. **Write-once** — into a staging dir, never the hand-authored tree; the human integrates it. | **done (T07)** | +| **Changed component** | Emit a **drift report** (`adapters/lit/drift/.md` + machine `_report.json`) — never overwrite the hand-authored element. | **done (T07)** | + +### Drift severity + +`make adapt-lit` exits `3` only on **actionable** drift — `prop-missing`, +`attribute-mismatch`, `variant-axis-missing`, `tag-mismatch`. **Informational** +issues do not gate: `non-portable` (React `style`/callbacks that inherently have +no attribute form — the Lit element is right to omit them) and `prop-extra` (the +Lit element is richer than the minimal React designbook). Resolve actionable drift +per `.claude/rules/designbook-propagation.md` (fix the stack, or change the language +in Claude Design and re-propagate — never a stack→React back-edit). + +## Parity — `make parity-lit` + +`adapters/lit/parity.mjs` renders every `` in a real browser (Playwright) and +writes `adapters/lit/parity/_parity.json` (the contract's parity-result shape): + +- **Contract parity** — each element must upgrade and carry no `attribute-mismatch` + vs its IR contract (computed statically, so no runtime type-coercion false + positives). A prop the element *lacks* is a coverage note (already surfaced as + drift), not a parity failure. +- **Visual parity** — a render smoke: the element renders non-empty with a positive + box; a screenshot is saved to `adapters/lit/parity/.png` (gitignored) as the + artifact. The `ir/exemplars/.html` are designbook **gallery cards** (a grid + of all variants), not single-component baselines, so an automated pixel diff + against them is not meaningful — per-component Lit appearance regression is owned + by the Playwright baseline suite (`tests/visual/`); the exemplar is the human + visual reference. Exit `4` on a contract or render failure. ## Directionality diff --git a/adapters/lit/adapt.mjs b/adapters/lit/adapt.mjs index c696d36..aba1f6f 100644 --- a/adapters/lit/adapt.mjs +++ b/adapters/lit/adapt.mjs @@ -16,13 +16,18 @@ // type/utility CSS after it is preserved untouched. Re-running with an unchanged // ir/tokens.json is a no-op (byte-identical output). // ============================================================= -import { readFileSync, writeFileSync, existsSync } from "node:fs"; +import { readFileSync, writeFileSync, existsSync, mkdirSync, readdirSync, rmSync } from "node:fs"; +import { execSync } from "node:child_process"; import { join, dirname } from "node:path"; import { fileURLToPath } from "node:url"; +import { parseLitElements, componentDrift, renderStub, loadAccepted } from "./scaffold.mjs"; const REPO = join(dirname(fileURLToPath(import.meta.url)), "..", ".."); const TOKENS_JSON = join(REPO, "ir", "tokens.json"); const TOKEN_CSS = join(REPO, "src", "styles", "colors_and_type.css"); +const IR_COMPONENTS = join(REPO, "ir", "components"); +const DRIFT_DIR = join(REPO, "adapters", "lit", "drift"); +const STUBS_DIR = join(REPO, "adapters", "lit", "stubs"); const BEGIN = "/* @generated tokens — regenerated by `make adapt-lit` from ir/tokens.json. DO NOT EDIT. */"; const END = "/* @end generated tokens */"; @@ -85,10 +90,105 @@ function generateTokens() { console.log(`tokens: regenerated ${count} custom properties → src/styles/colors_and_type.css`); } +// ---------- T07: component scaffold + drift ---------- +function irRef() { + try { + return execSync("git rev-parse --short HEAD", { cwd: REPO }).toString().trim(); + } catch { return "(no-git)"; } +} + +function renderDriftMd(c) { + const head = { + ok: "✓ in sync with the IR contract.", + drift: "⚠ drift detected — resolve per `.claude/rules/designbook-propagation.md`.", + new: "+ new component — a stub was generated; integrate it.", + removed: "- removed from the IR.", + }[c.status]; + const lines = [ + ``, + `# Drift — ${c.name} \`<${c.tag}>\``, + "", + `**Status:** ${c.status} — ${head}`, + "", + ]; + if (!c.issues.length) lines.push("No issues."); + else { + lines.push("| severity | kind | prop | detail |", "| --- | --- | --- | --- |"); + const order = { drift: 0, info: 1 }; + for (const i of [...c.issues].sort((a, b) => order[a.severity] - order[b.severity])) { + const detail = i.detail || (i.expected !== undefined ? `expected \`${i.expected}\`, actual \`${i.actual}\`` : ""); + lines.push(`| ${i.severity === "drift" ? "**drift**" : "info"} | ${i.kind} | ${i.prop ? `\`${i.prop}\`` : "—"} | ${detail} |`); + } + } + lines.push(""); + return lines.join("\n"); +} + +function runScaffold() { + if (!existsSync(IR_COMPONENTS)) { + console.error("No ir/components/ — run `make ir` first."); + process.exit(2); + } + const byTag = parseLitElements(REPO); + const accepted = loadAccepted(REPO); + const contracts = readdirSync(IR_COMPONENTS).filter((f) => f.endsWith(".json")) + .map((f) => JSON.parse(readFileSync(join(IR_COMPONENTS, f), "utf8"))); + + const results = contracts.map((c) => componentDrift(c, byTag, accepted)) + .sort((a, b) => a.name.localeCompare(b.name)); + + // Per-component drift docs: snapshot, so wipe stale ones first (idempotency rule 4). + mkdirSync(DRIFT_DIR, { recursive: true }); + for (const f of readdirSync(DRIFT_DIR)) if (f.endsWith(".md")) rmSync(join(DRIFT_DIR, f)); + for (const c of results) writeFileSync(join(DRIFT_DIR, `${c.name}.md`), renderDriftMd(c)); + + // Machine roll-up. Reuse generatedAt when nothing material changed so a no-op + // `make adapt-lit` produces no git churn (matches ir/manifest.json discipline). + const reportPath = join(DRIFT_DIR, "_report.json"); + let generatedAt = new Date().toISOString(); + let ref = irRef(); + if (existsSync(reportPath)) { + try { + const prev = JSON.parse(readFileSync(reportPath, "utf8")); + if (JSON.stringify(prev.components) === JSON.stringify(results)) { + if (prev.generatedAt) generatedAt = prev.generatedAt; + if (prev.irRef) ref = prev.irRef; // unchanged drift ⇒ keep the prior ref, no churn + } + } catch { /* regenerate fresh */ } + } + const report = { stack: "lit", generatedAt, irRef: ref, components: results }; + writeFileSync(reportPath, JSON.stringify(report, null, 2) + "\n"); + + // Write-once stubs for genuinely new components. + let stubbed = 0; + for (const c of results.filter((r) => r.status === "new")) { + mkdirSync(STUBS_DIR, { recursive: true }); + const out = join(STUBS_DIR, `${c.name}.js`); + if (!existsSync(out)) { writeFileSync(out, renderStub(contracts.find((x) => x.name === c.name))); stubbed++; } + } + + const drift = results.filter((r) => r.status === "drift"); + const isNew = results.filter((r) => r.status === "new"); + const ok = results.filter((r) => r.status === "ok"); + const infoCount = ok.reduce((n, r) => n + r.issues.length, 0); + console.log(`scaffold: ${ok.length} ok · ${drift.length} drift · ${isNew.length} new (${stubbed} stub${stubbed === 1 ? "" : "s"} written) → adapters/lit/drift/`); + if (infoCount) console.log(` (${infoCount} informational note${infoCount === 1 ? "" : "s"} on in-sync components — non-portable/extra props, not gated)`); + for (const c of [...drift, ...isNew]) { + const actionable = c.issues.filter((i) => i.severity === "drift"); + console.log(` ${c.status === "drift" ? "⚠" : "+"} ${c.name}: ${actionable.map((i) => `${i.kind}(${i.prop ?? ""})`).join(", ") || c.issues.map((i) => i.kind).join(", ")}`); + } + + return drift.length + isNew.length > 0; // → drift exit code +} + function main() { generateTokens(); - // T07 will add: component stub scaffolding + drift reports here. - console.log("adapt-lit: tokens done. (component scaffold + drift: T07)"); + const drifted = runScaffold(); + if (drifted) { + console.log("adapt-lit: drift detected — see adapters/lit/drift/. Exit 3 (review, non-fatal)."); + process.exit(3); + } + console.log("adapt-lit: tokens + scaffold done, no drift."); } main(); diff --git a/adapters/lit/drift.accepted.json b/adapters/lit/drift.accepted.json new file mode 100644 index 0000000..38ed9b7 --- /dev/null +++ b/adapters/lit/drift.accepted.json @@ -0,0 +1,17 @@ +{ + "_comment": "Human-curated accepted divergences — the auditable output of drift triage (WHYNOT-WP-0002). An entry downgrades a specific drift issue to an informational, justified note so it does not gate make adapt-lit/parity-lit. Use ONLY for intentional React<->Lit modelling differences, never to silence a real defect. Keyed by component + drift kind + prop. See .claude/rules/designbook-propagation.md.", + "accepted": [ + { + "component": "Sidebar", + "kind": "prop-missing", + "prop": "current", + "rationale": "Composition divergence (intentional). The React Sidebar is monolithic and takes a `current` selection-key prop, comparing it against its own internal NAV_ITEMS. The Lit stack decomposes the sidebar into + + , modelling selection as per-item `active` state on the slotted children rather than a container-level key. There is no single `current` attribute to honour on ; the contract is satisfied compositionally. Reconcile upstream only if the React designbook is ever made composable." + }, + { + "component": "Sidebar", + "kind": "variant-axis-missing", + "prop": "current", + "rationale": "Same composition divergence as Sidebar.current above — the `current` variant axis is expressed as item-level `active` on , not as a property." + } + ] +} diff --git a/adapters/lit/drift/Button.md b/adapters/lit/drift/Button.md new file mode 100644 index 0000000..c878c74 --- /dev/null +++ b/adapters/lit/drift/Button.md @@ -0,0 +1,14 @@ + +# Drift — Button `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `onClick` | type=function; not attribute-mappable — handle explicitly, never drop. | +| info | non-portable | `style` | type=object; not attribute-mappable — handle explicitly, never drop. | +| info | prop-extra | `size` | on (attribute 'size'), not in IR contract. | +| info | prop-extra | `iconEnd` | on (attribute 'icon-end'), not in IR contract. | +| info | prop-extra | `type` | on (attribute 'type'), not in IR contract. | +| info | prop-extra | `disabled` | on (attribute 'disabled'), not in IR contract. | +| info | prop-extra | `href` | on (attribute 'href'), not in IR contract. | diff --git a/adapters/lit/drift/Eyebrow.md b/adapters/lit/drift/Eyebrow.md new file mode 100644 index 0000000..c33047f --- /dev/null +++ b/adapters/lit/drift/Eyebrow.md @@ -0,0 +1,9 @@ + +# Drift — Eyebrow `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `style` | type=object; not attribute-mappable — handle explicitly, never drop. | +| info | prop-extra | `strong` | on (attribute 'strong'), not in IR contract. | diff --git a/adapters/lit/drift/Icon.md b/adapters/lit/drift/Icon.md new file mode 100644 index 0000000..5d6ea4d --- /dev/null +++ b/adapters/lit/drift/Icon.md @@ -0,0 +1,8 @@ + +# Drift — Icon `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `style` | type=object; not attribute-mappable — handle explicitly, never drop. | diff --git a/adapters/lit/drift/PageHeader.md b/adapters/lit/drift/PageHeader.md new file mode 100644 index 0000000..d522ebe --- /dev/null +++ b/adapters/lit/drift/PageHeader.md @@ -0,0 +1,9 @@ + +# Drift — PageHeader `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | prop-via-slot | `actions` | IR prop honoured by on (slotted content, not an attribute). | +| info | prop-extra | `hasActions` | on (attribute 'hasactions'), not in IR contract. | diff --git a/adapters/lit/drift/PipelineStrip.md b/adapters/lit/drift/PipelineStrip.md new file mode 100644 index 0000000..9c6fce0 --- /dev/null +++ b/adapters/lit/drift/PipelineStrip.md @@ -0,0 +1,8 @@ + +# Drift — PipelineStrip `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | prop-extra | `stages` | on (attribute 'stages'), not in IR contract. | diff --git a/adapters/lit/drift/Sidebar.md b/adapters/lit/drift/Sidebar.md new file mode 100644 index 0000000..e180adf --- /dev/null +++ b/adapters/lit/drift/Sidebar.md @@ -0,0 +1,11 @@ + +# Drift — Sidebar `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | prop-missing | `current` | in IR (attribute 'current'), absent on | +| info | non-portable | `onNav` | type=function; not attribute-mappable — handle explicitly, never drop. | +| info | variant-axis-missing | `current` | IR variant axis 'current' (doc:) has no Lit property. | +| info | prop-extra | `activation` | on (attribute 'activation'), not in IR contract. | diff --git a/adapters/lit/drift/StageDot.md b/adapters/lit/drift/StageDot.md new file mode 100644 index 0000000..a85ac53 --- /dev/null +++ b/adapters/lit/drift/StageDot.md @@ -0,0 +1,8 @@ + +# Drift — StageDot `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `style` | type=object; not attribute-mappable — handle explicitly, never drop. | diff --git a/adapters/lit/drift/Stamp.md b/adapters/lit/drift/Stamp.md new file mode 100644 index 0000000..3727399 --- /dev/null +++ b/adapters/lit/drift/Stamp.md @@ -0,0 +1,8 @@ + +# Drift — Stamp `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `style` | type=object; not attribute-mappable — handle explicitly, never drop. | diff --git a/adapters/lit/drift/Tag.md b/adapters/lit/drift/Tag.md new file mode 100644 index 0000000..a946994 --- /dev/null +++ b/adapters/lit/drift/Tag.md @@ -0,0 +1,8 @@ + +# Drift — Tag `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `style` | type=object; not attribute-mappable — handle explicitly, never drop. | diff --git a/adapters/lit/drift/TopNav.md b/adapters/lit/drift/TopNav.md new file mode 100644 index 0000000..c7213c9 --- /dev/null +++ b/adapters/lit/drift/TopNav.md @@ -0,0 +1,11 @@ + +# Drift — TopNav `` + +**Status:** ok — ✓ in sync with the IR contract. + +| severity | kind | prop | detail | +| --- | --- | --- | --- | +| info | non-portable | `onNew` | type=function; not attribute-mappable — handle explicitly, never drop. | +| info | prop-extra | `logoSrc` | on (attribute 'logo-src'), not in IR contract. | +| info | prop-extra | `brand` | on (attribute 'brand'), not in IR contract. | +| info | prop-extra | `slug` | on (attribute 'slug'), not in IR contract. | diff --git a/adapters/lit/drift/_report.json b/adapters/lit/drift/_report.json new file mode 100644 index 0000000..81c5b26 --- /dev/null +++ b/adapters/lit/drift/_report.json @@ -0,0 +1,223 @@ +{ + "stack": "lit", + "generatedAt": "2026-06-30T07:46:35.458Z", + "irRef": "756634c", + "components": [ + { + "name": "Button", + "status": "ok", + "tag": "wn-button", + "issues": [ + { + "kind": "non-portable", + "prop": "onClick", + "detail": "type=function; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + }, + { + "kind": "non-portable", + "prop": "style", + "detail": "type=object; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "size", + "detail": "on (attribute 'size'), not in IR contract.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "iconEnd", + "detail": "on (attribute 'icon-end'), not in IR contract.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "type", + "detail": "on (attribute 'type'), not in IR contract.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "disabled", + "detail": "on (attribute 'disabled'), not in IR contract.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "href", + "detail": "on (attribute 'href'), not in IR contract.", + "severity": "info" + } + ] + }, + { + "name": "Eyebrow", + "status": "ok", + "tag": "wn-eyebrow", + "issues": [ + { + "kind": "non-portable", + "prop": "style", + "detail": "type=object; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "strong", + "detail": "on (attribute 'strong'), not in IR contract.", + "severity": "info" + } + ] + }, + { + "name": "Icon", + "status": "ok", + "tag": "wn-icon", + "issues": [ + { + "kind": "non-portable", + "prop": "style", + "detail": "type=object; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + } + ] + }, + { + "name": "PageHeader", + "status": "ok", + "tag": "wn-page-header", + "issues": [ + { + "kind": "prop-via-slot", + "prop": "actions", + "detail": "IR prop honoured by on (slotted content, not an attribute).", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "hasActions", + "detail": "on (attribute 'hasactions'), not in IR contract.", + "severity": "info" + } + ] + }, + { + "name": "PipelineStrip", + "status": "ok", + "tag": "wn-pipeline", + "issues": [ + { + "kind": "prop-extra", + "prop": "stages", + "detail": "on (attribute 'stages'), not in IR contract.", + "severity": "info" + } + ] + }, + { + "name": "Sidebar", + "status": "ok", + "tag": "wn-sidebar", + "issues": [ + { + "kind": "prop-missing", + "prop": "current", + "detail": "in IR (attribute 'current'), absent on ", + "severity": "info", + "accepted": "Composition divergence (intentional). The React Sidebar is monolithic and takes a `current` selection-key prop, comparing it against its own internal NAV_ITEMS. The Lit stack decomposes the sidebar into + + , modelling selection as per-item `active` state on the slotted children rather than a container-level key. There is no single `current` attribute to honour on ; the contract is satisfied compositionally. Reconcile upstream only if the React designbook is ever made composable." + }, + { + "kind": "non-portable", + "prop": "onNav", + "detail": "type=function; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + }, + { + "kind": "variant-axis-missing", + "prop": "current", + "detail": "IR variant axis 'current' (doc:) has no Lit property.", + "severity": "info", + "accepted": "Same composition divergence as Sidebar.current above — the `current` variant axis is expressed as item-level `active` on , not as a property." + }, + { + "kind": "prop-extra", + "prop": "activation", + "detail": "on (attribute 'activation'), not in IR contract.", + "severity": "info" + } + ] + }, + { + "name": "StageDot", + "status": "ok", + "tag": "wn-stage-dot", + "issues": [ + { + "kind": "non-portable", + "prop": "style", + "detail": "type=object; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + } + ] + }, + { + "name": "Stamp", + "status": "ok", + "tag": "wn-stamp", + "issues": [ + { + "kind": "non-portable", + "prop": "style", + "detail": "type=object; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + } + ] + }, + { + "name": "Tag", + "status": "ok", + "tag": "wn-tag", + "issues": [ + { + "kind": "non-portable", + "prop": "style", + "detail": "type=object; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + } + ] + }, + { + "name": "TopNav", + "status": "ok", + "tag": "wn-top-nav", + "issues": [ + { + "kind": "non-portable", + "prop": "onNew", + "detail": "type=function; not attribute-mappable — handle explicitly, never drop.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "logoSrc", + "detail": "on (attribute 'logo-src'), not in IR contract.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "brand", + "detail": "on (attribute 'brand'), not in IR contract.", + "severity": "info" + }, + { + "kind": "prop-extra", + "prop": "slug", + "detail": "on (attribute 'slug'), not in IR contract.", + "severity": "info" + } + ] + } + ] +} diff --git a/adapters/lit/parity.mjs b/adapters/lit/parity.mjs new file mode 100644 index 0000000..f0225fe --- /dev/null +++ b/adapters/lit/parity.mjs @@ -0,0 +1,174 @@ +// ============================================================= +// adapters/lit/parity.mjs — make parity-lit (WHYNOT-WP-0002 · T08) +// +// The gate that confirms the Lit elements actually honour the IR contract. +// Renders each in a real browser (Playwright) and checks: +// +// (a) CONTRACT parity — for every IR-declared portable prop the element HAS, +// setting the IR-declared attribute must drive the property (no attribute +// contradiction). A prop the element lacks is a *coverage* note, not a +// contradiction — it is already surfaced by `make adapt-lit` drift (T07). +// (b) VISUAL parity — the element renders non-empty with a positive box; a +// screenshot is saved to adapters/lit/parity/.png as the artifact. +// +// On pixel-exact appearance: `ir/exemplars/.html` are designbook *gallery +// cards* (a grid of all variants), not single-component baselines, so a direct +// pixel diff against them is not meaningful. Per-component Lit appearance +// regression is owned by the Playwright baseline suite (tests/visual/). Visual +// parity here is a render smoke + artifact; the exemplar is the human reference. +// +// Result: adapters/lit/parity/_parity.json (adapters/ADAPTER_CONTRACT.md shape). +// Exit: 0 pass · 2 usage · 4 parity failure · 5 internal. +// ============================================================= +import { readFileSync, readdirSync, existsSync, mkdirSync, writeFileSync, rmSync } from "node:fs"; +import { spawn } from "node:child_process"; +import { join, dirname } from "node:path"; +import { fileURLToPath } from "node:url"; +import { parseLitElements, componentDrift, loadAccepted } from "./scaffold.mjs"; + +const REPO = join(dirname(fileURLToPath(import.meta.url)), "..", ".."); +const IR_COMPONENTS = join(REPO, "ir", "components"); +const OUT = join(REPO, "adapters", "lit", "parity"); +const PORT = 4399; + +async function loadChromium() { + for (const id of ["@playwright/test", "playwright", "playwright-core"]) { + try { return (await import(id)).chromium; } catch { /* next */ } + } + console.error("parity: Playwright not installed (need @playwright/test)."); process.exit(2); +} + +function waitForServer(url, tries = 30) { + return new Promise((resolve, reject) => { + const tick = (n) => fetch(url).then(() => resolve()).catch(() => { + if (n <= 0) return reject(new Error("server did not start")); + setTimeout(() => tick(n - 1), 200); + }); + tick(tries); + }); +} + +// Representative attribute values from the contract (to exercise rendering). +function fixtureAttrs(contract) { + const attrs = {}; + for (const p of contract.props || []) { + if (p.portable === false || p.attribute === false) continue; + if (p.type === "enum") attrs[p.attribute] = p.default ?? (p.enum && p.enum[0]) ?? ""; + else if (p.type === "number") attrs[p.attribute] = "1"; + else if (p.type === "boolean") attrs[p.attribute] = ""; + else attrs[p.attribute] = "Sample"; + } + return attrs; +} + +async function main() { + if (!existsSync(IR_COMPONENTS)) { console.error("No ir/components/ — run `make ir`."); process.exit(2); } + const contracts = readdirSync(IR_COMPONENTS).filter((f) => f.endsWith(".json")) + .map((f) => JSON.parse(readFileSync(join(IR_COMPONENTS, f), "utf8"))) + .sort((a, b) => a.name.localeCompare(b.name)); + + mkdirSync(OUT, { recursive: true }); + for (const f of readdirSync(OUT)) if (f.endsWith(".png")) rmSync(join(OUT, f)); + + const url = `http://127.0.0.1:${PORT}/examples/showcase/index.html`; + // Reuse an already-running static server (set by the caller / CI); only spawn + // and manage our own if none is up. Spawning is what some sandboxes dislike. + let server = null; + const alreadyUp = await fetch(url).then(() => true).catch(() => false); + if (!alreadyUp) { + server = spawn("python3", ["-m", "http.server", String(PORT), "--bind", "127.0.0.1"], + { cwd: REPO, stdio: "ignore" }); + } + const stopServer = () => { if (server) server.kill(); }; + const chromium = await loadChromium(); + let browser; + try { + await waitForServer(url); + browser = await chromium.launch({ args: ["--no-sandbox"] }); + const page = await browser.newPage({ viewport: { width: 800, height: 600 } }); + await page.route(/fonts\.(googleapis|gstatic)\.com/, (r) => r.abort()); + // The showcase page registers every wn-* element and loads components.css. + await page.goto(`http://127.0.0.1:${PORT}/examples/showcase/index.html`, { waitUntil: "commit" }); + await page.waitForFunction(() => !!customElements.get("wn-button"), null, { timeout: 8000 }); + await page.addStyleTag({ content: "#parity-stage{position:fixed;left:0;top:0;background:var(--paper);padding:16px;z-index:99999}" }); + + // Static contract analysis (precise attribute-name correctness, no runtime + // type-coercion false positives). The browser then confirms the element + // actually upgrades + renders — the thing static analysis cannot prove. + const byTag = parseLitElements(REPO); + const accepted = loadAccepted(REPO); + + const results = []; + for (const c of contracts) { + const tag = c.tag; + const drift = componentDrift(c, byTag, accepted); + const attrMismatch = drift.issues.filter((i) => i.kind === "attribute-mismatch" && i.severity === "drift"); + const missing = drift.issues.filter((i) => i.kind === "prop-missing" && i.severity === "drift"); + const hasDefaultSlot = (c.slots || []).some((s) => s.name === "default"); + + const observed = await page.evaluate(async ({ tag, attrs, hasDefaultSlot }) => { + if (!customElements.get(tag)) return { exists: false }; + let stage = document.getElementById("parity-stage"); + if (!stage) { stage = document.createElement("div"); stage.id = "parity-stage"; document.body.appendChild(stage); } + stage.innerHTML = ""; + const el = document.createElement(tag); + for (const [k, v] of Object.entries(attrs)) el.setAttribute(k, v); + if (hasDefaultSlot) el.textContent = "Sample"; + stage.appendChild(el); + await el.updateComplete?.catch(() => {}); + const r = el.getBoundingClientRect(); + const rendered = el.children.length > 0 || (el.textContent || "").trim().length > 0 || !!el.shadowRoot; + return { exists: true, rendered, rect: { w: Math.round(r.width), h: Math.round(r.height) } }; + }, { tag, attrs: fixtureAttrs(c), hasDefaultSlot }); + + if (!observed.exists) { + results.push({ name: c.name, contract: "skip", visual: "skip", diffRatio: null, + notes: `no <${tag}> element (see adapters/lit/drift/${c.name}.md)` }); + continue; + } + + // Screenshot the element box as the visual artifact. + try { + const h = await page.$("#parity-stage > *"); + if (h) await h.screenshot({ path: join(OUT, `${c.name}.png`) }); + } catch { /* non-fatal */ } + + const contract = attrMismatch.length ? "fail" : "pass"; + const visual = observed.rendered && (observed.rect.w > 0 || observed.rect.h > 0) ? "pass" : "fail"; + const notes = []; + if (attrMismatch.length) notes.push(`attribute-mismatch: ${attrMismatch.map((i) => `${i.prop} expected '${i.expected}' got '${i.actual}'`).join(", ")}`); + if (missing.length) notes.push(`coverage (drift, not gated): missing ${missing.map((i) => i.prop).join(", ")}`); + results.push({ name: c.name, contract, visual, diffRatio: null, box: observed.rect, notes: notes.join("; ") || "ok" }); + } + + const summary = { + total: results.length, + contractFail: results.filter((r) => r.contract === "fail").length, + visualFail: results.filter((r) => r.visual === "fail").length, + skipped: results.filter((r) => r.contract === "skip").length, + }; + const out = { stack: "lit", generatedAt: new Date().toISOString(), components: results, summary }; + writeFileSync(join(OUT, "_parity.json"), JSON.stringify(out, null, 2) + "\n"); + + console.log(`parity-lit: ${summary.total} components · contractFail=${summary.contractFail} · visualFail=${summary.visualFail} · skip=${summary.skipped}`); + for (const r of results) { + const flag = r.contract === "fail" || r.visual === "fail" ? "✗" : r.contract === "skip" ? "·" : "✓"; + console.log(` ${flag} ${r.name}: contract=${r.contract} visual=${r.visual}${r.notes && r.notes !== "ok" ? ` (${r.notes})` : ""}`); + } + + await browser.close(); + stopServer(); + if (summary.contractFail || summary.visualFail) { + console.log("parity-lit: FAILURE — see adapters/lit/parity/_parity.json. Exit 4."); + process.exit(4); + } + console.log("parity-lit: pass."); + } catch (e) { + if (browser) await browser.close().catch(() => {}); + stopServer(); + console.error("parity-lit: internal error —", e.message); + process.exit(5); + } +} + +main(); diff --git a/adapters/lit/parity/_parity.json b/adapters/lit/parity/_parity.json new file mode 100644 index 0000000..0af21a8 --- /dev/null +++ b/adapters/lit/parity/_parity.json @@ -0,0 +1,122 @@ +{ + "stack": "lit", + "generatedAt": "2026-06-30T07:49:18.063Z", + "components": [ + { + "name": "Button", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 82, + "h": 36 + }, + "notes": "ok" + }, + { + "name": "Eyebrow", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 45, + "h": 23 + }, + "notes": "ok" + }, + { + "name": "Icon", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 0, + "h": 23 + }, + "notes": "ok" + }, + { + "name": "PageHeader", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 117, + "h": 37 + }, + "notes": "ok" + }, + { + "name": "PipelineStrip", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 633, + "h": 76 + }, + "notes": "ok" + }, + { + "name": "Sidebar", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 273, + "h": 592 + }, + "notes": "ok" + }, + { + "name": "StageDot", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 56, + "h": 23 + }, + "notes": "ok" + }, + { + "name": "Stamp", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 63, + "h": 23 + }, + "notes": "ok" + }, + { + "name": "Tag", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 64, + "h": 24 + }, + "notes": "ok" + }, + { + "name": "TopNav", + "contract": "pass", + "visual": "pass", + "diffRatio": null, + "box": { + "w": 243, + "h": 57 + }, + "notes": "ok" + } + ], + "summary": { + "total": 10, + "contractFail": 0, + "visualFail": 0, + "skipped": 0 + } +} diff --git a/adapters/lit/scaffold.mjs b/adapters/lit/scaffold.mjs new file mode 100644 index 0000000..c704e82 --- /dev/null +++ b/adapters/lit/scaffold.mjs @@ -0,0 +1,235 @@ +// ============================================================= +// adapters/lit/scaffold.mjs — component scaffold + drift (WHYNOT-WP-0002 · T07) +// +// Pure functions over ir/ + the Lit source tree (src/elements/*.js). Per +// adapters/ADAPTER_CONTRACT.md: +// • IR component with no counterpart → a write-once STUB +// (adapters/lit/stubs/.js), never into the hand-authored tree. +// • IR component with a counterpart → a DRIFT REPORT +// (adapters/lit/drift/.md + a machine roll-up); never an overwrite. +// +// Behaviour is never generated — stubs carry a TODO; drift is for human triage. +// ============================================================= +import { readFileSync, readdirSync, existsSync } from "node:fs"; +import { join } from "node:path"; + +const ELEMENT_FILES = ["atoms.js", "form.js", "layout.js", "chrome.js"]; + +// ---------- Parse the Lit source tree → tag → element descriptor ---------- +// Extract the balanced { … } block that starts at/after `from`. +function balancedBlock(src, from) { + let i = src.indexOf("{", from), depth = 0; + const begin = i; + for (; i < src.length; i++) { + if (src[i] === "{") depth++; + else if (src[i] === "}" && --depth === 0) return src.slice(begin, i + 1); + } + return src.slice(begin); +} + +// Parse a `static properties = { … }` block body into { name: {attribute,type,reflect} }. +function parseProps(block) { + const props = {}; + // Each entry: `name: { … },` — scan key then its balanced object. + const re = /([A-Za-z_$][\w$]*)\s*:\s*\{/g; + let m; + while ((m = re.exec(block))) { + const name = m[1]; + const decl = balancedBlock(block, m.index + m[0].length - 1); + const attrM = /attribute\s*:\s*(false|"([^"]+)"|'([^']+)')/.exec(decl); + const typeM = /type\s*:\s*([A-Za-z]+)/.exec(decl); + const reflect = /reflect\s*:\s*true/.test(decl); + let attribute; + if (attrM) attribute = attrM[1] === "false" ? false : (attrM[2] || attrM[3]); + else attribute = name.toLowerCase(); // Lit default: lowercased property name + props[name] = { attribute, type: typeM ? typeM[1] : "String", reflect }; + re.lastIndex = m.index + m[0].length; // resume after the key (decl re-scanned harmlessly) + } + return props; +} + +// Find a class's own `static properties` (walks `extends` within the same file set). +function classProps(name, classes) { + const cls = classes[name]; + if (!cls) return {}; + const own = cls.propsBlock ? parseProps(cls.propsBlock) : {}; + const inherited = cls.extends && classes[cls.extends] ? classProps(cls.extends, classes) : {}; + return { ...inherited, ...own }; +} + +function classSlots(name, classes) { + const cls = classes[name]; + if (!cls) return new Set(); + const inherited = cls.extends && classes[cls.extends] ? classSlots(cls.extends, classes) : new Set(); + return new Set([...inherited, ...(cls.slots || [])]); +} + +export function parseLitElements(repo) { + const classes = {}; // className → { propsBlock, extends, file } + const defines = []; // { tag, className, file } + for (const file of ELEMENT_FILES) { + const path = join(repo, "src", "elements", file); + if (!existsSync(path)) continue; + const src = readFileSync(path, "utf8"); + const classRe = /class\s+([A-Za-z_$][\w$]*)\s+extends\s+([A-Za-z_$][\w$]*)/g; + let m; + while ((m = classRe.exec(src))) { + const [className, base] = [m[1], m[2]]; + const propsAt = src.indexOf("static properties", m.index); + // bound the search to before the next class declaration + classRe.lastIndex = m.index + m[0].length; + const nextClass = src.indexOf("class ", m.index + m[0].length); + const propsBlock = propsAt !== -1 && (nextClass === -1 || propsAt < nextClass) + ? balancedBlock(src, propsAt) : null; + // Named slots the element renders (e.g. ) — a prop can + // be honoured by a same-named slot rather than a reactive property. + const region = src.slice(m.index, nextClass === -1 ? undefined : nextClass); + const slots = [...region.matchAll(/ x[1]); + classes[className] = { propsBlock, extends: base, file, slots }; + } + const defRe = /customElements\.define\(\s*["']([\w-]+)["']\s*,\s*([A-Za-z_$][\w$]*)\s*\)/g; + while ((m = defRe.exec(src))) defines.push({ tag: m[1], className: m[2], file }); + } + const byTag = {}; + for (const d of defines) byTag[d.tag] = { ...d, props: classProps(d.className, classes), slots: classSlots(d.className, classes) }; + return byTag; +} + +// ---------- Drift: IR contract vs Lit element ---------- +// Actionable drift gates `make adapt-lit` (exit 3). The rest is informational: +// • non-portable — React style/callbacks that inherently have no attribute form; +// the Lit element is correct to omit them. Surfaced (never dropped), never gated. +// • prop-extra — the Lit element is richer than the minimal React designbook; +// a divergence worth noting, but not a defect to block on. +const ACTIONABLE = new Set(["prop-missing", "attribute-mismatch", "variant-axis-missing", "tag-mismatch"]); + +export function litAttrOf(decl) { + return decl.attribute === false ? null : decl.attribute; +} + +// Human-curated accepted divergences — the auditable output of drift triage for +// divergences that are intentional (e.g. a React monolithic prop modelled +// per-child in a composable Lit element). Keyed `::` → rationale. +// Read from adapters/lit/drift.accepted.json. An accepted issue is still listed in +// the report (marked "accepted: ") but downgraded to info, so it does not gate. +export function loadAccepted(repo) { + const path = join(repo, "adapters", "lit", "drift.accepted.json"); + if (!existsSync(path)) return {}; + try { + const out = {}; + for (const e of (JSON.parse(readFileSync(path, "utf8")).accepted || [])) + out[`${e.component}:${e.kind}:${e.prop ?? ""}`] = e.rationale || "accepted"; + return out; + } catch { return {}; } +} + +function classify(issues, component, accepted = {}) { + for (const i of issues) { + const key = `${component}:${i.kind}:${i.prop ?? ""}`; + if (accepted[key]) { i.severity = "info"; i.accepted = accepted[key]; } + else i.severity = ACTIONABLE.has(i.kind) ? "drift" : "info"; + } + return issues.some((i) => i.severity === "drift") ? "drift" : "ok"; +} + +// Find a likely renamed counterpart when no exact tag match (e.g. wn-pipeline-strip → wn-pipeline). +function likelyCounterpart(tag, byTag) { + if (byTag[tag]) return null; + const head = tag.replace(/^wn-/, "").split("-")[0]; // "pipeline" + const hit = Object.keys(byTag).find((t) => t.replace(/^wn-/, "").split("-")[0] === head); + return hit || null; +} + +export function componentDrift(contract, byTag, accepted = {}) { + const tag = contract.tag; + const el = byTag[tag]; + + if (!el) { + const alt = likelyCounterpart(tag, byTag); + if (alt) { + const issues = [{ kind: "tag-mismatch", expected: tag, actual: alt, + detail: `IR contract tag '${tag}' has no element; '${alt}' looks like the hand-authored counterpart (rename — resolve in Claude Design or realign the element).` }]; + return { name: contract.name, status: classify(issues, contract.name, accepted), tag, issues }; + } + return { name: contract.name, status: "new", tag, issues: [ + { kind: "no-counterpart", detail: `no <${tag}> in src/elements/ — stub generated.` }, + ] }; + } + + const issues = []; + const litProps = el.props; + const litSlots = el.slots || new Set(); + for (const p of contract.props || []) { + if (p.portable === false) { + issues.push({ kind: "non-portable", prop: p.name, + detail: `type=${p.type}; not attribute-mappable — handle explicitly, never drop.` }); + continue; + } + if (p.attribute === false) continue; // property-only by contract + const lit = litProps[p.name]; + if (!lit) { + // A content prop can be honoured by a same-named named slot (e.g. PageHeader + // `actions` → ) — that is satisfaction, not drift. + if (litSlots.has(p.name) || litSlots.has(p.attribute)) { + issues.push({ kind: "prop-via-slot", prop: p.name, + detail: `IR prop honoured by on <${tag}> (slotted content, not an attribute).` }); + continue; + } + issues.push({ kind: "prop-missing", prop: p.name, + detail: `in IR (attribute '${p.attribute}'), absent on <${tag}>` }); + continue; + } + const litAttr = litAttrOf(lit); + if (litAttr !== p.attribute) { + issues.push({ kind: "attribute-mismatch", prop: p.name, expected: p.attribute, actual: litAttr === null ? "(property-only)" : litAttr }); + } + } + // Variant axes must have a backing property. + for (const v of contract.variants || []) { + if (!litProps[v.axis]) issues.push({ kind: "variant-axis-missing", prop: v.axis, + detail: `IR variant axis '${v.axis}' (${v.values.join("/")}) has no Lit property.` }); + } + // Extra Lit properties not described by the IR contract. + const irNames = new Set((contract.props || []).map((p) => p.name)); + for (const name of Object.keys(litProps)) { + if (!irNames.has(name)) issues.push({ kind: "prop-extra", prop: name, + detail: `on <${tag}> (attribute '${litAttrOf(litProps[name]) ?? "(property-only)"}'), not in IR contract.` }); + } + + return { name: contract.name, status: classify(issues, contract.name, accepted), tag, issues }; +} + +// ---------- Stub generation (write-once) ---------- +export function renderStub(contract) { + const tag = contract.tag; + const cls = "Wn" + contract.name; + const props = (contract.props || []).filter((p) => p.portable !== false && p.attribute !== false); + const litType = (t) => (t === "boolean" ? "Boolean" : t === "number" ? "Number" : "String"); + const propLines = props.map((p) => { + const attr = p.attribute !== p.name.toLowerCase() ? `, attribute: "${p.attribute}"` : ""; + return ` ${p.name}: { type: ${litType(p.type)}${attr} },`; + }).join("\n"); + const nonPortable = (contract.props || []).filter((p) => p.portable === false); + const npNote = nonPortable.length + ? `\n // Non-portable props (handle explicitly, do not drop): ${nonPortable.map((p) => p.name).join(", ")}.` + : ""; + const slotMarkup = (contract.slots || []).some((s) => s.name === "default") + ? "" : ""; + return `// @generated STUB by adapters/lit (WHYNOT-WP-0002 T07) — from ir/components/${contract.name}.json. +// Write-once scaffold: skeleton + typed reactive properties + a behaviour TODO. +// Move into src/elements/ and implement; the adapter never overwrites this once edited. +import { LitElement, html } from "lit"; + +export class ${cls} extends LitElement { + createRenderRoot() { return this; } // light DOM, matches the existing wn-* elements${npNote} + static properties = { +${propLines || " // (no attribute-mappable props in the contract)"} + }; + render() { + // TODO(${contract.name}): implement per ir/exemplars/${contract.name}.html and the design language. + return html\`
${slotMarkup}
\`; + } +} +// customElements.define("${tag}", ${cls}); // ← uncomment when integrating +`; +} diff --git a/adapters/plain-css/README.md b/adapters/plain-css/README.md new file mode 100644 index 0000000..f982e7a --- /dev/null +++ b/adapters/plain-css/README.md @@ -0,0 +1,31 @@ +# plain-css adapter — second-adapter smoke (WHYNOT-WP-0002 · T10) + +> **This is not a finished stack.** It exists to prove the **IR/adapter boundary**: +> that a second, non-Lit adapter can consume the *same* `ir/` and honour the *same* +> [`adapters/ADAPTER_CONTRACT.md`](../ADAPTER_CONTRACT.md). The deliverable is +> confidence in the seam, so the architecture can later be lifted into a +> coulomb-level tool — **not** a usable plain-CSS component kit. + +Run with **`make adapt-plain-css`** (`adapters/plain-css/adapt.mjs`). + +## What it proves + +| Contract concern | This adapter | Same as Lit? | +|---|---|---| +| Input is `ir/` only | reads `ir/tokens.json` + `ir/components/*.json` | ✓ identical inputs | +| Tokens fully generated | → `adapters/plain-css/tokens.css` (CSS custom properties, deterministic no-op re-run) | ✓ same discipline, different target | +| New component → stub | write-once class stub `adapters/plain-css/stubs/.css` (base + variant modifier classes from the contract) | ✓ write-once, into a staging dir | +| Drift roll-up | `adapters/plain-css/_report.json` in the contract's report shape (`stack`, `generatedAt`, `components[]`) | ✓ portable shape | +| Exit codes | `0` ok · `2` usage · `3` new/drift · `5` internal | ✓ shared convention | + +Because plain-CSS has no hand-authored source, **every** IR component reports +`status: "new"` and gets a stub — exactly the contract's new-component path. That a +totally different stack reuses the same IR, the same report shape, and the same exit +codes — with **zero changes to `ir/`** — is the proof the boundary holds. + +## What it deliberately does NOT do + +No real CSS appearance, no parity, no full component set, no integration into the +repo's build. Finishing a plain-CSS (or Vue/Svelte/…) stack is future work; the seam +is what T10 validates. See `DesignSystemIntroduction.md` §5.1 and the Lit reference +adapter (`adapters/lit/`) for the full implementation. diff --git a/adapters/plain-css/_report.json b/adapters/plain-css/_report.json new file mode 100644 index 0000000..895bade --- /dev/null +++ b/adapters/plain-css/_report.json @@ -0,0 +1,106 @@ +{ + "stack": "plain-css", + "generatedAt": "2026-06-30T07:48:30.643Z", + "components": [ + { + "name": "Button", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-button class — stub generated." + } + ] + }, + { + "name": "Eyebrow", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-eyebrow class — stub generated." + } + ] + }, + { + "name": "Icon", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-icon class — stub generated." + } + ] + }, + { + "name": "PageHeader", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-page-header class — stub generated." + } + ] + }, + { + "name": "PipelineStrip", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-pipeline class — stub generated." + } + ] + }, + { + "name": "Sidebar", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-sidebar class — stub generated." + } + ] + }, + { + "name": "StageDot", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-stage-dot class — stub generated." + } + ] + }, + { + "name": "Stamp", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-stamp class — stub generated." + } + ] + }, + { + "name": "Tag", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-tag class — stub generated." + } + ] + }, + { + "name": "TopNav", + "status": "new", + "issues": [ + { + "kind": "no-counterpart", + "detail": "no .wn-top-nav class — stub generated." + } + ] + } + ] +} diff --git a/adapters/plain-css/adapt.mjs b/adapters/plain-css/adapt.mjs new file mode 100644 index 0000000..940e07e --- /dev/null +++ b/adapters/plain-css/adapt.mjs @@ -0,0 +1,102 @@ +#!/usr/bin/env node +// ============================================================= +// adapters/plain-css/adapt.mjs — second-adapter SMOKE (WHYNOT-WP-0002 · T10) +// +// NOT a finished stack. This exists only to prove the IR/adapter *boundary*: +// a non-Lit adapter consuming the very same ir/ and honouring the same +// adapters/ADAPTER_CONTRACT.md (token full-gen + stub/drift + exit codes). +// The deliverable is confidence in the seam, not a usable plain-CSS kit. +// +// It does two contract things from ir/ and nothing Lit-specific: +// • tokens → fully generated CSS custom properties (deterministic no-op re-run) +// • components → write-once class stubs + a drift roll-up in the contract shape +// (every component is "new" here — plain-CSS has no existing source to drift). +// +// Exit codes (shared contract): 0 ok · 2 usage · 3 drift/new · 5 internal. +// Run: `make adapt-plain-css`. +// ============================================================= +import { readFileSync, readdirSync, writeFileSync, existsSync, mkdirSync, rmSync } from "node:fs"; +import { join, dirname } from "node:path"; +import { fileURLToPath } from "node:url"; + +const REPO = join(dirname(fileURLToPath(import.meta.url)), "..", ".."); +const IR = join(REPO, "ir"); +const HERE = join(REPO, "adapters", "plain-css"); +const STUBS = join(HERE, "stubs"); + +const refToVar = (v) => { + const m = /^\{[A-Za-z0-9]+\.([A-Za-z0-9-]+)\}$/.exec(String(v).trim()); + return m ? `var(--${m[1]})` : v; +}; + +function generateTokens() { + const tokens = JSON.parse(readFileSync(join(IR, "tokens.json"), "utf8")); + const lines = ["/* @generated by adapters/plain-css (WHYNOT-WP-0002 T10) from ir/tokens.json — DO NOT EDIT. */", ":root {"]; + let n = 0; + for (const [group, entries] of Object.entries(tokens)) { + lines.push(` /* ${group} */`); + for (const [key, tok] of Object.entries(entries)) { + if (key === "$type") continue; + lines.push(` --${key}: ${refToVar(tok.$value)};`); n++; + } + } + lines.push("}", ""); + const out = join(HERE, "tokens.css"); + const body = lines.join("\n"); + const before = existsSync(out) ? readFileSync(out, "utf8") : null; + if (before === body) { console.log(`tokens: up to date (${n} custom properties, no change).`); return; } + writeFileSync(out, body); + console.log(`tokens: regenerated ${n} custom properties → adapters/plain-css/tokens.css`); +} + +function renderClassStub(c) { + const base = c.tag; // reuse the contract tag as the base class name + const lines = [ + `/* @generated STUB by adapters/plain-css (T10) from ir/components/${c.name}.json — write-once. */`, + `/* ${c.name}: ${c.description} */`, + `.${base} { /* TODO: base appearance per ir/exemplars/${c.name}.html */ }`, + ]; + for (const v of c.variants || []) { + for (const val of v.values) lines.push(`.${base}--${val} { /* ${v.axis}=${val} */ }`); + } + return lines.join("\n") + "\n"; +} + +function scaffold() { + const contracts = readdirSync(join(IR, "components")).filter((f) => f.endsWith(".json")) + .map((f) => JSON.parse(readFileSync(join(IR, "components", f), "utf8"))) + .sort((a, b) => a.name.localeCompare(b.name)); + + // Plain-CSS has no hand-authored source, so every IR component is "new". + const components = contracts.map((c) => ({ name: c.name, status: "new", + issues: [{ kind: "no-counterpart", detail: `no .${c.tag} class — stub generated.` }] })); + + mkdirSync(STUBS, { recursive: true }); + let stubbed = 0; + for (const c of contracts) { + const out = join(STUBS, `${c.tag}.css`); + if (!existsSync(out)) { writeFileSync(out, renderClassStub(c)); stubbed++; } + } + // Drift roll-up — same shape as the Lit adapter's, proving the contract is portable. + const reportPath = join(HERE, "_report.json"); + let generatedAt = new Date().toISOString(); + if (existsSync(reportPath)) { + try { const prev = JSON.parse(readFileSync(reportPath, "utf8")); + if (JSON.stringify(prev.components) === JSON.stringify(components) && prev.generatedAt) generatedAt = prev.generatedAt; + } catch { /* fresh */ } + } + writeFileSync(reportPath, JSON.stringify({ stack: "plain-css", generatedAt, components }, null, 2) + "\n"); + console.log(`scaffold: ${components.length} components, all new (${stubbed} stub${stubbed === 1 ? "" : "s"} written) → adapters/plain-css/stubs/`); + return components.length > 0; +} + +function main() { + if (!existsSync(join(IR, "tokens.json"))) { console.error("No ir/ — run `make ir` first."); process.exit(2); } + generateTokens(); + const isNew = scaffold(); + console.log("\nadapt-plain-css: SMOKE only — proves a non-Lit adapter consumes the same ir/ and"); + console.log("emits the same contract shapes. Not a finished stack (see adapters/plain-css/README.md)."); + if (isNew) process.exit(3); // new components present (contract: 3) — expected for a fresh stack +} + +main(); diff --git a/adapters/plain-css/stubs/wn-button.css b/adapters/plain-css/stubs/wn-button.css new file mode 100644 index 0000000..9c6f492 --- /dev/null +++ b/adapters/plain-css/stubs/wn-button.css @@ -0,0 +1,6 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/Button.json — write-once. */ +/* Button: Button — extracted from designbook ui_kits/whynot-control/Atoms.jsx. */ +.wn-button { /* TODO: base appearance per ir/exemplars/Button.html */ } +.wn-button--secondary { /* variant=secondary */ } +.wn-button--primary { /* variant=primary */ } +.wn-button--ghost { /* variant=ghost */ } diff --git a/adapters/plain-css/stubs/wn-eyebrow.css b/adapters/plain-css/stubs/wn-eyebrow.css new file mode 100644 index 0000000..f9a13ed --- /dev/null +++ b/adapters/plain-css/stubs/wn-eyebrow.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/Eyebrow.json — write-once. */ +/* Eyebrow: Eyebrow — extracted from designbook ui_kits/whynot-control/Atoms.jsx. */ +.wn-eyebrow { /* TODO: base appearance per ir/exemplars/Eyebrow.html */ } diff --git a/adapters/plain-css/stubs/wn-icon.css b/adapters/plain-css/stubs/wn-icon.css new file mode 100644 index 0000000..13a448e --- /dev/null +++ b/adapters/plain-css/stubs/wn-icon.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/Icon.json — write-once. */ +/* Icon: Icon — extracted from designbook ui_kits/whynot-control/Atoms.jsx. */ +.wn-icon { /* TODO: base appearance per ir/exemplars/Icon.html */ } diff --git a/adapters/plain-css/stubs/wn-page-header.css b/adapters/plain-css/stubs/wn-page-header.css new file mode 100644 index 0000000..15c8c07 --- /dev/null +++ b/adapters/plain-css/stubs/wn-page-header.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/PageHeader.json — write-once. */ +/* PageHeader: PageHeader — extracted from designbook ui_kits/whynot-control/Chrome.jsx. */ +.wn-page-header { /* TODO: base appearance per ir/exemplars/PageHeader.html */ } diff --git a/adapters/plain-css/stubs/wn-pipeline.css b/adapters/plain-css/stubs/wn-pipeline.css new file mode 100644 index 0000000..1004460 --- /dev/null +++ b/adapters/plain-css/stubs/wn-pipeline.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/PipelineStrip.json — write-once. */ +/* PipelineStrip: PipelineStrip — extracted from designbook ui_kits/whynot-control/Chrome.jsx. */ +.wn-pipeline { /* TODO: base appearance per ir/exemplars/PipelineStrip.html */ } diff --git a/adapters/plain-css/stubs/wn-sidebar.css b/adapters/plain-css/stubs/wn-sidebar.css new file mode 100644 index 0000000..ea51343 --- /dev/null +++ b/adapters/plain-css/stubs/wn-sidebar.css @@ -0,0 +1,4 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/Sidebar.json — write-once. */ +/* Sidebar: Sidebar — extracted from designbook ui_kits/whynot-control/Chrome.jsx. */ +.wn-sidebar { /* TODO: base appearance per ir/exemplars/Sidebar.html */ } +.wn-sidebar--doc: { /* current=doc: */ } diff --git a/adapters/plain-css/stubs/wn-stage-dot.css b/adapters/plain-css/stubs/wn-stage-dot.css new file mode 100644 index 0000000..e481bac --- /dev/null +++ b/adapters/plain-css/stubs/wn-stage-dot.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/StageDot.json — write-once. */ +/* StageDot: StageDot — extracted from designbook ui_kits/whynot-control/Atoms.jsx. */ +.wn-stage-dot { /* TODO: base appearance per ir/exemplars/StageDot.html */ } diff --git a/adapters/plain-css/stubs/wn-stamp.css b/adapters/plain-css/stubs/wn-stamp.css new file mode 100644 index 0000000..2f5592c --- /dev/null +++ b/adapters/plain-css/stubs/wn-stamp.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/Stamp.json — write-once. */ +/* Stamp: Stamp — extracted from designbook ui_kits/whynot-control/Atoms.jsx. */ +.wn-stamp { /* TODO: base appearance per ir/exemplars/Stamp.html */ } diff --git a/adapters/plain-css/stubs/wn-tag.css b/adapters/plain-css/stubs/wn-tag.css new file mode 100644 index 0000000..958ad3a --- /dev/null +++ b/adapters/plain-css/stubs/wn-tag.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/Tag.json — write-once. */ +/* Tag: Tag — extracted from designbook ui_kits/whynot-control/Atoms.jsx. */ +.wn-tag { /* TODO: base appearance per ir/exemplars/Tag.html */ } diff --git a/adapters/plain-css/stubs/wn-top-nav.css b/adapters/plain-css/stubs/wn-top-nav.css new file mode 100644 index 0000000..cc2a9e4 --- /dev/null +++ b/adapters/plain-css/stubs/wn-top-nav.css @@ -0,0 +1,3 @@ +/* @generated STUB by adapters/plain-css (T10) from ir/components/TopNav.json — write-once. */ +/* TopNav: TopNav — extracted from designbook ui_kits/whynot-control/Chrome.jsx. */ +.wn-top-nav { /* TODO: base appearance per ir/exemplars/TopNav.html */ } diff --git a/adapters/plain-css/tokens.css b/adapters/plain-css/tokens.css new file mode 100644 index 0000000..9d08898 --- /dev/null +++ b/adapters/plain-css/tokens.css @@ -0,0 +1,91 @@ +/* @generated by adapters/plain-css (WHYNOT-WP-0002 T10) from ir/tokens.json — DO NOT EDIT. */ +:root { + /* color */ + --ink: #0A0A0A; + --ink-2: #1F1F1F; + --ink-3: #5C5C5C; + --ink-4: #8A8A8A; + --ink-5: #B5B5B3; + --line: #E5E5E2; + --line-strong: #C9C9C5; + --line-soft: #F0F0EC; + --paper: #FFFFFF; + --paper-2: #FAFAF7; + --paper-3: #F4F4EF; + --fg-1: var(--ink); + --fg-2: var(--ink-3); + --fg-3: var(--ink-4); + --fg-mute: var(--ink-5); + --fg-on-dark: #FAFAF7; + --bg-1: var(--paper); + --bg-2: var(--paper-2); + --bg-3: var(--paper-3); + --bg-invert: var(--ink); + --border: var(--line); + --border-strong: var(--line-strong); + --border-soft: var(--line-soft); + --hi: #FFE14A; + --hi-2: #FFD400; + --hi-ink: #1A1500; + --status-raw: #B5B5B3; + --status-weak: #8A8A8A; + --status-medium: #5C5C5C; + --status-strong: #0A0A0A; + --status-commercial: #FFD400; + --status-error: #B33A2E; + --status-error-bg: #FCF3F1; + --status-warn: #C28000; + --status-warn-bg: #FFFCEB; + --status-success: #2F6B3A; + --status-success-bg: #F2F7F2; + --status-info: #2E5C8A; + --status-info-bg: #F2F5FA; + /* fontFamily */ + --ff-sans: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif; + --ff-mono: ui-monospace, "SF Mono", Menlo, Consolas, monospace; + --ff-serif: ui-serif, Georgia, "Times New Roman", serif; + /* fontSize */ + --fs-xs: 11px; + --fs-sm: 13px; + --fs-base: 15px; + --fs-md: 17px; + --fs-lg: 20px; + --fs-xl: 24px; + --fs-2xl: 32px; + --fs-3xl: 44px; + --fs-4xl: 64px; + --fs-5xl: 96px; + /* lineHeight */ + --lh-tight: 1.05; + --lh-snug: 1.25; + --lh-base: 1.5; + --lh-loose: 1.7; + /* letterSpacing */ + --tr-tight: -0.02em; + --tr-snug: -0.01em; + --tr-base: 0em; + --tr-mono: 0.02em; + --tr-label: 0.08em; + /* space */ + --sp-1: 4px; + --sp-2: 8px; + --sp-3: 12px; + --sp-4: 16px; + --sp-5: 24px; + --sp-6: 32px; + --sp-7: 48px; + --sp-8: 64px; + --sp-9: 96px; + --sp-10: 128px; + /* radius */ + --r-0: 0px; + --r-1: 2px; + --r-2: 4px; + --r-3: 8px; + --r-pill: 999px; + /* shadow */ + --shadow-0: none; + --shadow-1: 0 1px 0 var(--line); + --shadow-2: 0 1px 0 var(--line-strong); + --shadow-3: 0 4px 12px -6px rgba(10,10,10,0.10); +} diff --git a/designbook/README.md b/designbook/README.md index d0cc82c..eb5d8bc 100644 --- a/designbook/README.md +++ b/designbook/README.md @@ -8,6 +8,32 @@ build scripts; `tokens/` and `src/styles/` in the repo root are *derived* from i See `DesignSystemIntroduction.md` §1 (three places) and §5 (the atelier → repo hop), and `RecentChanges.md` (regenerated by `make designbook-sync`) for the last diff. +## Refresh runbook — propagating a designbook change to Lit (WHYNOT-WP-0002) + +When the cloud designbook moves, run **`make designbook-refresh`** — it chains +check → pull → record → `make ir` → `make adapt-lit` → (drift triage) → `make +parity-lit` and stops when a human decision is needed. See +`.claude/rules/stack-and-commands.md` for the step list and +`.claude/rules/designbook-propagation.md` for the one-way governance. + +**Step 6 — resolving drift (the human step).** When `make adapt-lit` exits `3`, +the refresh halts and points you at `adapters/lit/drift/.md`. For each +**actionable** issue (informational `non-portable`/`prop-extra` are not gated): + +| drift kind | what it means | how to resolve | +|---|---|---| +| `attribute-mismatch` | the Lit property reflects a different attribute than the IR contract | rename the Lit `attribute:` to match the IR, or — if the *language* is what's wrong — change it in Claude Design and re-propagate | +| `prop-missing` | the IR contract has a prop the `` element lacks | add the reactive property + behaviour to the element, **or** if the element models it differently (e.g. a slot, or state on a child), change the React designbook so the contract matches reality | +| `variant-axis-missing` | an IR variant axis has no backing Lit property | add the variant property, or correct the axis in Claude Design | +| `tag-mismatch` | the IR contract's tag has no element; a near-named one exists (e.g. `wn-pipeline-strip` vs the hand-authored `wn-pipeline`) | decide the canonical name **in Claude Design** and re-propagate, then realign the element — do not silently rename only the stack | + +**Never** resolve drift by editing `ir/` or back-editing React from the stack — +that desyncs the canonical source (see `designbook-propagation.md`). After +resolving, re-run `make designbook-refresh --no-pull` to confirm `adapt-lit` is +clean and `parity-lit` passes (exit `0`). New components get a write-once stub in +`adapters/lit/stubs/.js` — move it into `src/elements/`, implement the +behaviour, register it, and re-run. + ## How it syncs The designbook is a cloud project of type `PROJECT_TYPE_DESIGN_SYSTEM`. Sync is diff --git a/intakes/intakes.md b/intakes/intakes.md new file mode 100644 index 0000000..f67a15e --- /dev/null +++ b/intakes/intakes.md @@ -0,0 +1,28 @@ +# Intake records + +## WHYNOT-IN-0001 — Provision a consumer npm-read lane + +```yaml +id: WHYNOT-IN-0001 +kind: intake +title: "Provision a consumer-install npm-read lane for @whynot/design" +lane: yellow +status: open +origin: residual +origin_ref: WHYNOT-WP-0003 +priority: medium +owner: whynot-design +repo: whynot-design +description: | + WHYNOT-WP-0003-T02 published @whynot/design to the coulomb Forgejo npm + registry using the publish lane. A separate read/install token id + (whynot-design-npm-read) was never provisioned; the publish token was + enough to verify one install. + + Consumers still need an .npmrc token to install from the org registry. + Route custody through warden route / OpenBao (railiance-platform). Do + not inline a secret in Git, State Hub, or this record. +created: "2026-08-29" +updated: "2026-08-29" +state_hub_intake_id: "01a04d91-1308-7399-8942-d23f10cef388" +``` diff --git a/ir/INDEX.md b/ir/INDEX.md index e267b2a..016ed57 100644 --- a/ir/INDEX.md +++ b/ir/INDEX.md @@ -1,7 +1,7 @@ # whynot-design IR catalog -**designVersion** `0.4.0` · **components** 10 · **generated** 2026-06-28T22:41:24.992Z +**designVersion** `0.4.2` · **components** 10 · **generated** 2026-09-04T21:25:01.914Z Machine-readable companion: [`manifest.json`](./manifest.json) (per-component + token hashes). @@ -96,7 +96,7 @@ PageHeader — extracted from designbook ui_kits/whynot-control/Chrome.jsx. **Contract:** [`components/PageHeader.json`](./components/PageHeader.json) · **hash** `sha256:93e12068e2f58f10` · **exemplar:** [`exemplars/PageHeader.html`](./exemplars/PageHeader.html) -### PipelineStrip `` +### PipelineStrip `` PipelineStrip — extracted from designbook ui_kits/whynot-control/Chrome.jsx. @@ -104,7 +104,7 @@ PipelineStrip — extracted from designbook ui_kits/whynot-control/Chrome.jsx. | --- | --- | --- | --- | | `activeIdx` | `active-idx` | number | `3` | -**Contract:** [`components/PipelineStrip.json`](./components/PipelineStrip.json) · **hash** `sha256:89c40afe4742d64e` · **exemplar:** [`exemplars/PipelineStrip.html`](./exemplars/PipelineStrip.html) +**Contract:** [`components/PipelineStrip.json`](./components/PipelineStrip.json) · **hash** `sha256:167717c21cceff79` · **exemplar:** [`exemplars/PipelineStrip.html`](./exemplars/PipelineStrip.html) ### Sidebar `` diff --git a/ir/components/PipelineStrip.json b/ir/components/PipelineStrip.json index 92d1972..865ee4b 100644 --- a/ir/components/PipelineStrip.json +++ b/ir/components/PipelineStrip.json @@ -1,6 +1,6 @@ { "name": "PipelineStrip", - "tag": "wn-pipeline-strip", + "tag": "wn-pipeline", "group": "chrome", "description": "PipelineStrip — extracted from designbook ui_kits/whynot-control/Chrome.jsx.", "props": [ diff --git a/ir/manifest.json b/ir/manifest.json index 7c65435..d39ee7e 100644 --- a/ir/manifest.json +++ b/ir/manifest.json @@ -1,7 +1,7 @@ { "schemaVersion": "1.0.0", - "designVersion": "0.4.0", - "generatedAt": "2026-06-28T22:41:24.992Z", + "designVersion": "0.4.2", + "generatedAt": "2026-09-04T21:25:01.914Z", "tokensHash": "sha256:426f565a9ce6c36f", "components": [ { @@ -27,7 +27,7 @@ { "name": "PipelineStrip", "group": "chrome", - "hash": "sha256:89c40afe4742d64e" + "hash": "sha256:167717c21cceff79" }, { "name": "Sidebar", diff --git a/package.json b/package.json index 2d60729..6626563 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@whynot/design", - "version": "0.4.0", + "version": "0.4.2", "description": "The neutral, mostly-black-and-white visual language for whynot — prototype cards, signal records, beta plans, decision documents, and any other deliberately-unfinished artefact. Ships tokens, CSS, and Lit-based web components consumable from React, Django, Vue, plain HTML, or anywhere a custom element runs.", "private": false, "type": "module", @@ -65,10 +65,10 @@ "keywords": ["whynot", "design-system", "wireframe", "prototype", "lit", "web-components", "django", "react"], "repository": { "type": "git", - "url": "git+ssh://git@gitea.coulomb.social/coulomb/whynot-design.git" + "url": "git+ssh://git@forgejo.coulomb.social/coulomb/whynot-design.git" }, "publishConfig": { - "registry": "https://gitea.coulomb.social/api/packages/coulomb/npm/" + "registry": "https://forgejo.coulomb.social/api/packages/coulomb/npm/" }, "license": "UNLICENSED" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml new file mode 100644 index 0000000..b820143 --- /dev/null +++ b/pnpm-lock.yaml @@ -0,0 +1,97 @@ +lockfileVersion: '9.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +importers: + + .: + devDependencies: + '@playwright/test': + specifier: ^1.45.0 + version: 1.61.1 + lit: + specifier: ^3.2.1 + version: 3.3.3 + +packages: + + '@lit-labs/ssr-dom-shim@1.6.0': + resolution: {integrity: sha512-VHb0ALPMTlgKjM6yIxxoQNnpKyUKLD04VzeQdsiXkMqkvYlAHxq9glGLmgbb889/1GsohSOAjvQYoiBppXFqrQ==} + + '@lit/reactive-element@2.1.2': + resolution: {integrity: sha512-pbCDiVMnne1lYUIaYNN5wrwQXDtHaYtg7YEFPeW+hws6U47WeFvISGUWekPGKWOP1ygrs0ef0o1VJMk1exos5A==} + + '@playwright/test@1.61.1': + resolution: {integrity: sha512-8nKv6+0RJSL9FE4jYOEGXnPeM/Hg12qZpmqzZjRh3qM0Y7c3z1mrOTfFLids72RDQYVh9WpLEfR5WdpNX4fkig==} + engines: {node: '>=18'} + hasBin: true + + '@types/trusted-types@2.0.7': + resolution: {integrity: sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==} + + fsevents@2.3.2: + resolution: {integrity: sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==} + engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} + os: [darwin] + + lit-element@4.2.2: + resolution: {integrity: sha512-aFKhNToWxoyhkNDmWZwEva2SlQia+jfG0fjIWV//YeTaWrVnOxD89dPKfigCUspXFmjzOEUQpOkejH5Ly6sG0w==} + + lit-html@3.3.3: + resolution: {integrity: sha512-el8M6jK2o3RXBnrSHX3ZKrsN8zEV63pSExTO1wYJz7QndGYZ8353e2a5PPX+qHe2aGayfnchQmkAojaWAREOIA==} + + lit@3.3.3: + resolution: {integrity: sha512-fycuvZg/hkpozL00lm1pEJH5nN/lr9ZXd6mJI2HSN4+Bzc+LDNdEApJ6HFbPkdFNHLvOplIIuJvxkS4XUxqirw==} + + playwright-core@1.61.1: + resolution: {integrity: sha512-h7Qlt6m4REp25qvIdvbDtVmD4LqVXfpRxhORv9L0jzETM05p4fuPJ3dKyuSXQxDSbXnmS79HAgi9589lGSpLkg==} + engines: {node: '>=18'} + hasBin: true + + playwright@1.61.1: + resolution: {integrity: sha512-DWnY5o3YbLWK4GovuAVwpqL+1VwGNdUGrRr++8j8PtQQzvAVZUIMjKQ90fY689sEJZJBbZVw1rXaOKSTitkzPQ==} + engines: {node: '>=18'} + hasBin: true + +snapshots: + + '@lit-labs/ssr-dom-shim@1.6.0': {} + + '@lit/reactive-element@2.1.2': + dependencies: + '@lit-labs/ssr-dom-shim': 1.6.0 + + '@playwright/test@1.61.1': + dependencies: + playwright: 1.61.1 + + '@types/trusted-types@2.0.7': {} + + fsevents@2.3.2: + optional: true + + lit-element@4.2.2: + dependencies: + '@lit-labs/ssr-dom-shim': 1.6.0 + '@lit/reactive-element': 2.1.2 + lit-html: 3.3.3 + + lit-html@3.3.3: + dependencies: + '@types/trusted-types': 2.0.7 + + lit@3.3.3: + dependencies: + '@lit/reactive-element': 2.1.2 + lit-element: 4.2.2 + lit-html: 3.3.3 + + playwright-core@1.61.1: {} + + playwright@1.61.1: + dependencies: + playwright-core: 1.61.1 + optionalDependencies: + fsevents: 2.3.2 diff --git a/registry/capabilities/capability.design.whynot-system.md b/registry/capabilities/capability.design.whynot-system.md new file mode 100644 index 0000000..8bffa32 --- /dev/null +++ b/registry/capabilities/capability.design.whynot-system.md @@ -0,0 +1,131 @@ +--- +id: capability.design.whynot-system +name: Whynot Design System +summary: 'Framework-agnostic visual language for whynot prototype/market-signal artefacts: design tokens, + drop-in CSS, Lit-based web components usable from React/Django/Vue/plain HTML, and Django template adapters.' +owner: whynot-design +status: draft +domain: consumer +tags: +- design-system +- web-components +- frontend +maturity: + discovery: + current: D3 + target: D4 + confidence: medium + rationale: README documents a clear three-layer architecture (tokens, CSS, Lit web components) plus + a companion DesignSystemIntroduction.md describing propagation pipeline, versioning, and A1 staging + relative to whynot-control. + availability: + current: A2 + target: A3 + confidence: high + rationale: 'Published as `@whynot/design` (not private: `"private": false` in package.json), ships + a CLI (`whynot-design` bin), tokens/CSS/JS source, and Django adapters — genuinely consumable across + frameworks today, not just planned.' +external_evidence: + completeness: + level: C2 + confidence: low + basis: scope_vs_intent_and_consumer_expectations + satisfied_expectations: + - framework-agnostic Lit web components (same `` usable in React/Django/Vue/plain HTML) + - design tokens as source of truth + - Django adapter partials + - package is publicly consumable (not private) + broken_expectations: [] + out_of_scope_expectations: [] + reliability: + level: R1 + confidence: low + basis: consumer_quality_signals + known_reliability_risks: + - cross-framework consumption claims not independently verified in every target framework during this + sweep +discovery: + intent: Give whynot's prototype and market-signal artefacts a consistent, deliberately-unfinished visual + language, consumable identically across any framework via framework-agnostic web components rather + than per-framework reimplementation. + includes: + - design tokens (tokens/*.json) + - drop-in CSS (src/styles/*.css) + - Lit-based web components (src/elements/*.js) + - Django adapter partials + excludes: + - whynot-control's product/business logic itself (see whynot-control) + assumptions: [] + use_cases: [] + research_memos: [] +availability: + current_level: A2 + target_level: A3 + current_artifacts: + - '`@whynot/design` npm package (public)' + - '`whynot-design` CLI' + target_artifacts: [] + consumption_modes: + - library import (npm) + - cli + - django template adapter +relations: + depends_on: [] + supports: [] + related_to: [] +evidence: + documentation: + - README.md + - DesignSystemIntroduction.md + tests: + - tests/ + - test-results/ + consumer_feedback: [] + bug_reports: [] + incidents: [] +consumer_guidance: + recommended_for: + - whynot-family apps needing a consistent, framework-agnostic visual language across React/Django/Vue/plain + HTML + not_recommended_for: + - consumers wanting a themed (non-neutral) visual language, or needing whynot-control's business logic + itself + known_limitations: + - cross-framework consumption not independently re-verified in every target framework this sweep +promotion_history: [] +--- + +# Whynot Design System + +## Overview + +`@whynot/design` is the framework-agnostic visual language for whynot's prototype and market-signal artefacts: design tokens as source of truth, drop-in CSS, and Lit-based web components that work identically across React, Django, Vue, and plain HTML, plus Django adapter partials — publicly published, not a private/internal-only package. + +## Assessment notes + +### Discovery + +README documents a clear three-layer architecture (tokens, CSS, Lit web components) plus a companion DesignSystemIntroduction.md describing propagation pipeline, versioning, and A1 staging relative to whynot-control. + +### Availability + +Published as `@whynot/design` (not private: `"private": false` in package.json), ships a CLI (`whynot-design` bin), tokens/CSS/JS source, and Django adapters — genuinely consumable across frameworks today, not just planned. + +### Completeness + +First-pass honest assessment from the REUSE-WP-0017 coverage campaign +(reuse-surface). No external consumer feedback exists yet; levels reflect +scope-vs-intent documentation quality, not internal code quality. + +### Reliability + +No production consumer telemetry exists yet; reliability level is +intentionally conservative pending REUSE-WP-0019 reuse-telemetry evidence. + +## Promotion checklist + +- [x] ID follows `capability..` pattern +- [x] Maturity enums match `specs/CapabilityMaturityStandard.md` +- [x] `external_evidence` is populated separately from `maturity` +- [ ] Relations reference valid capability IDs (none yet) +- [x] Index entry added in `registry/indexes/capabilities.yaml` diff --git a/registry/indexes/capabilities.yaml b/registry/indexes/capabilities.yaml index f944e47..b226cfe 100644 --- a/registry/indexes/capabilities.yaml +++ b/registry/indexes/capabilities.yaml @@ -1,4 +1,22 @@ version: 1 -updated: '2026-06-16' +updated: '2026-07-06' domain: helix_forge -capabilities: [] +capabilities: +- id: capability.design.whynot-system + name: Whynot Design System + summary: 'Framework-agnostic visual language for whynot prototype/market-signal artefacts: design tokens, + drop-in CSS, Lit-based web components usable from React/Django/Vue/plain HTML, and Django template + adapters.' + vector: D3 / A2 / C2 / R1 + domain: consumer + status: draft + owner: whynot-design + path: registry/capabilities/capability.design.whynot-system.md + tags: + - design-system + - web-components + - frontend + consumption_modes: + - library import (npm) + - cli + - django template adapter diff --git a/scripts/designbook-refresh.mjs b/scripts/designbook-refresh.mjs new file mode 100644 index 0000000..50a848b --- /dev/null +++ b/scripts/designbook-refresh.mjs @@ -0,0 +1,73 @@ +#!/usr/bin/env node +// ============================================================= +// designbook-refresh.mjs — the refresh orchestrator (WHYNOT-WP-0002 · T09) +// +// One routine to keep the Lit stack current with the canonical React designbook. +// Runs the *automatable* steps (1–5, 7) and stops for the *human* step (6) when +// drift is detected, honouring the adapter-contract exit codes: +// +// 1. make designbook-check — has the cloud designbook moved? (best-effort) +// 2. make designbook-pull — pull the React designbook → designbook/ (best-effort) +// 3. make designbook-sync — record the diff → RecentChanges.md (best-effort) +// 4. make ir — re-extract the IR (the blueprint) (gate) +// 5. make adapt-lit — tokens + scaffold + drift (drift gate → 3) +// 6. (human) resolve drift — adapters/lit/drift/*.md ← STOP here on drift +// 7. make parity-lit — contract + visual parity (parity gate → 4) +// +// Best-effort steps (1–3) need network / the local `claude` binary / llm-connect; +// their failure warns and continues (the IR re-extracts from the current mirror). +// Steps 4/5/7 are deterministic and gate. Exit: highest applicable adapter code — +// 0 ok · 2 usage · 3 drift (stop for triage) · 4 parity failure · 5 internal. +// +// Flags: --no-check --no-pull --no-parity (skip the matching step) +// ============================================================= +import { spawnSync } from "node:child_process"; +import { join, dirname } from "node:path"; +import { fileURLToPath } from "node:url"; + +const REPO = join(dirname(fileURLToPath(import.meta.url)), ".."); +const args = new Set(process.argv.slice(2)); + +function run(label, cmd, { gate = false } = {}) { + console.log(`\n\x1b[1m▶ ${label}\x1b[0m (${cmd})`); + const r = spawnSync(cmd, { cwd: REPO, shell: true, stdio: "inherit" }); + const code = r.status == null ? 5 : r.status; + if (code !== 0 && !gate) console.log(`\x1b[33m ↪ step exited ${code} — best-effort, continuing.\x1b[0m`); + return code; +} + +function done(code, msg) { + console.log(`\n\x1b[1m${code === 0 ? "✓" : "■"} designbook-refresh: ${msg}\x1b[0m`); + process.exit(code); +} + +// 1–3: best-effort (never abort the refresh). +if (!args.has("--no-check")) run("1/7 cloud-ahead check", "make designbook-check"); +if (!args.has("--no-pull")) run("2/7 pull React designbook", "make designbook-pull"); +run("3/7 record diff (RecentChanges.md)", "make designbook-sync"); + +// Gating steps call the node scripts DIRECTLY (not via make, which collapses any +// recipe failure to exit 2 and would hide the adapter's 3/4 drift/parity codes). +const N = JSON.stringify(process.execPath); + +// 4: IR extraction — deterministic gate; without it nothing downstream is valid. +const irCode = run("4/7 extract IR", `${N} scripts/ir-extract.mjs`, { gate: true }); +if (irCode !== 0) done(irCode === 5 ? 5 : 2, `IR extraction failed (exit ${irCode}). Fix the designbook/ source before refreshing.`); + +// 5: adapt-lit — drift gate. Exit 3 ⇒ stop for human triage (step 6). +const adaptCode = run("5/7 adapt Lit (tokens + scaffold + drift)", `${N} adapters/lit/adapt.mjs`, { gate: true }); +if (adaptCode === 3) { + done(3, "DRIFT detected (step 6 is yours). Resolve adapters/lit/drift/*.md per " + + ".claude/rules/designbook-propagation.md, then re-run `make designbook-refresh --no-pull` to re-check + run parity."); +} +if (adaptCode !== 0) done(adaptCode === 2 ? 2 : 5, `adapt-lit failed (exit ${adaptCode}).`); + +// 6: human drift resolution — only reached when adapt-lit is clean. + +// 7: parity gate. +if (args.has("--no-parity")) done(0, "tokens + scaffold clean; parity skipped (--no-parity)."); +const parityCode = run("7/7 parity (contract + visual)", `${N} adapters/lit/parity.mjs`, { gate: true }); +if (parityCode === 4) done(4, "PARITY FAILURE — see adapters/lit/parity/_parity.json."); +if (parityCode !== 0) done(parityCode === 2 ? 2 : 5, `parity-lit failed (exit ${parityCode}).`); + +done(0, "in sync — IR extracted, Lit adapted with no drift, parity passed."); diff --git a/scripts/ir-extract.mjs b/scripts/ir-extract.mjs index 5158d0f..84e0f52 100644 --- a/scripts/ir-extract.mjs +++ b/scripts/ir-extract.mjs @@ -38,6 +38,18 @@ const COMPONENT_SOURCES = ["Atoms.jsx", "Chrome.jsx"]; const log = (...a) => console.log(...a); const kebab = (s) => s.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase(); +// The custom-element tag is an IR-*projection* detail, not something the React +// designbook dictates (React components have no tag). The default mapping is +// `wn-${kebab(Name)}`, but a component's canonical tag can differ from a literal +// kebab of its React name. These overrides record those decisions in one place +// (resolving a tag-mismatch drift the governance-correct way — at the projection, +// not by renaming the hand-authored stack element). The component *name* stays +// faithful to React; only the projected tag is overridden. +const TAG_OVERRIDES = { + PipelineStrip: "wn-pipeline", // React "PipelineStrip"; the established web-component tag is wn-pipeline. +}; +const tagFor = (name) => TAG_OVERRIDES[name] || `wn-${kebab(name)}`; + // ---------- Tokens: _ds_manifest.json tokens[] → W3C DTCG ---------- // Each manifest token: { name:"--ink", value:"#0A0A0A", kind:"color", definedIn }. // Group + DTCG $type are decided by name prefix (kind is a fallback hint). @@ -204,7 +216,7 @@ function extractComponents() { const card = matchExemplar(name, cards); const contract = { name, - tag: `wn-${kebab(name)}`, + tag: tagFor(name), group, description: `${name} — extracted from designbook ui_kits/${KIT}/${file}.`, props, diff --git a/workplans/WHYNOT-WP-0002-designbook-stack-adapters.md b/workplans/WHYNOT-WP-0002-designbook-stack-adapters.md index 4cc0df9..afa5f16 100644 --- a/workplans/WHYNOT-WP-0002-designbook-stack-adapters.md +++ b/workplans/WHYNOT-WP-0002-designbook-stack-adapters.md @@ -4,14 +4,39 @@ type: workplan title: "Technology-neutral designbook with stack adapters (Lit reference)" domain: infotech repo: whynot-design -status: proposed +status: finished owner: claude topic_slug: custodian created: "2026-06-22" -updated: "2026-06-22" +updated: "2026-06-30" state_hub_workstream_id: "0a3511c1-1771-438b-9364-104d8f0de2f8" --- +> **Completed 2026-06-30.** All 11 tasks done. The full pipeline is in place: +> `Claude Design (React) → designbook/ → ir/ → adapters/lit` with `make ir`, +> `make adapt-lit` (tokens + scaffold + drift), `make parity-lit`, the +> `make designbook-refresh` orchestrator, and a plain-css second-adapter smoke +> proving the IR seam. Parity passes (contractFail=0, visualFail=0). +> +> **Drift triage — all three resolved 2026-06-30; `make designbook-refresh` is GREEN +> (0 drift, parity pass).** Each was resolved the governance-correct way (no stack→React +> back-edit, no `ir/` hand-edit): +> 1. **PipelineStrip** — the web-component *tag* is an IR-projection detail (React has +> no tags), so a documented `TAG_OVERRIDES` in `scripts/ir-extract.mjs` maps +> `PipelineStrip → wn-pipeline` (the component *name* stays faithful to React). Tag +> now matches the element; parity tests it. +> 2. **PageHeader.actions** — `actions` is rendered as a *node* in React +> (`{actions &&
{actions}
}`), i.e. slotted content, and `` +> honours it via ``. The drift detector now recognises a prop +> satisfied by a same-named named slot (`prop-via-slot`, informational). +> 3. **Sidebar.current** — a genuine composition divergence (React monolithic `current` +> key ↔ Lit per-item `active` on composable ``). Recorded as a +> justified, auditable **accepted divergence** in `adapters/lit/drift.accepted.json` +> — still listed in the report, downgraded to info, does not gate. +> +> The drift machinery now distinguishes real defects from intentional modelling +> differences, which is the point of the gate. + # Technology-neutral designbook with stack adapters (Lit reference) ## Problem @@ -181,7 +206,7 @@ re-running is a no-op when nothing changed. Add `make adapt-lit` (tokens portion ```task id: WHYNOT-WP-0002-T07 -status: todo +status: done priority: high state_hub_task_id: "00ed1aff-7724-4e90-9a51-fd58699480ca" ``` @@ -201,7 +226,7 @@ hand-authored element**. Map React prop types → Lit property declarations. Wir ```task id: WHYNOT-WP-0002-T08 -status: todo +status: done priority: medium state_hub_task_id: "1f52ca1f-64a6-4643-992f-f0b4812461a0" ``` @@ -264,7 +289,7 @@ visual tests for determinism. ```task id: WHYNOT-WP-0002-T09 -status: todo +status: done priority: high state_hub_task_id: "07e60a34-0c62-4f8b-848b-d3b8d4292a18" ``` @@ -292,7 +317,7 @@ human-in-loop runbook for step 6. Document in `.claude/rules/stack-and-commands. ```task id: WHYNOT-WP-0002-T10 -status: todo +status: done priority: low state_hub_task_id: "483de131-f580-4031-85df-72cf70a45679" ``` diff --git a/workplans/WHYNOT-WP-0004-forgejo-npm-migration.md b/workplans/WHYNOT-WP-0004-forgejo-npm-migration.md new file mode 100644 index 0000000..0ae60d6 --- /dev/null +++ b/workplans/WHYNOT-WP-0004-forgejo-npm-migration.md @@ -0,0 +1,65 @@ +--- +id: WHYNOT-WP-0004 +type: workplan +title: "Move @whynot/design publication to Forgejo Packages" +domain: infotech +repo: whynot-design +status: finished +owner: codex +topic_slug: forgejo-npm-migration +created: "2026-09-04" +updated: "2026-09-04" +state_hub_workstream_id: "a1483ac2-09c6-5c57-ba56-99a8f28cadb8" +--- + +## Reconcile the package release state + +```task +id: WHYNOT-WP-0004-T01 +status: done +priority: high +state_hub_task_id: "c191d55f-302b-5f29-aee1-526516f57ad7" +``` + +Audit the partially completed Forgejo migration, choose a new immutable package +version when the existing Gitea release cannot be reused safely, and verify the +release contents before any credentialed write. This work promotes routed intake +`01a06e08-6936-7762-a347-f832182b7705`. + +## Publish and verify the Forgejo package + +```task +id: WHYNOT-WP-0004-T02 +status: done +priority: high +state_hub_task_id: "93e4835b-b3eb-5af8-ac83-557ea4c59921" +``` + +Use the governed `whynot-design-npm-publish` credential lane to publish the new +version to `https://forgejo.coulomb.social/api/packages/coulomb/npm/`. Verify an +authenticated exact-version install and the shipped IR/version contract without +printing or persisting the credential. + +## Align consumer and operator documentation + +```task +id: WHYNOT-WP-0004-T03 +status: done +priority: medium +state_hub_task_id: "f0614332-75a3-5e99-8fef-c749c76987ac" +``` + +Make Forgejo the single canonical npm endpoint in current package, consumer, and +release guidance. Hand the verified endpoint to ops-warden for catalog and +playbook reconciliation. + +Prepared `@whynot/design@0.4.2` on 2026-09-04. The package dry-run contains 105 +files with IR `designVersion` 0.4.2; all five Playwright visual tests pass. The +changelog gate correctly reports no *post-release* `[Unreleased]` entry after the +0.4.2 section was cut. + +Published and exact-integrity verified on Forgejo on 2026-09-04. The dedicated +publish lane's OpenBao read is healthy but its stored token could not complete +the Forgejo write, so the plan-authorized `forgejo-admin-api-token` lane was used +as a one-time contained recovery path. Dedicated-token rotation remains live in +`WARDEN-WP-0037`; no credential value was printed or persisted. diff --git a/workplans/archived/260627-ADHOC-2026-06-27.md b/workplans/archived/260627-ADHOC-2026-06-27.md index 65788f7..3887998 100644 --- a/workplans/archived/260627-ADHOC-2026-06-27.md +++ b/workplans/archived/260627-ADHOC-2026-06-27.md @@ -1,5 +1,5 @@ --- -id: ADHOC-2026-06-27 +id: WHYNOT-WP-ADHOC-2026-06-27 type: workplan title: "Ad hoc fixes — 2026-06-27" domain: infotech @@ -9,9 +9,11 @@ owner: claude topic_slug: custodian created: "2026-06-27" updated: "2026-06-27" -state_hub_workstream_id: "4945ead3-d54b-438f-963a-2fd687c472d4" +state_hub_workstream_id: "6d6f3bc9-69ff-5fb7-b77a-6b3be204a8d3" --- +> **Terminology note:** Historical text in this archived workplan may use the legacy term "workstream". The fleet term is **workplan** (`canon/standards/workplan-terminology-fleet_v0.1.md`). + # Ad hoc fixes — 2026-06-27 Low-risk opportunistic fixes completed directly during the WHYNOT-WP-0003 session. @@ -19,10 +21,10 @@ Low-risk opportunistic fixes completed directly during the WHYNOT-WP-0003 sessio ## README consumer-onboarding accuracy ```task -id: ADHOC-2026-06-27-T01 +id: WHYNOT-WP-ADHOC-2026-06-27-T01 status: done priority: medium -state_hub_task_id: "76417728-969c-4b26-9ed8-f6cedd793ff4" +state_hub_task_id: "f4f70b75-24d0-5431-ade5-e33874740755" ``` Two staleness fixes in `README.md` found while reviewing the consumer on-ramp: diff --git a/workplans/WHYNOT-WP-0003-downstream-consumption.md b/workplans/archived/260829-WHYNOT-WP-0003-downstream-consumption.md similarity index 88% rename from workplans/WHYNOT-WP-0003-downstream-consumption.md rename to workplans/archived/260829-WHYNOT-WP-0003-downstream-consumption.md index 205f975..12356db 100644 --- a/workplans/WHYNOT-WP-0003-downstream-consumption.md +++ b/workplans/archived/260829-WHYNOT-WP-0003-downstream-consumption.md @@ -4,12 +4,12 @@ type: workplan title: "Downstream consumption: versioned IR releases + consumer drift-check" domain: infotech repo: whynot-design -status: active +status: finished owner: claude topic_slug: custodian created: "2026-06-27" -updated: "2026-06-27" -state_hub_workstream_id: "41fed928-f44a-48f4-9870-120310fbf071" +updated: "2026-08-29" +state_hub_workstream_id: "d3a6ec16-ac40-5ffb-99e7-07f997e59a4a" --- # Downstream consumption: versioned IR releases + consumer drift-check @@ -100,11 +100,27 @@ tagged. Tag the current state as the first real anchor. ```task id: WHYNOT-WP-0003-T02 -status: wait +status: done priority: high state_hub_task_id: "dbd3a2e6-0623-4efd-8293-399002e85ea2" ``` +**Done 2026-06-29.** Published `@whynot/design@0.4.0` to the coulomb Gitea npm +registry (`https://gitea.coulomb.social/api/packages/coulomb/npm/`, 66 files). +Cut as a coherent release first (`make release VERSION=0.4.0` + `make ir` so +`ir/manifest.json` designVersion reads 0.4.0; tagged `v0.4.0`). The token was +sourced via the ops-warden access front door — `warden access +whynot-design-npm-publish --field NPM_AUTH_TOKEN --exec -- npm publish` — which +proxies the OpenBao read as the caller (OIDC `bao login -path=netkingdom role= +whynot-design-workload-kv-read`, OpenBao at `bao.coulomb.social`); no secret was +inlined or committed. Install-verified in a scratch consumer: `npm i +@whynot/design@0.4.0 lit` resolves, installed version + `ir/manifest.json` +designVersion both 0.4.0, and the `exports` map resolves (`.`, `/tokens`, +`/styles/components.css`, `/ir/*`). Lane provisioning tracked as railiance-platform +CCR-2026-0001 (active/ready/resolvable). A separate read/install token id +(`whynot-design-npm-read`) is not yet provisioned — the publish token sufficed for +the verify install. + Make the package installable with a version pin: - Flip `"private": true` → `false`; fix `repository.url` (currently the placeholder `gitea.example.com`) to the real Gitea remote. @@ -282,10 +298,11 @@ shape of the heavier mode. whynot-design. `drift` is read-only against the package; only `.whynot-design.lock` (in the consumer repo) is written. -## Registering this workplan +## Residuals -After review, register the workstream from `~/state-hub`: +All nine tasks are done. T09's go/defer decision is already resolved +(`b7d3d35d`, defer consumer-side contract-parity). -```bash -make fix-consistency REPO=whynot-design -``` +Live residual: `WHYNOT-IN-0001` — provision a consumer-install npm-read +lane. The publish token was enough to verify T02; consumers still need a +read lane to install from the org registry.