Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
be31f6af89 | ||
|
|
7a4b7c6db8 | ||
|
|
086c735c65 | ||
|
|
d4adb53a3a | ||
|
|
50acdc8216 | ||
|
|
2075d235d8 | ||
|
|
452d8e3895 | ||
|
|
d32925cccf | ||
|
|
f8b54ef708 | ||
|
|
a19dc6c5df | ||
|
|
124beb46db | ||
|
|
1121157938 | ||
|
|
e3aba0a637 | ||
|
|
3edb4468a8 | ||
|
|
699a827cae | ||
|
|
765e374584 | ||
|
|
2ab57d9a7e | ||
|
|
17dffac1ea | ||
|
|
36843e4bc9 | ||
|
|
33a0dbd34a | ||
|
|
80ae3decdd | ||
|
|
caef9a0ee3 | ||
|
|
72c827dddf | ||
|
|
498e09bb15 | ||
|
|
68d1f82a2e | ||
|
|
fdf43b197f | ||
|
|
7e2c824d4f | ||
|
|
8890c3ad13 | ||
|
|
f328406bb5 | ||
|
|
6114914dd6 | ||
|
|
4932ad4162 | ||
|
|
a3b117dafc | ||
|
|
3469a74cc1 | ||
|
|
b639c8945d | ||
|
|
9cd39f6ce8 | ||
|
|
d4cfd32c9a | ||
|
|
8215b7a9c5 | ||
|
|
3dfd44ba88 | ||
|
|
3414a19ce6 | ||
|
|
50a78a6917 | ||
|
|
1877ca1fa7 | ||
|
|
57bda29db8 | ||
|
|
3343762c70 | ||
|
|
342da7c353 | ||
|
|
da105160a8 | ||
|
|
977e462e76 | ||
|
|
57134cf36e | ||
|
|
c19a072a3a | ||
|
|
cd8a1be568 | ||
|
|
f968aeded8 | ||
|
|
fb71a02756 | ||
|
|
c8e65f12a6 | ||
|
|
739e56c5cf | ||
|
|
ade74cd636 | ||
|
|
48830c1afb | ||
|
|
b65481cb24 | ||
|
|
7d54941b75 | ||
|
|
5cbc6edce2 | ||
|
|
6b93bcb4c5 | ||
|
|
d49f2d5792 | ||
|
|
bfb47f3a8e | ||
|
|
cb86034de9 | ||
|
|
0d7c2e140b | ||
|
|
eefa7082ed | ||
|
|
8acd7b9d9f | ||
|
|
f026d3eebc | ||
|
|
1b3360dc99 | ||
|
|
16a736a2a9 | ||
|
|
8663eba113 | ||
|
|
f40ddf5f8e | ||
|
|
57e32ab64f | ||
|
|
483c3055b2 | ||
|
|
ca1e137a54 |
No files matched your search
@@ -5,18 +5,23 @@
|
||||
|
||||
```
|
||||
plan2code/
|
||||
├── src/ # Source workflow prompts (11 markdown files)
|
||||
├── src/ # Source workflow prompts (14 markdown files)
|
||||
│ ├── plan2code-0-pathfinder-references/ # Reference files for pathfinder skill
|
||||
│ │ ├── brief.md # Dated plain-English decision briefs
|
||||
│ │ ├── chart.md # MODE A: destination + frontier grills, templates
|
||||
│ │ ├── github-issues.md # Issue-backed map (loaded only when Backend is github)
|
||||
│ │ ├── grilling.md # Folded-in grilling + domain-modeling
|
||||
│ │ ├── questions.md # On-disk question-file format + markers
|
||||
│ │ ├── resolve.md # Per-type resolution + graduating the fog
|
||||
│ │ ├── handoff.md # Clearing gate + PLAN-DRAFT handoff
|
||||
│ │ └── trail.md # Every-response map visual + pathed resume command
|
||||
│ ├── shared-references/ # Reference files shared across skills
|
||||
│ │ └── building-habits.md # Find the cause, test first, pin behaviour (quick-task, implement, implement-review)
|
||||
│ ├── plan2code-review-references/ # Reference files for review skill
|
||||
│ │ ├── verification-protocol.md # Deep verification + confidence calibration
|
||||
│ │ ├── dimensions.md # 11 dimensions with detailed checklists
|
||||
│ │ ├── false-positives.md # Known false-positive patterns
|
||||
│ │ ├── reviewer-brief.md # Fill-in brief for the one fresh helper that runs the analysis
|
||||
│ │ └── session-end.md # Next-step routing at review session end
|
||||
│ ├── plan2code-init-update-references/ # Reference files for init-update skill
|
||||
│ │ └── ai-agent-file-sync.md # Step 7: replace AI configs with AGENTS.md refs
|
||||
@@ -25,6 +30,7 @@ plan2code/
|
||||
├── plan2code-loop/ # Autonomous loop CLI tool (Node.js/TypeScript)
|
||||
│ ├── src/ # TypeScript source
|
||||
│ └── dist/ # Built output (tsup)
|
||||
├── plan2code-bot/ # Autonomous end-to-end workflow test runner (TypeScript, tsup, Claude Agent SDK, vitest); user docs in .readme/test-bot.md
|
||||
├── plan2code-metrics/ # Recursive self-improvement toolchain
|
||||
│ ├── src/ # TypeScript source
|
||||
│ │ └── prompts/ # Internal AI prompt templates (no char limit)
|
||||
@@ -32,20 +38,46 @@ plan2code/
|
||||
├── src/statusline-claude/ # Claude CLI status line (Node.js, zero deps, single file)
|
||||
│ ├── statusline.js # Self-contained: config, git, formatters, render
|
||||
│ └── statusline-config.json # Default config template
|
||||
├── src/launcher/ # Global `plan2code` command (Node.js, zero deps)
|
||||
│ ├── plan2code.js # Opens /plan2code in Claude Code or Devin in the cwd (or a picked folder)
|
||||
│ ├── models.json # Curated model menu, copied to ~/.plan2code/bin/ on install
|
||||
│ └── plan2code.ico # Desktop shortcut icon (Windows)
|
||||
├── src/web-console/ # Local browser UI bundled into every skill (Node.js, zero deps, no build)
|
||||
│ ├── console.mjs # CLI the agent drives: open, post, wait, chat, keep, status, stop, help
|
||||
│ ├── server.mjs, routes.mjs, static.mjs, cmd-*.mjs, picker.mjs, and the by-job files (files, sessions, patches, scan, inbox, workspace, settings)
|
||||
│ ├── console.md, console-*.md, notes/, building*.md # Agent-facing contract (console.md read once, the rest on demand)
|
||||
│ └── public/ # Page assets served to the browser
|
||||
├── scripts/ # Development scripts
|
||||
│ ├── bench-web-console.mjs # Start-path timing
|
||||
│ ├── capture-screenshots.mjs # Stages web console screens and saves the docs screenshots (needs a local Chrome or Edge, through `playwright-core`)
|
||||
│ ├── browser.mjs # The one place a browser is launched (Chrome, then Edge, through `playwright-core`; `PLAN2CODE_TEST_BROWSER` forces one); page tests, the screenshots and the bench use it
|
||||
│ ├── css-snapshot.mjs # Dev-only: every element's computed style on every screen, both themes; take one before a stylesheet move and `--compare` after
|
||||
│ ├── vendor-codemirror.mjs # Dev-only: bundles the pinned CodeMirror 6 packages with esbuild into `public/vendor/codemirror.esm.js` (installed in a temp folder from `vendor-codemirror-lock.json`, never in the repo)
|
||||
│ ├── check-skill-table.mjs # src/plan2code.md "What each skill reads and writes" table vs each skill's prompt and references
|
||||
│ ├── parse-check.mjs # Imports every shipped browser module as real ESM
|
||||
│ ├── screenshots/ # JSON payloads posted per shot (`ask` reuses `question.json`; `finish` follows `signoff.json`)
|
||||
│ ├── test-web-console-*.mjs, web-console-test-helpers.mjs # Web console suites, split by area (the page tests are `-page-*`, the source shape `-shape`), and their shared setup
|
||||
│ ├── test-launcher.mjs, test-getting-started.mjs # Launcher suite; newcomer docs kept in step
|
||||
│ ├── test-skill-scripts.mjs, test-script-<skill>.mjs, test-git-repo.mjs, skill-script-helpers.mjs, fixture-helpers.mjs # Skill script suites and fixtures
|
||||
│ └── validate-char-count.js # Pre-commit character count validator
|
||||
├── dist/ # Generated distribution files (auto-generated)
|
||||
│ ├── global-commands/ # For global installation (~/.claude/, etc.)
|
||||
│ └── local-commands/ # For per-project installation (.claude/, etc.)
|
||||
├── skills/ # Generated, gitignored build output — one Agent Skill per src/ prompt
|
||||
│ └── plan2code-<name>/ # SKILL.md plus references/ and scripts/ where present
|
||||
│ # Generated by npm run build:skills; consumed by skills add
|
||||
├── .husky/ # Git hooks (husky)
|
||||
│ └── pre-commit # Runs character count validation
|
||||
├── .claude/ # Repo-local Claude Code config (NOT installed by install.js)
|
||||
│ └── skills/ # Maintainer-only dev skills, e.g. plan2code-publish/
|
||||
├── docs/ # Documentation and assets
|
||||
│ └── skills/ # Maintainer-only dev skills, e.g. plan2code-publish/, plan2code-model-update/
|
||||
├── .github/ISSUE_TEMPLATE/ # bug.yml, idea.yml, config.yml (target of the console's feedback button)
|
||||
├── .readme/ # User guides linked from README (web-console.md, web-console-design.md, walkthrough.md, autonomous-loop.md, metrics.md, status-line.md, test-bot.md)
|
||||
├── docs/ # Landing page `index.html` served at plan2code.jparkerweb.com (GitHub Pages, `CNAME`) and assets
|
||||
│ └── screenshots/ # Web console screenshots, <shot>-light.webp and <shot>-dark.webp (generated)
|
||||
├── specs/ # Feature specs (if any in-progress)
|
||||
├── install.js # Interactive installer (Node.js)
|
||||
├── package.json # Root package (husky only, private: true)
|
||||
├── version.json # Version metadata
|
||||
├── CHANGELOG.md, QUICK-REFERENCE.md, LICENSE
|
||||
├── .gitattributes, .editorconfig # Pin LF (see Code Style & Gotchas)
|
||||
├── prototypes/, specs--completed/, dist/ # Local only, gitignored: design prototypes, archived specs, stale pre-2.2 build output. Ignore root dist/.
|
||||
└── README.md # User documentation
|
||||
```
|
||||
|
||||
@@ -53,32 +85,41 @@ plan2code/
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `install.js` | Main installer - generates and installs workflow files to AI tool directories |
|
||||
| `install.js` | Interactive installer — builds `skills/` from `src/`, then delegates installation to the skills CLI |
|
||||
| `src/plan2code-*.md` | Source workflow prompts (the "source of truth") |
|
||||
| `scripts/validate-char-count.js` | Pre-commit validator ensuring all source prompts ≤ 11,000 chars |
|
||||
| `skills/` | Generated Agent Skills, gitignored build output regenerated by the installer (and `npm run build:skills`) before every `skills add` |
|
||||
| `scripts/validate-char-count.js` | Pre-commit validator ensuring all source prompts ≤ 20,000 chars |
|
||||
| `version.json` | Version metadata (name, version, description) |
|
||||
| `QUICK-REFERENCE.md` | User quick-reference card |
|
||||
| `src/statusline-claude/` | Claude CLI status bar (included in `A` Install All + dev tools; also via Custom → S) |
|
||||
| `src/statusline-claude/` | Claude CLI status bar (see Status Line below) |
|
||||
| `src/launcher/plan2code.js` | Global `plan2code` command that opens the dashboard skill in Claude Code, Devin or Codex (installed by `I` and Advanced → `E`; also via Advanced → `D`) |
|
||||
|
||||
## Workflow Prompts (in `src/`)
|
||||
|
||||
| File | Step | Purpose |
|
||||
|------|------|---------|
|
||||
| `plan2code.md` | — | The dashboard: opens the web console's skill menu and launches the picked skill into its own session |
|
||||
| `plan2code-init.md` | Init | Generate AGENTS.md as index + `.agents-docs/` section files (progressive discovery) |
|
||||
| `plan2code-init-update.md` | Update | Update AGENTS.md with learnings; detects and routes edits to `.agents-docs/` files |
|
||||
| `plan2code-0-pathfinder.md` | 0 | Chart a foggy idea as a local map of decision questions under `specs/<idea>/pathfinder/`, resolve one per session, hand a seeded PLAN-DRAFT to Step 1 |
|
||||
| `plan2code-0-pathfinder.md` | 0 | Chart a foggy idea as a map (local files, or GitHub Issues) of decision questions under `specs/<idea>/pathfinder/`, resolve them one at a time, hand a seeded PLAN-DRAFT to Step 1 |
|
||||
| `plan2code-quick-task.md` | quick | Lightweight planning for small tasks (standalone — not a pipeline step) |
|
||||
| `plan2code-1-plan.md` | 1 | Requirements analysis & architecture |
|
||||
| `plan2code-1b-revise-plan.md` | 1b | Mid-implementation revisions |
|
||||
| `plan2code-2-document.md` | 2 | Create implementation specs |
|
||||
| `plan2code-3-implement.md` | 3 | Execute implementation (phase by phase) |
|
||||
| `plan2code-review.md` | review | Post-implementation comprehensive review |
|
||||
| `plan2code-3-implement-review.md` | 3 | Execute one phase, run focused review and fixes, then request approval |
|
||||
| `plan2code-review.md` | review | Post-implementation comprehensive review, analysed by one fresh helper when the tool has one (verified in session; the report says who reviewed) |
|
||||
| `plan2code-4-finalize.md` | 4 | Validate, summarize, feedback, archive (steps 1–7, +optional 6.5) |
|
||||
| `plan2code-handoff.md` | handoff | Compact the conversation into a self-contained handoff document for a fresh session |
|
||||
| `plan2code-xray.md` | xray | Explain how and why an area works (files, commits, PRs via `gh` when present), or rank the rough spots worth fixing into `ARCHITECTURE-BRIEF-<date>.md` for Pathfinder or Plan; never edits code |
|
||||
| `plan2code-diagnose.md` | diagnose | Find a bug's cause under the find-the-cause-first habit (`references/building-habits.md`) and write it up as `specs/<bug-name>/DIAGNOSIS-<YYYYMMDD>.md` without fixing it, then offer Quick Task to fix it, or Plan when the fix is big. The dashboard scan reports such a folder as spec state `diagnosed` ("Bug diagnosed"), which lights Quick Task (suggested) and Plan. Once Quick Task marks the diagnosis `Fixed` (nothing past it in the folder) the state is `fixed` ("Bug fixed"): no pipeline card lights, the picker never pre-selects it, and Quick Task offers to archive it with `specs.mjs archive` |
|
||||
| `plan2code-changelog.md` | changelog | Check the CHANGELOG version against the default branch, suggest editable entries for new work, keep `package.json` aligned, offer to commit the result through Git |
|
||||
| `plan2code-git.md` | git | Branches, pull (with conflict help), push, publish and commits (clear message, suggested splits) on the web console's git board, or plain instructions in the terminal (`switch to main`, `commit and push`); asks before every push, publish and delete |
|
||||
|
||||
## Naming Convention
|
||||
|
||||
Workflow files follow a strict naming pattern:
|
||||
- **The hub:** `plan2code.md` (bare name — `bare: true` in `SOURCE_PROMPTS`, no suffix; it is the dashboard the rest hang off, not a step)
|
||||
- **Utilities:** `plan2code-<name>.md` (single dash)
|
||||
- **Numbered steps:** `plan2code-<N>-<name>.md` (single dash, number, single dash)
|
||||
|
||||
@@ -89,34 +130,219 @@ Examples:
|
||||
|
||||
## Reference Files
|
||||
|
||||
Some workflows use companion reference files for depth that exceeds the 11k char limit. The orchestrator (main workflow file) loads them via `Read` directives during execution.
|
||||
Some workflows use companion reference files for depth that does not need to load on every invocation. The orchestrator (main workflow file) loads them via `Read` directives during execution.
|
||||
|
||||
**Pattern:** `src/<source-filename-without-extension>-references/` (e.g., `plan2code-review-references/`)
|
||||
**Pattern:** `src/<source-filename-without-extension>-references/` (e.g., `plan2code-review-references/`). A file several skills read lives in `src/shared-references/` instead and ships to each through `additionalReferences` (e.g., `building-habits.md` into Quick Task, Implement and Implement + Review).
|
||||
|
||||
**How the installer handles them:**
|
||||
- **Skill-directory platforms** (Claude Code, Agents, Crush, Devin): reference files are nested as `<skill-name>/references/`. Read paths use canonical `references/<file>.md`.
|
||||
- **Flat-file platforms** (Windsurf, Cursor, Copilot, Continue): reference files are placed as a sibling directory. The installer rewrites Read paths to the sibling directory name (e.g., `plan2code-review-references/<file>.md`).
|
||||
**How the installer handles them:** the directory is copied verbatim to `skills/<skill-name>/references/`, so `Read references/<file>.md` resolves consistently for every agent. There is one output format, with no flat-file sibling directory or path rewrite.
|
||||
|
||||
Reference files are NOT subject to the 11,000 character limit. The review workflow pioneered this pattern (`verification-protocol`, `dimensions`, `false-positives`, `session-end`); the init-update workflow also uses it (`ai-agent-file-sync` for its Step 7), `plan2code-4-finalize.md` uses it for STEP 6.5 (`community-feedback-submission`), and `plan2code-0-pathfinder.md` leans on it hardest (`chart`, `grilling`, `questions`, `resolve`, `handoff`, `trail` — the orchestrator is a dispatcher, the depth lives in the references). Other workflows can adopt it when a source file's detail exceeds the 11k limit.
|
||||
Reference files are NOT subject to the 20,000 character limit. The review workflow pioneered this pattern (`verification-protocol`, `dimensions`, `false-positives`, `session-end`); the init-update workflow also uses it (`ai-agent-file-sync` for its Step 7), `plan2code-4-finalize.md` uses it for STEP 6.5 (`community-feedback-submission`), and `plan2code-0-pathfinder.md` leans on it hardest (`brief`, `chart`, `github-issues`, `grilling`, `questions`, `resolve`, `handoff`, `trail` — the orchestrator is a dispatcher, the depth lives in the references). Other workflows can adopt it when a source file carries detail that is only needed some of the time. The implement-review skill is a generated composition: `additionalReferences` in `SOURCE_PROMPTS` packages the canonical implement prompt, review prompt, and review reference directory into its own `references/` directory so those workflows are reused without source duplication.
|
||||
|
||||
**`Read` directives must sit at column 0.** `install.js` matches `/^(Read\s+)references\//gm` for the flat-file path rewrite — anchored, with no leading-whitespace tolerance. An indented or bulleted `Read` line is silently skipped, so flat-file platforms ship a `references/` path that does not exist there (they receive the reference dir as a *sibling*, named `plan2code-<name>-references/`).
|
||||
## Skill Scripts
|
||||
|
||||
Anything a workflow step decides with one correct answer (parsing a spec's checkboxes, rebuilding Pathfinder's map markers, the commit message, which AI config files exist) lives in a script the agent runs, not in prose it follows. Prose keeps the judgment.
|
||||
|
||||
| Source | Ships to | How |
|
||||
|---|---|---|
|
||||
| `src/skill-scripts/<name>.mjs` | `skills/<skill>/scripts/<name>.mjs` | Shared: a skill lists the ones it runs in `scripts: [...]` on its `SOURCE_PROMPTS` entry. Skills install independently, so each gets its own copy |
|
||||
| `src/skill-scripts/common.mjs` | every skill that has scripts | `SHARED_SCRIPTS_ALWAYS` in `install.js` |
|
||||
| `src/<source>-scripts/<name>.mjs` | `skills/<skill>/scripts/<name>.mjs` | A skill's own scripts, mirroring `-references/`. A name that collides with a shared script is a build error |
|
||||
| `version.json` (repo root) | `skills/<skill>/scripts/version.json` | Copied at build, so an installed skill can report its version |
|
||||
|
||||
| Script | Skills | Does |
|
||||
|---|---|---|
|
||||
| `specs.mjs` | plan, revise-plan, document, implement, implement-review, review, quick-task, finalize, handoff | `list` / `status` (Phase Checklist, groups, task markers, numbering, the implement selection verdict, consistency checks) / `metrics` / `mark` / `archive`. Imports `scanProject()` from the bundled `web-console/scan.mjs`, so the dashboard and the skills share one spec classifier |
|
||||
| `commit-msg.mjs` | implement(-review), review, quick-task, finalize, init-update, git | The `<subject>` / `AI Assisted` commit command (two `-m` flags), with optional `git add` |
|
||||
| `review-scope.mjs` | review, implement(-review), quick-task | Review Mode's git fallback: files, lines, doc share, base branch |
|
||||
| `agents-md.mjs` | init, init-update | AGENTS.md structure, budget, orphans, broken links, always-inline sections |
|
||||
| `agent-files.mjs` | init, init-update | Detect and replace other agents' config files with AGENTS.md pointers |
|
||||
| `pathfinder.mjs` (own) | 0-pathfinder | `reconcile`, `frontier`, `claim`, `resolve`, `rule-out`, `trail`, `gate`, `lint`, `brief-data` |
|
||||
| `feedback-payload.mjs` (own) | 4-finalize | STEP 6.5's payload (real sha256 prompt hashes) and the gh / browser / print submission tiers |
|
||||
| `xray.mjs` (own) | xray | `hotspots` (churn, files changed together, often-changed files with no test, from `git log` over a capped window) and `history <path>` (commits following renames, a blame summary, PR titles and first paragraphs through `gh` when signed in, and which sources were used). Read-only |
|
||||
| `changelog-state.mjs` (own) | changelog | `state`, `bump`, `set-package-version`: the default branch's version, whether the branch's entry can be extended (not released, not on another branch), the file's heading style, the gap since the entry was last touched; only `set-package-version` writes, and only the version field |
|
||||
| `git.mjs` (own) | git | `state`, `plan`, `branch-check`, `init-check`, `delete-check`, `cleanup-list`, `conflicts`, `pr-url`, `classify-error`: the repo snapshot, each action's exact command and confirm text (shared by the terminal and the board), branch-name, delete, cleanup and git init checks, a stopped rebase's conflicts, the pull-request link and git's errors sorted into kinds with a next step. Read-only: the agent runs every command it prints, and `guard()` refuses force push, hook skipping, amend, remote delete and blanket add |
|
||||
|
||||
**Conventions** (`common.mjs`): Node 18+ built-ins only; one JSON object on stdout (`ok: false` plus `error`, `message`, `next` on a handled failure, the same line on stderr); exit 0 ok, 1 crash, 2 bad arguments, 3 not found, 4 invalid or check failed, 5 refused; `--help` documents commands and exit codes; writes take `--dry-run`; `PLAN2CODE_NOW` pins the clock for tests. A SKILL.md names a script as `node "<S>/<name>.mjs"`, where `<S>` is `scripts/` beside it.
|
||||
|
||||
**Tests:** `scripts/test-skill-scripts.mjs` (installer plumbing and the shared scripts), `scripts/test-script-<skill>.mjs` (a skill's own), with fixtures from `scripts/skill-script-helpers.mjs`. Importing that module rebuilds `skills/` unless `npm_lifecycle_event` is `test` (`npm test` has just built it). Git fixtures go through `copyFixture()` (`scripts/fixture-helpers.mjs`): built once per test file, copied per test, since every `git` process costs a few hundred milliseconds on Windows; a remote inside the fixture is added with `slashed()` so the copy's `.git/config` can be pointed at its own origin. They run the built `skills/` tree, and one test fails if any SKILL.md or shipped reference names a `<S>/<name>.mjs` that skill does not ship. The per-skill scripts import `./common.mjs`, which only sits beside them in the built tree, so run them from `skills/`, not `src/`.
|
||||
|
||||
## Repo-Local Skills (`.claude/skills/`)
|
||||
|
||||
Maintainer-only Claude Code skills committed to the repo but **deliberately excluded** from `install.js` — they are dev tooling, not shipped product, so they never install to `~/.claude/skills/` and carry no version bump of their own (a product-version bump would wrongly imply a user-facing release); changelog mentions fold into the current version's entry.
|
||||
Maintainer-only skills committed to the repo but deliberately excluded from the generated `skills/` product artifact:
|
||||
|
||||
- `plan2code-publish/` — cuts a GitHub Release from the top `CHANGELOG.md` entry once `CHANGELOG.md` / `version.json` / `package.json` agree and the version is ahead of the latest published release. Delegates tag creation to `gh release create --target main`.
|
||||
- `plan2code-publish/` — publishes a GitHub Release after version files agree.
|
||||
- `plan2code-changelog/` — validates release classification and keeps version files synchronized.
|
||||
- `plan2code-model-update/` — refreshes the launcher's curated model menu (`src/launcher/models.json`) from `devin models list` and Claude Code's documented model aliases: shows a diff, applies only the changes the maintainer approves, validates the file and runs `npm test`. Terminal only, and it never commits.
|
||||
- `sync-repo/` — decrypts the protected upstream-sync workflow in memory.
|
||||
|
||||
**Warning:** anything named `plan2code-*` placed under `~/.claude/skills/` is deleted by the installer's uninstall (`uninstallFiles()` in `install.js`) and by every re-install's pre-copy cleanup in `install()` (both match `/^plan2code-/` for the Claude Code skills target). Keep these skills repo-local only.
|
||||
Do not run `skills add` against the repository root: recursive discovery also finds these maintainer skills. `install.js` targets `skills/` and passes explicit workflow names instead. Global install/uninstall cleanup removes `plan2code-*` workflow skills from user skill directories; it never operates on this repository's `.claude/skills/` directory, and `sync-repo` intentionally has no `plan2code-` prefix.
|
||||
|
||||
## Web Console
|
||||
|
||||
Optional local browser UI shipped with **every** skill. Source lives in `src/web-console/` and is fanned into each skill by an `additionalReferences: [{ source: 'web-console', target: 'web-console' }]` entry in `SOURCE_PROMPTS`, landing at `skills/<skill>/references/web-console/`. The bare `plan2code` skill is the hub: it opens the console as `--workflow dashboard`, the page draws the skill menu itself (from each `SKILLS` entry's `card` in `public/skills.js`, through `SKILL_CATALOG` in `public/answers.js`, kept in sync with the install set by a test), and a card click reaches the agent as a `{ "i": "__launch", "skill": ..., "workflow": ... }` send — the dashboard then **resumes its own session** under the launched skill's workflow (`open --resume <sid> --workflow <w>` restates `workflow`/`title`/`specDir` on the live server) and runs that skill's file. `plan2code-review` now has a console of its own AND still runs inside builds on the page (a `review` verdict on Implementation's sign-off card, or the **Review it now** button on a finished quick task), so `plan2code-3-implement` and `plan2code-quick-task` also carry `review.md` and the review references, the same way `implement-review` does. `CONSOLE_WORKFLOWS` in `public/answers.js`, built from the same `SKILLS` list, decides whether a copied hand-off asks the next session for the console.
|
||||
|
||||
| File | Role |
|
||||
|---|---|
|
||||
| `console.mjs` | the CLI the agent drives: `open`, `post`, `wait`, `chat` (the instant Quick question check), `keep` (copy a cited note attachment into `specs/<idea>/attachments/`), `delete-spec`, `handoff new`, `delete-handoff` (both on `handoffs.mjs`), `status`, `stop`, `help` (a compact summary for an agent that found the binary but not `console.md`; `help <topic>` prints one contract file, `help topics` lists them). `post --wait <N>` posts and waits in one command |
|
||||
| `server.mjs` | HTTP server, spawned **detached** by `open` (never as a harness background task, which get killed on compaction and at assorted timeouts) |
|
||||
| `public/` (other files) | `index.html`, `favicon.svg` (Planny peeking up from the tab bar, served as `image/svg+xml`) with `favicon.png` (the same icon at 192 px, served as `image/png`) as the fallback, `vendor/marked.esm.js`, the chimes (`start-skill.mp3`, `bootup.mp3`, `start-stop.mp3`, `next.mp3`, `insert.mp3`, `sleeping.mp3`; which moment plays which is `SOUND_EVENTS` in `palette.js`, one switch per event saved in `looks.json`), and a `package.json` that only says `"type": "module"`, so Node (the server and the tests import the pure modules) parses them as ES modules without a reparse warning. The stylesheet is the files in `public/styles/`, joined by the server into the one `/app.css` the page asks for |
|
||||
| `cmd-chat.mjs` | the `chat` command: hand over Quick questions now, never waiting |
|
||||
| `cmd-help.mjs` | the `help` command: the CLI's usage and the contract's topic files; the usage's workflow list and its build sessions come from `WORKFLOWS` and `isBuild()` in `skills.js` |
|
||||
| `cmd-open.mjs` | the `open` command: start or resume a session, its server and the browser; refuses a `--workflow` that `isWorkflow()` does not know (exit 2, naming the valid ones), and asks `startsClean()` (`public/hops.js`) whether a resume blanks the page |
|
||||
| `cmd-post-wait.mjs` | `post` and `wait`: publish a patch, then collect what the person sent |
|
||||
| `cmd-small.mjs` | the small commands: keep, forget, delete-spec, handoff, delete-handoff, status and stop; `handoff new` refuses an unknown `--workflow` the same way `open` does |
|
||||
| `files.mjs` | where the console's files live, how they are written safely, and the argument parser both command lines share |
|
||||
| `inbox.mjs` | the Quick question chat's inbox beside the card slot |
|
||||
| `patches.mjs` | checking and merging an agent's patch into the session state: `validate()` (the house rules; allows `templates` only as `"idea"` on a `text` item, anything else exits 3), the patch merge, `resolveDocFiles()` and `applyPatch()` |
|
||||
| `routes.mjs` | every URL the page can call, in one ordered list (`ROUTES`, walked by `handle()`); `server.mjs` hands each request to it |
|
||||
| `scan.mjs` | what the dashboard knows about the repo: `scanProject()`, `classifySpec()` (a folder's files to a spec state), `TASK_LINE_RE` (re-exported from `spec-files.mjs`) and `removeSpec()` |
|
||||
| `sessions.mjs` | a session's roots and handle files (`repoRoots()`, `healthOk()`, `attachmentName()`: the kept-file name `<slug>-<id8>.<ext>`, the same upload always gets the same name, `readOverview()`) and the console folder's housekeeping: the three sweeps `open` runs fire-and-forget after it prints (`sweepUploads()`, `staleSessions()` / `removeSessions()`, `staleScratch()` / `removeScratch()`) and `cleanupFindings()` / `removeCleanup()` for User Preferences → Cleanup |
|
||||
| `settings.mjs` | the person's saved console settings: Subagents and pull-request hosts |
|
||||
| `spec-files.mjs` | no imports: how a spec's markdown files are read, `MARKERS`, `TASK_LINE_RE`, `TASK_ID_RE`, `CHECKBOX_RE`, `STATUS_RE`, `statusOf()` and `countTasks()`; shared by `scan.mjs`, `patches.mjs` and `src/skill-scripts/specs.mjs` (through `consoleModule()`) |
|
||||
| `static.mjs` | serving the page's own files: `SERVABLE` (the allow-list), `TYPES`, caching and ETags, the accent colors, and `CSS_ORDER` + `joinedStyles()`, the one place the cascade order is stated |
|
||||
| `workspace.mjs` | the session's extra folders, and the folders remembered per project and spec |
|
||||
| `public/app.js` | the page's entry and the only page file that starts anything: the start-up block. `index.html` loads it; it imports `screens/core.js` and the screens beside it |
|
||||
| `public/doc-files.js` | a document as the page shows it, and as a file: blocks, Markdown and HTML download |
|
||||
| `public/hops.js` | no imports: the hop rule, `startsClean(from, to)`, which says whether a hop from one workflow to another starts the new skill on a clean page (to or from the dashboard, into Git, or from one skill into another off a finished screen, but never out of Git or into Review); shared by `cmd-open.mjs`, `server.mjs` (its Ask reset) and `screens/core.js` |
|
||||
| `public/looks.js` | how the page looks and sounds: the saved looks, their sync, and the preferences dialog's swatches |
|
||||
| `public/mention-box.js` | the @name suggestions popover under a text box |
|
||||
| `public/net.js` | the page talking to its own server |
|
||||
| `public/palette.js` | the highlight colors, the sound events and the card widths, as data (importable by Node so a test can check every shade in both themes) |
|
||||
| `public/render.js` | Markdown to DOM, safely: no HTML string is ever produced, only nodes built with `createElement` and `textContent`; also the shared page helpers (`el`, `md`, `copyButton`, `lightDismiss`) |
|
||||
| `public/selectors.js` | what the page reads off its state: the questions, the finish, the scan, who has the ball |
|
||||
| `public/send-state.js` | whether Send is available, and what its button says |
|
||||
| `public/skills.js` | the skill list: every per-skill fact the console uses (card, order, start pose, launch scoring, subagent opt-in, which spec states light its card), data only, imported by the page and by Node; the older tables (`SKILL_CATALOG`, `START_POSES`, `CONSOLE_WORKFLOWS` and the rest, in `answers.js`) are lookups on it. Each entry also carries `weight` (what its launch and `run` score on the meter, or null), `started` and `ran` (the meter's labels for them, or null), `resume` (`"overview"`, `"folder"` or null: what the resume command takes after the skill's command) and an optional `card.help` (Help's line for the card when it differs from `blurb`). `WORKFLOWS` (every entry's workflow, in order) and `isWorkflow()` are what the CLI checks a `--workflow` against. The meter's `WEIGHTS`, `LAUNCH_LABELS` and `RUN_LABELS`, `resumeCommand()`, Help's card list and `cmd-help`'s workflow list are all derived from it, so a new skill is one entry here, not an edit to each of those |
|
||||
| `public/sound.js` | the sound cues: which plays, one at a time, held until the first click |
|
||||
| `public/spec-states.js` | the spec states (`diagnosed`, `fixed`, `exploring`, `mapped`, `planned`, `documented`, `building`, `built`, `unrecognized`): each one's picker label, the card it is the natural next step for and its recommendation, data only; which cards a state lights lives in `skills.js`, how a folder maps to a state in `classifySpec()` in `scan.mjs` |
|
||||
| `public/state.js` | the page's shared state (`page.S` the server's truth, `page.local` what is staged) and the `redraw()` / save hooks every screen calls; defines only |
|
||||
| `public/uploads.js` | pictures and documents attached to a note: chips, trays, re-encoding, upload, retry |
|
||||
| `public/screens/ask.js` | the Ask chat, the Subagents tab, and attaching files to notes |
|
||||
| `public/screens/cards.js` | question cards: every kind, the pager, settled and in-flight records |
|
||||
| `public/screens/cleanup.js` | User Preferences, Cleanup tab |
|
||||
| `public/screens/core.js` | the core every screen sits inside: connection, the render loop, the page chrome and Send; the only file that imports the screens, and only `app.js` imports it |
|
||||
| `public/screens/dashboard.js` | the dashboard: cards, the spec picker, handoff chips, delete, and the first-open wake-up |
|
||||
| `public/screens/docs.js` | documents: tabs, blocks, print and download, and the brief button |
|
||||
| `public/screens/ending.js` | how a session ends: the finished screen, its offers, Stop and the way home |
|
||||
| `public/screens/git-host.js` | hosts the git board: tabs, panels and what each click sends |
|
||||
| `public/screens/help-dialog.js` | the Help dialog and the first-run Welcome (named so it is never confused with the pure help.js) |
|
||||
| `public/screens/looks.js` | User Preferences: looks, sounds and the launcher's model menus |
|
||||
| `public/screens/starting.js` | the launching, starting and waiting screens, with Planny's poses |
|
||||
| `public/screens/workspace.js` | the read-only Workspace of extra folders, and @mentions |
|
||||
| `public/styles/ask.css` | The Ask pane and its Quick question chat |
|
||||
| `public/styles/dashboard.css` | The dashboard: the menu, the spec picker, its confirm and the launching pane |
|
||||
| `public/styles/docs.css` | Documents and the doc tools |
|
||||
| `public/styles/ending.css` | The end of a session: the hand-off and the stopping screen |
|
||||
| `public/styles/git.css` | The git board |
|
||||
| `public/styles/help.css` | The help dialog, its diagrams and its tabs |
|
||||
| `public/styles/looks.css` | The looks button and the highlight swatches |
|
||||
| `public/styles/pieces.css` | Shared pieces: cards, options, settled answers, pager, forms, checklist, markdown and the modal |
|
||||
| `public/styles/planny.css` | Planny the mascot: the flight, his moods and variants, and the wake-up |
|
||||
| `public/styles/poses.css` | The start-screen poses, one per skill. After the dashboard on purpose: its narrow-window rules override the dashboard's |
|
||||
| `public/styles/responsive.css` | Print, then the narrow-window rules: last, so its overrides come after everything they override |
|
||||
| `public/styles/shell.css` | The page shell: banner, top bar and meter, layout, sidebar, aside, footer, waiting and arrival |
|
||||
| `public/styles/tokens.css` | Colours, type, sizes and the light and dark themes: the variables every other file reads |
|
||||
| `public/help.js` | the Help dialog's PURE rules: `HELP_TABS` (18 tabs: ids, order, labels, diagram flags; every tab uses the chosen highlight color; The git board sits right after Watching a build), `helpTabFor()` (which tab opens, FR-8 order, first match wins: finished → Stopping and finishing, server gone or agent adrift → When something looks stuck, opened from the Workspace dialog → Your workspace, then Ask, the Subagents tab → Helpers (subagents), a red-meter dashboard → Session meter, dashboard, a doc or the Overview, a git session → The git board, a build, else What this page is) and `helpKeyTarget()` (roving arrow keys, Home, End, wrapping). No module-scope DOM, so `node --test` covers it |
|
||||
| `git-repo.mjs` | the one read-only reader of a git repository: the worktree status (`countPending()`, behind `pendingFiles()`), the branch table, the default branch, a merge or rebase in progress, the remotes and their web addresses, the last fetch and the pull-request link; `snapshot()` is what `open` and every `reread` store as `state.git`. Every git call carries `GIT_OPTIONAL_LOCKS=0`, so a background look never takes the index lock. Imported by `cmd-open.mjs`, `cmd-post-wait.mjs` and `sessions.mjs`; the git skill's `git.mjs` reaches it through `common.mjs` |
|
||||
| `public/git-board.js` | PURE, one import (`pr-url.js`): the git board's rules from a `state.git` snapshot: branch order and the Remote only fold at `REMOTE_FOLD` 50, whether a new branch name is free, which buttons show and are enabled, whether the board still waits on the agent (`boardAwaiting()`: from a click until the agent's next post, not just until `wait` collects it), the plain sentence each click sends as `reply`, the "Last refreshed" line, which files start ticked in the commit dialog, and the pull-request link; the next step (ten rules, `nextStep()`), the tab that owns it, per-tab badges (`tabBadges()`), the busy mode and per-control gate (`busyMode()`, `controlAllowed()`), the tab to show (`pickTab()`), and the create-panel sources and clean-up groups. `app.js` only renders what it says |
|
||||
| `public/git-board-view.js` | No DOM access of its own: `drawGitBoard(ctx)` draws the tabbed board (header, tab strip with Done with git, the card slot, step strip, Changes / Branches / Sync) from the helpers it is handed (`el`, `md`, `copyButton`), every control through one gate; `screens/git-host.js` hosts it, and `scripts/test-web-console-git-board.mjs` drives it with a recording fake `el` |
|
||||
| `public/pr-url.js` | PURE, no imports: `prUrl()`, the "open a pull request" link for the GitHub, GitLab, Azure DevOps and Bitbucket shapes (`null` for an unknown kind, no web address, or a non-https result). `git-repo.mjs` re-exports it, and the board's base picker rebuilds the link in the browser with the same code |
|
||||
| `public/workspace.js` | PURE, no imports: the Workspace's name rules (`nameProblem()`, `NAME_MAX`, `defaultName()`, `freeName()` for the `-2` suggestion), the footer label and its width tiers (`footerLabel()`, `FOOTER_TIERS`) and `changeLine()`, the `Workspace: …` reply line an agent is handed per change. Imported by the server, `cmd-chat.mjs`, `cmd-post-wait.mjs`, `workspace.mjs` and the page |
|
||||
| `public/meter.js` | PURE, imports only `skills.js`: the session meter. `WEIGHTS` (the events that are not a skill's own launch, merged with each skill's `weight` from `skills.js`; its keys are also `RUN_EVENTS`, the `run` events `post` accepts), `LAUNCH_COUNTED` (workflows whose launch itself scores), the built-phase sizing (`TASK_EVENTS`, the keys of `TASK_BONUS`: `implement-phase` +0 and `implement-review-phase` +1; `isTaskCount()` accepts a whole `tasks` from 1 to `MAX_TASKS` 999; `runPoints()` scores such a run `ceil(tasks / TASKS_PER_POINT)` (3) plus its bonus, and any other run its `WEIGHTS` value), `ANSWERS_PER_POINT` 2 (`answer` entries score per skill run, `floor(count / 2)`), `breakdownFrom()` (the click-the-ring list: one row per scoring entry plus one answers row per skill run), `pointsFrom()` (the count, its sum, folded from `ledger.ndjson` and deduplicated by id, never stored), `levelFor()` with `YELLOW_AT` 5 / `RED_AT` 10, `ringFraction()` (full at `RING_FULL` 15), `WORDS`, `tooltipFor()`, `RED_BANNER` and `meterView()` |
|
||||
| `public/mentions.js` | PURE, no imports: the `@name` popover's logic — `mentionAt()` finds an `@partial` at the caret, `matchNames()` filters the workspace names, `applyMention()` splices a pick in and returns the new caret. Used by the Ask box, notes and text answers |
|
||||
| `public/favicon.js` | The tab icon's status bar. `faviconState({ mood, spin, finished })` (PURE) maps the call `renderStatus()` makes for Planny's line to `busy` (the spinning ring), `ready` (`point`), `attention` (`adrift`, `gone`, or `work` without the ring — the stale line) or `plain` (finished, `happy`); `faviconSvg()` is `FAVICON_BODY` (kept equal to `favicon.svg` by a test) plus a bar along the bottom edge in the `FAVICON_COLORS` color (busy dashed on a white strip, so the states differ by pattern; the rest solid); `setFavicon()` swaps both `<link rel=icon>` hrefs only on a change — the SVG as a data URL, the PNG link drawn through a canvas. Called from `say()` in `renderStatus()`, which runs every second |
|
||||
| `public/subagents.js` | PURE, no imports: the Subagents switch. `SUBAGENT_WORKFLOWS` / `offered()` (the opt-in table: `implement`, `implement-review`, `quick-task`, `review`, `pathfinder`, each with its default instruction), `cleanSetting()` (`{ on, instruction, max }` or `{ error }`: `bad`, `too-long` past 2,000 characters, `max` outside 1-20), `FRAME_LINES`, `blockFor(setting, told)` (the `Subagents:` lines and `subagents` field an agent is owed, given the session setting and its cursor; never says "off" to an agent not told "on"), `checkHelper()` / `checkHelpers()` (the `helpers` house rule) and the page's view rules `showSwitch()`, `switchLabel()`, `helperRows()`, `showTab()`, `CHECKIN_LINE`. Imported by the server, the `cmd-*.mjs` files, `patches.mjs`, `settings.mjs`, the page and the tests; in `SERVABLE` and preloaded |
|
||||
| `handoffs.mjs` | the handoff store, the only code that names, lists, marks, deletes and sweeps handoffs, all in `~/.plan2code/handoffs/` (`PLAN2CODE_HANDOFFS_DIR` for tests; `PLAN2CODE_NOW` pins its clock): `newHandoff()` claims `YYYY-MM-DD-HHmm-handoff` (`-2`, `-3` on a clash, the `.json` created exclusively) and writes only `<id>.json` (`{ v: 1, id, title, worktree, project, spec, workflow, skill, written, fromStop, usedAt }`), the agent writing `<id>.md`; `listHandoffs(worktree)` (unused, same worktree, `.md` present, newest first, title and Next task read off the document); `readHandoffMeta()`, `markHandoffUsed()`; `removeHandoff()` (`HANDOFF_ID` only, regular files, never a link, realpath inside the folder, throws on any refusal); `staleHandoffs()` / `removeHandoffs()` for the sweep |
|
||||
| `notepads.mjs` | the notebook store (the feature is named Notebook; its code, routes and storage folder keep the name `notepad`), the only code that names, reads, writes and removes notebooks, one per folder Plan2Code runs in, in `~/.plan2code/notepads/<folder-name>-<12 hex>/` (`PLAN2CODE_NOTEPADS_DIR` for tests), split into named tabs: `meta.json` (`{ v: 2, folder, created }`), `tabs.json` (`{ v: 1, order, last, tabs: { id: { name, created } } }`) and `tabs/<id>/note.md` with `tabs/<id>/images/`. `notepadKey()` (the folder's basename slug and the first 12 hex of `sha256(foldKey(folder))`), `listTabs()` / `defaultTabId()`, `readNotepad(folder, tab)` (never creates or writes anything; `{ tabs, last, tab }` with the tab's `text`, `savedAt` and `images` repeated at the top), the tab changes `createTab()` / `renameTab()` / `reorderTabs()` / `setLastTab()` / `deleteTab()` (index first, then the folder; names pass `normalizeTabName()`, `TAB_NAME_MAX` 40, any case compared by `nameKey()`, `NOTEPAD_MAX_TABS` 20), `saveNote(folder, tab, text)` (1 MB cap, atomic), `addImage()` / `addThumb()` / `removeImage()` (JPEG bytes only, 200 pictures per tab, UUID names), `imagePath()` (regular files whose realpath stays inside the folder), `staleNotepads(now, maxAgeMs)` (the real folders directly under it named like a key, never a link or a file, whose newest file is at least `maxAgeMs` old, as `{ key, folder, path }` with `folder` from `meta.json` or null), `removeNotepad(key)` (the key checked against `NOTEPAD_KEY_RE`, the path kept inside the notepads folder by `path.relative`, a link refused, then the whole folder removed; User Preferences, Cleanup is its only caller) and `NotepadError` (`code` and `status`, turned into `{ error }` by the `/notepad` routes). **Migration:** a notepad in the first shape (`note.md` and `images/` at the top) reads as one virtual tab, Notes (`LEGACY_TAB_ID`), and writes nothing; its first write moves the files into `tabs/<LEGACY_TAB_ID>/` and writes `tabs.json` last, every step safe to run again after a crash. A `tabs.json` that does not hold up is set aside as `tabs.json.corrupt` and rebuilt from the tab folders on the next write. Every write runs under a `notepad.lock` in the notepad's folder. The agent CLI never imports it: nothing in a notepad reaches the agent |
|
||||
| `public/notepad.js` | PURE, no imports: the Notebook's rules. `SAVE_DEBOUNCE_MS` 800, `RETRY_STEPS_MS` (1 s up to 30 s), `NOTE_MAX_BYTES` / `NOTEPAD_MAX_IMAGES` / `TAB_NAME_MAX` / `NOTEPAD_MAX_TABS` / `IMAGE_ID_RE` / `TAB_ID_RE` (kept equal to `notepads.mjs` by a test), `noteBytes()`, the save-state reducer `nextSave(state, event)` from `SAVE_START` (states `idle`, `pending`, `saving`, `saved`, `failed`, `too-long`; it returns the timer to arm), `saveStatus()` (the status line's words), `unsaved()` (what `beforeunload` asks on), `keepsText()` (unsaved or too long: a reopen never replaces the editor's text then), `tabSwitch()` (whether leaving a tab must save it first), `NOT_LOADED`, `EDITOR_NOT_LOADED`, `errorSentence()` (one sentence per `/notepad` refusal, else a lost connection), the tab rules `cleanTabName()`, `nameTaken()`, `tabNameProblem()`, `moveTab()`, `dropTab()` and the two-confirm delete `nextDelete()` / `DELETE_STAGES`, and `step()` (wrapping through the pictures) |
|
||||
| `public/screens/notepad.js` | the Notebook: `#btn-notepad` in the top bar on every screen (disabled while the server is gone, `renderNotepadButton()` in the render pass), `#notepad-modal`, the one CodeMirror editor (made on first open by a dynamic import of `notepad-editor.js`), the page's view of the notepad as `{ tabs, activeId }`, the name form (New tab and Rename, never `window.prompt`), the in-modal two-step delete, and autosave through `nextSave()` to `POST /notepad/text?tab=<id>`, flushed on close, when the page is hidden and before a switch. The editor stays read-only until the first read lands, so nothing typed into an empty editor is saved over a note. **Every save and every picture is bound to the tab it was made in**: `saveTab` is fixed when the change is made, a picture entry carries its `tab`, and a switch waits for the save (`settled()`), stays put with "Not saved yet, so staying on this tab." when it cannot, and drops a deleted tab's unsaved text without sending it |
|
||||
| `public/notepad-tabs.js` | the tab bar: `createTabs({ onSwitch, onChange })` with `draw(tabs, activeId)` (`role="tab"` buttons, roving `tabindex`, arrow keys, Alt+arrows to reorder, F2 and double-click to rename, native drag and drop with an `.is-drop-before` mark that only a tab drag lights, focus kept across redraws, `#notepad-empty` and `#notepad-body` toggled) and `focusTab()`. No fetches: it calls back, and `screens/notepad.js` owns every request |
|
||||
| `public/notepad-editor.js` | the Notebook's live-preview editor on CodeMirror 6 (`makeCodeMirrorEditor(parent, { onChange, label })` returning `{ getValue, setValue, setReadOnly, focus, destroy }`). A `ViewPlugin` decorates only the lines in view from the Markdown syntax tree: heading line classes `cm-h1` to `cm-h6`, bullets drawn as a widget, the marks around bold, links, quotes and a heading hidden on every line the selection is not on. The editor sits in a shadow root (`.notepad-cm-host`), because CodeMirror writes its rules as a `<style>` element, which `style-src 'self'` refuses, and adopts them as a constructed stylesheet inside a shadow root. `setValue()` is `setState()`: not reported through `onChange`, and the undo history is cleared (so each tab starts with a clean one) |
|
||||
| `public/notepad-editor.css` | the one stylesheet of that shadow root, linked from `notepad-editor.js` (a `<link>` inside the root, in `SERVABLE`, not in `CSS_ORDER`): heading sizes, bullets, quote, code and link looks on the console's tokens (custom properties inherit across the boundary, so both themes work). Rules that meet CodeMirror's own base theme use `div.cm-editor` for the specificity |
|
||||
| `public/vendor/codemirror.esm.js` | CodeMirror 6 (state, view, language, commands, lang-markdown, MIT), bundled into one minified ES module by `scripts/vendor-codemirror.mjs` (sha256 `4ff96d58fc1a5497eb933426bd2d160d2fb0cf490de8bb9302c304096c71c1d4`, the six top-level versions in the script and the file's header comment, everything they pull in pinned by `scripts/vendor-codemirror-lock.json` and installed with `npm ci`, so the same lock gives the same bytes). Never edited by hand: change a version in the script and run `node scripts/vendor-codemirror.mjs --update-lock` (needs npm and network; the packages install in a temp folder, never in the repo), or without the flag to rebuild from the lock |
|
||||
| `public/styles/notepad.css` | the notebook's own rules: the top bar button, the dialog, the tab bar and its tools, the name form, the delete question, the empty state and the pictures. The editor's look is `notepad-editor.css`, inside its shadow root |
|
||||
| `picker.mjs` | the per-OS native folder picker behind **Browse…** (`pickerCommand()` → `{ command, args, env }` or `null`; `pickFolder()` runs it with async `spawn`, so the server keeps serving while the dialog is open). Copied from `src/launcher/plan2code.js` (self-contained CommonJS, so it cannot be shared) with the prompt as a parameter; a drift test keeps the two in step |
|
||||
| `update-check.mjs` | the dashboard's release check, server-only (never in `SERVABLE`): `compareVersions()` (numeric X.Y.Z, `null` otherwise), `latestTag()` (the highest `refs/tags/vX.Y.Z`, peeled `^{}` and pre-release tags skipped), `checkForUpdate({ installed, cacheFile, now, run })` (never throws) and `runLsRemote()` (`git ls-remote --tags` on the repo: no shell, `GIT_TERMINAL_PROMPT=0`, `GCM_INTERACTIVE=never`, SSH `BatchMode` when `GIT_SSH_COMMAND` is unset, `windowsHide`, killed at 10 s; git authenticates itself, the console never touches a credential). The answer, failures included, is cached for an hour in `~/.plan2code/console/update-check.json` (`UPDATE_CHECK_FILE`, in `PROTECTED_CONSOLE_FILES` so no sweep removes it). `server.mjs` starts it after the ready line and never awaits it; `stateFrame()` carries `update: { installed, latest }` only when a newer release exists (its `latest` is part of `haveKey()`, so a page that connected first still gets it), and `GET /version` returns `{ version, latest }`. Tests seed a fresh cached failure in every console home, so no test server reaches the network. The `plan2code` launcher reads the same cache for its terminal release notice (a copy of this module sits in `~/.plan2code/bin/`) |
|
||||
| `public/chat.js` | the Quick question chat's PURE rules, shared by the server and the page: `CHAT_LIMIT` / `CHAT_MAX_CHARS` / `CHAT_MAX_ATTACHMENTS` (the combined image + document cap; `CHAT_MAX_IMAGES` is kept as an alias of it), `chatOffline()` (the server's `409 offline` guard), and the page's view model (`chatView`, `sendState`, `nextAbout`, `contextOptions`, `unreadDot` / `shouldChime`). Ask context is the `{ history, about }` model: `nextAbout()` records the last 3 places visited in `history` and sets `about` only when the person picks one from **+ Add context** (`contextOptions()` lists that history plus *This spec*); dropping it or a successful send clears it, so the page never attaches context on its own. Imports only `answers.js`, no module-scope DOM, so `node --test` covers it |
|
||||
| `public/starters.js` | PURE, no imports: the Role list (`ROLES`, `ROLE_NOT_SET`, `normalizeRole()`, `needsRoleNudge()`: the dashboard banner shows until `looks.json` carries any `role`), the 19 starter templates (Markdown `## heading` sections, shape pinned by a test) and their per-role orders (`TEMPLATES`, `TEMPLATE_ORDERS`, `templatesFor()`, `templateSwap()` for the replace prompt), and the Ask starter sets (`STARTER_SETS`, `STARTER_SET_FOR`, `startersFor()`). Imported by the page's looks and screens and by the tests; in `SERVABLE`, preloaded by `index.html` and parse-checked. The page owns the wording; a skill only flags its fresh-idea `text` card with `"templates": "idea"` |
|
||||
| `public/answers.js` | the page's PURE answer-shaping logic (what an answer reads as, what a placeholder offers, whether a send carries an answer at all). Kept out of the page's entry because `app.js` cannot be imported outside a browser, so anything left in it is untestable. The `scripts/test-web-console-*.mjs` tests import it directly. |
|
||||
| `public/labels.js` | `taskLabel()` / `activityLabel()`: rewrites a build's `Task 4.2 of 6` activity line to `Task 2 of 6` (only for `implement` / `implement-review`; a plan's `Task 2.1` is a real section number). A separate module for the same reason as `answers.js`: pure, so `node --test` can import it |
|
||||
| `public/boot.js` | `playWake()`: the dashboard's first-open wake-up. Self-contained (it owns its timers, the listeners that swallow input mid-run and the one measured glide transform; the page's `stir()` callback times the nudge between the click and the boot, which `screens/dashboard.js` fills with one snore; `skipEl` — the muted Skip button, and Escape — ends the run early with `onSkip` as the cue to silence queued sounds) and free of module-scope DOM access, so it can be imported by the tests and kept out of the screens' render paths; `GLIDE_AT_MS` / `DONE_AT_MS` are its timings |
|
||||
| `console.md` | the core of the agent-facing contract, read once per conversation (every skill ships the same copy, so a dashboard hop never re-reads it): starting, the turn (`post --wait`, the exit codes, handling a send, `settle`), posting, the payload and its kinds, documents (including `file` blocks), the house rules, and an index of the topic files below with the moment each is read. A test caps it at 24,000 characters |
|
||||
| `console-finish.md` · `console-stop.md` · `console-chat.md` · `console-workspace.md` · `console-subagents.md` · `console-launches.md` · `console-meter.md` · `console-attachments.md` · `console-trouble.md` | topic files, each read only when its moment first comes: finishing (the finish and its buttons), stop requests (the way home mid-workflow, `stopWarning`, resuming a pause), Quick questions, the Workspace, standing instructions and helper reports, dashboard launches and the menu payload, the session meter's `run` events (read only when a `run` is refused: the notes inline every `run`), keeping a cited note attachment, and recovery |
|
||||
| `notes/<workflow>.md` | per-workflow notes (`init` for both inits, `pathfinder` with Briefs, `plan`, `revise-plan`, `document`, `implement` for both builds, `quick-task`, `review`, `finalize`, `handoff`, `changelog`, `git`, `xray`, `diagnose`). Each skill's Interface line reads `<D>/console.md` and its own notes file right after `open`; a test checks every skill names one that exists |
|
||||
| `building.md` · `building-review.md` | the build half of the contract, for `implement`, `implement-review` and `quick-task`: progress posts (`agent.activity`, `agent.quietMinutes`, `file` blocks re-read with `refresh`), the chat check between tasks, questions mid-build and stop requests; `building-review.md` is the review run on the page (the sign-off's `review` verdict, **Review it now**, Implement + Review's Stage 2), read only when asked for |
|
||||
|
||||
Key design points:
|
||||
|
||||
- **First-run Welcome.** The first dashboard a person sees (after the wake-up finishes) opens `#welcome-modal`. Any close (button, Esc, backdrop) saves `looks.welcomeSeen: true` to `looks.json`, which survives "Back to default". Help's first tab has a **Show the welcome again** link (`data-action="welcome"`). Logic: `maybeWelcome()` / `openWelcome()` in `screens/help-dialog.js`.
|
||||
- **Top-bar icons.** `#btn-looks` (gear) opens `#looks-modal`, titled User Preferences: Role, Theme, Card width, Highlight color, Sounds and Models. `#btn-feedback` (megaphone) is a plain link to `https://github.com/jparkerweb/plan2code/issues/new/choose`, backed by `.github/ISSUE_TEMPLATE/bug.yml` and `idea.yml` (`config.yml` sets `blank_issues_enabled: false`). `DEFAULT_ACCENT` in `palette.js` is `ocean`.
|
||||
- **Version in Help.** `GET /version` reads `version.json` beside `server.mjs`, falling back to `../../version.json` for a run from `src/` (the `/version` route in `routes.mjs`). `renderHelpVersion()` in `screens/help-dialog.js` fills `#help-version`. `computeExpectedSkills()` in `install.js` injects the root `version.json` into every `references/web-console/`, so a version bump changes every skill.
|
||||
- **Models in User Preferences.** `GET` / `POST /models` in `routes.mjs` read the shipped `~/.plan2code/bin/models.json` and read/write the user's `~/.plan2code/models.json` (`SHIPPED_MODELS_FILE` / `USER_MODELS_FILE` in `files.mjs`). `PLAN2CODE_MODELS_DIR` relocates both for tests. The launcher reads the same two files for its model menu.
|
||||
- **The wait is bounded.** `wait --seconds 240` exits `0` (answers), `10` (still waiting, `message: "Waiting on your answer in the web console"` to relay), `20` (server gone, resume it) or `30` (cancelled). The agent loops. Nothing blocks for the whole time a person takes.
|
||||
- **A turn is one command, and the CLI does the bookkeeping.** Agent speed is model round trips and typed tokens, not the console (`bench-web-console.mjs --roundtrip`: Send→agent ~70 ms, post→page ~180 ms), so the CLI absorbs every step with one right answer: `consume()` marks the agent `working` when it hands over a submit (`markWorking()`), and `wait` hands the turn back (`markWaiting()`) when it starts with an open question, a finish, or on the dashboard or git board; `post --wait <N>` posts and waits in one process; `settle: true | [ids]` (`settleItems()` in `patches.mjs`) records the latest send's cards as answered from their `submitted`; a new or reopened question with no stated status sets `waiting` and waiting drops `quietMinutes` (`settleAgent()`); a doc whose content changed with no `version` moves up one (`mergeDocs()`); a chat reply with no `id` is `r<re>`; doc blocks with `file` (and `select: "tasks"`, doc-level `refresh: true`) are read from the worktree by `resolveDocFiles()` before the merge, refusing paths outside it; and a hop (`__launch`, `__dashboard`, `__commit`, `__pickup`) comes with `resume` (the exact `open --resume` command) and `skillFile` (`hopFor()`), a pick-up also with `handoffFile`. The wait loop's health check runs beside the 50 ms polling instead of blocking it, and is aborted on exit. `help <topic>` prints any contract file; `help topics` lists them. `token` defaults to the option key in the page's `tokenFor()`, and nothing reads `fallbackText`, so the contract no longer asks for either.
|
||||
- **The CLI hands the agent its terminal line.** `open`, `post` and `wait` (exits `0` and `10`) print `terminalLine: "→ Look at the web console: <url>"` (`terminalLine()` in `sessions.mjs`), and `console.md` asks the agent to end every terminal message with the latest one verbatim, so the tool builds the line rather than the model. In `wait` it is added to the printed result only; the collected `result.json` on disk never carries it. `open` also prints `swept: { sessions, scratch, handoffs }` when it found anything to clean.
|
||||
- **State fields written by `open`, not the agent.** Every `open` (fresh or resume) records `state.worktree` and `state.branch` from `repoRoots()` — the branch is read off `<gitdir>/HEAD` on the walk that already finds the gitdir (`""` on a detached HEAD or outside git; env-relocated repos ask git, as before) — and the page shows them in the footer as the workspace label (`footerLabel()`: `folder · branch`, or `folder + N folders · branch` once folders are added, stepping down through narrower tiers); a click opens the Workspace dialog. `state.wake = true` is set only by a fresh `open --workflow dashboard` and deleted by every resume (server restart, launch, Back to the dashboard); the page also keeps a per-sid `sessionStorage` guard so a reload never replays it.
|
||||
- **`looks.width` is a person-level preference** alongside theme, accent and sounds in `looks.json`. `CARD_WIDTHS` in `public/palette.js` (`narrow` 720, `comfortable` 880 — default — `wide` 1080) is read by the page (`cardWidth()` validates a saved value) and by `routes.mjs`, which paints `data-width` on first load; `styles/tokens.css` maps `data-width` onto the single `--card-width` variable that every column rule uses.
|
||||
- **`GET /overview` is the one route that reads a project file.** It serves `<spec>/overview.md` as `text/markdown` with `cache-control: no-store` (so the Overview tab is always fresh), or `404 { "error": "no overview" }`. A dashboard session honours `?spec=` only when it equals a `dir` in `state.scan.specs`; every other workflow uses `state.specDir` and ignores the query. The root is `state.worktree` (fallback `state.project`), and `readOverview()` resolves and `realpath`s the file and refuses anything outside the root's realpath, so `../`, absolute paths and outward symlinks all 404.
|
||||
- **Month-old sessions are deleted whole.** `open` lists `staleSessions()` (directories matching the session-id pattern whose `state.json` mtime is older than 30 days, never the sid being opened — no exceptions for paused sessions or unread sends) and `staleScratch()` (top-level regular `.json` / `.mjs` files in the console folder older than 30 days, never `looks.json` or `console-dir` — `PROTECTED_CONSOLE_FILES` — never a directory or symlink) before it prints, and removes them after; `removeSessions()` / `removeScratch()` re-check every name against the session-id pattern / the scratch-name rule before deleting — not the age, the skipped sid or the file type, which the `stale*` listing already decided, so never hand them names that did not come from it. `console.md` tells agents to write temporary payload files into the session's own folder so they go with it.
|
||||
- **User Preferences → Cleanup deletes on demand, from a list the server makes.** `POST /cleanup` (origin-checked) with `{ scan: true }` returns `cleanupFindings()`: `{ items: [{ id, where, name, kind, bytes, folder? }], bytes }` (`folder` on `notepad:` items only), ids `session:<sid>` (the `staleSessions()` rule, and every file in the folder that old too, never the serving sid), `console:<name>` (anything at the top of the console home but `PROTECTED_CONSOLE_FILES`, `sessions` and `runtime`, directories too) and `root:<name>` (anything at the top of `~/.plan2code` but `KEPT_PLAN2CODE_ENTRIES`: `console`, `bin`, `launcher.json`, `install.json`, `models.json`, `handoffs`, `notepads`), `notepad:<key>` (a month-old notepad, whole; see Notebook below) and `completed:<name>` (each folder or link directly under the session worktree's `specs--completed/` whose newest mtime is older than the session age, 30 days; loose files there stay; the server passes `project: sessionWorktree() || PROJECT`, and without a `project` the archive is never scanned). Both stray kinds must be untouched for `STRAY_GRACE_MS` (an hour, by the newest `lstat` mtime anywhere inside, since rewriting a file never moves its folder's mtime; unreadable reads as fresh): the same folders hold `workspaces.json.lock` and `writeJsonAtomic()`'s `<file>.<pid>.tmp`, which live for milliseconds. `root:` is only scanned when the console home is `<PLAN2CODE_MODELS_DIR or ~/.plan2code>/console`, so a test or dev home never reaches the real folder. Paths never go to the page. `{ delete: [id] }` runs `removeCleanup()`, which re-scans and removes only ids still on the fresh list (symlinks unlinked, never followed), returning `{ removed, bytes, failed }`. The page always shows the list before **Delete these**.
|
||||
- **The console's path is stated, not searched for.** Each Interface line names `references/web-console/` beside the SKILL.md and the `~/.plan2code/console/console-dir` fallback; the prompts with room (all but pathfinder, plan, document and finalize, which sit near the char limit) also name the canonical global install path `~/.agents/skills/<skill>/references/web-console/` (the skills CLI's real store; every agent dir links into it), and every `console.mjs open` writes `HERE` to `~/.plan2code/console/console-dir` (only `open`, so a `help` or dev run from `src/` never repoints it) so a later session can read the path from a fixed place. Without these the agent hunts the skill install dirs on every session.
|
||||
- **`open` needs no payload, and runs first.** `--file` and `--title` are optional (the title defaults to the folder name). Every skill's Interface line puts `node "<D>/console.mjs" open --workflow <w>` BEFORE reading console.md or the project, and a test (`every skill opens the console before it reads anything`) keeps it that way; a blank session renders a starting screen ("Starting Pathfinder", Planny in flight) until the first post. Every skill replaces the flight with its own animated pose (init — init-update borrows it — pathfinder, plan — revise-plan borrows it — document, implement — implement-review borrows it — finalize, quick-task, review, handoff; only the dashboard keeps the flight), cloned by `startStage()` in `screens/starting.js` from `<template id="start-poses">` in `index.html` and animated under `.pose` in `styles/poses.css`; each `SKILLS` entry's `pose` in `skills.js` is the list (`START_POSES`/`startPose()` in `answers.js` read it), and a test keeps the template in sync with it and every catalog workflow mapped to a pose. The same pose stands above the waiting pane (`.waiting-pane`, agent working with an `activity` and nothing to ask). `posePane()` keeps the pane on screen across renders when the pose is unchanged — `renderMain()` holds any `:scope > [data-pose]` child back from the clear — so the SVG never leaves the DOM, its animations never restart on a state frame, and Planny carries unbroken from launching → starting → waiting. The dashboard's launch hand-off resumes first and reads the launched skill's file after.
|
||||
- **The dashboard scan knows whether the folder is a git repository.** `scanProject()` returns `{ hasAgents, isGit, pending, specs }`; `isGit` comes from `insideGitRepo()`, the same filesystem walk `findRoots()` does (no `git` process, linked worktrees and submodules count, a set `GIT_DIR` / `GIT_WORK_TREE` / `GIT_COMMON_DIR` counts as a repo). The Git card is never greyed, since a clean tree still has branches to switch, pull and push. When `isGit` is `false` the card shows `GIT_INIT_NOTE` ("Not a git repository yet: it offers to start one") as its detail line; a scan with no `isGit` counts as a repo. In a repo, `pending` is `pendingFiles()` in `sessions.mjs`, which calls `countPending()` in `git-repo.mjs`: one bounded `git status --porcelain -z` under `GIT_OPTIONAL_LOCKS=0` (`null` when git cannot say) counting modified, staged, deleted and untracked paths. Above `0` the detail line is `pendingNote(n)` ("3 files to commit"); `0` and `null` show no note. A finish with `commit: true` puts a **Commit it now** button on the finished screen (`commitOffer()`, `renderCommitOffer()`); its `__commit` press makes the agent resume as `git` in the same session and run the commit flow above the board. `open --resume` treats any switch into `git` (this press, or Changelog's "Commit this now?") as a hop, like a dashboard launch: `switchWorkflow()` blanks the page, finish and the last run's `state.git` included, and `draft.json` goes. Without that, the old finish outlived the switch, and the page sat on the old ending above the new questions and the board. A confirm item may carry `files: [{ path, state }]`, drawn as a collapsed table by `filesTable()`. Subagents is **on** by default for the five opted-in skills (`defaultSetting()`); a saved Off stays off.
|
||||
- **The start path is timed, and `open` is built around it.** Measure with `node scripts/bench-web-console.mjs` (`--browser-delay 900` for a real Chrome launch, `--roundtrip` for Send→agent and post→page, `PLAN2CODE_CONSOLE_TRACE=1` on `open` for a step timeline). Four things make it fast, and each is load-bearing:
|
||||
- **No git process.** `repoRoots()` in `sessions.mjs` finds the common dir and worktree top by walking to `.git` (following `gitdir:` and `commondir` files) — each `git rev-parse` cost 150ms+ on Windows. It asks git only when `GIT_DIR`/`GIT_WORK_TREE`/`GIT_COMMON_DIR` relocate the repo, and uses the native realpath so an 8.3 short name keys the same project git would.
|
||||
- **The socket handover.** `open` spawns the server first, then binds the loopback port itself (the first `listen()` blocks ~50ms on Windows, overlapped with the server's boot), launches the browser on that URL immediately (Chrome via `start` takes ~900ms to its first request, the longest step of all), and hands the listening socket to the server over IPC (`bindLoopback()`/`handOff()` in `sessions.mjs`, `--handoff` in `server.mjs`). Requests queue in the socket until the server takes it; one `open` already accepted is passed across as a socket and acknowledged (`conn-held`) before the channel is closed. No channel, or no socket within 3s, and the server binds its own port; `open` then opens the real URL.
|
||||
- **The first paint needs no fetch.** `routes.mjs` (`renderIndex()`) renders `index.html` with the session's title, badge and saved theme (`data-theme`, `data-looks-accent`, matched by accent rules generated from `palette.js` and appended to the joined stylesheet by `static.mjs`) and the whole first state as an inline `<script type="application/json" id="boot">` (every `<` escaped; data blocks are not executed, so the CSP is unchanged). `modulepreload` hints fetch every module in parallel, the page draws in the same task as the script runs, and `/events?have=<key>` skips the opening frame when the page already holds that exact state. The chimes load on first use, not at start-up.
|
||||
- **Reads are stat-gated.** `fileStamp()` (mtime:size:ino) decides whether `state.json`, `result.json` and `looks.json` changed before anything reads or parses them — per request, per heartbeat and in the 1s poll; the parsed state is cached (`readState()` returns it; `/submit` clones before editing). `wait` stats `result.json` every 50ms instead of parsing it every 400ms. Static assets are held in memory for the server's life and revalidate by ETag.
|
||||
- **The Workspace and the session meter live beside `state.json`, one writer each, and outlive every hop.** Three session files, none of which `switchWorkflow()` ever touches, so both survive dashboard → skill → dashboard (a new console session starts with a count of 0, and with the folders remembered for its folder and spec, below):
|
||||
|
||||
| File | Writer | Holds |
|
||||
|---|---|---|
|
||||
| `workspace.json` | the server (`workspace.mjs`) | the folders (`id`, `path`, `name`, `description`, `original`, `nested`), `version`, the `changes` log, `missing` ids, and `remote` (`remoteWarning()` in `sessions.mjs`, computed by the server at boot) |
|
||||
| `ledger.ndjson` | `console.mjs` | append-only, one JSON line per entry. Meter events: `launch` (every fresh `open` and every resume into another workflow), `run` (a post's `run`, id scoped by launch, with `tasks` when a built phase reports one) and `answer` (one per item the person answered in a collected send, written by `ledgerAnswers()`, id `<launch>:answer:<send stamp>:<item>`). Also `folder-issue` reports |
|
||||
| `workspace-cursor.json` | `console.mjs` | the last workspace `version` handed to the agent; advanced after the print, never backwards |
|
||||
|
||||
The page changes the workspace only through five routes: `GET /workspace` (`?check=1` re-stats every folder first), `POST /workspace/add` (path resolved against `state.worktree`, `~` expanded, case-insensitive duplicate check on win32/darwin; `not-a-folder`, `duplicate`, `bad-name`, `name-taken` + `suggest`), `POST /workspace/edit`, `POST /workspace/remove` (the original folder refuses) and `POST /workspace/browse` (one picker at a time, 409 `busy`; 404 `no-picker` when `remote` is set or no picker exists; `PLAN2CODE_PICKER_ECHO` stands in for the dialog in tests). `stateFrame()` carries `workspace` (folders, `missing`, `remote`, the current launch's folder `issues`) and `meter` (`meterView()` over the ledger), and both files are on the 1s poll; it also carries an optional `update` once the boot-time release check (`update-check.mjs`) finds a newer release. The agent hears of the workspace through `open` output (`workspace: { folders, missing? }`, which also seeds the cursor) and then each change once, as `workspace: [...]` plus `Workspace: …` reply lines on `wait` exit 0 or `chat`; a change alone never ends a `wait` slice (`pendingWorkspace` on exit 10). `post` and `open --file` lift `run` and `folderIssue` out of the patch into the ledger, never into `state.json`; an unknown event or a malformed issue is exit 3. **Remembered workspaces.** `workspace.mjs` keeps `~/.plan2code/console/workspaces.json` (`WORKSPACES_FILE`, under `PLAN2CODE_CONSOLE_HOME` in tests): `projects[<case-folded worktree>] = { path, project, specs: { "specs/<name>": … } }`, each entry `{ original: { name, description }, folders: [{ path, name, description, nested? }], at }`. `rememberedWorkspace()` answers spec, else project, else nothing; `initialWorkspace(worktree, entry)` builds from it, both in the server's first `workspaceNow()` and in `open`'s read-only `workspaceOnOpen()`, so they agree. `workspace.json` carries `scope` (the spec key or `""`). Every user change (`bumpWorkspace`, not `missing`/`found`) calls `rememberWorkspace()`. `setScope()` swaps the list, logging `removed`/`added`/`renamed`/`described` changes so the cursor stays truthful; `POST /workspace/scope { spec }` (the dashboard picker, on selection and before a launch) seeds an unsaved spec from the project's list, and `followSpecDir()` (state poll, boot) moves the scope to a posted `specDir`, saving the current list as an unsaved spec's. Two writers, each a read-modify-write of one key: the server and `console.mjs forget --spec` (Finalize Step 6). The contract is in `console-workspace.md` and `console-meter.md`, and `building.md` (per-phase `run`), so the skill prompts stay unchanged.
|
||||
- **The Subagents switch is a standing instruction, injected only on change.** The page's icon button (`#btn-subagents`, after Write a brief) and `#subagents-modal` show only when the frame's `subagents` block says `offered && supported`. `offered` comes from `public/subagents.js`; `supported` means the latest `{ "type": "open" }` line in `events.ndjson` carries `caps: ["subagents"]` (`latestOpenCaps()`), so an older skill copy's `open` hides the button. Four places hold it, one writer each:
|
||||
|
||||
| File | Writer | Holds |
|
||||
|---|---|---|
|
||||
| `~/.plan2code/console/subagents.json` | `server.mjs` | per project folder → workflow: `{ on, instruction, max }`, `instruction: null` being the shipped default; on `PROTECTED_CONSOLE_FILES` |
|
||||
| `<session>/subagents-setting.json` | the server (`settings.mjs`) | `{ workflow, on, instruction, max, revision }`: synced from the store at boot and on any workflow change (`serverSubagents().sync` in `settings.mjs`), `revision` bumped only by a real change |
|
||||
| `<session>/subagents-cursor.json` | `console.mjs` | `{ revision, state }`, the last block handed over; `open` resets it, and it moves only after the print |
|
||||
| `state.json` → `helpers` | `console.mjs post` | the helpers the agent reports, merged by `id`, checked by `checkHelpers()` plus the prose scan; dropped by `switchWorkflow()` on a dashboard hop |
|
||||
|
||||
`POST /subagents` (origin-checked; `400` `not-offered` / `bad` / `too-long` / `max`) saves the store and bumps the session setting. `consume()`, `cmdChat()`, `deliverChat()` and `open` append `blockFor()`'s lines last in `reply` and the `subagents` field; a change alone never ends a `wait` slice. The page's Subagents tab (before Ask) draws `state.helpers` through `helperRows()`. Helpers never reach the meter ledger. Contract: `console-subagents.md`.
|
||||
- **The filesystem is the transport.** Sessions live in `~/.plan2code/console/sessions/<sid>/`, deliberately not under `specs/`, so the console cannot trip the metrics scraper or the loop's marker parser, and survives `git clean`. A result written after the agent dies is picked up by the next session.
|
||||
- **Attachments on notes and quick questions live in `<sid>/uploads/`**, never in the project: images as `<uuid>.jpg`, documents as `<uuid>.<ext>` with `ext` from `DOC_TYPES` in `answers.js` (text, code, PDF). The browser re-encodes images to JPEG and sends raw bytes to `POST /upload` as `image/jpeg`; documents go as-is as `application/octet-stream`, the extension taken by `docExt()` from the uncut `x-p2c-name`. `readRaw(req, limit, cb)` in `routes.mjs` caps images at `MAX_BODY` (4 MB) and documents at `MAX_DOC_BYTES` (10 MB), and drains rather than destroys so the client gets its 413. Images need the `FF D8 FF` magic; documents pass `checkDocument()` in `sessions.mjs` (`%PDF-` for PDF, strict UTF-8 with no NUL for text), else 415. The server names the file with `crypto.randomUUID()`. `GET /uploads/<id>.<ext>` serves images as `image/jpeg` and documents under a fixed type (`application/pdf`, else `text/plain`) with `nosniff` and, on text, CSP `sandbox` (a sandboxed PDF cannot open in the viewer), so a browser can show but never run one; `recordSubmitted()` writes every send's note onto its item as `sentNote { at, text, images, files }` (paths and names only), which `noteAwaiting()` in `answers.js` turns into the Sent box's attachment links and the Notes pane's pending note until the agent's next thread message; `DELETE /uploads/<id>.<ext>` takes any allowed extension; both stay contained under `uploads/`. `isOwnUpload()` returns the kind (`"image"` / `"file"` / `false`), and `attachmentsOk()` makes `/submit` comments and `/chat` messages carry images only in `images[]` and documents only in `files[]`, this session's uploads only, at most 5 together (`MAX_ATTACHMENTS`). A comment's `reply` gains one ` Image: <path> (<name>)` or ` File: <path> (<name>)` line per attachment, in attach order; a chat entry's lines come from `chatReplyLines()`, its images first, then its files. `sweepUploads()` bounds disk growth, and the session sweep removes the whole session a month after that. A note attachment a spec file cites is copied out first by `console.mjs keep` (`--session --upload --name --spec [--from]`): it checks both paths (the upload must sit under the session's `uploads/`, and the spec folder under `state.project`, real paths included, so a symlinked folder cannot carry the copy outside), copies with `COPYFILE_EXCL` and reuses an existing copy, prints `{ ok, path, link, image, reused }` with a forward-slash link relative to `--from`, and logs a `keep` event. It is the agent's hand, not the server's: it runs in the agent's shell only when the agent decides to cite a file, so the server still never writes into a project.
|
||||
- **Answers carry their terminal token.** Each item ships `fallbackText` and `token`, so a click resolves to the literal word the prompt already expects (`approved`, `a`, `skip`). No workflow needs a second code path, and declining the console degrades to prose with nothing lost.
|
||||
- **A build tells the page how long silence is normal.** The page calls a working agent stuck after two minutes without a post, which is right for a conversation and wrong for a twenty-minute build task. `agent.quietMinutes` (1 to 60, counted only while `working`) stretches the stuck, adrift and Send-grace thresholds; `quietLimitMs()` in `answers.js` is the one rule.
|
||||
- **A finished quick task's review button is a request through the wait loop**, like the brief: `{ "i": "__review" }` or `{ "i": "__done" }`. The agent keeps waiting after posting a finish that carries `review`, and takes the review up by posting `"finish": null`, which puts the session back to work. Implementation's review needs no such machinery: it is a verdict on the sign-off card, asked before approval, so the session never left work to take it up.
|
||||
- **Back to the dashboard is the same kind of post-finish request.** A finish with `finish.dashboard: true` shows the button; a press arrives as `{ "i": "__dashboard", "type": "dashboard" }`, and the agent runs `open --resume <sid> --no-open --workflow dashboard` then posts `"finish": null` with a fresh `menu`. The agent waits ~10 minutes after the finish for it (alongside `__review` / `__done` on a quick task); after that the page swaps the button for the `/plan2code` command. `finish.command` is optional — without one the page shows the "All done" line — and `validate()` rejects a `<placeholder>` command and a non-boolean `dashboard`. The session-level actions are therefore `__brief`, `__stop`, `__launch`, `__review`, `__done` and `__dashboard`; a new post-finish button should copy this precedent.
|
||||
- **Continue here, Update CHANGELOG first and Ask prompt blocks.** Three small additions on the same pattern. **Continue here** is page-only: `continueOffer(fin)` (`public/answers.js`) reads `finish.command`, and when it starts with a Plan2Code skill (and the finish is not a pause) `screens/ending.js` draws a button beside the Next step block, hidden when the session meter is red; the press is the dashboard's own `{ "i": "__launch", ... }` through `sendAfterBuild("launch", offer)`, so the agent writes nothing new (`startsClean()` cleans the page for the hop, except out of Git and into Review; a same-skill next step keeps the workflow, so the agent posts `"finish": null`). **Update CHANGELOG first** is `finish.changelog: true`, accepted by `validate()` only on `quick-task` and `finalize` (a paused finish is exempt from that check and the page ignores the flag), and it belongs with `commit: true`; the press is `__changelog`, a `HOP_ACTIONS` entry in `cmd-post-wait.mjs` that resumes as `changelog`, whose "Commit this now?" yes carries on to Git. **Ask prompt blocks** are contract only (`console-chat.md` → Prompts to carry away): the page already draws a Copy button on every fenced block.
|
||||
- **`__dashboard` also arrives mid-workflow.** A left-pointing triangle (`#btn-home`, filled with `--accent`) sits left of Stop session on every non-dashboard page. Its state comes from the pure `homeButtonState()` in `answers.js`: hidden on the dashboard, on a finish and during a stop, and otherwise gated by the same `turnGate()` Stop now uses (the person's turn, unless the agent has gone adrift). The confirm (`#home-modal`) reuses `stopWarning()`, and the submit carries the staged answers plus `__dashboard`, with `HOME_REPLY`. With no finish on the page, the agent treats it as a stop that lands on the menu: it saves its place as for `__stop`, then resumes as the dashboard with `"finish": null` + `menu`, with no finish and no stop in between (console-stop.md → "Back to the dashboard, mid-workflow"; building.md for builds). `local.homeward` drives Planny's "Saving your place and opening the dashboard…" line until the through-the-dashboard reset clears it.
|
||||
- **Handoffs live outside every repo, in `~/.plan2code/handoffs/`, and the console owns them** (`handoffs.mjs`; the console ships in every skill, so the Stop flow, the Handoff skill and the dashboard all reach it through `console.mjs`). `handoff new --workflow <w> --skill <s> [--spec specs/<x>] [--title <t>] [--from-stop]` claims one for this checkout and prints `{ ok, id, path, meta }` (exit 2 bad usage, 3 a bad value). Off the dashboard the Stop modal offers **Stop with a handoff** (`#stop-handoff`, suggested) above **Just stop and save** (`#stop-go`); the first sends `__stop` with `handoff: true` and `STOP_HANDOFF_REPLY`, and `wait` adds `handoffSkill` (the built Handoff skill's `SKILL.md`, `handoffFor()`); console-stop.md gives the order (answers, save, `handoff new --from-stop`, write, paused finish naming the file, `stop`). On a dashboard, `cmdOpen()` adds `scan.handoffs` (`listHandoffs(worktree)`) and `scan.handoffsDir` after `scanProject()`, which stays handoff-free because `specs.mjs list` shares it. The picker draws them as dashed `.spec-chip.is-handoff` chips after the specs (`specSel = "handoff:<id>"`); a picked one replaces the skill cards with `renderHandoffPreview()`: **Pick it up here**, **Read it all** (`GET /handoff?id=`, served only for an id in the dashboard's own `state.scan.handoffs`), **Copy for a new conversation** (`handoffCopyText()`) and **Delete** (`openHandoffDelete()`, one step). Pick it up sends `{ "i": "__pickup", "type": "pickup", "handoff": <id> }`; `HOP_ACTIONS.pickup` (`pickupHop()`) reads the stored `.json` only, never the page, and falls back to Quick Task with `fallback: true` when the record, its skill or its spec is gone, or the Handoff skill wrote it (resuming that skill would only write another handoff); `markPickedUp()` stamps `usedAt` as the hop is printed, so the next scan drops the chip. Delete sends `__delete` with `handoff` in place of `spec`, and the agent runs `delete-handoff --handoff <id>` (`removeHandoff()`, exit 3 on a refusal, nothing touched). `open` sweeps handoffs untouched for 30 days (`staleHandoffs()`, the `.json`'s mtime, else the `.md`'s), picked up or not, and reports them in `swept.handoffs`; Cleanup never lists the folder (`KEPT_PLAN2CODE_ENTRIES`).
|
||||
- **Notebook: the person's, one per folder, in `~/.plan2code/notepads/`, in named tabs, and never the agent's.** `notepads.mjs` is the store's one owner (`PLAN2CODE_NOTEPADS_DIR` moves it for tests). The folder is the session's worktree, else its project (`notepadRoot()` in `routes.mjs`), keyed `<folder-name>-<12 hex>` by `notepadKey()` (the hash over `foldKey()`, so case-only path differences match on Windows and macOS, and two worktrees get two notepads). **Layout:** `meta.json` (`{ v: 2, folder, created }`), `tabs.json` (`{ v: 1, order: [id], last, tabs: { id: { name, created } } }`, the index and the only place order and the last tab live) and, per tab, `tabs/<id>/note.md` with `tabs/<id>/images/<uuid>.jpg` and `<uuid>.thumb.jpg`; a tab id is 12 hex. Every write takes the folder's `notepad.lock`; a read never creates a file, so only the person's edits age a notepad. A delete removes the tab from the index first, then its folder, and the next write sweeps away a tab folder the index no longer names (a delete that crashed half way). **Migration:** the first shape (`v: 1`, one `note.md` and `images/` at the top) reads as one virtual tab, Notes, with the fixed id `LEGACY_TAB_ID`, and a read writes nothing; the first write moves the files into `tabs/<LEGACY_TAB_ID>/` and writes `tabs.json` last, so a crash in the middle is finished by the next write and never loses a file. A `tabs.json` that does not hold up is set aside as `tabs.json.corrupt` and rebuilt from the tab folders. **Routes:** eleven, placed after `/upload` in `ROUTES` (the shape test pins the order): `GET /notepad[?tab=<id>]` (`{ tabs, last, tab: { id, text, savedAt, images } }`, with the tab's `text`, `savedAt` and `images` repeated at the top), `POST /notepad/text?tab=` (`{ text }`, 1 MB, 413 `too-long`), `POST /notepad/image?tab=` and `POST /notepad/thumb?id=<uuid>&tab=` (raw `image/jpeg` the page re-encoded with `reencode()`, 4 MB, 200 pictures per tab: 415 `not-jpeg`, 413 `too-large`, 409 `too-many`), `POST /notepad/image/delete?tab=` (`{ id }`), `POST /notepad/tab` (`{ name }`), `/notepad/tab/rename` (`{ id, name }`), `/notepad/tab/delete` (`{ id }`), `/notepad/tab/order` (`{ order }`, every id once) and `/notepad/tab/last` (`{ id }`), and `GET /notepad/images/<tab>/<uuid>[.thumb].jpg` (matched on the raw request line like `/uploads/`, served through `imagePath()`'s realpath containment, `no-store`). A text or picture request with no `?tab` means the last tab used (and makes Notes when there is none), so an unchanged client keeps working. The ten POSTs are origin-checked, and every refusal is a `NotepadError` turned into `{ error }` (`bad-name`, `duplicate-name`, `too-many-tabs`, `no-such-tab` beside the picture and text codes). None of them writes to the session folder or `events.ndjson`, and `console.mjs` never imports `notepads.mjs`, so nothing in a notepad reaches `state.json` or anything `wait` prints. **The editor, and the CSP.** CodeMirror 6 replaced OverType 2.6.1 after a spike (typing at 200 KB measured about 24 ms a key against about 99 ms, and real heading sizes): `public/vendor/codemirror.esm.js` is one minified file (about 500 KB) made by the dev-only `scripts/vendor-codemirror.mjs` from `scripts/vendor-codemirror-lock.json`, never installed in the repo, and loaded by a dynamic import only when the Notebook first opens. CodeMirror writes its rules as a `<style>` element, which `style-src 'self'` refuses, so the editor lives in the open shadow root of `.notepad-cm-host` where it adopts them as a constructed stylesheet, and its own look is `public/notepad-editor.css`, a `<link>` inside the root. Custom properties inherit across the boundary, so both themes work; page tests reach the editor with Playwright's CSS locators (they pierce open shadow roots) and read its text from `EditorView.findFromDOM()`, since lines the cursor is not on draw without their Markdown marks. CodeMirror's own rules win a tie in specificity (they are adopted after the linked sheet), so `notepad-editor.css` writes `div.cm-editor .cm-scroller` for the few it overrides. `scripts/test-web-console-page-notepad.mjs` fails on any `securitypolicyviolation` with the notepad open. **Upgrading CodeMirror:** change a version in `scripts/vendor-codemirror.mjs`, run `node scripts/vendor-codemirror.mjs --update-lock` (npm and network; it installs in a temp folder), update the sha256 in the files-table row, then run the two notepad test files. **Tabs on the page:** `screens/notepad.js` binds every save and picture to the tab it was made in (a switch waits for the save, and stays put when it cannot), `public/notepad-tabs.js` draws the bar, and `public/notepad.js` holds the name, order and delete rules as pure code. **Cleanup.** No sweep at `open` touches a notepad, and `notepads` is in `KEPT_PLAN2CODE_ENTRIES`, so the folder is never a stray. `cleanupFindings()` lists a notepad as one `notepad:<key>` item (with `folder` from `meta.json`, labelled "Notebook for <folder>"Line truncated
|
||||
- **A Bug fixed spec deletes in one step.** Its chip shows a visible **Delete** (`.spec-chip-del-label`) instead of the hover ✕, `openDeleteConfirm()` gives it a fixed-bug warning and a **Delete it** button, and `deleteStep()` sends `__delete` on the first press, with no name to type. `chipDetail()` drops the scan's repeated "bug fixed" detail under the label.
|
||||
- **The Quick question chat is a second, append-only channel beside the card slot.** The page's **Ask** tab (always last, every workflow, still there after a finish) posts to `POST /chat` (a message, or `{ reset: true }` for New conversation) and `POST /chat/decision` (Approve / Decline on an edit the agent proposed). The server is the only writer of `<sid>/chat.ndjson` (one JSON line per `message` / `decision` / `reset`, each with a `seq`; `appendChat()` in `inbox.mjs`); `console.mjs` is the only writer of `<sid>/chat-cursor.json` (the last seq handed over, advanced only after printing) and of the agent's replies in `state.json` → `chat.replies` (merged by `id`, checked by `validateChat()`: real `re`, proposal paths outside the running `specs/<idea>/`). The server never writes chat into `state.json` — `post` read-modify-writes it under `withStateLock()` — and `stateFrame()` merges inbox and replies into the frame's `chat` block (`conversation`, `messages`, `typed`, `limit`, `offline`) in memory. `/chat` never checks `pendingResult()`, so neither channel can block the other. `wait` keeps its exit codes 0/10/20/30: exit 0 gains `chat` (or is `type: "chat"` with no actions), and the instant `console.mjs chat` answers 0/10/20 without touching `result.json`, which builds run after every task. Guards: 10 typed messages per conversation (`409 limit`), 4,000 characters (`400 too-long`), own uploads only, of the right kind (`400 image`, `400 file`), `409 offline` when `chatOffline()` says no agent is there, `409 stale` for an old conversation. A hop through the dashboard (checked on every state change and at server start, so a restart still sees it) appends a `reset` and starts a new conversation. A lone reset never ends a `wait` slice (`deliverableChat()`); it rides along with the next message.
|
||||
- **`validate()` in `patches.mjs` enforces four workflow rules mechanically**: max three open required questions, no internal vocabulary in a title, one recommended option, and no loop markers or metrics-scraper bait.
|
||||
- **The palette is written twice for dark, and that duplication is the mechanism.** `@media (prefers-color-scheme: dark) :root:not([data-theme="light"])` follows the system; `:root[data-theme="dark"]` is the explicit choice from the colors panel. Drop the `:not()` and a system-dark browser overrides someone who asked for light. A chosen accent is applied as an inline custom property on `:root` (CSSOM, which the CSP allows), and the default is applied by REMOVING that override so the stylesheet's own per-theme values win. The server's `data-looks-accent` stand-in only lasts until `applyLooks()` runs, which removes it first thing — left on, its rule would beat "Back to default".
|
||||
- **Help is in the page, built on first open.** The **?** button (`#btn-about`) opens `<dialog id="help-modal">`, which replaced the old "What this page is" About dialog. Its 18 panels and their icon sheet are hand-written HTML and SVG in `<template id="help-content">` in `index.html` (after `#start-poses`), cloned into `#help-panels` the first time **?** is pressed (except the dashboard topic's card list: `buildHelp()` fills its `.help-cards` from `SKILL_CATALOG` and `CATALOG_GROUPS` at that moment, in the dashboard's order), so first load builds nothing and Help still reads fully once the server is gone. `help.js` supplies the tab list and rules, `screens/help-dialog.js` the wiring (tab buttons, roving focus, `renderAbout()` for the live connection line on tab 1, `lightDismiss()`, and a Ctrl/⌘+Enter guard scoped to this dialog). SVG is styled by class and CSS variables only — a `style=` attribute is dropped by the CSP, and a test fails on one — and every number the prose quotes sits in a `data-fact` span a test checks against the constant it comes from.
|
||||
- **Stuck sessions are explained twice, in Help and on the status line.** `stuck` ("When something looks stuck") is the second tab in `HELP_TABS`; its panel opens with a `help-callout` ("Check this first": Plan2Code often waits for a permission in the terminal, which the page cannot see) and four You see / Likely cause / Do this rows before the diagram. The quiet and Not running status lines carry a "What to check" button (`openHelpOn("stuck")`) inside the existing `role="status"` element, so it exists only while the symptom shows. Every finished and paused screen gets a "Before you close this" panel from `renderCloseGuide()` in `renderHandoff()` (Safe to close, Start fresh, Carry on). Tests in `scripts/test-web-console-source.mjs` check the tab order, the callout and rows, and the `renderCloseGuide` call.
|
||||
- **Markdown is rendered to DOM nodes, never to an HTML string** (`public/render.js`), so agent-authored text that quotes a hostile source cannot execute. Only `marked.lexer()` is used.
|
||||
|
||||
Tests: `npm test` runs, in order, `validate-char-count.js`, `install.js --build-skills`, `parse-check.mjs`, `check-skill-table.mjs`, then one `node --test` over the skill-script tests (`test-skill-scripts.mjs`, `test-script-*.mjs`, `test-git-repo.mjs`), `test-launcher.mjs`, `test-getting-started.mjs` and the web console's `test-web-console-*.mjs`, so they run in parallel, one process each. The console tests are split by area (`-session`, `-lifecycle`, `-logic`, `-server`, `-chat`, `-chat-stress`, `-workspace`, `-subagents`, `-concurrency`, `-source`, `-git`, `-qa`, `-speed`, `-hardening`). Their shared setup is `scripts/web-console-test-helpers.mjs`: importing it gives the file its own console home (so `workspaces.json`, `subagents.json`, `looks.json` and sessions never collide across files) and registers the `stop --all` cleanup. `-session` and `-lifecycle` each run an ordered chain of tests on one session of their own; everything else opens a session per test. A new test goes in the file for its area, after the tests it depends on. The parse check exists because `node --check` parses a `.js` file as a CommonJS script and has already let a browser-fatal string literal through; it imports each shipped module as a real ES module instead. They live in `scripts/`, not `src/web-console/`, because everything under the latter ships into every skill.
|
||||
|
||||
**Adding a file under `public/`:** a page module needs `SERVABLE` in `static.mjs` and a `<link rel="modulepreload">` in `index.html`. The set is hardcoded rather than a directory lookup so there is nothing to traverse; a module missing from it 404s and the page dies at import with no useful error (the import-fetch test fetches every import and fails naming the file). A module missing its preload still works, but loads serially after `app.js` and slows the first paint. A screen goes in `public/screens/`, imports only `state.js` and the pure modules (never another screen), and is imported by `screens/core.js`; the import guard in `scripts/test-web-console-shape.mjs` fails naming a screen that breaks either rule. A stylesheet goes in `public/styles/` and on `CSS_ORDER` in `static.mjs`, never on `SERVABLE`; the joined-stylesheet test fails when the folder and the list disagree. Every new file also needs its row in the files table above, which the docs-table test (same file) checks.
|
||||
|
||||
## Status Line
|
||||
|
||||
Optional Claude Code status bar living in `src/statusline-claude/`. Three-line bar (icon + content per line) showing model, project, branch, uncommitted diff stats, session duration + cost, context window usage, and plan/quota usage.
|
||||
Optional Claude Code status bar living in `src/statusline-claude/`. Three-line bar beside a Planny icon: two content lines with a dashed rule between, showing model (+ effort), project/worktree, branch, uncommitted diff stats, session duration + cost, context window usage, and plan/quota usage.
|
||||
|
||||
**Design constraints:**
|
||||
- **Zero runtime dependencies** — `statusline.js` is self-contained (config loader, git helpers, formatters, render). Copied verbatim to `~/.claude/plan2code-statusline.js` on install; no bundler step.
|
||||
- **Stdin-driven** — all data comes from Claude Code's stdin JSON (`model`, `workspace`, `context_window`, `rate_limits`, `cost`). No API calls, no auth, no background processes.
|
||||
- **Silent failure** — outer `try/catch` around `main()` plus `process.exit(0)` on missing stdin guarantees the script never crashes the CLI. All git ops are timeout-bounded (1.5s) and non-git workspaces short-circuit via `fs.existsSync('.git')`.
|
||||
- **Silent failure** — outer `try/catch` around `main()` plus `process.exit(0)` on missing stdin guarantees the script never crashes the CLI. All git ops are timeout-bounded (1.5s) and non-git workspaces short-circuit via `isGitRepo()` (walks up to 10 parent dirs looking for `.git`).
|
||||
- **Atomic settings writes** — installer writes `~/.claude/settings.json` via temp file + rename so a crash never leaves the file truncated.
|
||||
- **Custom-config respect** — installer detects non-plan2code `statusLine` entries, prompts before replacing, and backs up to `statusline-previous.json`. Uninstall only removes `settings.statusLine` if it points to the plan2code bundle.
|
||||
|
||||
@@ -131,4 +357,36 @@ src/statusline-claude/
|
||||
|
||||
**Adaptive plan-usage display:** the formatter auto-selects between `5h/7d` rate-limit percentages (Pro/Max/Teams — when `rate_limits` present in stdin) and `Nk in · Nk out` session-token counts (Bedrock/Vertex/PAYG — when `rate_limits` absent). Segment is hidden when neither shape is available.
|
||||
|
||||
**Installer integration** lives in `install.js` under the `STATUS LINE INSTALLATION` section (`installStatusLine`, `uninstallStatusLine`). Included in `A` (Install All + dev tools); also available individually via Custom → `S`.
|
||||
**Installer integration** lives in `install.js` under the `STATUS LINE INSTALLATION` section (`installStatusLine`, `uninstallStatusLine`). Included in Advanced → `E` (Everything); also available individually via Advanced → `S`.
|
||||
|
||||
## Global `plan2code` Command
|
||||
|
||||
Typing `plan2code` in any directory opens the dashboard skill against the current project, **in that directory**, in one of three CLIs (the `CLIS` table in the launcher):
|
||||
|
||||
| CLI | Runs |
|
||||
| --- | --- |
|
||||
| Claude Code | `claude /plan2code --permission-mode bypassPermissions [args]` |
|
||||
| Devin | `devin --permission-mode bypass [args] -- /plan2code` |
|
||||
| Codex | `codex --dangerously-bypass-approvals-and-sandbox [args] $plan2code` (Codex starts a skill with `$name`; the launch line follows Codex's documentation) |
|
||||
|
||||
On a terminal it first prints a Planny banner (`renderBanner()`). With more than one on `PATH` it asks `Plan2Code opens inside an AI coding agent. Pick which one to use:` as a numbered menu, the last pick pre-selected and marked `(last used)` (Enter keeps it; a number or a CLI id also works); with one installed it uses that without asking, printing `Opening with <CLI>…` (as does a `--cli` pick); with none it exits 127 and prints `SKILL_STEPS`: how to install an agent, `cd` into the project, and type `/plan2code` (`$plan2code` in Codex). An uninstalled `--cli` pick prints that CLI's own steps after its error (its install command, `cd` into the project, then `plan2code --cli <id>` or its prompt). `--cli claude` / `devin` / `codex` (or `--cli=<name>`) skips the menu and is never forwarded; an unknown name exits 2, an uninstalled one 127. The pick is saved as `lastCli` in `~/.plan2code/launcher.json`, merged beside `lastFolder`. Before spawning, unless the forwarded args carry `--model` / `--model=` (or, for Codex, `-m`), it asks `Which model should <CLI> use?` from `models.json` plus the user's additions, Enter keeping the model the CLI last used — Ctrl+C at any launcher prompt exits 130. With no TTY on stdin there is no menu (last pick, else the first installed) and no model question: it prints that the CLI will use the model last used in it (switch it in that CLI on its own, or pass `--model <name>`). Headings, numbers, defaults, retry lines and the `plan2code:` error prefixes are colored with `paint()` (the escape values of `install.js`'s `COLORS`, copied), stdout only when stdout is a TTY and stderr only when stderr is, and never when `NO_COLOR` is set; piped runs print plain text and no banner. Other arguments are forwarded to the CLI (`plan2code --model opus`), and its exit code is passed back. `plan2code update` is the one subcommand: it is never forwarded and opens no agent, it runs `npx --yes --allow-git=all git+https://github.com/jparkerweb/plan2code.git --update`, so `install.js --update` reinstalls what `~/.plan2code/install.json` lists. On every other start, before spawning the CLI, it prints one line when a newer release is out (`Plan2Code v<latest> is out (you have v<installed>). Run: plan2code update`), compared against `~/.plan2code/bin/version.json` and read from the console's cached release check (`~/.plan2code/console/update-check.json`); it never waits on the network, and when the cache is missing or stale it refreshes it in a detached background process so the next start knows. Tests: `scripts/test-launcher.mjs` (run by `npm test`) spawns the launcher against stand-in `claude`/`devin`/`codex` commands and a temp home.
|
||||
|
||||
**Design constraints:**
|
||||
- **Stable copy, not the package dir** — the installer normally runs from an npx cache directory npm may delete, so `installLauncher()` copies `src/launcher/plan2code.js` to `~/.plan2code/bin/plan2code.js` and the shims point there. Beside it go `update-check.mjs` (the web console's release check, for the terminal notice) and a `version.json` (the installed version). (The loop/metrics/bot wrappers point into `__dirname` and don't have this protection.)
|
||||
- **npm-style shims** — written into npm's global bin (`npm config get prefix`; `<prefix>/bin` off Windows): an sh shim everywhere, plus `.cmd` and `.ps1` on Windows, so cmd.exe, PowerShell and Git Bash all resolve it. On macOS/Linux, when the npm bin isn't writable (system Node), it falls back to `~/.local/bin`.
|
||||
- **Marker-based ownership** — every shim contains `plan2code-launcher`; `uninstallLauncher()` removes only files carrying it, leaving any other `plan2code` bin alone.
|
||||
- **Resolving the CLI** — the launcher walks `PATH` (+ `PATHEXT` on Windows) itself. An `.exe` is spawned directly; a `.cmd`/`.bat` wrapper goes through `cmd.exe /d /s /c` with quoted args, since Node refuses to spawn batch files without a shell. The installer warns only when neither `claude` nor `devin` is on `PATH`.
|
||||
- **No bin-name overlap** — the installer's own bin in `package.json` is `plan2code-install` (→ `install.js`), so `plan2code` belongs to the launcher alone. npx runs a package's only bin whatever it's named, so the README's `npx … plan2code.git` command is unaffected; keep it the only bin, or npx will need `-c plan2code-install`.
|
||||
- **`--pick-folder` is shortcut-only** — the launcher strips it before building the CLI's args. The shortcut runs the CLI menu, then the folder picker, then the model menu. With it, a native folder picker chooses the cwd instead: on Windows, the Explorer-style `IFileOpenDialog` (`FOS_PICKFOLDERS`) via `powershell -STA -EncodedCommand`, its C# interop (`WINDOWS_PICKER_SOURCE`) passed in an env var and compiled with `Add-Type` (~0.5s), with a TopMost owner form so it doesn't open behind the console — Windows PowerShell's `FolderBrowserDialog` is the old tree-only dialog, and is kept only as the fallback when `Add-Type` is blocked (Constrained Language Mode, AppLocker); `osascript choose folder` on macOS, and `zenity` then `kdialog` on Linux (only when `DISPLAY`/`WAYLAND_DISPLAY` is set). If there's no picker, or the picker fails, it falls back to a typed `Project folder [last]:` prompt. A picker that exits 0/1 with nothing printed means the person cancelled, so the launcher exits 0. The picker starts on the last pick, stored in `~/.plan2code/launcher.json`. From the shortcut, a non-zero exit other than Ctrl+C (130 / `0xC000013A`) waits for Enter so the error doesn't vanish with the window. Typed in a terminal, `plan2code` behaves exactly as before.
|
||||
|
||||
**Desktop shortcut** — after the shims are written, `installLauncher()` (now async) calls `offerDesktopShortcut()`. It asks `Also add a Plan2Code shortcut to your desktop? (y/N)`, skips the question when stdin isn't a TTY, and refreshes an existing marked shortcut without asking. `installDesktopShortcut()` writes it to the real desktop (`[Environment]::GetFolderPath('Desktop')` on Windows, which covers OneDrive redirection; `xdg-user-dir DESKTOP` on Linux; `~/Desktop` otherwise):
|
||||
|
||||
| OS | File | Runs |
|
||||
| --- | --- | --- |
|
||||
| Windows | `Plan2Code.lnk` (written by `WScript.Shell`) | `pwsh.exe` (else Windows PowerShell) `-NoLogo -ExecutionPolicy Bypass -File "<bin>\plan2code.ps1" --pick-folder`, icon `src/launcher/plan2code.ico` (the web console's Peek-a-boo favicon, 16–256 px) copied to `~/.plan2code/bin/plan2code.ico` |
|
||||
| macOS | `Plan2Code.command` (0755) | `exec "<bin>/plan2code" --pick-folder` in Terminal |
|
||||
| Linux | `plan2code.desktop` (0755, `Terminal=true`, `gio … metadata::trusted`) | `"<bin>/plan2code" --pick-folder`, `Icon=` the web console's `favicon.png` copied to `~/.plan2code/bin/plan2code.png` |
|
||||
|
||||
The macOS and Linux shortcuts carry the `plan2code-launcher` marker as a comment line. A `.lnk` has nowhere to hide one (its Description is the hover tooltip), so it's recognized by what it runs: the UTF-16 strings `plan2code.ps1` and `--pick-folder` stored in the file (`plan2code.cmd` also matches, so shortcuts from before the PowerShell switch get refreshed). `uninstallLauncher()` removes only a recognized shortcut, plus the icons (`plan2code.ico`, `plan2code.png`), `bin/models.json` and `launcher.json` (never the user's `~/.plan2code/models.json`). A shortcut failure prints a warning and never fails the command install.
|
||||
|
||||
**Installer integration** lives in `install.js` under the `PLAN2CODE COMMAND` section (`installLauncher`, `uninstallLauncher`, plus the shortcut helpers). `install()` awaits it after a successful skills install (so `I` and Advanced → `E` get it), `U` removes it, and Advanced → `D` installs it alone. Every global install writes `~/.plan2code/install.json`, the install record listing the pieces installed (skills, launcher, statusline, loop, metrics, bot); `install.js --update` (what `plan2code update` runs) reinstalls exactly those, with no menu and never uninstalling, or with no record the skills and the `plan2code` command. After an install, `printGettingStarted()` prints the three steps (cd into the project, start Plan2Code, pick a card) and, when no agent CLI is on `PATH`, how to get one.
|
||||
@@ -4,19 +4,35 @@
|
||||
## Code Style
|
||||
|
||||
- **install.js:** CommonJS, Node.js built-ins only (no external deps), ANSI colors via `COLORS` constant, readline-based prompts
|
||||
- **plan2code-loop & plan2code-metrics:** TypeScript + ESM, built with tsup (target ES2022, moduleResolution: bundler)
|
||||
- External deps: `@inquirer/prompts`, `chalk`, `execa`, `ora`
|
||||
- **plan2code-loop, plan2code-metrics & plan2code-bot:** TypeScript + ESM, built with tsup (target ES2022, moduleResolution: bundler)
|
||||
- External deps (loop, metrics): `@inquirer/prompts`, `chalk`, `execa`, `fs-extra`, `ora`
|
||||
- External deps (bot): `@anthropic-ai/claude-agent-sdk`, `chalk`, `fs-extra`, `ora`
|
||||
- Interactive CLI via `@inquirer/prompts` (select, input, confirm)
|
||||
- **File operations:** Synchronous fs in all packages
|
||||
- **File operations:** Synchronous fs by default; the web console's fire-and-forget sweeps and `readOverview()` use `fs.promises`
|
||||
- **src/web-console:** ESM, Node built-ins only, no build step. It is bundled into every skill, so it must stay dependency-free and runnable as a plain `node console.mjs`. Anything added under `src/web-console/` ships to users — put tests in `scripts/` instead.
|
||||
|
||||
## Gotchas / Pitfalls
|
||||
|
||||
- **Version sync:** When adding a new version to `CHANGELOG.md`, also update `version.json` and `package.json` (root) to match. Check `README.md` for any version badges or references that need updating. The installer displays the version from `version.json` in its header. All three files (`CHANGELOG.md`, `version.json`, `package.json`) must always show the same version number.
|
||||
- **Version sync:** When adding a new version to `CHANGELOG.md`, also update `version.json` and `package.json` (root) to match. `README.md` (the `Version X.Y.Z` line near the top) also carries the version, and `version.json`'s `releaseDate` moves with it. `version.json` is copied into every skill's `references/web-console/` (the console's Help shows it), so after a bump run `npm run build:skills` or `npm test` (`--verify-skills`) fails. The installer displays the version from `version.json` in its header. All three files (`CHANGELOG.md`, `version.json`, `package.json`) must always show the same version number.
|
||||
- **CHANGELOG ordering:** Entries in `CHANGELOG.md` must be in reverse-chronological order — newest version at the top, oldest at the bottom. New entries are always inserted immediately after the file header.
|
||||
- **CHANGELOG house format is not Keep a Changelog:** version headings are `## vX.Y.Z` — with a `v` prefix and **no date**. The release date is recorded only in `version.json`'s `releaseDate`. Category headings carry emoji: `### ✨ Added`, `### 🔧 Changed`, `### 🐛 Fixed`, `### 💥 Breaking`, `### 🗑️ Removed`, `### 📚 Documentation`. Older entries contain one-off variants (`🎁 Added`, `📦 Updated`, `📝 Documentation`, `🏎️ Improved`, `🧪 Testing`) — do not introduce new ones. The `.claude/skills/plan2code-changelog/` skill automates version selection and formatting; use it rather than hand-rolling an entry.
|
||||
- **PowerShell mangles the CHANGELOG emoji:** `Get-Content` / `Select-String` render the `###` heading emoji as `?` under the default Windows console encoding, so a heading audit done that way reports garbage. Read `CHANGELOG.md` with a file-read or grep tool instead.
|
||||
- **`.claude/skills/` is tracked:** a new repo-local skill only needs `git add` (see Architecture → Repo-Local Skills). A correction that is a workflow belongs there as a skill, linked from AGENTS.md, not as a Failure log line.
|
||||
- **Loop `.gitignore` setup:** `ensureGitignore()` runs at startup in `Controller.run()` as a pre-flight step, not just inside `createTaskCommit()`. This is critical for phase mode where the Node controller doesn't handle commits — without it, `git add -A` would stage spec files.
|
||||
- **Workflow file character limit:** All `src/plan2code-*.md` files must be ≤ 11,000 characters. A husky pre-commit hook enforces this. The 11,000 limit leaves buffer for platform-specific YAML headers (106-142 chars) to stay under Windsurf's 12,000 char limit.
|
||||
- **Metrics internal prompts have no char limit:** Files in `plan2code-metrics/src/prompts/` are NOT subject to the 11,000 char limit — only `src/plan2code-*.md` consumer-facing prompts are.
|
||||
- **Workflow file character limit:** All `src/plan2code-*.md` files (and the dashboard prompt `src/plan2code.md`) must be ≤ 20,000 characters (about 5k tokens, the usual Agent Skills guidance for a SKILL.md body). A husky pre-commit hook enforces this, and `plan2code-metrics` (`improver.ts`, `applier.ts`) applies the same number to proposed prompt edits, so change them together. History: 11,000 originally (headroom under Windsurf's old 12,000-char limit for platform-specific files, gone since 2.1.0's single-format build), 11,500 in 2.4.0, 20,000 in 2.4.1. The limit is now a prompt-size discipline only: the whole SKILL.md loads on every invocation while references load on demand, so situational detail still belongs in a reference file, and anything with one correct answer belongs in a script (see Skill scripts in the architecture doc).
|
||||
- **Keep LF line endings:** `.gitattributes` pins `eol=lf` because `validate-char-count.js` counts the characters on disk, and a CRLF checkout adds about one per line to every prompt. Measure with `node scripts/validate-char-count.js` before trusting a near-limit prompt.
|
||||
- **The pre-commit hook runs only the char-count check:** `.husky/pre-commit` is `node scripts/validate-char-count.js` alone. `skills/` drift, parse errors and test failures are caught only by `npm test`, so run it before committing. Sub-package tests are separate; see [Development Commands](./AGENTS-development-commands.md).
|
||||
- **`skills/` is generated build output (gitignored):** edit `src/` only. The installer rebuilds `skills/` on every run, so it is always up to date at install time. `npm test` runs `install.js --build-skills` so a broken `SOURCE_PROMPTS` entry or unreadable source fails CI. Never hand-edit `skills/`; `install.js --verify-skills` can diff a stale tree against `src/` when diagnosing.
|
||||
- **Metrics internal prompts have no char limit:** Files in `plan2code-metrics/src/prompts/` are NOT subject to the 20,000 char limit — only `src/plan2code-*.md` consumer-facing prompts are.
|
||||
- **User Feedback table format:** The `## User Feedback` markdown table in `overview.md` has a strict format the collector regex depends on. Field names must be exactly `Rating`, `Reason`, `Went Well`, `Went Poorly`. Pipe characters in values must be escaped as `\|`.
|
||||
- **PLAN-DRAFT confidence numbers are scraped by regex:** when a `specs/<feature>/PLAN-DRAFT-*.md` contains no `<!-- METRICS_JSON ... -->` comment, `collector.ts` falls back to prose scraping (`collector.ts:186-241`). The overall-confidence pattern requires a literal `%`, but the four *breakdown* patterns (`collector.ts:201-204`) do **not** — `/[Rr]equirements?[:\s|]+(\d{1,2})/` and its siblings match a bare dimension word followed by whitespace, a colon, or a pipe and then digits. So a PLAN-DRAFT written by anything other than `/plan2code-1-plan` Phase 7 must keep both the `%` sign **and** bare `Requirements` / `Feasibility` / `Integration` / `Risk` followed by a number off the page — including innocent table rows like `| Requirements | 11 |`. Otherwise the metrics pipeline records a planning-step confidence that no planning step produced. `/plan2code-0-pathfinder` works around this by hyphenating the labels (`Requirements-clarity 22/25`), which breaks the character class.
|
||||
- **Reference file sizing guideline:** Files in `src/plan2code-*-references/` directories target ~100-200 lines each (soft guideline; evaluate splitting above 300). They are NOT subject to the 11,000 character limit. The pre-commit hook (`validate-char-count.js`) only checks `src/plan2code-*.md` flat files — subdirectory contents are automatically excluded.
|
||||
- **The splitting guideline has a hard ceiling — reference files cannot always be split:** two constraints bound it. (1) Each new reference costs the orchestrator a column-0 `Read references/<file>.md` line plus its fallback blockquote (~150-200 chars), and orchestrators near the 11,000 limit have no room to spend. (2) **The path rewrite is not recursive** — `syncPrompts()` rewrites `Read references/…` paths on the *orchestrator's* content only, so a `Read references/…` directive placed *inside* a reference file is never rewritten for flat-file targets; it ships as a dangling instruction pointing at a path that does not exist there. When a reference legitimately exceeds 300 lines (e.g. `plan2code-0-pathfinder-references/chart.md`), that is an accepted trade-off, not an oversight.
|
||||
- **PLAN-DRAFT confidence numbers are scraped by regex:** `collector.ts` scrapes the latest `specs/<feature>/PLAN-DRAFT-*.md` prose. Overall confidence falls back to prose only when `<!-- METRICS_JSON ... -->` lacks `confidence` (`collector.ts:186-196`): `Confidence: 95%`, or a table row `| Confidence | 95` with no `%`. The four *breakdown* patterns (`collector.ts:200-203`) run on every draft, METRICS_JSON or not: `/[Rr]equirements?[:\s|]+(\d{1,2})/` and its siblings match a bare dimension word followed by whitespace, a colon, or a pipe and then digits. So a PLAN-DRAFT written by anything other than `/plan2code-1-plan` Phase 7 must keep `Confidence` followed by a number (with `%`, or as a table row) **and** bare `Requirements` / `Feasibility` / `Integration` / `Risk` followed by a number off the page — including innocent table rows like `| Requirements | 11 |`. Otherwise the metrics pipeline records a planning-step confidence that no planning step produced. `/plan2code-0-pathfinder` works around this by hyphenating the labels (`Requirements-clarity 22/25`), which breaks the character class.
|
||||
- **Web console result-handoff invariant:** `result.json` holds answers a person pressed Send on. **An uncollected result (no `consumedAt`) is never overwritten and never deleted.** `/submit` and `/cancel` return 409 while one is pending, `open` clears the file only when it is already consumed, and `wait` stamps `consumedAt` **after** printing the result, never before, and exits by setting `process.exitCode` rather than calling `process.exit()`. That ordering is deliberate: an agent harness that kills a long shell command must not be able to land between "marked collected" and "handed over", and `process.exit()` can truncate an unflushed pipe. A repeat delivery is recoverable, a lost one is not. Two separate data-loss bugs came from breaking this in different places, and both were silent: the person sees "Sent", the agent never receives it. Any new code path that touches `result.json` must preserve the invariant, and `scripts/test-web-console-lifecycle.mjs` guards it (its "result handoff (regressions)" tests). Related: the server writes each submitted answer onto its item as `submitted`, and `validate()` in `patches.mjs` must keep excluding that field from the completion-marker and metrics-scraper scans, which are meant for agent-authored text only. A person who typed `TASK_COMPLETE` into an answer would otherwise make every later patch unpostable.
|
||||
- **Web console oversized bodies:** `readBody()` and `readRaw()` (the `POST /upload` reader) in `routes.mjs` drain the rest of the body past `MAX_BODY` instead of calling `req.destroy()`, so an oversized body gets a 413 rather than a connection reset, and memory still stays capped. A new body reader must drain the same way.
|
||||
- **Web console commands are tied to the directory `open` ran in:** `console.mjs` finds a running server through a handle file under a hash of the project directory (`handleFile(project, sid)` → `runtimeDirFor(project)` → `<RUNTIME_DIR>/<cwdHash(project)>/<sid>.json` in `sessions.mjs`, with `RUNTIME_DIR` = `os.tmpdir()/plan2code-console`, or `$PLAN2CODE_CONSOLE_HOME/runtime`), and the project is the working directory of `open` / `open --resume`. Run `status`, `chat`, `wait` and `stop` from that same directory. From anywhere else `status` says `live: false`, `chat` / `wait` report `server-gone` (exit 20) and `stop` stops nothing, while the server is in fact still running. It is easy to mistake for a crash when a scratch session is opened from the repo and then driven from its session folder; check `server.log` and `events.ndjson` (a real exit writes an `exit` event or a stack) before chasing one.
|
||||
- **Windows temp paths in web console tests:** `os.tmpdir()` can be an 8.3 short path (`C:\Users\JUSTIN~1.PAR\...`), while `server.mjs` canonicalises its session dir with `fs.realpathSync.native` to the long form. Any test comparing a server-returned path (e.g. an upload's `path`) against the test's `session` must pass the test side through `fs.realpathSync.native()` first, and compare case-insensitively on Windows.
|
||||
- **Web console assets:** `computeExpectedSkills()` copies references as `Buffer`s, so binary files are fine. Adding a `public/` file needs the three edits in Architecture → Web Console. The vendored `marked.esm.js` sha256 is in `.readme/web-console.md`.
|
||||
- **The default highlight color lives in two places:** changing it means editing `DEFAULT_ACCENT` in `public/palette.js` and the light, system-dark and explicit-dark `--accent*` values in `public/styles/tokens.css`. No test ties them together.
|
||||
- **Reference file sizing guideline:** Files in `src/plan2code-*-references/` directories target ~100-200 lines each (soft guideline; evaluate splitting above 300). They are NOT subject to the 20,000 character limit. The pre-commit hook (`validate-char-count.js`) only checks `src/plan2code-*.md` flat files — subdirectory contents are automatically excluded.
|
||||
- **The splitting guideline has a hard ceiling — reference files cannot always be split:** each new reference costs the orchestrator a `Read references/<file>.md` line plus its fallback blockquote (~150-200 chars), which adds up across a prompt's 20,000-char budget. When a reference legitimately exceeds 300 lines (e.g. `plan2code-0-pathfinder-references/chart.md`), that is an accepted trade-off, not an oversight. Nested folders under `-references/` work: `references/` is the real path on every agent.
|
||||
- **Windows global bins for loop, metrics and bot are wrappers, not `npm link`:** on win32 the installer writes `<name>.cmd` and `<name>.ps1` into `npm config get prefix`, each running `node <package>/dist/bin/<name>.js` (`install.js:1302-1323` for the loop; the metrics and bot installers do the same). After a source change, `npm run build` in the package is enough; no reinstall.
|
||||
- **plan2code-metrics only runs from a repo checkout:** `analyzer.ts` and `improver.ts` load `src/prompts/analyze.md` / `improve.md` at runtime through `new URL('../src/prompts/...', import.meta.url)`, resolved relative to `dist/` (`analyzer.ts:11`, `improver.ts:13`). A packed or copied `dist/` without `src/prompts/` fails.
|
||||
@@ -4,12 +4,40 @@
|
||||
## Common Commands
|
||||
|
||||
```bash
|
||||
# Install dev dependencies (sets up husky pre-commit hooks)
|
||||
# Install dev dependencies (sets up husky pre-commit hooks only; each sub-package
|
||||
# below needs its own npm install. Running `npm test` needs Node 20+; users of
|
||||
# the installed skills still need only Node 18+)
|
||||
npm install
|
||||
|
||||
# Run the interactive installer (always interactive — any CLI args are silently ignored)
|
||||
# Run the interactive installer
|
||||
node install.js
|
||||
|
||||
# Regenerate skills/ from src/ (non-interactive)
|
||||
npm run build:skills
|
||||
|
||||
# Full check (about 70s): char limits, skills/ build, browser-module parse check,
|
||||
# dashboard skill-table check, web console + launcher + getting-started node:test suites
|
||||
npm test
|
||||
|
||||
# One web console or launcher test
|
||||
node --test --test-name-pattern "<regex>" scripts/test-web-console-<area>.mjs
|
||||
|
||||
# Web console start-up benchmark (the paint columns use a local Chrome or Edge through
|
||||
# playwright-core, which `npm install` already provides)
|
||||
node scripts/bench-web-console.mjs [--runs 7] [--workflow dashboard]
|
||||
|
||||
# Refresh the web console screenshots in docs/screenshots/ (needs a local Chrome or Edge).
|
||||
# Rerun after any change a person would see on the console page, and open every image
|
||||
# before committing: right screen, both themes, no username or home path in frame.
|
||||
# PLAN2CODE_TEST_BROWSER=chrome|msedge forces which browser the page tests and these scripts use
|
||||
node scripts/capture-screenshots.mjs # every screen
|
||||
node scripts/capture-screenshots.mjs --only dashboard # one screen (dashboard-utilities scrolls to the utility cards)
|
||||
|
||||
# Compare every element's computed style on every screen before and after a stylesheet change
|
||||
# (dev-only, not in npm test): take a baseline first, then compare after each move
|
||||
node scripts/css-snapshot.mjs --out before.json
|
||||
node scripts/css-snapshot.mjs --compare before.json
|
||||
|
||||
# Plan2Code Loop
|
||||
cd plan2code-loop && npm install # First time setup
|
||||
cd plan2code-loop && npm run build # Build the CLI
|
||||
@@ -17,85 +45,112 @@ cd plan2code-loop && npm run build # Build the CLI
|
||||
# Plan2Code Metrics
|
||||
cd plan2code-metrics && npm install # First time setup
|
||||
cd plan2code-metrics && npm run build # Build the CLI
|
||||
cd plan2code-metrics && npm test # vitest (aggregator, community, improver)
|
||||
|
||||
# Plan2Code Bot (end-to-end workflow runner, Claude Agent SDK)
|
||||
cd plan2code-bot && npm install && npm run build
|
||||
cd plan2code-bot && npm test # vitest
|
||||
```
|
||||
|
||||
The root `npm test` does not run the metrics or bot vitest suites; run them in their package. `npm run dev` in loop, metrics and bot is `tsup --watch`. The web console and launcher suites isolate themselves with `PLAN2CODE_CONSOLE_HOME`, `PLAN2CODE_MODELS_DIR` and `PLAN2CODE_NO_BROWSER=1` (`scripts/web-console-test-helpers.mjs`), so they never open a browser or touch your real console home. The web console suites are split by area so `node --test` runs them in parallel.
|
||||
|
||||
## Test/Dev Env Vars
|
||||
|
||||
| Variable | Effect |
|
||||
|----------|--------|
|
||||
| `PLAN2CODE_CONSOLE_HOME` | Replaces `~/.plan2code/console`: sessions, `looks.json` and the runtime handle dir all move under it (`src/web-console/files.mjs`). Always set it for scratch runs so `stop --all` cannot reach real sessions. |
|
||||
| `PLAN2CODE_NO_BROWSER` | `open` does not launch a browser (`NO_BROWSER` also works). |
|
||||
| `PLAN2CODE_BROWSER` | Browser command line to run with the link appended, instead of the system default. |
|
||||
| `PLAN2CODE_MODELS_DIR` | Moves the launcher model menus (`bin/models.json`, `models.json`) away from `~/.plan2code`, for tests. |
|
||||
| `PLAN2CODE_PICKER_ECHO` | Tests only: `/workspace/browse` returns this as the picked folder instead of opening a picker (`-` means cancelled). |
|
||||
| `PLAN2CODE_CONSOLE_TRACE` | Set to `1` on `open` to print a start-up step timeline to stderr. |
|
||||
|
||||
## Installer Menu Options
|
||||
|
||||
**Main menu:**
|
||||
|
||||
| Option | Action |
|
||||
|--------|--------|
|
||||
| `I` | Install Plan2Code workflow prompts for all platforms, plus `plan2code-loop` CLI |
|
||||
| `A` | Everything in `I` plus `plan2code-bot`, `plan2code-metrics` (dev tools), and Claude Code status line |
|
||||
| `U` | Uninstall Plan2Code files: prompts + `plan2code-loop` + `plan2code-metrics` + `plan2code-bot` + Claude Code status line (confirmation required) |
|
||||
| `C` | Open CUSTOM sub-menu |
|
||||
| `I` | Install the Plan2Code skills globally via the `skills` CLI, plus the global `plan2code` command (opens the dashboard in Claude Code, Devin or Codex), then print the getting-started steps. No dev tools |
|
||||
| `U` | Uninstall Plan2Code: skills + `plan2code` command + `plan2code-loop` + `plan2code-metrics` + `plan2code-bot` + Claude Code status line (confirmation required) |
|
||||
| `A` | Open the ADVANCED sub-menu |
|
||||
| `Q` | Quit |
|
||||
|
||||
**CUSTOM sub-menu (`C`):**
|
||||
**ADVANCED sub-menu (`A`):**
|
||||
|
||||
| Option | Action |
|
||||
|--------|--------|
|
||||
| `L` | Show local (per-project) install instructions |
|
||||
| `L` | Install the skills into the current project instead of globally |
|
||||
| `O` | Install plan2code-loop CLI only |
|
||||
| `M` | Install plan2code-metrics CLI only |
|
||||
| `S` | Install Claude Code status line only |
|
||||
| `B` | Install plan2code-bot CLI only |
|
||||
| `D` | Install the global `plan2code` command only |
|
||||
| `E` | Everything: the skills, the `plan2code` command and every dev tool (`plan2code-loop`, `plan2code-bot`, `plan2code-metrics`, the Claude Code status line) |
|
||||
| `Q` | Return to main menu |
|
||||
|
||||
## Non-Interactive Flags
|
||||
|
||||
`install.js` takes no arguments for normal use, but exposes two build hooks and the non-interactive update. Any argument other than these three (when none is present) exits 1 with usage; extra arguments beside `--build-skills` or `--verify-skills` are ignored, while `--update` must be the only argument.
|
||||
|
||||
| Flag | Action |
|
||||
|------|--------|
|
||||
| `--build-skills` | Regenerate `skills/` from `src/`, pruning stale skills and reference files |
|
||||
| `--verify-skills` | Diff local `skills/` against `src/`; exits 1 on drift. Diagnostic only, the installer rebuilds anyway |
|
||||
| `--update` | No menu: reinstall what `~/.plan2code/install.json` lists (skills, launcher, statusline, loop, metrics, bot), never uninstalling; with no record, the skills and the `plan2code` command. `plan2code update` runs it through npx |
|
||||
|
||||
## How the Installer Works
|
||||
|
||||
1. **Reads source prompts** from `src/plan2code-*.md`
|
||||
2. **Generates platform-specific files** with appropriate headers (YAML frontmatter for some platforms)
|
||||
3. **Writes to `dist/`** subdirectories organized by destination type
|
||||
4. **Copies to target directories** (global: `~/.claude/commands/`, etc.)
|
||||
1. **Builds `skills/` from `src/`** — one Agent Skill per source prompt, including uncommitted source edits.
|
||||
2. **Checks the skills CLI is reachable** with `npx --yes skills --version`.
|
||||
3. **Sweeps pre-2.2 install paths** and removes installed `plan2code-*` skills so renamed or retired prompts cannot survive as orphans.
|
||||
4. **Delegates installation** to `npx --yes skills add "<repo>/skills" -g -s <skill names> -y`.
|
||||
5. **Installs the global `plan2code` command** (only when step 4 succeeded). Advanced → `L` runs the same flow without `-g` and without the launcher.
|
||||
|
||||
## Platform-Specific File Formats
|
||||
The skills CLI owns distribution from step 4 onward. It stores canonical skills under `~/.agents/skills/` and links them into agents that maintain their own skill directory. Plan2Code no longer maintains platform-specific output formats.
|
||||
|
||||
| Platform | Extension / File | Local Dir | Global Dir | Header |
|
||||
|----------|-----------------|-----------|------------|--------|
|
||||
| Claude Code | `.md` | — | — | None |
|
||||
| Cursor | `.md` | — | — | None |
|
||||
| Copilot CLI | `.md` | — | — | YAML frontmatter |
|
||||
| Continue | `.prompt.md` | — | — | YAML frontmatter |
|
||||
| Windsurf | `.md` | — | — | YAML frontmatter |
|
||||
| VS Code Copilot | `.prompt.md` | — | — | YAML frontmatter |
|
||||
| Codeium | `.md` | — | — | YAML frontmatter |
|
||||
| Claude Code (Skills) | `SKILL.md` in subdir | `.claude/skills/<skill-name>/` | `~/.claude/skills/<skill-name>/` | YAML frontmatter + `disable-model-invocation: true` |
|
||||
| Agent Skills (Amp · Devin · OpenCode · Zed) | `SKILL.md` in subdir | `.agents/skills/<skill-name>/` | `~/.agents/skills/<skill-name>/` | YAML frontmatter (no disable flag) |
|
||||
| Crush | `SKILL.md` in subdir | — (global only) | `~/.config/crush/skills/<skill-name>/` (Unix) / `%LOCALAPPDATA%\crush\skills\<skill-name>\` (Windows) | YAML frontmatter |
|
||||
| Pi (pi.dev) | `.md` | `.pi/prompts/` | `~/.pi/agent/prompts/` | YAML frontmatter (`description`) |
|
||||
**Invocation choices:**
|
||||
|
||||
| Choice | Reason |
|
||||
|--------|--------|
|
||||
| Explicit space-separated `-s <names>` | Avoids shell expansion and prevents unrelated directories under `skills/` from being installed. |
|
||||
| No `-a` / `--agent '*'` | Uses the CLI's supported default agent set instead of requesting incompatible scope/agent combinations. |
|
||||
| Captured output | Suppresses the CLI's duplicated banners while preserving real failures; unsupported-scope noise is filtered. |
|
||||
|
||||
## Skill Format
|
||||
|
||||
| Item | Value |
|
||||
|------|-------|
|
||||
| Path | `skills/<skill-name>/SKILL.md` |
|
||||
| Skill name | `generateSkillName(prompt)`, such as `plan2code-1-plan` or `plan2code-init` |
|
||||
| Frontmatter | `name`, `description`, `disable-model-invocation: true` |
|
||||
| Reference files | `skills/<skill-name>/references/<path>`, copied from `src/<prompt>-references/` and `additionalReferences` (any file type; every skill bundles `web-console/` plus a copy of `version.json`) |
|
||||
| Scripts | `skills/<skill-name>/scripts/<file>.mjs`, plus `common.mjs` and a generated `version.json` (see Skill Scripts in the architecture doc) |
|
||||
|
||||
`disable-model-invocation: true` is unconditional because these workflows are user-initiated. Agents that do not recognize the field ignore it.
|
||||
|
||||
## Editing Workflow Prompts
|
||||
|
||||
When modifying workflow prompts in `src/`:
|
||||
See the `skills/` build-artifact gotcha in [Code Style & Gotchas](./AGENTS-code-style.md).
|
||||
|
||||
1. Edit the source file in `src/`
|
||||
2. Run `node install.js` to regenerate distribution files
|
||||
3. Test the workflow in your AI tool of choice
|
||||
4. The `dist/` folder is regenerated automatically — don't edit files there directly
|
||||
1. Edit the source file under `src/`.
|
||||
2. Run `npm run build:skills`.
|
||||
3. Test the workflow in an AI tool.
|
||||
4. `skills/` is gitignored, so only the `src/` change is committed.
|
||||
5. Never edit `skills/` by hand because the next build overwrites it.
|
||||
|
||||
## Adding a New Workflow Prompt / Skill
|
||||
|
||||
Adding a new prompt to `src/` is more than dropping in a file — the installer is
|
||||
driven by an explicit registry and several docs enumerate the command set. When
|
||||
you add a `src/plan2code-<name>.md`, do **all** of the following so nothing drifts:
|
||||
1. Create `src/plan2code-<name>.md` with body content only and keep it under 20,000 characters.
|
||||
2. Register it in `SOURCE_PROMPTS` in `install.js` (with the web-console `additionalReferences` entry every skill carries); add a `generateStepLabel()` case when needed. List any shared scripts it runs in `scripts: [...]`, and put its own scripts in `src/plan2code-<name>-scripts/` (with a `scripts/test-script-<name>.mjs` added to `package.json`'s `test` list).
|
||||
3. Register it with the web console. The meter's points and labels, the resume command, Help's card list and `console.mjs help`'s workflow list are all derived from `skills.js`, so the edits are `skills.js`, `install.js` (step 2), the skill's prompt (step 1), its pose and its notes; `npm test` names anything else left out:
|
||||
- `src/web-console/public/skills.js`: one entry (workflow, label, start pose, flags, subagents line, the meter's `weight`, `started` and `ran`, and `resume`) with its card (plus `help` when Help's line should differ from the blurb), and the card's `states` and `greyed`. Utilities go in group `"extra"` before Changelog.
|
||||
- `src/web-console/public/index.html`: its start pose, an `<svg class="pose pose-<workflow>" data-pose="<workflow>">` in `<template id="start-poses">` (pose CSS in `public/styles/poses.css`), unless its `pose` borrows an existing one (as Implement + Review borrows Implement's).
|
||||
- Its help topic: a `src/web-console/notes/<workflow>.md` (named in the skill's Interface line) or a `HELP_TOPICS` alias in `src/web-console/cmd-help.mjs`.
|
||||
- `src/plan2code.md`: the skill/workflow table and "What each skill reads and writes" (`scripts/check-skill-table.mjs`: every backticked token must appear in the skill's prompt).
|
||||
- `console.md` (the `open --workflow` list and the `notes/<workflow>.md` row).
|
||||
- Optional: `STARTER_SET_FOR` in `public/starters.js` (unlisted gets "general").
|
||||
|
||||
1. **Create the source file** `src/plan2code-<name>.md` — body content **only**,
|
||||
no YAML frontmatter (the installer generates frontmatter per platform). Keep
|
||||
it **under 11,000 characters** (`npm test` enforces this).
|
||||
2. **Register it in the installer.** Add an entry to the `SOURCE_PROMPTS` array in
|
||||
`install.js` (`source`, `stepNumber`, `name`, `displayName`, `description`, and
|
||||
`isUtility: true` for non-numbered utilities). If `stepNumber` is a non-numeric
|
||||
label (e.g. `'handoff'`), add a matching case to `generateStepLabel()` so the
|
||||
generated description reads correctly.
|
||||
3. **Update every doc that lists the command set** — keep these in sync, they are
|
||||
the canonical inventories:
|
||||
- `README.md` — command table ("When to Use")
|
||||
- `QUICK-REFERENCE.md` — Commands table
|
||||
- `.agents-docs/AGENTS-architecture.md` — "Workflow Prompts (in `src/`)" table
|
||||
- `CHANGELOG.md` — add an entry under the current version
|
||||
- `docs/index.html` — **only** if the new prompt belongs to the core pipeline
|
||||
shown there; utilities (like `init`, `quick-task`, `handoff`) are deliberately
|
||||
omitted from that curated marketing list.
|
||||
4. **Regenerate and validate:** run `node install.js` (regenerates `dist/`) and
|
||||
`npm test` (character-count validator now covers the new file).
|
||||
**Adding a spec state** is shorter: one entry in `src/web-console/public/spec-states.js`, the detection in `classifySpec()` in `src/web-console/scan.mjs`, the `states` of each card in `skills.js` that takes it, and a line in the dashboard skill (`src/plan2code.md`); then `npm test`.
|
||||
4. Update command inventories in `README.md` (dashboard-card and command tables), `QUICK-REFERENCE.md`, `.agents-docs/AGENTS-architecture.md` (prompt table, own-script rows, notes list), and `CHANGELOG.md`. Update `docs/index.html` for core pipeline steps, and for a utility only when it is a headline change (its `.utils` block).
|
||||
5. Run `npm run build:skills` and `npm test`.
|
||||
@@ -13,15 +13,15 @@ The loop uses an **LLM-driven discovery** approach:
|
||||
|
||||
## Loop Commands
|
||||
|
||||
```bash
|
||||
# Build the loop CLI
|
||||
cd plan2code-loop && npm run build
|
||||
Run `plan2code-loop` in a project (fully interactive, no flags). Build commands: see [Development Commands](./AGENTS-development-commands.md).
|
||||
|
||||
# Run the loop (after linking) - fully interactive
|
||||
plan2code-loop
|
||||
```
|
||||
The CLI auto-detects specs in `./specs/`, prompts for selection if multiple found, and handles session continuation interactively. Only `specs/<feature>/overview.md` is detected; archived specs in `specs--completed/` are ignored. Session state is stored per-spec in `specs/<feature>/.plan2code-loop/`.
|
||||
|
||||
The CLI auto-detects specs in `./specs/`, prompts for selection if multiple found, and handles session continuation interactively. Session state is stored per-spec in `specs/<feature>/.plan2code-loop/`.
|
||||
Exit codes: 0 all complete, 1 max iterations, 2 interrupted (SIGINT/SIGTERM saves state), 3 error. The state dir holds `config.json`, `scratchpad.md` (LLM notes), `iteration.log` (NDJSON) and `spec.hash` (a mismatch prompts "Start fresh?"). Defaults: 100 max iterations, 3 min timeout, 5 retries.
|
||||
|
||||
## Supported Agents
|
||||
|
||||
Claude Code, GitHub Copilot CLI, Devin CLI, defined in `plan2code-loop/src/agents/` (one file each, registered in `agents/index.ts`).
|
||||
|
||||
## Loop Modes
|
||||
|
||||
@@ -36,6 +36,10 @@ The LLM must output one of these formats:
|
||||
- `TASK_BLOCKED: 1.1 - Reason` - Cannot complete task
|
||||
- `PHASE_COMPLETE` - Current phase finished (phase mode only)
|
||||
- `LOOP_COMPLETE` - All phases finished
|
||||
- `PREREQ_COMPLETE: P1.1 - Description` - Prerequisite verified
|
||||
- `PREREQ_ASSUMED: P2.1 - Description` - Prerequisite that cannot be verified, assumed met
|
||||
|
||||
Parsing is in `utils/completion.ts` and is lenient: `TASK_COMPLETE: 1.1: x` and `TASK_COMPLETE[1.1]: x` also match.
|
||||
|
||||
## Key Source Files
|
||||
|
||||
@@ -44,4 +48,7 @@ The LLM must output one of these formats:
|
||||
| `plan2code-loop/src/controller.ts` | Main loop orchestrator |
|
||||
| `plan2code-loop/src/prompt/templates.ts` | Prompt templates for both loop modes |
|
||||
| `plan2code-loop/src/utils/git.ts` | `createTaskCommit()` — handles task-mode commits with footer |
|
||||
| `plan2code-loop/src/cli.ts` | Interactive CLI entry point |
|
||||
| `plan2code-loop/src/cli.ts` | Interactive session setup (spec, agent, JIRA ID, loop mode, max iterations, resume/fresh) |
|
||||
| `plan2code-loop/src/utils/completion.ts` | Marker parsing (`checkForCompletion` task mode, `checkForAllCompletions` phase mode) |
|
||||
| `plan2code-loop/src/state/manager.ts` | Per-spec state dir, spec hash, iteration log |
|
||||
| `plan2code-loop/src/agents/` | Agent adapters (claude-code, copilot-cli, devin-cli) |
|
||||
@@ -17,10 +17,7 @@ Collect → Aggregate → Analyze → Improve → Apply
|
||||
|
||||
## Metrics Commands
|
||||
|
||||
```bash
|
||||
cd plan2code-metrics && npm run build # Build the CLI
|
||||
plan2code-metrics # Run (fully interactive, no flags)
|
||||
```
|
||||
Run `plan2code-metrics` (fully interactive, no flags). Build and test commands: see [Development Commands](./AGENTS-development-commands.md).
|
||||
|
||||
## Metrics CLI Menu
|
||||
|
||||
@@ -33,6 +30,7 @@ plan2code-metrics # Run (fully interactive, no flags)
|
||||
| Propose | AI improvement proposals with validation |
|
||||
| Apply | Interactive diff review + file patching |
|
||||
| Fetch community submissions | List/parse/import open community-feedback GitHub issues from jparkerweb/plan2code, close on success |
|
||||
| Delete metrics data | Delete selected runs, all runs + aggregated data, or everything including proposals |
|
||||
|
||||
Community submissions arrive as GitHub issues labeled `community-feedback` on `jparkerweb/plan2code`, created by the finalize prompt's post-Step-6 submission flow; the "Fetch community submissions" option requires an authenticated `gh` CLI to list/close them.
|
||||
|
||||
@@ -49,6 +47,7 @@ Community submissions arrive as GitHub issues labeled `community-feedback` on `j
|
||||
| `applier.ts` | Interactive diff review + file patching |
|
||||
| `cli.ts` | Menu-driven interactive CLI (100% prompts, no flags) |
|
||||
| `invoke-llm.ts` | Unified LLM interface (Claude Code, GitHub Copilot CLI, or Devin CLI) |
|
||||
| `*.test.ts` | vitest suites for aggregator, community, improver (`npm test` in `plan2code-metrics/`) |
|
||||
|
||||
## User Feedback
|
||||
|
||||
@@ -68,8 +67,8 @@ Feedback is collected during finalize (Step 5) or retroactively via the CLI. Pip
|
||||
|
||||
## Supported AI Agents
|
||||
|
||||
- **Claude Code** (recommended): `claude` CLI with `--inputFile` for prompt delivery
|
||||
- **GitHub Copilot CLI**: `copilot` CLI with stdin prompt delivery
|
||||
- **Claude Code** (recommended): `claude --print --dangerously-skip-permissions`, prompt written to a temp file and piped to stdin (execa `inputFile`)
|
||||
- **GitHub Copilot CLI**: `copilot --allow-all-tools -s`, prompt on stdin (default model `claude-sonnet-4`)
|
||||
- **Devin CLI**: `devin` CLI with `--print --prompt-file <file> --permission-mode dangerous`
|
||||
|
||||
## Metric Targets
|
||||
@@ -77,11 +76,14 @@ Feedback is collected during finalize (Step 5) or retroactively via the CLI. Pip
|
||||
| Metric | Target | Direction |
|
||||
|--------|--------|-----------|
|
||||
| `avg_confidence` | ≥ 90 | higher is better |
|
||||
| `avg_clarification_rounds` | ≤ 2.0 | lower is better |
|
||||
| `avg_verification_gaps_found` | ≤ 2.0 | lower is better |
|
||||
| `avg_parallel_groups` | ≥ 0.5 | higher is better |
|
||||
| `avg_verification_items_added` | ≤ 1.5 | lower is better |
|
||||
| `avg_task_completion_rate` | ≥ 0.95 | higher is better |
|
||||
| `avg_blocker_count` | ≤ 1.5 | lower is better |
|
||||
| `avg_completion_marker_success_rate` | ≥ 0.95 | higher is better |
|
||||
| `avg_verification_failures_found` | ≤ 1.0 | lower is better |
|
||||
| `archival_success_rate` | ≥ 0.99 | higher is better |
|
||||
| `avg_user_rating` | ≥ 7.0 | higher is better |
|
||||
|
||||
Data stored in `.plan2code-metrics/` (runs/, aggregated.json, proposals/).
|
||||
On start the CLI asks for the plan2code repo path (default: saved `plan2codeRepoPath` in `~/.plan2code-metrics.json`, else auto-detected up to 5 parent dirs) and the project path (default: cwd). Data is stored in `<project>/.plan2code-metrics/` (runs/, aggregated.json, proposals/).
|
||||
@@ -0,0 +1,149 @@
|
||||
---
|
||||
name: plan2code-changelog
|
||||
description: "Validate and fix the CHANGELOG.md version number before opening a PR. Reads main branch to determine the current latest version, classifies changes on the current branch, and proposes the correct next semver. Use this skill when the user mentions changelog, version number, preparing a PR, release version, semver check, or says 'check the changelog', 'what version should this be', 'prepare for PR', or 'fix the version'. Also use proactively when you notice a CHANGELOG entry that may have an incorrect version number."
|
||||
---
|
||||
|
||||
# Plan2Code Changelog Validator
|
||||
|
||||
Ensure the CHANGELOG.md entry for the current branch has the correct semver version before a PR is opened. This skill exists because parallel branches independently pick version numbers that collide or leap-frog when merged — this validates against main's actual state right before the PR.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1 — Gather state
|
||||
|
||||
Run these commands to understand the current situation:
|
||||
|
||||
```bash
|
||||
# 1. Current latest version on main
|
||||
git show main:CHANGELOG.md | head -20
|
||||
|
||||
# 2. Current branch name (for ticket ID extraction)
|
||||
git branch --show-current
|
||||
|
||||
# 3. What this branch changed (commit subjects)
|
||||
git log main...HEAD --oneline
|
||||
|
||||
# 4. Files changed on this branch
|
||||
git diff main...HEAD --name-only
|
||||
```
|
||||
|
||||
Extract from main's CHANGELOG:
|
||||
- The **latest version number** (first `## vX.Y.Z` line)
|
||||
|
||||
Note: on Windows, PowerShell's console encoding mangles the emoji in the `###` headings to `?`. Read `CHANGELOG.md` with the file-read or grep tool rather than `Get-Content` / `Select-String` when you need to see them.
|
||||
|
||||
Extract from the branch:
|
||||
- The **list of changed files** to classify the change type
|
||||
- The **commit messages** for changelog entry content
|
||||
|
||||
### Step 2 — Classify the change
|
||||
|
||||
Determine the change type by examining what was modified on this branch:
|
||||
|
||||
| Signal | Classification | Version Bump | Heading |
|
||||
|--------|---------------|--------------|---------|
|
||||
| An install target removed, or an existing workflow's contract broken | Breaking change | **Major** (X.0.0) | `### 💥 Breaking` |
|
||||
| New workflow prompt (`.md` file under `src/`) | New workflow | **Minor** (x.Y.0) | `### ✨ Added` |
|
||||
| New capability added to an existing prompt, or a new `.claude/skills/` skill | New capability | **Patch** (x.y.Z) | `### ✨ Added` |
|
||||
| Behavioral changes to existing prompt(s), installer, or docs | Behavior change | **Patch** (x.y.Z) | `### 🔧 Changed` |
|
||||
| Bug fix to existing prompt(s) or tooling | Bug fix | **Patch** (x.y.Z) | `### 🐛 Fixed` |
|
||||
| A prompt, target, or file deleted | Removal | **Patch** (x.y.Z) | `### 🗑️ Removed` |
|
||||
| README / `.readme/` / docs-site only | Documentation | **Patch** (x.y.Z) | `### 📚 Documentation` |
|
||||
| Mix of the above | Use the **highest** bump (major > minor > patch) | Combine headings |
|
||||
|
||||
Use only the headings in this table — the CHANGELOG has historical one-off variants (`🎁 Added`, `📦 Updated`, `📝 Documentation`, `🏎️ Improved`, `🧪 Testing`) that should not be introduced in new entries.
|
||||
|
||||
### Step 3 — Compute the correct version
|
||||
|
||||
Starting from main's latest version:
|
||||
- **Major bump:** increment the first number, reset the rest (e.g., `1.16.1` → `2.0.0`)
|
||||
- **Minor bump:** increment the middle number, reset patch to 0 (e.g., `2.0.0` → `2.1.0`)
|
||||
- **Patch bump:** increment the last number (e.g., `2.1.0` → `2.1.1`)
|
||||
|
||||
### Step 4 — Check the current branch's CHANGELOG
|
||||
|
||||
Read the current `CHANGELOG.md` on the branch. Look for:
|
||||
|
||||
0. **You are on `main` with no diff** — there is no branch to validate. Instead, compare the top CHANGELOG version against `git log` since the commit that released it: if commits have landed on `main` without a CHANGELOG entry, treat those commits as the change set and continue from Step 2. Say so explicitly rather than reporting "nothing to do."
|
||||
|
||||
1. **No entry exists yet for this branch's work** — the branch hasn't added a version entry above main's latest. Proceed to Step 5 to draft one.
|
||||
|
||||
2. **An entry exists but the version is wrong** — the branch has a version entry, but it doesn't match the computed correct version (common when branches were rebased or other PRs merged first). Report the discrepancy:
|
||||
|
||||
```
|
||||
Version check for branch: {branch-name}
|
||||
|
||||
Main is at: {main-version}
|
||||
Branch claims: {branch-version}
|
||||
Correct version: {computed-version} ({classification})
|
||||
|
||||
The version needs to be updated: {branch-version} → {computed-version}
|
||||
```
|
||||
|
||||
Ask: "Update the version to {computed-version}? (yes / no)"
|
||||
|
||||
3. **An entry exists and the version is correct** — report success:
|
||||
|
||||
```
|
||||
Version check for branch: {branch-name}
|
||||
|
||||
Main is at: {main-version}
|
||||
Branch version: {branch-version} ({classification})
|
||||
|
||||
Version is correct. CHANGELOG is ready for PR.
|
||||
```
|
||||
|
||||
Stop here unless the user asks for content changes.
|
||||
|
||||
### Step 5 — Draft or fix the CHANGELOG entry
|
||||
|
||||
**If no entry exists**, draft a new one based on the commits and changed files. Match this repo's house format exactly — a bare `## vX.Y.Z` heading with **no date**, emoji `###` headings from the Step 2 table, and a blank line between bullets:
|
||||
|
||||
```markdown
|
||||
## {computed-version-with-v-prefix}
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **{prompt-or-area}** — {what changed, and why it matters to someone installing it}
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **{prompt-or-area}** — {what changed}
|
||||
```
|
||||
|
||||
Conventions to follow, drawn from existing entries:
|
||||
|
||||
- Bold lead-in naming the prompt, file, or area, then an em dash (`—`), then the description.
|
||||
- Reference prompts by their command (`/plan2code-1-plan`) or path (`src/plan2code-init.md`), not by informal name.
|
||||
- One paragraph per bullet is fine — this CHANGELOG favours substantive entries over terse one-liners, and a bullet may carry extra indented paragraphs for detail.
|
||||
- A release with a big theme may open with a one-line summary paragraph directly under the `## vX.Y.Z` heading, before the first `###`.
|
||||
|
||||
Insert the new section directly below the `All notable changes...` line and above the previous version's heading.
|
||||
|
||||
Present the draft and ask for approval before writing.
|
||||
|
||||
**If the version is wrong**, update only the version number — preserve the existing content unless the user asks for content changes too.
|
||||
|
||||
After any changes, show the final CHANGELOG entry for confirmation.
|
||||
|
||||
### Step 6 — Sync `package.json` and `version.json` versions
|
||||
|
||||
After writing or updating the CHANGELOG entry, update the `version` field in `package.json` at the repo root to match the computed version:
|
||||
|
||||
1. Read `package.json` and `version.json` then check the current `version` value.
|
||||
2. If it already matches the computed version, skip — no change needed.
|
||||
3. If it differs, update the `"version"` field in both files to the computed version (e.g., `"version": "2.1.1"`).
|
||||
4. Set `releaseDate` in `version.json` to today's date in `YYYY-MM-DD`. This is the only place a date is recorded — the CHANGELOG headings carry no date.
|
||||
5. Include `package.json` and `version.json` in the same commit as the CHANGELOG changes.
|
||||
|
||||
This keeps `package.json`, `version.json`, and `CHANGELOG.md` in lockstep so `npm pkg get version` always reflects the latest release.
|
||||
|
||||
## Rules
|
||||
|
||||
- Never create a version entry without checking main first — the whole point is to derive the version from main's current state
|
||||
- Always present changes before writing — the user should see and approve the CHANGELOG entry
|
||||
- Match the existing file's format — `## vX.Y.Z` with no date, emoji `###` headings. Do not introduce Keep a Changelog's `## [x.y.z] - date` style
|
||||
- Write for someone reading the release notes, not for someone reading the diff — say what the change lets them do
|
||||
- If multiple change types exist (Added + Changed), use multiple headings under the same version
|
||||
- `version.json`'s `releaseDate` is today's date, i.e. when the release is being prepared, not when the work started
|
||||
- If the branch has no meaningful changes vs main (e.g., only non-shipping files changed), say so and ask if a CHANGELOG entry is actually needed
|
||||
@@ -0,0 +1,116 @@
|
||||
---
|
||||
name: plan2code-model-update
|
||||
description: "Refresh the plan2code launcher's curated model menu in src/launcher/models.json from `devin models list` and Claude Code's documented model aliases, with the maintainer approving every change before anything is written. Use this skill when the user says 'update the models', 'refresh models.json', 'new Claude model', 'devin models changed', or otherwise asks to bring the launcher's model list up to date."
|
||||
---
|
||||
|
||||
# Plan2Code Model Update
|
||||
|
||||
Bring the launcher's curated model menu (`src/launcher/models.json`) up to date with the models each CLI offers today. Discover what Devin and Claude Code currently offer, show the maintainer a diff against the shipped file, apply only the changes they approve, validate the file, and run `npm test`. This skill never commits.
|
||||
|
||||
**Repo-local by design.** This skill lives in the repo's `.claude/skills/` and is intentionally NOT wired into `install.js` — it is a maintainer dev tool, not part of the shipped product, so it is never installed to `~/.claude/skills/`. Do **not** copy it there: the uninstaller (`uninstallSkills()` in `install.js`) and every re-install (`install()`) both run `cleanLegacyPaths()`, which deletes every entry matching `/^plan2code-/` under `~/.claude/skills/` (the `LEGACY_PATHS` row for Claude Code skills), so a copy placed there would be silently removed.
|
||||
|
||||
**Terminal only.** This skill runs in the terminal, with no web console session. Ask every question here.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1 — Preflight
|
||||
|
||||
Run from the repo root (the folder holding `install.js` and `src/launcher/`). Run `git status --porcelain -- src/launcher/models.json`. If it prints anything, warn — do not stop:
|
||||
|
||||
> `src/launcher/models.json` already has uncommitted changes. The diff below compares against the file as it stands on disk, including those changes.
|
||||
|
||||
### Step 2 — Read the current file
|
||||
|
||||
Read `src/launcher/models.json`. It has three keys: `_note` (a string), `claude` and `devin` (each an array of `{ "id", "label" }`). Keep the `_note` text exactly as read — Step 7 writes it back verbatim and the Validation rules check it.
|
||||
|
||||
### Step 3 — Discover Devin's models
|
||||
|
||||
If `devin` is on PATH (`command -v devin` in bash, `Get-Command devin` in PowerShell), run:
|
||||
|
||||
```bash
|
||||
devin models list
|
||||
```
|
||||
|
||||
Show its raw output to the maintainer before any interpretation — the format is not a stable contract. The output is long (hundreds of ids across about twenty families), so save it to a scratch file outside the repo, say where, and show the family headings in full. From it, take the explicit ids at Low, Medium and High effort only, plus `adaptive`. Skip every id the Validation rules forbid (`xhigh`, `max`, `fast`, `priority` endings), and also skip `none`-effort ids, ids with no effort suffix (such as `swe-1-7`, which is a Max model), and `fusion-*` combinations.
|
||||
|
||||
The 30-entry cap means the file can never hold every family at three efforts. Propose additions by family — newest and most-used first — and say how many entries that leaves.
|
||||
|
||||
If `devin` is not on PATH or the command fails, say so with the error, and switch to **guided manual edits** for Devin: ask the maintainer which ids to add, remove or relabel, one at a time, and carry those into Step 5 as the proposed list.
|
||||
|
||||
### Step 4 — Discover Claude Code's models
|
||||
|
||||
Look up Claude Code's current model documentation — the model configuration page in the Claude Code docs. Locate it on each run (search the Claude Code docs for model configuration) rather than using a remembered URL; docs move. List the documented model aliases (for example `default`, `sonnet`, `opus`, `haiku`, `opusplan`) and what each one means, and name the page you used. Keep `default` as the file's first entry even though the docs call it a special value rather than an alias. Bracketed aliases such as `opus[1m]` are valid ids; propose them only when the maintainer wants them in the menu.
|
||||
|
||||
If the lookup fails or the page does not list aliases, say so, and switch to **guided manual edits** for Claude, exactly as in Step 3.
|
||||
|
||||
### Step 5 — Show the diff
|
||||
|
||||
For each CLI, compare the discovered list with the current one by `id` and show one table:
|
||||
|
||||
| Change | id | Current label | Proposed label | Source |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| added | `new-id` | — | New label | `devin models list` |
|
||||
| gone | `old-id` | Old label | — | not in `devin models list` |
|
||||
| relabelled | `same-id` | Old label | New label | Claude Code docs: <page> |
|
||||
|
||||
- **added:** offered by the CLI, not in the file.
|
||||
- **gone:** in the file, no longer offered.
|
||||
- **relabelled:** same `id`, a better or changed label. Propose a label in the file's existing style.
|
||||
|
||||
Summarise unchanged entries as a count under the table ("19 Devin entries unchanged") instead of listing them. If approving every **added** Devin row would take the list past 30 entries, say so above the table and by how many. Call out any likely rename before approval (see the rename warning under Validation rules). If both tables are empty, say the file is current and stop.
|
||||
|
||||
### Step 6 — Approve each change
|
||||
|
||||
Ask about each row, one at a time: **yes**, **no**, or **edit the label** (they type the label to use). Write nothing until every row has an answer. A "no" leaves that entry exactly as it is today.
|
||||
|
||||
### Step 7 — Edit `models.json`
|
||||
|
||||
Apply only the approved rows:
|
||||
|
||||
- Keep `_note` verbatim.
|
||||
- Keep the existing order. Remove a **gone** entry where it stands, change a **relabelled** label in place, and append each **added** entry at the end of its list.
|
||||
- Write two-space-indented JSON with a trailing newline, matching the file's current formatting.
|
||||
|
||||
### Step 8 — Validate
|
||||
|
||||
Check the edited file against every rule under Validation rules. On a failure, show the rule and the entry that broke it, and go back to Step 6 for the affected rows. Do not run tests on a file that fails validation.
|
||||
|
||||
### Step 9 — Test
|
||||
|
||||
Run `npm test` from the repo root and report the result honestly: pass, or the failing suite and its output. Never describe a failing run as passing.
|
||||
|
||||
### Step 10 — Remind about the release
|
||||
|
||||
A launcher model change reaches people only with the next release. Remind the maintainer to add a `CHANGELOG.md` line and keep `CHANGELOG.md`, `version.json` and `package.json` on the same version — `/plan2code-changelog` does both.
|
||||
|
||||
### Step 11 — Suggest a commit
|
||||
|
||||
Suggest a one-line commit message that says what changed, and do not run it:
|
||||
|
||||
```bash
|
||||
git add src/launcher/models.json
|
||||
git commit -m "Refresh the launcher's model menu"
|
||||
```
|
||||
|
||||
Give `add` and `commit` as two separate commands (Windows PowerShell 5.1 has no `&&`).
|
||||
|
||||
## Validation rules
|
||||
|
||||
Check every rule before `npm test` (Step 8). They mirror the shipped-file test in `scripts/test-launcher.mjs` ("the shipped models.json is curated Devin at low/medium/high only") plus the menu's own needs:
|
||||
|
||||
- The file is valid JSON.
|
||||
- `_note` is present and unchanged from what Step 2 read.
|
||||
- `claude` and `devin` are both non-empty arrays.
|
||||
- `devin` has at most 30 entries.
|
||||
- Every entry has a non-empty string `id` and a non-empty string `label`.
|
||||
- Ids are unique within each list, and labels are unique within each list.
|
||||
- No Devin id ends in `xhigh`, `max`, `fast` or `priority`.
|
||||
|
||||
**Warn on renames.** When an entry is **gone** and a near-identical id is **added** in the same list (a changed version number or suffix, say `glm-5-3-high` → `glm-5-4-high`), call the pair out before approval as a likely rename. People's own lists in `~/.plan2code/models.json` merge with the shipped one by id (`mergeModels()` in `src/launcher/plan2code.js`), so a renamed id can bring back a user's old copy of the entry beside the new one. Approve the pair knowingly, or keep the old id.
|
||||
|
||||
## Rules
|
||||
|
||||
- **Never commit and never push** — Step 11 suggests the commit; the maintainer runs it.
|
||||
- **Touch only `src/launcher/models.json`**, plus `CHANGELOG.md` only if the maintainer asks for the release line.
|
||||
- **Nothing is written before every row is answered** (Step 6).
|
||||
- **Never install this skill** — never add it to `install.js`, and never copy it to `~/.claude/skills/` (the uninstaller deletes `plan2code-*` entries there).
|
||||
@@ -0,0 +1,56 @@
|
||||
#!/usr/bin/env node
|
||||
// set-synced.mjs: rewrite the "Last synced" line inside sync-repo.enc, in memory only.
|
||||
// Decrypts, replaces exactly one anchored line, re-encrypts, then decrypts again to verify.
|
||||
// Plaintext never touches disk and never passes through a shell pipe (PowerShell pipes
|
||||
// re-encode UTF-8 through the console code page, which is how the body got mojibake).
|
||||
// Usage: SKILL_PASSWORD=... node set-synced.mjs <file.enc> "<new value>"
|
||||
// e.g. node set-synced.mjs sync-repo.enc "v2.4.0 (main @ 1a2b3c4)"
|
||||
import { readFileSync, writeFileSync } from 'node:fs';
|
||||
import { scryptSync, randomBytes, createCipheriv, createDecipheriv } from 'node:crypto';
|
||||
|
||||
const MAGIC = Buffer.from('SENC', 'ascii');
|
||||
const VERSION = 0x01;
|
||||
const SCRYPT = { N: 1 << 17, r: 8, p: 1, maxmem: 256 * 1024 * 1024 };
|
||||
const KEYLEN = 32, SALTLEN = 16, IVLEN = 12, TAGLEN = 16;
|
||||
// Anchored to a whole line that starts with "**Last synced upstream:". Command text elsewhere in
|
||||
// the body can mention the phrase without ever matching, because it never starts a line this way.
|
||||
const LINE = /^\*\*Last synced upstream: .*\*\*$/gm;
|
||||
|
||||
const password = process.env.SKILL_PASSWORD;
|
||||
const [encPath, value] = process.argv.slice(2);
|
||||
if (!password) { console.error('ERROR: set SKILL_PASSWORD env var.'); process.exit(2); }
|
||||
if (!encPath || !value) { console.error('Usage: node set-synced.mjs <file.enc> "<new value>"'); process.exit(2); }
|
||||
if (value.includes('*') || value.includes('\n')) { console.error('ERROR: value may not contain * or a newline.'); process.exit(2); }
|
||||
|
||||
function decrypt(b64) {
|
||||
const blob = Buffer.from(b64.trim(), 'base64');
|
||||
if (!blob.subarray(0, MAGIC.length).equals(MAGIC) || blob[MAGIC.length] !== VERSION) throw new Error('bad header');
|
||||
let off = MAGIC.length + 1;
|
||||
const salt = blob.subarray(off, off += SALTLEN);
|
||||
const iv = blob.subarray(off, off += IVLEN);
|
||||
const tag = blob.subarray(off, off += TAGLEN);
|
||||
const d = createDecipheriv('aes-256-gcm', scryptSync(password, salt, KEYLEN, SCRYPT), iv);
|
||||
d.setAuthTag(tag);
|
||||
return Buffer.concat([d.update(blob.subarray(off)), d.final()]).toString('utf8');
|
||||
}
|
||||
|
||||
function encrypt(text) {
|
||||
const salt = randomBytes(SALTLEN), iv = randomBytes(IVLEN);
|
||||
const c = createCipheriv('aes-256-gcm', scryptSync(password, salt, KEYLEN, SCRYPT), iv);
|
||||
const ct = Buffer.concat([c.update(Buffer.from(text, 'utf8')), c.final()]);
|
||||
return Buffer.concat([MAGIC, Buffer.from([VERSION]), salt, iv, c.getAuthTag(), ct]).toString('base64') + '\n';
|
||||
}
|
||||
|
||||
let body;
|
||||
try { body = decrypt(readFileSync(encPath, 'utf8')); }
|
||||
catch { console.error('Decryption failed: wrong password or corrupted data.'); process.exit(1); }
|
||||
|
||||
const hits = body.match(LINE) || [];
|
||||
if (hits.length !== 1) { console.error(`ERROR: expected exactly one "Last synced" line, found ${hits.length}. Nothing written.`); process.exit(1); }
|
||||
if (body.includes('�')) { console.error('ERROR: body contains U+FFFD (encoding damage). Nothing written.'); process.exit(1); }
|
||||
|
||||
const next = body.replace(LINE, `**Last synced upstream: ${value}**`);
|
||||
const out = encrypt(next);
|
||||
if (decrypt(out) !== next) { console.error('ERROR: round-trip verification failed. Nothing written.'); process.exit(1); }
|
||||
writeFileSync(encPath, out);
|
||||
console.error(`Updated: ${hits[0]} -> **Last synced upstream: ${value}**`);
|
||||
@@ -1 +1 @@
|
||||
U0VOQwGC+cVDQX33z9hyjf2GyG8u7kGlmVvR0Y8mPpz9U+OYECVP4C1W/S35F2DbAmcmx77tq6dReTyyGDvBoFpnFGLdNxCCu90fc1fnVUBAlG6jXN9MZZfNwJ6G4trn9vV2iZFs6G9cRRR/dC636cSbZwMkcfY4XNKbM2DieCrJ60Wfo6EF9Sy97DrKqGw4IJnRoEAM+dKTQDfDxpWZCW5C3vwr0pxHS0hhFPUmb3G2EMSEtoYhyhi38sf55u6wwpIJZg8Ko0KPgkBePzk0LYuWY2fMGrrfwOXWstBcUDjwrEdXcejiHG9iTsxwXS/W1gQRe4Ucx7+PffmUJedFnL+yx9gnKNfYwtDGVtXjgXeNkZaiqn85sbJTYAHXheAZUi4itPNxe6BHpxXQcpyTP0zkrhEvFtbRTBYvITqiAgBZt+brjcLkJ4N+uVjkI8fqxemQTJVBbtpChREaCqGA2R9UqlKKpEGGUq9/SqyMMxtHvUHhI1unVEQj1C3IWBdF0DC678pEKGbjx5z9UwF2Jbvw/hkmJdX7RycayDhuL0ufS/USkSe6JB/NKQ6+MMlNfZCsZyhijrgq6t0VqrsiLzN4B2paAQiYaX/sEy9AWEBwHmehW0xLsV9dhhkhW1995XTHi20JgZpNI4h53qxqaaYxwMjQ0FUR9/8570Tp0p2PUtyELJLTaRF0YpyW/zsnntycAkfqxP6hqv7719PQSu0Cg12Ppfw/rX9M3T6HC0EMT1evKl/YETomxZeRF74+JMNEge12QfHmlKgtaJ7CYkn2E3wg8rA2jfw7cleXpy/a5tK95i/Ty793TrvjBPWdurHTcq9GWqrC7FQ+IG2bkoCziPv3LSz0CdKKdkWso/hq/uOrZ0PKlcJQH8RhWYXPkjUM4yCdKmFXv77e6c6TEnPkqwIQPqzc5CoiU8yh+pwPmucpyR1gFLOEUJ/qdt5xVAyMumEZKccUIcS/rjV2j1gZL68KTz9MNe4IWxNssRGmARgezEJq5hWQwtcIMCx4BqLK5oeYSmiYkrMAHsLjMIBLyi6lGng4jEED7Wo/J5wRJCDciO5t8eqgRTHe7hIsI77lgpqVn0fo0zLVgfwSMxkSkT16eYbZ0YVKoyx2SFurAlzCeJkceZXgXMld2Nq7S3+fzuc1O0ggfH7hizZ45NxfywBarYT2RxlwHT4gsN68759YWHbYJ9ZvoU8Gb3KOfgNRm/xK0F1qeY1LY1wJ4VkHm+LMoMX3V9ZTjCDbc24P2ag755VZ6FwwW9PVHX/i2CyJ5Ub9xrB0JGEhpz1GASbzczl8gAJDxSaUg9qxbsM5qPD54euu5AGXAiXJEsGwiBIEv783vQBpQKlJhs4t8ADAWJ9JmU+YY6QF9yPiDtg7UPwsvQlMlCfSoBqAyIhYzfBXNam9yGTuIGI6MZMtQ6cIOLAn6FOBEShxPOnuQr8+ULydQblyX5a2BvgXAvJz3tXWG5SplK0Rq6JgA1d8PeeLJr9ApjHL8cnQdhpqhnCC7C/V5sugRLl6+uOUTNxf5rMNaMN2qEen+rXdKErMh7VHciC8vAzMKmdUL6wKfSIkr3YRzqYaMd49SPVyE/5STh+qUojtJICjaQbmM3inlAM6AiBIgNTL3Rr2KodM//sYyMVRC7IfP1Z99x2rDNNUyrhZO+3huaGrtRbDq2Xe1MtiEk81ilNF0vAMKhTJGb97W0UyGy5Ptii5iqlZMfQ6bixhs6PAdyu6JFgT1nDzNfsltg1l0bWIVlDTz8+VJpPm0H7a77NxsX8rov5JNTZayefhll4pBt9elPQkoOXNKBZ4ms4VfQFv4iFGjNleXfr0f0GNpA0qSN/VdXxgJvZHamqD3i8f67TlwxJMeQYoE1x8Frkc3TU5XfP1hbk1cGfNV25N8WewZSzfcBWTVhC5Nx/AxiGMFCqvZ5VyM7VaNTigujz5lPGBfkDsEiP0QbckGoxjx02WFRshDpFpk7SB1BIpm7+wQDJ4i5Rla873lG6F9EIOSsOi3qmRrOsdpfAhM7ssPolIbMsveESp4S0ufJKcPsRR1XyIRBQUmLWFBvodYui01GsEl5pDkGsd2L3Yg/rlLLKz3qjWH0rLt7YAVDqVCz4brqoPmDz9jWNAB4cvv5whdZ6gUOM64vbTMe4ZSNjpke/O66Z9JcnyEptxBFSJ4mW0HxlUSpsnQ6GZ4Nnarvwfxs2NHophkaiLoJAiBDvUJd529WXxP+snJe4WoXMJ2ULJ1lqVzdrXiKRHYV7MFu04lEg76LCd10M+zL18DpfP4vWhIF5B6vaSUCMTWfd5W2Lfi3X5qVkL4aauh9H1cZu0oT1aHAnI/qiQeJKZ3zAW+BfnTnL8xHD3qWQ49L0eRb1lAwZnvh67CbH5bSnFc14oHKcnE5YBzAsWd//J6gGCVjeZ8eBcKkOGK0xOitZT8Ag+aythCsseG5hT+SBuoLaUzzHlhFF2WpFgBKqwdJ9HEQNDWRyGCa/oFmogAg8RoEFK5FoxbXlqClJD20gK+9OnJ51bnYMH1RqszJ0+Rau9TOztMqgbCLl7A5TtFk37OuUbBdONSrdacrga9aCOLqfmDe9UXLb0ByrEXMypu6REQHEycNWjF4eUqNf7lqoQLwc9DWRsEqZUPCjO9+GXRHEa1YO7OWD3lDltajbY5IxwrG8vVCWWCmhxCwV1sxNPsvGsGXczgTskO+NgkKqqIb7c4bK73z3lgGYhO/57eHFB5Q8EaVj02+nzqH7KnQi52r3pzM3klMVDpZVaOWY903mRDpeOgCaTdwsa10srCP2AhNB1TVjjBsQ8ezdPfCRJKzh3+NvcizUg6KSO4rGMJPj2OoCD7uL++lNKpSwkvGznZKDLwIDP/h50Az+Qm8KTOUl975VeQ1MY63HkF+Qo8Dvel9eKyvXRZ70aMY5v8DzIQILbcn5zUD9oU96eyk+fdhxvkR4t5X+DK2TxHWOm/cRVbdYBMKrwcnR/jC7/oHIFzGKLe7+ynGhP3pg8mhdwaW3gefOfaRxS8n0ka/OpcxqDbi6SdojqZ4ka3wshgcnDlYFWF7HZto099hvp9N7MzR+2enYdPSL4jP8W+GNbGXgbxnT4xCF5kyTzcEZoXDxVaGnArVDdKxS7nJe4lPm+NfPkHxHWKZKvpk85qqLyBtfIUAjcrV8uIiFOhaKttlko+6ZwYb6+R/7YlEWyaO+uwJVNG22idAW+jEDkPX9DB0/pWP7Oy73WLro9ovFHws48Nrxfygu5TqjuxuhfNWwdUwQfUJG4vk8bqdH636o7AKOa97yvGPGIkHm69qiMxc1lZ8fcltRTdYbjFysK3ySqs9+MlymonAW389/xXeYivEeS3MePTzZAxy+q5IwqgAnC595qzU2LXDpU2wqeQI+6gV/GuzPcOw6sxvdBqz/75SRnHv9L0qzBLiA0PdEl6Z9KDO0Em4IOjcrvGvJj2XDwN2gGD9/N9H9AXIexQpS2vhnWQRTFHWG7eLxr/egHGe9IR5K+Mo2rHPfJjAkgkyAZEd2eNplc3EP6fujJArTy0iGkOLdB2RND9s+NcfFEF+WztNwUxxFQEmuwFVXSr8PFiMvUK/OSLy3KhEihGvZdIQ4CICG1tjFf0ElxVKO/XkoKflbhCEkGifNd+iZL1yqF7YXi412e+2kjMq1QFwpMX+8PTweSHY15xqgquG0Bp3S+93WL2lOVXu2AlFQRjlmPYwhEdcLWqxgko97LfqLRCWIC9u72rBKYFHW5iwERmdmPqfYlC+B01OflGOWjne2jiaLS3AMZoAVUkSkRZZATPaEOrwfgowU7Ik+FSKJkgmMx2cpLQYm8ltA862cPiKiiMZjwsfnYmByyyV76V20RL5wEHXBK6fJadS/W9mY7kqJASmMO4Ru40SkZ+Ksy5v1NydLZyRy2rBXzAYwUJopzhPwZ9e8fi6V9LW0C7fpCqiCapmxs8gGo/7XzvGhDlzgsDk8P2utse3iySKDxikF5AFqRASLmkcU4qxOSXw2TplwyzC+dXK0ITiBoriz6Dey1InkCydj1dprR91obS9lY48S+C+nj3F6OLWBOEWnmYiD7zyCyo8DC2FefzGkWIldZhnopBui4SysivINcI/muKAJULMzxgcvmtRdafT53enyrqQVmddILAHNt8bbNnzhOt8bcuyqO3ESs7DdkzA0vYm/GcKX4qovlT6FOSUnhzWeXKuJ/lwCjVdgDwmcq06zg0JaeVzqoRPbOlFeWjAhtw0w+470TgoanMm3esRrYPn6Bt3N0Lpz8F9gw5Bg+v2kqdTn2wFkS0Y1aIY1NLtP44CeZAESX41SwAkcaprm9jDovltqytgXLagAkhOh+0ners91j5VEB+9keSfJ0zgZvkrrwk2Hz1nmjvI5fLWlbavMsy9h6/XZb/WFrcvDGCoQnJVrLlJY4VLQYmaxGLdeDb+8ZsZLvGFoUPNNzcqzoYchxsRIpXLkjlIV31jAYPwkHsHwAmerw60lyP2rv1XF8pW3z1fx/n/aatgwEL/lCcef0TxHsrJ65ifUY5QhpPjmj0RpamaH+Wn20arWOdUEJ7elgLYdrjk3zesed2c3j86GMePuwsuyPr5zvyXCpD/qQcTvX00GM3QE69mS30u3Xtrgn1KMGMnWQrotPZ43L3N0APFlR0zAofd+3PMI9XsCClO90ZNEwt6kAzKKwhTpw0Du76a4d8OWrh60JF5DSQje/7zlhln4zuGfq7b7ATVhXS6r929/F6TBjh1+BzX9OrWv543zotOSBYqMgxlYMc7pJurhsvaoDzPTtAU/t2vBrCi+IqJXC85tVjmY28B9FL3OtC6ERBYnFYcn4ZxkPEs6mtRuRATMPZVnPCLAgCOGOCilNohqA0UI307LtpumlIPMXVsdauLsdVm6eI0llAL1ju9ISAGonGxFMHLXaI2vITLdVZgV2qvHqtB9Sy4pvWF/2i2rqoKHYOALfgC4Abu+MbRNsXAsesFvz8vlZr3wVXY5Line truncated
|
||||
U0VOQwFCLraZiofXGk3ma3rfAp+AwimbD2xmPARjOXLQKQDASKq6WUdAn5Xu24Z6rJgFAocX+aoaxr7aEcSFrlFujCdvGz8V8xc24n8bf5xsAEXkLEYouPry356TXt0FXr6hMN0uJvih1b0zJQI2g0NP0Nqjb6W3QsusKfvxJdVSWCC6fXd8YVGjqXIBBB0TnReajLcbE6innfSbpK9bPioIuychW0VEPtytUTo/+z8xxIwZphis8Wx4zVUUm2b6CZVgbh/Uhxq54dkicULYd58KfsBgRaUscASNvjwgw6ggjvo7R1Wj47xm0L0nSFDPoERuOomxW0lI4ib5wfJ+3j2hBoueX5dHVMpVaGOZpL7RLvJf0AbBE8kwCL4hLxjBuatt95R+sfCpxHXu8hga1AzFKa2gL/IE6nzq5GMC5UKJ9JIhjmM6GxekM3c5yh+AbBgUxfv4Fa2OnRzNBvICB+xJfDSP3G0lE+OwkenYURIzMrW+gS24NXJ12rzhlyhEp0iAvr6wGAskcTpe9nXShyL9M69FXmCJuNZdenQv8pPr9zuw0M5b6BdKG9Tcp8j1Qm4BBA8J22Vd0uF7D6ByjpKkknbPdQMh3A/s09qix7t20eP/OGTh1JBZkOXxbSt5N/mjYUeLXAzqCYN0c3GsX6Za45OU618l4PO+kC223EdAjD4dWbN1CW65uJY0m2XckZr+2p3f9ow00BHnfzIZVG+aMSicaIJdGGudWdABVCsb7zvFr/Pv2pRWZjSOtSh2OrIkFeobEuqOFra1ifRCn6Y2/LChsPJBUqDwV4qDNjFouWL1JR59XntCn/Vcn94S9HmeP1gFS0ceOWGDDnaocbqCF3RL6SW9PN7GZCORjiyYhVZn6i7gIBIvmlg8mqmYYAaTGm9abwB278V2UJEn/YD/Hbr2krnVZEoEG73pk+oFGDRiY+G+cA2bpWhVt0bXKluanQJV1UTby0/RhbGGjhFMr+dPqHLRoeuLbnYkvcvLbdjz3vRXRbJdO3GARy81hWjPEZnvEaT0SR0683uMsCzCz3pWqL8BMIN2GuMIIsn7D0lZwb5eKrDjEZIkyVZhYiwX1kSsjK+JfIweRvxRoa2fCZ20tP5alIozh6m+Q2eWyzdxyRqXCHZkd8kUUT+XbLj5cw9tl3oINfwRUFYxAPwq/bhJS3bpl5ElPdo/ZKOKQuHpjt2nLdyXDYjXtpY9nUMKDO5in/bkqzSnSM52Va++1vaaYBtZnYx0v1HFoPtepx34pwkX0yjKIqIsHOzQVNNAYL5cQlzATMNISYsmne8c8ioRRuK07nyHGZhLroVaxJ2fgL6VQVjlxWmyeI9b+tBf3fRGtYwP3SwS1B4SYySFZ70bNZyROaQdE8Rin8mH7Pw8WquuCEE+LR63KLdC0QnV3iAr8d4aJSsYlDjqMXMASgtqof/jKCE2KZtCR+T2DrnXMhvgsRVwZ18Iufd9clv8hxrEUYx8D0sP+Ao9LJYAWGJ0Kt7GSfdwDLaRjL4jkToeFIImwIZPDpckCsraOcWD+vuR+kuuOBCtSxN+rm9pZ1VulMAG0KkkpydTeNPlbRuLbgfmwk8o7QQnmjcWL96sLQszm0JnYlQDHLRfAmaBj7L4JbsiGhCe5+2SfIrfqDCZhUYF+OwILtwXbhBGl5DcbCeRUSz9NUrz3ywF8TZa8TgBM89PiJb/pvMNrE7m+SmDJugiQ6UWcoYD9eC/katecM+b7KLGBYpO5qFx2+QpJff/YRhmHpz5O8UjJVKJK+xLAbvyiVs44OL+yJ5MIq8TUB7ojZDaTkpuwLKeezycktpzUENMbona5GbjvSaJWmD97TgBgAY9iP38h6lOHzKh0Mda5aVSWVn1Rq1pJ3IsZBPSC9QQe/p4DItw5aXeiMQwdozY5j95qICXfxvfnZP/MSIAyj9SZWKhNIuCDvOUxDHj2h4EZ6X+sCBAvhQG4YFAIzPqS8nnUIdgBtbStZBkQoY+n+m8qPsaYf7QdWeGPRI2vcfcCXyR9DvePV6ER3sTI2GKUUr61peCejc+cBwIWvqacr7Xl5QqTgTXGYvgu/Sh3FMws9iEPNScfd9K/hRbqTpJv4CeDu4fyFwTzuP/BHRQuv5pqJvzHdmTppwAfqAmo5pAWig9WpglQc+rWmlJYAtUvF7SIop/uXcH3r0xmlMilpc4PDMzaw3gu6kLIec63jrS0+cX5CD0DjfuT9nSgsdR8plkFi7UwtIRGhFO3B0gCIG+frznPAFUpm5KtnjjG1jIKsAXcfB1ZViS7/yHVcC4FeO4XOOJyVZSAImWKJ7ljGtpjLCK8BtiqrCuf26wlj3iw9jMm8wS5f+G+INg7bFgnlNRfqId2EeYJ21q9rODCCLMf2DUjJmVEuqk/grPparL3OgIV579+RUhXMUechv3zwkSdk/w5zyKyCc4j6tbAERg2KJP3CEQnCrdUeqMSdy06/prdkHnByPAX+7tx3JzVjOPxv3L7FNmahhTW6lWSJX2IR2VRwsP1UL6kf4pPeT9T5Ou47mmRy3CP+JLFDYt+3cQs9qYry+Xz2MfTJnyNJb7vGfPaQv/rPfJZyOmlFhQSzXfGtAPVF8srKnUNgdX6EJsw08rDZQhr0pCcu92VkNvNigzDtxIb+u+WYNprGb+sJFT+rtPQbP5v9+akyBw1Op7+Kek+S1XgK4PF+29QiEHKfPq4pgYnO5BLaUvNJVEImZV4nXM1ve2+YRDjtxRB0f2zBau0CfI+QpSfAHPk/COZojZU5Pdd/IiVPttEaSo7dvlhINIbmvTmHIA/XcHuOERmTpIZycVumSeKhDXxnahJzEeWZwDoxIkxIhFM94hLH6rc13fcAUvo3T+jKt7d9k13rF6dw+rd63+Bq83bBDHFero8tZmWdQ0Tpnv231EbSwv4L16N7J7ALtvPbnyNWR5wWzN9bc2/xglGys4txTcBt32P/dBR8QsBQ26CISfoElUR+vWQyo+OTOMP9sXyWPN0q2jC+EA/j+xg0TT2dW7RtkpjLR9uEMZpvJSMYnep+HtWw+6fns+W8kTV8zjv9cwod0TOA+qLbd3VCaQr/TDImqHigciRLV4NCLOTWGYuZiWbHCfikIyG4HBJlRgFumVTlgGKsVPRtdx5gqZBvZqaE2CSAtESC/O7q6ocoGx7cyLEs5Oq9sp2JZQPfxyLTtfG77OdAsr4KFFwGvgjH1Laz6rqw+DL15Ysj/WTl7yJ6toQ0KaRVTUf+3pNhpyCsqfWOLy4A8bMWAoPTdvh4sN+lOgNmHfe5Wym/UfR/UTz6cDGSrQgbSN3PXFzzSBM/Lm77MRljbBbFp0qXJAsteajVeXJX2JVFhGhQ8TzAUL3jhblbY0psVHuBoW9oyQ+UREc5/fH9hbRSDVcCr/5BWnY3Og3YOESOhHFx+lNFT+v96QU5lkat8b80llUwM/aJ8t+tzK+nyKhQwGgXpek6hVwnDhAFuwGXbxaCJNR5XJWrvChcn+m/5TDEm/U7mRblkiwEBm+i3mBDEioH9vHcRTu7wB+FoR6Q0FJbr1tm2lG3tvBg05pEglHkXrz//3iH61NjH251++zW93BFzngQLoRRBcreFfdiEP6VoHsVC5cFjzcnymLEdUtBp/ihbDZ3Tzn72c0oOzV8td4lgDDzxlJLZglwqj2Yx0yJLAPUAG7hJCWk+NbvyDsYSLWxn+ywOMH2onyh3pnPV7S3nKuJ3k6o52gdLmBOM6kHZvDmyTl4yua5zABGr6UWSHlgtCS1BRs8bH+RV79irRp1F8LUl8C+aENK1OlvD37kRRrlbZlqUV0cFib1ItRy2I69E2H1MfjgPE8gwksVmvX/JSGR6GC1SOFEqRRaGQtVAgSNrZ9W+qVpevtsK7Eytg2HVo8ZmPifWRZe5YOawhE7fFaih0/4gEoegRa6hDGK+X0uWao+95Vgtf1DosETrxlICRbDZT6oyqqWjGrIHi4X3ZSAgXF7VsZ+EeYRLRbJ84H8l552PnjXXPufQkOP3o6fFJYCMEnqowtqRhTIl5stzBbHLWVmQ6UCKPlhUHePsjI5snYy8/zuw6HRxYY+p6odEi0sn31PXO3RCeRBMtNQ5xWhddJK2KX33Ygc+qXBLSe3LG1PcbTCCf1H+E8x06JM5tVGG1WsmZnEIBxCpQUZN3/fUe65B37QYyxBwZDFwxetjthnT2E4WR1INRVUgJySBYrgHJr9PJF84dAdyrbXJsh2TckR4rCRYpOC4Yf4p/GqQim69YA09EIHA+9PgywDyiZ3lSKYHwrLgGZliiJx0envl2YlL9udzPcLzpjGOLzwTj2vpOAe3cDgscYGLPSUK76yqS1cPCXfz+xpmrvVFgUxRSx5i/hj4TFQotyI9sTfHTSXBJBvywpxC2GMoZrTSR+4ksLv2kLatRtVGnUHSAA/Lx6fbFKQleOqN3sFn9exSQAo3EWEA1wT/Uep6uSBWAg12Laf8l9hgoIniThbqv3D1AgfRth3aXfY5sK0S7HQfwCfbMWr2HSU0JydhxufKFV3z6aV1fCpXAgkXoZ151Brrpgi4urtwgFWfD4Cvlrq1SXM8aW2F84EpvOkADhrEvpzf2ZJ8w7mOzZxZCxoQ3CbBhjHjyfnoPMUMldvYctLobZxOBUqfwxC2SlcCyQCvlRLDs+M6z/qONNOhg29pZK368WHEbzUNmevtq7cleE4MGk2NU88Br99YPFc0qaxY+xDSaZKFDhERe+2QRNY3jTC07aK8tfoChkK4uahAghWDImK50i3DCLnUI5TlOaxkOaujA40QtEmnt5CNQuLeSCKtduT4rmDn2zDdep+BCCJlS1lJfonIhtDl/fCUT1Zj4Q/JWOlwUJDs+3yalPC78fqWTgHrNOREN/o5VRkOegZDz36eE6sFr4cpKfjSdeeojMb8MMKAFRAJce3MR6HflkKqEpTyVPMkeB/u48Z2wANGcYDwhqzi9c54DDjbSh1Vw4BbkuxgFUgdREipn1NJLine truncated
|
||||
@@ -0,0 +1,6 @@
|
||||
root = true
|
||||
|
||||
[*]
|
||||
end_of_line = lf
|
||||
charset = utf-8
|
||||
insert_final_newline = true
|
||||
@@ -4,8 +4,8 @@
|
||||
# Git stores LF, and every text file is checked out as LF on all platforms.
|
||||
# This is not cosmetic: scripts/validate-char-count.js measures the characters
|
||||
# actually on disk, so a CRLF checkout adds ~1 character per line. The workflow
|
||||
# prompts in src/plan2code-*.md run close to their 11,000 character budget
|
||||
# (several sit above 10,800), and a CRLF working tree pushes them over — turning
|
||||
# prompts in src/plan2code-*.md are counted against a 20,000 character budget,
|
||||
# and a CRLF working tree inflates that count, turning
|
||||
# `npm test` into a check that passes or fails depending on how the repo was
|
||||
# cloned. Pinning eol=lf makes the count reproducible everywhere.
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
@@ -16,6 +16,7 @@
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
*.png binary
|
||||
*.jpg binary
|
||||
*.mp3 binary
|
||||
*.jpeg binary
|
||||
*.gif binary
|
||||
*.ico binary
|
||||
|
||||
@@ -0,0 +1,78 @@
|
||||
name: "🐛 Bug"
|
||||
description: Something in Plan2Code or the web console is broken or behaves unexpectedly.
|
||||
title: "🐛 Bug: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Describe the problem. Screenshots are welcome.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: What did you expect to happen?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
placeholder: |
|
||||
1. Run /plan2code
|
||||
2. Pick ...
|
||||
3. See ...
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: skill
|
||||
attributes:
|
||||
label: Which skill or tool?
|
||||
options:
|
||||
- Dashboard (/plan2code)
|
||||
- Init / Init Update
|
||||
- Pathfinder
|
||||
- Plan / Revise Plan
|
||||
- Quick Task
|
||||
- Document
|
||||
- Implement / Implement + Review
|
||||
- Review
|
||||
- Finalize
|
||||
- Handoff
|
||||
- Web console (page itself)
|
||||
- Loop (plan2code-loop)
|
||||
- Metrics
|
||||
- Status line
|
||||
- Installer
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: interface
|
||||
attributes:
|
||||
label: Where were you working?
|
||||
options:
|
||||
- Web console
|
||||
- Terminal
|
||||
- Not sure
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Plan2Code version
|
||||
description: Found in version.json, the installer banner, or at the bottom of the web console's Help dialog.
|
||||
placeholder: "2.4.0"
|
||||
- type: input
|
||||
id: environment
|
||||
attributes:
|
||||
label: OS, Node version and agent CLI
|
||||
placeholder: "Windows 11, Node 22, Claude Code"
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Console output or logs
|
||||
description: Anything from the terminal or the browser console that helps.
|
||||
render: shell
|
||||
@@ -0,0 +1 @@
|
||||
blank_issues_enabled: false
|
||||
@@ -0,0 +1,29 @@
|
||||
name: "💡 Idea"
|
||||
description: Suggest a feature or an improvement to Plan2Code.
|
||||
title: "💡 Idea: "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem or goal is this for?
|
||||
description: What are you trying to do that is hard or impossible today?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: idea
|
||||
attributes:
|
||||
label: Your idea
|
||||
description: What would you like Plan2Code to do?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: who
|
||||
attributes:
|
||||
label: Who would this help?
|
||||
placeholder: "Product leads writing specs, engineers running the loop, ..."
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives you considered
|
||||
description: Workarounds you use now, or other ways it could work.
|
||||
@@ -14,4 +14,13 @@ nul
|
||||
handoffs/
|
||||
node_modules/
|
||||
package-lock.json
|
||||
SYNC.md
|
||||
SYNC.md
|
||||
|
||||
# Generated by install.js/`npm run build:skills` from src/, regenerated on
|
||||
# every install, so it never needs committing. Anchored: .claude/skills/ and
|
||||
# per-skill references must stay tracked.
|
||||
/skills/
|
||||
|
||||
# Throwaway design prototypes (ai-assist-prototype). The decision they
|
||||
# recorded lives in the code and the CHANGELOG; the files stay local.
|
||||
prototypes/
|
||||
@@ -8,7 +8,7 @@ specs--completed/
|
||||
.gitignore
|
||||
CLAUDE.md
|
||||
|
||||
# Exclude generated files (installer generates dist/ dynamically)
|
||||
# Exclude stale generated output from pre-2.2 checkouts
|
||||
dist/
|
||||
|
||||
# Exclude dependencies (installer will run npm install if needed)
|
||||
|
||||
@@ -13,6 +13,7 @@ produces are unchanged.
|
||||
| Approach | Best for |
|
||||
|----------|----------|
|
||||
| `/plan2code-3-implement` | Interactive control, reviewing each phase, logic that needs your judgment |
|
||||
| `/plan2code-3-implement-review` | The same interactive control, with a focused review and its fixes applied before you approve the phase |
|
||||
| `plan2code-loop` | Straightforward implementations, batch work, overnight runs |
|
||||
|
||||
The loop reads the same `overview.md` and phase files. You can start with the loop and finish by
|
||||
@@ -24,7 +25,7 @@ hand, or the reverse — the checkboxes are the only handoff.
|
||||
|
||||
```bash
|
||||
# From the plan2code root directory
|
||||
node install.js # A (everything + dev tools) — or C → O (loop only)
|
||||
node install.js # A → E (everything + dev tools) or A → O (loop only)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
@@ -16,7 +16,7 @@ One thing to remember: **collect after every finished spec.** Everything else is
|
||||
|
||||
```bash
|
||||
# Install once, from the plan2code root
|
||||
node install.js # A (everything + dev tools) — or C → M (metrics only)
|
||||
node install.js # A → E (everything + dev tools) or A → M (metrics only)
|
||||
|
||||
# After finishing a spec (steps 1–4)
|
||||
cd your-project
|
||||
|
||||
@@ -15,18 +15,18 @@ background processes.** Optional, and unrelated to the workflow itself.
|
||||
On Pro / Max / Teams accounts, where rate limits are available:
|
||||
|
||||
```
|
||||
◦ ◦ Opus 5 / high │ plan2code │ feature/pathfinder-github-iss │ +12 -3
|
||||
╭●╮ ┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
|
||||
├■┤ 3h 5m ($4.62) │ ▰▰▰▰▰▱▱▱▱▱▱▱ 42% (84K) │ 5h: 28% · 7d: 61%
|
||||
╭───╮ Opus 5 / high │ plan2code │ feature/pathfinder-github-iss │ +12 -3
|
||||
│ ★ │ ┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
|
||||
╰┬─┬╯ 3h 5m ($4.62) │ ▰▰▰▰▰▱▱▱▱▱▱▱ 42% (84K) │ 5h: 28% · 7d: 61%
|
||||
```
|
||||
|
||||
On Enterprise / Bedrock / Vertex / pay-as-you-go, where they aren't, the last segment becomes session
|
||||
token counts instead:
|
||||
|
||||
```
|
||||
◦ ◦ Sonnet 5 │ plan2code │ main │ +12 -3
|
||||
╭●╮ ┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
|
||||
├■┤ 2m ($0.18) │ ▰▰▱▱▱▱▱▱▱▱▱▱ 18% │ 88k in · 3k out
|
||||
╭───╮ Sonnet 5 │ plan2code │ main │ +12 -3
|
||||
│ ★ │ ┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
|
||||
╰┬─┬╯ 2m ($0.18) │ ▰▰▱▱▱▱▱▱▱▱▱▱ 18% │ 88k in · 3k out
|
||||
```
|
||||
|
||||
The icons down the left are Planny, the project mascot.
|
||||
@@ -36,7 +36,7 @@ The icons down the left are Planny, the project mascot.
|
||||
## Install
|
||||
|
||||
```bash
|
||||
node install.js # A (everything + dev tools) — or C → S (status line only)
|
||||
node install.js # A → E (everything + dev tools) or A → S (status line only)
|
||||
```
|
||||
|
||||
That copies the script to `~/.claude/plan2code-statusline.js`, writes a default config to
|
||||
|
||||
@@ -19,7 +19,7 @@ Built for **maintainers**. If you're using Plan2Code to ship features, you don't
|
||||
## Install
|
||||
|
||||
```bash
|
||||
node install.js # I (everything) — or C → B (bot only)
|
||||
node install.js # A → E (everything + dev tools) or A → B (bot only)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
@@ -1,103 +1,174 @@
|
||||
# Walkthrough: one feature, start to finish
|
||||
|
||||
A REST API for task management, from a sentence to archived specs. Every block below is a **separate
|
||||
conversation** — that's the whole trick.
|
||||
A REST API for task management goes from a sentence to archived specs, all on the web console.
|
||||
Each session stays short, and the specs on disk carry everything from one session to the next.
|
||||
|
||||
← [Back to README](../README.md)
|
||||
|
||||
---
|
||||
|
||||
## Session 1 — Plan
|
||||
## Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first.
|
||||
|
||||
Not installed yet? The install steps are in the [README](../README.md#install-and-start).
|
||||
|
||||
---
|
||||
|
||||
## Session 1: Plan
|
||||
|
||||
Run `plan2code` in the project (or `/plan2code` inside your agent). The dashboard opens in your
|
||||
browser with every step laid out as a card.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/dashboard-dark.webp">
|
||||
<img src="../docs/screenshots/dashboard-light.webp" alt="The Plan2Code dashboard: a Set up card, then the steps in order as cards, one of them marked Suggested.">
|
||||
</picture>
|
||||
|
||||
Pick **Plan** and describe the idea in the box: *I want to build a REST API for a task management
|
||||
application.* The same page turns into the Plan session.
|
||||
|
||||
The questions arrive in batches of up to three, each option with its trade-off written underneath.
|
||||
Answer what is there and press **Send to Plan2Code**; the next batch follows.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/question-dark.webp">
|
||||
<img src="../docs/screenshots/question-light.webp" alt="A Plan question card, How tasks are paged, with three options, the first marked Suggested, each with its trade-off underneath.">
|
||||
</picture>
|
||||
|
||||
The phase breakdown comes back as a list you can reorder and edit. Documents a skill writes on the
|
||||
page open as tabs like this one, where settled parts read as decisions and anything still a guess
|
||||
is marked as assumed and still open.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/doc-dark.webp">
|
||||
<img src="../docs/screenshots/doc-light.webp" alt="The What we've agreed tab for the task API: a settled summary, an assumed section on paging with a dashed edge, and a dimmed draft list of what is still to work out.">
|
||||
</picture>
|
||||
|
||||
Plan proposes a tech stack, Fastify + Postgres + Zod, and does not pick it alone: a sign-off card
|
||||
asks you to approve it. Plan then designs the architecture. At 92% confidence (the gate is 90%) it
|
||||
asks whether to write the draft, and with 3 assumptions written down, it writes:
|
||||
|
||||
```
|
||||
You: /plan2code-1-plan
|
||||
I want to build a REST API for a task management application.
|
||||
|
||||
AI: 🤔 [REQUIREMENTS ANALYSIS]
|
||||
Six questions. Four of them I need answered before I can size this.
|
||||
...
|
||||
|
||||
AI: 🤔 [TECH STACK]
|
||||
Proposing Fastify + Postgres + Zod. I don't pick this alone — sign off?
|
||||
|
||||
You: approved
|
||||
|
||||
AI: 🤔 [ARCHITECTURE DESIGN]
|
||||
...
|
||||
|
||||
AI: 🤔 [TRANSITION DECISION]
|
||||
Confidence: 92% (gate is 90%). Assumptions written to the draft: 3.
|
||||
→ specs/task-api/PLAN-DRAFT-20260804.md
|
||||
specs/task-api/PLAN-DRAFT-20260804.md
|
||||
```
|
||||
|
||||
Two files land: the draft, and a `PLAN-CONVERSATION-*.md` log of how you got there.
|
||||
Two files land: the draft, and a `PLAN-CONVERSATION-*.md` log of how you got there. The finish
|
||||
card names the next step.
|
||||
|
||||
> **Started foggy instead?** Run `/plan2code-0-pathfinder` first. When its map clears it writes a
|
||||
> `PLAN-DRAFT` that Step 1 picks up at Phase 4, with requirements and scope already answered.
|
||||
> `PLAN-DRAFT` that Plan picks up at Phase 4, with requirements and scope already answered.
|
||||
|
||||
---
|
||||
|
||||
## Session 2 — Document
|
||||
## Session 2: Document
|
||||
|
||||
On Plan's finish card, press **Back to the dashboard** (or start a fresh console session if the
|
||||
session meter says so; see Session 3 below). Pick **Document**, with `specs/task-api` selected in
|
||||
the picker at the top. It reads `specs/task-api/PLAN-DRAFT-20260804.md`.
|
||||
|
||||
The overview and each phase file appear as tabs as they are written, so you watch the spec take
|
||||
shape:
|
||||
|
||||
```
|
||||
You: /plan2code-2-document
|
||||
specs/task-api/PLAN-DRAFT-20260804.md
|
||||
|
||||
AI: 📝 [DOCUMENTATION]
|
||||
Creating specs/task-api/overview.md
|
||||
Creating specs/task-api/Phase 1.md Project setup (6 tasks)
|
||||
Creating specs/task-api/Phase 2.md Data model (8 tasks)
|
||||
Creating specs/task-api/Phase 3.md API endpoints (11 tasks)
|
||||
Creating specs/task-api/Phase 4.md Authentication (7 tasks)
|
||||
|
||||
Parallel execution groups: Phase 3 and Phase 4 don't share files.
|
||||
specs/task-api/overview.md
|
||||
specs/task-api/phase-1.md Project setup (6 tasks)
|
||||
specs/task-api/phase-2.md Data model (8 tasks)
|
||||
specs/task-api/phase-3.md API endpoints (11 tasks)
|
||||
specs/task-api/phase-4.md Authentication (7 tasks)
|
||||
```
|
||||
|
||||
Parallel execution groups: Phase 3 and Phase 4 don't share files.
|
||||
|
||||
---
|
||||
|
||||
## Sessions 3…N — Implement, one phase each
|
||||
## Sessions 3 to N: Implement, one phase each
|
||||
|
||||
```
|
||||
You: /plan2code-3-implement
|
||||
specs/task-api/overview.md
|
||||
Look at the session meter in the top bar first. Plan and Document add 2 points each, so after
|
||||
those two the meter is at 4: **Session: getting long**, in yellow. That is the cue to close this
|
||||
console session and start a fresh one for the build (run `plan2code` again). This is the first of
|
||||
the four rules:
|
||||
|
||||
AI: ⚡ [PHASE 1: Project setup]
|
||||
(Phase 1 is the next unchecked phase.)
|
||||
...
|
||||
✓ 6/6 tasks. Checkboxes updated in Phase 1.md and overview.md.
|
||||
Next: Phase 2 — Data model (8 tasks). New conversation.
|
||||
```
|
||||
> **1 · Keep each session short.**
|
||||
> Chaining a couple of small skills on the dashboard is fine. Start a fresh console session when the session meter turns red, and always before a big planning or build step. The specs on disk carry everything between sessions.
|
||||
|
||||
Repeat. New conversation each time. It always finds the next open phase itself.
|
||||
On the fresh dashboard, pick **Implement** for `specs/task-api`. Phase 1 (Project setup) is the next
|
||||
unchecked phase, so it starts there. The page shows the build as it goes: a progress bar counting
|
||||
tasks, the phase's task list ticking as each task lands on disk, and a line beside Planny saying
|
||||
what it is doing now. Use the **Ask** tab for a quick question without interrupting the build.
|
||||
|
||||
When you reach a parallel group, it offers you the choice — open a second agent, take the other
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/build-dark.webp">
|
||||
<img src="../docs/screenshots/build-light.webp" alt="A phase of a task API being built: 5 of 11 done on the progress bar, and the phase's task list with the first five ticked.">
|
||||
</picture>
|
||||
|
||||
When all 6 of 6 tasks are ticked in `phase-1.md`, a **Completion report** tab opens with the
|
||||
sign-off card: **Review the code first**, **Approve this phase**, or **I want changes**.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/signoff-dark.webp">
|
||||
<img src="../docs/screenshots/signoff-light.webp" alt="The Approve this phase card, with a button to read the completion report and three choices: Review the code first, Approve this phase, and I want changes.">
|
||||
</picture>
|
||||
|
||||
After you approve, `overview.md` marks Phase 1 done, and the finish card gives the next command:
|
||||
Phase 2, Data model (8 tasks), in a new session.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/finish-dark.webp">
|
||||
<img src="../docs/screenshots/finish-light.webp" alt="The finished screen after a phase sign-off: the phase is built, the next implement command with a Copy button, and a Back to the dashboard button.">
|
||||
</picture>
|
||||
|
||||
Repeat. A fresh session each time. It always finds the next open phase itself.
|
||||
|
||||
When you reach a parallel group, it offers you the choice: open a second agent, take the other
|
||||
phase, and the `[/]` marks keep them from colliding.
|
||||
|
||||
**Optional, any time:** `/plan2code-review` for an independent second opinion on what just landed.
|
||||
Pick **Implement + review** instead when review should run automatically before phase approval.
|
||||
**Review** remains available on the dashboard for an independent second opinion at any other time.
|
||||
|
||||
---
|
||||
|
||||
## Final session — Finalize
|
||||
## Final session: Finalize
|
||||
|
||||
```
|
||||
You: /plan2code-4-finalize
|
||||
specs/task-api/overview.md
|
||||
With every phase approved, the dashboard suggests **Finalize** for `specs/task-api`. Pick it in a
|
||||
fresh session. Each check lands on the page as a report tab, and anything that needs your say is
|
||||
a card:
|
||||
|
||||
AI: 🧹 [VALIDATION]
|
||||
All 32 tasks verified against the phase specs. 2 gaps found and fixed.
|
||||
- **Validation.** All 32 tasks verified against the phase specs. 2 gaps found and fixed.
|
||||
- **Documentation review.** README needs the new `/tasks` endpoints; AGENTS.md is current. A card
|
||||
lists the proposed doc updates, and you tick the ones to make.
|
||||
- **Spec cleanup.** A confirm card, then `specs/task-api/` moves to `specs--completed/task-api/`.
|
||||
|
||||
AI: 🧹 [DOCUMENTATION REVIEW]
|
||||
README needs the new /tasks endpoints. AGENTS.md is current.
|
||||
|
||||
AI: 🧹 [SPEC CLEANUP]
|
||||
Moved specs/task-api/ → specs--completed/task-api/
|
||||
|
||||
Implementation complete.
|
||||
```
|
||||
The finish card says the implementation is complete, and gives the commit command when doc
|
||||
updates landed.
|
||||
|
||||
---
|
||||
|
||||
## If requirements move mid-build
|
||||
|
||||
Don't patch the code and hope the specs catch up. Run `/plan2code-1b-revise-plan` — it edits the
|
||||
specs (and only the specs), so the drawing and the build stay in agreement.
|
||||
Don't patch the code and hope the specs catch up. Pick **Revise the plan** on the dashboard: it
|
||||
edits the specs (and only the specs), so the drawing and the build stay in agreement.
|
||||
|
||||
---
|
||||
|
||||
## Prefer the terminal?
|
||||
|
||||
The same journey is four commands, each in a new conversation:
|
||||
|
||||
1. `/plan2code-1-plan` with the idea in a sentence. Writes `specs/task-api/PLAN-DRAFT-20260804.md`.
|
||||
2. `/plan2code-2-document specs/task-api/PLAN-DRAFT-20260804.md`. Writes the overview and phase files.
|
||||
3. `/plan2code-3-implement specs/task-api/overview.md`, once per phase. It finds the next open phase itself.
|
||||
4. `/plan2code-4-finalize specs/task-api/overview.md`. Verifies, updates docs, and archives the spec.
|
||||
|
||||
Add `--web` to any of them (for example `/plan2code-1-plan --web`) to open that step straight on the
|
||||
web console without being asked. Every command and argument is in the README's
|
||||
[Prefer the terminal?](../README.md#prefer-the-terminal) section. You can switch between terminal and
|
||||
console at any point, because the files under `specs/` are the only state.
|
||||
|
||||
## More
|
||||
|
||||
- [web-console.md](web-console.md): every screen, setting and recovery path
|
||||
- [../QUICK-REFERENCE.md](../QUICK-REFERENCE.md): the one-page card
|
||||
@@ -0,0 +1,380 @@
|
||||
# Plan2Code Web Console: design proposal
|
||||
|
||||
**Status:** implemented in v2.4.0. Kept as the design record, because it explains
|
||||
*why* the thing is shaped the way it is. For how to use it, see
|
||||
[web-console.md](./web-console.md); for where the code lives, see
|
||||
[AGENTS-architecture.md](../.agents-docs/AGENTS-architecture.md).
|
||||
**Date:** 2026-09-20
|
||||
**Scope:** an optional local browser UI that `plan2code-0-pathfinder` and `plan2code-1-plan` can offer at startup, built as a shared component other workflow steps can adopt later.
|
||||
|
||||
---
|
||||
|
||||
## 1. Why this is smaller than it looks
|
||||
|
||||
Pathfinder is already written against a *delivery-channel abstraction*. Its rules say:
|
||||
|
||||
> AskUserQuestion when available; prose Q blocks only as fallback.
|
||||
|
||||
and `grilling.md` specifies the question object in full: a plain two-or-three-word header, the probe with its why-it-matters, two to four genuine options each described by its trade-off with exactly one named as the recommendation, plus an automatic `Other` escape hatch.
|
||||
|
||||
That is a form. The console is not a new workflow, it is a **third delivery channel** alongside the structured tool and prose. The methodology, the file formats, the gates and the rules are untouched.
|
||||
|
||||
Plan is the opposite: pure prose Q and A with seven phases and four named approval gates. But every one of its gates already resolves to a literal typed token (`approved`, `needs changes`, `approve / refine / abort`). That gives us the second half of the idea.
|
||||
|
||||
### The keystone: answers map back to the literal token
|
||||
|
||||
Every console request carries two extra fields:
|
||||
|
||||
| Field | Purpose |
|
||||
| --- | --- |
|
||||
| `fallbackText` | the exact terminal phrasing the prompt would have printed |
|
||||
| `token` | what each button resolves to: `approved`, `H`, `A`, `S 1,3,5`, `yes`, `skip` |
|
||||
|
||||
Clicking **Approve** in the browser is then byte-identical to typing `approved` in the terminal. No prompt logic ever forks. If the console is absent, refused, or times out, the agent prints `fallbackText` and the session continues in the terminal with nothing lost. Mid-session switching in either direction is free, because the markdown files under `specs/` remain the only source of truth.
|
||||
|
||||
This one decision is what keeps the integration from metastasising across twelve prompt files.
|
||||
|
||||
---
|
||||
|
||||
## 2. Hard constraints found during research
|
||||
|
||||
These are verified, not assumed. They shape everything below.
|
||||
|
||||
### 2.1 The character limit is the binding constraint
|
||||
|
||||
`scripts/validate-char-count.js` caps every flat `src/plan2code-*.md` at 20,000 characters since 2.4.1 (11,000 when the numbers below were measured), enforced by a husky pre-commit hook. Measured today:
|
||||
|
||||
```
|
||||
10995 5 plan2code-0-pathfinder.md <- 5 characters of headroom
|
||||
10676 324 plan2code-1-plan.md
|
||||
10835 165 plan2code-2-document.md
|
||||
```
|
||||
|
||||
Neither target prompt can absorb the integration inline. **Trimming pathfinder by roughly 250 characters is a prerequisite task, not a nice-to-have.** Reference files are exempt from the limit, so all of the console contract lives in one.
|
||||
|
||||
### 2.2 Packaging needs zero installer code changes
|
||||
|
||||
`computeExpectedSkills()` in `install.js` copies `additionalReferences` directories verbatim through `listFilesRecursive()`, which has no extension filter. The initial implementation fanned one shared source directory into two skills; the current installer fans it into every skill.
|
||||
|
||||
Current packaging constraints:
|
||||
|
||||
- Reference files are copied as `Buffer`s, so binary assets are supported; the shipped MP3 chimes exercise this path. Browser-served assets must also be added to the server's `SERVABLE` allow-list and covered by a test.
|
||||
- `skills/` is generated build output (committed, and checked for drift by `npm test`) and `buildSkills()` prunes files it doesn't expect. Assets must originate in `src/` and never be hand-placed.
|
||||
|
||||
### 2.3 `specs/` is gitignored, which is an argument *for* the server
|
||||
|
||||
Three prompts repeat the warning that Glob silently fails on `specs/` and only a shell listing works. A Node server enumerating candidate spec directories server-side and handing the page a list is strictly better than either a terminal listing or a browser file input.
|
||||
|
||||
### 2.4 Formats that must round-trip byte for byte
|
||||
|
||||
- `<!-- METRICS_JSON {...} -->` comments
|
||||
- the `## User Feedback` table (exact field names `Rating`, `Reason`, `Went Well`, `Went Poorly`, pipes escaped as `\|`)
|
||||
- the five-state checkbox alphabet `[ ]` `[/]` `[x]` `[?]` `[!]`, with the invariant "never reset `[/]` to `[ ]`"
|
||||
- the handoff string `**Status:** Phase 3 Complete - Resume at Phase 4`, plain ASCII hyphen, single spaces
|
||||
|
||||
The console carries all of these as opaque strings and never reformats them.
|
||||
|
||||
### 2.5 Two regex landmines
|
||||
|
||||
- `plan2code-metrics` scrapes confidence with patterns like `/[Rr]equirements?[:\s|]+(\d{1,2})/` that **do not require a percent sign**. Nothing the console writes under `specs/` may contain bare `Requirements` / `Feasibility` / `Integration` / `Risk` followed by a number.
|
||||
- The loop parses `TASK_COMPLETE`, `PHASE_COMPLETE` and friends. Pathfinder already forbids these tokens under `specs/`.
|
||||
|
||||
Both are cheap to enforce mechanically in the server's write path.
|
||||
|
||||
---
|
||||
|
||||
## 3. Architecture
|
||||
|
||||
### 3.1 Placement
|
||||
|
||||
```
|
||||
src/web-console/
|
||||
console.mjs CLI: open | post | wait | status | stop
|
||||
server.mjs the HTTP server (spawned detached by `open`); routes.mjs lists its URLs
|
||||
files.mjs, sessions.mjs, patches.mjs, scan.mjs, ... paths, atomic writes, patch merge, validate(), the repo scan
|
||||
console.md the agent-facing contract
|
||||
public/index.html markup shell only
|
||||
public/app.js the client's entry (no inline script, see CSP below); screens/ and state.js hold the rest
|
||||
public/styles/ the stylesheet, joined by the server into /app.css
|
||||
public/render.js markdown tokens to DOM nodes
|
||||
public/vendor/marked.esm.js pinned 15.0.7, MIT, lexer only
|
||||
```
|
||||
|
||||
Wired in with one data entry per consumer:
|
||||
|
||||
```js
|
||||
{
|
||||
source: 'plan2code-0-pathfinder.md',
|
||||
// ...
|
||||
additionalReferences: [{ source: 'web-console', target: 'web-console' }]
|
||||
}
|
||||
```
|
||||
|
||||
Lands at `~/.agents/skills/<skill>/references/web-console/` on all ~28 target agents. The server finds its own siblings via `path.dirname(fileURLToPath(import.meta.url))`.
|
||||
|
||||
The agent needs an absolute path to invoke it. `ai-assist-git-pr` already establishes the convention, proven on Windows, and we reuse its wording:
|
||||
|
||||
> `<SKILL_ROOT>` = the directory containing this `SKILL.md` (its install location). Use the absolute path you loaded it from.
|
||||
|
||||
### 3.2 The transport, which is the genuinely hard part
|
||||
|
||||
A turn-based agent must wait up to twenty minutes for a human. Claude Code's Bash tool caps at 600s and **harness-managed background tasks are not a safe place to wait**: there are open issues documenting them being killed at 5 to 20 minutes, killed on compaction, killed when a new prompt arrives, and leaked with no handle when spawned by subagents. Detached processes are explicitly immune.
|
||||
|
||||
So: **split into two processes with deliberately different lifetimes.**
|
||||
|
||||
```
|
||||
# once, at handoff
|
||||
node <SKILL_ROOT>/references/web-console/console.mjs open --file request.json
|
||||
-> spawns server.mjs DETACHED, prints URL + session id, exits in under 300ms
|
||||
|
||||
# repeatedly, until done
|
||||
node ... console.mjs wait --seconds 240
|
||||
exit 0 -> stdout is the result JSON. Done.
|
||||
exit 10 -> {"status":"waiting","elapsed":"6m12s","answered":3,"total":7,...}
|
||||
Agent relays one line to the user and calls wait again.
|
||||
exit 20 -> server is dead. Agent restarts it, re-reports the URL.
|
||||
exit 30 -> human hit Cancel.
|
||||
```
|
||||
|
||||
Why bounded rather than a single long block:
|
||||
|
||||
- The deadline lives in our code, not the harness's. `--seconds 240` covers a 20-minute session in five turns. Drop to `--seconds 90` for harnesses with a 120s default (Cursor auto-backgrounds and cannot be told not to).
|
||||
- Every return is a free heartbeat: "still waiting, 3 of 7 answered, 6 minutes in" beats silence.
|
||||
- Interruption is survivable. Ctrl-C the agent, compact the context, restart: the next `wait` re-attaches, because state is on disk.
|
||||
|
||||
The waiter uses `fs.watch` on the session **directory** (watching a file breaks on Windows when the file is replaced by rename) with a 500ms `stat` fallback as the authority, and pings `/health` every 5s for liveness. The result is delivered **through the filesystem**, not HTTP, which decouples the waiter from the server and is also the resumability story.
|
||||
|
||||
**Optional push accelerator, Claude Code only:** at `start`, also fire a backgrounded `until [ -f <dir>/result.json ]; do sleep 2; done`. If it survives, submit-to-agent latency drops to near zero. If it gets killed, nothing breaks, because the poll loop is the source of truth.
|
||||
|
||||
### 3.3 Port, lifecycle, security
|
||||
|
||||
| Concern | Decision |
|
||||
| --- | --- |
|
||||
| Port | `listen(0, '127.0.0.1')`, handle file in `os.tmpdir()/<tool>/<sha1(cwd).slice(0,8)>/`. This is Jupyter's `jpserver-<pid>.json` pattern and RFC 8252 §7.3. A fixed port is fatal here: you run git worktrees, so two agents in two checkouts of one repo is routine, and a fixed port makes that silently wrong. |
|
||||
| Bind | the literal `127.0.0.1`, never `0.0.0.0`, never the string `localhost` (which may resolve to `::1` and produce the classic "server is up but the browser gets ECONNREFUSED" bug on Windows). |
|
||||
| Auto-open | best-effort, never fatal. Skip when `DISPLAY` and `WAYLAND_DISPLAY` are both unset, or `SSH_CONNECTION` / `REMOTE_CONTAINERS` is set. Honour `BROWSER=` and `--no-open`. |
|
||||
| Orphan prevention | a **server-side idle deadline** (30 min, bumped by any authenticated request) is the mechanism, not a nicety. Windows has no real SIGTERM, and a detached server with no console never sees `SIGINT`, so signal handlers cannot be relied on. Plus a 4h absolute cap, a `pagehide` beacon, an explicit `stop`, and a reap sweep on every `start`. |
|
||||
| Liveness test | `process.kill(pid, 0)` **and** a `/health` check whose returned session id matches the handle. PID reuse is real; the sid match is what disambiguates. |
|
||||
|
||||
Security, six controls, about 60 lines:
|
||||
|
||||
1. Bind `127.0.0.1`.
|
||||
2. **`Host` header allowlist.** This is the DNS-rebinding defence and the highest-value line in the server. Vite shipped GHSA-vg6x-rcgg-rjx6 for exactly this omission.
|
||||
3. 128-bit token **in the URL path**, not the query string. Path placement also kills the Windows `cmd /c start` `&`-injection hazard, because the URL then contains no `&`.
|
||||
4. First `GET /s/<token>/` sets `HttpOnly; SameSite=Strict` cookie and 302s to `/`. Token leaves the address bar, history and pasted screenshots; CSRF protection comes free.
|
||||
5. `Origin` check on every mutating request.
|
||||
6. Strict CSP with no `unsafe-inline`, which is why JS and CSS are separate files rather than one inlined HTML.
|
||||
|
||||
**On whether XSS matters here.** The tempting argument is "it is the user's own machine and the model would not write `<script>`". That misses the real risk. The page is same-origin with a server that reads and writes the user's files and holds the session token, so script in that page can post arbitrary answers back to the agent, which then acts on them with the agent's full tool permissions. And the markdown is only nominally agent-authored: in practice the agent is summarising a dependency README, a scraped page, a PR description, a log. Treat it as attacker-controlled.
|
||||
|
||||
The structural fix, rather than a filter: **vendor `marked` for `lexer()` only and render tokens to the DOM with `createElement` and `textContent`.** No HTML string is ever produced, so there is nothing for a sanitiser bypass to bypass, and the strict CSP holds. Roughly 120 lines of renderer. Hand-rolling the parser instead is a trap: hand-rolled markdown fails exactly where agent-authored technical documents live (a table inside a list item, a fenced block containing backticks) and its failure mode is usually an injection hole.
|
||||
|
||||
### 3.4 Browser transport
|
||||
|
||||
SSE primary (about fifteen lines on Node's built-in `http`), with automatic fallback to 3s interval polling after three consecutive errors. **Exactly one `EventSource` per page, ever**: browsers cap HTTP/1.1 at ~6 connections per origin, and a second stream per tab across three tabs wedges the origin with no error and no timeout. Multiplex everything through one stream with a `type` field.
|
||||
|
||||
The page shows the **agent's** liveness, not the server's. If the agent's turn crashed, the server is still happily up and a naive spinner lies forever. Stamp `agentLastSeen` on every waiter ping; when stale past two minutes the page says so plainly: "The agent has not checked in for 4 minutes. Your answers are saved. Check your terminal."
|
||||
|
||||
### 3.5 State on disk
|
||||
|
||||
The filesystem is the database and the result transport.
|
||||
|
||||
```
|
||||
~/.plan2code/console/sessions/<sid>/
|
||||
session.json sid, cwd, workflow, title, phase
|
||||
request-<rev>.json the agent's payload, immutable per revision
|
||||
draft.json in-progress answers, debounced ~500ms write
|
||||
result.json written ATOMICALLY on submit (temp + fsync + rename)
|
||||
events.ndjson append-only, doubles as SSE Last-Event-ID replay
|
||||
```
|
||||
|
||||
Deliberately **not** under `specs/`: that keeps the console clear of the metrics scraper and the loop's marker parser, and survives a `git clean`.
|
||||
|
||||
Draft persistence is the highest-value feature in the tool and among the cheapest. Twenty minutes of a product manager's structured answers must never be lost to a closed tab. Server-side debounced write plus a `localStorage` mirror keyed by `sid + rev`.
|
||||
|
||||
Recovery matrix:
|
||||
|
||||
| Failure | Recovery |
|
||||
| --- | --- |
|
||||
| Tab closed or browser crashed | Reopen the URL, draft restored, agent never notices |
|
||||
| Server died, agent alive | `wait` returns exit 20, agent runs `start --resume <sid>`, new port, same session dir |
|
||||
| **Agent session died, human still working** | Human submits, `result.json` lands on disk. A fresh session runs `status`, finds the unconsumed result, picks up where it left off |
|
||||
| Machine rebooted | Handle file is gone (correct), session dir survives, `--resume` works |
|
||||
|
||||
---
|
||||
|
||||
## 4. The interaction contract
|
||||
|
||||
### 4.1 Item envelope
|
||||
|
||||
```jsonc
|
||||
{
|
||||
"id": "i7", "topic": "t2", "kind": "choice",
|
||||
"title": "Export format", // PLAIN 2-4 words, never internal jargon
|
||||
"body": "markdown: the probe plus its why-it-matters",
|
||||
"options": [ { "k": "A", "text": "CSV", "detail": "trade-off", "recommended": true } ],
|
||||
"allowOther": true,
|
||||
"required": true,
|
||||
"status": "open",
|
||||
"answer": null,
|
||||
"thread": [],
|
||||
"fallbackText": "the exact terminal phrasing",
|
||||
"token": { "A": "a", "B": "b" } // maps a click back to the literal reply
|
||||
}
|
||||
```
|
||||
|
||||
Note `recommended` is **optional per option**. Handoff explicitly wants its inferred task offered as the recommendation.
|
||||
|
||||
### 4.2 Primitives
|
||||
|
||||
Tier 1, needed for pathfinder and plan, build now:
|
||||
|
||||
| Kind | Covers |
|
||||
| --- | --- |
|
||||
| `choice` | Step 0 intent gate, all six destination probes, the 14 frontier axes, plan's coverage and scope questions |
|
||||
| `multi` | plan's testing types (Unit / Integration / E2E / None) |
|
||||
| `text` | sacrificial boundary, the embarrassment question, kebab-case feature name **with live pattern validation the terminal cannot do** |
|
||||
| `confirm` | the Tier-2 sketch gate, the lock offer, abort confirmations |
|
||||
| `recap` | the recap-and-confirm turn. Non-skippable by design |
|
||||
| `review` | plan's four approval gates, `1b`'s spec-update gate, paper-sketch reactions |
|
||||
| `checklist` | `legwork · HITL`: numbered steps plus Done / Blocked / Need help / Defer plus a values field |
|
||||
| `menu` | the fork menu: up to three takeable questions plus Start fresh, one recommended, with the resume command as copy-to-clipboard |
|
||||
| `list` | orderable and editable rows, for plan Phase 6's implementation phases |
|
||||
|
||||
Tier 2, design the schema to admit them but do not build yet: `findings-triage`, `table-review`, `form`, `path-picker`, `command-handoff`, `notice`, `progress`.
|
||||
|
||||
### 4.3 Rules the server enforces mechanically
|
||||
|
||||
Several prose rules become checks, which is the quiet advantage of routing through a server at all:
|
||||
|
||||
- **Reject a patch leaving more than three open required items.** Grilling says "the cap is three regardless of what the environment allows. The ceiling is the human's attention, not the tool's schema." A web UI tempts you to show ten. Make the rule mechanical.
|
||||
- **Reject internal jargon in `title`**: `grill`, `frontier`, `fog`, `HITL`, `Locked:`, `Blocked by:`. There is an explicit do-not-say list in `grilling.md`; this is where to enforce it.
|
||||
- **One authoritative gate per session.** `plan2code-3-implement-review` proves several prompts each carry an approval gate while only one may fire when composed. A `gate: { id, authoritative }` field plus a server guard.
|
||||
- **Defer is a third verb**, distinct from reject.
|
||||
- Reject forbidden tokens and bare confidence-word-plus-number patterns in anything written under `specs/`.
|
||||
- Stamp every timestamp server-side. Models do not reliably know the time.
|
||||
|
||||
---
|
||||
|
||||
## 5. The UI
|
||||
|
||||
Three panes, plus view tabs, closer to pathfinder's own vocabulary than to a grilling UI.
|
||||
|
||||
```
|
||||
┌──────────────────────────────────────────────────────────────────────┐
|
||||
│ 🧭 audit-export · Pathfinder · Working 4 of 9 cleared ▓▓▓▓░░░░░ │
|
||||
│ ● Waiting on you · 3 questions [Questions] [Map] [Draft] │
|
||||
├───────────────┬──────────────────────────────┬───────────────────────┤
|
||||
│ THE MAP │ What you end up with │ DISCUSSION │
|
||||
│ │ │ │
|
||||
│ ✓ Destination │ Why this matters: ... │ thread on this item │
|
||||
│ ✓ Codebase │ │ │
|
||||
│ ● Export fmt │ ○ A CSV, ... │ │
|
||||
│ ○ Size cap │ ◉ B Parquet RECOMMENDED │ │
|
||||
│ ⊘ Retention │ ○ C Both, ... │ │
|
||||
│ │ ○ Something else ______ │ │
|
||||
│ NOT YET CLEAR │ │ │
|
||||
│ · fog item │ Not sure, skip for now │ │
|
||||
├───────────────┴──────────────────────────────┴───────────────────────┤
|
||||
│ 2 staged · Export format → B · +1 comment ⌘↩ [Send to Agent] │
|
||||
└──────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### What to take from grill-with-ui
|
||||
|
||||
- **Batch staging with one explicit Send.** Everything is local and reversible until one deliberate press. For a non-technical user this removes the terror of "did I just commit to that?"
|
||||
- **The three-tier commitment vocabulary**: staged (amber, removable) → sent and pending (dashed, spinner) → recorded (green check). Honoured consistently on every surface.
|
||||
- **The whole stuck-agent apparatus**: live elapsed counter, disabled Send while working, a five-minute grace that re-enables Send with an explanation, server-gone detection with self-reconnect. About 40 lines, and more honest about agent latency than most commercial agent UIs.
|
||||
- **Assumed regions.** The best idea in that repo: the generated artifact marks regions that depend on still-open questions with a dashed outline and "assumed, pending Q3". This transplants directly onto a plan taking shape.
|
||||
- **Versioned artifacts with a staleness flag** and a one-line change note.
|
||||
- `withInputs()` focus preservation, raw-string diffing before re-render, and the `prefers-reduced-motion` handling that keeps progress indicators legible rather than freezing them.
|
||||
|
||||
### What to change
|
||||
|
||||
- **Topics, not rounds.** Grill groups the nav by round, which is a temporal artifact: "questions the agent happened to ask on turn 4". Its own sample data has one round containing three unrelated subjects. Product people cannot use that. Group by topic, stable and nameable.
|
||||
- **Show real progress.** Grill has no "N of M" counter at all. Pathfinder's trail footer already computes `4/9 cleared` and a plain-English confidence line. Put both in the header. In a 45-minute session with a PM, "how much longer is this" is the first question asked.
|
||||
- **Recommendations become optional.** Grill always leads with one, which is right when the agent has an opinion and you are pushing on it. In discovery the agent frequently should not have an opinion, and pre-filling one anchors a PM into rubber-stamping. Neutral mode: no `rec`, or reframed as "what similar products do".
|
||||
- **Real, accessible form controls.** Grill's options are `<li>` with `onclick`, so they are unreachable by keyboard and invisible to screen readers. Non-negotiable to fix if non-technical stakeholders are in scope.
|
||||
- **Markdown actually renders.** Grill escapes everything and sets `white-space: pre-line`; there is no markdown at all. A plan document cannot be shown that way.
|
||||
- **Rename everything.** "Grill", "durable", "Defer", "Reopen", "Why A." is a vocabulary for interrogating an engineer who already has a plan.
|
||||
- **Do not dim rejected options to 45%.** In discovery the rejected options are often the most valuable thing in the room, and an engineer joining late needs to see why B lost.
|
||||
|
||||
### Two things the console unlocks that the terminal cannot
|
||||
|
||||
- **Tier-2 UI sketches.** `resolve.md` already sanctions building 3 to 5 structurally different UI variants switched by "a URL search param plus a small floating bar". The console can host them in a sandboxed iframe with a proper variant switcher. This is already in the methodology and currently awkward.
|
||||
- **Anchored reactions.** `resolve.md` insists every sketch probe "names its row or element". With `anchors: { "row5": "b3" }`, clicking the probe highlights the row. That is the inline-commenting capability, scoped to something the methodology already demands.
|
||||
|
||||
### Room-screen polish (v2.4.0)
|
||||
|
||||
Built for a mixed product and engineering room reading one screen together.
|
||||
|
||||
- **One width variable.** `--card-width` on `:root` in `styles/tokens.css` sets the column the card, the pager and the document tabs share (`max-width: min(var(--card-width), 100%)`, so a narrow window still wins); no fixed `720px` column rule is left outside a media query. Three presets, picked under *Card width* in the looks panel and saved as `looks.width`: `narrow` 720px, `comfortable` 880px (the default, and the variable's own value), `wide` 1080px, applied as `:root[data-width="…"]`. `CARD_WIDTHS` in `palette.js` is the same list for the page's validation and the server's first-paint `data-width`; **`palette.js` and `app.css` must agree**, which is the one place the number is written twice. The dashboard keeps its own 860px layout. Inside the card the `62ch` / `68ch` measure caps come off (`.card .md, .card .prompt { max-width: none; }`) so a wider card is not a narrow column in a wide frame; documents keep `.md`'s 68ch.
|
||||
- **One box grows.** On the primary card, the answer box that is being typed in — a `text` question's box, a choice's *Something else* box once picked, or the note under a verdict / confirm / recap once shown — is `textarea.grow`, and the card takes the column's full height above the pager (`.card.is-primary.has-grow { flex: 1 1 auto; }`). `fitGrowBox()` in `app.js` writes the card's free height as the box's `min-height`, **never under 160px**; a `ResizeObserver` watches the main column rather than the box, so the box growing can never retrigger it, and it writes only on a change over 1px. `resize: vertical` with that moving floor makes the handle taller-only; past the fill the card scrolls. Every other box keeps its ordinary size, and the notes panel is untouched.
|
||||
- **A switch per sound.** Every cue is an event in `SOUND_EVENTS` (`palette.js`), each naming its file and rank: `startSkill` (`start-skill.mp3`, played once the dashboard's **Start** is accepted) 5, `bootup` 4, `sessionStart` / `sessionEnd` (`start-stop.mp3`) 3, `question` / `skillReady` / `chatReply` (`next.mp3`) 2, `newTab` (`insert.mp3`) 1, `snore` (`sleeping.mp3`, looped by the wake-up outside the queue) 0. The queue, the held slot and the one-at-a-time rule in `app.js` work on events, one `Audio` per file shared by the events that use it. User Preferences shows a *Play sounds* master (`looks.sound`) over one box per event, saved flat as `sound<Event>` (`soundStartSkill`, …) because `looks.json` only holds flat values; `soundPrefs()` turns any missing or non-boolean switch on, so a file from before the switches keeps every sound. A cue plays only while the master and its own switch are both on; the master off greys the boxes but keeps their ticks, and ticking a box plays it.
|
||||
- **Send breathes.** `#btn-send:not(:disabled)` runs `send-pulse`, a soft accent ring that spreads and fades every 2.4s; a disabled Send is still, and reduced motion switches it off.
|
||||
- **Per-tab scroll memory.** An in-memory `Map` keyed by view id holds the scroller's position (the main column on a document or the Overview, the card on the questions view, with the item it belonged to), restored when the tab comes back. Page-local, never persisted, cleared when the session turns into or out of the dashboard.
|
||||
- **The Overview tab.** Appears only while `GET /overview` returns a file for the session's spec (on the dashboard: the picker's spec; gone for *start from scratch*), fetched with `no-store` on load, on a spec change and on every tab click, so it always shows the file as it is on disk. Rendered through the same DOM-only markdown path as every doc, captioned read-only. It never becomes a doc: the page is not the record.
|
||||
- **The footer slot.** The workspace label sits centred in the footer's middle track, 12px and muted: `footerLabel()` in `public/workspace.js` builds `folder · branch` (from the workspace's original folder and `state.branch`), or `folder + N folders · branch` once folders are added, and `renderWhere()` steps down through its narrower tiers (`FOOTER_TIERS`) until the text fits. A warning dot marks a missing or unreadable folder. A click opens the Workspace dialog (`#workspace-modal`), where each folder has its own **Copy path**. The notification pill is fixed over the same spot and covers it while it shows, on purpose: nothing there needs pressing while the pill is up. The dashboard keeps the footer for this label alone: `renderFooter()` puts `is-dash` on it, which hides the summary and Send (and on a narrow screen keeps the label, the one thing left in the bar); the footer only disappears there when there is no label to show.
|
||||
- **The wake-up.** A fresh dashboard (`state.wake`, plus a per-sid `sessionStorage` guard) plays Planny powering on centre stage, as proven in `pathfinder/sketch-01`. The wake layer hides the dashboard behind a solid `var(--bg)` backdrop (`.wake::before`, so it follows the theme) whose opacity fades out over the same 0.6s as the glide, revealing the menu as he lands; the notification pill (`.banner`, z-index 46) stays above the layer (45). Before the first click or key he sleeps there on loop under a "Click to wake Planny" hint (`.wake.dormant`): Z's rising, slow breathing, slack arms swaying out of step, his feet pulsing like a standby light. While he sleeps the page tries to loop `sleeping.mp3` (browsers usually refuse until the first click, so this is normally silent). That click fades the hint and nudges him (`.wake.stirring`): he rocks gently about his feet (`wake-nudge`) while exactly one snore plays from the top, via the `stir()` callback `playWake()` awaits — timed by the snore's `ended`, capped at 6s, or a 2.6s timer when sounds are off or refused. Then the boot starts to `bootup.mp3` (in place of the opening chime; outranked only by the Start-skill cue, which cannot coincide with it because the wake layer swallows every click and key until the run ends), which fades out over 0.5s the moment the run ends or is aborted. The boot pops the Z's outward: 0.4s power-on and his feet blink · 1.35s feet plant · 1.5s / 1.9s arms lift off his sides · 2.5s the star opens lit, with a scan · 2.85s he glances left, right, then ahead · 3.2s smile · 3.6s hop and a cheer, star back to ink · 4.3s a 0.6s glide into the rail, measured once by `boot.js` and handed to CSS as `--wake-glide` · the menu groups rise in 60ms apart as he lands, and the note types in. Done by 5s (a fallback timer covers a hidden tab whose transition never fires). The beats are CSS keyframes on delays under `.wake.booting`, all inside `@media (prefers-reduced-motion: no-preference)`; there is no skip: from the waking click on, clicks and plain keys (no Ctrl/Meta/Alt) are swallowed so the nudge, boot and sound always play out; only a launch mid-run aborts it (snore stopped, boot-up faded), and under reduced motion `playWake()` resolves at once and the awake dashboard is simply there.
|
||||
|
||||
---
|
||||
|
||||
## 6. The startup question
|
||||
|
||||
Both prompts open with one ask. Pathfinder already uses `AskUserQuestion`, so this costs almost nothing:
|
||||
|
||||
> Run this session in the **web console** (a local page in your browser, better for walking through decisions with someone) or **here in the terminal**?
|
||||
|
||||
Recommended default is an open decision (see §8). Because the markdown files stay the source of truth, the user can switch either way mid-session at no cost, and the prompt should say so.
|
||||
|
||||
---
|
||||
|
||||
## 7. Work plan
|
||||
|
||||
| # | Task | Notes |
|
||||
| --- | --- | --- |
|
||||
| 0 | **Trim `plan2code-0-pathfinder.md` by ~250 characters** | Hard prerequisite. 5 characters of headroom today. Candidates: the `grilling.md` fallback blockquote, the Rules list. |
|
||||
| 1 | `src/web-console/` skeleton: `console.mjs` start/wait/status/stop, detached spawn, handle file, reap sweep | The transport is the risky part, build and prove it first |
|
||||
| 2 | `server.mjs`: the six security controls, SSE, atomic result write with Windows `EPERM` retry | |
|
||||
| 3 | `index.html` + `app.js` + `app.css` + vendored `marked` lexer, token-to-DOM renderer | |
|
||||
| 4 | Tier 1 primitives, staging, drafts, Send | |
|
||||
| 5 | `console.md`: the agent contract | The only file the prompts point at |
|
||||
| 6 | `SOURCE_PROMPTS` entries + `npm run build:skills` + commit `skills/` | Zero installer code changes |
|
||||
| 7 | Pathfinder integration: startup ask, channel rule, `Read` line | ~250 chars, funded by task 0 |
|
||||
| 8 | Plan integration | 324 chars headroom, fits, trim ~150 for margin |
|
||||
| 9 | CHANGELOG + `version.json` + `package.json` in lockstep | `plan2code-publish` refuses to release on mismatch |
|
||||
|
||||
### Three things most likely to bite during implementation
|
||||
|
||||
1. **Forgetting `windowsHide: true` on the detached spawn.** It defaults to `false`, and `detached` on Windows forces a console window that "once enabled, cannot be disabled". Every handoff flashes a black box at the user.
|
||||
2. **`fs.rename` `EPERM` from antivirus and search indexers on Windows.** Intermittent, unreproducible on demand, looks exactly like a logic bug. Retry three times with backoff from day one.
|
||||
3. **Relying on `SIGTERM` for cleanup on Windows.** It does not arrive. Build the idle deadline first, not last, and comment why.
|
||||
|
||||
### Non-obvious portability notes
|
||||
|
||||
- grill-with-ui's heredoc idiom (`patch <<'EOF'`) is **not portable to PowerShell**, which is the default shell for Claude Code on Windows. Use a `--file <path>` form as the primary documented interface.
|
||||
- `nohup ... &` is bash-only. Backgrounding happens inside `console.mjs start`, never in the shell command the agent writes.
|
||||
- Always emit `node "<abs>/console.mjs"` quoted. Install paths contain spaces.
|
||||
|
||||
---
|
||||
|
||||
## 8. Open decisions
|
||||
|
||||
1. **Default channel.** Terminal (lower ceremony for an engineer working solo) or console (better for the cross-functional sessions that motivated this)? Recommendation: console marked as recommended in the ask, terminal as the low-ceremony alternative.
|
||||
2. **Vendoring `marked`.** It is MIT and dependency-free, but it is the first vendored third-party code in the repo, against a house style of "Node built-ins only". The alternative, a hand-rolled parser, is materially worse on both correctness and security. Recommendation: vendor it, pin the version, record the SHA-256.
|
||||
3. **Single-driver or multi-user.** Everything above assumes one browser, one driver, no identity or attribution. A facilitated workshop with one person at the keyboard works fine. Two people answering independently is a different product and reaches into the state model. Recommendation: single-driver for v1, say so explicitly.
|
||||
4. **Third consumer.** After pathfinder and plan, `/plan2code-review` is the strongest case: two of its rules exist only because output goes to a terminal ("for 15+ findings, present top 10", "output tables as direct markdown, NOT inside code blocks") and a browser deletes both. Its `S 1,3,5` fix selection is literally a checkbox list compressed into a CLI token, and one findings UI serves both `/plan2code-review` and `/plan2code-3-implement-review`.
|
||||
|
||||
---
|
||||
|
||||
## 9. Honest assessment of size
|
||||
|
||||
This is not a weekend. Rough shape: `console.mjs` plus `server.mjs` around 700 to 900 lines, the client around 900 to 1,200, the contract file 300 to 400 lines of prose, plus the prompt trims and build wiring. The transport and lifecycle work (tasks 1 and 2) is where the risk concentrates, and it is worth proving end to end on one primitive before building the other eight.
|
||||
|
||||
A smaller first cut that still tests the whole idea: pathfinder only, `choice` and `text` and `recap` only, no artifact pane. That exercises the transport, the token mapping, the fallback path and the three-probe cap, which are the parts most likely to be wrong.
|
||||
|
||||
---
|
||||
|
||||
## Credits
|
||||
|
||||
The architecture owes a large debt to `grill-with-ui`, whose file-ownership model, staged-then-send interaction, commitment tiers and assumed-region idea are all borrowed here. The implementation is independent.
|
||||
@@ -0,0 +1,964 @@
|
||||
# The Web Console
|
||||
|
||||
## New here? A two-minute tour
|
||||
|
||||
**Launch it.** After installing, run `plan2code` in your project folder. It starts Claude Code or
|
||||
Devin on the dashboard, and the page opens in your browser. In any other agent, run `/plan2code`
|
||||
inside it, or add `--web` to a skill (`/plan2code-1-plan --web plan a lunch voting app`).
|
||||
|
||||
**What you see.**
|
||||
|
||||
- **The dashboard** has a card for every skill. The one it suggests next is flagged. Pick a card and
|
||||
that skill starts on the same page.
|
||||
- **Questions** come laid out with the trade-offs next to each option and a progress bar on top.
|
||||
Nothing is sent until you press **Send**, and half-typed answers survive a closed tab.
|
||||
- **Tabs** show the document taking shape, the build progress and, always last, **Ask**, where you can
|
||||
put a quick question to the running agent.
|
||||
- **Sign-off** asks for your approval at the end of a phase. You can run the code review first from
|
||||
the same card, or press **Show me it working** to have the agent start the app and show you
|
||||
screenshots of the change right on the page.
|
||||
|
||||
**Where next.** [walkthrough.md](walkthrough.md) follows one feature from the first idea to the
|
||||
last phase. The rest of this file is the reference: every card, button and rule. Prefer the terminal?
|
||||
Run the same commands without `--web` and answer there; the files under `specs/` are identical.
|
||||
|
||||
---
|
||||
|
||||
The web console is the main way to use Plan2Code: a local page in your browser
|
||||
where you pick a step, answer its questions, watch the documents and the build
|
||||
take shape, and approve the work. Every skill runs on it, and `/plan2code` is
|
||||
the front door: it opens a dashboard of all of them, and whichever you pick
|
||||
starts right there on the same page.
|
||||
|
||||
It exists because the hardest part of adopting Plan2Code is not the engineering.
|
||||
It is getting the person who actually knows what the product should do into the
|
||||
room. Pathfinder and Planning are the two steps where that person matters most,
|
||||
and they were the two steps that looked like a wall of terminal text.
|
||||
|
||||
## Quick start
|
||||
|
||||
1. Install Plan2Code (see [Install and start](../README.md#install-and-start) in the README).
|
||||
2. Run `plan2code` in your project, or `/plan2code` inside your agent. The dashboard opens in your
|
||||
browser.
|
||||
3. Pick a card. The same page becomes that step's session.
|
||||
4. Answer on the page and press **Send to Plan2Code**.
|
||||
|
||||
Starting a step by its own command instead? Add `--web` (for example `/plan2code-1-plan --web`) and
|
||||
it opens on the page without asking.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/dashboard-dark.webp">
|
||||
<img src="../docs/screenshots/dashboard-light.webp" alt="The Plan2Code dashboard: a Set up card, then the steps in order as cards, one of them marked Suggested.">
|
||||
</picture>
|
||||
|
||||
Scroll down for the utilities. Outside a git repository the **Git** card says so and still offers to start one:
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/dashboard-utilities-dark.webp">
|
||||
<img src="../docs/screenshots/dashboard-utilities-light.webp" alt="The utility cards: Quick task, Review, Handoff and Git, which notes that the folder is not a git repository yet and offers to start one.">
|
||||
</picture>
|
||||
|
||||
---
|
||||
|
||||
## What you get
|
||||
|
||||
- **Every question laid out**, with the trade-offs written next to each option
|
||||
instead of scrolling past in your history.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/question-dark.webp">
|
||||
<img src="../docs/screenshots/question-light.webp" alt="A Plan question card, How tasks are paged, with three options, the first marked Suggested, each with its trade-off underneath.">
|
||||
</picture>
|
||||
|
||||
- **A progress bar.** "4 of 9 settled" answers the first thing anybody asks.
|
||||
- **Previous and Next under each card**, walking the questions still waiting, so
|
||||
the list on the left is somewhere to jump from rather than the only way round.
|
||||
- **An example you can accept.** Where a question comes with one, an *Autofill
|
||||
suggestion* button puts it in the box as a real answer for you to edit. It
|
||||
disappears as soon as you have typed anything of your own.
|
||||
- **Answers you have settled read as answers**, not as a form you might still be
|
||||
able to change: what you chose, stated in words, with everything else locked.
|
||||
- **A question you have sent is held** until Plan2Code answers it, showing
|
||||
what you sent. The rest of the page carries on working, so you can read ahead
|
||||
or answer the next question while you wait.
|
||||
- **The document taking shape**, in a tab, with the parts that are still guesses
|
||||
clearly marked as guesses.
|
||||
- **A brief, on demand** (Pathfinder). Press *Write a brief*, choose how far back,
|
||||
and what comes back is a plain-English report of what has been decided, what is
|
||||
still open and what happens next, in its own tab with Print and Save buttons.
|
||||
It is the thing you take to a meeting.
|
||||
- **Nothing is sent until you press Send.** Everything before that is local and
|
||||
reversible, so nobody has to worry about committing to something by accident.
|
||||
- **Nothing gets lost.** Close the tab, reload, restart your machine: your
|
||||
half-typed answers are still there. Once you press Send, what you sent is
|
||||
held until Plan2Code actually collects it, so it cannot be written over.
|
||||
- **It tells you when the other half stops listening.** The terminal and this
|
||||
page are two programs that fail separately, and a page that sat there saying
|
||||
"one moment" forever was the worst way to find that out. Now it says so, and
|
||||
says what to do: answering anyway still works, because what you send is held
|
||||
on disk until something comes for it.
|
||||
- **Starters picked for your role.** Tell *User Preferences* what you do
|
||||
(engineer, product lead, architect, designer, QA, engineering manager) and
|
||||
the starter templates on an idea card and the starter questions on the Ask
|
||||
tab put the most useful ones first. It changes the order, never the
|
||||
questions a skill asks (see *Your role* below).
|
||||
- **Light or dark, and a highlight color you pick.** The gear button at the
|
||||
top right opens *User Preferences*: your role first, then these. It follows
|
||||
your system by default; set it to one or the other if
|
||||
you would rather it stayed put. Remembered on your machine, so it carries
|
||||
over to every session.
|
||||
- **A card as wide as you want it.** The same panel has a *Card width*
|
||||
setting — **Narrow** (720px), **Comfortable** (880px, the default) or
|
||||
**Wide** (1080px) — that widens the question card, the Previous / Next pager
|
||||
and the document tabs together. The dashboard keeps its own layout, and on a
|
||||
small window the column simply fits the window. Remembered with the colors,
|
||||
so it follows you into every session.
|
||||
- **Text that uses the card.** A question's text runs the full width of the
|
||||
card rather than stopping in a narrow column, and the answer box you are
|
||||
typing in grows to fill the card's free height: the box of a text question,
|
||||
the *Something else* box once you pick it, or the note under a verdict,
|
||||
yes/no or recap once it shows. Other boxes stay small. Drag the handle to
|
||||
make it taller; it never shrinks below the space it was given, and on a short
|
||||
window the card scrolls instead of squeezing the box under 160px.
|
||||
- **Send tells you it is ready.** While there is something to send, the Send
|
||||
button pulses gently; it goes still when there is nothing to send.
|
||||
- **Each tab remembers where you were.** Scroll halfway down a document,
|
||||
jump to the questions, come back: you are where you left off. The same goes
|
||||
for a long question card. It lasts as long as the tab is open.
|
||||
- **The spec's overview, one click away.** When the session is working on a
|
||||
spec that has an `overview.md`, an **Overview** tab shows it — read-only,
|
||||
and read fresh from disk each time you open the tab, so an edit shows up
|
||||
straight away. No file, no tab. On the dashboard it follows the spec picked
|
||||
at the top, and disappears for *start from scratch*.
|
||||
- **Where you are, at the bottom.** The footer names the folder the session
|
||||
was launched from and its git branch (`plan2code · feature/…`), muted in
|
||||
the middle. Click it to open the Workspace dialog (see *Your workspace*).
|
||||
Outside a git repo it shows only the folder.
|
||||
- **A chime when it's your turn.** The page plays a sound when new questions
|
||||
arrive, when a new tab (a document, the overview) joins the strip, and when
|
||||
the session opens or closes, so you can look away without missing your cue.
|
||||
Starting a skill from the dashboard plays its own sound too. The same panel
|
||||
has a *Play sounds* switch for all of them, and a box per moment (Planny
|
||||
snoring, Planny waking up, starting a skill, session opens, skill is ready,
|
||||
session ends, new questions, a reply on Ask, a new tab), so you can keep only
|
||||
the ones you want. Ticking a box plays its sound; everything is remembered
|
||||
like the colors.
|
||||
- **Files in your notes.** Show instead of describe: attach a screenshot, a
|
||||
photo or a document to any note or quick question (see *Attachments in notes
|
||||
and questions* below).
|
||||
- **A notebook of your own.** One per project folder, in named tabs, for
|
||||
jottings and screenshots that are yours, not the agent's (see *Your notebook*
|
||||
below).
|
||||
- **A nudge when it might be waiting on you.** Your agent may stop in the
|
||||
terminal to ask permission for something, and the page cannot see that. So
|
||||
the dashboard and every starting screen carry a one-line tip about hands-off
|
||||
modes (`auto` mode in Claude Code, `smart` mode in Devin) that can cut down
|
||||
on those stops, though they may still need your attention, and when the agent
|
||||
has been working and silent for about 30 seconds, Planny's line asks
|
||||
*"Still working, or waiting on an approval in your terminal?"* — well before
|
||||
the two-minute *"Still working on it"* line.
|
||||
- **The tab icon says whose turn it is.** A bar along the bottom of Planny's
|
||||
favicon follows the line beside him: dashed amber while Plan2Code is
|
||||
working or picking up your answers, solid green when it is your move, solid
|
||||
red when it has gone quiet or the connection is lost (busy is dashed so the
|
||||
states differ by pattern, not only color). A finished session goes back to
|
||||
the plain icon, so a console left in a background tab can be checked at a
|
||||
glance.
|
||||
- **Help.** The **?** at the top right opens a Help dialog with 18 topics,
|
||||
one per tab down the left (across the top on a narrow window), opening on
|
||||
the one for where you are. It is part of the page itself, so it still reads
|
||||
fully when the page has lost its program.
|
||||
- Works offline, on your own machine only. No account, no install, no network.
|
||||
|
||||
An Implement phase ends on a sign-off card: read the completion report, then
|
||||
review the code first, approve the phase, or ask for changes. Implement +
|
||||
review has already reviewed the code, so its card has no review button.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/signoff-dark.webp">
|
||||
<img src="../docs/screenshots/signoff-light.webp" alt="The Approve this phase card, with a button to read the completion report and three choices: Review the code first, Approve this phase, and I want changes.">
|
||||
</picture>
|
||||
|
||||
The **Ask** tab is a chat beside the cards, for a quick question at any point.
|
||||
When a question is really a new task, the answer ends with a ready-to-paste
|
||||
prompt in a block with a Copy button, to take into a new conversation.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="../docs/screenshots/ask-dark.webp">
|
||||
<img src="../docs/screenshots/ask-light.webp" alt="The Ask tab: the question Where are tasks paged? and Plan2Code's answer naming the file.">
|
||||
</picture>
|
||||
|
||||
## Using it
|
||||
|
||||
The easy way in is the dashboard:
|
||||
|
||||
```
|
||||
/plan2code
|
||||
```
|
||||
|
||||
A page opens with every skill laid out as cards — the setup pair, the pipeline
|
||||
in order, and the utilities alongside — with a note about what it made of your
|
||||
project (no AGENTS.md yet, a spec waiting on Phase 2) and a *Suggested* flag on
|
||||
the card it would pick. **Git** is among the utilities, always available: it opens
|
||||
the git board, three tabs — Changes, Branches and Sync — that open on the
|
||||
likely next step (Help's *The git board* topic walks through it), and asks
|
||||
before every push, publish and delete. In a folder that is not a git
|
||||
repository its card says *Not a git repository yet: it offers to start one*,
|
||||
and clicking it still works. **Codebase X-ray** is always available too: it
|
||||
explains how and why an area works, or ranks its rough spots into
|
||||
`specs/<name>/ARCHITECTURE-BRIEF-<date>.md`, and never changes code.
|
||||
**Diagnose a bug** sits beside it, also always
|
||||
available: it finds a bug's cause and writes it up as
|
||||
`specs/<bug-name>/DIAGNOSIS-<date>.md` without fixing it. Pick such a spec in
|
||||
the picker and it reads *Bug diagnosed*: Quick Task (suggested) and Plan light
|
||||
up, while Document, Implement, Implement + Review and Finalize stay greyed. Once
|
||||
Quick Task has fixed it, the folder reads *Bug fixed*: Quick Task offers to
|
||||
archive it to `specs--completed/`, and until then the picker never opens on it
|
||||
and hides it while *Hide unavailable workflows* is on. Its chip has a visible
|
||||
**Delete** button in place of the hover ✕ other specs carry, and one confirm
|
||||
removes the folder (any other spec also asks you to type its name). Click a card and Planny
|
||||
flies while it gets ready;
|
||||
a few seconds later the same page is that skill's console, already running. No
|
||||
command names to remember.
|
||||
|
||||
Handoffs this checkout has not picked up yet follow the specs in the picker as
|
||||
dashed **Handoff** chips, each with its title and age. Select one and the skill
|
||||
cards give way to a preview: when it was written, its spec, the skill it came
|
||||
from and its Next task. **Pick it up here** carries on in that skill and spec
|
||||
in this same session (Quick Task takes over, and says so, when the skill or
|
||||
spec is gone), and the chip is gone from the next dashboard. **Read it all**
|
||||
opens the whole document, **Copy for a new conversation** copies a one-line
|
||||
prompt that points a fresh conversation at the file, and **Delete** removes it
|
||||
for good after one confirm. Handoffs from *Stop with a handoff* (below) and
|
||||
from the Handoff skill land in the same place, `~/.plan2code/handoffs/`.
|
||||
|
||||
A freshly opened dashboard starts with Planny asleep in the middle of the page.
|
||||
Click to wake him: he snores once while he gets a gentle shake side to side,
|
||||
then about five seconds of him powering on to a boot-up sound (arms lifting
|
||||
off his sides, his star opening, a hop and a cheer) before he glides into his spot at
|
||||
the top and the menu rises in. (Browsers stay silent until your first click,
|
||||
so the snoring usually starts with it; with *Sounds* off, the same wake-up
|
||||
plays without audio.)
|
||||
It plays only on a fresh `/plan2code`: not on a reload, not when you come
|
||||
back with **Back to the dashboard**, and not after a launch. To skip it — from
|
||||
the asleep screen or mid-animation — press the muted **Skip** button at the
|
||||
bottom right or hit Escape; either goes straight to the dashboard, silent.
|
||||
With reduced motion switched on in your system settings you get the awake
|
||||
dashboard at once.
|
||||
|
||||
Or start any step directly by its command (the full list is in the README's
|
||||
[Prefer the terminal?](../README.md#prefer-the-terminal) section).
|
||||
|
||||
The first thing it asks is how you would like to work:
|
||||
|
||||
> **How would you like to work through this?**
|
||||
>
|
||||
> - **In your browser** (suggested)
|
||||
> - **Here in the terminal**
|
||||
|
||||
Pick the browser and a page opens at a `127.0.0.1` address, straight away:
|
||||
opening the page is the first thing the skill does, before it reads your
|
||||
project, so for the first few seconds you see a starting screen naming the step
|
||||
("Starting Pathfinder") while it gets its bearings — for the core steps, with
|
||||
Planny acting that step out. The questions replace it the
|
||||
moment they are ready. Answer what is there, press **Send to Plan2Code**, and
|
||||
it carries on. You can switch back to the
|
||||
terminal at any point by saying so: the files under `specs/` are the same either
|
||||
way, and neither side owns them.
|
||||
|
||||
While the page is open, the agent's messages in the terminal end with a
|
||||
pointer back to it — `→ Look at the web console: http://127.0.0.1:…` — and
|
||||
while it is waiting on you it says so in those words: *Waiting on your answer
|
||||
in the web console*. Glance at the terminal, and it always tells you where to
|
||||
look.
|
||||
|
||||
Know you want the page already? Pass `--web` with the command —
|
||||
`/plan2code-1-plan --web plan a lunch voting app` — and it opens the console
|
||||
without asking. The flag is dropped before the rest of the argument is read, so
|
||||
it never becomes part of the request.
|
||||
|
||||
Sharing the link with a colleague on another machine will not work, and that is
|
||||
deliberate. It is bound to your own machine only. To work through a session
|
||||
together, share your screen.
|
||||
|
||||
For the same reason, the web console is only offered when the agent is running
|
||||
on your own machine. An agent working in a cloud VM, a container or over SSH
|
||||
stays in the terminal: a `127.0.0.1` link from somewhere else is a link you
|
||||
cannot open.
|
||||
|
||||
### Your role
|
||||
|
||||
The first control in *User Preferences* (the gear button) is **Role**:
|
||||
Engineer, Product lead / PM, Architect / tech lead, Designer (UX), QA / test
|
||||
engineer, Engineering manager, or **Not set / none of these**, the default.
|
||||
It only reorders things: the starter templates on an idea card and the starter
|
||||
questions on the Ask tab. It never changes what a skill asks or does. It is
|
||||
kept in `looks.json` with your colors, so it follows you into every session,
|
||||
and **Back to default** sets it back to *Not set*.
|
||||
|
||||
Until you have chosen, the dashboard shows a one-line banner at the top —
|
||||
*Pick your role to get starter templates ordered for you.* — with **Set up
|
||||
preferences** and **Not now**. Choosing any role, *Not set* included, or
|
||||
pressing *Not now* puts it away for good.
|
||||
|
||||
### Starter templates
|
||||
|
||||
The first "What's the idea?" box in Pathfinder, Plan and Quick Task has a row
|
||||
of starter templates above it: **Blank** first, then outlines to fill in (an
|
||||
engineering spec, product requirements, a design decision, a bug
|
||||
investigation, a refactor, a data migration, and so on), in the order your
|
||||
role puts them. With a role chosen, the first one carries a *For your role*
|
||||
pill. Pick one and the box fills with editable Markdown, one `## heading` per
|
||||
answer with the answer on the lines under it, and the first `[blank]` is
|
||||
selected so you can type straight over it. Brackets mark only the parts you
|
||||
fill in; everything else is a default you can keep or edit. If you have
|
||||
already typed something, a strip asks **Replace** or **Keep mine** first.
|
||||
Only what is in the box is sent, exactly as if you had typed it.
|
||||
|
||||
The templates live in the page (`public/starters.js`), not in the prompts. A
|
||||
skill only marks its fresh-idea card with `"templates": "idea"`, and `post`
|
||||
refuses that flag on anything but a `text` card. A resumed map or plan asks
|
||||
no idea question, so it shows no templates, and the terminal never has them.
|
||||
|
||||
### Leave for later (Pathfinder)
|
||||
|
||||
Pathfinder's scope question is **Leave for later** — *"Which of these features
|
||||
are we leaving out this time?"* It is a tick-any list of 3–5 features someone
|
||||
might expect, each ending with what leaving it out means ("Scheduled exports
|
||||
(Leaving this out = someone runs each export by hand)"), with a recommended
|
||||
set to tick in one go. The features you tick become the first lines of the
|
||||
map's *Out of scope*. Every option names a feature, never a rule to keep, so a
|
||||
tick always means "not this time".
|
||||
|
||||
### Skipping a question
|
||||
|
||||
**Skip this one**, on an optional question, now moves you straight on: the card
|
||||
reads *Skipped* for a beat (about a quarter of a second) and the next open
|
||||
question comes up. On the last one, focus goes to **Send to Plan2Code**
|
||||
instead. A click or a key press in that beat cancels the move. **Do not skip**
|
||||
on a skipped card brings it back.
|
||||
|
||||
### Your workspace
|
||||
|
||||
The folder label in the middle of the footer — `shop · main`, or
|
||||
`shop + 2 folders · main` once you have added some (shorter on a narrow
|
||||
window) — opens the **Workspace** dialog: the folders the agent uses as
|
||||
context for this console session.
|
||||
|
||||
- **The folder you started in** is always first. It can be renamed and given a
|
||||
description, but not removed.
|
||||
- **Add a folder** by pasting a path (`../shared-ui` counts from the folder
|
||||
you started in; `~` is your home folder) or with **Browse…**, which opens
|
||||
your system's own folder picker. Browse… is hidden when the page looks like
|
||||
it is being reached from another machine (SSH, a dev container, a
|
||||
Codespace). A path that is not a folder, one already in the list, and a name
|
||||
already taken are each refused with a message (a taken name comes with a
|
||||
**Use @name-2** button); a folder inside another one in the list is
|
||||
accepted, with a note.
|
||||
- **Every folder has an `@name`** (lowercase letters, numbers and hyphens) and
|
||||
an optional one-line *What is it?*. Type `@` in the Ask box, a note or a
|
||||
typed answer and a list of names pops up; the agent reads `@shared-ui` as
|
||||
that folder.
|
||||
- **What the agent does with them.** It is told the list when its session
|
||||
opens and each change once after that. Added folders are read-only
|
||||
reference: it reads them, reads each one's `AGENTS.md` (or `CLAUDE.md`)
|
||||
before first using it, and changes one only if you ask. Your harness may
|
||||
ask permission the first time it reads outside the project.
|
||||
- **Marks.** *This folder no longer exists* when it is gone from disk; *The
|
||||
agent can't read this yet* when the agent reported a failed read (in Claude
|
||||
Code with a copyable `/add-dir <path>` to run); *Inside another folder in
|
||||
the list* for a nested one.
|
||||
|
||||
The workspace carries across skills you start from the dashboard and back, and
|
||||
it is remembered for next time:
|
||||
|
||||
- **Saved on every change**, in `~/.plan2code/console/workspaces.json` (beside
|
||||
`looks.json`, never in the project, since the paths are your machine's),
|
||||
keyed by the folder you started in.
|
||||
- **One list per spec.** *Start from scratch* on the dashboard shows the
|
||||
project's list. Picking a spec loads its own; the first time, it starts as a
|
||||
copy of the project's, and after that the two are separate. A spec created
|
||||
mid-run (Pathfinder, Plan) takes the list in force with it. The line under
|
||||
the dialog's title says whose list it is.
|
||||
- **Forgotten on archive.** Finalize's Spec Cleanup step says it will forget
|
||||
the spec's list and runs `console.mjs forget --spec specs/<name>` after the
|
||||
move.
|
||||
|
||||
### Subagents
|
||||
|
||||
On a build (Implement, Implement + review, Quick task), a review and
|
||||
Pathfinder, the agent can hand independent pieces of work to helpers
|
||||
(subagents) while it keeps the conversation with you.
|
||||
|
||||
- **The button.** An icon in the top bar, after Stop session (and Write a
|
||||
brief on Pathfinder): one larger node linked to three smaller ones, lit in
|
||||
your highlight color while helpers are on. It shows only on those skills,
|
||||
and only when the skill's copy of the console can pass the setting on.
|
||||
- **The dialog.** A click opens it; the button never switches anything by
|
||||
itself. **Use helpers** or **Work alone**, the instruction the agent follows
|
||||
(**Reset to default** puts the shipped one back), and how many helpers may
|
||||
run at once (1 to 20; your agent's own limit still applies). **Save** sends
|
||||
it; the agent hears of it at its next check-in, as a setting, not as
|
||||
something you typed.
|
||||
- **Saved per project and per skill**, on until switched off, in
|
||||
`~/.plan2code/console/subagents.json`. The next session of the same skill
|
||||
in the same folder starts the same way.
|
||||
- **The Subagents tab.** With the first helper the agent reports, a tab
|
||||
appears before Ask: one row per helper with what it was asked and whether it
|
||||
is running, done or failed, plus a one-line result at the end. Rows change at
|
||||
the agent's check-ins, not live. *Working alone* means your agent has no way
|
||||
to start helpers here. The tab clears when you go back to the dashboard.
|
||||
- **Pathfinder's research** always uses helpers, whatever the switch says, and
|
||||
they show in the tab too.
|
||||
|
||||
### Your notebook
|
||||
|
||||
The **Notebook** icon in the top bar, on the dashboard, every skill and the
|
||||
finished screen, opens a large dialog with a scratch pad for the folder you are
|
||||
working in.
|
||||
|
||||
- **Tabs.** A row of named tabs sits across the top, each with its own text and
|
||||
its own pictures. **+ New tab** asks for a name first (1 to 40 characters, no
|
||||
two the same in any case, up to 20 tabs), in a small dialog. There is no
|
||||
toolbar under the row: a double-click (or **F2**) on a tab renames it, the **x**
|
||||
beside its name deletes it (the **Delete** key does too), and tabs are moved
|
||||
only by dragging them. The tab you left open is the one you come back to.
|
||||
Delete opens a dialog that asks twice and takes the tab's text and pictures
|
||||
with it; with no tab left, the dialog asks you to make one. A notebook from before tabs opens
|
||||
as one tab called **Notes**.
|
||||
- **Markdown, styled as you type.** The editor shows Markdown in place:
|
||||
headings grow, bullets draw, bold, code, quotes and links take their look, and
|
||||
the marks come back on the line you are on. The text itself stays plain
|
||||
Markdown (saved as the tab's `note.md`, up to 1 MB).
|
||||
- **Pictures beside it.** Paste a screenshot, drop files on the dialog or press
|
||||
**Add image**: each becomes a thumbnail in a strip under the text (up to 200
|
||||
per tab). Click one for a full-screen preview (arrow keys step through, Esc
|
||||
closes); its **X** asks before it deletes.
|
||||
- **It saves itself**, about a second after you stop typing, when you close the
|
||||
dialog and before you switch tabs. If a tab's text cannot be saved, switching
|
||||
is refused ("Not saved yet, so staying on this tab") rather than losing it.
|
||||
If the connection drops, your text stays in the page and is retried, and the
|
||||
browser tab warns before you close it with something unsaved.
|
||||
- **One per folder, kept between sessions.** Every session started in the same
|
||||
folder (each git worktree counts as its own) opens the same notebook, in
|
||||
`~/.plan2code/notepads/<folder-name>-<12 hex>/`: `meta.json` (which folder it
|
||||
belongs to), `tabs.json` (the tabs, their order and the last one open) and one
|
||||
folder per tab, `tabs/<id>/`, holding its `note.md` and `images/`. Two pages
|
||||
open on one folder share it, and the last save wins.
|
||||
- **Private.** It never goes into your project, your session or anything the
|
||||
agent reads, so the agent never sees it. It stays on this machine.
|
||||
- **Removed only when you say.** No automatic cleanup touches it. Once the
|
||||
newest file in a notebook is 30 days old or more, *User Preferences →
|
||||
Cleanup* offers it as one item named after its folder's full path
|
||||
(*Notebook for /home/sam/code/shop*),
|
||||
and deleting it removes the whole notebook, every tab's text and pictures.
|
||||
|
||||
### Session meter
|
||||
|
||||
A small ring pill in the top bar — **Session: fresh** (green), **Session:
|
||||
getting long** (yellow), **Session: time for a fresh start** (red) — counts the
|
||||
work this console session has done. Click it for the count, a list of each
|
||||
step that added points and what it added (for example *Quick task started +1*),
|
||||
and a **What is this?** link to Help.
|
||||
|
||||
Each skill run adds points (`WEIGHTS` in `public/meter.js`): Plan, Document,
|
||||
Review, Init and Init update 2; Revise plan, Quick task and Finalize 1; a
|
||||
Pathfinder map 2 and each question its research subagents settle 1; a built phase by its size,
|
||||
one point per 3 tasks it completed (rounded up), plus 1 for Implement + Review
|
||||
(a flat 2, or 3, if the agent did not report a task count); Handoff and the dashboard 0.
|
||||
A build counts while it runs: each task the progress bar ticks off adds to the
|
||||
build's row (*Implement + Review: 9 tasks built so far*), Implement + Review's
|
||||
review stage adds its 1 as it starts, and the approved phase takes the row over
|
||||
with its final score, so the meter never waits for the sign-off to catch up.
|
||||
On top of that, every 2 questions you answer on the page add 1 point to the
|
||||
skill run you answered them in (`ANSWERS_PER_POINT`), so a long Pathfinder or a
|
||||
Plan with many clarifying questions weighs more than a short one. A review run on the
|
||||
page after a quick task or a phase sign-off counts as a Review too. Green is
|
||||
under 5, yellow from 5, red from 10, and the ring is full at 15. At red the dashboard
|
||||
also shows a banner: starting a **new console session** keeps the agent sharp
|
||||
(resuming this one carries the count along). It is a rule of thumb, not a
|
||||
reading of the agent's real context, and it never blocks anything.
|
||||
|
||||
### While something is being built
|
||||
|
||||
Implementation, Implement + Review and a Quick Task spend most of their time
|
||||
building rather than asking, so the page shows the build instead:
|
||||
|
||||
- **What it is doing right now**, beside Planny ("Task 5 of 9: the rate
|
||||
limiter"), and the progress bar counting tasks done. Tasks are counted
|
||||
within the phase, to match the bar — the phase is already named in the
|
||||
headline — so you never see "Task 4.2 of 6"; the page rewrites that form if
|
||||
an agent still sends it.
|
||||
- **The phase's task list** in its own tab, ticking as each task lands on
|
||||
disk, and **the phase file itself** (`phase-3.md`) rendered in the next —
|
||||
the prerequisites and task specs, not just the checklist.
|
||||
- **Any question the build needs answered** (which phase, a spec conflict,
|
||||
failing tests) appears as an ordinary question, and the sign-off is a
|
||||
**Completion report** tab with an *Approve this phase* card.
|
||||
- A long task is not mistaken for a stall. The build says how long it may go
|
||||
quiet, and the page only calls it stuck after that.
|
||||
|
||||
### Review before you approve
|
||||
|
||||
The *Approve this phase* card carries a **Review the code first** button beside
|
||||
the approval. Press it and the same session runs a focused code review of
|
||||
exactly the files the phase changed, before you are asked to approve anything.
|
||||
The findings come back as a tab, and a *Which to fix* card lists every one with
|
||||
its severity: tick the ones to fix (or use the *Critical and warnings* / *All
|
||||
of them* quick picks), press Send, and it fixes and re-checks them before the
|
||||
approval card comes back.
|
||||
|
||||
A quick task has no approval step, so its offer sits on the finished screen
|
||||
instead: a large **Review it now** button above the next step, with **No
|
||||
thanks, I am done** beside it. If the session has already closed, the button
|
||||
turns into the `/plan2code-review` command to run in the terminal.
|
||||
|
||||
Implement + Review shows neither: it reviews every phase before sign-off
|
||||
already.
|
||||
|
||||
### When a session ends
|
||||
|
||||
A finished session says so, and ends in one of three shapes:
|
||||
|
||||
- **A next step.** What happened, and the exact command to run next (with a
|
||||
Copy button) — the next phase, Finalize, a commit.
|
||||
- **All done.** Nothing is left to run, so there is no command to copy:
|
||||
*"All done, nothing left to run."* Init, Init update and Handoff end this
|
||||
way, and so do Review and Finalize when nothing landed that needs committing.
|
||||
- **Paused.** You pressed *Stop session*. The card names what was saved and
|
||||
gives the command that picks it up later. Nothing else is offered.
|
||||
|
||||
*Stop session* offers two ways to stop (on the dashboard, where nothing has
|
||||
started, it is a plain Stop). **Stop with a handoff**, the suggested one,
|
||||
saves your place as usual and also has the agent write a handoff: where the
|
||||
work stands and the next task, kept in `~/.plan2code/handoffs/` rather than in
|
||||
your project. The paused card names the file, and the dashboard offers it as a
|
||||
chip until it is picked up. **Just stop and save** saves your place and gives
|
||||
the resume command, nothing more; where the step has nothing saved yet it reads
|
||||
*Stop anyway*, under a warning about what is lost.
|
||||
|
||||
When the next step is another Plan2Code skill, the screen also has a
|
||||
**Continue here** button beside it: one press starts that skill in the same
|
||||
conversation, as a dashboard card would. It disappears once the session meter is
|
||||
red, when a fresh conversation is the better choice. A finished Quick Task or
|
||||
Finalize that ends on a commit can also offer **Update CHANGELOG first**, beside
|
||||
**Commit it now**: it opens Changelog right there, and Changelog's yes to
|
||||
*Commit this now?* carries on to Git.
|
||||
|
||||
The first two also carry a **Back to the dashboard** button (beside the next
|
||||
step, or as the main button under "All done"). Press it and the same page turns
|
||||
back into the skill menu, in the same conversation, so the next skill starts
|
||||
right there. The agent keeps listening for it for about ten minutes after the
|
||||
session ends; after that, or once the session has closed, the button turns into
|
||||
the `/plan2code` command instead. That command is on both of these screens
|
||||
anyway, for starting the dashboard in a fresh conversation — the better choice
|
||||
after a long skill, since a fresh conversation starts with a clean context.
|
||||
|
||||
You don't have to finish first. On every skill but the dashboard itself, a
|
||||
small **triangle** pointing left, in your highlight color, sits beside *Stop
|
||||
session*. Press it, confirm, and the agent saves your place exactly as a stop
|
||||
would, with any answers you have ready going along. Then the page turns into
|
||||
the dashboard instead of showing a finish card. Pick the same skill again to
|
||||
carry on, or pick another one. Like Stop, it only works on your turn, and where
|
||||
nothing is saved yet (early in a plan) the confirm says what would be lost.
|
||||
|
||||
### Attachments in notes and questions
|
||||
|
||||
Any note, any quick question on the Ask tab, and the fresh-idea box on
|
||||
Pathfinder, Plan and Quick Task can carry files (on a card they travel with your
|
||||
answer as a note attachment), three ways:
|
||||
|
||||
- the **+ Attach file** button beside the box (pick one or more files),
|
||||
- **paste** a screenshot or a copied file straight into the box,
|
||||
- **drag and drop** files onto the notes panel or the Ask composer.
|
||||
|
||||
Two kinds are allowed:
|
||||
|
||||
- **Images.** Each is shrunk and re-encoded in your browser (JPEG, 2000 px on
|
||||
the long edge at most, phone-photo rotation kept) and shows as a thumbnail.
|
||||
- **Documents**: text, code and PDF (`.md`, `.txt`, `.json`, `.yaml`, `.csv`,
|
||||
`.log`, `.js`, `.ts`, `.py`, `.sql`, `.pdf` and the like), up to 10 MB each.
|
||||
They upload exactly as they are and show as a chip with the file type, name
|
||||
and size. The server checks the contents match the type (a PDF header, or
|
||||
UTF-8 text with no NUL bytes), and a document is never opened from the page.
|
||||
|
||||
Up to 5 attachments per note and 5 per question, images and documents counted
|
||||
together. Anything else (`.docx`, a file over 10 MB, a dotfile such as `.env`)
|
||||
picked or dropped is refused with a message naming the file; a paste only
|
||||
picks up the files it can attach, and leaves any text to paste as usual. Each
|
||||
file uploads straight away while you carry on typing, and sits in a tray with a
|
||||
remove button; removing one deletes its file. A failed upload offers retry or
|
||||
remove and holds back only that note, so the rest of your answers still send.
|
||||
|
||||
The files are stored with the session, in
|
||||
`~/.plan2code/console/sessions/<id>/uploads/`, never in your project, under a
|
||||
random name the server picks. When you send, each note is followed by one line
|
||||
per attachment:
|
||||
|
||||
```
|
||||
Note on Header row: Please keep the header row.
|
||||
Image: /home/sam/.plan2code/console/sessions/<id>/uploads/<uuid>.jpg (header.png)
|
||||
File: /home/sam/.plan2code/console/sessions/<id>/uploads/<uuid>.pdf (api-spec.pdf)
|
||||
```
|
||||
|
||||
and the agent opens those paths with its own file reader. Uploads from sessions
|
||||
untouched for 30 days are swept away the next time a session opens.
|
||||
|
||||
**Keeping the ones a spec cites.** When the agent is about to write a file
|
||||
under `specs/<idea>/` that links to one of your note attachments (a plan, the
|
||||
overview, a phase file, a Pathfinder question or the map), it first copies the
|
||||
attachment into `specs/<idea>/attachments/` with `console.mjs keep` and links
|
||||
the copy, so the spec still shows it after the session is swept. The copy is
|
||||
named `<slug of your file name>-<8 characters of the upload id>.<ext>`, so
|
||||
keeping the same upload twice reuses it. Attachments nothing cites stay in the
|
||||
session, and quick-question attachments are never kept. `keep` is run by the
|
||||
agent, in its own shell; the server itself still never writes into your
|
||||
project.
|
||||
|
||||
### Ask a quick question
|
||||
|
||||
The **Ask** tab, always the last tab, on the dashboard and in every skill,
|
||||
opens a **Quick question** chat. Ask anything about the project's files, or
|
||||
anything at all, without waiting for a card. The agent running the skill
|
||||
answers at its next check-in (in a build, after the task it is on), and the
|
||||
workflow carries on meanwhile. Asking never holds up a card send, and a card
|
||||
send never holds up a question.
|
||||
|
||||
- **Context only when you add it.** A question starts with no context, so it
|
||||
reads as a general question. **+ Add context**, beside *+ Attach file*,
|
||||
lists the last 3 places you visited (question cards, document sections, a
|
||||
spec picked on the dashboard) plus *This spec*; pick one and an *About: …*
|
||||
chip sits above the box. × removes it, and it clears after the question is
|
||||
sent.
|
||||
- **Starter questions.** An empty conversation offers a few questions to start
|
||||
from, chosen for the skill you are in and ordered by your role; the ones
|
||||
that need context appear once you have added some. Clicking one fills the
|
||||
box without sending it.
|
||||
- **Pictures.** The same as notes: the button, paste, or drag and drop, up to 5
|
||||
per question.
|
||||
- **Ten questions per conversation.** The `N of 10` counter is always in view.
|
||||
After the tenth is answered, **New conversation** starts a clean one. So does
|
||||
switching skills through the dashboard.
|
||||
- **Edits need your approval.** Ask for a change to a file and the agent
|
||||
replies with a summary and the list of files it would touch, with
|
||||
**Approve** and **Decline**. Nothing changes until you approve. Afterwards
|
||||
it lists what changed, with line counts, and nothing is committed unless you
|
||||
spell out a commit in your message. It never edits the running skill's own
|
||||
files under `specs/`, and a chat message never answers a card or moves the workflow on: that is what the cards are for.
|
||||
- **When you cannot send.** Two different lines explain it: "That's 10
|
||||
questions in this conversation" means start a new one, and "No agent is
|
||||
connected right now" means the session has finished or the agent has gone
|
||||
quiet, so resume it to ask. Either way the conversation above stays
|
||||
readable.
|
||||
|
||||
A reply that lands while you are on another tab puts a dot on **Ask** and
|
||||
chimes once (if sounds are on).
|
||||
|
||||
### When an update is out
|
||||
|
||||
When a newer Plan2Code release is out, the dashboard shows an **UPDATE
|
||||
AVAILABLE** banner at the top. Click it for the details: the version you
|
||||
have, the new one (linked to its Releases page) and the command that updates
|
||||
you, `plan2code update`, with a Copy button. It updates everything that was
|
||||
installed (the skills, the `plan2code` command and any extras you added), with
|
||||
no menu, and never uninstalls anything. If the `plan2code` command is not
|
||||
installed, the dialog also shows the install command,
|
||||
`npx --allow-git=all git+https://github.com/jparkerweb/plan2code.git`, to run
|
||||
instead. **×** hides the banner for this session; the next dashboard shows it
|
||||
again until you update.
|
||||
|
||||
The `plan2code` command tells you too: before it starts your agent it prints
|
||||
one line, `Plan2Code v<latest> is out (you have v<installed>). Run: plan2code update`.
|
||||
It reads the same saved check, so it never waits on the network; when that
|
||||
check is missing or old, it refreshes it in the background for next time.
|
||||
|
||||
The check uses your own git login to read the repo's release tags, once an
|
||||
hour at most. If git cannot reach the repo (no git, no access, offline), you
|
||||
simply see no banner, and nothing waits on it. The version in Help always
|
||||
links to the Releases page.
|
||||
|
||||
### Keyboard
|
||||
|
||||
| Key | Does |
|
||||
| --- | --- |
|
||||
| `Ctrl` + `Enter` (`⌘` + `Enter` on a Mac) | Send |
|
||||
| `Tab` / `Space` | Move between options and pick one |
|
||||
| In the Ask box: `Enter` / `Ctrl` + `Enter` (`⌘` + `Enter`) | `Enter` is a new line; `Ctrl` + `Enter` sends the quick question, never the cards |
|
||||
| `Esc` | Closes whichever dialog is open; on the dashboard, backs out of a pick |
|
||||
| In Help: arrow keys, `Home`, `End` | Move between topics (the arrows wrap). `Ctrl` + `Enter` does nothing inside Help |
|
||||
|
||||
Every control is a real button, radio or checkbox, so screen readers and
|
||||
keyboard-only navigation work.
|
||||
|
||||
## Models in User Preferences
|
||||
|
||||
The `plan2code` launcher's model menu comes from `models.json`, which every install overwrites with the authors' curated list. **User Preferences → Models** (Claude, Devin and Codex tabs) lets you add a model that came out before Plan2Code was updated; additions are kept in `~/.plan2code/models.json`, and **Reset to default** removes them. Restart `plan2code` to see a change. You can always run `plan2code --model <id>`, or switch model inside your agent before running a skill. Devin ids ending `-xhigh` or `-max` are refused. Maintainers refresh the curated list with the repo-local `/plan2code-model-update` skill, which shows a diff and changes only what they approve.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| What happened | What to do |
|
||||
| --- | --- |
|
||||
| You closed the tab | Open the link again. Everything is where you left it. After about two minutes with no tab open the link stops working: ask the agent to resume the session for a new one. |
|
||||
| The link stopped working | Tell the agent. It restarts the session and gives you a new link. |
|
||||
| Your agent session died while you were mid-answer | Press Send anyway. Your answers are written to disk and are never discarded, including when the session is restarted. The next session picks them up. |
|
||||
| The page says Plan2Code is not running | It has not checked in for a few minutes. Look at the terminal: it may have finished its turn, hit an error, or be waiting on you there. If it is idle, type `continue` in the terminal and it picks your answers up. Answering here still works, and what you send is held for it. |
|
||||
| You are not sure anything is connected | The **?** at the top right opens Help. Its *What this page is* tab says what keeps the page alive and whether both halves are talking at that moment, and *When something looks stuck* covers what to check. |
|
||||
| You would rather use the terminal after all | Say so. Nothing is lost. |
|
||||
|
||||
---
|
||||
|
||||
## How it works
|
||||
|
||||
Nothing is installed. The skills ship a small zero-dependency Node server
|
||||
(`references/web-console/`), and the workflow step starts it when you say yes.
|
||||
|
||||
```
|
||||
agent server (detached) your browser
|
||||
| | |
|
||||
|-- open (binds the port, starts ->| |
|
||||
| the server AND the browser) ---|---------------------------->|
|
||||
|<-- http://127.0.0.1:PORT/s/TOK/ |<---- the page, first state -|
|
||||
| | already inside it |
|
||||
|-- post the first questions ----->|---- pushed to the page ---->|
|
||||
|-- wait --seconds 240 ----------->| |
|
||||
| (returns every 4 minutes with | |
|
||||
| progress, then waits again) |<---- you press Send --------|
|
||||
|<-- your answers -----------------| |
|
||||
```
|
||||
|
||||
The server runs detached rather than as a background task of the agent, because
|
||||
agent background tasks get killed at various timeouts, and that would take your
|
||||
half-finished answers with them.
|
||||
|
||||
**It is built to show you something fast.** A browser takes most of a second to
|
||||
turn up after it is asked, so `open` binds the page's port itself and sends the
|
||||
browser there before the server has even finished starting; the server takes
|
||||
the port over a moment later, and the browser's request waits for it rather
|
||||
than being refused. The page arrives with the session already inside it, so it
|
||||
draws the real screen without asking for anything first, in your own theme and
|
||||
colors from the first frame. On a Windows laptop the page is in front of you in
|
||||
roughly the time the browser itself takes to open.
|
||||
|
||||
**It stays up while the page is open.** The page pings it every few seconds, so
|
||||
the idle clock never runs down while you are there. Close the tab and it shuts
|
||||
itself down about two minutes later; it stops after four hours regardless, and
|
||||
the agent stops it outright when the session ends.
|
||||
|
||||
That also means **the server routinely outlives the agent**. It is the agent, not
|
||||
the server, that reads your answers, and the two fail separately. The page tells
|
||||
the two apart: the **?** button at the top right opens Help, whose *What this
|
||||
page is* tab says which halves are talking right now (and *When something
|
||||
looks stuck* covers what to check), and Planny stops looking busy once
|
||||
nothing is listening rather than spinning at you indefinitely.
|
||||
|
||||
**State lives in three places**, and none of them is your repository (the one
|
||||
exception being the note attachments the agent keeps for a spec, above):
|
||||
|
||||
| Where | What | Survives |
|
||||
| --- | --- | --- |
|
||||
| `~/.plan2code/console/sessions/<id>/` | the questions, your draft, your answers | 30 days after the session was last touched |
|
||||
| `~/.plan2code/console/sessions/<id>/workspace.json`, `ledger.ndjson`, `workspace-cursor.json` | the workspace's folders (paths, names, descriptions — never their contents), the session meter's events, and how far the agent has been told of workspace changes. Kept beside the session, so they outlive every dashboard hop | with the session |
|
||||
| `~/.plan2code/console/sessions/<id>/uploads/` | images and documents attached to notes and quick questions | 30 days after the session was last touched |
|
||||
| `~/.plan2code/handoffs/<id>.md`, `<id>.json` | each handoff's document, and which checkout, spec and skill it belongs to and whether it was picked up (`handoffs.mjs` is their one owner) | 30 days after it was last touched, picked up or not |
|
||||
| `~/.plan2code/notepads/<folder-name>-<12 hex>/` | your notebook for one folder: `meta.json`, `tabs.json` and, per tab, `tabs/<id>/note.md` and `tabs/<id>/images/` (`notepads.mjs` is their one owner; the agent never reads them) | until you delete it through Cleanup, which offers it once its newest file is 30 days old |
|
||||
| `~/.plan2code/console/looks.json` | your role, theme, colors, sounds and card width | always |
|
||||
| `~/.plan2code/console/subagents.json` | your Subagents switch, instruction and limit, per project folder and skill | always |
|
||||
| `~/.plan2code/console/sessions/<id>/subagents-setting.json`, `subagents-cursor.json` | this session's copy of the switch, and how far the agent has been told of it | with the session |
|
||||
| your system temp directory | the port, process id and session token | until reboot |
|
||||
|
||||
Each of the workspace and meter files has exactly one writer: the server owns
|
||||
`workspace.json` (the page changes it only through the `/workspace` routes
|
||||
under Security), and `console.mjs` owns `ledger.ndjson` and
|
||||
`workspace-cursor.json`. The meter's count is never stored; it is folded from
|
||||
the ledger every time (`public/meter.js`), so a repeated `post` never counts
|
||||
twice. The logic lives in small pure modules the tests import directly —
|
||||
`public/workspace.js` (names, the footer label, the change lines the agent
|
||||
reads), `public/meter.js` and `public/mentions.js` (the `@name` popover) — and
|
||||
**Browse…** runs the per-OS picker in `picker.mjs`, copied from the
|
||||
`plan2code` launcher and kept in step with it by a test.
|
||||
|
||||
**Old sessions clean themselves up.** Each time a session opens, whole session
|
||||
folders nobody has touched for 30 days are deleted — questions, drafts,
|
||||
answers, uploads and all, paused or not — along with stray scratch files
|
||||
(`.json` / `.mjs`) left at the top of `~/.plan2code/console/` for as long, and
|
||||
handoffs in `~/.plan2code/handoffs/` untouched for as long, both files each.
|
||||
Your `looks.json` and the `console-dir` pointer are never touched, and neither
|
||||
is the session being opened. Nothing of value goes with them: the page is
|
||||
never the record, `specs/` in your project is.
|
||||
|
||||
**Or clean up on demand.** *User Preferences → Cleanup* → **Find files to
|
||||
clean up** lists, with sizes, everything in `~/.plan2code/` that is not
|
||||
needed: sessions untouched for 30 days (never the one you are in), anything at
|
||||
the top of `~/.plan2code/console/` other than `sessions/`, `looks.json`,
|
||||
`workspaces.json`, `subagents.json`, `console-dir` and `update-check.json`, and anything at the top of `~/.plan2code/` other than
|
||||
`console/`, `bin/`, `launcher.json`, `install.json` (what you installed, which
|
||||
`plan2code update` reads), `models.json`, `handoffs/` (old handoffs go by
|
||||
age, above) and `notepads/`. Each notebook whose newest file is 30 days old or
|
||||
more is listed as one item, *Notebook for* its folder, and goes whole; no
|
||||
automatic sweep ever removes one. It also lists each
|
||||
folder in the project's `specs--completed/` whose newest file is more than 30
|
||||
days old: archived specs Finalize moved there. Deleting one is permanent:
|
||||
`specs--completed/` is usually gitignored, so git can't restore it. A stray is listed once
|
||||
it has sat untouched for an hour, so a lock or temp file another session is
|
||||
writing right now is never caught. **Delete these** removes
|
||||
that list and nothing else. A console running from another home
|
||||
(`PLAN2CODE_CONSOLE_HOME`) only ever looks inside that home.
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
|
||||
It is a local dev server that reads files in your project (never writing to it)
|
||||
and keeps its own state in your home folder, so it is built to be boring about
|
||||
this:
|
||||
|
||||
- Bound to `127.0.0.1` only, never `0.0.0.0`. Not reachable from your network.
|
||||
- A `Host` header allow-list, which is what stops a website you happen to be
|
||||
visiting from talking to it through a DNS rebinding trick.
|
||||
- A 128-bit token in the link, swapped for an `HttpOnly; SameSite=Strict` cookie
|
||||
on first load so it leaves your address bar, your history and any screenshot.
|
||||
- A strict Content Security Policy with no inline script allowed.
|
||||
- Markdown written by the agent is turned into page elements directly and never
|
||||
into an HTML string, so a document that quotes a hostile README cannot run
|
||||
anything. It shows up as text, which is what it is.
|
||||
- Uploads are named by the server (`<uuid>.jpg`, or `<uuid>.<ext>` with the
|
||||
extension taken from the allow-list, via `crypto.randomUUID()`), never by the
|
||||
file name you sent, and live only under the session's own `uploads/`. The
|
||||
server checks the bytes: a JPEG header for images (4 MB cap), and for
|
||||
documents a `%PDF-` header or strict UTF-8 with no NUL byte (10 MB cap).
|
||||
Documents are served back only under a fixed type (`application/pdf`, or
|
||||
`text/plain` for text and code) with `nosniff` (and `sandbox` on text), so
|
||||
the Sent box can link them. A send may only point at
|
||||
uploads inside that session's `uploads/`, images in `images` and documents
|
||||
in `files`.
|
||||
|
||||
### Routes
|
||||
|
||||
The upload routes, the send, the overview and handoff reads, the workspace and the notebook. Like every page route, they are on `127.0.0.1`
|
||||
behind the session cookie, and the ones that write also check the request's
|
||||
origin.
|
||||
|
||||
| Route | Does |
|
||||
| --- | --- |
|
||||
| `POST /upload` | Raw bytes, original name in `x-p2c-name`. `Content-Type: image/jpeg`: writes `uploads/<uuid>.jpg` and answers `{ ok, id, kind: "image", path, url, name, size }`; not a JPEG → 415, over 4 MB → 413. `Content-Type: application/octet-stream`: a document, its extension from the name's allow-listed extension; writes `uploads/<uuid>.<ext>` and answers `{ ok, id, kind: "file", path, name, size }` with no `url`; not an allowed extension or contents that do not match → 415 `type`, over 10 MB → 413. Any other content type → 415. |
|
||||
| `GET /uploads/<id>.<ext>` | Serves an upload: an image as `image/jpeg` (the thumbnail after a reload), a document as `application/pdf` or `text/plain; charset=utf-8` with `nosniff` and, on text, `Content-Security-Policy: sandbox`. Only `<uuid>.<allowed ext>` names under `uploads/`; anything else is 404. |
|
||||
| `DELETE /uploads/<id>.<ext>` | Deletes an image or document removed before sending. 204, or 404 if it is not there. |
|
||||
| `POST /submit` | The Send. A note may carry `images` and `files`, each `[{ path, name }]`: at most 5 together, images in `images` and documents in `files`, every path inside this session's `uploads/`, otherwise 400. |
|
||||
| `POST /chat` | A Quick question `{ text, about?, images?, files?, conversation }`, or `{ reset: true, conversation }` for New conversation. Appended to the session's `chat.ndjson`. 400 `too-long` (over 4,000 characters), `image`, `file` or `bad`; 409 `offline`, `stale` or `limit` (10 per conversation). Never refused because a card send is still uncollected. |
|
||||
| `POST /chat/decision` | Approve or Decline on an edit the agent proposed: `{ re, decision, text?, conversation }`. Once per proposal; does not count toward the 10. |
|
||||
| `GET /overview?spec=specs/<name>` | The Overview tab's read of `<spec>/overview.md`, as `text/markdown` with `cache-control: no-store`. On the dashboard `spec` must be one of the scanned specs; elsewhere the session's own spec is used. The file's real path must stay inside the project, so `../`, absolute paths and symlinks pointing out all get 404. |
|
||||
| `GET /handoff?id=<id>` | *Read it all*: the handoff's `.md` from `~/.plan2code/handoffs/`, as `text/markdown` with `cache-control: no-store`. A dashboard only, and only an id its own scan listed: a used, unknown or malformed id is 404. |
|
||||
| `GET /workspace` | The Workspace dialog's list: folders, `missing`, `remote` and the agent's folder `issues`. `?check=1` re-checks every folder on disk first. |
|
||||
| `POST /workspace/add` | `{ path, name?, description? }`. The path is resolved against the folder the session started in (`~` expanded) and must be a folder: 400 `not-a-folder`, `duplicate` (with its `name`; compared case-insensitively on Windows and macOS), `bad-name`, or `name-taken` with a `suggest`. Answers the new entry, `nested: true` when it sits inside another folder in the list. |
|
||||
| `POST /workspace/edit` | `{ id, name?, description? }`. Renames or re-describes one folder: 400 `bad-name` / `name-taken`, 404 `unknown`. |
|
||||
| `POST /workspace/remove` | `{ id }`. 400 `original` for the folder the session started in, 404 `unknown`. |
|
||||
| `POST /workspace/browse` | Opens the system folder picker and answers `{ path }` or `{ cancelled: true }`; never adds anything itself. 409 `busy` while one is open, 404 `no-picker` when the session looks remote or no picker exists. |
|
||||
| `GET /notepad[?tab=<id>]` | The notepad for the folder this session runs in: `{ tabs: [{ id, name }], last, tab: { id, text, savedAt, images: [{ id, url, thumb }] } | null }`, with the tab's `text`, `savedAt` and `images` repeated at the top. Without `tab` it answers the last one used; 404 `no-such-tab` for an id it does not have. A notepad in the first shape answers one virtual tab, Notes. Reading never creates or moves a file. |
|
||||
| `POST /notepad/text?tab=<id>` | `{ text }`. Saves that tab's `note.md` and answers `{ ok, savedAt }`; 400 `bad`, 404 `no-such-tab`, 413 `too-long` (over 1 MB). |
|
||||
| `POST /notepad/image?tab=<id>` | Raw `image/jpeg` (the page re-encodes every picture first). Writes the tab's `images/<uuid>.jpg` and answers `{ ok, id, url }`; 415 `not-jpeg`, 413 `too-large` (over 4 MB), 409 `too-many` (200 pictures in the tab). |
|
||||
| `POST /notepad/thumb?id=<uuid>&tab=<id>` | Raw `image/jpeg`: that picture's thumbnail. 404 `not-found` or `no-such-tab`, 415 `not-jpeg`, 413 `too-large`. |
|
||||
| `POST /notepad/image/delete?tab=<id>` | `{ id }`. Deletes a picture and its thumbnail; 404 `not-found` or `no-such-tab`. |
|
||||
| `POST /notepad/tab` | `{ name }`. Makes a tab, which becomes the last one used, and answers `{ ok, id, name }`; 400 `bad-name`, 409 `duplicate-name` (any case) or `too-many-tabs` (20). |
|
||||
| `POST /notepad/tab/rename` | `{ id, name }`. Answers `{ ok, id, name }`; 400 `bad-name`, 404 `no-such-tab`, 409 `duplicate-name`. |
|
||||
| `POST /notepad/tab/delete` | `{ id }`. Removes the tab from the index, then its folder (text and pictures); 404 `no-such-tab`. |
|
||||
| `POST /notepad/tab/order` | `{ order: [id] }`, every current id exactly once; 400 `bad` otherwise. |
|
||||
| `POST /notepad/tab/last` | `{ id }`. Remembers the open tab; 404 `no-such-tab`. |
|
||||
| `GET /notepad/images/<tab>/<uuid>.jpg`, `<uuid>.thumb.jpg` | Serves a picture or its thumbnail as `image/jpeg`, only by a tab id and a UUID name, a regular file (never a link) whose real path stays inside `~/.plan2code/notepads/`; anything else is 404. |
|
||||
| `POST /subagents` | `{ on, instruction, max }` (`instruction: null` for the shipped default). Saves the switch for this project and skill and answers `{ ok, setting }`; 400 `not-offered` on a skill without the switch, `bad`, `too-long` (over 2,000 characters) or `max` (outside 1 to 20). |
|
||||
|
||||
## For maintainers
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| Source | `src/web-console/` (one row per file in the files table of `.agents-docs/AGENTS-architecture.md`; a test keeps it complete) |
|
||||
| Ships as | `skills/<every skill>/references/web-console/` |
|
||||
| Wiring | one `additionalReferences` entry per skill in `install.js`; the dashboard's menu lives in `public/skills.js` (each entry's `card`; `SKILL_CATALOG` in `public/answers.js` is a lookup on it) |
|
||||
| Agent contract | `src/web-console/console.md` (read once), its topic files (`console-*.md`), `notes/<workflow>.md`, and `building.md` / `building-review.md` for the builds; `console.mjs help <topic>` prints any of them |
|
||||
| Tests | `node --test scripts/test-web-console-*.mjs` (split by area, shared setup in `scripts/web-console-test-helpers.mjs`), also run by `npm test` |
|
||||
| Start-up benchmark | `node scripts/bench-web-console.mjs` (needs a local Chrome or Edge for the paint columns, driven through `playwright-core` from `npm install`; `--browser-delay 900` models a real browser launch, `--roundtrip` times Send→agent and post→page) |
|
||||
| Screenshots | `node scripts/capture-screenshots.mjs` (needs a local Chrome or Edge, driven through `playwright-core` from `npm install`; `PLAN2CODE_TEST_BROWSER=chrome|msedge` forces one) |
|
||||
| Dependencies | none at runtime. `marked` 15.0.7 (MIT) is vendored for its lexer only, and CodeMirror 6 (MIT) for the notebook's editor as one bundled file, `public/vendor/codemirror.esm.js`, made by the dev-only `node scripts/vendor-codemirror.mjs` from a pinned lock (about 500 KB, loaded only when the Notebook is first opened); the page's policy blocks the `<style>` element CodeMirror writes, so the editor lives in a shadow root where it adopts its rules as a constructed stylesheet (steps in the architecture doc's Notebook point) |
|
||||
|
||||
Edit `src/` only. `skills/` is a committed build artifact: regenerate it with
|
||||
`npm run build:skills` and commit it with the source change, since `npm test`
|
||||
(via `--verify-skills`) fails when it drifts from `src/`.
|
||||
|
||||
### Driving it by hand
|
||||
|
||||
You do not need an agent to poke at the console. Point `PLAN2CODE_CONSOLE_HOME`
|
||||
somewhere disposable first, so you never touch a real session:
|
||||
|
||||
```bash
|
||||
export PLAN2CODE_CONSOLE_HOME=/tmp/p2c-play # Windows: $env:PLAN2CODE_CONSOLE_HOME
|
||||
|
||||
cat > /tmp/payload.json <<'JSON'
|
||||
{ "workflow": "pathfinder", "title": "Playing about",
|
||||
"items": [ { "id": "q1", "kind": "choice", "title": "Export format",
|
||||
"body": "Pick one.",
|
||||
"options": [ { "k": "A", "text": "CSV", "recommended": true },
|
||||
{ "k": "B", "text": "Excel" } ],
|
||||
"token": { "A": "a", "B": "b" } } ],
|
||||
"agent": { "status": "waiting" } }
|
||||
JSON
|
||||
|
||||
node src/web-console/console.mjs open --file /tmp/payload.json # prints the URL, opens the browser
|
||||
node src/web-console/console.mjs wait --session <sid> --seconds 60
|
||||
node src/web-console/console.mjs stop --all
|
||||
```
|
||||
|
||||
`node src/web-console/console.mjs help` prints the same command summary an
|
||||
agent gets when it finds the binary before the docs.
|
||||
|
||||
`wait` exits `0` with the answers, `10` if nobody has finished yet, `20` if the
|
||||
server died, `30` on Cancel. Pick `--seconds` to sit under whatever your harness
|
||||
allows a single command: it is a poller, so killing it costs nothing, and a
|
||||
collected result is printed before it is marked collected, which means an
|
||||
interrupted handover can only repeat itself, never lose an answer. `status`
|
||||
lists sessions and flags any whose answers were submitted but never collected.
|
||||
|
||||
When something misbehaves, the session directory is the whole story:
|
||||
`state.json` (what the agent published), `draft.json` (what the person has typed
|
||||
but not sent), `result.json` (what they sent), `events.ndjson` (an append-only
|
||||
log you can `cat`), and `server.log`.
|
||||
|
||||
Set `--idle-ms 60000` on `open` if you want the server to shut itself down
|
||||
quickly while experimenting.
|
||||
|
||||
Two environment variables help when the start is what you are looking at:
|
||||
|
||||
| Variable | Does |
|
||||
| --- | --- |
|
||||
| `PLAN2CODE_CONSOLE_TRACE=1` | `open` prints a timeline of its steps to stderr (roots found, server spawned, port bound, browser sent, state written, server listening). |
|
||||
| `PLAN2CODE_BROWSER` | The command that opens the link instead of the system default, run through the shell with the link appended, e.g. `PLAN2CODE_BROWSER='firefox --new-tab'`. |
|
||||
|
||||
Every `console.mjs open` also writes its own directory to
|
||||
`$PLAN2CODE_CONSOLE_HOME/console-dir` (or `~/.plan2code/console/console-dir`
|
||||
when the override is unset): it is how an agent finds the console on a later
|
||||
session without searching the skill install dirs.
|
||||
|
||||
The vendored file is `src/web-console/public/vendor/marked.esm.js`,
|
||||
sha256 `7a7d9a521ac9384e0c3a075120a7c486cbd0c3c32cc5601bbb79a23e97403690`.
|
||||
Only `marked.lexer()` is used; the rendering is ours, in `public/render.js`, and
|
||||
builds DOM nodes rather than HTML so nothing needs sanitising.
|
||||
|
||||
### Refreshing the screenshots
|
||||
|
||||
The docs and the landing page show the console through the images in
|
||||
`docs/screenshots/`, one light and one dark WebP per screen. Rerun the capture
|
||||
after any change a person would see on the page: a new layout, a renamed
|
||||
button, a different colour.
|
||||
|
||||
```bash
|
||||
node scripts/capture-screenshots.mjs # every screen
|
||||
node scripts/capture-screenshots.mjs --only dashboard # one screen
|
||||
```
|
||||
|
||||
Each screen is staged with no agent, from the payloads in
|
||||
`scripts/screenshots/` (its README names the file behind each screen), in a
|
||||
throwaway sample project and console home that the script removes when it is
|
||||
done. It prints each file's size and warns over 300 KB.
|
||||
|
||||
Open every image before you commit it: the right screen, both themes, nothing
|
||||
cut off, and no username, home path or real project name anywhere on it.
|
||||
@@ -1,6 +1,6 @@
|
||||
# AGENTS.md
|
||||
|
||||
This file provides guidance to AI coding agents like Claude Code (claude.ai/code), Cursor AI, Codex, GitHub Copilot, Devin, Zed, and other AI coding assistants when working with code in this repository.
|
||||
This file provides guidance to AI coding agents working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
|
||||
@@ -10,9 +10,11 @@ Plan2Code is a structured 4-step workflow methodology for AI-assisted software d
|
||||
**Author:** Justin Parker
|
||||
**License:** MIT
|
||||
|
||||
Plan2Code is started from the project the person works in (`cd` into it, then run `plan2code`), not from this repository; every newcomer doc says so, next to the Node.js 18+ requirement.
|
||||
|
||||
## How to Use This File
|
||||
|
||||
This file is an index — each section below contains a brief summary and a link to a detail file in `.agents-docs/`. Read only the sections relevant to your current task. Full details (commands, tables, file lists) are in the linked files. The sections "Git Commit Messages" and "Project Overview" are fully inline here.
|
||||
This file is an index — each section below contains a brief summary and a link to a detail file in `.agents-docs/`. Read only the sections relevant to your current task. Full details (commands, tables, file lists) are in the linked files. The sections "Project Overview", "How to Use This File", "Mascot", and "Keeping this file current" / "Failure log" are fully inline here and are never split into `.agents-docs/`.
|
||||
|
||||
## Architecture
|
||||
|
||||
@@ -34,13 +36,24 @@ Details: [Plan2Code Metrics](./.agents-docs/AGENTS-plan2code-metrics.md)
|
||||
|
||||
## Plan2Code Status Line (Claude CLI)
|
||||
|
||||
Optional CLI status bar (`src/statusline-claude/`) for Claude Code. Displays model, project, branch, context usage, usage stats (rate limits or token counts), git diff stats, and duration. Reads data directly from Claude Code's stdin JSON — no API calls, no auth, no background processes. Included in `Install All + dev tools` (`A`); also available via `install.js` Custom → S (opt-in).
|
||||
Optional CLI status bar (`src/statusline-claude/`) for Claude Code. Displays model (+ effort), project/worktree, branch, git diff stats, duration + session cost, context usage, and usage stats (rate limits or token counts). Reads data directly from Claude Code's stdin JSON (plus timeout-bounded git calls): no API calls, no auth, no background processes.
|
||||
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md) (see Status Line section)
|
||||
|
||||
## Web Console
|
||||
|
||||
Optional local browser UI (`src/web-console/`, zero dependencies, detached `node` server on `127.0.0.1`) bundled into every skill via `additionalReferences`. The bare `plan2code` skill opens its dashboard, a card menu that launches any skill in the same session. Pages cover questions, sign-off gates (with an in-page code review), build progress, the living document, an **Ask** chat, a read-only **Workspace** of extra folders (remembered per folder and spec in `~/.plan2code/console/workspaces.json`), a session meter, a **git board** for the `git` workflow (three tabs, Changes, Branches and Sync, opening on the likely next step; branches, pull, push, commits and pull-request links, drawn from `state.git`; contract in `notes/git.md`), **Stop with a handoff** (handoffs live in `~/.plan2code/handoffs/`, owned by `handoffs.mjs`, swept after 30 days, and offered as dashboard chips to pick up in the same session), a private **Notebook** in the top bar (named tabs of Markdown and pictures, a live-preview CodeMirror editor, one notepad per folder in `~/.plan2code/notepads/`, owned by `notepads.mjs`, never shown to the agent, removed only through Cleanup once a month untouched), a built-in 18-topic Help, a first-run Welcome, User Preferences (gear) and a bug/idea link to GitHub issues. On opted-in skills (builds, review, Pathfinder) a **Subagents** button in the top bar turns helpers on or off per project and skill (on by default for those skills until switched off, saved in `~/.plan2code/console/subagents.json`); the agent hears of it as a standing instruction only when it changes, and reports its helpers in a **Subagents** tab beside Ask (contract in `console-subagents.md`). Per-skill facts live in one list, `public/skills.js`, from which the meter, the resume command, Help's card list and the CLI's workflow list are derived; task files are read through `spec-files.mjs` (shared with the `specs.mjs` skill script), and the rule for which hops start the page clean is `startsClean()` in `public/hops.js`. The agent contract is read in pieces: `console.md` once per conversation, then a topic file (`console-*.md`, `notes/<workflow>.md`, `building*.md`) only when its moment comes; the server never writes into a project.
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md) (see Web Console section) and [.readme/web-console.md](./.readme/web-console.md)
|
||||
|
||||
## Skill Scripts
|
||||
|
||||
Deterministic workflow steps run as Node scripts shipped in each skill's `scripts/` (shared ones in `src/skill-scripts/`, a skill's own in `src/<skill>-scripts/`, listed per skill in `SOURCE_PROMPTS` → `scripts`). Prose keeps the judgment. JSON on stdout, documented exit codes, tests run against the built `skills/` tree.
|
||||
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md) (see Skill Scripts section)
|
||||
|
||||
## Development Commands
|
||||
|
||||
Build commands, installer menu options, how the installer generates platform-specific files, platform format table, and how to edit workflow prompts.
|
||||
Build commands, installer menu options, non-interactive skill-build verification, skills CLI delegation, skill format, and how to edit workflow prompts.
|
||||
|
||||
Details: [Development Commands](./.agents-docs/AGENTS-development-commands.md)
|
||||
|
||||
@@ -52,11 +65,44 @@ Details: [Code Style & Gotchas](./.agents-docs/AGENTS-code-style.md)
|
||||
|
||||
## Mascot
|
||||
|
||||
The project has a mascot called "Planny" — an ASCII art robot that appears in installer output and workflow prompts. Mascot variants are defined in the `MASCOT` constant in `install.js` and appear in workflow markdown files.
|
||||
The project has a mascot called "Planny": a box with a star for an eye, stick arms and two small feet. He appears in installer output, workflow prompts, the loop, the Claude Code status line (box, star and feet, no arms) and the web console. ASCII variants are defined in the `MASCOT` constant in `install.js` (and `plan2code-loop/src/utils/logger.ts`) and appear in workflow markdown files: arms down at rest, one arm waving when he is asking something, both arms up when he is celebrating. The eye is always the star.
|
||||
|
||||
The web console draws him as inline SVG in `src/web-console/public/index.html`, where he doubles as the page's state indicator: his star lights in the highlight colour and he waves when something is yours to do, the star turns and his feet walk while the agent works, it goes green when all is done, he shows no arms at all when the agent is not answering, and he fades with his star shut when the connection drops. The parts are classed (`shell`, `eye`, `smile`, `foot`, and one `arms a-<mood>` set per mood) and `screens/core.js` switches mood with a single class, so the drawing stays in the markup and the styling in `styles/planny.css`. The nine skill start poses, the dashboard wake-up, `favicon.svg` / `favicon.js` and `src/launcher/plan2code.ico` all use the same design.
|
||||
|
||||
```
|
||||
╭───╮
|
||||
│ ● │
|
||||
│ ◡ │
|
||||
╰───╯
|
||||
╭───╮
|
||||
│ ★ │╱
|
||||
╱│ ◡ │
|
||||
╰┬─┬╯
|
||||
```
|
||||
|
||||
## Keeping this file current
|
||||
|
||||
The `Failure log` section below is a recording of mistakes made by previous AI Agents while working with this code base.
|
||||
|
||||
When you make a mistake, get corrected, or discover something about this codebase that wasn't written down:
|
||||
|
||||
1. Add one line to the `Failure log` below, in the imperative, describing the correct behaviour.
|
||||
2. Keep it specific to this repo. General advice belongs nowhere.
|
||||
3. If this fix is a workflow rather than a rule, put it in `.claude/skills/` and link it from here.
|
||||
4. Include the change in the same commit and mention it in your summary.
|
||||
5. A skill rule broken twice becomes a script check (a `scripts/` test or a skill-script check), not more prose.
|
||||
6. Before adding a line, look for one on the same topic: sharpen or extend that one rather than adding a near-duplicate.
|
||||
7. Keep the log to 17 entries at most. Over the cap, first merge entries that share a cause, then drop the lowest-value ones: one-offs unlikely to recur, rules a test or script now enforces, and entries about code that no longer exists.
|
||||
|
||||
## Failure log
|
||||
|
||||
- Do not audit `CHANGELOG.md` headings through PowerShell — the emoji come back as `?`. See the gotcha for the correct approach.
|
||||
- Sync upstream only through `/sync-repo`, and verify its baseline against the real tree before porting: an earlier sync silently skipped a whole upstream release (the `3-implement-review` skill) while the recorded version froze. Update the baseline with `.claude/skills/sync-repo/set-synced.mjs`, never with a shell pipe over the decrypted body.
|
||||
- After a sync merge, run `npm test` before trusting a "clean" file: when upstream and plan2code fixed the same bug, `git merge-file` keeps both copies without a conflict (a sync once left `let pattern` declared twice in `app.js`, caught only by `parse-check`).
|
||||
- When extracting upstream files in Git Bash, run `git show <ref>:<path>` with `MSYS_NO_PATHCONV=1` and `C:/` style paths (never `/c/`): path conversion rewrites `origin/main:.readme/x.md` into `origin\main;.readme\x.md`, the show fails, and the merge silently runs against an empty "theirs". Check every extracted file is non-empty before merging.
|
||||
- After a sync, grep the result for every upstream name the rebrand map can miss (the `/sync-repo` body lists them): the owner slug and company name in any case, the bare brand word inside identifiers and fixtures, and the ticket key followed by anything, not only digits. Each slipped through once: an owner slug in `feedback-payload.mjs` and its test (fixed by hand to `jparkerweb/plan2code`); in v2.7.0 a `KEPT_<BRAND>_ENTRIES` constant, a `<brand>Dir` option, a `"<brand>"` test folder and an owner slug in a git remote URL; in v2.8.0 git board fixtures built as `` `feature/<KEY>-${11000 + i}-…` `` template literals, which a digits-only rewrite to `ABC-<n>` misses. No upstream name may appear in plain text anywhere in this repo.
|
||||
- Keep plan2code's ticket-free `commit-msg.mjs` (`<subject>`, `AI Assisted`) in every `/sync-repo`: upstream's ticket-from-branch rule was ported by mistake once and removed in v2.6.0.
|
||||
- When a new first-run dialog is added to the web console, set its seen flag in `scripts/capture-screenshots.mjs`'s `looks.json` too: the Welcome dialog once covered the regenerated dashboard screenshots until `welcomeSeen: true` was added.
|
||||
- Import `scripts/skill-script-helpers.mjs` in any test that builds git fixtures for a skill script or `git-repo.mjs`: it scrubs the whole test process's git config, so fixtures, imported modules and spawned scripts agree. Mixed configs broke `git plan switch` once (a global `core.autocrlf=true` checked fixtures out with CRLF the scrubbed script read as changed).
|
||||
- Before deleting a test file that upstream split or removed, diff plan2code's copy against the rebranded upstream base and port the plan2code-only tests: v2.7.0's split of the web console suite would otherwise have dropped seven hardening tests (now in `scripts/test-web-console-hardening.mjs`).
|
||||
- Register a new skill in `install.js` `SOURCE_PROMPTS` before running its `scripts/test-script-<name>.mjs`: importing `scripts/skill-script-helpers.mjs` rebuilds `skills/` and prunes any skill folder `install.js` does not list, so the script under test vanishes.
|
||||
- When a `CHANGELOG.md` heading gets a version number, set the same number in `version.json` (with its `releaseDate`), the root `package.json` and README's `Version X.Y.Z` line in the same change, then run `npm run build:skills`. The changelog skill only touches `package.json`: v2.9.0 nearly shipped with `version.json` at 2.8.1, and README's line sat at 2.6.0 for three releases.
|
||||
- When `npm test` fails only timing-bound suites (the chat stress test, the page-cards redraw test "a redraw keeps the place of...", then a cascade in the session suite starting at "no submitted frame within 5s") while the machine is busy, rerun those files alone, and the `node --test` list with `--test-concurrency=4`, before suspecting the change: they failed that way on untouched code under load during the web console file split, and the redraw test did again in three phases of web-console-health. In web-console-notepad, four more failed only in full runs and passed alone: the Workspace page's @-mention test, the dashboard page's handoff chip test, the session suite's document route (`connect ETIMEDOUT`) and the notepad page's 200 KB typing test (why its budget there is 200 ms, not the 92 ms it takes alone).
|
||||
- Post a helper as `done` or `failed` in the same turn its completion notice arrives: its row stays `running` on the Subagents tab until a post says otherwise (a build once reached its sign-off with one row spinning). A `finish` is now refused while any helper is `running`.
|
||||
- Bring the Windows folder picker (`picker.mjs`, copied into `src/launcher/plan2code.js`) to the front with an Alt tap before `SetForegroundWindow`, never with `windowsHide`, the owner form's `TopMost`, `HWND_TOPMOST` or `AttachThreadInput`: measured on Windows 11, `SetWindowPos(HWND_TOPMOST)` returns true while the dialog stays non-topmost behind the browser, and only the Alt tap made it the foreground window. Check with `GetForegroundWindow` from a second process, since no test can see it.
|
||||
@@ -2,6 +2,404 @@
|
||||
|
||||
All notable changes to Plan2Code will be documented in this file.
|
||||
|
||||
## v2.11.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **web console**: the Notebook has named **tabs**. Each tab is its own Markdown note with its own pictures, kept in its own folder under the notebook's (`tabs/<id>/note.md` and `images/`, with a `tabs.json` index). **+ New tab** asks for a name (1 to 40 characters, no two alike in any case, up to 20 tabs). A tab can be renamed (button, double-click or F2), reordered (drag, Move left and Move right, or Alt with the arrow keys) and deleted, which asks twice and removes its text and pictures. The tab left open is the one that opens next, and with no tab left the dialog offers to make one. Saves and pictures are bound to the tab they were made in, so switching never moves either; a switch that cannot save first stays put and says why.
|
||||
- **web console**: five routes (`POST /notepad/tab`, `/tab/rename`, `/tab/delete`, `/tab/order`, `/tab/last`), `?tab=` on the text and picture routes, and picture addresses that carry the tab (`/notepad/images/<tab>/<uuid>.jpg`).
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **web console**: the Notepad is now called the **Notebook** (the icon is unchanged), in the top bar, the dialog, the Help, the docs and the screenshots. Code names, routes and the `~/.plan2code/notepads/` folder keep their names, so nothing already saved moves. The dialog's line about it being never shared to the AI Agent is bold, in the highlight color.
|
||||
- **web console**: every document tab and the Overview has a **Back to Questions** button (Dashboard or Git on those screens) left of Print and Download, with a highlight border, and that header row stays at the top of the pane while the document scrolls.
|
||||
- **web console**: the Notebook editor is now CodeMirror 6 with live in-place Markdown: headings grow, bullets draw and the marks come back on the line the cursor is on. It replaces OverType after a spike showed typing in a 200 KB note about four times faster. The editor ships as one vendored file loaded only when the Notebook first opens, and runs in a shadow root so the page's content-security policy stays as strict as before.
|
||||
- **web console**: an existing notebook opens as one tab called **Notes**. Reading it writes nothing; the first edit moves the note and pictures into the tab, and a crash part way is finished by the next write.
|
||||
- **contributors**: `scripts/vendor-codemirror.mjs` and its lock file build the editor bundle reproducibly; the OverType vendor script, its CSS and its page helpers are gone.
|
||||
|
||||
## v2.10.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **web console**: a private **Notepad** in the top bar, on every screen. It opens a modal with a Markdown editor that styles as you type (OverType 2.6.1, vendored, MIT) and saves as you go, with pictures: paste, drag and drop or **Add image**, each shrunk to JPEG in the browser, shown as a thumbnail strip with an X that asks before deleting, and a full-screen preview. There is one notepad per project folder, kept in `~/.plan2code/notepads/` (`notepads.mjs`) and never shown to the agent. User Preferences → Cleanup offers a notepad for removal only when its newest file is 30 days old or more, as one item that removes the whole folder; the automatic sweep at open never touches it.
|
||||
|
||||
- **web console**: a finished screen whose next step is a Plan2Code skill has a **Continue here** button beside the Next step block. One press starts that skill in the same session, as a dashboard card would, on a clean page. It is hidden when the session meter is red (a fresh conversation is the better choice), on a pause and for a git command. The page does it alone: the agent only handles the `__launch` the dashboard already sends, and posts `finish: null` first when the next step is the same skill (Implement to Implement).
|
||||
- **web console**: a finished Quick Task or Finalize can offer **Update CHANGELOG first** beside **Commit it now** (`finish.changelog: true`, refused on any other workflow). It hops into Changelog in the same session, and Changelog's yes to *Commit this now?* carries on to Git. The press arrives as `__changelog`.
|
||||
- **web console**: the Ask contract (`console-chat.md`, *Prompts to carry away*) tells the agent to answer a new-task question, or a request for a prompt, with the explanation and one self-contained prompt in a fenced block. The page already gave every fenced block a Copy button, so there is no page change.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **web console**: the dashboard has one Implement card instead of Implement and Implement + Review. Its confirm pane has a Review checkbox, ticked by default, that launches Implement + Review when ticked and plain Implement when not; the command shown follows the box.
|
||||
- **web console**: `open` and `handoff new` refuse a `--workflow` the console does not know (exit 2, naming the valid ones), instead of opening a session no skill answers. `open` with no `--workflow` still opens Pathfinder.
|
||||
- **web console**: Help's list of dashboard cards is built from the cards themselves, so it can never name a card the dashboard lacks: it follows the dashboard's order (Handoff last under *Useful any time*), and X-ray's line is its card's.
|
||||
- **web console**: a hop into Git from any skill now starts the page clean on both sides. The server always cleared it; the page kept the last skill's tab and staged answers.
|
||||
- **contributors**: the per-skill tables that were still kept by hand now come from `public/skills.js`: the meter's weights and labels (`WEIGHTS`, `LAUNCH_LABELS`, `RUN_LABELS` in `meter.js`), `resumeCommand()`'s switch in `answers.js`, Help's card list in `index.html` (now filled by `buildHelp()` in `screens/help-dialog.js`) and `cmd-help.mjs`'s workflow list. Each entry gains `weight`, `started`, `ran`, `resume` and an optional `card.help`, and `skills.js` exports `WORKFLOWS` and `isWorkflow()`. A test fails, naming the file and the name, when `console.md`, `src/plan2code.md` or the CLI's help drift from the list.
|
||||
- **contributors**: two new shared modules. `src/web-console/spec-files.mjs` holds the task markers and the task-line, checkbox and Status-line patterns with `statusOf()` and `countTasks()`, read by `scan.mjs` and the `specs.mjs` skill script, which no longer keep copies of their own; `patches.mjs` now takes `TASK_LINE_RE` from it instead of from `scan.mjs`. `src/web-console/public/hops.js` holds `startsClean()`, the rule for which hops start the page clean, called by `cmd-open.mjs`, `server.mjs` and `screens/core.js`.
|
||||
- **contributors**: for the upstream port, these moved: the meter tables, `resumeCommand()`'s switch, Help's card markup and `cmd-help`'s workflow list into `skills.js` fields; the markers and patterns in `scan.mjs` and `specs.mjs` into `spec-files.mjs` (and `TASK_LINE_RE` tightened on the way: exactly one space before the box and a case-sensitive `Task`, matching `TASK_ID_RE`; keep that when porting); the hop test in `cmd-open.mjs`, `server.mjs` and `screens/core.js` into `hops.js`. Port upstream's changes to those tables into `skills.js` and the two modules, not back into the old files.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **web console**: Workspace's Browse… folder picker (and the launcher's) no longer opens behind the browser on Windows. Windows refused the picker's `SetForegroundWindow`, because the picker is spawned by the detached console server and is not the process that last had input; the existing topmost flag is ignored by that dialog. It now waits until the dialog is visible, taps Alt (which lifts the foreground lock for the next call), and takes the foreground.
|
||||
- **dashboard**: an assumed task (`[?]`) counts as done and is named in the spec's line ("3 of 4 tasks done, 1 assumed"). It used to be left out of the count altogether, so that phase read "2 of 3 tasks done", and a spec whose tasks were all assumed read as not started. Numbered task lines (`1. [x] **Task ...`) count too, on the dashboard and in the `specs.mjs` skill script.
|
||||
|
||||
## v2.9.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **building habits**: Quick Task, Implement and Implement + Review now read one shared reference file, `references/building-habits.md`, at three moments. When a bug or an unexpected failing test turns up, they find the cause first: build a command that fails on the bug before changing code (or say why they cannot, rank their guesses with the evidence and let you decide), then keep the reproduction as a regression test in the project's existing test runner. When the plan asks for it, they build test first: write the test, see it fail for the right reason, then write the code. Before a restructure meant to change no behaviour, they pin the behaviour with tests that must pass unchanged afterwards. Adapted from Matt Pocock's [`diagnose`, `tdd` and `improve-codebase-architecture`](https://github.com/mattpocock/skills) skills and pstack's debugging playbook (both MIT).
|
||||
- **plan**: the testing question gains a fourth choice, **Approach**: code first (the default) or test first. Test first is recorded in the PLAN-DRAFT's Testing Strategy table, and Document then orders each task's test before its code with a `Test:` line under the task naming where the test drives the behaviour.
|
||||
- **review**: reviews run in a fresh helper that never saw the build; reports say how they ran. Wherever the tool can start a helper and the web console's Subagents switch is not off, every review (`/plan2code-review`, Implement + Review's Stage 2, Implement's "review" at sign-off and Quick Task's "Review it now") hands its analysis to one helper briefed only with the spec and the change set (the new `references/reviewer-brief.md`). The main session checks every finding in the source before you see it and drops what it cannot confirm. Each report carries a **Reviewed by** line: a fresh helper (with how many findings were checked and dropped), or this session, said once as not independent. Adapted from pstack's independent reviewer and Matt Pocock's [`code-review`](https://github.com/mattpocock/skills) guidance (both MIT).
|
||||
- **xray**: a new skill, **Codebase X-ray** (`/plan2code-xray`), on the dashboard under *Useful any time*. Explain an area: how it works and why it is that way, citing files and the commits and pull requests behind it (git history always, `gh` when it is installed and signed in, and it says once which sources it could not use). Or find the rough spots: files that always change together, thin wrappers, tangled boundaries and busy code with no tests, ranked with a concrete "to change X today you must touch..." example each. You tick the ones worth fixing and only those go into `specs/<name>/ARCHITECTURE-BRIEF-<date>.md`, ready for Pathfinder or Plan. A new script, `xray.mjs`, does the counting from git history. Pathfinder and Plan point at it when the code is unfamiliar. Adapted from Matt Pocock's [`improve-codebase-architecture`](https://github.com/mattpocock/skills) skill (MIT) and pstack's codebase survey, `how` and `why`.
|
||||
- **diagnose**: a new skill, **Diagnose a bug** (`/plan2code-diagnose`), on the dashboard under *Useful any time*. It finds a bug's cause and writes it up without fixing it, under the find-the-cause-first habit: a command that fails on the bug first (or, when it cannot build one, its guesses ranked with the evidence), then the cause in `specs/<bug-name>/DIAGNOSIS-<date>.md`. It then offers `/plan2code-quick-task` to fix it, or `/plan2code-1-plan` when the fix is big. The dashboard shows such a folder as a new spec state, **Bug diagnosed**, which lights Quick Task (suggested) and Plan and keeps Document, Implement, Implement + Review and Finalize greyed. Adapted from Matt Pocock's [`diagnose`](https://github.com/mattpocock/skills) skill and pstack's debugging playbook (both MIT).
|
||||
- **quick-task**: asks "Write the test first?" when the change alters behaviour and the project already has a test runner, and names the test spot in the plan's Verify section. A bug fix starts with its reproduction.
|
||||
- **show me it working**: Implement, Implement + Review, Quick Task and Finalize offer to show the change running before you approve, never required: reply `show me` in the terminal, or press **Show me it working** on the web console. The agent starts the app the way `AGENTS.md` says (working it out from the project and offering the line for `AGENTS.md` when it is missing, or asking you), looks at the change, stops what it started and records one line saying what was run and what was seen. Screenshots appear on the page only, never under `specs/`. Init and Init Update now ask how to start the app and where to view it. Adapted from pstack's proof-on-the-running-app idea (MIT).
|
||||
- **web console**: a doc can show a picture. An image block (`"image": "shots/<name>.png"`) shows a PNG, JPEG or WebP the agent saved under the session's `shots/` folder; anything outside that folder, over 5 MB or not really an image is refused.
|
||||
- **launcher**: `plan2code update` updates everything that was installed (the skills, the `plan2code` command and any of the status line, `plan2code-loop`, `plan2code-metrics` and `plan2code-bot`), with no menu and never uninstalling. Every global install now writes `~/.plan2code/install.json` listing what it installed, which `install.js --update` reads; with no record it updates the skills and the `plan2code` command.
|
||||
- **launcher**: `plan2code` prints one line before it starts your agent when a newer release is out: `Plan2Code v<latest> is out (you have v<installed>). Run: plan2code update`. It reads the web console's saved release check, so it never waits on the network; when that check is missing or old it refreshes it in the background for the next start.
|
||||
- **web console**: **Stop session** gains a second way to stop, **Stop with a handoff**. It saves the skill's place as before and also writes a Handoff document, so a quick task, a review or a half-done changelog keeps its context; the paused screen names the file.
|
||||
- **dashboard**: this checkout's unused handoffs show as chips in the spec picker. **Pick it up here** carries on in the skill that stopped (a handoff from the Handoff skill carries on in Quick Task), in the same session, and the chip is gone afterwards; **Read it all**, **Copy for a new conversation** and **Delete** sit beside it.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **implement**, **quick-task**, **plan**, **document**: tightened as they took on the habits, so each stays well under 15,000 characters.
|
||||
- **pathfinder**: tightened to stay under 15,000 characters as it took on the X-ray pointer.
|
||||
- **quick-task**, **implement**: when the cause is unclear or the fix big, they stop and suggest `/plan2code-diagnose`.
|
||||
- **finalize**: its archive confirmation now reads "yes / no / show me", the last chance to look at the whole feature running before the spec moves.
|
||||
- **dashboard**: Handoff is now the last card in *Useful any time*, after Git.
|
||||
- **contributors**: the add-a-skill checklist in `.agents-docs/AGENTS-development-commands.md` now lists every place a new skill must be registered (it missed about a dozen).
|
||||
- **contributors**: `AGENTS.md` gains a rule that a skill rule broken twice becomes a script check, not more prose.
|
||||
- **web console**: the UPDATE AVAILABLE dialog now gives `plan2code update` as the command, keeping the install command beside it for a machine without the `plan2code` command. User Preferences → Cleanup never lists `~/.plan2code/install.json`.
|
||||
- **docs**: README, the quick reference and the web console guide say to update with `plan2code update` (or re-run the install command).
|
||||
- **handoff**: every handoff now lives in `~/.plan2code/handoffs/` (a Markdown file plus a small `.json` beside it), owned by the web console, and handoffs older than 30 days are swept when the console opens. The Handoff skill writes there with no folder or `.gitignore` question, and Cleanup never lists the folder. Handoffs written to the OS temp folder or a `handoffs/` folder before this change are not listed.
|
||||
- **dashboard**: a **Bug fixed** spec has a visible **Delete** that needs one confirm, and its chip no longer repeats the "bug fixed" line.
|
||||
- **web console**: the review sign-off card lists **Approve this phase** before **Show me it working**, with the approve button outlined in the accent colour.
|
||||
- **web console**: a sign-off's **yes** button (Quick Task's **Build it**, Finalize's **Archive it**) is outlined in your highlight colour too, like **Approve**. So is the yes of a yes/no question (such as Plan's **Write the plan**) and a recap's **Yes, that is right**, except on a question marked dangerous, whose yes stays red.
|
||||
- **web console**: **Skip this one** (and **Do not skip**) on an optional question is a small button in your highlight colour, like a comment box's **No changes**, instead of an underlined link.
|
||||
- **init**, **init-update**: the *Keeping this file current* section they write into `AGENTS.md` gains three rules: a rule broken twice becomes an automated check, a new Failure log line first looks for one on the same topic to sharpen instead, and the log holds 17 entries at most (over the cap, merge entries that share a cause, then drop the lowest-value ones). Init update offers the missing rules to an existing section and tidies the log on every run, showing each merge and removal for a yes before it writes.
|
||||
- **contributors**: this repo's `AGENTS.md` follows the same Failure log rules, and its three post-sync grep entries are merged into one.
|
||||
- **contributors**: the web console's source is split by job: `lib.mjs`, `server.mjs`, `console.mjs`, `app.js` and `app.css` become `routes.mjs`, `static.mjs`, `cmd-*.mjs`, the by-job Node files, `public/screens/` and `public/styles/`. Nothing a person sees changes, and the page starts faster (ready in about 280 ms, was 450 ms).
|
||||
- **contributors**: the per-skill and per-spec-state tables live in two data files, `public/skills.js` and `public/spec-states.js`, so adding a skill or a state is a short list in `.agents-docs/AGENTS-development-commands.md` and `npm test` names anything missed. This replaces the long add-a-skill checklist noted above.
|
||||
- **contributors**: page tests drive the real console in Chrome or Edge through `playwright-core` inside `npm test` (running it needs Node 20 or newer; installed skills still need only Node 18). The screenshot and speed scripts use it too, with no hand install, and `scripts/css-snapshot.mjs` compares every computed style across a stylesheet change.
|
||||
- **contributors**: a test keeps the files table in `.agents-docs/AGENTS-architecture.md` complete: every console file needs a one-line row.
|
||||
- **contributors**: `post` now refuses a `finish` (exit 3) while any reported helper still shows `running`, so a finished page never keeps a spinning row. The agent contract in `console-finish.md` says to mark each helper `done` or `failed` first.
|
||||
|
||||
### 🗑️ Removed
|
||||
|
||||
- **handoff**: the Handoff skill's `handoff-path.mjs` script is retired in favour of `console.mjs handoff new`, which every skill can reach.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **web console**: a short card on the git board (a confirm such as *Delete 2 branches?*) fills the board's width instead of sitting narrow in the middle.
|
||||
- **web console**: a redraw no longer throws you back to the top of the finished screen, a doc tab, the Overview or the dashboard menu (pressing **Review it now**, or an agent update landing while you read). The page kept your place only on question cards; it now keeps it for whatever is scrolling, as long as the same thing is still on screen.
|
||||
- **dashboard**: a bug folder whose diagnosis Quick Task had marked `Fixed` no longer sits on the dashboard forever as *Files on disk*, pre-selected as the most recent spec with no card to clear it. The scan reports it as a new spec state, **Bug fixed**: no pipeline card lights for it, the picker never opens on it (it opens on the most recent spec still in play, or *Start from scratch*), and it is hidden while *Hide unavailable workflows* is on, dimmed otherwise. Quick Task, right after marking a diagnosis-only folder `Fixed`, offers to archive it to `specs--completed/<bug>/` with the same `specs.mjs archive` Finalize uses (a confirm card on the web console).
|
||||
|
||||
## v2.8.1
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- **docs**: the docs site now shows the git board, with a light and dark screenshot under the pipeline's "Any time" cards: the Changes, Branches and Sync tabs, opening on the likely next step, the tab badges, the single block for a stopped rebase or merge, and asking before every push, publish or delete.
|
||||
- **docs**: `scripts/capture-screenshots.mjs` gains a `git` shot. It builds a sample repository with a pushed feature branch and three changes to commit, so `node scripts/capture-screenshots.mjs --only git` regenerates the images.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **tests**: `npm test` no longer fails `git plan switch` on a machine with a global `core.autocrlf=true`. `scripts/skill-script-helpers.mjs` now strips back the git config for the whole test process, so test fixtures, imported modules and the scripts under test always use the same settings.
|
||||
|
||||
## v2.8.0
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **git**: the web console's git board is now three tabs, **Changes**, **Branches** and **Sync**, and opens on the tab holding the likely next step. Ten fixed rules pick that step from the repository's state (fix or continue a stopped rebase or merge, make the first commit, make a branch on a detached HEAD, commit or start a branch for your changes, pull, push, publish, open a pull request, clean up branches) and show it as one main button with at most one quieter one beside it. Each tab badges what is waiting on it, and the other tabs say "Next step is on ‹tab›" with a link to it. Your own click moves you to the next step's tab once it lands; a refresh or a commit from the terminal leaves you where you are, and a reload keeps your tab.
|
||||
- **git**: held-back files (secrets, files over 5 MB) no longer keep Commit as the next step forever. They get a quiet "held back" line and an **Add … to .gitignore** offer, which commits only `.gitignore`.
|
||||
- **git**: a busy board is read-only. While a git command runs or the agent has not picked up your last click, every button, tick and picker greys out (switching tabs, search and folds still work), and what is running shows where the next step usually sits. Plan2Code's questions now appear under the tab strip.
|
||||
- **git**: a rebase or merge stopped on conflicts shows one block on Sync with the files marked *markers left* or *resolved*, one main button and **Abort** once; Changes and Branches wait until it is finished or aborted.
|
||||
- **git**: **Done with git** is a normal button at the right of the tab strip. It greys while a git command runs (Stop session in the top bar still works), and while one of Plan2Code's questions waits it cancels that question and finishes.
|
||||
- **web-console**: Help → *The git board* is rewritten for the tabs, badges, the next step, the busy rules and Done with git. Handoff is described as packing the current session, not this conversation.
|
||||
- **docs**: the docs site's "Any time" skills now list **Changelog** and **Git** beside Quick task, Review and Handoff.
|
||||
- **tests**: `scripts/test-web-console-git-board.mjs` checks every sample repository state's next step, tab and badges, proves no control on a busy board is clickable, and that every board function is reachable on some tab.
|
||||
|
||||
## v2.7.1
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **implement**: Implement no longer says there is nothing left to do while the dashboard keeps Finalize greyed out. When every phase is approved but tasks under them are still open (usually manual steps an agent could not do, left blocked `[!]` with a "User action"), `specs.mjs status` now returns a `checkoff` verdict listing them, and Implement asks about each one in turn: "Is this done?" in the terminal, or a **Done, check it off** / **Not yet** card in the web console. A yes runs the new `specs.mjs tick <spec> --task <id>`, which marks the task `[x]` and adds a "Confirmed done by the user on <date>" line under it. Once nothing is left open, Implement points to `/plan2code-4-finalize` and the dashboard shows the spec as ready to finalize.
|
||||
|
||||
## v2.7.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **git**: a new `/plan2code-git` skill and dashboard card that puts branches, pull, push and commits on one board in the web console. The board shows the branch you are on with what is ahead or behind, when the remotes were last refreshed, and every local and remote branch: current and default first, **Merged** and **Remote copy deleted** marked, remote-only branches folded after 50, and a search box. Every click is one action the agent runs, and the bar locks until it is done.
|
||||
- **git**: branch actions on the board: switch (asking first when you have changes: **Switch and bring them**, **Commit first** or **Cancel**), create `<type>/<description>` branches from any branch, delete local branches (a red confirm when unmerged) and **Clean up** merged and remote-deleted ones in one go. A remote branch is never deleted.
|
||||
- **git**: pull with conflict help. A pull that stops on conflicts offers to resolve them, shows each stop's files with a reason and a diff, and waits for **Continue**, **Change it** or **Abort pull**. Files it cannot resolve with confidence are named and left alone.
|
||||
- **git**: push and publish, each asking first with the exact command, never a force-push. After a push or publish the board links to the host's new pull request page (GitHub, GitLab, Bitbucket, Azure DevOps); an unknown host is asked about once and remembered in `~/.plan2code/console/pr-hosts.json`. Bitbucket PR links are unverified.
|
||||
- **git**: plain instructions in the terminal, such as `/plan2code-git switch to main` or `/plan2code-git commit and push`, run at once with the same confirms the board shows. Commits keep the `<subject>` / `AI Assisted` format.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **web-console**: agents get through each turn faster. The agent instructions are split: a short `console.md` (21 KB, was 86 KB) is read once per conversation, and every skill copy is the same, so a dashboard hop doesn't re-read it. Topic files (ending a session, Quick questions, Workspace, helpers, launches, the meter, troubleshooting, each workflow's notes, the in-page review) are read only when they're needed. `console.mjs help <topic>` prints any of them.
|
||||
- **web-console**: one command per turn. `post --wait <N>` posts and then waits. Collecting a send marks the agent working, and a new question (or a wait with one open) hands the turn back, so agents no longer post a status first. `"settle": true` records the cards just answered from what was sent.
|
||||
- **web-console**: builds no longer retype the phase file after every task. A doc block can name a file (`{ "file": "specs/x/phase-3.md" }`, `"select": "tasks"` for the task lines) that the console reads from the project. `"refresh": true` re-reads it, and a doc's version moves up by itself when its content changes. A hop (dashboard launch, Back to the dashboard, Commit it now) comes with the exact resume command and the skill file to read. A chat reply's id defaults to `r<seq>`, and `fallbackText` is no longer asked for (nothing read it).
|
||||
- **web-console**: a send is picked up without delay. The wait loop's server health check no longer holds the 50 ms polling for up to 4 s. A working agent's timer now restarts with each new turn instead of counting from when the session opened. The git board unlocks when a working agent stops checking in.
|
||||
- **web-console**: **Commit it now** on a finished Finalize, phase build or quick task now opens Git in the same session, which commits every changed file (risky ones left out and named) and leaves the board open with Push lit.
|
||||
- **changelog**: its closing "Commit this now?" hands the session to Git to commit the result.
|
||||
- **web-console**: Help has an 18th topic, **The git board**, right after **Watching a build**, and a Git session opens Help on it. The dashboard topic's Git line points to it.
|
||||
- **web-console**: a Quick Task build now ticks the steps on the **Plan** tab one by one as each finishes, alongside the "Task x of y" line beside Planny. The separate Build progress tab is gone. The plan is posted as Summary, Files to change, Steps and Verify blocks, and each step's post resends only the `steps` checklist. The waiting pane's "follow along" link opens the Plan tab.
|
||||
- **web-console**: User Preferences → Cleanup also lists this project's `specs--completed/<feature>/` folders that nobody has touched for 30 days. Deleting one is permanent, since that folder is usually gitignored, and the help text says so.
|
||||
- **web-console**: the **Subagents** tab shows the small spinner left of its label, like **Ask**, while any helper is Running.
|
||||
- **web-console**: User Preferences is wider (880px). Only its body scrolls, so **Back to default** and **Done** stay in view.
|
||||
- **installer**: the finish screen no longer ends with "Update later with: `npx skills update -g`" (the README sentence is gone too). Re-running the install command is the update path.
|
||||
- **tests**: `npm test` runs much faster with the same tests. The web console's tests are split by area into `scripts/test-web-console-*.mjs` so `node --test` runs them in parallel, git fixtures are built once per test file and copied for each test, and the skill-script tests no longer rebuild `skills/` when `npm test` has just built it. The hardening tests that were only in plan2code moved to `scripts/test-web-console-hardening.mjs`.
|
||||
- **docs**: wherever the install command is printed (README, quick reference, docs site, the console's Update modal), a line explains that no output at all means npm couldn't reach the repository and hid the reason, and that `git ls-remote https://github.com/jparkerweb/plan2code.git` shows why.
|
||||
|
||||
### 🗑️ Removed
|
||||
|
||||
- **git-commit**: `/plan2code-git-commit` was replaced by `/plan2code-git`; a terminal commit no longer offers a push, so say `commit and push` to do both.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **git**: a new repository now starts on `main` rather than git's legacy `master`, unless you set `init.defaultBranch` yourself. `init-check` returns the `branch` and the `commands` to run (`git init`, then `git symbolic-ref HEAD refs/heads/main`, which works on every supported git), and the init card names the branch.
|
||||
- **web-console**: answers are never lost or misfiled. `settle: true` records the send `wait` handed over, never a later one still waiting to be collected. A thread reply on a sent list, text or multi card puts what was sent back on the form. A card asked again keeps the note sent with its answer in its thread. A card the agent left open after collecting it no longer stays locked as "sent". Multi-line answers and notes are indented in `reply`, so typed text never passes for a console line. A list's `reply` names renames, additions and removals, and its first click after a rename works. A skipped card settles as skipped, and a note on a finished card reads "Your last note".
|
||||
- **web-console**: builds and the git board report the right state. A build's progress bar trusts `cleared: 0`, and a review between counts shows its stage. A later phase can ask for its own sign-off. After a commit hop the Ask tab no longer shows answered questions as pending. The board locks while an agent question is open above it, sends Publish without a remote when there are several, always offers Continue during a conflict, shows "main · rebasing" mid-rebase, updates the footer branch, keeps the last good refresh time after a failed one, and disables New branch mid-rebase or before the first commit. A `notice` no longer takes a question slot. `pr-url` refuses a pull request from the default branch into itself, deleting a branch with no unique commits is no longer a red confirm, and `classify-error` knows more network failures and a new `diverged` kind.
|
||||
- **web-console**: a send made before the last collection, or a skip, never stays locked as "with Plan2Code". A card left open by a partial settle keeps the person's edits, and a plain reopen frees the card and keeps the note in its thread. A list rename is kept while typing. Two dashboard tabs on different specs no longer trade the workspace back and forth. A branch whose remote copy was deleted offers Publish, not Pull. Refresh works with no remote, picking up edits made outside. The cleanup confirm is red only when commits would be lost. A stop past a warning no longer promises a saved place. `post` refuses a patch that is not one JSON object. A spec with no `overview.md` no longer logs a failed request.
|
||||
- **web-console**: the CLI is sturdier. `post --file` reads a BOM or UTF-16 patch (PowerShell's), `wait`, `chat` and `stop --session` find a session's server from any folder, `open --resume` gives a busy server a second look rather than starting another, `keep` refuses a `--from` outside the project and keeps one copy per upload, `agent.status` accepts only `working` or `waiting`, and the dashboard refuses question cards.
|
||||
- **web-console**: the page reads right. Doc images and links to kept attachments load, and other relative links show their path. HTML comments are hidden, blocked, in-progress and assumed tasks get markers, and long doc tab titles are cut. Cards with more below the fold fade at their bottom edge. Back on the dashboard the picker starts on the most recent spec, and the agent's note shows only for that spec. Pauses read as paused, the hand-off wording matches the `--web` flag and git commands, stop and leave dialogs with a warning no longer promise a saved place, and the "still being picked up" banner clears. Smaller fixes cover the Brief button and dates, the decision line, Workspace and Cleanup messages, the role banner, the Subagents dialog, the welcome dialog, the tab title, dialog links and the chips.
|
||||
- **web-console**: on the git board, a card with a note box (the proposed `.gitignore`, a split's review) no longer shrinks under the board with its buttons and note box drawn behind it; the card keeps its full height and the column scrolls. A note box there grows with what you type instead of scrolling inside itself, and before the first question lands, a folder with no repository says a question is coming rather than pointing at an empty space "above". A task line holding a code block or a long word no longer widens a doc tab past the page, the branch table scrolls on its own on a phone instead of pushing the board off screen, and the Ask tab's Send button wraps rather than being clipped on a narrow screen.
|
||||
- **web-console**: the dashboard's spec card counts only a phase file's `**Task N.M:**` lines, so an Acceptance Criteria checkbox no longer shows as a task or keeps a built spec from reading "built". `post` and `status` stop reporting `phase: "submitted"` once a send has been collected. Several "New conversation" lines arriving together reach the agent as one. A posted finish (a pause included) no longer leaves the agent shown as working, and resuming a paused session starts a fresh working turn.
|
||||
- **web-console**: **Commit it now** on a finished screen (and Changelog's "Commit this now?") no longer leaves the page stuck on the previous skill's ending. Resuming into Git now clears the previous skill's page, its ending included, as a dashboard launch does.
|
||||
- **web-console**: the top bar's three right-side buttons (Help, Colors & theme, feedback) keep to the right edge when the progress bar is hidden; on the dashboard and the git board they used to sit beside the title.
|
||||
- **web-console**: the git board's action bar (Refresh, Pull/Push, Commit, **Done**) stays pinned to the bottom of the pane while the branch table scrolls, and **Done** shows in the highlight colour when it is live.
|
||||
- **web-console**: a finished screen's buttons (**Review it now**, **Commit it now**, **Back to the dashboard**) stay live for as long as the session is open; the copy-the-command fallback only appears once the session has closed.
|
||||
|
||||
## v2.6.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **web-console**: the breakdown question's "Anything else about this breakdown?" field has a **No changes** button. One click fills the box with "no changes", so you no longer type it. The old "(type 'no changes' if none)" hint is gone from the label.
|
||||
- **git-commit**: a new `/plan2code-git-commit` skill and dashboard card. It reads what changed, drafts the commit message for your approval, offers a new branch first on the default branch, suggests splitting work that is really two jobs, and asks before every commit and push (never a force-push). Outside a git repository it offers to start one.
|
||||
- **changelog**: a new `/plan2code-changelog` skill and dashboard card, just left of Git commit. It reads the default branch's latest version, classifies the branch's work and picks the version. When the branch already owns a version that is not released and not on another branch, it adds to that entry instead of starting a new one. It compares the branch with the newest entry, suggests the entries that are missing for you to edit, keeps `package.json` aligned, and offers to run Git commit next. The facts come from `changelog-state.mjs`, with tests in `scripts/test-script-changelog.mjs`.
|
||||
- **web-console**: the Git commit card counts the files waiting ("3 files to commit") and greys out on a clean tree, from a bounded `git status` the scan runs when the dashboard opens. If git cannot answer, the card stays clickable.
|
||||
- **web-console**: the Commit this? question in Git commit has a collapsed **Show the N files** table of every path and its state, so "15 files" can be read before you say yes.
|
||||
- **web-console**: a finished quick task or phase build gets a **Commit it now** button beside the printed git command. It starts Git commit in the same session, as if you had clicked its dashboard card.
|
||||
- **web-console**: the dashboard scan reports `isGit`, found from the filesystem without spawning git (linked worktrees count). The Git commit card stays clickable outside a repository and says "Not a git repository yet: it offers to start one". The skill has its own Planny pose and a Help entry.
|
||||
- **installer**: after an install it prints getting-started steps: how to start Plan2Code from the project you want to work in, and what to do if no agent CLI is installed yet.
|
||||
- **launcher**: the `plan2code` command can start Codex as well as the other agent CLIs. The Codex launch line follows Codex's documentation and has not been tried by hand.
|
||||
- **launcher**: when no agent CLI is installed, `plan2code` now explains how to get one and how to run the skill from it, instead of printing one line and exiting.
|
||||
- **docs**: the README, quick reference, docs site and package READMEs open with a "Before you start" block: Node.js 18+ is needed, start Plan2Code from your project, and the ways in. `scripts/test-getting-started.mjs` keeps them in step.
|
||||
- **web-console**: Help's "When something looks stuck" tab is now second, opens with a "Check this first" callout about a permission prompt waiting in the terminal, and lists four symptoms with a likely cause and what to do. The quiet and Not running status lines carry a "What to check" button that opens it.
|
||||
- **web-console**: every finished and paused screen shows a "Before you close this" panel: the tab is safe to close, why to restart the agent or start a new session, and the two ways to carry on.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **installer**: the menu is now Install, Uninstall, Advanced and Quit. The former Custom choices live under Advanced.
|
||||
- **web-console**: Subagents is now on by default for the skills that offer it, until you turn it off for a project and skill. A saved Off is kept.
|
||||
- **commits**: every commit Plan2Code suggests is now `<subject>`, a blank line, then `AI Assisted`. `commit-msg.mjs` no longer reads a ticket from the branch name and rejects `--ticket`.
|
||||
- **build**: `skills/` is no longer tracked. It is gitignored build output, rebuilt by the installer and `npm run build:skills`, as upstream does. `npm test` now runs `install.js --build-skills` instead of `--verify-skills`, so it fails on a broken source entry rather than on drift. `--verify-skills` stays as a diagnostic.
|
||||
|
||||
## v2.5.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **web-console**: six new starter templates, each slotted into every role's order. **Refactor** (Plan, Quick Task) asks what behaviour must not change. **Performance problem** (Plan, Quick Task) asks for today's number and the target. **Dependency upgrade** (Quick Task) asks for the known breaking changes. **Spike** (Pathfinder) is a time-boxed question with an "answered when". **Integration** (Pathfinder, Plan) covers the other side's auth and limits and what happens when it fails. **Data migration** (Plan) asks for a rollback plan. Pathfinder now offers 8 templates, Plan 10 and Quick Task 10, 19 in all.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **web-console**: the starter templates on the fresh-idea card (Pathfinder, Plan, Quick Task) are now Markdown sections. Each one is a `## heading` with its answer on the lines under it, instead of `Label: [blank]` lines run together. You get room to write, and the agent gets clear sections. Brackets mark only the parts you fill in, so the lines already written for you (who reads it, what it should pin down) read as defaults. **Bug investigation** splits Expected and Actual into their own sections and numbers its steps. **Add a test** lists its cases. Picking a template now selects its first `[blank]`, so you type straight over it instead of starting at the end of the box. Ids, labels and which skills see the existing templates are unchanged. A new test in `scripts/test-web-console.mjs` pins the shape.
|
||||
- **web-console**: template content, revised against design-doc, PRD, ADR (MADR) and bug-report guidance. **Engineering spec** gains *Out of scope* and asks for the simpler options turned down. **Product requirements** gains *Not doing* and asks for evidence and a measure of success. **Test strategy** leads with what costs most if it breaks. **Scoping and rollout** asks who sees it first and how it rolls back. **Bug investigation** gains *How often* and *Error or logs*. **Small change** gains *Leave alone*, and its *Done when* asks for a command or check. **Add a test** names the failure case. **Record a decision**'s *Why* asks what forced the choice.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **web-console**: a "working alone" report no longer hides helpers reported after it (or beside it). A real helper report now removes the marker (`applyPatch` in `lib.mjs`, `helperRows()` in `subagents.js`), the standing instruction and `console.md` say to post `alone` only when the agent's tools cannot start helpers at all, and Help's **Helpers (subagents)** topic says the note goes away once a helper shows.
|
||||
|
||||
## v2.5.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **web-console**: a **Subagents** switch for the skills that can hand work to helpers (Implement, Implement + review, Quick task, Review, Pathfinder). An icon button after Write a brief, lit while helpers are on, opens a **Subagents** dialog: **Use helpers** or **Work alone**, an editable instruction with **Reset to default**, and an advisory "at most N at once" (1 to 20). It is off by default and saved per project folder and skill in `~/.plan2code/console/subagents.json` (`POST /subagents`, on Cleanup's keep-list). The button shows only when the skill opts in (`public/subagents.js`) and the agent's console copy reported support (`caps: ["subagents"]` on its `open` event), so an older skill copy never shows a switch it cannot serve.
|
||||
- **web-console**: the switch reaches the agent as a standing instruction, and only when it changes. `wait` exit 0, `chat` and `open` carry a `subagents` field and `Subagents: on (revision N)` lines last in `reply`. A higher revision replaces a lower one, "off" goes only to an agent that was told "on", and a resume or dashboard launch with the switch on states it once. The per-session cursor moves only after the print, so a killed `wait` repeats a change rather than losing it. Contract: `console.md` → Standing instructions; `building.md` points at it.
|
||||
- **web-console**: a **Subagents** tab before Ask, from the first helper the agent reports through `post` (`helpers: [{ id, title, ask, state, result? }]`, merged by `id`, or one `{ id: "alone", alone: true }` entry when it has no way to start helpers). One row per helper with its ask, a Running / Done / Failed pill and a one-line result. It clears on a dashboard hop, and helper reports add no session meter points. `validate()` refuses malformed entries with exit 3 (house rule 8). Help gains a 17th topic, **Helpers (subagents)**.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **review**: run on its own with nothing named (no argument, no conversation work, not from a build's review button), `plan2code-review` no longer assumes the branch diff. It does a quick scan (branch changes, uncommitted changes, specs) and asks what to review, each option with its size; on the web console that is the first scope question, a `choice`. A build's review keeps its already-decided scope.
|
||||
- **web-console**: `post` and `open --file` refuse a patch that sends a doc a lower `version` than the page already holds (exit 3, naming the doc and both versions; house rule 9). A version going back is almost always a stale or copied payload, which the page would otherwise show quietly under the new run's name. `building.md` now says a later phase in the same session continues `phase`, `phasefile`, `report` and `review` from the version the page holds instead of restarting at 1.
|
||||
- **web-console**: the project name in the footer's `<project> · <branch>` label now shows in your highlight color, and the browser tab title starts with it (`<project> · <title> · #<sid> · Plan2Code`), so consoles for different projects are easy to tell apart.
|
||||
|
||||
## v2.4.2
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **web-console**: the Questions and Ask tabs show a small spinner left of their name while Plan2Code is on it. Questions (Dashboard on the dashboard) spins from Send until the answers are picked up, the same wait as *Sent. Waiting for Plan2Code.*; Ask spins while a question the agent picked up has no answer yet, exactly when the conversation's own ring does. Neither turns once the agent goes quiet or offline, so a dead session never reads as a slow one.
|
||||
- **web-console**: **User Preferences → Cleanup**, above Models. **Find files to clean up** lists, with sizes, what `~/.plan2code` does not need: sessions untouched for 30 days (never the one serving the page), anything at the top of `~/.plan2code/console/` but `sessions/`, `looks.json`, `workspaces.json`, `console-dir` and `update-check.json`, and anything at the top of `~/.plan2code/` but `console/`, `bin/`, `launcher.json` and `models.json`. A stray is listed only after an hour untouched (`STRAY_GRACE_MS`), so a held lock or a temp file mid-rename never is. **Delete these** removes exactly that list and reports what went and the space freed. The server builds the list (`POST /cleanup`, `cleanupFindings()` in `lib.mjs`), sends no paths to the page, and on delete re-scans and removes only ids still found (`removeCleanup()`), unlinking symlinks without following them. A console running from `PLAN2CODE_CONSOLE_HOME` never looks outside that home. Help's User Preferences topic describes it.
|
||||
- **web-console**: the dashboard shows an **UPDATE AVAILABLE · v<latest>** banner when a newer release is out. The console server finds the newest `vX.Y.Z` tag with `git ls-remote --tags` when it starts (no shell, prompts off, a 10 s limit, never waited on), caches the answer for an hour in `~/.plan2code/console/update-check.json`, and adds `update` to the state frame only when that release is newer. The banner opens a dialog with both versions, a Releases link and the update command with Copy; × hides it for that session. `GET /version` also returns `latest`, and the version in Help links to the Releases page.
|
||||
- **launcher**: `plan2code` opens with a colored Planny banner and a plain-English intro, then the agent menu with cyan numbers, a `(last used)` marker on the remembered pick and a green default. With one CLI installed, or a `--cli` pick, it prints `Opening with <CLI>…` instead. The model menu, the folder prompt and every `plan2code:` error get the same styling. Color is used only on a terminal with `NO_COLOR` unset, so piped runs print plain text and no banner.
|
||||
- **maintainer**: a repo-local `/plan2code-model-update` skill (`.claude/skills/`, never installed) refreshes `src/launcher/models.json` from `devin models list` and Claude Code's documented model aliases. It shows a diff, applies only the changes the maintainer approves, checks the file against the launcher's rules, runs `npm test` and never commits.
|
||||
- **tests**: `scripts/test-web-console.mjs` covers Cleanup, the update check and the note thread; `scripts/test-launcher.mjs` covers the banner and color handling.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **document**: `overview.md` puts the Phase Checklist and Parallel Execution Groups directly under the Summary, ahead of the Tech Stack, Architecture, Risks and Success Criteria, so the phases are found without scrolling. Every script finds these sections by heading, so specs written in the old order keep working.
|
||||
- **web-console**: while a build runs, the waiting screen's pointer to the tasks list is now clickable. **Task** and the tab's own name (say **Phase 6 tasks**) show bold in the highlight color, and either one opens that phase's tasks tab.
|
||||
- **web-console**: the session meter counts a build while it runs instead of only once the phase is approved. `console.mjs` writes a `progress` ledger entry whenever an Implement or Implement + Review post raises `headline.cleared`, and the build's row (*Implement + Review: 9 tasks built so far*) scores one point per 3 tasks done. The phase's final `run` takes that row over in place, so nothing counts twice and the meter never drops. A second phase in the same run starts its own count once its headline is back at `cleared: 0`.
|
||||
- **web-console**: the **UPDATE AVAILABLE** banner and **Send to Plan2Code** (while enabled) carry a soft glow in the picked highlight color; with reduced motion Send's pulse stops and the glow stays.
|
||||
- **web-console**: a request body over the size cap now gets `413 too large` from every JSON route instead of a connection reset or a `400`.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **web-console**: Implement + Review's built-in review no longer scores twice on the session meter. Its `review` run now scores the phase's 1-point review bonus as the review starts (not a standalone Review's 2), and the phase's final `run` leaves that point out. A 17-task phase now ends at 7 points, not 9. The breakdown also stops repeating the unit in "Code review run: review".
|
||||
- **web-console**: Send no longer stays disabled when an agent posts a question mid-build while still marked `working` (seen on Implement + Review, where the question said "I'm carrying on while you decide"). Once an open question has an answer or a note staged, Send unlocks at once with "Still working · it reads this next", instead of waiting out the agent's `quietMinutes` (up to an hour); the server holds the send until the agent next looks. `building.md` now says a question stops the build: set `waiting` in the same post as the question and wait, never keep working with a question open.
|
||||
- **web-console**: **Notes on this** showed the agent's replies as empty "Plan2Code" bubbles and dropped the person's own notes once they were picked up. The server now writes every note into the item's `thread` as it arrives, `post` lifts `from` / `role` and `md` / `body` / `content` into `{ who, text }` (and drops an echoed copy of the person's note), and an entry with no text is rejected with exit 3. Older `{ from, md }` entries still render. `console.md` gains a **Replying to a note** section.
|
||||
- **web-console**: dropped the `comments` list on docs, which `post` appended and time-stamped but nothing ever displayed.
|
||||
- **web-console**: a dashboard launch could strand the hand-off when the agent called a skill-invocation tool on the picked skill instead of reading its `SKILL.md` (every skill below the dashboard ships `disable-model-invocation: true`). `plan2code.md` and `console.md` now say to open the next skill's file with a file-read tool.
|
||||
- **web-console**: the waiting pane pointed Document and other skills with no task list at a tasks tab that never exists there. The pointer now appears only when a build's `phase` or a quick task's `tasks` tab is posted. The nav tab spinner also gets its 7px gap back from the tab's name.
|
||||
- **web-console**: skipping a question dropped a note already typed for it; the note now goes with the skip as `skip; <note>`. Ticking a checklist step after a skip now ends the skip instead of still sending `skip`.
|
||||
- **web-console**: reconnecting cleared every banner, including a warning that arrived while offline; it now clears only the *Lost contact* banner. An open Overview tab now refreshes during a build.
|
||||
- **web-console**: a `409` on Home, Stop or **Write the brief** now marks the page busy the way Send does, and the brief dialog says why it could not go.
|
||||
- **web-console**: arrowing through a menu question kept dropping keyboard focus to the page body; menu radios now carry stable ids, a `value` and an `aria-label`. `@` mentions typed with a capital letter now match, and the attachment-limit banner uses `MAX_ATTACHMENTS` / `CHAT_MAX_ATTACHMENTS` instead of a hard-coded 5.
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- **web console guide**: new *When an update is out* section, Cleanup under the session cleanup notes, and a pointer to `/plan2code-model-update` for the curated model list.
|
||||
|
||||
## v2.4.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Screenshots of the web console**: seven screens (dashboard, question, living document, build, sign-off, finish, Ask tab) in light and dark, as WebP in `docs/screenshots/`. Readers see the theme that matches their system, on GitHub and on the site.
|
||||
- **`scripts/capture-screenshots.mjs`**: stages each screen from the JSON payloads in `scripts/screenshots/`, in a throwaway sample project and console home, and captures it with puppeteer-core and a local Chrome or Edge. One command refreshes every image; `--only <shot>` refreshes one. `puppeteer-core` is installed with `--no-save` and never added to `package.json`.
|
||||
- **New landing page**: `docs/index.html` rebuilt in the console's look, with the console above the fold.
|
||||
- **Web console welcome**: the first dashboard a person sees opens a Welcome dialog with Planny waving, four tips and a **Start building** button. Closing it by any route saves `looks.welcomeSeen` in `looks.json`; Help's first tab has **Show the welcome again**.
|
||||
- **Report a bug or idea from the console**: a megaphone button at the right of the top bar opens GitHub's new-issue chooser for `jparkerweb/plan2code`, with new **Bug** and **Idea** issue templates in `.github/ISSUE_TEMPLATE/` (blank issues off).
|
||||
- **Version in Help**: the Help dialog's footer shows the running Plan2Code version, served by a new `GET /version` route. The skill build copies `version.json` into each skill's `references/web-console/` so the console can find it.
|
||||
- **skills**: skill scripts. Every step a workflow decides with one correct answer now runs as a script the agent calls instead of prose it follows: Node 18+ built-ins only, one JSON object on stdout, documented exit codes, `--help`, `--dry-run` on writes. They install beside each `SKILL.md` in `scripts/`: shared ones from `src/skill-scripts/` (named per skill in `SOURCE_PROMPTS` → `scripts`), a skill's own from `src/<skill>-scripts/`, plus `common.mjs` and the release's `version.json`.
|
||||
- **specs.mjs** (plan, revise-plan, document, implement, implement-review, review, quick-task, finalize, handoff): `list`, `status`, `metrics`, `mark`, `archive`. It reads gitignored `specs/` directly, parses the Phase Checklist and Parallel Execution Groups in the formats real specs use, counts tasks by marker (including `3.6a` and named `1.T` tasks), applies Implementation Mode's phase-selection table, and flags drift such as a phase marked `[x]` with open tasks. It shares the dashboard's spec classifier by importing the bundled `web-console/lib.mjs`.
|
||||
- **pathfinder.mjs**: `reconcile`, `frontier`, `claim`, `resolve`, `rule-out`, `trail`, `gate`, `lint`, `brief-data` for maps on the `local` backend. The map's markers, the Trail Footer, the Clearing Gate's mechanical checks and hard caps, the standing-rule lint (loop tokens, checkboxes, reserved names, schema lines, `Blocked by:` cycles, the metrics collector's own scrape patterns) and a brief's date filtering are computed from the question files. Reconcile keeps each map row's own wording and only changes what the files contradict. Maps on the `github` backend keep doing these steps with `gh`, as `github-issues.md` describes.
|
||||
- **feedback-payload.mjs** (finalize STEP 6.5): builds the payload from the archive, with real 12-character sha256 prompt hashes (the prose admitted the agent could not compute them), renders the issue, checks the 8 KB URL limit with `--truncate`, and runs the gh / browser / print tiers against `jparkerweb/plan2code`.
|
||||
- **commit-msg.mjs**, **review-scope.mjs**, **agents-md.mjs**, **agent-files.mjs**, **handoff-path.mjs**: the commit command from the branch's ticket, Review's git scope and doc share, AGENTS.md's structure and orphans, the AI agent file sync, and the handoff's timestamped path and git ignore check.
|
||||
- **tests**: `scripts/test-skill-scripts.mjs` and `scripts/test-script-<skill>.mjs`, run by `npm test` against the built `skills/` tree. One test fails if a `SKILL.md` names a script its skill does not ship.
|
||||
- **web console**: the Workspace dialog's folders are remembered across console sessions, in `~/.plan2code/console/workspaces.json` beside `looks.json` (never in the project), keyed by the folder a session runs in and then by spec. Every change is saved. *Start from scratch* on the dashboard shows the project's list; picking a spec loads its own, which starts as a copy of the project's and is separate after that, and a spec created mid-run takes the list in force with it. The dialog says whose list it is. New `console.mjs forget --spec specs/<name>`, which Finalize's Spec Cleanup runs after archiving a spec.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **skills**: the character limit for `src/plan2code-*.md` rises from 11,500 to 20,000 (about 5k tokens). It no longer guards Windsurf's old limit; it is a size discipline, applied by `validate-char-count.js` and the metrics improver alike.
|
||||
- **finalize**: a run at exactly 75% complete now finalizes with notice (the table said >75% and <75%). Assumed `[?]` tasks count as completed and are listed; started `[/]` tasks count as incomplete. `verification_items_added` and Step 7's two judgment counts are passed to the script, which computes the rest.
|
||||
- **finalize**: the community feedback issue title reads `[Feedback] v<version> - rating N/10`; ingestion matches on the `[Feedback]` prefix and is unaffected.
|
||||
- **init**, **init-update**: both write the same pointer templates, from `agent-files.mjs`. Replacing `.cursor/rules/` now also removes Cursor's own `.mdc` rule files, so AGENTS.md really is the single source there, and files that already point at AGENTS.md are no longer offered again.
|
||||
- **revise-plan**: re-opening a phase (`specs.mjs mark --to open`) also sets its phase file's Status back to In Progress.
|
||||
- **review**: the branch scope compares `base...HEAD` (what this branch added since it left the base) rather than `main..HEAD`, and a trunk other than `main` / `master` is passed with `--base`.
|
||||
- **pathfinder**: the Trail Footer's named legend numbers stops by position (`(blocked:3)` points at stop 3), and a brief's range is given as `this-week`, `since:<date>` or `<date>..<date>`.
|
||||
- **init**, **init-update**: a CLAUDE.md (or other agent file) that is a symlink or hard link to AGENTS.md is reported as `linkedToAgents` and never replaced, since writing the pointer through it would overwrite AGENTS.md. A pointer file checked out with CRLF line endings still counts as already pointing.
|
||||
- **review**: with no `main` or `master` and no `--base`, `review-scope.mjs` now stops with `no-base` instead of quietly counting only uncommitted changes.
|
||||
- **commit-msg.mjs**: the add step is `git add -- <paths>`, paths starting with `@` or `-` are quoted, and subjects with `\`, `!` or curly quotes are refused. The output also carries `add` and `commit` separately for Windows PowerShell 5.1, which has no `&&`.
|
||||
- **specs.mjs**: `mark` reads a Status line written as `Status:` or `**Status**:` too, and warns when a phase file has none; a path that is not a folder directly under `specs/` is refused (`not-a-spec`).
|
||||
- **pathfinder**: the map header carries `**Next NN:**`, so a deleted question's number is never handed out again. `claim`, `resolve` and `rule-out` honour `--dry-run`. Notes indented under a map row survive a marker change. Research questions are fired unclaimed; the one-claim rule is for the questions a person works through.
|
||||
- **finalize**: `feedback-payload.mjs` counts the same phase files `specs.mjs` does, `submit` refuses an oversize URL when `gh` is unavailable (`oversize`), and a bare spec name present in both `specs/` and `specs--completed/` is refused as ambiguous.
|
||||
- Every script was checked against real specs and Pathfinder maps in other repositories and by four independent reviews; each issue found has a regression test.
|
||||
|
||||
- **install.js**: the closing message beside Planny now names the dashboard first: `plan2code` from any project, or `/plan2code` in your agent when the command could not be installed. The docs link moves to the line under it.
|
||||
- **web-console**: User Preferences opens from a gear button instead of the three swatches, and the default highlight color is now ocean blue instead of rust.
|
||||
- **web-console**: the dashboard rail marks the suggested next step with a small dot, since the center pane's Suggested pill can scroll out of view. Send pulses only while it is the primary button.
|
||||
- **web-console**: when the agent stops checking in, the status line and Help now say to type **continue** in an idle terminal so it picks your answers up.
|
||||
- **web-console**: `wait` exit 10 now carries a `next` instruction (relay one line, then wait again), and `console.md` opens with the one rule that keeps the page alive: every turn ends on a `wait` call, never on text.
|
||||
- **web-console**: a finished quick task offers **Back to the dashboard** as well as **Review it now**, so the finished screen is never a dead end.
|
||||
- **Windows**: the folder picker (the launcher's desktop shortcut and the Workspace **Browse…** button) now opens centred and in front of other windows instead of behind the terminal.
|
||||
- **Launcher**: before asking which CLI to use, `plan2code` says what it is about to do and that running `/plan2code` inside your agent works too.
|
||||
- **web-console**: the session meter now weighs the work a session actually did instead of a flat amount per step. A built phase scores one point per 3 tasks it completed (rounded up), plus 1 for Implement + Review, so a twelve-task phase weighs four times a three-task one; the agent reports the count as `run.tasks`. Every 2 questions you answer on the page add a point to the skill you answered them in, so a long back-and-forth in Plan or Pathfinder counts for more than a short one. Each Pathfinder research question adds 1 through a new `pathfinder-research` event, since research fills the context with nobody answering anything. The levels move to match: yellow from 5 points, red from 10, and the ring is full at 15.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **pathfinder**: charting no longer ends the session, or shows "Session ended" in the web console, while its research subagents are still running. They live in the terminal's process, so closing it on a "done" page killed them mid-write. The session now waits for every one (the page shows a running count), each subagent ends `## Evidence` with a `**Research complete:**` line, and Work Step 2 re-fires any research question missing it. `console.md` makes the same rule general: no `finish` while any subagent or background job is still out.
|
||||
- **web-console**: reusing a settled question id for a different kind of question (say a multi-select turned confirm) now opens it as a new question instead of keeping the old answer.
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- **Web console first**: README, QUICK-REFERENCE, the walkthrough and the console guide now open on the browser flow (install, run `plan2code`, pick a card) with screenshots, and keep every slash command in a "Prefer the terminal?" section. The walkthrough follows the task API through the web console, session by session, and the console guide opens with a Quick start and has Troubleshooting ahead of the internals.
|
||||
- **Rule 1 is now "Keep each session short"**, worded the same in README, QUICK-REFERENCE, the walkthrough and the landing page: chain a couple of small skills on the dashboard, and start a fresh console session when the session meter turns red or before a big planning or build step.
|
||||
- **Web console guide** opens with a two-minute tour; **QUICK-REFERENCE** opens with a Launch table (shell, inside an agent, straight into a skill with `--web`) and a "Terminal instead" note; the walkthrough mentions the Ask tab during a build and ends with links onward.
|
||||
|
||||
## v2.4.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Web console**: an optional local browser UI that every skill offers at the start of a session ("web console or terminal?"). Questions, recaps, sign-off gates, build progress and the document taking shape are laid out in a page instead of scrolling past in the terminal, so the workflow is usable by product people and not only engineers. Zero dependencies, no build step: a detached `node server.mjs` bound to `127.0.0.1`, bundled into each skill as `references/web-console/`. Answers carry the literal terminal token they stand for (`approved`, `a`, `skip`), so declining the console or losing it mid-session falls straight back to the terminal with nothing lost. Full guide in `.readme/web-console.md`.
|
||||
- **`plan2code` dashboard skill**: a new bare-named skill that opens the console as a card menu of every skill, with a spec picker, and launches the pick on the same page. **Back to the dashboard** works from finished screens and, mid-workflow, from a triangle beside **Stop session**.
|
||||
- **Global `plan2code` command**: installed with the skills (`I` and `A`; alone via Custom → `D`; removed by `U`). Typed in any project it opens the dashboard in Claude Code or Devin, asking which when both are installed and remembering the last pick in `~/.plan2code/launcher.json`. `--cli claude|devin` skips the question and `--model <name>` skips the model notice; other arguments are forwarded. It starts the agent with permission prompts off (`--permission-mode bypassPermissions` in Claude Code, `--permission-mode bypass` in Devin); run `claude /plan2code` yourself if you want prompts. The launcher lives in `~/.plan2code/bin/` with npm-style shims (sh, plus `.cmd` and `.ps1` on Windows).
|
||||
- **Desktop shortcut** (opt-in, asked after the command installs): `Plan2Code.lnk` on Windows, `Plan2Code.command` on macOS, `plan2code.desktop` on Linux. It opens a native folder picker first, starting on the last folder picked.
|
||||
- **`plan2code-3-implement-review`**: a quality-gated Step 3 that implements one phase, runs a focused review and the selected fixes before sign-off, and marks the phase complete only after the reviewed result is approved. Step 2's hand-off now offers it first, with `/plan2code-3-implement` as the review-free alternative.
|
||||
- **`--web` flag**: `/plan2code-1-plan --web plan a lunch voting app` opens the console without asking. Every next-step command the workflow prints (resume footers, NEXT STEP lines, the loop's completion banner) now carries `--web`.
|
||||
- **Console pages for builds and reviews**: a build shows the current task, a task-count progress bar and the phase's task list ticking as tasks land. After an approved phase or a finished quick task, **Review it now** runs `/plan2code-review` on the page, with *Which to fix* presets for critical-and-warnings or everything.
|
||||
- **Console conveniences**: nine question shapes with live validation and drag-to-reorder phases; drafts that survive a closed tab, reload, server restart or agent crash; an **Ask** tab for quick questions the agent answers at its next check-in (file edits need approval); image and document attachments; a read-only **Overview** tab; a **Workspace** of extra read-only folders addressed as `@name`; a green / yellow / red **session meter**; a **Role** preference that orders starter templates; nineteen highlight colours, light / dark themes and card widths; audio cues with per-event toggles; and a 16-topic Help dialog.
|
||||
- **Planny in the console**: drawn in SVG in his own dock above the question list, where he carries the page's state: his star lights and he waves when it is your turn, the star turns and he walks on the spot while the agent works, it goes green when all is caught up, he shows no arms when the agent is not answering, and he fades with his star shut when disconnected. He flies through a starfield while the agent thinks, wakes up on a fresh dashboard, and acts out each skill on its starting screen, arms holding that step's prop. The tab icon adds a busy, ready or attention bar, and the desktop shortcut uses him too.
|
||||
- **Tests**: `scripts/test-web-console.mjs` and `scripts/test-launcher.mjs` (run by `node --test`), `scripts/parse-check.mjs` (every shipped browser module parses as an ES module) and `scripts/check-skill-table.mjs` (the dashboard's "What each skill reads and writes" table matches the skills), all wired into `npm test`. `scripts/bench-web-console.mjs` measures time to first paint.
|
||||
- **install.js**: an animated progress indicator during the two long install phases, so the installer no longer looks hung.
|
||||
- **Curated launcher models**: the `plan2code` launcher's model menu reads `src/launcher/models.json` (copied to `~/.plan2code/bin/` and refreshed by every install) instead of asking the CLI, so Devin offers a short verified list at Low, Medium and High effort. **User Preferences → Models** (Claude and Devin tabs) adds models released after an install, kept in `~/.plan2code/models.json`, with **Reset to default**. `--model <id>` still skips the menu.
|
||||
- **Quick-task build progress on the console**: an approved quick-task plan opens a **Build progress** tab that ticks each step, raises the progress bar and updates the activity line, as an Implement phase does.
|
||||
- **Console extras**: sent notes and their attachments stay listed in the Sent box after a reload or in a second tab; the fresh-idea box on Pathfinder, Plan and Quick Task has **+ Attach file** (and takes a paste); clicking the session meter lists what each step added; git code blocks get a **Run it** button; the Ask tab may run one command the person spells out (a commit, a test run) and report the result; the wake-up animation has a **Skip** button.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Planny has a new look everywhere**: a box with a star for an eye, stick arms and two small feet, chosen from twenty studies. Every ASCII Planny in the workflow prompts, the installer, `plan2code-loop` and the Claude Code status line is redrawn to match: the eye is always the star, one arm waves when he is asking something, both go up when he is celebrating, and the status line shows his box, star and feet without arms.
|
||||
- **Character limit raised from 11,000 to 11,500** for `src/plan2code-*.md` (`scripts/validate-char-count.js`, and the same number in `plan2code-metrics`'s `improver.ts` and `applier.ts`), so the console's Interface lines fit without cutting workflow rules.
|
||||
- **package.json**: the installer's bin is renamed `plan2code` → `plan2code-install`, leaving the `plan2code` name to the launcher. The `npx` install command is unchanged.
|
||||
- **install.js**: skills bundle the shared `src/web-console/` directory through `additionalReferences`, copied as bytes so the bundled chimes survive the build. Installed skills are listed by reading the skills store directly instead of `skills list` (seconds instead of over a minute on Windows), and removal is one variadic `skills remove`.
|
||||
- **plan2code-0-pathfinder**: the duplicated Trail Footer forms fold into the fallback line, since `references/trail.md` defines them in full; the GitHub Issues backend is unchanged.
|
||||
- **`.gitattributes`**: `*.mp3` is binary. `.editorconfig` pins LF for editors. `prototypes/` is gitignored.
|
||||
- **Finished screens**: Review, Init, Init Update and Handoff end with **Back to the dashboard**, as Quick Task does; only a pause leaves it off.
|
||||
- **Console sturdiness**: `wait` reports the server gone only after three missed health checks in a row, so a busy server is not taken for a dead one; a reused question id no longer inherits the old answer; polling stops redrawing an unchanged page and returns to the live stream (with backoff) once the server answers; `stop` gives a busy server a second, longer health check before leaving it alone; a fresh session in a linked worktree records the worktree as its folder; a text question whose `pattern` does not compile is refused at `post`.
|
||||
- **scripts/validate-char-count.js**: the dashboard prompt `src/plan2code.md` is size-checked too.
|
||||
|
||||
## v2.3.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **`plan2code-0-pathfinder`: `Resolved:` date on question files** — a sixth schema line recording the day each decision landed. Reconcile backfills older maps from `Claimed:` (today if unclaimed), and resolved map rows now carry the date in italics beside the gist. On the GitHub Issues backend the issue's own close date fills this role, so there is nothing to write and nothing to backfill.
|
||||
|
||||
- **`plan2code-0-pathfinder`: BRIEF mode** — asking for a `brief`, `recap`, or `minutes` writes a dated, plain-English report to `pathfinder/briefs/brief-<YYYYMMDD>.md`: what was decided in the range, what was ruled out, what is ready to decide next, what is still blocked, and what is next. Zero pathfinder machinery in the file — no numbers, markers, or jargon — so it doubles as meeting minutes for a joint Product and Engineering session. New `references/brief.md`; BRIEF mode never claims or resolves a question. The brief file stays on local disk on both backends.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **`plan2code-0-pathfinder`: MODE B cadence is now decide → menu → checkpoint** — questions still resolve strictly one at a time, but a session no longer ends after one. Recording a decision leads to a continue-or-stop fork-menu (new Trail Footer **Form C**, with the resume command always visible as the stop branch), and a fresh session is *recommended* after about three decisions — or after a heavy, contested, or locked one — to protect context quality rather than forced by the rules.
|
||||
|
||||
- **`plan2code-0-pathfinder`: every user-facing question uses the structured question UI when available** — intent gate, destination and frontier grills, recap confirmations, sketch reactions, `legwork · HITL` completion, and the new fork-menu. The old detail test that routed gnarly questions to prose Q blocks is gone: trade-offs go in option descriptions, composed answers come back through `Other`, and an artifact is shown in prose immediately before the tool rather than replacing it. Prose Q blocks are now fallback only, for when the tool does not exist.
|
||||
|
||||
- **`plan2code-0-pathfinder`: the breadth-first frontier grill gains seven product axes** — user value, success measurement, target user, rollout, analytics, support and docs, and legal/compliance, each with a sample probe. Inapplicable axes are named and skipped up front, and with Product in the room engineering and product batches alternate so neither team spectates. New group-session grilling rules: address the room, record who broke a tie, and never record a contested pick as decided — both positions go under `## Evidence` and the question stays open.
|
||||
|
||||
## v2.2.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Committed Agent Skills build** — each workflow under `src/` now builds to `skills/<skill-name>/SKILL.md`, with companion references nested under `references/`. `npm run build:skills` regenerates the artifact, and `npm test` verifies that committed skills have not drifted from their source prompts.
|
||||
|
||||
- **Project-scoped skill installation** — Custom → `L` now installs Plan2Code directly into the current project through the skills CLI instead of printing manual copy instructions.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Installation now delegates to the skills CLI** — Plan2Code ships one canonical Agent Skill format instead of maintaining separate command, prompt, workflow, and skill outputs for individual tools. The installer builds `skills/`, checks `npx --yes skills`, removes stale Plan2Code skills, and runs `skills add` with an explicit workflow list. Installation now requires Node.js 18+ and network access; installed skills can be updated with `npx skills update -g`.
|
||||
|
||||
- **Legacy installation cleanup is automatic** — install and uninstall sweep files written by earlier per-tool installers so old commands cannot shadow the canonical skills. This includes the Gemini CLI files retained exclusively for uninstall compatibility.
|
||||
|
||||
- **Default installation is skills-only** — main-menu option `I` no longer installs `plan2code-loop`. The loop remains part of `A` and is still available separately through Custom → `O`.
|
||||
|
||||
- **One frontmatter contract serves every agent** — generated `SKILL.md` files always include `name`, `description`, and `disable-model-invocation: true`. Reference files remain nested under their owning skill, eliminating the old flat-file path rewrite and its column-position constraint.
|
||||
|
||||
## v2.1.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Failure Log convention in the init prompts** — `/plan2code-init` now generates a `## Keeping this file current` / `## Failure log` pair at the end of `AGENTS.md`, so agents record repo-specific corrections as one imperative line each instead of relearning them. The section is always-inline (never split to `.agents-docs/`) and is listed in the generated `CLAUDE.md` pointer block. `/plan2code-init-update` gains a matching **Failure Log Audit** step that flags the section as missing on existing `AGENTS.md` files and offers to add it.
|
||||
|
||||
- **`plan2code-changelog` skill** (`.claude/skills/plan2code-changelog/`) — validates the CHANGELOG version before a PR is opened. Reads `main` for the current latest version, classifies the branch's changes to pick minor vs patch, and keeps `CHANGELOG.md`, `package.json`, and `version.json` in lockstep. Exists because parallel branches pick colliding version numbers independently.
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **`AGENTS.md` preamble shortened** in the init template — the generated header no longer enumerates specific agents (Claude Code, Cursor, Codex, Copilot, Devin, Zed) and reads "AI coding agents working with code in this repository."
|
||||
|
||||
- **`CLAUDE.md` added at the repo root** — a pointer file to `AGENTS.md`, matching what `/plan2code-init` now tells agents to generate.
|
||||
|
||||
- **`CLAUDE.md` template reconciled between the two init prompts** — `/plan2code-init` emitted the `CRITICAL — MANDATORY FIRST STEP` directive followed by a seven-item bullet list, while `/plan2code-init-update`'s Step 7 reference emitted the directive followed by a single prose line. Running one workflow after the other rewrote `CLAUDE.md` back and forth. `src/plan2code-init-update-references/ai-agent-file-sync.md` now carries the bullet-list form for both the `CLAUDE.md` and the generic reference template.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **Typos in the Failure Log template** — the template shipped in `src/plan2code-init.md` and `src/plan2code-init-update.md` said `AGETNS.md`, `mistage`, and "mistakes make by". Since agents copy this block verbatim into generated `AGENTS.md` files, the errors propagated into every project initialized with it.
|
||||
|
||||
## v2.1.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# CLAUDE.md
|
||||
|
||||
**CRITICAL — MANDATORY FIRST STEP: You MUST read [AGENTS.md](./AGENTS.md) before responding to ANY user message, including simple questions. Do NOT skip this step regardless of how trivial the request appears. No exceptions.**
|
||||
|
||||
See AGENTS.md for complete project documentation including:
|
||||
- Development commands and setup
|
||||
- Architecture overview
|
||||
- Workflow prompt reference
|
||||
- Plan2Code Loop CLI details
|
||||
- Code style and gotchas
|
||||
- Keeping this file current / Failure log
|
||||
- Section details in .agents-docs/
|
||||
|
||||
This file exists for Claude Code auto-loading. All AI coding agents should reference AGENTS.md.
|
||||
@@ -1,20 +1,55 @@
|
||||
# Plan2Code Quick Reference
|
||||
|
||||
## Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first.
|
||||
|
||||
## Launch
|
||||
|
||||
The web console is the main way in: a local page where questions, documents, build progress and sign-offs live.
|
||||
|
||||
| How | Command | What happens |
|
||||
| ------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------- |
|
||||
| From your project (shell) | `plan2code` | Opens Claude Code, Devin or Codex on the dashboard (`--cli claude` / `devin` / `codex` to choose) |
|
||||
| Inside any agent | `/plan2code` (`$plan2code` in Codex) | Opens the dashboard: a card for every skill, launched on the same page |
|
||||
| Install | `npx --allow-git=all git+https://github.com/jparkerweb/plan2code.git` | Installs the skills and the `plan2code` command (re-run it to update without the `plan2code` command) |
|
||||
| Update | `plan2code update` | Updates everything that was installed, with no menu; never uninstalls anything |
|
||||
| Straight into a skill | `/plan2code-1-plan --web` (any step) | Skips the "web console or terminal?" question and opens the page |
|
||||
|
||||
The install command always opens a menu. Back at your prompt with no output at all? npm could not reach the repository and hid the reason: run `git ls-remote https://github.com/jparkerweb/plan2code.git` to see it (usually the network, a proxy or the VPN).
|
||||
|
||||
Pick a skill on the dashboard and the same page becomes that session. Details: [.readme/web-console.md](.readme/web-console.md) · worked example: [.readme/walkthrough.md](.readme/walkthrough.md).
|
||||
|
||||
The **Notebook** icon in the top bar opens a private scratch pad for the folder you are in (Markdown and pictures, kept in `~/.plan2code/notepads/`, never shown to the agent).
|
||||
|
||||
## Commands
|
||||
|
||||
| Step | Command | Input | Output |
|
||||
| ------- | ----------------------------- | --------------- | -------------------------------------------------- |
|
||||
| Init | /plan2code-init | None | AGENTS.md file |
|
||||
| Update | /plan2code-init-update | AGENTS.md | Updated AGENTS.md |
|
||||
| 0 | /plan2code-0-pathfinder | A foggy idea | pathfinder/map.md *or* GitHub Issues + PLAN-DRAFT-<date>.md |
|
||||
| quick | /plan2code-quick-task | Requirements | Conversational plan (standalone — not a pipeline step) |
|
||||
| review | /plan2code-review | Scope guidance | Review findings + fixes |
|
||||
| 1 | /plan2code-1-plan | Requirements | PLAN-CONVERSATION-<date>.md + PLAN-DRAFT-<date>.md |
|
||||
| 1b | /plan2code-1b-revise-plan | Specs + changes | Updated specs |
|
||||
| 2 | /plan2code-2-document | PLAN-DRAFT.md | overview.md + Phase files |
|
||||
| 3 | /plan2code-3-implement | overview.md | Implemented code |
|
||||
| 4 | /plan2code-4-finalize | overview.md | Archived specs |
|
||||
| handoff | /plan2code-handoff | Conversation | Self-contained handoff doc in handoffs/ |
|
||||
Every command below is what a dashboard card runs. Typed on its own, each one asks "web console or terminal?" first.
|
||||
|
||||
| Step | Command | Input | Output |
|
||||
| ---------- | ----------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| — | /plan2code | None | Web console dashboard — a menu of every skill below, launched on the page |
|
||||
| Init | /plan2code-init | None | AGENTS.md file |
|
||||
| Update | /plan2code-init-update | AGENTS.md | Updated AGENTS.md |
|
||||
| 0 | /plan2code-0-pathfinder | A foggy idea | pathfinder/map.md *or* GitHub Issues + PLAN-DRAFT-<date>.md |
|
||||
| quick | /plan2code-quick-task | Requirements | A short plan, then the change built (standalone, not a pipeline step) |
|
||||
| review | /plan2code-review | Scope guidance | Review findings + fixes |
|
||||
| 1 | /plan2code-1-plan | Requirements | PLAN-CONVERSATION-<date>.md + PLAN-DRAFT-<date>.md |
|
||||
| 1b | /plan2code-1b-revise-plan | Specs + changes | Updated specs |
|
||||
| 2 | /plan2code-2-document | PLAN-DRAFT.md | overview.md + Phase files |
|
||||
| 3 | /plan2code-3-implement | overview.md | Implemented code |
|
||||
| 3+review | /plan2code-3-implement-review | overview.md | Reviewed implementation ready for approval (alternative to `/plan2code-3-implement`) |
|
||||
| 4 | /plan2code-4-finalize | overview.md | Archived specs |
|
||||
| handoff | /plan2code-handoff | Conversation | Self-contained handoff doc (OS temp dir by default, or a folder you pick such as `handoffs/`) |
|
||||
| xray | /plan2code-xray | An area, or none | An explanation citing files and commits, or `ARCHITECTURE-BRIEF-<date>.md` with the rough spots you picked |
|
||||
| diagnose | /plan2code-diagnose | A bug, or none | `DIAGNOSIS-<date>.md` with the cause and its evidence, then Quick Task (or Plan for a big fix) to fix it |
|
||||
| changelog | /plan2code-changelog | Your branch | `CHANGELOG.md` entries and the `package.json` version, from the default branch's latest version |
|
||||
| git | /plan2code-git | Your repo | Commits (`<subject>` / `AI Assisted`), branches, pull with conflict help, push, publish |
|
||||
|
||||
**Terminal instead:** run any command without `--web` and answer the interface question with **terminal**. Nothing is lost: same questions, same gates, same files under `specs/`. You can switch between the two mid-feature.
|
||||
|
||||
## File Structure
|
||||
|
||||
@@ -23,7 +58,8 @@ specs/
|
||||
└── <feature-name>/
|
||||
├── pathfinder/ # From Step 0 (optional, if charted locally)
|
||||
│ ├── map.md # the map: destination, decisions, fog
|
||||
│ └── questions/NN-<slug>.md # one decision question per file
|
||||
│ ├── questions/NN-<slug>.md # one decision question per file
|
||||
│ └── briefs/brief-<date>.md # on-demand plain-English decision briefs
|
||||
│ # (GitHub Issues backend: map issue + sub-issues instead)
|
||||
├── PLAN-DRAFT-<date>.md # From Step 1 (verified plan)
|
||||
├── PLAN-CONVERSATION-<date>.md # From Step 1 (conversation log)
|
||||
@@ -38,9 +74,9 @@ Note: `<date>` uses YYYYMMDD format (e.g., `20250204`)
|
||||
|
||||
## Key Rules
|
||||
|
||||
- Start NEW conversation for each step (and each implementation phase)
|
||||
- Keep sessions short: fresh console session when the meter turns red, and before a big plan or build step
|
||||
- ONE phase per conversation (but parallel phases can run in separate instances)
|
||||
- Reply "approved" to complete phases
|
||||
- Approve phases on the sign-off card (or reply "approved" in the terminal)
|
||||
- 90% confidence required before planning completes
|
||||
- Never look in `specs--completed/` (it's archived specs)
|
||||
|
||||
@@ -51,27 +87,29 @@ Note: `<date>` uses YYYYMMDD format (e.g., `20250204`)
|
||||
| `[ ]` | Pending | Not started |
|
||||
| `[/]` | In Progress | Agent working (or paused) |
|
||||
| `[x]` | Complete | Approved |
|
||||
| `[!]` | Blocked | Couldn't be done; the line says why and what you need to do |
|
||||
| `[?]` | Assumed | Couldn't be verified, assumed complete; check it |
|
||||
|
||||
## Parallel Execution
|
||||
|
||||
When phases have no file conflicts or dependencies, they can run simultaneously:
|
||||
|
||||
1. Documentation Mode auto-detects parallel-eligible phases
|
||||
2. Implementation Mode shows selection UI with status for each phase
|
||||
2. Implementation Mode asks which phase to take (a card on the web console), with the status of each
|
||||
3. Run multiple `/plan2code-3-implement` instances on different phases
|
||||
4. `[/]` status shows which phases are actively being worked on
|
||||
|
||||
## Quick Troubleshooting
|
||||
|
||||
| Issue | Solution |
|
||||
| ---------------------- | ------------------------------------------------- |
|
||||
| Lost context mid-phase | Attach spec files, say "resume from Task X.Y" |
|
||||
| Wrong phase started | Say "abort", start correct phase |
|
||||
| Issue | Solution |
|
||||
| ---------------------- | ------------------------------------------------ |
|
||||
| Lost context mid-phase | Attach spec files, say "resume from Task X.Y" |
|
||||
| Wrong phase started | Say "abort", start correct phase |
|
||||
| Need to change plan | Use `/plan2code-1b-revise-plan` |
|
||||
| Multiple spec folders | Specify which: "Continue with specs/user-auth/" |
|
||||
| Need AGENTS.md file | Use `/plan2code-init` to generate one |
|
||||
| Update AGENTS.md | Use `/plan2code-init-update` after sessions |
|
||||
| Run phases in parallel | Check Parallel Execution Groups in overview.md |
|
||||
| Multiple spec folders | Specify which: "Continue with specs/user-auth/" |
|
||||
| Need AGENTS.md file | Use `/plan2code-init` to generate one |
|
||||
| Update AGENTS.md | Use `/plan2code-init-update` after sessions |
|
||||
| Run phases in parallel | Check Parallel Execution Groups in overview.md |
|
||||
|
||||
## Workflow Decision
|
||||
|
||||
@@ -82,8 +120,9 @@ New to a project?
|
||||
Learned something during a session?
|
||||
└── /plan2code-init-update → Add learnings to AGENTS.md
|
||||
|
||||
Too unclaer to plan? (big idea, don't yet know what the questions are)
|
||||
└── /plan2code-0-pathfinder → chart it, clear one decision per session
|
||||
Too foggy to plan? (big idea, don't yet know what the questions are)
|
||||
└── /plan2code-0-pathfinder → chart it, clear one decision at a time
|
||||
├── continue-or-stop menu between decisions; fresh session recommended after ~3
|
||||
└── then → /plan2code-1-plan (resumes at Phase 4)
|
||||
|
||||
Is it a quick, small task?
|
||||
@@ -91,6 +130,7 @@ Is it a quick, small task?
|
||||
└── No → /plan2code-1-plan (full workflow)
|
||||
├── /plan2code-2-document
|
||||
├── /plan2code-3-implement (repeat per phase)
|
||||
│ ├── OR: /plan2code-3-implement-review (review gate before approval)
|
||||
│ └── OR: plan2code-loop (autonomous alternative)
|
||||
└── /plan2code-4-finalize
|
||||
|
||||
@@ -100,22 +140,4 @@ Need to revise mid-implementation?
|
||||
|
||||
## Autonomous Loop (Alternative)
|
||||
|
||||
The `plan2code-loop` CLI is an **alternative** to Step 3, not a replacement.
|
||||
|
||||
| Approach | Use When |
|
||||
|----------|----------|
|
||||
| `/plan2code-3-implement` | You want interactive control per phase |
|
||||
| `plan2code-loop` | You want hands-off autonomous execution |
|
||||
|
||||
```bash
|
||||
plan2code-loop # Fully interactive - auto-detects specs, prompts for options
|
||||
```
|
||||
|
||||
### Loop Modes
|
||||
|
||||
| Mode | Description |
|
||||
|------|-------------|
|
||||
| **One task per loop** (default) | One task per agent invocation. Node handles git commits. |
|
||||
| **One phase per loop** | All tasks in a phase per invocation. LLM handles git commits. Best for smart models with larger context. |
|
||||
|
||||
Session state stored per-spec in `specs/<feature>/.plan2code-loop/`
|
||||
`plan2code-loop` is a hands-off alternative to Step 3. See [.readme/autonomous-loop.md](.readme/autonomous-loop.md).
|
||||
@@ -1,48 +1,103 @@
|
||||
|
||||
# Plan2Code
|
||||
|
||||
<img src="docs/banner.png" alt="Plan2Code — send the plan, the build follows" style="max-width:1024px;">
|
||||
**A spec-driven workflow for AI coding agents.**
|
||||
|
||||
**A spec-driven workflow for AI coding agents. Send the plan — the build follows.**
|
||||
<img src="docs/banner.jpg" alt="banner" data="object-fit:contain;" style="max-width:1024px;">
|
||||
|
||||
An AI agent is a fine builder and a terrible client. Plan2Code stops making it both: you approve a
|
||||
plan, the plan becomes a set of phase documents in your repo, and the agent builds to those documents
|
||||
one phase at a time. Progress lives in files instead of chat history — so the next session, the next
|
||||
agent, and the next engineer all start from the same specs.
|
||||
You work through Plan2Code on a page in your browser. The dashboard lists every step as a card, and
|
||||
each step's questions, progress and sign-offs arrive on that same page while your agent does the
|
||||
work. What you decide still lands in your repo as plain files: an approved plan becomes phase
|
||||
documents, and the agent builds to them one phase at a time, so the next session, the next agent and
|
||||
the next engineer all start from the same specs.
|
||||
|
||||
Six commands, each posted separately. Two of them are optional.
|
||||
One command opens it, every step is a card, and the terminal is always there if you prefer it.
|
||||
|
||||
Version 2.0.0 · MIT · 📖 [plan2code.jparkerweb.com](https://plan2code.jparkerweb.com)
|
||||
Version 2.11.0 · MIT · 📖 [plan2code.jparkerweb.com](https://plan2code.jparkerweb.com)
|
||||
|
||||
---
|
||||
|
||||
## Install
|
||||
## See it
|
||||
|
||||
Requires [Node.js](https://nodejs.org/) 14 or later. Re-run any time to update.
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/dashboard-dark.webp">
|
||||
<img src="docs/screenshots/dashboard-light.webp" alt="The Plan2Code dashboard for a project mid-build: a Set up card, then the steps in order, with the Implement card marked Suggested and reading Phase 3 of 4 is next.">
|
||||
</picture>
|
||||
|
||||
The dashboard, in a project halfway through a build. It suggests the next step for the spec you pick.
|
||||
|
||||
---
|
||||
|
||||
## Install and start
|
||||
|
||||
### Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first.
|
||||
|
||||
Installation needs network access and runs through the [skills CLI](https://skills.sh). To update, run `plan2code update` (or re-run the install command).
|
||||
|
||||
```bash
|
||||
npx --allow-git=all git+https://github.com/jparkerweb/plan2code.git
|
||||
```
|
||||
|
||||
This fetches the installer to a temp directory, runs it, writes the slash commands for whichever
|
||||
tools you pick, and cleans up after itself. The installed commands work independently from then on.
|
||||
This fetches the installer to a temp directory, builds the workflow as Agent Skills, delegates
|
||||
installation to `skills add`, and cleans up after itself. The installed skills work independently
|
||||
from then on.
|
||||
|
||||
Either route lands you on the same menu:
|
||||
**Back at your prompt with no output at all?** The installer always opens the menu below, so nothing
|
||||
means npm could not reach the repository and hid the reason. Run
|
||||
`git ls-remote https://github.com/jparkerweb/plan2code.git` to see it: usually the network, a proxy
|
||||
or the VPN.
|
||||
|
||||
The installer opens this menu (cloning and running `node install.js`, below, opens the same one):
|
||||
|
||||
```
|
||||
╔═════════════════════════════════════════════════════════╗
|
||||
║ INSTALL PLAN2CODE ║
|
||||
╠═════════════════════════════════════════════════════════╣
|
||||
║ I. INSTALL Install Plan2Code for all platforms ║
|
||||
║ A. ALL Install Plan2Code + dev tools ║
|
||||
║ U. UNINSTALL Remove Plan2Code files ║
|
||||
║ C. CUSTOM Advanced options ║
|
||||
║ I. INSTALL Install skills + the plan2code command ║
|
||||
║ U. UNINSTALL Remove everything Plan2Code installed ║
|
||||
║ A. ADVANCED Project install, dev tools, and more ║
|
||||
║ Q. QUIT Exit ║
|
||||
╚═════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
**Supported tools:** Claude Code · Cursor · Windsurf · Continue · Codeium (IntelliJ) ·
|
||||
GitHub Copilot CLI · VS Code Copilot · Crush · Pi · Amp · OpenCode · Devin · Zed
|
||||
### Start
|
||||
|
||||
1. `cd` into your project, then run `plan2code`. It starts Claude Code, Devin or Codex on the dashboard,
|
||||
and the dashboard opens in your browser.
|
||||
2. In a project without an `AGENTS.md`, pick **Set up this project** first: Plan and Quick task
|
||||
need it.
|
||||
3. Pick a card.
|
||||
|
||||
Already inside your agent? Type `/plan2code` instead (`$plan2code` in Codex).
|
||||
|
||||
<details>
|
||||
<summary>About the plan2code command</summary>
|
||||
|
||||
Install (`I`) adds `plan2code` as a global command (Advanced `A` → `D` adds just the command). Run it from any project and the Plan2Code
|
||||
dashboard opens right there, in **Claude Code**, **Devin** or **Codex**. With more than one installed it asks which and
|
||||
remembers your pick; `plan2code --cli claude`, `--cli devin` or `--cli codex` skips the question, and `--model <name>`
|
||||
chooses the model. It works in cmd, PowerShell, Git Bash, macOS and Linux shells, and needs the
|
||||
Claude Code, Devin or Codex CLI on your `PATH`. It starts the agent with permission prompts off
|
||||
(`--permission-mode bypassPermissions` in Claude Code, `--permission-mode bypass` in Devin, `--dangerously-bypass-approvals-and-sandbox` in Codex); run
|
||||
`claude /plan2code` yourself if you want prompts. The installer then offers a desktop shortcut (answer `y`),
|
||||
which opens a folder picker first. Uninstalling (`U`) removes both.
|
||||
</details>
|
||||
|
||||
**Supported tools:** every agent supported by the skills CLI, including Claude Code · Cursor ·
|
||||
GitHub Copilot · Windsurf · Codex · Continue · Codeium · Zed · Amp · OpenCode · Devin · Crush · Pi ·
|
||||
Gemini CLI · Cline · Roo · Kilo · Goose · Trae · Qwen Code.
|
||||
|
||||
The installer keeps one canonical copy of each skill under `~/.agents/skills/` and links it into
|
||||
agents that maintain their own directory. To update, run `plan2code update` (or re-run the install command).
|
||||
|
||||
Use the installer rather than calling `skills add` against the repository root: recursive discovery
|
||||
would also find maintainer-only skills under `.claude/skills/`. The installer targets `skills/`
|
||||
explicitly.
|
||||
|
||||
<details>
|
||||
<summary>Prefer to clone?</summary>
|
||||
@@ -59,11 +114,55 @@ npm install && npx husky
|
||||
|
||||
---
|
||||
|
||||
## A session on the page
|
||||
|
||||
**Answer the questions.** They arrive a few at a time, each option with its trade-off written beside
|
||||
it, and a progress bar says how far along you are.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/question-dark.webp">
|
||||
<img src="docs/screenshots/question-light.webp" alt="A Plan question card, How tasks are paged, with three options, the first marked Suggested, each with its trade-off underneath.">
|
||||
</picture>
|
||||
|
||||
**Watch the build.** Tasks tick off as they land, and the line beside Planny says what is being
|
||||
worked on right now.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/build-dark.webp">
|
||||
<img src="docs/screenshots/build-light.webp" alt="A phase of a task API being built: 5 of 11 done on the progress bar, and the phase's task list with the first five ticked.">
|
||||
</picture>
|
||||
|
||||
**Sign off.** Read the completion report, then approve the phase or ask for changes. In Implement,
|
||||
you can also have the code reviewed first; Implement + review has already done it.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/signoff-dark.webp">
|
||||
<img src="docs/screenshots/signoff-light.webp" alt="The Approve this phase card, with a button to read the completion report and three choices: Review the code first, Approve this phase, and I want changes.">
|
||||
</picture>
|
||||
|
||||
**Ask a quick question any time.** The Ask tab is a chat beside the cards, answered at the agent's
|
||||
next check-in, and it never holds up your answers.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/ask-dark.webp">
|
||||
<img src="docs/screenshots/ask-light.webp" alt="The Ask tab: the question Where are tasks paged? and Plan2Code's answer naming the file.">
|
||||
</picture>
|
||||
|
||||
There is more on the page when you need it. Notes on any question can carry screenshots and
|
||||
documents. The folder label in the bottom bar opens your workspace, where you add other folders
|
||||
as read-only context and point at them by `@name`. The **Notebook** in the top bar is a private pad of your own for the
|
||||
folder, in Markdown with pictures, that the agent never sees. The session meter in the top bar turns from green
|
||||
to red as a session grows long and suggests a fresh one. **Stop session** saves your place and gives
|
||||
you the command to carry on later, and **Back to the dashboard** takes you home to pick the next
|
||||
step in the same session.
|
||||
|
||||
---
|
||||
|
||||
## The workflow
|
||||
|
||||
```
|
||||
┌╴╴╴╴╴╴╴╴╴╴╴╴┐
|
||||
╎0 PATHFINDER╎ optional · new in 2.0 · for an idea too big or unclear to plan
|
||||
╎0 PATHFINDER╎ optional · for an idea too big or unclear to plan
|
||||
└╴╴╴╴╴╴┬╴╴╴╴╴┘
|
||||
▼
|
||||
┌────────────┐ ┌────────────┐ ┌────────────┐ ┌╴╴╴╴╴╴╴╴╴╴╴╴┐ ┌────────────┐
|
||||
@@ -71,33 +170,41 @@ npm install && npx husky
|
||||
│decide what │ │ draw it as │ │build to the│ ╎ optional ╎ │verify, sum,│
|
||||
│ to build │ │phase specs │ │ drawing │ ╎ any time ╎ │ archive │
|
||||
└────────────┘ └────────────┘ └────────────┘ └╴╴╴╴╴╴╴╴╴╴╴╴┘ └────────────┘
|
||||
new chat new chat new chat/phase new chat new chat
|
||||
short sessions: fresh when the meter turns red, and before a big step
|
||||
├◀─────────────── one feature, start to archive ──────────────────▶┤
|
||||
```
|
||||
|
||||
Every box is its own conversation. That is not a style preference — planning context leaking into
|
||||
implementation is where most agent drift starts.
|
||||
Each box is a card on the dashboard. Chaining a couple of small steps in one session is fine, but
|
||||
start a fresh session before a big plan or build step: planning context leaking into implementation
|
||||
is where most agent drift starts.
|
||||
|
||||
| Command | Use it when |
|
||||
|---------|-------------|
|
||||
| `/plan2code-0-pathfinder` | The idea is too big and unclear to plan. Charts it as decisions, clears one per session, hands a hot plan draft to Step 1 |
|
||||
| `/plan2code-1-plan` | Starting a feature. Full requirements → architecture pass |
|
||||
| `/plan2code-2-document` | Planning is done. Turn the plan into phase specs |
|
||||
| `/plan2code-3-implement` | Build the next phase (one per conversation) |
|
||||
| `/plan2code-review` | Independent second opinion on local changes, then optional fixes |
|
||||
| `/plan2code-4-finalize` | All phases done. Validate, summarize, archive |
|
||||
| `/plan2code-init` | Generate this repo's `AGENTS.md` so every agent starts informed |
|
||||
| `/plan2code-init-update` | Fold what you learned this session back into `AGENTS.md` |
|
||||
| `/plan2code-quick-task` | A small change that doesn't warrant the full sequence |
|
||||
| `/plan2code-1b-revise-plan` | Requirements moved mid-build. Revise the specs, not the code |
|
||||
| `/plan2code-handoff` | Compact this conversation into a doc the next one resumes from |
|
||||
The dashboard's cards, and when each one lights up for the spec you pick:
|
||||
|
||||
| Card | What it is for | Lights up when |
|
||||
|------|----------------|----------------|
|
||||
| Set up this project | Reads your project and writes AGENTS.md, the guide every later step works from. | The project has no AGENTS.md yet |
|
||||
| Refresh AGENTS.md | Brings AGENTS.md and its notes up to date with what the project has learned lately. | The project has an AGENTS.md |
|
||||
| Pathfinder | A foggy idea becomes a clear list of decisions, settled one question at a time. | You start fresh, or the spec is still being explored |
|
||||
| Plan | Requirements, technical design and your approval: the shape of what gets built. | You start fresh, or the spec has a finished Pathfinder map, a drafted plan or a bug diagnosis |
|
||||
| Revise the plan | Requirements changed mid-build? Adjust the plan without starting over. | The spec is written up into phases and not fully built |
|
||||
| Document | The plan becomes a checklist of small tasks, grouped into phases, that a developer can just do. | The spec has a drafted plan |
|
||||
| Implement | Builds the next phase, task by task, with a report and your sign-off at the end. | The spec has phases with tasks still to build |
|
||||
| Implement + review | One phase built, then a careful review of the changes, then your sign-off. All in one run. | The spec has phases with tasks still to build |
|
||||
| Finalize | Checks the work, writes the summary, files the specs away and suggests the commit message. | Every task in the spec is done |
|
||||
| Quick task | Too small for the full process? A quick plan, then it just builds it. | Always (suggested when the spec is a diagnosed bug) |
|
||||
| Review | A second opinion on the changes. Problems ranked, and you pick what gets fixed. | Always |
|
||||
| Handoff | Pack this conversation into a document a fresh session can pick up cold. Any skill's **Stop with a handoff** writes one too, and the dashboard lists them to pick up. | Always |
|
||||
| Codebase X-ray | Explain how and why an area works, or find the rough spots worth fixing. | Always |
|
||||
| Diagnose a bug | Find a bug's cause and write it up, without fixing it. | Always |
|
||||
| Changelog | Checks the CHANGELOG version against the main branch and suggests entries for what is new. | Always |
|
||||
| Git | Branches, pull, push and commits on one board, asking before anything leaves your machine. | Always (offers to start a repository outside one) |
|
||||
|
||||
---
|
||||
|
||||
## The four rules that do most of the work
|
||||
|
||||
**1 · A fresh conversation for each step, and each implementation phase.**
|
||||
Step 3 gets a new chat per phase, not one chat for all of them.
|
||||
**1 · Keep each session short.**
|
||||
Chaining a couple of small skills on the dashboard is fine. Start a fresh console session when the session meter turns red, and always before a big planning or build step. The specs on disk carry everything between sessions.
|
||||
|
||||
**2 · No code until the plan hits 90% confidence.**
|
||||
Step 1 will not finalize below the threshold. Under it, the agent keeps asking and keeps reading your
|
||||
@@ -106,48 +213,20 @@ code — and writes every assumption down where you can argue with it.
|
||||
**3 · Checkboxes are the state, not the chat.**
|
||||
Progress lives in the spec files. Any agent, any session, resumes cold from them.
|
||||
|
||||
**4 · Reply `approved` to close a phase.**
|
||||
Nothing advances on a guess about what you meant.
|
||||
**4 · Approve a phase to close it.**
|
||||
On the sign-off card, or by replying `approved` in the terminal. Nothing advances on a guess about
|
||||
what you meant.
|
||||
|
||||
---
|
||||
|
||||
## What lands in your repo
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── specs/
|
||||
│ └── task-api/ ← in progress
|
||||
│ ├── pathfinder/ ← only if you charted it in Step 0
|
||||
│ │ ├── map.md the destination, the decisions, the fog
|
||||
│ │ └── questions/NN-<slug>.md one decision per file
|
||||
│ ├── PLAN-DRAFT-20260804.md ← Step 1: the verified plan
|
||||
│ ├── PLAN-CONVERSATION-*.md ← Step 1: how you got there
|
||||
│ ├── overview.md ← Step 2: phase list + parallel groups
|
||||
│ └── Phase 1.md … Phase N.md ← Step 2: one-point tasks, self-contained
|
||||
├── specs--completed/
|
||||
│ └── auth-refresh/ ← Step 4 files finished work here
|
||||
└── ...your code
|
||||
```
|
||||
Each feature gets a folder under `specs/` (the plan, the overview and one file per phase), and Step 4
|
||||
moves it to `specs--completed/`. The layout and progress marks are on the
|
||||
[quick reference](QUICK-REFERENCE.md#file-structure).
|
||||
|
||||
`specs/` is gitignored by default — it's your working drawing, not a deliverable. Share a folder
|
||||
deliberately with `git add -f` when you want to.
|
||||
|
||||
### Progress marks
|
||||
|
||||
| Mark | Status | Meaning |
|
||||
|------|--------|---------|
|
||||
| `[ ]` | Open | Unclaimed. Any agent picks it up cold. |
|
||||
| `[/]` | In progress | Claimed right now — which is how two agents run parallel phases without colliding. |
|
||||
| `[x]` | Done | Built, self-reviewed against the spec, approved by you. |
|
||||
|
||||
```markdown
|
||||
## Phases
|
||||
|
||||
- [x] Phase 1: Project setup
|
||||
- [x] Phase 2: Data model
|
||||
- [/] Phase 3: API endpoints ← an agent is on this now
|
||||
- [ ] Phase 4: Authentication ← next available
|
||||
```
|
||||
Add `specs/` to your project's `.gitignore` (`plan2code-loop` adds it for you): it's your working
|
||||
drawing, not a deliverable. Share a folder deliberately with `git add -f` when you want to.
|
||||
|
||||
Step 2 marks which phases don't share files. Open a second agent on one of those, and the `[/]` marks
|
||||
keep the two out of each other's way.
|
||||
@@ -156,10 +235,13 @@ keep the two out of each other's way.
|
||||
|
||||
## The six steps in detail
|
||||
|
||||
Each one travels on its own — a fresh conversation, opened and closed, with the specs on disk as the
|
||||
only thing carried between them.
|
||||
Each step is its own run, and the specs on disk are the only thing carried from one to the next.
|
||||
Chain a small one onto the last, or start a fresh session for a big one (rule 1).
|
||||
|
||||
### 0 · Pathfinder 🧭 — optional, new in 2.0
|
||||
### 0 · Pathfinder 🧭 (optional)
|
||||
|
||||
On the page: one question at a time with the options and their trade-offs, the map growing in its own
|
||||
tab, and a **Write a brief** button for a printable summary.
|
||||
|
||||
Some ideas are too big and unclear to plan: you can feel the shape of the work but you can't write
|
||||
it as requirements, so planning would just invent the answers. Pathfinder finds the *way* to the
|
||||
@@ -171,8 +253,11 @@ destination; Step 1 then walks it.
|
||||
sub-issue per decision, native blocking, so your team can see and work the frontier in the tracker).
|
||||
2. **Chart the map** — a breadth-first grilling surfaces the open decisions. Anything you can phrase
|
||||
*sharply* becomes a question file; anything you can only sense stays listed as fog.
|
||||
3. **Clear one question per session** — resolving a question burns off the fog behind it, graduating
|
||||
whatever just became sharp into new questions.
|
||||
3. **Clear the questions one at a time** — resolving one burns off the fog behind it, graduating
|
||||
whatever just became sharp into new questions. After each decision it offers a menu: take the next
|
||||
question here, or start fresh — recommended after about three, to keep the agent sharp.
|
||||
Ask for a **brief** at any point and you get a dated, plain-English summary of what has been
|
||||
decided, what is still open, and what is next — meeting minutes, with no jargon in them.
|
||||
4. **Hand off** — when nothing is left to decide, it writes a `PLAN-DRAFT` that
|
||||
`/plan2code-1-plan` resumes from at Phase 4, with requirements, context, and scope already
|
||||
answered.
|
||||
@@ -189,9 +274,13 @@ sub-issues) → `PLAN-DRAFT-<date>.md`. The draft is always a local file — tha
|
||||
|
||||
### 1 · Plan 🤔
|
||||
|
||||
The agent works as a senior architect through six phases, stopping for you after each: requirements
|
||||
analysis · system context (reading your actual codebase) · tech stack (needs your explicit sign-off) ·
|
||||
architecture design · technical specification · transition decision.
|
||||
On the page: questions in batches of up to three, the phase breakdown as a list you can reorder and
|
||||
edit, and a sign-off at each stage.
|
||||
|
||||
The agent works as a senior architect through seven phases, stopping for you after each: requirements
|
||||
analysis · system context (reading your actual codebase) · scope assessment (a large project saves and
|
||||
resumes in a fresh session) · tech stack (needs your explicit sign-off) · architecture design ·
|
||||
technical specification · transition decision.
|
||||
|
||||
It won't finalize below **90% confidence**, and every assumption it makes is written into the draft.
|
||||
|
||||
@@ -199,17 +288,23 @@ It won't finalize below **90% confidence**, and every assumption it makes is wri
|
||||
|
||||
### 2 · Document 📝
|
||||
|
||||
On the page: a question only where the plan leaves something open, each phase file appearing as its
|
||||
own tab as it is written, and one sign-off at the end.
|
||||
|
||||
The plan becomes the drawing. One `overview.md` with the phase checklist, plus one file per phase of
|
||||
one-story-point tasks. Each phase is **self-contained** — an agent opening `Phase 3.md` cold needs
|
||||
one-story-point tasks. Each phase is **self-contained** — an agent opening `phase-3.md` cold needs
|
||||
nothing else to build it. Unit and E2E tests are excluded unless you ask for them.
|
||||
|
||||
The overview also identifies the **parallel execution groups**: phases with no shared files or
|
||||
dependencies, safe to run in separate agents at once.
|
||||
|
||||
**In:** the `PLAN-DRAFT`. **Out:** `overview.md` + `Phase 1…N.md`
|
||||
**In:** the `PLAN-DRAFT`. **Out:** `overview.md` + `phase-1…N.md`
|
||||
|
||||
### 3 · Implement ⚡
|
||||
|
||||
On the page: a progress bar and the phase's task list ticking over as tasks land, then the completion
|
||||
report and a sign-off card where you approve, ask for changes, or have the code reviewed first.
|
||||
|
||||
Point it at `overview.md` and it does the rest: finds the next unchecked phase, implements every task
|
||||
exactly as specified, ticks tasks off as they land, then reviews its own work against the spec and
|
||||
writes a completion summary.
|
||||
@@ -218,8 +313,14 @@ One phase per conversation. It won't run tests unless the phase says to.
|
||||
|
||||
**In:** `specs/<feature>/overview.md`. **Out:** working code, and updated checkboxes.
|
||||
|
||||
Want a second pair of eyes before you sign off? `/plan2code-3-implement-review` builds the phase the
|
||||
same way, runs a focused review and the fixes you pick, and only then asks for approval.
|
||||
|
||||
### Review 🔬 — optional, any time
|
||||
|
||||
On the page: a few questions on scope, the findings as a report you can read in full, and a list
|
||||
where you tick what gets fixed.
|
||||
|
||||
An independent second opinion, not a rubber stamp. It figures out its own scope (conversation
|
||||
context, your instruction, or the git diff as a fallback), analyses across 11 dimensions, and ranks
|
||||
findings Critical / Warning / Suggestion. Every finding cites a file and a line, or it gets dropped —
|
||||
@@ -230,6 +331,9 @@ implementation step, but there's no wrong time to run it.
|
||||
|
||||
### 4 · Finalize 🧹
|
||||
|
||||
On the page: the task audit and the summary as reports, a list of the doc updates to approve, and a
|
||||
confirmation before anything is archived.
|
||||
|
||||
Validates every task against its phase spec, writes the summary and the list of files touched, flags
|
||||
the docs that drifted (`README`, `CHANGELOG`, `AGENTS.md`), then archives the whole spec folder —
|
||||
`pathfinder/` included — to `specs--completed/`. That folder is the record of *why* the code looks
|
||||
@@ -239,23 +343,43 @@ like this.
|
||||
|
||||
---
|
||||
|
||||
## What to bring to each step
|
||||
## Prefer the terminal?
|
||||
|
||||
| Step | Required input |
|
||||
|------|----------------|
|
||||
| 0 · Pathfinder | Nothing to start — just describe the idea. To continue: the feature name; it finds its own map |
|
||||
| 1 · Plan | Nothing — describe the feature |
|
||||
| 2 · Document | `specs/<feature>/PLAN-DRAFT-<date>.md`, or the planning conversation |
|
||||
| 3 · Implement | `specs/<feature>/overview.md` — it detects the phase itself |
|
||||
| Review | Scope guidance, e.g. "the last two phases", "just the auth module", "the whole PR". Auto-detects if you give none |
|
||||
| 4 · Finalize | `specs/<feature>/overview.md` |
|
||||
Every skill also runs right in the terminal. Each one asks at the start whether you want the web
|
||||
console or the terminal; add `--web` to skip the question and go straight to the web console:
|
||||
`/plan2code-1-plan --web plan a REST API for tasks`.
|
||||
|
||||
| Command | Use it when |
|
||||
|---------|-------------|
|
||||
| `/plan2code` | Open the dashboard in the web console: every skill below as a card, launched on the page |
|
||||
| `/plan2code-0-pathfinder` | The idea is too big and unclear to plan. Charts it as decisions, clears them one at a time, hands a hot plan draft to Step 1 |
|
||||
| `/plan2code-1-plan` | Starting a feature. Full requirements → architecture pass |
|
||||
| `/plan2code-2-document` | Planning is done. Turn the plan into phase specs |
|
||||
| `/plan2code-3-implement` | Build the next phase (one per conversation) |
|
||||
| `/plan2code-3-implement-review` | Build the next phase and review it before you approve it (instead of `/plan2code-3-implement`) |
|
||||
| `/plan2code-review` | Independent second opinion on local changes, then optional fixes |
|
||||
| `/plan2code-4-finalize` | All phases done. Validate, summarize, archive |
|
||||
| `/plan2code-init` | Generate this repo's `AGENTS.md` so every agent starts informed |
|
||||
| `/plan2code-init-update` | Fold what you learned this session back into `AGENTS.md` |
|
||||
| `/plan2code-quick-task` | A small change that doesn't warrant the full sequence |
|
||||
| `/plan2code-1b-revise-plan` | Requirements moved mid-build. Revise the specs, not the code |
|
||||
| `/plan2code-handoff` | Compact this conversation into a doc the next one resumes from, saved in `~/.plan2code/handoffs/` and listed on the dashboard to pick up |
|
||||
| `/plan2code-xray` | Explain how and why an area of the code works (citing files, commits and PRs), or rank the rough spots worth fixing into a brief for Pathfinder or Plan; never edits code |
|
||||
| `/plan2code-diagnose` | Find a bug's cause and write it up as `specs/<bug-name>/DIAGNOSIS-<date>.md` without fixing it, then offer `/plan2code-quick-task` to fix it, or `/plan2code-1-plan` when the fix is big |
|
||||
| `/plan2code-changelog` | Check the CHANGELOG version against the default branch, suggest entries for new work you can edit, keep `package.json` aligned, then hand off to Git to commit |
|
||||
| `/plan2code-git` | Branches, pull, push and commits on one board (or plain instructions in the terminal); asks before every push, publish and delete |
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Slash commands aren't recognised.** Re-run `node install.js` for that platform and restart your AI
|
||||
tool. For a per-project install, check the directory isn't gitignored.
|
||||
**The skills aren't recognised.** Re-run the installer and restart your AI tool. Confirm the global
|
||||
install with `npx skills list -g`. For a project install, check the generated directories aren't
|
||||
gitignored.
|
||||
|
||||
**Your tool doesn't read Agent Skills.** Since v2.2.0, Plan2Code ships only as skills. If your tool
|
||||
has no skill support, paste the relevant `src/plan2code-*.md` manually or point it at the installed
|
||||
copy under `~/.agents/skills/`.
|
||||
|
||||
**The agent starts coding during planning.** The prompts forbid it, but models drift. Say: "Stay in
|
||||
planning mode. Do not write code yet."
|
||||
@@ -272,13 +396,21 @@ the requirements.
|
||||
**Too many or too few phases.** Fix it in Step 2 — a phase should be a logical grouping of work, not
|
||||
a fixed size.
|
||||
|
||||
**The agent runs on another machine, or over SSH.** The page is served on `127.0.0.1` of the machine
|
||||
the agent runs on, so your browser can only reach it there. A forwarded port often works; otherwise
|
||||
work in the terminal, which loses nothing.
|
||||
|
||||
**Web console problems** (lost contact, a closed tab, a dead link): see
|
||||
[.readme/web-console.md](.readme/web-console.md#troubleshooting).
|
||||
|
||||
---
|
||||
|
||||
## Customizing
|
||||
|
||||
The prompts are yours to edit. Common changes: add testing requirements in Step 2, move the 90%
|
||||
confidence threshold in Step 1, restructure the `specs/` layout, or add review gates to Step 3.
|
||||
Source files live in `src/`; re-run `node install.js` to push your edits out to every platform.
|
||||
Source files live in `src/`; run `npm run build:skills`, then re-run `node install.js` to push your
|
||||
edits out through the skills CLI.
|
||||
|
||||
---
|
||||
|
||||
@@ -286,6 +418,7 @@ Source files live in `src/`; re-run `node install.js` to push your edits out to
|
||||
|
||||
Core reference:
|
||||
|
||||
- **[.readme/web-console.md](.readme/web-console.md)**: the full guide to the web console, from the dashboard to the last sign-off, including the private Notebook in the top bar
|
||||
- **[QUICK-REFERENCE.md](QUICK-REFERENCE.md)** — the one-page card: commands, inputs, outputs, decision tree
|
||||
- **[.readme/walkthrough.md](.readme/walkthrough.md)** — one feature from a sentence to archived specs, session by session
|
||||
- **[AGENTS.md](AGENTS.md)** — architecture and contributor guide for this repo
|
||||
|
||||
|
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 3.1 KiB |
|
After Width: | Height: | Size: 71 KiB |
|
Before Width: | Height: | Size: 127 KiB |
|
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 2.6 KiB |
|
Before Width: | Height: | Size: 584 B After Width: | Height: | Size: 884 B |
@@ -1,33 +1,7 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64" role="img" aria-label="Plan2Code postage stamp">
|
||||
<defs>
|
||||
<!-- Perforated stamp silhouette: white keeps, black bites out.
|
||||
Few, deep notches so the scalloped edge still reads at 16px. -->
|
||||
<mask id="perf">
|
||||
<rect width="64" height="64" fill="#000"/>
|
||||
<rect x="2" y="2" width="60" height="60" fill="#fff"/>
|
||||
<g fill="#000">
|
||||
<circle cx="2" cy="2" r="5"/><circle cx="14" cy="2" r="5"/><circle cx="26" cy="2" r="5"/>
|
||||
<circle cx="38" cy="2" r="5"/><circle cx="50" cy="2" r="5"/><circle cx="62" cy="2" r="5"/>
|
||||
<circle cx="2" cy="62" r="5"/><circle cx="14" cy="62" r="5"/><circle cx="26" cy="62" r="5"/>
|
||||
<circle cx="38" cy="62" r="5"/><circle cx="50" cy="62" r="5"/><circle cx="62" cy="62" r="5"/>
|
||||
<circle cx="2" cy="14" r="5"/><circle cx="2" cy="26" r="5"/>
|
||||
<circle cx="2" cy="38" r="5"/><circle cx="2" cy="50" r="5"/>
|
||||
<circle cx="62" cy="14" r="5"/><circle cx="62" cy="26" r="5"/>
|
||||
<circle cx="62" cy="38" r="5"/><circle cx="62" cy="50" r="5"/>
|
||||
</g>
|
||||
</mask>
|
||||
</defs>
|
||||
|
||||
<g mask="url(#perf)">
|
||||
<!-- printed stamp -->
|
||||
<rect x="2" y="2" width="60" height="60" fill="#D33A38"/>
|
||||
<!-- the 2, set as a franking-machine numeral -->
|
||||
<g fill="#FBFAF6">
|
||||
<rect x="16" y="13" width="32" height="8"/>
|
||||
<rect x="40" y="13" width="8" height="22"/>
|
||||
<rect x="16" y="27" width="32" height="8"/>
|
||||
<rect x="16" y="27" width="8" height="24"/>
|
||||
<rect x="16" y="43" width="32" height="8"/>
|
||||
</g>
|
||||
</g>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" role="img" aria-label="Plan2Code">
|
||||
<rect x="6" y="2.6" width="20" height="25.4" rx="4.4" fill="#eef3fa" stroke="#3b332c" stroke-width="2.2" />
|
||||
<rect x="9.6" y="27.6" width="4.8" height="2.6" rx="1.3" fill="#3b332c" />
|
||||
<rect x="17.6" y="27.6" width="4.8" height="2.6" rx="1.3" fill="#3b332c" />
|
||||
<path d="M16 8.8 L17.41 12.26 L21.14 12.53 L18.28 14.94 L19.17 18.57 L16 16.6 L12.83 18.57 L13.72 14.94 L10.86 12.53 L14.59 12.26 Z" fill="#2455a4" />
|
||||
<path d="M12.2 20.6 Q16 24.2 19.8 20.6" fill="none" stroke="#3b332c" stroke-width="1.8" stroke-linecap="round" />
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 636 B |
@@ -3,387 +3,467 @@
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<title>Plan2Code — Spec-Driven Workflow for AI Coding Agents</title>
|
||||
<meta name="description" content="Send the plan — the build follows. You approve a plan, it becomes phase documents in your repo, and the agent builds to those documents one phase at a time.">
|
||||
<title>Plan2Code: plan and build with your AI agent in your browser</title>
|
||||
<meta name="description" content="Plan and build with an AI coding agent on a page in your browser. You answer the questions and approve each phase, and the specs land in your repo as plain files.">
|
||||
<meta name="color-scheme" content="light dark">
|
||||
<link rel="icon" href="favicon.ico" sizes="32x32">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="favicon.png">
|
||||
<link rel="icon" href="favicon.svg" type="image/svg+xml">
|
||||
<link rel="apple-touch-icon" href="apple-touch-icon.png">
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||
<link href="https://fonts.googleapis.com/css2?family=Big+Shoulders+Display:wght@500;700;800&family=Karla:wght@300;400;500;600;700&family=Caveat:wght@500&display=swap" rel="stylesheet">
|
||||
<style>
|
||||
:root{
|
||||
--air:#E4ECF6; --air-2:#D3DEEE; --paper:#FBFAF6;
|
||||
--ink:#16233D; --ink-soft:#5E6E8A;
|
||||
--red:#D33A38; --blue:#2455A4; --kraft:#E5D8BE;
|
||||
/* The web console's palette and type (src/web-console/public/styles/tokens.css), so the
|
||||
site and the product look like one thing, with the Plan2Code blue as the
|
||||
accent: #2455a4 in light, and the console's Ocean highlight (palette.js),
|
||||
which the screenshots use, in dark. System fonts only, like the console. */
|
||||
:root {
|
||||
--bg: #f6f3ee;
|
||||
--panel: #ffffff;
|
||||
--panel-2: #fbf9f6;
|
||||
--ink: #1d1a17;
|
||||
--ink-2: #5d564d;
|
||||
--ink-3: #8f8779;
|
||||
--rule: #e4ddd1;
|
||||
--rule-2: #cfc6b6;
|
||||
--accent: #2455a4;
|
||||
--accent-soft: #ecf2f9;
|
||||
--accent-ink: #ffffff;
|
||||
--accent-line: #9ab4d3;
|
||||
--ok: #2f6b45;
|
||||
--focus: #1f6feb;
|
||||
--code-bg: #1d1a17;
|
||||
--code-ink: #f0ece5;
|
||||
--shadow: 0 1px 2px rgba(29, 26, 23, 0.05), 0 8px 24px rgba(29, 26, 23, 0.06);
|
||||
--shadow-lg: 0 2px 4px rgba(29, 26, 23, 0.06), 0 24px 60px rgba(29, 26, 23, 0.12);
|
||||
--sans: ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
|
||||
--serif: "Iowan Old Style", Charter, Georgia, Cambria, serif;
|
||||
--mono: ui-monospace, SFMono-Regular, "Cascadia Mono", Menlo, Consolas, monospace;
|
||||
--radius: 10px;
|
||||
--width: 1120px;
|
||||
--gutter: 24px;
|
||||
}
|
||||
*{margin:0;padding:0;box-sizing:border-box}
|
||||
body{background:var(--air);color:var(--ink);font:400 16.5px/1.65 'Karla',system-ui,sans-serif;-webkit-font-smoothing:antialiased}
|
||||
.bs{font-family:'Big Shoulders Display',sans-serif;font-weight:800;letter-spacing:.005em}
|
||||
.hand{font-family:'Caveat',cursive}
|
||||
.wrap{max-width:1140px;margin:0 auto;padding:0 34px}
|
||||
a{color:inherit}
|
||||
:focus-visible{outline:2px solid var(--red);outline-offset:3px}
|
||||
|
||||
/* ── SIGNATURE: airmail chevron border framing the page on all four sides ── */
|
||||
:root{--fr:11px}
|
||||
.frame-t,.frame-b,.frame-l,.frame-r{
|
||||
position:fixed;z-index:60;pointer-events:none;
|
||||
background:repeating-linear-gradient(-45deg,
|
||||
var(--red) 0 14px, var(--paper) 14px 28px,
|
||||
var(--blue) 28px 42px, var(--paper) 42px 56px);
|
||||
}
|
||||
.frame-t,.frame-b{left:0;right:0;height:var(--fr)}
|
||||
.frame-t{top:0}
|
||||
.frame-b{bottom:0}
|
||||
.frame-l,.frame-r{top:0;bottom:0;width:var(--fr)}
|
||||
.frame-l{left:0}
|
||||
.frame-r{right:0}
|
||||
body{padding:var(--fr)}
|
||||
|
||||
/* ── header (sticky, sits just under the top frame) ── */
|
||||
.top{
|
||||
background:var(--paper);border-bottom:2px solid var(--ink);
|
||||
position:sticky;top:var(--fr);z-index:40;
|
||||
}
|
||||
.top .wrap{display:flex;align-items:center;gap:16px;padding-top:13px;padding-bottom:12px}
|
||||
.brand{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:26px;letter-spacing:.01em;text-transform:uppercase}
|
||||
.brand i{font-style:normal;color:var(--red)}
|
||||
.avion{
|
||||
margin-left:auto;border:1.5px solid var(--blue);color:var(--blue);
|
||||
font-size:10px;letter-spacing:.22em;text-transform:uppercase;font-weight:700;padding:5px 11px;
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--bg: #171513;
|
||||
--panel: #201d1a;
|
||||
--panel-2: #262220;
|
||||
--ink: #f0ece5;
|
||||
--ink-2: #b6afa3;
|
||||
--ink-3: #8b8376;
|
||||
--rule: #332e29;
|
||||
--rule-2: #46403a;
|
||||
--accent: #619fe5;
|
||||
--accent-soft: #1a2533;
|
||||
--accent-ink: #0c1117;
|
||||
--accent-line: #3d5978;
|
||||
--ok: #74c28f;
|
||||
--focus: #6aa3ff;
|
||||
--code-bg: #0f0d0c;
|
||||
--code-ink: #f0ece5;
|
||||
--shadow: 0 1px 2px rgba(0, 0, 0, 0.4), 0 8px 24px rgba(0, 0, 0, 0.35);
|
||||
--shadow-lg: 0 2px 4px rgba(0, 0, 0, 0.45), 0 24px 60px rgba(0, 0, 0, 0.5);
|
||||
}
|
||||
}
|
||||
|
||||
/* ── hero: the envelope ── */
|
||||
.hero{padding:56px 0 70px}
|
||||
.env{
|
||||
background:var(--paper);border:2px solid var(--ink);position:relative;
|
||||
box-shadow:10px 12px 0 rgba(22,35,61,.14);padding:40px 42px 44px;
|
||||
* { box-sizing: border-box; }
|
||||
html { scroll-behavior: smooth; }
|
||||
body {
|
||||
margin: 0;
|
||||
background: var(--bg);
|
||||
color: var(--ink);
|
||||
font: 17px/1.6 var(--sans);
|
||||
-webkit-font-smoothing: antialiased;
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
/* cancellation waves */
|
||||
.cancel{position:absolute;right:34px;top:34px;width:210px;height:110px;pointer-events:none}
|
||||
.cancel .ring{fill:none;stroke:var(--red);stroke-width:2.2}
|
||||
.cancel .wv{fill:none;stroke:var(--red);stroke-width:2.2;opacity:.85}
|
||||
.cancel text{font-family:'Karla',sans-serif;font-weight:700;fill:var(--red);letter-spacing:.06em}
|
||||
/* stamp */
|
||||
.pstamp{
|
||||
position:absolute;right:250px;top:34px;width:86px;height:104px;background:var(--air-2);
|
||||
border:2px solid var(--ink);padding:8px;text-align:center;
|
||||
img { max-width: 100%; height: auto; }
|
||||
a { color: var(--accent); text-underline-offset: 3px; }
|
||||
a:hover { text-decoration-thickness: 2px; }
|
||||
code { font-family: var(--mono); font-size: 0.88em; }
|
||||
:focus-visible { outline: 2px solid var(--focus); outline-offset: 3px; border-radius: 4px; }
|
||||
h1, h2, h3 { font-family: var(--serif); font-weight: 600; line-height: 1.15; margin: 0; }
|
||||
h2 { font-size: clamp(1.8rem, 4vw, 2.5rem); margin-bottom: 12px; }
|
||||
h3 { font-size: 1.45rem; margin: 8px 0; }
|
||||
.muted { color: var(--ink-2); }
|
||||
.wrap { max-width: var(--width); margin: 0 auto; padding: 0 var(--gutter); }
|
||||
.narrow { max-width: 780px; margin: 0 auto; padding: 0 var(--gutter); text-align: center; }
|
||||
.skip { position: absolute; left: -9999px; top: 0; background: var(--panel); color: var(--ink); padding: 10px 16px; z-index: 10; }
|
||||
.skip:focus { left: 0; }
|
||||
|
||||
/* Planny, drawn as the console draws him: shell, star eye, lip, arms up. */
|
||||
.planny { display: block; margin: 0 auto; width: 44px; height: 60px; overflow: visible; }
|
||||
.planny .shell { fill: var(--panel); stroke: var(--ink-2); stroke-width: 1.3; }
|
||||
.planny .smile, .planny .arm path { fill: none; stroke: var(--ink-2); stroke-linecap: round; }
|
||||
.planny .smile { stroke-width: 0.9; }
|
||||
.planny .arm path { stroke-width: 1.2; }
|
||||
.planny .arm circle, .planny .foot { fill: var(--ink-2); }
|
||||
.planny .eye { fill: var(--accent); }
|
||||
|
||||
/* Screenshots: framed like a window, one per theme via <picture>. */
|
||||
.shot { display: block; border: 1px solid var(--rule-2); border-radius: var(--radius); overflow: hidden; background: var(--panel); box-shadow: var(--shadow); }
|
||||
.shot img { display: block; width: 100%; }
|
||||
.shot.big { border-radius: 14px; box-shadow: var(--shadow-lg); }
|
||||
|
||||
/* The install command and its copy button. */
|
||||
.cmd { position: relative; display: inline-flex; align-items: center; gap: 12px; max-width: 100%; background: var(--code-bg); color: var(--code-ink); border-radius: var(--radius); padding: 10px 10px 10px 18px; text-align: left; }
|
||||
.cmd pre { margin: 0; min-width: 0; overflow-x: auto; font: 14.5px/1.5 var(--mono); white-space: pre; }
|
||||
.cmd pre span { color: var(--accent-line); user-select: none; }
|
||||
.copy { flex: none; display: inline-flex; align-items: center; gap: 6px; border: 0; border-radius: 7px; background: var(--accent); color: var(--accent-ink); font: 700 13px/1 var(--sans); padding: 10px 12px; cursor: pointer; min-height: 40px; }
|
||||
.copy:hover { filter: brightness(1.08); }
|
||||
.copy svg { width: 16px; height: 16px; fill: none; stroke: currentColor; stroke-width: 2; stroke-linecap: round; stroke-linejoin: round; }
|
||||
.copy .tick { display: none; }
|
||||
.copy.-done .clip { display: none; }
|
||||
.copy.-done .tick { display: block; }
|
||||
.before { margin: 0 auto 20px; max-width: 640px; text-align: left; background: var(--panel); border: 1px solid var(--rule-2); border-radius: var(--radius); padding: 14px 18px; font-size: 15px; }
|
||||
.before h3 { font-size: 1.05rem; margin: 0 0 8px; }
|
||||
.before ul { margin: 0; padding-left: 20px; color: var(--ink-2); }
|
||||
.before li { margin: 4px 0; }
|
||||
.before strong { color: var(--ink); }
|
||||
.then { margin: 12px 0 0; color: var(--ink-2); font-size: 15px; }
|
||||
|
||||
/* Hero: centered headline, then the dashboard at full width. */
|
||||
.hero { padding: 40px 0 32px; background: linear-gradient(to bottom, var(--panel), var(--bg)); }
|
||||
.hero .narrow { max-width: 960px; }
|
||||
.hero h1 { font-size: clamp(2.2rem, 5.6vw, 3.7rem); line-height: 1.06; margin: 12px 0 14px; }
|
||||
.hero .lede { font-size: 1.2rem; color: var(--ink-2); margin: 0 auto 22px; max-width: 60ch; }
|
||||
.stage { max-width: 1200px; margin: 0 auto; padding: 8px var(--gutter) 72px; }
|
||||
|
||||
/* Sections. */
|
||||
section.s { padding: 72px 0; }
|
||||
section.alt { background: var(--panel); border-block: 1px solid var(--rule); }
|
||||
.intro { max-width: 62ch; margin: 0; }
|
||||
|
||||
/* How a session goes: alternating screenshot and text rows. */
|
||||
.row { display: grid; grid-template-columns: minmax(0, 7fr) minmax(0, 5fr); gap: 48px; align-items: center; margin-top: 56px; }
|
||||
.row.flip { grid-template-columns: minmax(0, 5fr) minmax(0, 7fr); }
|
||||
.row.flip .shot { order: 2; }
|
||||
.row .k { font-family: var(--serif); font-size: 3rem; line-height: 1; color: var(--accent); }
|
||||
.row p { color: var(--ink-2); margin: 0; }
|
||||
|
||||
/* The pipeline: a vertical line of steps, then the utilities. */
|
||||
.line { list-style: none; margin: 36px 0 0; padding: 0; position: relative; }
|
||||
.line::before { content: ""; position: absolute; left: 11px; top: 10px; bottom: 26px; width: 2px; background: var(--rule-2); }
|
||||
.line li { position: relative; padding: 0 0 26px 48px; }
|
||||
.line li::before { content: ""; position: absolute; left: 4px; top: 7px; width: 16px; height: 16px; border-radius: 50%; background: var(--panel); border: 2px solid var(--accent); }
|
||||
.line li.opt::before { border-style: dashed; }
|
||||
.line h3 { display: inline; font-family: var(--sans); font-size: 1.15rem; font-weight: 650; }
|
||||
.chip { display: inline-block; margin-left: 8px; vertical-align: 2px; font-size: 11px; font-weight: 700; letter-spacing: 0.08em; text-transform: uppercase; color: var(--ink-2); border: 1px solid var(--rule-2); border-radius: 999px; padding: 2px 8px; }
|
||||
.line p { margin: 4px 0 0; color: var(--ink-2); max-width: 64ch; }
|
||||
.line code { color: var(--ink-2); font-size: 13px; }
|
||||
.utils { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 12px; margin-top: 12px; }
|
||||
.util { border: 1px solid var(--rule-2); border-radius: var(--radius); background: var(--bg); padding: 16px; }
|
||||
.util h3 { font-family: var(--sans); font-size: 1rem; font-weight: 650; margin: 8px 0 4px; }
|
||||
.util p { margin: 0; font-size: 14.5px; color: var(--ink-2); }
|
||||
.util .chip { margin-left: 0; }
|
||||
|
||||
/* What the page gives you: a two-column list. */
|
||||
.feat { columns: 2; column-gap: 56px; margin-top: 36px; }
|
||||
.feat div { break-inside: avoid; padding: 18px 0; border-top: 1px solid var(--rule); }
|
||||
.feat h3 { font-size: 1.2rem; margin: 0 0 4px; }
|
||||
.feat p { margin: 0; color: var(--ink-2); }
|
||||
.feat-shots { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 24px; margin-top: 40px; }
|
||||
.feat-shots figure { margin: 0; }
|
||||
.feat-shots figcaption { margin-top: 10px; font-size: 14.5px; color: var(--ink-2); }
|
||||
|
||||
/* The rules: numbered. */
|
||||
ol.rules { list-style: none; padding: 0; margin: 32px 0 0; counter-reset: r; }
|
||||
ol.rules li { counter-increment: r; display: grid; grid-template-columns: 3.5rem minmax(0, 1fr); gap: 16px; padding: 22px 0; border-top: 1px solid var(--rule); }
|
||||
ol.rules li::before { content: counter(r); font-family: var(--serif); font-size: 2.6rem; line-height: 1; color: var(--accent); }
|
||||
ol.rules h3 { font-family: var(--sans); font-size: 1.15rem; font-weight: 650; margin: 0 0 4px; }
|
||||
ol.rules p { margin: 0; color: var(--ink-2); }
|
||||
|
||||
/* Prefer the terminal? */
|
||||
.term-band { display: grid; grid-template-columns: minmax(0, 1fr) minmax(0, 1fr); gap: 48px; align-items: center; }
|
||||
pre.term { background: var(--code-bg); color: var(--code-ink); border-radius: var(--radius); padding: 22px; margin: 0; font: 14.5px/1.8 var(--mono); overflow-x: auto; }
|
||||
|
||||
/* Closing install and footer. */
|
||||
.close { text-align: center; }
|
||||
.close .muted { margin: 0 0 22px; }
|
||||
footer { border-top: 1px solid var(--rule); padding: 26px 0 32px; color: var(--ink-2); font-size: 14.5px; }
|
||||
footer .wrap { display: flex; flex-wrap: wrap; justify-content: center; gap: 8px 22px; }
|
||||
footer a { color: inherit; }
|
||||
|
||||
@media (max-width: 820px) {
|
||||
.row, .row.flip, .term-band, .feat-shots { grid-template-columns: minmax(0, 1fr); gap: 20px; }
|
||||
.row.flip .shot { order: 0; }
|
||||
.row { margin-top: 44px; }
|
||||
.feat { columns: 1; }
|
||||
.utils { grid-template-columns: minmax(0, 1fr); }
|
||||
section.s { padding: 56px 0; }
|
||||
}
|
||||
.pstamp .in{border:1px solid rgba(22,35,61,.35);height:100%;display:flex;flex-direction:column;justify-content:center;gap:2px}
|
||||
.pstamp b{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:26px;line-height:1;color:var(--blue)}
|
||||
.pstamp span{font-size:8px;letter-spacing:.12em;text-transform:uppercase;color:var(--ink-soft);font-weight:700}
|
||||
@media(max-width:900px){.cancel,.pstamp{display:none}}
|
||||
|
||||
.kick{font-size:10.5px;letter-spacing:.24em;text-transform:uppercase;color:var(--blue);font-weight:700}
|
||||
h1{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:clamp(3rem,9vw,7rem);line-height:.86;text-transform:uppercase;margin-top:14px;max-width:13ch}
|
||||
h1 em{font-style:normal;color:var(--red)}
|
||||
.addr{
|
||||
margin-top:32px;padding-top:26px;border-top:1.5px dashed rgba(22,35,61,.3);
|
||||
display:grid;grid-template-columns:1fr 1fr;gap:36px;align-items:end;
|
||||
@media (max-width: 600px) {
|
||||
:root { --gutter: 16px; }
|
||||
body { font-size: 16px; }
|
||||
.hero { padding-top: 40px; }
|
||||
.cmd { display: flex; }
|
||||
.cmd pre { font-size: 13px; }
|
||||
ol.rules li { grid-template-columns: 2.5rem minmax(0, 1fr); }
|
||||
}
|
||||
.addr .to{font-size:10px;letter-spacing:.2em;text-transform:uppercase;color:var(--ink-soft);font-weight:700}
|
||||
.addr p{margin-top:10px;color:var(--ink-soft);max-width:44ch}
|
||||
.acts{display:flex;flex-wrap:wrap;gap:12px}
|
||||
.btn{
|
||||
display:inline-block;text-decoration:none;background:var(--ink);color:var(--paper);
|
||||
font-family:'Big Shoulders Display',sans-serif;font-weight:700;font-size:19px;letter-spacing:.1em;
|
||||
text-transform:uppercase;padding:12px 28px;transition:background .18s,transform .18s;
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
html { scroll-behavior: auto; }
|
||||
* { transition: none !important; animation: none !important; }
|
||||
}
|
||||
.btn:hover{background:var(--red);transform:translateY(-2px)}
|
||||
.btn.-o{background:transparent;border:2px solid var(--ink);color:var(--ink);padding:10px 26px}
|
||||
.btn.-o:hover{background:var(--ink);color:var(--paper)}
|
||||
|
||||
/* ── postage meter strip ── */
|
||||
.meter{background:var(--ink);color:var(--paper)}
|
||||
.meter .wrap{display:grid;grid-template-columns:repeat(auto-fit,minmax(140px,1fr));gap:0}
|
||||
.meter div{padding:24px 18px;border-left:1px dashed rgba(251,250,246,.28)}
|
||||
.meter div:first-child{border-left:none}
|
||||
.meter b{display:block;font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:2.4rem;line-height:1;color:#8FB6E8}
|
||||
.meter span{display:block;margin-top:3px;font-size:9.5px;letter-spacing:.14em;text-transform:uppercase;opacity:.66;font-weight:700}
|
||||
|
||||
/* ── dispatch (steps as airmail envelopes) ── */
|
||||
.dispatch{padding:80px 0 40px}
|
||||
.sect{display:flex;align-items:flex-end;gap:16px;border-bottom:2px solid var(--ink);padding-bottom:10px}
|
||||
.sect h2{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:clamp(2rem,5vw,3.4rem);text-transform:uppercase;line-height:.95}
|
||||
.sect span{margin-left:auto;font-size:10.5px;letter-spacing:.16em;text-transform:uppercase;color:var(--ink-soft);font-weight:700;padding-bottom:5px}
|
||||
|
||||
.letters{display:grid;grid-template-columns:repeat(auto-fit,minmax(400px,1fr));gap:22px;margin-top:30px}
|
||||
.ltr{
|
||||
background:var(--paper);border:2px solid var(--ink);position:relative;
|
||||
padding:26px 26px 28px 40px;display:flex;flex-direction:column;
|
||||
box-shadow:6px 7px 0 rgba(22,35,61,.12);transition:transform .2s,box-shadow .2s;
|
||||
}
|
||||
.ltr:hover{transform:translate(-3px,-3px);box-shadow:9px 10px 0 rgba(22,35,61,.16)}
|
||||
/* chevron spine */
|
||||
.ltr::before{
|
||||
content:'';position:absolute;left:0;top:0;bottom:0;width:14px;
|
||||
background:repeating-linear-gradient(-45deg,var(--red) 0 10px,var(--paper) 10px 20px,var(--blue) 20px 30px,var(--paper) 30px 40px);
|
||||
border-right:1px solid var(--ink);
|
||||
}
|
||||
.ltr .mark{
|
||||
position:absolute;right:20px;top:18px;width:56px;height:56px;border:2px solid var(--red);border-radius:50%;
|
||||
display:grid;place-items:center;text-align:center;transform:rotate(-11deg);
|
||||
font-size:8.5px;letter-spacing:.08em;text-transform:uppercase;color:var(--red);font-weight:700;line-height:1.25;
|
||||
}
|
||||
.ltr h3{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:1.9rem;text-transform:uppercase;line-height:1;padding-right:70px}
|
||||
.ltr .flag{
|
||||
display:inline-block;margin-left:9px;vertical-align:5px;font-family:'Karla',sans-serif;font-weight:700;
|
||||
font-size:9px;letter-spacing:.11em;text-transform:uppercase;background:var(--blue);color:#fff;padding:3px 8px;
|
||||
}
|
||||
.ltr .flag.-r{background:var(--red)}
|
||||
.ltr code{display:block;font-family:ui-monospace,Menlo,monospace;font-size:11.5px;color:var(--blue);margin-top:7px;font-weight:600}
|
||||
.ltr p{margin-top:12px;color:var(--ink-soft);font-size:.94rem}
|
||||
.ltr .pen{font-family:'Caveat',cursive;font-size:1.2rem;color:var(--red);margin-top:10px;transform:rotate(-.8deg)}
|
||||
.ltr ul{list-style:none;margin-top:auto;padding-top:16px}
|
||||
.ltr li{font-size:.85rem;padding:6px 0 6px 18px;position:relative;border-top:1px dotted rgba(22,35,61,.24)}
|
||||
.ltr li::before{content:'✈';position:absolute;left:0;color:var(--blue);font-size:9px;top:9px}
|
||||
|
||||
/* ── two routes ── */
|
||||
.routes{background:var(--paper);border-top:2px solid var(--ink);border-bottom:2px solid var(--ink);padding:76px 0;margin-top:56px}
|
||||
.rc{display:grid;grid-template-columns:1fr 1fr;gap:24px;margin-top:28px}
|
||||
.rc div{border:2px solid var(--ink);padding:26px 24px}
|
||||
.rc .-a{background:rgba(211,58,56,.06)}
|
||||
.rc .-b{background:rgba(36,85,164,.06)}
|
||||
.rc h4{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:1.5rem;text-transform:uppercase}
|
||||
.rc ul{list-style:none;margin-top:14px}
|
||||
.rc li{padding:9px 0 9px 24px;position:relative;font-size:.95rem;border-top:1px solid rgba(22,35,61,.14);color:var(--ink-soft)}
|
||||
.rc li:first-child{border-top:none}
|
||||
.rc .-a li::before{content:'✕';position:absolute;left:0;color:var(--red);font-weight:700}
|
||||
.rc .-b li::before{content:'✓';position:absolute;left:0;color:var(--blue);font-weight:700}
|
||||
|
||||
/* ── regulations ── */
|
||||
.regs{padding:78px 0}
|
||||
.rg{display:grid;grid-template-columns:repeat(auto-fit,minmax(230px,1fr));gap:0;margin-top:26px;border-top:2px solid var(--ink);border-left:2px solid var(--ink)}
|
||||
.rg div{padding:22px 20px;border-right:2px solid var(--ink);border-bottom:2px solid var(--ink);background:var(--paper)}
|
||||
.rg b{font-size:10px;letter-spacing:.15em;text-transform:uppercase;color:var(--red);font-weight:700}
|
||||
.rg p{margin-top:9px;font-size:.94rem;color:var(--ink-soft)}
|
||||
.rg p strong{color:var(--ink);font-weight:700}
|
||||
|
||||
/* ── install ── */
|
||||
.install{padding:0 0 82px}
|
||||
.term{margin-top:20px;background:var(--ink);color:#D6E2F2;padding:24px;
|
||||
font-family:ui-monospace,Menlo,monospace;font-size:12.5px;line-height:2.05;overflow-x:auto}
|
||||
.term .c{color:#7488A6}.term .k{color:#F0B06A}.term .p{color:#8FB6E8}
|
||||
|
||||
/* ── close ── */
|
||||
.close{background:var(--ink);color:var(--paper);text-align:center;padding:92px 0}
|
||||
.close h2{font-family:'Big Shoulders Display',sans-serif;font-weight:800;font-size:clamp(2.4rem,7vw,5.2rem);text-transform:uppercase;line-height:.9}
|
||||
.close h2 em{font-style:normal;color:#8FB6E8}
|
||||
.close .hand{display:block;margin-top:14px;font-size:1.5rem;color:#8FB6E8}
|
||||
.close .btn{margin-top:24px;background:var(--red)}
|
||||
.close .btn:hover{background:var(--paper);color:var(--ink)}
|
||||
footer{background:var(--ink);color:rgba(251,250,246,.5);padding:0 0 28px;font-size:10px;letter-spacing:.15em;text-transform:uppercase;font-weight:700}
|
||||
footer .wrap{display:flex;justify-content:space-between;gap:12px;flex-wrap:wrap;border-top:1px dashed rgba(251,250,246,.24);padding-top:20px}
|
||||
|
||||
@media(max-width:700px){:root{--fr:8px}}
|
||||
@media(max-width:820px){
|
||||
.wrap{padding:0 20px}
|
||||
.env{padding:26px 22px 28px}
|
||||
.addr{grid-template-columns:1fr;gap:22px}
|
||||
.rc{grid-template-columns:1fr}
|
||||
.letters{grid-template-columns:1fr}
|
||||
}
|
||||
@media(prefers-reduced-motion:reduce){*{transition:none!important}}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<a class="skip" href="#main">Skip to the content</a>
|
||||
<main id="main">
|
||||
|
||||
<div class="frame-t" aria-hidden="true"></div>
|
||||
<div class="frame-b" aria-hidden="true"></div>
|
||||
<div class="frame-l" aria-hidden="true"></div>
|
||||
<div class="frame-r" aria-hidden="true"></div>
|
||||
|
||||
<header class="top">
|
||||
<div class="wrap">
|
||||
<span class="brand">PLAN<i>2</i>CODE</span>
|
||||
<span class="avion">Par Avion · Via Air Mail</span>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<section class="hero">
|
||||
<div class="wrap">
|
||||
<div class="env">
|
||||
<div class="pstamp"><div class="in"><b>2.0</b><span>Plan2Code</span><span>Postage</span></div></div>
|
||||
<svg class="cancel" viewBox="0 0 210 110" aria-hidden="true">
|
||||
<circle class="ring" cx="52" cy="55" r="42"/>
|
||||
<text x="52" y="46" text-anchor="middle" font-size="10">SHIPPED</text>
|
||||
<text x="52" y="62" text-anchor="middle" font-size="13" font-weight="700">2026</text>
|
||||
<text x="52" y="76" text-anchor="middle" font-size="8">NO REWORK</text>
|
||||
<path class="wv" d="M98,36 C118,28 138,44 158,36 C178,28 194,40 208,34"/>
|
||||
<path class="wv" d="M98,50 C118,42 138,58 158,50 C178,42 194,54 208,48"/>
|
||||
<path class="wv" d="M98,64 C118,56 138,72 158,64 C178,56 194,68 208,62"/>
|
||||
<path class="wv" d="M98,78 C118,70 138,86 158,78 C178,70 194,82 208,76"/>
|
||||
</svg>
|
||||
|
||||
<p class="kick">Spec-driven workflow for AI coding agents</p>
|
||||
<h1>Send the plan.<br>The build <em>follows</em>.</h1>
|
||||
|
||||
<div class="addr">
|
||||
<div>
|
||||
<p class="to">Addressed to</p>
|
||||
<p>Anyone who has watched an AI agent confidently build the wrong thing. You approve a plan, it becomes phase documents in your repo, and the agent works to those documents one phase at a time.</p>
|
||||
</div>
|
||||
<div class="acts">
|
||||
<a class="btn" href="https://github.com/jparkerweb/plan2code">Install Plan2Code</a>
|
||||
<a class="btn -o" href="#dispatch">Read the letters</a>
|
||||
</div>
|
||||
</div>
|
||||
<section class="hero" aria-labelledby="hero-title">
|
||||
<div class="narrow">
|
||||
<svg class="planny" viewBox="0 0 22 30" aria-hidden="true" focusable="false">
|
||||
<rect class="foot" x="5.7" y="27.1" width="3.6" height="1.7" rx="0.85"/>
|
||||
<rect class="foot" x="12.7" y="27.1" width="3.6" height="1.7" rx="0.85"/>
|
||||
<rect class="shell" x="3" y="7" width="16" height="20" rx="3.2"/>
|
||||
<path class="eye" d="M11 10.95 L11.79 12.91 L13.9 13.06 L12.28 14.42 L12.79 16.47 L11 15.35 L9.21 16.47 L9.72 14.42 L8.1 13.06 L10.21 12.91 Z"/>
|
||||
<path class="smile" d="M8.3 18.4 Q11 21 13.7 18.4"/>
|
||||
<g class="arm"><path d="M3 16.5 L1.1 13.7"/><circle cx="1.1" cy="13.7" r="0.85"/></g>
|
||||
<g class="arm"><path d="M19 16.5 L20.9 13.7"/><circle cx="20.9" cy="13.7" r="0.85"/></g>
|
||||
</svg>
|
||||
<h1 id="hero-title">Plan and build with your AI agent, on one page.</h1>
|
||||
<p class="lede">Plan2Code asks the questions, drafts the plan and builds it one phase at a time. You answer and approve in your browser, and the specs land in your repo.</p>
|
||||
<div class="before" id="before-start">
|
||||
<h3>Before you start</h3>
|
||||
<ul>
|
||||
<li><strong>Node.js 18 or newer.</strong> Check with <code>node --version</code>. No Node? Get it from <a href="https://nodejs.org/">nodejs.org</a> (the LTS download), or run <code>winget install OpenJS.NodeJS.LTS</code> on Windows, <code>brew install node</code> on macOS, or use <code>nvm</code> on Linux. Then open a new terminal.</li>
|
||||
<li><strong>Start from your project.</strong> Open your terminal in the project you want to work on (<code>cd</code> into it) before you run anything. Plan2Code works on the folder you start it in.</li>
|
||||
<li><strong>Ways in.</strong> <code>plan2code</code> (Claude Code, Devin or Codex), or type <code>/plan2code</code> in your agent (<code>$plan2code</code> in Codex).</li>
|
||||
<li><strong>No agent yet?</strong> Install Claude Code, Codex or Devin first.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="cmd">
|
||||
<pre id="install-cmd"><span aria-hidden="true">$ </span>npx --allow-git=all git+https://github.com/jparkerweb/plan2code.git</pre>
|
||||
<button class="copy" type="button" aria-label="Copy the install command">
|
||||
<svg class="clip" viewBox="0 0 24 24" aria-hidden="true"><rect x="9" y="9" width="11" height="12" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>
|
||||
<svg class="tick" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 12.5 9.5 18 20 6.5"/></svg>
|
||||
<span class="label">Copy</span>
|
||||
</button>
|
||||
</div>
|
||||
<p class="then">then, from your project, run <code>plan2code</code> (Claude Code, Devin or Codex), or type <code>/plan2code</code> in your agent (<code>$plan2code</code> in Codex).</p>
|
||||
<p class="then">It always opens a menu; no output at all means npm could not reach the repository and hid the reason: <code>git ls-remote https://github.com/jparkerweb/plan2code.git</code> shows why.</p>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<div class="meter">
|
||||
<div class="wrap">
|
||||
<div><b>90%</b><span>Confidence gate</span></div>
|
||||
<div><b>11</b><span>Review dimensions</span></div>
|
||||
<div><b>1</b><span>Chat per phase</span></div>
|
||||
<div><b>0</b><span>Context pollution</span></div>
|
||||
</div>
|
||||
<div class="stage">
|
||||
<picture class="shot big">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/dashboard-dark.webp">
|
||||
<img src="screenshots/dashboard-light.webp" width="2560" height="1600" alt="The Plan2Code dashboard for a task API that is half built: a Set up card, then the steps in order, with the Implement card marked Suggested and reading Phase 3 of 4 is next.">
|
||||
</picture>
|
||||
</div>
|
||||
|
||||
<section class="dispatch wrap" id="dispatch">
|
||||
<div class="sect"><h2>Six written letters</h2><span>Two optional</span></div>
|
||||
|
||||
<div class="letters">
|
||||
|
||||
<article class="ltr">
|
||||
<span class="mark">Opt<br>00</span>
|
||||
<h3>Pathfinder<span class="flag">New in 2.0</span></h3>
|
||||
<code>/plan2code-0-pathfinder</code>
|
||||
<p>For an idea that arrives too foggy to plan. It charts the idea as a map of decision questions and clears exactly one per session until nothing is left to decide.</p>
|
||||
<p class="pen">it never answers its own questions — that's the point</p>
|
||||
<ul>
|
||||
<li>One decision per file, one file per session</li>
|
||||
<li>Research questions fan out to parallel agents</li>
|
||||
<li>Clears at ≥18/25 on four confidence dimensions</li>
|
||||
<li>Hands a hot plan draft to Step 1</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
<article class="ltr">
|
||||
<span class="mark">Req<br>01</span>
|
||||
<h3>Plan</h3>
|
||||
<code>/plan2code-1-plan</code>
|
||||
<p>A real back-and-forth about what gets built. Requirements pulled apart, your codebase actually read, the stack confirmed rather than assumed.</p>
|
||||
<ul>
|
||||
<li>Functional and non-functional requirements</li>
|
||||
<li>Integration points read from real source</li>
|
||||
<li>Tech stack confirmed by explicit approval</li>
|
||||
<li>Will not finalize below 90% confidence</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
<article class="ltr">
|
||||
<span class="mark">Req<br>02</span>
|
||||
<h3>Document</h3>
|
||||
<code>/plan2code-2-document</code>
|
||||
<p>The plan stops being a conversation and becomes files — an overview plus one self-contained phase document per phase, cut into one-story-point tasks.</p>
|
||||
<ul>
|
||||
<li>overview.md and Phase 1…N.md land in your repo</li>
|
||||
<li>One-point tasks with real checkboxes</li>
|
||||
<li>Parallel groups marked for concurrent agents</li>
|
||||
<li>Each phase readable with no prior context</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
<article class="ltr">
|
||||
<span class="mark">Req<br>03</span>
|
||||
<h3>Implement</h3>
|
||||
<code>/plan2code-3-implement</code>
|
||||
<p>Build to the drawing, one phase per conversation. Planning context bleeding into implementation is where most agent drift starts.</p>
|
||||
<p class="pen">reply “approved” — nothing advances on a guess</p>
|
||||
<ul>
|
||||
<li>Fresh conversation for every phase</li>
|
||||
<li>Specs followed exactly as documented</li>
|
||||
<li>Self-review against the spec before close</li>
|
||||
<li>[/] claims prevent parallel-agent collisions</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
<article class="ltr">
|
||||
<span class="mark">Opt<br>✳</span>
|
||||
<h3>Review<span class="flag -r">Second opinion</span></h3>
|
||||
<code>/plan2code-review</code>
|
||||
<p>An independent senior engineer with fresh eyes and no attachment to the code that just shipped. It reads every changed file completely and reports only what it can prove — file, line, and a concrete fix.</p>
|
||||
<ul>
|
||||
<li>Scope adapts: files, branch diff, or subsystem</li>
|
||||
<li>All 11 dimensions reported, clean ones justified</li>
|
||||
<li>Ranked Critical / Warning / Suggestion</li>
|
||||
<li>Read-only until you reply H, A, or S 1,3,5</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
<article class="ltr">
|
||||
<span class="mark">Req<br>04</span>
|
||||
<h3>Finalize</h3>
|
||||
<code>/plan2code-4-finalize</code>
|
||||
<p>Close it out. Every task audited against the spec it came from, a summary of what was built, docs checked for drift, and the folder filed away.</p>
|
||||
<ul>
|
||||
<li>Audit for tasks quietly left open</li>
|
||||
<li>Summary of what was built and changed</li>
|
||||
<li>README and other docs reconciled</li>
|
||||
<li>Specs archived to specs--completed/</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="routes">
|
||||
<section class="s" id="session" aria-labelledby="session-title">
|
||||
<div class="wrap">
|
||||
<div class="sect"><h2>Two routes</h2><span>Same destination</span></div>
|
||||
<div class="rc">
|
||||
<div class="-a">
|
||||
<h4>Sent without an address</h4>
|
||||
<ul>
|
||||
<li>Coding starts, requirements arrive later</li>
|
||||
<li>Design problems surface mid-build</li>
|
||||
<li>Constant backtracking and rework</li>
|
||||
<li>Context bloated with abandoned attempts</li>
|
||||
<li>No way to prove requirements were met</li>
|
||||
<li>Tokens burned on trial and error</li>
|
||||
</ul>
|
||||
<h2 id="session-title">How a session goes</h2>
|
||||
<p class="intro muted">One page, from the first card to the sign-off. Your agent does the work in the terminal; you do your part here.</p>
|
||||
|
||||
<div class="row">
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/question-dark.webp">
|
||||
<img src="screenshots/question-light.webp" width="2560" height="1600" loading="lazy" alt="A Plan question card, How tasks are paged, with three options, the first marked Suggested, each with its trade-off underneath.">
|
||||
</picture>
|
||||
<div>
|
||||
<span class="k" aria-hidden="true">1</span>
|
||||
<h3>Pick a card, answer on the page</h3>
|
||||
<p>Pick a step on the dashboard and it starts right there. Questions arrive a few at a time, each option with its trade-off written under it.</p>
|
||||
</div>
|
||||
<div class="-b">
|
||||
<h4>Sent with a plan attached</h4>
|
||||
<ul>
|
||||
<li>The plan is approved before any code</li>
|
||||
<li>Problems caught while they are still cheap</li>
|
||||
<li>Implementation follows the drawing</li>
|
||||
<li>Clean context, one phase at a time</li>
|
||||
<li>Checkboxes prove what is done</li>
|
||||
<li>Tokens spent building the agreed thing</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="row flip">
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/build-dark.webp">
|
||||
<img src="screenshots/build-light.webp" width="2560" height="1600" loading="lazy" alt="A phase of a task API being built: 5 of 11 done on the progress bar, and the phase's task list with the first five ticked.">
|
||||
</picture>
|
||||
<div>
|
||||
<span class="k" aria-hidden="true">2</span>
|
||||
<h3>Watch it build</h3>
|
||||
<p>Tasks tick off as they land, and the line beside Planny says what is being worked on right now.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/signoff-dark.webp">
|
||||
<img src="screenshots/signoff-light.webp" width="2560" height="1600" loading="lazy" alt="The Approve this phase card, with a button to read the completion report and three choices: Review the code first, Approve this phase, and I want changes.">
|
||||
</picture>
|
||||
<div>
|
||||
<span class="k" aria-hidden="true">3</span>
|
||||
<h3>Sign off</h3>
|
||||
<p>Read the completion report, then approve the phase or ask for changes. In Implement, you can also have the code reviewed first.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="regs wrap">
|
||||
<div class="sect"><h2>Postal regulations</h2><span>Four · non-negotiable</span></div>
|
||||
<div class="rg">
|
||||
<div><b>Reg 01</b><p>A <strong>fresh conversation</strong> for each step, and each implementation phase.</p></div>
|
||||
<div><b>Reg 02</b><p>No code until the plan hits <strong>90% confidence</strong>. The gate does not negotiate.</p></div>
|
||||
<div><b>Reg 03</b><p><strong>Checkboxes are the state</strong>, not the chat. Any session resumes cold.</p></div>
|
||||
<div><b>Reg 04</b><p>Reply <strong>approved</strong> to close a phase. Nothing advances on a guess.</p></div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="install wrap">
|
||||
<div class="sect"><h2>Installation</h2><span>Node 14+ · re-run to update</span></div>
|
||||
<pre class="term"><span class="p">$</span> npx <span class="k">--allow-git=all</span> git+https://github.com/jparkerweb/plan2code.git</pre>
|
||||
</section>
|
||||
|
||||
<section class="close">
|
||||
<section class="s alt" id="pipeline" aria-labelledby="pipeline-title">
|
||||
<div class="wrap">
|
||||
<h2>Post it once.<br><em>Then go outside.</em></h2>
|
||||
<span class="hand">free, MIT, twenty seconds to install</span>
|
||||
<br><a class="btn" href="https://github.com/jparkerweb/plan2code">Get Plan2Code</a>
|
||||
<h2 id="pipeline-title">The pipeline</h2>
|
||||
<p class="intro muted">Every step is a card on the dashboard. Each one writes files the next one reads, so any session can pick up cold.</p>
|
||||
<ol class="line">
|
||||
<li class="opt"><h3>Pathfinder</h3><span class="chip">Step 0 · optional</span><p>A foggy idea becomes a clear list of decisions, settled one question at a time. <code>/plan2code-0-pathfinder</code></p></li>
|
||||
<li><h3>Plan</h3><span class="chip">Step 1</span><p>Requirements, technical design and your approval: the shape of what gets built. <code>/plan2code-1-plan</code></p></li>
|
||||
<li><h3>Document</h3><span class="chip">Step 2</span><p>The plan becomes a checklist of small tasks, grouped into phases, that a developer can just do. <code>/plan2code-2-document</code></p></li>
|
||||
<li><h3>Implement</h3><span class="chip">Step 3 · once per phase</span><p>Builds the next phase, task by task, with a report and your sign-off at the end. <strong>Implement + review</strong> adds a careful review of the changes before the sign-off. <code>/plan2code-3-implement</code></p></li>
|
||||
<li><h3>Finalize</h3><span class="chip">Step 4</span><p>Checks the work, writes the summary, files the specs away and suggests the commit message. <code>/plan2code-4-finalize</code></p></li>
|
||||
</ol>
|
||||
<div class="utils">
|
||||
<div class="util"><span class="chip">Any time</span><h3>Quick task</h3><p>Too small for the full process? A quick plan, then it just builds it.</p></div>
|
||||
<div class="util"><span class="chip">Any time</span><h3>Review</h3><p>A second opinion on the changes. Problems ranked, and you pick what gets fixed.</p></div>
|
||||
<div class="util"><span class="chip">Any time</span><h3>Handoff</h3><p>Pack the current session into a document a fresh session can pick up cold.</p></div>
|
||||
<div class="util"><span class="chip">Any time</span><h3>Codebase X-ray</h3><p>Explains how and why an area works, or ranks the rough spots worth fixing into a brief for planning.</p></div>
|
||||
<div class="util"><span class="chip">Any time</span><h3>Diagnose a bug</h3><p>Finds a bug's cause and writes it up without fixing it, then hands the fix to Quick task, or to Plan when it is big.</p></div>
|
||||
<div class="util"><span class="chip">Any time</span><h3>Changelog</h3><p>Picks the next version and drafts the entries, which you edit before Git commits them.</p></div>
|
||||
<div class="util"><span class="chip">Any time</span><h3>Git</h3><p>A board for branches, pull, push and commits that opens on the likely next step.</p></div>
|
||||
</div>
|
||||
|
||||
<div class="row" id="git-board">
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/git-dark.webp">
|
||||
<img src="screenshots/git-light.webp" width="2560" height="1600" loading="lazy" alt="The git board on feature/task-endpoints: the Changes tab, badged 3, opens on a Next step card reading Commit 3 files, above the three changed files ticked for the commit. Branches and Sync tabs and a Done with git button sit beside it.">
|
||||
</picture>
|
||||
<div>
|
||||
<h3>The git board</h3>
|
||||
<p>Three tabs, <strong>Changes</strong>, <strong>Branches</strong> and <strong>Sync</strong>, and it opens on the one holding your likely next step: commit, pull, push, publish, open a pull request or tidy up branches. That step is one main button. Each tab badges what is waiting on it, a stopped rebase or merge gets one block with every file marked, and nothing is pushed, published or deleted without asking. It never force-pushes.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer><div class="wrap"><span>Plan2Code v2.0.0</span><span>MIT</span><span>plan2code.jparkerweb.com</span></div></footer>
|
||||
<section class="s" id="features" aria-labelledby="features-title">
|
||||
<div class="wrap">
|
||||
<h2 id="features-title">What the page gives you</h2>
|
||||
<p class="intro muted">The same workflow as the terminal, with more room to think.</p>
|
||||
<div class="feat">
|
||||
<div><h3>Trade-offs in plain view</h3><p>Questions arrive a few at a time, each option with its trade-off written under it, so you choose rather than guess.</p></div>
|
||||
<div><h3>Review before you approve</h3><p>Review the code first, on the sign-off card, reviews exactly the files the phase changed. You tick which findings get fixed, then approve.</p></div>
|
||||
<div><h3>The Ask tab</h3><p>A chat beside the cards for anything you want to know. It is answered at the agent's next check-in and never holds up your answers.</p></div>
|
||||
<div><h3>Attachments on notes</h3><p>Paste a screenshot or attach a document to a note on any question, and show instead of describe.</p></div>
|
||||
<div><h3>A notebook of your own</h3><p>A private pad for each project folder, in Markdown with pictures. It never goes into your project, and the agent never sees it.</p></div>
|
||||
<div><h3>Workspace folders</h3><p>Add a shared library or a design folder as read-only context, and point at it by its <code>@name</code>.</p></div>
|
||||
<div><h3>Session meter</h3><p>A ring in the top bar turns from green to red as a session grows long, and suggests when a fresh one would serve you better.</p></div>
|
||||
<div><h3>Runs on your machine</h3><p>A small program Plan2Code starts for you serves the page on <code>127.0.0.1</code>. No account, no dependencies, and nothing leaves your computer.</p></div>
|
||||
</div>
|
||||
<div class="feat-shots">
|
||||
<figure>
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/ask-dark.webp">
|
||||
<img src="screenshots/ask-light.webp" width="2560" height="1600" loading="lazy" alt="The Ask tab: the question Where are tasks paged? and Plan2Code's answer naming the file.">
|
||||
</picture>
|
||||
<figcaption>The Ask tab, answered between tasks.</figcaption>
|
||||
</figure>
|
||||
<figure>
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/finish-dark.webp">
|
||||
<img src="screenshots/finish-light.webp" width="2560" height="1600" loading="lazy" alt="The finished screen after a phase: what happened, the next command with a Copy button, and a Back to the dashboard button.">
|
||||
</picture>
|
||||
<figcaption>Every ending says what to run next.</figcaption>
|
||||
</figure>
|
||||
<figure style="grid-column:1/-1;max-width:calc(50% - 12px);justify-self:center">
|
||||
<picture class="shot">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="screenshots/notepad-dark.webp">
|
||||
<img src="screenshots/notepad-light.webp" width="2560" height="1600" loading="lazy" alt="The Notebook open over a question: two named tabs, and a heading, bullets and bold styled in place as they are typed.">
|
||||
</picture>
|
||||
<figcaption>Your own notebook, private to the folder.</figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="s alt" id="rules" aria-labelledby="rules-title">
|
||||
<div class="wrap">
|
||||
<h2 id="rules-title">The rules</h2>
|
||||
<p class="intro muted">Four rules do most of the work.</p>
|
||||
<ol class="rules">
|
||||
<li><div><h3>Keep each session short.</h3><p>Chaining a couple of small skills on the dashboard is fine. Start a fresh console session when the session meter turns red, and always before a big planning or build step. The specs on disk carry everything between sessions.</p></div></li>
|
||||
<li><div><h3>No code until the plan hits 90% confidence.</h3><p>Step 1 will not finalize below the threshold. Under it, the agent keeps asking and keeps reading your code, and writes every assumption down where you can argue with it.</p></div></li>
|
||||
<li><div><h3>Checkboxes are the state, not the chat.</h3><p>Progress lives in the spec files. Any agent, any session, resumes cold from them.</p></div></li>
|
||||
<li><div><h3>Approve a phase to close it.</h3><p>On the sign-off card, or by replying <code>approved</code> in the terminal. Nothing advances on a guess about what you meant.</p></div></li>
|
||||
</ol>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="s" id="terminal" aria-labelledby="terminal-title">
|
||||
<div class="wrap term-band">
|
||||
<div>
|
||||
<h2 id="terminal-title">Prefer the terminal?</h2>
|
||||
<p class="muted">Every skill also runs right in the terminal. Each one asks at the start whether you want the page or the terminal; add <code>--web</code> to skip the question and go straight to the page.</p>
|
||||
<p><a href="https://github.com/jparkerweb/plan2code#prefer-the-terminal">See every command in the README</a></p>
|
||||
</div>
|
||||
<pre class="term">/plan2code
|
||||
/plan2code-1-plan --web plan a REST API for tasks</pre>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="s alt close" id="install" aria-labelledby="install-title">
|
||||
<div class="narrow">
|
||||
<h2 id="install-title">Install</h2>
|
||||
<p class="muted">Run it again any time to update.</p>
|
||||
<div class="before" id="before-start-2">
|
||||
<h3>Before you start</h3>
|
||||
<ul>
|
||||
<li><strong>Node.js 18 or newer.</strong> Check with <code>node --version</code>. No Node? Get it from <a href="https://nodejs.org/">nodejs.org</a> (the LTS download), or run <code>winget install OpenJS.NodeJS.LTS</code> on Windows, <code>brew install node</code> on macOS, or use <code>nvm</code> on Linux. Then open a new terminal.</li>
|
||||
<li><strong>Start from your project.</strong> Open your terminal in the project you want to work on (<code>cd</code> into it) before you run anything. Plan2Code works on the folder you start it in.</li>
|
||||
<li><strong>Ways in.</strong> <code>plan2code</code> (Claude Code, Devin or Codex), or type <code>/plan2code</code> in your agent (<code>$plan2code</code> in Codex).</li>
|
||||
<li><strong>No agent yet?</strong> Install Claude Code, Codex or Devin first.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="cmd">
|
||||
<pre><span aria-hidden="true">$ </span>npx --allow-git=all git+https://github.com/jparkerweb/plan2code.git</pre>
|
||||
<button class="copy" type="button" aria-label="Copy the install command">
|
||||
<svg class="clip" viewBox="0 0 24 24" aria-hidden="true"><rect x="9" y="9" width="11" height="12" rx="2"/><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"/></svg>
|
||||
<svg class="tick" viewBox="0 0 24 24" aria-hidden="true"><path d="M4 12.5 9.5 18 20 6.5"/></svg>
|
||||
<span class="label">Copy</span>
|
||||
</button>
|
||||
</div>
|
||||
<p class="then">then, from your project, run <code>plan2code</code> (Claude Code, Devin or Codex), or type <code>/plan2code</code> in your agent (<code>$plan2code</code> in Codex).</p>
|
||||
<p class="then">It always opens a menu; no output at all means npm could not reach the repository and hid the reason: <code>git ls-remote https://github.com/jparkerweb/plan2code.git</code> shows why.</p>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
</main>
|
||||
|
||||
<footer>
|
||||
<div class="wrap">
|
||||
<a href="https://github.com/jparkerweb/plan2code">Plan2Code on GitHub</a>
|
||||
<span>MIT license</span>
|
||||
<a href="https://github.com/jparkerweb/plan2code/releases">Releases</a>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<script>
|
||||
(function () {
|
||||
var CMD = 'npx --allow-git=all git+https://github.com/jparkerweb/plan2code.git';
|
||||
function wire(btn) {
|
||||
var label = btn.querySelector('.label');
|
||||
var timer;
|
||||
function done() {
|
||||
btn.classList.add('-done');
|
||||
label.textContent = 'Copied';
|
||||
clearTimeout(timer);
|
||||
timer = setTimeout(function () {
|
||||
btn.classList.remove('-done');
|
||||
label.textContent = 'Copy';
|
||||
}, 1800);
|
||||
}
|
||||
function fallback() {
|
||||
var ta = document.createElement('textarea');
|
||||
ta.value = CMD;
|
||||
ta.setAttribute('readonly', '');
|
||||
ta.style.position = 'fixed';
|
||||
ta.style.opacity = '0';
|
||||
document.body.appendChild(ta);
|
||||
ta.select();
|
||||
try { document.execCommand('copy'); done(); } catch (e) {}
|
||||
document.body.removeChild(ta);
|
||||
}
|
||||
btn.addEventListener('click', function () {
|
||||
if (navigator.clipboard && navigator.clipboard.writeText) {
|
||||
navigator.clipboard.writeText(CMD).then(done, fallback);
|
||||
} else {
|
||||
fallback();
|
||||
}
|
||||
});
|
||||
}
|
||||
var buttons = document.querySelectorAll('.copy');
|
||||
for (var i = 0; i < buttons.length; i++) wire(buttons[i]);
|
||||
})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
After Width: | Height: | Size: 99 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
After Width: | Height: | Size: 110 KiB |
|
After Width: | Height: | Size: 114 KiB |
|
After Width: | Height: | Size: 89 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 109 KiB |
|
After Width: | Height: | Size: 119 KiB |
|
After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 122 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 103 KiB |
|
After Width: | Height: | Size: 73 KiB |
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 67 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 117 KiB |
|
After Width: | Height: | Size: 96 KiB |
|
After Width: | Height: | Size: 104 KiB |
@@ -1,15 +1,17 @@
|
||||
{
|
||||
"name": "plan2code",
|
||||
"version": "2.1.0",
|
||||
"version": "2.11.0",
|
||||
"private": true,
|
||||
"bin": {
|
||||
"plan2code": "./install.js"
|
||||
"plan2code-install": "./install.js"
|
||||
},
|
||||
"scripts": {
|
||||
"prepare": "husky",
|
||||
"test": "node scripts/validate-char-count.js"
|
||||
"build:skills": "node install.js --build-skills",
|
||||
"test": "node scripts/validate-char-count.js && node install.js --build-skills && node scripts/parse-check.mjs && node scripts/check-skill-table.mjs && node --test scripts/test-script-git.mjs scripts/test-git-repo.mjs scripts/test-skill-scripts.mjs scripts/test-script-changelog.mjs scripts/test-web-console-git.mjs scripts/test-web-console-git-board.mjs scripts/test-web-console-chat.mjs scripts/test-web-console-subagents.mjs scripts/test-web-console-speed.mjs scripts/test-web-console-qa.mjs scripts/test-web-console-concurrency.mjs scripts/test-web-console-workspace.mjs scripts/test-web-console-lifecycle.mjs scripts/test-web-console-chat-stress.mjs scripts/test-web-console-server.mjs scripts/test-web-console-session.mjs scripts/test-web-console-logic.mjs scripts/test-web-console-skills.mjs scripts/test-web-console-spec-states.mjs scripts/test-web-console-state.mjs scripts/test-web-console-shape.mjs scripts/test-script-pathfinder.mjs scripts/test-launcher.mjs scripts/test-web-console-source.mjs scripts/test-web-console-hardening.mjs scripts/test-web-console-handoffs.mjs scripts/test-web-console-notepad.mjs scripts/test-script-xray.mjs scripts/test-script-finalize.mjs scripts/test-getting-started.mjs scripts/test-install-update.mjs scripts/test-browser-helper.mjs scripts/test-web-console-page-cards.mjs scripts/test-web-console-page-dashboard.mjs scripts/test-web-console-page-session.mjs scripts/test-web-console-page-ask.mjs scripts/test-web-console-page-workspace.mjs scripts/test-web-console-page-help.mjs scripts/test-web-console-page-prefs.mjs scripts/test-web-console-page-git.mjs scripts/test-web-console-page-notepad.mjs"
|
||||
},
|
||||
"devDependencies": {
|
||||
"husky": "^9.0.0"
|
||||
"husky": "^9.0.0",
|
||||
"playwright-core": "1.64.1"
|
||||
}
|
||||
}
|
||||
@@ -13,7 +13,7 @@ From the plan2code root:
|
||||
|
||||
```bash
|
||||
node install.js
|
||||
# Select C > B to install bot only, or I to install everything
|
||||
# Select A > B to install the bot only, or A > E to install everything
|
||||
```
|
||||
|
||||
Or manually:
|
||||
|
||||
@@ -10,10 +10,10 @@ An autonomous CLI tool that implements Plan2Code specs by looping through tasks
|
||||
# From the plan2code root directory:
|
||||
|
||||
# Option 1: Install everything (recommended)
|
||||
node install.js # Select option A
|
||||
node install.js # Select A (Advanced) → E (Everything)
|
||||
|
||||
# Option 2: Install loop only
|
||||
node install.js # Select option O
|
||||
node install.js # Select A (Advanced) → O (Loop CLI)
|
||||
|
||||
# Option 3: Manual build and link
|
||||
cd plan2code-loop
|
||||
|
||||
@@ -6,25 +6,25 @@ export const MASCOT = {
|
||||
// Full mascot for headers
|
||||
full: [
|
||||
' ╭───╮ ',
|
||||
' │ ● │ ',
|
||||
' ╱│ ★ │╲ ',
|
||||
' │ ◡ │ ',
|
||||
' ╰───╯ ',
|
||||
' ╰┬─┬╯ ',
|
||||
],
|
||||
// Mini mascot for inline use
|
||||
mini: '(◉‿◉)',
|
||||
mini: '╱[★]╲',
|
||||
// Waving mascot for greetings
|
||||
wave: [
|
||||
' ╭───╮ ',
|
||||
' │ ● │ ',
|
||||
' │ ◡ │ ',
|
||||
' ╰───╯ ',
|
||||
' │ ★ │╱ ',
|
||||
' ╱│ ◡ │ ',
|
||||
' ╰┬─┬╯ ',
|
||||
],
|
||||
// Celebration mascot for completion
|
||||
celebrate: [
|
||||
' ╭───╮ ',
|
||||
' │ ★ │ ',
|
||||
' ╲│ ★ │╱ ',
|
||||
' │ ◡ │ ',
|
||||
' ╰───╯ ',
|
||||
' ╰┬─┬╯ ',
|
||||
],
|
||||
};
|
||||
|
||||
@@ -117,7 +117,7 @@ export const logger = {
|
||||
console.log(chalk.green.bold('═'.repeat(50)));
|
||||
console.log();
|
||||
console.log(chalk.cyan.bold('Next Step:'));
|
||||
console.log(chalk.white(' Return to your AI Agent and run the'), chalk.yellow.bold('/plan2code-4-finalize'), chalk.white('step.'));
|
||||
console.log(chalk.white(' Return to your AI Agent and run the'), chalk.yellow.bold('/plan2code-4-finalize --web'), chalk.white('step.'));
|
||||
console.log(chalk.dim(' This will ensure quality, completeness, and proper documentation.'));
|
||||
console.log();
|
||||
},
|
||||
|
||||
@@ -6,8 +6,8 @@ Recursive self-improvement toolchain for plan2code contributors. Collects metric
|
||||
|
||||
```bash
|
||||
# Install (one-time, from the plan2code root)
|
||||
node install.js # → "A" (Install All + dev tools) includes metrics
|
||||
# → or "M" (Metrics only) under the CUSTOM sub-menu
|
||||
node install.js # → "A" then "E" (Everything) includes metrics
|
||||
# → or "M" (Metrics only) under the ADVANCED sub-menu
|
||||
|
||||
# After finishing any project spec (steps 1-4):
|
||||
cd your-project
|
||||
@@ -226,7 +226,7 @@ Output: `.plan2code-metrics/proposals/<timestamp>-diagnosis.md`
|
||||
Sends the diagnosis plus current prompt file contents to an AI model. The AI proposes surgical `old_text -> new_text` edits, each validated against:
|
||||
|
||||
- The `old_text` actually exists in the target file
|
||||
- The edited file stays under the 11,000 character limit
|
||||
- The edited file stays under the 20,000 character limit
|
||||
|
||||
Output: `.plan2code-metrics/proposals/prop-<timestamp>.json`
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ import chalk from 'chalk';
|
||||
import type { PromptEdit, PromptProposal } from './types.js';
|
||||
import { validateEdit } from './improver.js';
|
||||
|
||||
const CHAR_LIMIT = 11_000;
|
||||
const CHAR_LIMIT = 20_000;
|
||||
|
||||
// ── Diff display ──────────────────────────────────────────────────────────────
|
||||
|
||||
|
||||
@@ -69,12 +69,12 @@ describe('validateEdit', () => {
|
||||
expect(result.warnings.some(w => /appears.*times/i.test(w))).toBe(true);
|
||||
});
|
||||
|
||||
it('errors when edit would exceed 11,000 char limit', () => {
|
||||
const bigText = 'x'.repeat(12_000);
|
||||
it('errors when edit would exceed 20,000 char limit', () => {
|
||||
const bigText = 'x'.repeat(21_000);
|
||||
const edit = makeEdit({ new_text: bigText });
|
||||
const result = validateEdit(edit, PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors.some(e => /exceed.*11.?000/i.test(e))).toBe(true);
|
||||
expect(result.errors.some(e => /exceed.*20.?000/i.test(e))).toBe(true);
|
||||
});
|
||||
|
||||
it('warns when reported char counts diverge from actual (>10 chars off)', () => {
|
||||
|
||||
@@ -9,7 +9,7 @@ import path from 'path';
|
||||
import type { PromptEdit, PromptProposal } from './types.js';
|
||||
import { invokeLLM, type AgentType } from './invoke-llm.js';
|
||||
|
||||
const CHAR_LIMIT = 11_000;
|
||||
const CHAR_LIMIT = 20_000;
|
||||
const IMPROVE_PROMPT_PATH = new URL('../src/prompts/improve.md', import.meta.url).pathname
|
||||
.replace(/^\/([A-Za-z]:)/, '$1'); // Fix Windows path
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ The following diagnosis was produced by the analysis step:
|
||||
|
||||
## Hard Constraints — ALL must be satisfied:
|
||||
|
||||
1. **Char limit:** Each target file MUST stay under 11,000 characters after your edit is applied. This is enforced by code — edits that violate it will be automatically rejected.
|
||||
1. **Char limit:** Each target file MUST stay under 20,000 characters after your edit is applied. This is enforced by code — edits that violate it will be automatically rejected.
|
||||
2. **Maximum 5 edits per cycle.** Focus on the highest-impact changes only.
|
||||
3. **Each edit must cite a specific metric** in its `expected_metric_impact` field (e.g., "avg_task_completion_rate", "avg_blocker_count").
|
||||
4. **`old_text` must be verbatim** from the file. Copy-paste exactly — include surrounding whitespace/newlines as they appear. Edits with mismatched old_text will be automatically rejected.
|
||||
@@ -85,7 +85,7 @@ Set `char_count_before`, `char_count_after`, and `char_count_delta` to your best
|
||||
|
||||
A table with columns: File | Before | Projected After | Delta | Limit | Status (✓/✗)
|
||||
|
||||
Verify that NO file exceeds 11,000 characters after your proposed edits.
|
||||
Verify that NO file exceeds 20,000 characters after your proposed edits.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,314 @@
|
||||
#!/usr/bin/env node
|
||||
// Start-up benchmark for the web console. Dev-only: lives in scripts/ so it
|
||||
// never ships inside a skill.
|
||||
//
|
||||
// node scripts/bench-web-console.mjs [--runs 7] [--workflow dashboard]
|
||||
// [--browser <path> | --browser none] [--cwd <repo>] [--json <out.json>]
|
||||
//
|
||||
// Every run starts from nothing, the way a person's first `/plan2code` does:
|
||||
// no server, a fresh browser context (each session gets a new port, so a new
|
||||
// origin, so the HTTP cache is always cold). It measures, from the moment the
|
||||
// agent runs `console.mjs open`:
|
||||
//
|
||||
// url the CLI has printed the link (what the agent hands over)
|
||||
// cliExit the CLI process has exited (when the agent's next step can start)
|
||||
// response the browser has the page's HTML
|
||||
// fcp first contentful paint: the person sees something
|
||||
// ready the session is drawn from real state (the menu, or a question)
|
||||
//
|
||||
// plus the bytes and request count the page cost. The browser columns need
|
||||
// playwright-core (from `npm install`) and a local Chrome or Edge, picked by
|
||||
// scripts/browser.mjs; without a browser it still reports url/cliExit and an
|
||||
// HTTP-only waterfall.
|
||||
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawn, spawnSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { findBrowser, launchBrowser } from "./browser.mjs";
|
||||
|
||||
const ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
|
||||
const CONSOLE_CLI = path.join(ROOT, "src", "web-console", "console.mjs");
|
||||
|
||||
const args = {};
|
||||
for (let i = 2; i < process.argv.length; i++) {
|
||||
const a = process.argv[i];
|
||||
if (a.startsWith("--")) args[a.slice(2)] = process.argv[i + 1] && !process.argv[i + 1].startsWith("--") ? process.argv[++i] : true;
|
||||
}
|
||||
const RUNS = Number(args.runs || 7);
|
||||
const WORKFLOW = args.workflow || "dashboard";
|
||||
const CWD = path.resolve(args.cwd || ROOT);
|
||||
|
||||
const HOME = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-bench-"));
|
||||
const ENV = { ...process.env, PLAN2CODE_CONSOLE_HOME: HOME, PLAN2CODE_NO_BROWSER: "1" };
|
||||
// A fresh cached failure: the boot-time release check stays off the network,
|
||||
// so a slow GitHub never colours the timings.
|
||||
fs.writeFileSync(path.join(HOME, "update-check.json"), JSON.stringify({ checkedAt: Date.now(), latest: null }));
|
||||
|
||||
// Resolves at the first stdout line carrying a url, and again at exit.
|
||||
// --launch hook (default): `open` launches "the browser" the way it would for
|
||||
// a person, through PLAN2CODE_BROWSER, and the hook just writes the link to
|
||||
// a file; the bench points its ready-made tab there the instant it appears.
|
||||
// That measures everything but the real browser's own start-up, which is
|
||||
// about 900ms on Windows and runs alongside the rest.
|
||||
// --launch url: navigate only once `open` prints the link. For comparing
|
||||
// against versions of console.mjs that predate the hook.
|
||||
const LAUNCH = args.launch || "hook";
|
||||
// --browser-delay <ms>: how long "the browser" takes to show up after it is
|
||||
// asked. 0 is a browser that is instant; ~900 is Chrome on Windows through
|
||||
// `start`, measured on this machine, and is what a person actually waits.
|
||||
const BROWSER_DELAY = Number(args["browser-delay"] || 0);
|
||||
const OPEN_LOG = path.join(HOME, "opened.txt");
|
||||
|
||||
function runOpen() {
|
||||
fs.rmSync(OPEN_LOG, { force: true });
|
||||
const hook = LAUNCH === "hook";
|
||||
const env = hook
|
||||
? { ...ENV, PLAN2CODE_NO_BROWSER: "", PLAN2CODE_BROWSER: `echo>>"${OPEN_LOG}"` }
|
||||
: ENV;
|
||||
const t0 = Date.now();
|
||||
const child = spawn(
|
||||
process.execPath,
|
||||
[CONSOLE_CLI, "open", "--workflow", WORKFLOW, "--title", "Bench", ...(hook ? [] : ["--no-open"])],
|
||||
{ cwd: CWD, env, stdio: ["ignore", "pipe", "pipe"] }
|
||||
);
|
||||
let out = "";
|
||||
let err = "";
|
||||
let urlResolve;
|
||||
const urlP = new Promise((r) => (urlResolve = r));
|
||||
child.stdout.on("data", (c) => {
|
||||
out += c;
|
||||
const m = out.match(/"url":"([^"]+)"/);
|
||||
if (m) urlResolve({ url: m[1], at: Date.now() });
|
||||
});
|
||||
child.stderr.on("data", (c) => (err += c));
|
||||
const exitP = new Promise((r) =>
|
||||
child.on("exit", (code) => {
|
||||
urlResolve({ url: null, at: Date.now() });
|
||||
r({ code, at: Date.now(), out, err });
|
||||
})
|
||||
);
|
||||
// The moment "the browser" was asked to open, and with what.
|
||||
const openP = hook
|
||||
? new Promise((resolve) => {
|
||||
const poll = setInterval(() => {
|
||||
let text = "";
|
||||
try {
|
||||
text = fs.readFileSync(OPEN_LOG, "utf8");
|
||||
} catch {}
|
||||
const m = text.match(/http:\/\/127\.0\.0\.1:\d+\/s\/[\w-]+\//);
|
||||
if (m) {
|
||||
clearInterval(poll);
|
||||
resolve({ url: m[0], at: Date.now() });
|
||||
}
|
||||
}, 2);
|
||||
exitP.then(() => setTimeout(() => (clearInterval(poll), resolve({ url: null, at: Date.now() })), 500));
|
||||
})
|
||||
: urlP;
|
||||
return { t0, urlP, exitP, openP };
|
||||
}
|
||||
|
||||
function stopAll() {
|
||||
spawnSync(process.execPath, [CONSOLE_CLI, "stop", "--all"], { cwd: CWD, env: ENV });
|
||||
}
|
||||
|
||||
async function httpWaterfall(url) {
|
||||
// What the page costs without a browser: the redirect, the HTML, every
|
||||
// asset it names, then the modules those import. Sequential levels, like a
|
||||
// browser without preload hints would discover them.
|
||||
const t = Date.now();
|
||||
const r1 = await fetch(url, { redirect: "manual" });
|
||||
const cookie = (r1.headers.get("set-cookie") || "").split(";")[0];
|
||||
const base = new URL(url).origin;
|
||||
const get = async (p) => {
|
||||
const res = await fetch(base + p, { headers: { cookie } });
|
||||
const body = Buffer.from(await res.arrayBuffer());
|
||||
return { p, status: res.status, bytes: body.length, text: body.toString("utf8") };
|
||||
};
|
||||
const html = await get("/");
|
||||
let bytes = html.bytes;
|
||||
let requests = 2;
|
||||
const seen = new Set();
|
||||
let level = [...html.text.matchAll(/(?:href|src)="(\/[^"#]+\.(?:css|js))"/g)].map((m) => m[1]);
|
||||
let levels = 1;
|
||||
while (level.length) {
|
||||
const fresh = level.filter((p) => !seen.has(p));
|
||||
fresh.forEach((p) => seen.add(p));
|
||||
if (!fresh.length) break;
|
||||
const got = await Promise.all(fresh.map(get));
|
||||
requests += got.length;
|
||||
bytes += got.reduce((n, g) => n + g.bytes, 0);
|
||||
level = got
|
||||
.filter((g) => g.p.endsWith(".js"))
|
||||
.flatMap((g) => [...g.text.matchAll(/from\s+"\.\/([^"]+)"/g)].map((m) => "/" + path.posix.join(path.posix.dirname(g.p.slice(1)), m[1])));
|
||||
levels++;
|
||||
}
|
||||
return { ms: Date.now() - t, bytes, requests, levels };
|
||||
}
|
||||
|
||||
// --roundtrip: the two hops of a live session, rather than the start.
|
||||
// send the person presses Send -> the agent's `wait` returns the answers
|
||||
// post the agent runs `post` -> the page's stream delivers the new state
|
||||
async function roundtrip() {
|
||||
const payload = path.join(HOME, "rt.json");
|
||||
const item = { id: "q1", kind: "text", title: "Anything", body: "Say something." };
|
||||
fs.writeFileSync(payload, JSON.stringify({ workflow: "pathfinder", items: [item], agent: { status: "waiting" } }));
|
||||
const out = spawnSync(process.execPath, [CONSOLE_CLI, "open", "--file", payload, "--no-open"], { cwd: CWD, env: ENV, encoding: "utf8" });
|
||||
const opened = JSON.parse(out.stdout.trim().split("\n").pop());
|
||||
const [, base, token] = opened.url.match(/^(http:\/\/127\.0\.0\.1:\d+)\/s\/([^/]+)\//);
|
||||
const headers = { cookie: `p2c_console_${new URL(base).port}=${token}`, "content-type": "application/json" };
|
||||
const sends = [];
|
||||
const posts = [];
|
||||
for (let i = -1; i < RUNS; i++) {
|
||||
// send: a waiter already sitting in its slice, then the press.
|
||||
const waiter = spawn(process.execPath, [CONSOLE_CLI, "wait", "--session", opened.sid, "--seconds", "30"], { cwd: CWD, env: ENV });
|
||||
const done = new Promise((r) => waiter.on("exit", () => r(Date.now())));
|
||||
await new Promise((r) => setTimeout(r, 700));
|
||||
const t = Date.now();
|
||||
await fetch(base + "/submit", { method: "POST", headers, body: JSON.stringify({ actions: [{ i: "q1", type: "answer", kind: "text", text: "x" + i }], reply: "x" }) });
|
||||
const sendMs = (await done) - t;
|
||||
|
||||
// post: a page listening on the stream, then the agent's update.
|
||||
const ctrl = new AbortController();
|
||||
const res = await fetch(base + "/events", { headers, signal: ctrl.signal });
|
||||
const reader = res.body.getReader();
|
||||
const dec = new TextDecoder();
|
||||
await reader.read();
|
||||
const patch = path.join(HOME, "rt-patch.json");
|
||||
fs.writeFileSync(patch, JSON.stringify({ items: [{ id: "q1", status: "open", body: "Again " + i }], agent: { status: "waiting" } }));
|
||||
const tp = Date.now();
|
||||
spawnSync(process.execPath, [CONSOLE_CLI, "post", "--session", opened.sid, "--file", patch], { cwd: CWD, env: ENV });
|
||||
const postCli = Date.now() - tp;
|
||||
let buf = "";
|
||||
while (!buf.includes("Again " + i)) buf += dec.decode((await reader.read()).value);
|
||||
const postMs = Date.now() - tp;
|
||||
ctrl.abort();
|
||||
if (i >= 0) {
|
||||
sends.push(sendMs);
|
||||
posts.push({ total: postMs, cli: postCli });
|
||||
}
|
||||
}
|
||||
spawnSync(process.execPath, [CONSOLE_CLI, "stop", "--all"], { cwd: CWD, env: ENV });
|
||||
const med = (v) => v.sort((a, b) => a - b)[Math.floor(v.length / 2)];
|
||||
console.log(`web console round trips, ${RUNS} runs`);
|
||||
console.log(`send -> wait returns median ${med(sends)} ms (min ${Math.min(...sends)}, max ${Math.max(...sends)})`);
|
||||
console.log(`post -> page has it median ${med(posts.map((p) => p.total))} ms (of which the post CLI ${med(posts.map((p) => p.cli))} ms)`);
|
||||
fs.rmSync(HOME, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
async function main() {
|
||||
if (args.roundtrip) return roundtrip();
|
||||
// --browser none: no launch at all. --browser <path>: that executable.
|
||||
// Otherwise the helper's pick; a browser problem is one line, then the
|
||||
// HTTP-only waterfall.
|
||||
let browser = null;
|
||||
let browserName = null;
|
||||
if (args.browser !== "none") {
|
||||
const custom = typeof args.browser === "string" ? args.browser : null;
|
||||
try {
|
||||
browser = await launchBrowser(custom ? { executablePath: custom } : {});
|
||||
const found = custom ? null : findBrowser();
|
||||
browserName = found ? `${found.channel} (${found.path})` : custom;
|
||||
} catch (e) {
|
||||
if (!e.browserProblem) throw e;
|
||||
console.error(e.message);
|
||||
}
|
||||
}
|
||||
|
||||
const rows = [];
|
||||
// One throwaway run so disk caches and the Node binary are warm; the person
|
||||
// running this has run node before too.
|
||||
for (let i = -1; i < RUNS; i++) {
|
||||
stopAll();
|
||||
// The tab exists before the clock starts: a person's browser is already
|
||||
// running, and creating a context is the harness's cost, not the page's.
|
||||
const ctx = browser ? await browser.newContext() : null;
|
||||
const page = ctx ? await ctx.newPage() : null;
|
||||
const { t0, urlP, exitP, openP } = runOpen();
|
||||
const o = await openP;
|
||||
if (!o.url) {
|
||||
const e = await exitP;
|
||||
throw new Error(`open failed (${e.code}): ${e.err}`);
|
||||
}
|
||||
const row = { open: o.at - t0 };
|
||||
if (browser) {
|
||||
let bytes = 0;
|
||||
let requests = 0;
|
||||
page.on("response", async (res) => {
|
||||
requests++;
|
||||
try {
|
||||
bytes += (await res.body()).length;
|
||||
} catch {}
|
||||
});
|
||||
if (BROWSER_DELAY) await new Promise((r) => setTimeout(r, Math.max(0, o.at + BROWSER_DELAY - Date.now())));
|
||||
await page.goto(o.url, { waitUntil: "domcontentloaded" });
|
||||
const timing = await page.evaluate(async () => {
|
||||
// "ready" = drawn from real state: a dashboard card, a question card,
|
||||
// the starting screen or the waiting pane a real state produces.
|
||||
const readySel = ".dash-card, .card.question, .waiting-pane, .launching.starting, .handoff";
|
||||
await new Promise((resolve) => {
|
||||
const check = () => (document.querySelector(readySel) ? resolve() : requestAnimationFrame(check));
|
||||
check();
|
||||
});
|
||||
const readyAt = performance.timeOrigin + performance.now();
|
||||
// The real screen can be drawn before the first paint happens at all,
|
||||
// so wait for the paint rather than reading an entry not yet made.
|
||||
const fcp = await new Promise((resolve) => {
|
||||
const got = () => performance.getEntriesByName("first-contentful-paint")[0];
|
||||
if (got()) return resolve(got());
|
||||
new PerformanceObserver(() => got() && resolve(got())).observe({ type: "paint", buffered: true });
|
||||
setTimeout(() => resolve(got() || null), 3000);
|
||||
});
|
||||
const nav = performance.getEntriesByType("navigation")[0];
|
||||
return {
|
||||
origin: performance.timeOrigin,
|
||||
fcp: fcp ? performance.timeOrigin + fcp.startTime : null,
|
||||
response: nav ? performance.timeOrigin + nav.responseEnd : null,
|
||||
ready: readyAt,
|
||||
};
|
||||
});
|
||||
// The origin here is the redirected document, so the 302 is inside
|
||||
// `response`, not before it.
|
||||
row.response = Math.round(timing.response - t0);
|
||||
row.fcp = timing.fcp ? Math.round(timing.fcp - t0) : null;
|
||||
row.ready = Math.round(timing.ready - t0);
|
||||
await new Promise((r) => setTimeout(r, 150));
|
||||
row.requests = requests;
|
||||
row.kb = Math.round(bytes / 1024);
|
||||
await ctx.close();
|
||||
}
|
||||
const e = await exitP;
|
||||
row.url = (await urlP).at - t0;
|
||||
row.cliExit = e.at - t0;
|
||||
if (!browser) Object.assign(row, await httpWaterfall(o.url));
|
||||
if (i >= 0) rows.push(row);
|
||||
}
|
||||
stopAll();
|
||||
if (browser) await browser.close();
|
||||
|
||||
const cols = Object.keys(rows[0]);
|
||||
const stat = (k) => {
|
||||
const v = rows.map((r) => r[k]).filter((x) => typeof x === "number").sort((a, b) => a - b);
|
||||
if (!v.length) return null;
|
||||
return { median: v[Math.floor(v.length / 2)], min: v[0], max: v[v.length - 1] };
|
||||
};
|
||||
const summary = Object.fromEntries(cols.map((k) => [k, stat(k)]));
|
||||
console.log(`web console start-up, ${RUNS} runs, workflow=${WORKFLOW}, cwd=${CWD}`);
|
||||
console.log(`browser: ${browser ? browserName : "none (HTTP-only waterfall)"}`);
|
||||
console.log("metric".padEnd(10) + "median".padStart(9) + "min".padStart(9) + "max".padStart(9));
|
||||
for (const k of cols) {
|
||||
const s = summary[k];
|
||||
if (!s) continue;
|
||||
const unit = k === "kb" ? " KB" : k === "requests" || k === "levels" ? "" : " ms";
|
||||
console.log(k.padEnd(10) + `${s.median}${unit}`.padStart(9) + `${s.min}`.padStart(9) + `${s.max}`.padStart(9));
|
||||
}
|
||||
if (args.json) fs.writeFileSync(path.resolve(args.json), JSON.stringify({ runs: rows, summary }, null, 2));
|
||||
fs.rmSync(HOME, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
main().catch((e) => {
|
||||
stopAll();
|
||||
console.error(e);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -0,0 +1,91 @@
|
||||
// Picks and launches the browser for page tests and the dev scripts. Dev-only:
|
||||
// lives in scripts/ so it never ships inside a skill.
|
||||
//
|
||||
// The first installed of Chrome then Edge, through playwright-core (a root
|
||||
// devDependency); PLAN2CODE_TEST_BROWSER=chrome or msedge forces one. Every
|
||||
// failure is one line in our own words, never Playwright's install hint.
|
||||
|
||||
import fs from "node:fs";
|
||||
|
||||
// The fixed places each browser installs to, probed in order on every
|
||||
// platform (a path that cannot exist here is simply not found).
|
||||
export const BROWSER_PATHS = {
|
||||
chrome: [
|
||||
"C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe",
|
||||
"C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe",
|
||||
"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
|
||||
"/usr/bin/google-chrome",
|
||||
"/usr/bin/google-chrome-stable",
|
||||
"/usr/bin/chromium",
|
||||
"/usr/bin/chromium-browser",
|
||||
],
|
||||
msedge: [
|
||||
"C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe",
|
||||
"C:\\Program Files\\Microsoft\\Edge\\Application\\msedge.exe",
|
||||
"/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge",
|
||||
"/usr/bin/microsoft-edge",
|
||||
"/usr/bin/microsoft-edge-stable",
|
||||
],
|
||||
};
|
||||
|
||||
const CHANNELS = Object.keys(BROWSER_PATHS);
|
||||
|
||||
// Returns { channel, path } for the first browser found, or null. Either way
|
||||
// findBrowser.checked lists every path this call looked at.
|
||||
export function findBrowser({ env = process.env, exists = fs.existsSync } = {}) {
|
||||
const forced = env.PLAN2CODE_TEST_BROWSER;
|
||||
if (forced && !CHANNELS.includes(forced)) {
|
||||
throw new Error(`PLAN2CODE_TEST_BROWSER must be ${CHANNELS.join(" or ")} (it is "${forced}").`);
|
||||
}
|
||||
findBrowser.checked = [];
|
||||
for (const channel of forced ? [forced] : CHANNELS) {
|
||||
for (const p of BROWSER_PATHS[channel]) {
|
||||
findBrowser.checked.push(p);
|
||||
if (exists(p)) return { channel, path: p };
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
findBrowser.checked = [];
|
||||
|
||||
// null when page tests can run here, otherwise the one line that says why
|
||||
// not. `checked` defaults to the paths the last findBrowser() call probed.
|
||||
export function browserProblem({ nodeVersion = process.versions.node, found, checked = findBrowser.checked } = {}) {
|
||||
if (Number(nodeVersion.split(".")[0]) < 20) {
|
||||
return `Page tests need Node 20 or newer (this is ${nodeVersion}). Users of Plan2Code still only need Node 18.`;
|
||||
}
|
||||
if (!found) {
|
||||
return `Page tests need Chrome or Edge. Looked in: ${checked.join(", ")}. Install either one, or set PLAN2CODE_TEST_BROWSER.`;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// Launches the browser findBrowser() picks, headless. `options` go to
|
||||
// Playwright's chromium.launch() as they are (an `executablePath` there skips
|
||||
// the pick); `find` hands findBrowser() its env and exists, for tests. A
|
||||
// problem rejects with an Error whose message is our one line and whose
|
||||
// `browserProblem` is true, never Playwright's own launch text.
|
||||
export async function launchBrowser(options = {}, find = {}) {
|
||||
const found = options.executablePath ? { channel: null, path: options.executablePath } : findBrowser(find);
|
||||
const problem = browserProblem({ found });
|
||||
if (problem) throw Object.assign(new Error(problem), { browserProblem: true });
|
||||
let chromium;
|
||||
try {
|
||||
({ chromium } = await import("playwright-core"));
|
||||
} catch (e) {
|
||||
throw Object.assign(new Error("Page tests need playwright-core: run npm install.", { cause: e }), { browserProblem: true });
|
||||
}
|
||||
try {
|
||||
return await chromium.launch({
|
||||
executablePath: found.path,
|
||||
headless: true,
|
||||
args: ["--no-first-run", "--no-default-browser-check"],
|
||||
...options,
|
||||
});
|
||||
} catch (e) {
|
||||
// Playwright's own text stays out of the message, but is kept as the
|
||||
// cause for whoever needs to debug a real launch failure.
|
||||
const line = `Page tests could not start the browser at ${found.path}. Install Chrome or Edge, or set PLAN2CODE_TEST_BROWSER.`;
|
||||
throw Object.assign(new Error(line, { cause: e }), { browserProblem: true });
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,613 @@
|
||||
#!/usr/bin/env node
|
||||
// Screenshots of the web console for the docs. Dev-only: lives in scripts/ so
|
||||
// it never ships inside a skill.
|
||||
//
|
||||
// node scripts/capture-screenshots.mjs [--only <shot>] [--browser <path>]
|
||||
// [--out <dir>] [--compare]
|
||||
//
|
||||
// Every shot is staged with no agent: a throwaway sample project called
|
||||
// `task-api`, a throwaway console home (PLAN2CODE_CONSOLE_HOME), then
|
||||
// `console.mjs open` and `post` with the payloads in scripts/screenshots/.
|
||||
// Each screen is saved light and dark, at 1280x800 and twice the pixel
|
||||
// density, as `<out>/<shot>-light.webp` and `<out>/<shot>-dark.webp`.
|
||||
// The shots use the console's Ocean highlight rather than its default orange:
|
||||
// it is the console's nearest to the Plan2Code blue the site and README use.
|
||||
//
|
||||
// Shots: dashboard, dashboard-utilities, question, doc, build, signoff, finish, ask, git.
|
||||
// --compare adds workspace, stop, delete, help, prefs and cleanup: screens the
|
||||
// docs never show, for checking a change by eye against a "before" set. Its
|
||||
// --out must be outside docs/screenshots/, so the set is never published.
|
||||
//
|
||||
// --snapshot <file> (used by scripts/css-snapshot.mjs) takes no pictures: it
|
||||
// writes every element's computed style, per screen, theme and width, to <file>.
|
||||
// It sees what these shots stage: choice, multi, text, review and confirm cards;
|
||||
// a checklist, list, recap or menu card is not staged, so a rule only they use
|
||||
// is not covered.
|
||||
//
|
||||
// Needs playwright-core (a root devDependency, so `npm install` brings it) and
|
||||
// a local Chrome or Edge, launched through scripts/browser.mjs. Playwright has
|
||||
// no WebP screenshots, so each shot is taken over CDP. Writes nothing outside
|
||||
// its temp folders and --out.
|
||||
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { launchBrowser } from "./browser.mjs";
|
||||
|
||||
const ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
|
||||
const CONSOLE_CLI = path.join(ROOT, "src", "web-console", "console.mjs");
|
||||
const PAYLOADS = path.join(ROOT, "scripts", "screenshots");
|
||||
|
||||
const args = {};
|
||||
for (let i = 2; i < process.argv.length; i++) {
|
||||
const a = process.argv[i];
|
||||
if (a.startsWith("--")) args[a.slice(2)] = process.argv[i + 1] && !process.argv[i + 1].startsWith("--") ? process.argv[++i] : true;
|
||||
}
|
||||
const OUT = path.resolve(args.out || path.join(ROOT, "docs", "screenshots"));
|
||||
const QUALITY = 85;
|
||||
const WARN_KB = 300;
|
||||
const THEMES = ["light", "dark"];
|
||||
|
||||
// Which workflow each shot opens under, which payloads it posts in order,
|
||||
// which tab it is captured on (by the tab's label; none means the first tab),
|
||||
// and where to scroll first: `scrollTo` is put at the top of the view and
|
||||
// `mustShow` has to end up wholly inside it (none means the top).
|
||||
const SHOTS = {
|
||||
// The suggested card sits below the fold at 1280x800, and it is the point of
|
||||
// the shot. Starting at the "Hide unavailable" switch keeps the spec picker's
|
||||
// cut out of frame and the card in it.
|
||||
dashboard: {
|
||||
workflow: "dashboard",
|
||||
posts: ["dashboard"],
|
||||
scrollTo: ".dash-toggle",
|
||||
mustShow: ".dash-card:has(.pill.suggested)",
|
||||
},
|
||||
// The utility cards sit even lower: scroll until the Git card is the
|
||||
// last row in frame ("cmd:" picks a card by its command).
|
||||
"dashboard-utilities": {
|
||||
workflow: "dashboard",
|
||||
posts: ["dashboard"],
|
||||
scrollTo: "cmd:/plan2code-git",
|
||||
mustShow: "cmd:/plan2code-git",
|
||||
},
|
||||
question: { workflow: "plan", posts: ["question"] },
|
||||
doc: { workflow: "plan", posts: ["doc"], tab: "What we've agreed" },
|
||||
build: { workflow: "implement", posts: ["build"], tab: "Phase 3 tasks" },
|
||||
signoff: { workflow: "implement", posts: ["signoff"] },
|
||||
finish: { workflow: "implement", posts: ["signoff", "finish"] },
|
||||
ask: { workflow: "plan", posts: ["question"], ask: "Where are tasks paged?" },
|
||||
// The git board draws itself from a real repository, so this shot runs in
|
||||
// its own git sample project; the post only hands the board back to you.
|
||||
git: { workflow: "git", posts: ["git"], repo: true },
|
||||
// The Notebook dialog over the plan question, with two named tabs: Call notes
|
||||
// (a heading, bullets and bold, shown live) and Ideas, with the first one
|
||||
// open. The store is the scratch folder's, never the real one.
|
||||
notepad: {
|
||||
workflow: "plan",
|
||||
posts: ["question"],
|
||||
open: async (page) => {
|
||||
await page.click("#btn-notepad");
|
||||
await page.waitForSelector("#notepad-modal[open]", { timeout: 10000 });
|
||||
const editor = page.locator("#notepad-editor .cm-content");
|
||||
const newTab = async (name) => {
|
||||
await page.click((await page.locator("#notepad-empty").isVisible()) ? "#notepad-empty-new" : "#notepad-tab-new");
|
||||
await page.fill("#notepad-name", name);
|
||||
await page.keyboard.press("Enter");
|
||||
await page.waitForFunction(
|
||||
(n) => [...document.querySelectorAll("#notepad-tabs .notepad-tab")].some((b) => b.textContent === n && b.getAttribute("aria-selected") === "true"),
|
||||
name,
|
||||
{ timeout: 10000 },
|
||||
);
|
||||
await editor.click();
|
||||
};
|
||||
// The second theme's run finds the first one's tabs, kept in the same store.
|
||||
await page.waitForFunction(
|
||||
() => document.querySelector("#notepad-tabs .notepad-tab") || !document.getElementById("notepad-empty").hidden,
|
||||
null,
|
||||
{ timeout: 10000 },
|
||||
);
|
||||
if (!(await page.locator("#notepad-tabs .notepad-tab").count())) {
|
||||
// The list marker is typed once: the editor carries a list on at Enter.
|
||||
await newTab("Call notes");
|
||||
await page.keyboard.type(
|
||||
"# Before the call\n\n- Ask about **paging**: cursor or offset?\nWho signs in to the API?\nCheck the `/tasks` limit with the team\n\n"
|
||||
);
|
||||
await newTab("Ideas");
|
||||
await page.keyboard.type("Retry policy for the export job.\nWhat should the page size cap be?");
|
||||
}
|
||||
await sleep(1000);
|
||||
await page.locator("#notepad-tabs .notepad-tab", { hasText: /^Call notes$/ }).click();
|
||||
await page.locator("#notepad-editor .cm-h1").waitFor({ timeout: 10000 });
|
||||
await page.locator("#notepad-editor .cm-line").last().click();
|
||||
await sleep(1800);
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// --compare only: the screens the docs never show, shot so a change to the
|
||||
// console can be checked against a "before" set by eye. `open` runs on the
|
||||
// page after every load and clicks through to the screen. Never published.
|
||||
const COMPARE_SHOTS = {
|
||||
// The confirm dialog, with the handoff choice beside plain stop.
|
||||
stop: {
|
||||
workflow: "implement",
|
||||
posts: ["stop"],
|
||||
open: async (page) => {
|
||||
await page.click("#btn-stop");
|
||||
await page.waitForSelector("#stop-modal[open]", { timeout: 10000 });
|
||||
},
|
||||
},
|
||||
// The first step of a spec chip's delete.
|
||||
delete: {
|
||||
workflow: "dashboard",
|
||||
posts: ["delete"],
|
||||
open: async (page) => {
|
||||
await page.locator(".spec-chip-del").first().click({ force: true });
|
||||
await page.waitForSelector("#delete-modal[open]", { timeout: 10000 });
|
||||
},
|
||||
},
|
||||
// Help on its first tab, whatever topic it opened on.
|
||||
help: {
|
||||
workflow: "plan",
|
||||
posts: ["help"],
|
||||
open: async (page) => {
|
||||
await page.click("#btn-about");
|
||||
await page.locator("#help-tabs .help-tab").first().click();
|
||||
await page.waitForSelector("#help-modal[open]", { timeout: 10000 });
|
||||
},
|
||||
},
|
||||
prefs: {
|
||||
workflow: "plan",
|
||||
posts: ["prefs"],
|
||||
open: async (page) => {
|
||||
await page.click("#btn-looks");
|
||||
await page.waitForSelector("#looks-modal[open]", { timeout: 10000 });
|
||||
},
|
||||
},
|
||||
// Preferences scrolled to Cleanup once its scan has answered.
|
||||
cleanup: {
|
||||
workflow: "plan",
|
||||
posts: ["cleanup"],
|
||||
open: async (page) => {
|
||||
await page.click("#btn-looks");
|
||||
await page.waitForSelector("#looks-modal[open]", { timeout: 10000 });
|
||||
await page.locator(".looks-cleanup").scrollIntoViewIfNeeded();
|
||||
await page.click("#cleanup-scan");
|
||||
await page.waitForFunction(() => document.getElementById("cleanup-status").textContent.trim() !== "", null, { timeout: 15000 }).catch(() => {});
|
||||
},
|
||||
},
|
||||
// The panel open with two folders: the project and a sibling added once.
|
||||
// Last, since the console remembers the folder for the project and every
|
||||
// later shot's footer would count it.
|
||||
workspace: {
|
||||
workflow: "plan",
|
||||
posts: ["workspace"],
|
||||
open: async (page) => {
|
||||
const extra = makeExtraFolder();
|
||||
await page.evaluate(async (dir) => {
|
||||
const now = await (await fetch("/workspace", { cache: "no-store" })).json();
|
||||
if ((now.folders || []).length < 2) {
|
||||
await fetch("/workspace/add", {
|
||||
method: "POST",
|
||||
headers: { "content-type": "application/json" },
|
||||
body: JSON.stringify({ path: dir, name: "task-web", description: "The web app that calls the API" }),
|
||||
});
|
||||
}
|
||||
}, extra);
|
||||
await page.click("#footer-where");
|
||||
await page.waitForSelector("#workspace-modal[open] #workspace-list li:nth-child(2)", { timeout: 10000 });
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// On Windows the temp dir sits under the user's profile, and the page can
|
||||
// show the project's path, so the sample project goes at the drive root
|
||||
// instead. Elsewhere the temp dir carries no username. Each run makes its own
|
||||
// folder there (p2c-shots-XXXXXX), so it never deletes anything it did not
|
||||
// create and two runs never share one.
|
||||
const SCRATCH_ROOT = process.platform === "win32" ? path.parse(os.tmpdir()).root : os.tmpdir();
|
||||
let SCRATCH = null;
|
||||
let HOME = null;
|
||||
let ENV = null;
|
||||
|
||||
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
|
||||
|
||||
function fail(message) {
|
||||
console.error(message);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
function phaseFile(n, name, tasks, done) {
|
||||
const lines = tasks.map((t, i) => `- [${done ? "x" : " "}] **Task ${n}.${i + 1}:** ${t}`).join("\n");
|
||||
return `# Phase ${n}: ${name}\n\n**Status:** ${done ? "Complete" : "Not Started"}\n\n## Tasks\n\n${lines}\n`;
|
||||
}
|
||||
|
||||
// A neutral project the console scans as mid-build: Phases 1 and 2 done,
|
||||
// Phases 3 and 4 still to do.
|
||||
function makeSampleProject() {
|
||||
const project = path.join(SCRATCH, "task-api");
|
||||
const spec = path.join(project, "specs", "task-api");
|
||||
fs.mkdirSync(spec, { recursive: true });
|
||||
fs.writeFileSync(
|
||||
path.join(project, "AGENTS.md"),
|
||||
"# AGENTS.md\n\nA REST API for a team's tasks, on Fastify, Postgres and Zod.\n\n## Development Commands\n\n- `npm start` runs the API\n- `npm test` runs the tests\n"
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(spec, "overview.md"),
|
||||
[
|
||||
"# Task API",
|
||||
"",
|
||||
"**Status:** In Progress",
|
||||
"",
|
||||
"## Summary",
|
||||
"",
|
||||
"A REST API for a team's tasks: create, list, update and delete them, with filters by status and assignee and cursor paging.",
|
||||
"",
|
||||
"## Phase Checklist",
|
||||
"",
|
||||
"- [x] Phase 1: Project setup ([phase-1.md](./phase-1.md))",
|
||||
"- [x] Phase 2: Data model ([phase-2.md](./phase-2.md))",
|
||||
"- [ ] Phase 3: API endpoints ([phase-3.md](./phase-3.md))",
|
||||
"- [ ] Phase 4: Authentication ([phase-4.md](./phase-4.md))",
|
||||
"",
|
||||
].join("\n")
|
||||
);
|
||||
// The file the Ask shot's answer points at.
|
||||
fs.mkdirSync(path.join(project, "src", "tasks"), { recursive: true });
|
||||
fs.writeFileSync(
|
||||
path.join(project, "src", "tasks", "paginate.js"),
|
||||
[
|
||||
"// Cursor paging for GET /tasks: up to 50 tasks a page, oldest first.",
|
||||
"export function paginate(tasks, cursor, limit = 50) {",
|
||||
" const start = cursor ? tasks.findIndex((t) => t.id === cursor) + 1 : 0;",
|
||||
" const page = tasks.slice(start, start + limit);",
|
||||
" return { tasks: page, nextCursor: page.length === limit ? page[page.length - 1].id : null };",
|
||||
"}",
|
||||
"",
|
||||
].join("\n")
|
||||
);
|
||||
fs.writeFileSync(path.join(spec, "phase-1.md"), phaseFile(1, "Project setup", ["Scaffold the Fastify app", "Add the Postgres connection", "Add the test runner"], true));
|
||||
fs.writeFileSync(
|
||||
path.join(spec, "phase-2.md"),
|
||||
phaseFile(2, "Data model", ["Add the tasks table and its migration", "Add the task model", "Add status and assignee indexes", "Seed sample tasks"], true)
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(spec, "phase-3.md"),
|
||||
phaseFile(3, "API endpoints", ["Add GET /tasks with cursor paging", "Add POST /tasks", "Add PATCH /tasks/:id", "Add DELETE /tasks/:id"], false)
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(spec, "phase-4.md"),
|
||||
phaseFile(4, "Authentication", ["Add API keys", "Require a key on every route", "Scope tasks to the key's team"], false)
|
||||
);
|
||||
return project;
|
||||
}
|
||||
|
||||
// The Workspace shot's second folder, beside the sample project.
|
||||
function makeExtraFolder() {
|
||||
const dir = path.join(SCRATCH, "task-web");
|
||||
fs.mkdirSync(dir, { recursive: true });
|
||||
fs.writeFileSync(path.join(dir, "README.md"), "# task-web\n\nThe web app that lists and edits a team's tasks.\n");
|
||||
return dir;
|
||||
}
|
||||
|
||||
function git(cwd, ...gitArgs) {
|
||||
const r = spawnSync("git", gitArgs, { cwd, env: ENV, encoding: "utf8" });
|
||||
if (r.status !== 0) throw new Error(`git ${gitArgs.join(" ")} failed: ${(r.stderr || "").trim()}`);
|
||||
}
|
||||
|
||||
// The git shot's project: the same sample in a repository whose feature branch
|
||||
// is pushed to a local bare "origin" and has three changes to commit, so the
|
||||
// board opens on Changes with Commit as the next step. It sits in its own
|
||||
// folder so the other shots never see a repository.
|
||||
let GIT_PROJECT = null;
|
||||
function makeGitProject() {
|
||||
if (GIT_PROJECT) return GIT_PROJECT;
|
||||
const parent = path.join(SCRATCH, "git");
|
||||
fs.mkdirSync(parent, { recursive: true });
|
||||
const origin = path.join(parent, "origin.git");
|
||||
git(parent, "init", "--bare", "--initial-branch=main", origin);
|
||||
const prev = SCRATCH;
|
||||
SCRATCH = parent;
|
||||
const project = makeSampleProject();
|
||||
SCRATCH = prev;
|
||||
const id = ["-c", "user.name=Sam Rivera", "-c", "user.email=sam@example.com", "-c", "commit.gpgsign=false"];
|
||||
git(project, "init", "--initial-branch=main");
|
||||
git(project, "remote", "add", "origin", origin);
|
||||
git(project, "add", "-A");
|
||||
git(project, ...id, "commit", "-m", "Scaffold the task API and its specs");
|
||||
git(project, "push", "-u", "origin", "main");
|
||||
git(project, "switch", "-c", "feature/task-endpoints");
|
||||
fs.writeFileSync(path.join(project, "src", "tasks", "routes.js"), "// The /tasks routes.\nexport default async function routes(app) {}\n");
|
||||
git(project, "add", "-A");
|
||||
git(project, ...id, "commit", "-m", "Register the /tasks routes plugin");
|
||||
git(project, "push", "-u", "origin", "feature/task-endpoints");
|
||||
// A fetch stamps FETCH_HEAD, so the board says "Last refreshed" rather than "Never".
|
||||
git(project, "fetch", "origin");
|
||||
fs.appendFileSync(path.join(project, "src", "tasks", "paginate.js"), "\nexport const MAX_LIMIT = 50;\n");
|
||||
fs.writeFileSync(path.join(project, "src", "tasks", "schema.js"), "// The Zod schema for a task.\nexport const taskSchema = {};\n");
|
||||
fs.appendFileSync(path.join(project, "specs", "task-api", "phase-3.md"), "\n<!-- Task 3.1 in progress -->\n");
|
||||
GIT_PROJECT = project;
|
||||
return project;
|
||||
}
|
||||
|
||||
function cli(cwd, ...cliArgs) {
|
||||
const r = spawnSync(process.execPath, [CONSOLE_CLI, ...cliArgs], { cwd, env: ENV, encoding: "utf8" });
|
||||
const line = (r.stdout || "").trim().split("\n").pop() || "";
|
||||
let out = null;
|
||||
try {
|
||||
out = JSON.parse(line);
|
||||
} catch {}
|
||||
return { code: r.status, out, err: r.stderr };
|
||||
}
|
||||
|
||||
function post(project, sid, name) {
|
||||
const r = cli(project, "post", "--session", sid, "--file", path.join(PAYLOADS, name + ".json"));
|
||||
if (r.code !== 0) throw new Error(`post ${name}.json failed (${r.code}): ${r.err.trim()}`);
|
||||
}
|
||||
|
||||
// Opens a session for the shot and posts its payloads. Returns { sid, url }.
|
||||
function stage(project, spec) {
|
||||
const r = cli(project, "open", "--workflow", spec.workflow, "--no-open");
|
||||
if (r.code !== 0 || !r.out || !r.out.url) throw new Error(`open failed (${r.code}): ${r.err.trim()}`);
|
||||
for (const name of spec.posts) post(project, r.out.sid, name);
|
||||
return { sid: r.out.sid, url: r.out.url };
|
||||
}
|
||||
|
||||
// Waits for the page to draw real state, then lets the animations finish
|
||||
// (the dashboard's wake-up is the longest).
|
||||
async function settle(page) {
|
||||
await page.waitForLoadState("networkidle", { timeout: 15000 }).catch(() => {});
|
||||
await page.waitForSelector(".dash-card, .card, .handoff, .ask-pane, .doc, .git-board", { timeout: 15000 }).catch(() => {});
|
||||
await sleep(args.snapshot ? 1800 : 3500);
|
||||
}
|
||||
|
||||
async function openTab(page, label) {
|
||||
await page.evaluate((text) => {
|
||||
const tab = [...document.querySelectorAll("#views .view-tab")].find((b) => b.firstChild && b.firstChild.textContent.trim() === text);
|
||||
if (tab) tab.click();
|
||||
}, label);
|
||||
await sleep(600);
|
||||
}
|
||||
|
||||
async function scrollTo(page, { scrollTo: top, mustShow }) {
|
||||
const problem = await page.evaluate(
|
||||
([topSel, showSel]) => {
|
||||
const find = (sel) =>
|
||||
sel.startsWith("cmd:")
|
||||
? [...document.querySelectorAll(".dash-card")].find((c) => c.querySelector(".dash-card-cmd")?.textContent.trim() === sel.slice(4))
|
||||
: document.querySelector(sel);
|
||||
const node = find(topSel);
|
||||
if (!node) return `nothing matched ${topSel}, captured from the top`;
|
||||
node.scrollIntoView({ block: topSel.startsWith("cmd:") ? "end" : "start", behavior: "instant" });
|
||||
if (!showSel) return null;
|
||||
const show = find(showSel);
|
||||
if (!show) return `nothing matched ${showSel}`;
|
||||
const r = show.getBoundingClientRect();
|
||||
return r.top >= 0 && r.bottom <= window.innerHeight ? null : `${showSel} is not wholly in view`;
|
||||
},
|
||||
[top, mustShow || null]
|
||||
);
|
||||
if (problem) console.log(` warning: ${problem}`);
|
||||
await sleep(300);
|
||||
}
|
||||
|
||||
// The properties that change how a stylesheet move would look.
|
||||
const SNAP_PROPS = [
|
||||
"display", "position", "top", "right", "bottom", "left", "width", "height", "min-width", "max-width", "min-height", "max-height",
|
||||
"margin-top", "margin-right", "margin-bottom", "margin-left", "padding-top", "padding-right", "padding-bottom", "padding-left",
|
||||
"color", "background-color", "background-image", "border-top-width", "border-right-width", "border-bottom-width", "border-left-width",
|
||||
"border-top-style", "border-top-color", "border-right-color", "border-bottom-color", "border-left-color", "border-top-left-radius",
|
||||
"font-family", "font-size", "font-weight", "font-style", "line-height", "letter-spacing", "text-align", "text-transform",
|
||||
"gap", "grid-template-columns", "grid-template-rows", "grid-column-start", "grid-column-end", "grid-row-start", "grid-row-end",
|
||||
"flex-direction", "flex-wrap", "flex-grow", "flex-shrink", "flex-basis", "align-items", "justify-content", "align-self",
|
||||
"overflow-x", "overflow-y", "opacity", "visibility", "transform", "z-index", "box-shadow", "cursor", "pointer-events", "white-space",
|
||||
"content", "outline-style", "transform-origin", "fill", "stroke",
|
||||
];
|
||||
// Recorded after the properties above, for every element: what names its animation.
|
||||
// A property a running animation is moving is recorded as "~" (it differs from run
|
||||
// to run), so a rule that adds or removes an animation shows in these fields instead.
|
||||
const SNAP_ANIMATION = ["animation-name", "animation-duration", "animation-delay", "animation-iteration-count", "animation-timing-function", "animation-direction", "animation-fill-mode"];
|
||||
|
||||
const SNAP = {};
|
||||
|
||||
async function snapshotNow(page) {
|
||||
return page.evaluate(
|
||||
([props, animation]) => {
|
||||
const out = {};
|
||||
const seen = new Map();
|
||||
for (const el of document.querySelectorAll("*")) {
|
||||
const parent = el.parentElement;
|
||||
const key = parent ? (seen.get(parent) || "") : "";
|
||||
const sib = parent ? [...parent.children].indexOf(el) : 0;
|
||||
const cls = typeof el.className === "string" ? el.className.trim().split(/\s+/).filter(Boolean).slice(0, 3).join(".") : "";
|
||||
const path = (parent ? key + ">" : "") + el.tagName.toLowerCase() + (el.id ? "#" + el.id : "") + (cls ? "." + cls : "") + "[" + sib + "]";
|
||||
seen.set(el, path);
|
||||
const cs = getComputedStyle(el);
|
||||
const moving = new Set();
|
||||
for (const a of el.getAnimations ? el.getAnimations() : []) {
|
||||
for (const kf of a.effect && a.effect.getKeyframes ? a.effect.getKeyframes() : []) {
|
||||
for (const k of Object.keys(kf)) if (!["offset", "easing", "composite", "computedOffset"].includes(k)) moving.add(k.replace(/[A-Z]/g, (c) => "-" + c.toLowerCase()));
|
||||
}
|
||||
}
|
||||
out[path] = props.map((p) => (moving.has(p) ? "~" : cs.getPropertyValue(p))).concat(animation.map((p) => cs.getPropertyValue(p))).join("|");
|
||||
}
|
||||
return out;
|
||||
},
|
||||
[SNAP_PROPS, SNAP_ANIMATION]
|
||||
);
|
||||
}
|
||||
|
||||
async function snapshotShot(page, name, theme) {
|
||||
for (const [w, h] of [[1280, 800], [390, 844]]) {
|
||||
await page.setViewportSize({ width: w, height: h });
|
||||
await sleep(1500);
|
||||
SNAP[`${name}/${theme}/${w}`] = await snapshotNow(page);
|
||||
}
|
||||
await page.setViewportSize({ width: 1280, height: 800 });
|
||||
}
|
||||
|
||||
async function shoot(page, name) {
|
||||
const written = [];
|
||||
// Math.random picks Planny's mood variants; pinned so two runs draw the same page.
|
||||
if (args.snapshot) await page.addInitScript(() => { Math.random = () => 0.5; });
|
||||
for (const theme of THEMES) {
|
||||
await page.emulateMedia({ colorScheme: theme });
|
||||
// The theme is applied at load, so reload rather than trust a live switch.
|
||||
await page.reload({ waitUntil: "domcontentloaded" });
|
||||
await settle(page);
|
||||
if (page.__tab) await openTab(page, page.__tab);
|
||||
if (page.__scroll && page.__scroll.scrollTo) await scrollTo(page, page.__scroll);
|
||||
if (page.__open) {
|
||||
await page.__open(page);
|
||||
await sleep(600);
|
||||
}
|
||||
if (args.snapshot) {
|
||||
await snapshotShot(page, name, theme);
|
||||
continue;
|
||||
}
|
||||
const file = path.join(OUT, `${name}-${theme}.webp`);
|
||||
const cdp = await page.context().newCDPSession(page);
|
||||
// Without a clip the capture comes out in CSS pixels; a clip of the
|
||||
// viewport at scale 2 is the twice-density shot (byte for byte what
|
||||
// Playwright's own PNG screenshot takes).
|
||||
const clip = { x: 0, y: 0, width: 1280, height: 800, scale: 2 };
|
||||
const { data } = await cdp.send("Page.captureScreenshot", { format: "webp", quality: QUALITY, captureBeyondViewport: false, clip });
|
||||
await cdp.detach();
|
||||
fs.writeFileSync(file, Buffer.from(data, "base64"));
|
||||
const kb = Math.round(fs.statSync(file).size / 1024);
|
||||
console.log(`${path.basename(file)} ${kb} KB`);
|
||||
if (kb > WARN_KB) console.log(` warning: ${path.basename(file)} is over ${WARN_KB} KB`);
|
||||
written.push(file);
|
||||
}
|
||||
return written;
|
||||
}
|
||||
|
||||
// Opens the page for a staged session and saves both themes.
|
||||
async function capture(browser, url, name, { tab, scrollTo: top, mustShow, open }) {
|
||||
const ctx = await browser.newContext({ viewport: { width: 1280, height: 800 }, deviceScaleFactor: 2 });
|
||||
try {
|
||||
const page = await ctx.newPage();
|
||||
await page.goto(url, { waitUntil: "domcontentloaded" });
|
||||
await settle(page);
|
||||
page.__tab = tab || null;
|
||||
page.__scroll = { scrollTo: top, mustShow };
|
||||
page.__open = open || null;
|
||||
return await shoot(page, name);
|
||||
} finally {
|
||||
await ctx.close();
|
||||
}
|
||||
}
|
||||
|
||||
// The Ask shot: a question typed and sent on the page, collected with `chat`
|
||||
// the way an agent would, and answered with a posted reply.
|
||||
async function captureAsk(browser, project, sid, url, question) {
|
||||
const ctx = await browser.newContext({ viewport: { width: 1280, height: 800 }, deviceScaleFactor: 2 });
|
||||
try {
|
||||
const page = await ctx.newPage();
|
||||
await page.goto(url, { waitUntil: "domcontentloaded" });
|
||||
await settle(page);
|
||||
await openTab(page, "Ask");
|
||||
await page.waitForSelector("#ask-input:not([disabled])", { timeout: 10000 });
|
||||
await page.locator("#ask-input").pressSequentially(question);
|
||||
await page.evaluate(() => {
|
||||
const send = [...document.querySelectorAll(".ask-composer button")].find((b) => b.textContent.trim() === "Send");
|
||||
if (send) send.click();
|
||||
});
|
||||
|
||||
let entry = null;
|
||||
for (let i = 0; i < 40 && !entry; i++) {
|
||||
const r = cli(project, "chat", "--session", sid);
|
||||
if (r.code === 0 && r.out && r.out.chat) entry = r.out.chat.find((c) => c.kind === "message");
|
||||
if (!entry) await sleep(250);
|
||||
}
|
||||
if (!entry) throw new Error("the Ask question never reached the console");
|
||||
|
||||
const reply = path.join(HOME, "ask-reply.json");
|
||||
fs.writeFileSync(
|
||||
reply,
|
||||
JSON.stringify({
|
||||
chat: {
|
||||
replies: [
|
||||
{
|
||||
id: "r" + entry.seq,
|
||||
re: entry.seq,
|
||||
conversation: entry.conversation,
|
||||
md: "Paging is in `src/tasks/paginate.js`. It reads the `cursor` query parameter, returns up to 50 tasks and a `nextCursor`, and `GET /tasks` calls it on every request.",
|
||||
},
|
||||
],
|
||||
},
|
||||
agent: { status: "waiting" },
|
||||
})
|
||||
);
|
||||
const r = cli(project, "post", "--session", sid, "--file", reply);
|
||||
if (r.code !== 0) throw new Error(`posting the Ask reply failed (${r.code}): ${r.err.trim()}`);
|
||||
await sleep(1000);
|
||||
page.__tab = "Ask";
|
||||
return await shoot(page, "ask");
|
||||
} finally {
|
||||
await ctx.close();
|
||||
}
|
||||
}
|
||||
|
||||
async function main() {
|
||||
const docs = path.join(ROOT, "docs", "screenshots");
|
||||
const fold = (p) => (process.platform === "win32" ? p.toLowerCase() : p);
|
||||
if (args.compare && (fold(OUT) === fold(docs) || fold(OUT).startsWith(fold(docs) + path.sep))) {
|
||||
fail(`--compare never writes into ${path.relative(ROOT, docs)}: pass --out with a folder outside it.`);
|
||||
}
|
||||
const table = args.compare ? { ...SHOTS, ...COMPARE_SHOTS } : SHOTS;
|
||||
const names = args.only ? [args.only] : Object.keys(table);
|
||||
for (const n of names) if (!table[n]) fail(`Unknown shot "${n}". Shots: ${Object.keys(table).join(", ")}`);
|
||||
|
||||
SCRATCH = fs.mkdtempSync(path.join(SCRATCH_ROOT, "p2c-shots-"));
|
||||
HOME = path.join(SCRATCH, "console-home");
|
||||
ENV = { ...process.env, PLAN2CODE_CONSOLE_HOME: HOME, PLAN2CODE_NOTEPADS_DIR: path.join(SCRATCH, "notepads"), PLAN2CODE_NO_BROWSER: "1" };
|
||||
fs.mkdirSync(HOME, { recursive: true });
|
||||
fs.mkdirSync(OUT, { recursive: true });
|
||||
let browser = null;
|
||||
let project = null;
|
||||
try {
|
||||
project = makeSampleProject();
|
||||
// A saved role keeps the dashboard's "pick your role" banner out of shot,
|
||||
// and the Ocean highlight is the console's nearest to the Plan2Code blue
|
||||
// the landing page uses.
|
||||
fs.writeFileSync(path.join(HOME, "looks.json"), JSON.stringify({ looks: { role: "engineer", accent: "ocean", welcomeSeen: true } }));
|
||||
browser = await launchBrowser({
|
||||
...(typeof args.browser === "string" ? { executablePath: args.browser } : {}),
|
||||
args: ["--no-first-run", "--no-default-browser-check", "--mute-audio"],
|
||||
});
|
||||
for (const name of names) {
|
||||
const where = table[name].repo ? makeGitProject() : project;
|
||||
const { sid, url } = stage(where, table[name]);
|
||||
try {
|
||||
if (table[name].ask) await captureAsk(browser, where, sid, url, table[name].ask);
|
||||
else await capture(browser, url, name, table[name]);
|
||||
} finally {
|
||||
cli(where, "stop", "--session", sid);
|
||||
}
|
||||
}
|
||||
if (args.snapshot) fs.writeFileSync(path.resolve(String(args.snapshot)), JSON.stringify(SNAP));
|
||||
} finally {
|
||||
if (browser) await browser.close();
|
||||
if (project) cli(project, "stop", "--all");
|
||||
removeScratch();
|
||||
}
|
||||
}
|
||||
|
||||
// `stop` signals the server and returns without waiting for it to exit, and
|
||||
// on Windows a server still closing holds its log open. Retry the delete, and
|
||||
// never let a failed cleanup replace the run's own result or error.
|
||||
function removeScratch() {
|
||||
try {
|
||||
fs.rmSync(SCRATCH, { recursive: true, force: true, maxRetries: 10, retryDelay: 200 });
|
||||
} catch (e) {
|
||||
console.log(`warning: could not remove ${SCRATCH} (${e.code || e.message}); delete it by hand`);
|
||||
}
|
||||
}
|
||||
|
||||
main().catch((e) => {
|
||||
console.error(e && e.message ? e.message : e);
|
||||
process.exit(1);
|
||||
});
|
||||
@@ -0,0 +1,91 @@
|
||||
// Check the dashboard's "What each skill reads and writes" table against the
|
||||
// skills it describes.
|
||||
//
|
||||
// The table is what the dashboard and the Ask tab treat as ground truth for a
|
||||
// skill's files. Every backticked name in a row must appear in that skill's own
|
||||
// prompt or its references, so a rename in a skill fails here instead of the
|
||||
// table quietly going stale. `<placeholder>` segments match any placeholder,
|
||||
// so `PLAN-DRAFT-<date>.md` accepts the skill's `PLAN-DRAFT-<YYYYMMDD>.md`.
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
|
||||
const SRC = path.join(ROOT, "src");
|
||||
const HEADING = "## What each skill reads and writes";
|
||||
|
||||
function readTree(dir) {
|
||||
if (!fs.existsSync(dir)) return "";
|
||||
return fs
|
||||
.readdirSync(dir, { withFileTypes: true })
|
||||
.map((entry) => {
|
||||
const full = path.join(dir, entry.name);
|
||||
if (entry.isDirectory()) return readTree(full);
|
||||
return entry.name.endsWith(".md") ? fs.readFileSync(full, "utf8") : "";
|
||||
})
|
||||
.join("\n");
|
||||
}
|
||||
|
||||
function skillCorpus(skill) {
|
||||
const file = path.join(SRC, `plan2code-${skill}.md`);
|
||||
if (!fs.existsSync(file)) return null;
|
||||
return fs.readFileSync(file, "utf8") + "\n" + readTree(path.join(SRC, `plan2code-${skill}-references`));
|
||||
}
|
||||
|
||||
// "3-implement(-review)" names both 3-implement and 3-implement-review.
|
||||
function expandSkills(cell) {
|
||||
const optional = cell.match(/^(.*)\((.+)\)$/);
|
||||
return optional ? [optional[1], optional[1] + optional[2]] : [cell];
|
||||
}
|
||||
|
||||
function tokenPattern(token) {
|
||||
const escaped = token.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||
return new RegExp(escaped.replace(/<[^>]+>/g, "<[^>]+>"));
|
||||
}
|
||||
|
||||
function mentions(corpus, token) {
|
||||
if (tokenPattern(token).test(corpus)) return true;
|
||||
const leaf = token.slice(token.lastIndexOf("/") + 1);
|
||||
return leaf !== "" && leaf !== token && tokenPattern(leaf).test(corpus);
|
||||
}
|
||||
|
||||
const prompt = fs.readFileSync(path.join(SRC, "plan2code.md"), "utf8");
|
||||
const start = prompt.indexOf(HEADING);
|
||||
if (start === -1) {
|
||||
console.error(` FAIL src/plan2code.md has no "${HEADING}" section.`);
|
||||
process.exit(1);
|
||||
}
|
||||
const section = prompt.slice(start + HEADING.length).split(/\n## /)[0];
|
||||
const rows = section
|
||||
.split("\n")
|
||||
.filter((line) => line.startsWith("|") && !/^\|\s*(skill|---)/.test(line))
|
||||
.map((line) => line.split("|").slice(1, -1).map((cell) => cell.trim()));
|
||||
|
||||
if (rows.length === 0) {
|
||||
console.error(` FAIL "${HEADING}" has no table rows.`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
let bad = 0;
|
||||
for (const [skillCell, ...cells] of rows) {
|
||||
const skills = expandSkills(skillCell);
|
||||
const corpora = skills.map(skillCorpus);
|
||||
if (corpora.some((corpus) => corpus === null)) {
|
||||
bad++;
|
||||
console.error(` FAIL ${skillCell}: no src/plan2code-<skill>.md for ${skills.join(" / ")}`);
|
||||
continue;
|
||||
}
|
||||
const corpus = corpora.join("\n");
|
||||
const tokens = cells.join(" ").match(/`[^`]+`/g) ?? [];
|
||||
const missing = tokens.map((t) => t.slice(1, -1)).filter((token) => !mentions(corpus, token));
|
||||
if (missing.length) {
|
||||
bad++;
|
||||
console.error(` FAIL ${skillCell}: not in the skill's source: ${missing.join(", ")}`);
|
||||
} else {
|
||||
console.log(` ok ${skillCell} (${tokens.length} name(s))`);
|
||||
}
|
||||
}
|
||||
if (bad) {
|
||||
console.error(`${bad} row(s) of "${HEADING}" disagree with their skill.`);
|
||||
process.exit(1);
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
// The console's stylesheet as the tests read it: the files under
|
||||
// public/styles/ joined in the server's own order, without the accent rules.
|
||||
// A rule moving between files never breaks a test; only a rule that changes
|
||||
// or vanishes does.
|
||||
|
||||
import { joinedStyles } from "../src/web-console/static.mjs";
|
||||
|
||||
export function joinedCss() {
|
||||
return joinedStyles().toString("utf8");
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
#!/usr/bin/env node
|
||||
// The cheapest check for a stylesheet move: every element's computed style, on
|
||||
// every screen the console has, in both themes, at desktop and phone width.
|
||||
// Dev-only, not in `npm test`. Stages the screens the way
|
||||
// scripts/capture-screenshots.mjs does (its --snapshot mode), so the sample
|
||||
// project and payloads are the same.
|
||||
//
|
||||
// node scripts/css-snapshot.mjs [--out <file>] write a snapshot
|
||||
// node scripts/css-snapshot.mjs --compare <file> take one now and print every difference
|
||||
//
|
||||
// Take a baseline before moving any rule, then compare after each move. Two
|
||||
// runs in a row on the same stylesheet report nothing: Math.random is pinned,
|
||||
// a property a running animation is moving is recorded as "~" (its animation
|
||||
// fields are still compared), and heights within 4px are ignored (see jitter).
|
||||
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
|
||||
const CAPTURE = path.join(ROOT, "scripts", "capture-screenshots.mjs");
|
||||
|
||||
const args = {};
|
||||
for (let i = 2; i < process.argv.length; i++) {
|
||||
const a = process.argv[i];
|
||||
if (a.startsWith("--")) args[a.slice(2)] = process.argv[i + 1] && !process.argv[i + 1].startsWith("--") ? process.argv[++i] : true;
|
||||
}
|
||||
|
||||
function take(file) {
|
||||
// The screenshot script wants a folder to exist for --compare; nothing is written to it.
|
||||
const out = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-css-snap-"));
|
||||
try {
|
||||
const r = spawnSync(process.execPath, [CAPTURE, "--compare", "--snapshot", file, "--out", out], { stdio: ["ignore", "inherit", "inherit"] });
|
||||
if (r.status !== 0) {
|
||||
console.error("the snapshot run failed");
|
||||
process.exit(1);
|
||||
}
|
||||
} finally {
|
||||
fs.rmSync(out, { recursive: true, force: true });
|
||||
}
|
||||
}
|
||||
|
||||
const NAMES = [
|
||||
"display", "position", "top", "right", "bottom", "left", "width", "height", "min-width", "max-width", "min-height", "max-height",
|
||||
"margin-top", "margin-right", "margin-bottom", "margin-left", "padding-top", "padding-right", "padding-bottom", "padding-left",
|
||||
"color", "background-color", "background-image", "border-top-width", "border-right-width", "border-bottom-width", "border-left-width",
|
||||
"border-top-style", "border-top-color", "border-right-color", "border-bottom-color", "border-left-color", "border-top-left-radius",
|
||||
"font-family", "font-size", "font-weight", "font-style", "line-height", "letter-spacing", "text-align", "text-transform",
|
||||
"gap", "grid-template-columns", "grid-template-rows", "grid-column-start", "grid-column-end", "grid-row-start", "grid-row-end",
|
||||
"flex-direction", "flex-wrap", "flex-grow", "flex-shrink", "flex-basis", "align-items", "justify-content", "align-self",
|
||||
"overflow-x", "overflow-y", "opacity", "visibility", "transform", "z-index", "box-shadow", "cursor", "pointer-events", "white-space",
|
||||
"content", "outline-style", "transform-origin", "fill", "stroke",
|
||||
];
|
||||
const ANIMATION = ["animation-name", "animation-duration", "animation-delay", "animation-iteration-count", "animation-timing-function", "animation-direction", "animation-fill-mode"];
|
||||
|
||||
// A growing answer box at phone width settles a few pixels either way from one
|
||||
// run to the next with the same stylesheet; the heights it carries up the page
|
||||
// (and the transform origin, which is half of one) are not a stylesheet's doing.
|
||||
const JITTER = new Set(["height", "min-height", "transform-origin"]);
|
||||
function jitter(name, a, b) {
|
||||
if (!JITTER.has(name)) return false;
|
||||
const na = a.match(/-?\d+(?:\.\d+)?/g);
|
||||
const nb = b.match(/-?\d+(?:\.\d+)?/g);
|
||||
return !!na && !!nb && na.length === nb.length && na.every((n, i) => Math.abs(n - nb[i]) <= 4);
|
||||
}
|
||||
|
||||
function compare(before, after) {
|
||||
const diffs = [];
|
||||
for (const key of new Set([...Object.keys(before), ...Object.keys(after)])) {
|
||||
const a = before[key];
|
||||
const b = after[key];
|
||||
if (!a || !b) {
|
||||
diffs.push(`${key}: screen ${a ? "missing from the new run" : "is new"}`);
|
||||
continue;
|
||||
}
|
||||
for (const el of new Set([...Object.keys(a), ...Object.keys(b)])) {
|
||||
if (a[el] === b[el] || el.includes("p.dock-say")) continue; // the one line of Planny that types itself in, so its width moves
|
||||
if (a[el] === undefined || b[el] === undefined) {
|
||||
diffs.push(`${key} ${el}: element ${a[el] === undefined ? "added" : "gone"}`);
|
||||
continue;
|
||||
}
|
||||
const x = a[el].split("|");
|
||||
const y = b[el].split("|");
|
||||
const names = NAMES.concat(ANIMATION);
|
||||
x.forEach((v, i) => {
|
||||
if (v !== y[i] && v !== "~" && y[i] !== "~" && !jitter(names[i], v, y[i])) diffs.push(`${key} ${el} ${names[i] ?? i}: ${v} -> ${y[i]}`);
|
||||
});
|
||||
}
|
||||
}
|
||||
return diffs;
|
||||
}
|
||||
|
||||
if (args.compare === true) {
|
||||
console.error("usage: node scripts/css-snapshot.mjs --compare <snapshot file> (or --out <file> to take one)");
|
||||
process.exit(1);
|
||||
} else if (typeof args.compare === "string") {
|
||||
const tmp = path.join(os.tmpdir(), `p2c-css-snap-${process.pid}.json`);
|
||||
take(tmp);
|
||||
const diffs = compare(JSON.parse(fs.readFileSync(args.compare, "utf8")), JSON.parse(fs.readFileSync(tmp, "utf8")));
|
||||
fs.rmSync(tmp, { force: true });
|
||||
for (const d of diffs.slice(0, 200)) console.log(d);
|
||||
if (diffs.length > 200) console.log(`... and ${diffs.length - 200} more`);
|
||||
console.log(diffs.length ? `${diffs.length} difference(s)` : "no differences");
|
||||
process.exit(diffs.length ? 1 : 0);
|
||||
} else {
|
||||
const out = path.resolve(typeof args.out === "string" ? args.out : "css-snapshot.json");
|
||||
take(out);
|
||||
console.log(`wrote ${out} (${Math.round(fs.statSync(out).size / 1024)} KB)`);
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
// Copy-on-use fixtures for the tests in scripts/.
|
||||
//
|
||||
// Building a git fixture means a run of git processes (init, config, add,
|
||||
// commit, remote, push), and on Windows each one costs a few hundred
|
||||
// milliseconds. copyFixture builds a fixture once per test file and hands
|
||||
// every caller its own copy of it, so a test can still change its repo freely.
|
||||
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
|
||||
const templates = new Map();
|
||||
const madeDirs = [];
|
||||
|
||||
const tempDir = (name) => {
|
||||
const dir = fs.mkdtempSync(path.join(fs.realpathSync.native(os.tmpdir()), `p2c-${name}-`));
|
||||
madeDirs.push(dir);
|
||||
return dir;
|
||||
};
|
||||
export const slashed = (p) => p.replace(/\\/g, "/");
|
||||
|
||||
/** Every .git/config in the copied tree, bounded two levels down (repo at the root or `repo/` + `origin.git/` beside it). */
|
||||
function gitConfigs(dir, depth = 2) {
|
||||
const out = [];
|
||||
const walk = (d, left) => {
|
||||
for (const entry of fs.readdirSync(d, { withFileTypes: true })) {
|
||||
const p = path.join(d, entry.name);
|
||||
if (entry.isDirectory() && entry.name === ".git") out.push(path.join(p, "config"));
|
||||
else if (entry.isDirectory() && left > 0) walk(p, left - 1);
|
||||
}
|
||||
};
|
||||
walk(dir, depth);
|
||||
return out;
|
||||
}
|
||||
|
||||
/** Remove the temp dirs copyFixture made. Suites call this in test.after. */
|
||||
export function fixtureCleanup() {
|
||||
for (const dir of madeDirs.splice(0)) fs.rmSync(dir, { recursive: true, force: true });
|
||||
}
|
||||
|
||||
/**
|
||||
* A fresh copy, in its own temp dir named for `name`, of the fixture `build`
|
||||
* makes. `build(dir)` runs once per `key` per process, into an empty dir.
|
||||
*
|
||||
* A remote that points inside the fixture (a bare origin beside the repo)
|
||||
* must be added with forward slashes, as `slashed()` gives it: every copied
|
||||
* .git/config (found by a bounded walk, so a repo a folder or two down still
|
||||
* gets it) has the template's path swapped for the copy's, so the copy pushes
|
||||
* to its own origin.
|
||||
*/
|
||||
export function copyFixture(name, key, build) {
|
||||
let template = templates.get(key);
|
||||
if (!template) {
|
||||
template = tempDir("template");
|
||||
build(template);
|
||||
templates.set(key, template);
|
||||
}
|
||||
const dir = tempDir(name);
|
||||
fs.cpSync(template, dir, { recursive: true, preserveTimestamps: true });
|
||||
for (const config of gitConfigs(dir)) {
|
||||
if (!fs.existsSync(config)) continue;
|
||||
const text = fs.readFileSync(config, "utf8");
|
||||
if (text.includes(slashed(template))) fs.writeFileSync(config, text.split(slashed(template)).join(slashed(dir)));
|
||||
}
|
||||
return dir;
|
||||
}
|
||||
@@ -0,0 +1,360 @@
|
||||
// Git board fixture: canned state.git snapshots, one per journey step and edge case.
|
||||
//
|
||||
// A copy of specs/git-board-redesign/pathfinder/sketch-00/states.js, the repo
|
||||
// states every Pathfinder sketch moved between. Shape follows
|
||||
// src/web-console/git-repo.mjs snapshot(). `expect` is [primary op, secondary
|
||||
// op] under the agreed next-step rules (nextStep() in git-board.js), and
|
||||
// `expectTab` the tab that owns that step. Times are relative to a fixed NOW,
|
||||
// so ages read the same on every run.
|
||||
|
||||
export const NOW = Date.parse("2026-10-14T12:00:00Z");
|
||||
const ago = (mins) => new Date(NOW - mins * 60000).toISOString();
|
||||
|
||||
const ORIGIN = {
|
||||
name: "origin",
|
||||
url: "git@github.com:jparkerweb/plan2code.git",
|
||||
host: "github.com",
|
||||
web: "https://github.com/jparkerweb/plan2code",
|
||||
kind: "github",
|
||||
};
|
||||
|
||||
const pr = (head) => `https://github.com/jparkerweb/plan2code/compare/main...${head}?expand=1`;
|
||||
|
||||
const last = (subject, author, mins) => ({ subject, author, at: ago(mins) });
|
||||
|
||||
function local(name, extra = {}) {
|
||||
return {
|
||||
name,
|
||||
current: false,
|
||||
default: name === "main",
|
||||
remote: null,
|
||||
upstream: `origin/${name}`,
|
||||
upstreamRemote: "origin",
|
||||
ahead: 0,
|
||||
behind: 0,
|
||||
gone: false,
|
||||
merged: false,
|
||||
last: last("Update README", "Justin Parker", 60 * 24),
|
||||
...extra,
|
||||
};
|
||||
}
|
||||
|
||||
function remoteOnly(name, subject, author, mins) {
|
||||
return { name, current: false, default: false, remote: "origin", upstream: null, upstreamRemote: null, ahead: null, behind: null, gone: false, merged: false, last: last(subject, author, mins) };
|
||||
}
|
||||
|
||||
// The branches every journey shares; `current` and the current row's tracking are set per state.
|
||||
function branches(current, row = {}) {
|
||||
const rows = [
|
||||
local("main", { last: last("Release 4.12.0", "Justin Parker", 60 * 5) }),
|
||||
local("feature/ABC-12001-export-csv", { last: last("Add CSV export button to the audit view", "Justin Parker", 40) }),
|
||||
local("feature/ABC-11980-audit-filter", { last: last("Filter audit events by actor", "Priya Raman", 60 * 26) }),
|
||||
local("fix/ABC-11890-null-ticket", { merged: true, last: last("Guard against a null ticket id", "Sam Okafor", 60 * 24 * 6) }),
|
||||
local("chore/bump-deps", { merged: true, last: last("Bump dev dependencies", "Justin Parker", 60 * 24 * 9) }),
|
||||
remoteOnly("feature/ABC-12010-sso-banner", "Show SSO expiry banner", "Dana Whitfield", 60 * 3),
|
||||
remoteOnly("docs/readme-console", "Document the console's Ask tab", "Priya Raman", 60 * 24 * 2),
|
||||
];
|
||||
if (!rows.some((b) => b.name === current)) rows.splice(1, 0, local(current, { upstream: null, upstreamRemote: null, ahead: null, behind: null }));
|
||||
return rows.map((b) => (b.name === current && !b.remote ? { ...b, current: true, ...row } : b));
|
||||
}
|
||||
|
||||
const NO_CHANGES = { count: 0, heldBack: 0, files: [], untrackedDirs: [] };
|
||||
|
||||
const DIRTY_FEATURE = {
|
||||
count: 4,
|
||||
heldBack: 1,
|
||||
files: [
|
||||
{ path: "src/web-console/public/audit-export.js", state: "modified", staged: false, risky: false },
|
||||
{ path: "src/web-console/public/app.css", state: "modified", staged: false, risky: false },
|
||||
{ path: ".env.local", state: "new", staged: false, risky: true },
|
||||
],
|
||||
untrackedDirs: [{ path: "scripts/fixtures/audit/", files: 6 }],
|
||||
};
|
||||
|
||||
const DIRTY_MAIN = {
|
||||
count: 2,
|
||||
heldBack: 0,
|
||||
files: [
|
||||
{ path: "src/web-console/public/login.js", state: "modified", staged: false, risky: false },
|
||||
{ path: "scripts/test-login.mjs", state: "new", staged: false, risky: false },
|
||||
],
|
||||
untrackedDirs: [],
|
||||
};
|
||||
|
||||
function snap({ branch, ahead = 0, behind = 0, upstream, gone = false, changes = NO_CHANGES, inProgress = null, conflicted = [], lastFetch = ago(5), remotes = [ORIGIN], rows, prUrl = null, hasCommits = true, detached = null, rebasing }) {
|
||||
const up = upstream === undefined ? (branch ? `origin/${branch}` : null) : upstream;
|
||||
return {
|
||||
at: new Date(NOW).toISOString(),
|
||||
repo: true,
|
||||
hasCommits,
|
||||
head: { branch, detached, ...(rebasing ? { rebasing } : {}), upstream: up, gone, ahead: up ? ahead : null, behind: up ? behind : null },
|
||||
defaultBranch: "main",
|
||||
inProgress,
|
||||
conflicted,
|
||||
changes,
|
||||
remotes,
|
||||
lastFetch,
|
||||
refreshFailed: false,
|
||||
branches: rows || branches(branch, { upstream: up, upstreamRemote: up ? "origin" : null, ahead: up ? ahead : null, behind: up ? behind : null, gone }),
|
||||
prUrl,
|
||||
};
|
||||
}
|
||||
|
||||
const EXPORT = "feature/ABC-12001-export-csv";
|
||||
const LOGIN = "fix/ABC-12044-login-redirect";
|
||||
const FILTER = "feature/ABC-11980-audit-filter";
|
||||
|
||||
/** The three journeys, in click order. */
|
||||
export const JOURNEYS = [
|
||||
{ id: "commit-push", title: "Commit & push", states: ["cp-dirty", "cp-committing", "cp-ahead", "cp-pushing", "cp-pushed"] },
|
||||
{ id: "new-branch", title: "Start a new branch", states: ["nb-main-dirty", "nb-creating", "nb-unpublished", "nb-publishing", "nb-published"] },
|
||||
{ id: "pull-conflict", title: "Recover from a pull conflict", states: ["pc-diverged", "pc-pulling", "pc-conflict", "pc-resolved", "pc-continuing", "pc-rebased", "pc-pushing", "pc-pushed"] },
|
||||
];
|
||||
|
||||
/**
|
||||
* Every state: `git` (the snapshot), `journey` and `step` (or "edge"), `title`,
|
||||
* `expect` (primary op, secondary op or null), `expectTab` (the tab owning the
|
||||
* next step), `expectLine` where the line itself is pinned, `busy` (what is
|
||||
* running, when a git command is), `result` (the git-result notice after the
|
||||
* last action), and `on` (board op -> next state id) for the clicks a journey
|
||||
* takes.
|
||||
*/
|
||||
export const STATES = {
|
||||
/* Commit & push, on a published feature branch */
|
||||
"cp-dirty": {
|
||||
journey: "commit-push", step: 1, title: "4 changes on a feature branch (one held back)",
|
||||
git: snap({ branch: EXPORT, changes: DIRTY_FEATURE, prUrl: pr(EXPORT) }),
|
||||
expect: ["commit", "pr"],
|
||||
expectTab: "changes",
|
||||
on: { commit: "cp-committing" },
|
||||
},
|
||||
"cp-committing": {
|
||||
journey: "commit-push", step: 2, title: "Committing (busy)", busy: "Committing 3 files on feature/ABC-12001-export-csv",
|
||||
git: snap({ branch: EXPORT, changes: DIRTY_FEATURE, prUrl: pr(EXPORT) }),
|
||||
expect: ["commit", "pr"],
|
||||
expectTab: "changes",
|
||||
on: { done: "cp-ahead" },
|
||||
},
|
||||
"cp-ahead": {
|
||||
journey: "commit-push", step: 3, title: "Committed, 1 to push",
|
||||
result: { title: "Committed 3 files", body: "`9f3c2ab` Add CSV export button to the audit view. `.env.local` was held back." },
|
||||
git: snap({ branch: EXPORT, ahead: 1, changes: { count: 1, heldBack: 1, files: [DIRTY_FEATURE.files[2]], untrackedDirs: [] }, prUrl: pr(EXPORT) }),
|
||||
expect: ["push", "pr"],
|
||||
expectTab: "sync",
|
||||
on: { push: "cp-pushing" },
|
||||
},
|
||||
"cp-pushing": {
|
||||
journey: "commit-push", step: 4, title: "Pushing (busy)", busy: "Pushing 1 commit to origin",
|
||||
git: snap({ branch: EXPORT, ahead: 1, changes: { count: 1, heldBack: 1, files: [DIRTY_FEATURE.files[2]], untrackedDirs: [] }, prUrl: pr(EXPORT) }),
|
||||
expect: ["push", "pr"],
|
||||
expectTab: "sync",
|
||||
on: { done: "cp-pushed" },
|
||||
},
|
||||
"cp-pushed": {
|
||||
journey: "commit-push", step: 5, title: "Pushed, pull request ready",
|
||||
result: { title: "Pushed 1 commit to origin/feature/ABC-12001-export-csv", body: `\`9f3c2ab\`. [Open pull request](${pr(EXPORT)})` },
|
||||
git: snap({ branch: EXPORT, changes: { count: 1, heldBack: 1, files: [DIRTY_FEATURE.files[2]], untrackedDirs: [] }, prUrl: pr(EXPORT) }),
|
||||
expect: ["pr", "cleanup"],
|
||||
expectTab: "sync",
|
||||
on: {},
|
||||
},
|
||||
|
||||
/* Start a new branch, from changes made on main */
|
||||
"nb-main-dirty": {
|
||||
journey: "new-branch", step: 1, title: "2 changes on main",
|
||||
git: snap({ branch: "main", changes: DIRTY_MAIN }),
|
||||
expect: ["create-commit", "commit"],
|
||||
expectTab: "changes",
|
||||
on: { "create-commit": "nb-creating", create: "nb-creating" },
|
||||
},
|
||||
"nb-creating": {
|
||||
journey: "new-branch", step: 2, title: "Creating the branch and committing (busy)", busy: "Creating fix/ABC-12044-login-redirect from origin/main, then committing 2 files",
|
||||
git: snap({ branch: "main", changes: DIRTY_MAIN }),
|
||||
expect: ["create-commit", "commit"],
|
||||
expectTab: "changes",
|
||||
on: { done: "nb-unpublished" },
|
||||
},
|
||||
"nb-unpublished": {
|
||||
journey: "new-branch", step: 3, title: "New branch with 1 commit, not published",
|
||||
result: { title: "Created fix/ABC-12044-login-redirect and committed 2 files", body: "`4e7d1c0` Redirect to the login page after SSO expiry." },
|
||||
git: snap({ branch: LOGIN, upstream: null }),
|
||||
expect: ["publish", "cleanup"],
|
||||
expectTab: "sync",
|
||||
on: { publish: "nb-publishing" },
|
||||
},
|
||||
"nb-publishing": {
|
||||
journey: "new-branch", step: 4, title: "Publishing (busy)", busy: "Publishing fix/ABC-12044-login-redirect to origin",
|
||||
git: snap({ branch: LOGIN, upstream: null }),
|
||||
expect: ["publish", "cleanup"],
|
||||
expectTab: "sync",
|
||||
on: { done: "nb-published" },
|
||||
},
|
||||
"nb-published": {
|
||||
journey: "new-branch", step: 5, title: "Published, pull request ready",
|
||||
result: { title: "Published fix/ABC-12044-login-redirect to origin", body: `[Open pull request](${pr(LOGIN)})` },
|
||||
git: snap({ branch: LOGIN, prUrl: pr(LOGIN) }),
|
||||
expect: ["pr", "cleanup"],
|
||||
expectTab: "sync",
|
||||
on: {},
|
||||
},
|
||||
|
||||
/* Recover from a pull conflict */
|
||||
"pc-diverged": {
|
||||
journey: "pull-conflict", step: 1, title: "1 ahead, 3 behind",
|
||||
git: snap({ branch: FILTER, ahead: 1, behind: 3, prUrl: pr(FILTER) }),
|
||||
expect: ["pull", "push"],
|
||||
expectTab: "sync",
|
||||
on: { pull: "pc-pulling" },
|
||||
},
|
||||
"pc-pulling": {
|
||||
journey: "pull-conflict", step: 2, title: "Pulling (busy)", busy: "Pulling origin/feature/ABC-11980-audit-filter (rebase)",
|
||||
git: snap({ branch: FILTER, ahead: 1, behind: 3, prUrl: pr(FILTER) }),
|
||||
expect: ["pull", "push"],
|
||||
expectTab: "sync",
|
||||
on: { done: "pc-conflict" },
|
||||
},
|
||||
"pc-conflict": {
|
||||
journey: "pull-conflict", step: 3, title: "Rebase stopped on 2 conflicts, 1 with markers left",
|
||||
result: { title: "Pull stopped on 2 conflicts", body: "Replaying `b81e9d4` Filter audit events by actor (1 of 1). Plan2Code resolved `src/web-console/public/audit.js`; `src/web-console/public/audit.css` still has markers." },
|
||||
git: snap({
|
||||
branch: null, detached: "b81e9d4", rebasing: FILTER, upstream: null, inProgress: "rebase",
|
||||
conflicted: [
|
||||
{ path: "src/web-console/public/audit.js", markers: false },
|
||||
{ path: "src/web-console/public/audit.css", markers: true },
|
||||
],
|
||||
rows: branches(FILTER, { ahead: 1, behind: 3 }),
|
||||
}),
|
||||
expect: ["fix", "abort"],
|
||||
expectTab: "sync",
|
||||
on: { continue: "pc-conflict", abort: "pc-diverged", fix: "pc-resolved" },
|
||||
},
|
||||
"pc-resolved": {
|
||||
journey: "pull-conflict", step: 4, title: "Every conflict resolved",
|
||||
git: snap({
|
||||
branch: null, detached: "b81e9d4", rebasing: FILTER, upstream: null, inProgress: "rebase",
|
||||
conflicted: [
|
||||
{ path: "src/web-console/public/audit.js", markers: false },
|
||||
{ path: "src/web-console/public/audit.css", markers: false },
|
||||
],
|
||||
rows: branches(FILTER, { ahead: 1, behind: 3 }),
|
||||
}),
|
||||
expect: ["continue", "abort"],
|
||||
expectTab: "sync",
|
||||
on: { continue: "pc-continuing", abort: "pc-diverged" },
|
||||
},
|
||||
"pc-continuing": {
|
||||
journey: "pull-conflict", step: 5, title: "Continuing the rebase (busy)", busy: "Continuing the rebase",
|
||||
git: snap({
|
||||
branch: null, detached: "b81e9d4", rebasing: FILTER, upstream: null, inProgress: "rebase",
|
||||
conflicted: [
|
||||
{ path: "src/web-console/public/audit.js", markers: false },
|
||||
{ path: "src/web-console/public/audit.css", markers: false },
|
||||
],
|
||||
rows: branches(FILTER, { ahead: 1, behind: 3 }),
|
||||
}),
|
||||
expect: ["continue", "abort"],
|
||||
expectTab: "sync",
|
||||
on: { done: "pc-rebased" },
|
||||
},
|
||||
"pc-rebased": {
|
||||
journey: "pull-conflict", step: 6, title: "Rebased, 1 to push",
|
||||
result: { title: "Pull finished", body: "1 commit replayed on top of origin. Resolved `audit.js` (kept both filters) and `audit.css` (you fixed it). 1 commit ready to push." },
|
||||
git: snap({ branch: FILTER, ahead: 1, prUrl: pr(FILTER) }),
|
||||
expect: ["push", "pr"],
|
||||
expectTab: "sync",
|
||||
on: { push: "pc-pushing" },
|
||||
},
|
||||
"pc-pushing": {
|
||||
journey: "pull-conflict", step: 7, title: "Pushing (busy)", busy: "Pushing 1 commit to origin",
|
||||
git: snap({ branch: FILTER, ahead: 1, prUrl: pr(FILTER) }),
|
||||
expect: ["push", "pr"],
|
||||
expectTab: "sync",
|
||||
on: { done: "pc-pushed" },
|
||||
},
|
||||
"pc-pushed": {
|
||||
journey: "pull-conflict", step: 8, title: "Pushed, pull request ready",
|
||||
result: { title: `Pushed 1 commit to origin/${FILTER}`, body: `\`c42d7e1\`. [Open pull request](${pr(FILTER)})` },
|
||||
git: snap({ branch: FILTER, prUrl: pr(FILTER) }),
|
||||
expect: ["pr", "cleanup"],
|
||||
expectTab: "sync",
|
||||
on: {},
|
||||
},
|
||||
|
||||
/* Edges that break layouts */
|
||||
"e-caught-up": {
|
||||
journey: "edge", title: "All caught up on main",
|
||||
git: snap({ branch: "main", rows: branches("main").map((b) => ({ ...b, merged: false })) }),
|
||||
expect: [null, "create"],
|
||||
expectTab: "sync",
|
||||
expectLine: "All caught up on main · checked 5 min. ago",
|
||||
on: {},
|
||||
},
|
||||
"e-stale": {
|
||||
journey: "edge", title: "All caught up, but last checked 3 hours ago",
|
||||
git: snap({ branch: "main", lastFetch: ago(180), rows: branches("main").map((b) => ({ ...b, merged: false })) }),
|
||||
expect: [null, "create"],
|
||||
expectTab: "sync",
|
||||
expectLine: "All caught up on main · checked 3 hr. ago",
|
||||
on: { refresh: "e-caught-up" },
|
||||
},
|
||||
"e-held-only": {
|
||||
journey: "edge", title: "Caught up except a held-back file",
|
||||
git: snap({ branch: "main", changes: { count: 1, heldBack: 1, files: [{ path: ".env.local", state: "new", staged: false, risky: true }], untrackedDirs: [] }, rows: branches("main").map((b) => ({ ...b, merged: false })) }),
|
||||
expect: [null, "ignore"],
|
||||
expectTab: "changes",
|
||||
on: {},
|
||||
},
|
||||
"e-gone": {
|
||||
journey: "edge", title: "Remote copy deleted",
|
||||
git: snap({ branch: "feature/ABC-11702-old-banner", gone: true }),
|
||||
expect: ["publish", "cleanup"],
|
||||
expectTab: "sync",
|
||||
on: {},
|
||||
},
|
||||
"e-no-remote": {
|
||||
journey: "edge", title: "No remote at all",
|
||||
git: snap({ branch: "main", upstream: null, remotes: [], lastFetch: null, rows: [local("main", { current: true, upstream: null, upstreamRemote: null, ahead: null, behind: null })] }),
|
||||
expect: [null, "create"],
|
||||
expectTab: "sync",
|
||||
expectLine: "Nothing to commit on main · no remote yet",
|
||||
on: {},
|
||||
},
|
||||
"e-first-commit": {
|
||||
journey: "edge", title: "No commits yet",
|
||||
git: snap({
|
||||
branch: "main", hasCommits: false, upstream: null, remotes: [], lastFetch: null, rows: [],
|
||||
changes: { count: 3, heldBack: 0, files: [{ path: "README.md", state: "new", staged: false, risky: false }, { path: "package.json", state: "new", staged: false, risky: false }], untrackedDirs: [{ path: "src/", files: 12 }] },
|
||||
}),
|
||||
expect: ["commit", null],
|
||||
expectTab: "changes",
|
||||
on: {},
|
||||
},
|
||||
"e-detached": {
|
||||
journey: "edge", title: "Detached at a commit",
|
||||
git: snap({ branch: null, detached: "a1b2c3d", upstream: null, rows: branches("main").map((b) => ({ ...b, current: false })) }),
|
||||
expect: ["create", "cleanup"],
|
||||
expectTab: "branches",
|
||||
on: {},
|
||||
},
|
||||
"e-many-branches": {
|
||||
journey: "edge", title: "300 branches, 40 merged",
|
||||
git: snap({
|
||||
branch: "main",
|
||||
rows: [
|
||||
local("main", { current: true }),
|
||||
...Array.from({ length: 120 }, (_, i) =>
|
||||
local(`feature/ABC-${11000 + i}-${["export", "filter", "banner", "login", "audit", "sso"][i % 6]}-${i}`, {
|
||||
merged: i < 40,
|
||||
ahead: i % 7 === 0 ? 2 : 0,
|
||||
behind: i % 5 === 0 ? 4 : 0,
|
||||
last: last(`Work on ABC-${11000 + i}`, ["Justin Parker", "Priya Raman", "Sam Okafor", "Dana Whitfield"][i % 4], 60 * (i + 1)),
|
||||
}),
|
||||
),
|
||||
...Array.from({ length: 179 }, (_, i) => remoteOnly(`feature/ABC-${12100 + i}-remote-${i}`, `Remote work ${i}`, "Dana Whitfield", 60 * 24 + i * 30)),
|
||||
],
|
||||
}),
|
||||
expect: ["cleanup", null],
|
||||
expectTab: "branches",
|
||||
on: {},
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,127 @@
|
||||
// Start a real console and open its page in a real browser, for the page tests
|
||||
// (scripts/test-web-console-page-*.mjs).
|
||||
//
|
||||
// One browser per test file (pageSuite), a fresh console session and browser
|
||||
// context per test (openSession). Sessions run against the file's own console
|
||||
// home from web-console-test-helpers.mjs, in a temp project unless a test
|
||||
// names one. Any uncaught error on the page fails the test that opened it, so
|
||||
// a later split that breaks a screen shows as a named error, not a blank page.
|
||||
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { cli, payload, until, HOME, REMEMBERED } from "./web-console-test-helpers.mjs";
|
||||
import { launchBrowser } from "./browser.mjs";
|
||||
|
||||
// `test` is node:test's test function (or any context with .after): the
|
||||
// browser is launched the first time a test asks for it and closed once the
|
||||
// file is done.
|
||||
export function pageSuite(test) {
|
||||
let launching = null;
|
||||
test.after(async () => {
|
||||
if (launching) await (await launching).close();
|
||||
});
|
||||
return {
|
||||
browser: () => (launching ??= launchBrowser()),
|
||||
};
|
||||
}
|
||||
|
||||
let projects = 0;
|
||||
let payloads = 0;
|
||||
|
||||
// A fresh project folder under the file's console home, removed with it.
|
||||
export function tempProject(files = {}) {
|
||||
const dir = path.join(HOME, "projects", `p${++projects}`);
|
||||
for (const [rel, text] of Object.entries(files)) {
|
||||
fs.mkdirSync(path.dirname(path.join(dir, rel)), { recursive: true });
|
||||
fs.writeFileSync(path.join(dir, rel), text);
|
||||
}
|
||||
fs.mkdirSync(dir, { recursive: true });
|
||||
return dir;
|
||||
}
|
||||
|
||||
// Opens a console session the way an agent does (`console.mjs open`, then
|
||||
// `post`), and its page in a new browser context. Resolves once the page has
|
||||
// drawn from the session's real state, not the boot pane in the markup.
|
||||
// `t` is the test's context: stop() is registered with t.after, so a failing
|
||||
// test still cleans up, and a page error fails the test. `clock: true` gives
|
||||
// the page Playwright's fake clock before it loads (s.page.clock), so a test
|
||||
// can jump past the page's silence limits instead of sitting through them.
|
||||
export async function openSession(browser, { t, workflow, payload: first, project, open = [], clock = false }) {
|
||||
fs.rmSync(REMEMBERED, { force: true });
|
||||
const cwd = project || tempProject();
|
||||
const opened = cli(["open", "--workflow", workflow, "--no-open", ...open], { cwd }).json;
|
||||
const s = {
|
||||
sid: opened.sid,
|
||||
session: opened.session,
|
||||
url: opened.url,
|
||||
project: cwd,
|
||||
errors: [],
|
||||
context: null,
|
||||
page: null,
|
||||
};
|
||||
|
||||
// The agent's side, run from the project like an agent would.
|
||||
s.post = (patch) => {
|
||||
const r = cli(["post", "--session", s.sid, "--file", payload(`page-post-${++payloads}.json`, patch)], { cwd });
|
||||
if (r.status !== 0) throw new Error(`post failed (${r.status}): ${r.stderr}`);
|
||||
return r.json;
|
||||
};
|
||||
s.wait = (seconds = 10) => {
|
||||
const r = cli(["wait", "--session", s.sid, "--seconds", String(seconds)], { cwd });
|
||||
return { code: r.status, ...(r.json || {}) };
|
||||
};
|
||||
// Whether the session's server still answers on its port.
|
||||
s.answers = async () => {
|
||||
try {
|
||||
await fetch(new URL("/health", s.url), { signal: AbortSignal.timeout(1000) });
|
||||
return true;
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
};
|
||||
let stopped = false;
|
||||
s.stop = async () => {
|
||||
if (stopped) return;
|
||||
stopped = true;
|
||||
cli(["stop", "--session", s.sid], { cwd });
|
||||
if (s.context) await s.context.close().catch(() => {});
|
||||
await until(async () => !(await s.answers()), 5000);
|
||||
};
|
||||
t.after(async () => {
|
||||
await s.stop();
|
||||
if (s.errors.length) throw new Error(`uncaught error on the page: ${s.errors[0]}`);
|
||||
});
|
||||
|
||||
if (first) s.post(first);
|
||||
s.context = await browser.newContext({ viewport: { width: 1280, height: 800 } });
|
||||
if (clock) await s.context.clock.install();
|
||||
s.page = await s.context.newPage();
|
||||
s.page.on("pageerror", (e) => s.errors.push(e.message));
|
||||
await s.page.goto(s.url, { waitUntil: "domcontentloaded" });
|
||||
await drawn(s.page);
|
||||
return s;
|
||||
}
|
||||
|
||||
// The page has adopted a state frame: app.js has replaced the boot pane the
|
||||
// markup ships with.
|
||||
export async function drawn(page) {
|
||||
await page.waitForFunction(() => !document.querySelector("#main .boot-pane"), null, { timeout: 15000 });
|
||||
}
|
||||
|
||||
// Presses Send on the page and collects the send the way an agent's `wait`
|
||||
// does: the same JSON an agent receives.
|
||||
export async function sendAndCollect(s) {
|
||||
await s.page.click("#btn-send");
|
||||
const got = s.wait(10);
|
||||
if (got.code !== 0) throw new Error(`nothing was sent (wait exit ${got.code}): ${got.message || ""}`);
|
||||
return got;
|
||||
}
|
||||
|
||||
// The card for one item id.
|
||||
export const itemCard = (page, id) => page.locator(`[data-item="${id}"]`).first();
|
||||
|
||||
// A locator's visible text, trimmed.
|
||||
export const textOf = async (locator) => (await locator.innerText()).trim();
|
||||
|
||||
// The scroll offset of the first element matching `selector`.
|
||||
export const scrollTopOf = (page, selector) => page.$eval(selector, (el) => el.scrollTop);
|
||||
@@ -0,0 +1,48 @@
|
||||
// Parse every shipped browser module as a real ES module.
|
||||
//
|
||||
// `node --check` is not enough: it parses a .js file as a CommonJS script, and
|
||||
// it let a string literal containing a raw newline through to the browser,
|
||||
// where the page died at import with nothing rendered. Importing the source as
|
||||
// a data: module is the same parse the browser does.
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
|
||||
const DIR = path.join(ROOT, "src", "web-console", "public");
|
||||
// Every page module (vendored code aside), found by walking public/ so a new
|
||||
// screen is guarded without editing a list.
|
||||
function pageModules(dir, rel = "") {
|
||||
const out = [];
|
||||
for (const e of fs.readdirSync(path.join(dir, rel), { withFileTypes: true })) {
|
||||
const p = rel ? `${rel}/${e.name}` : e.name;
|
||||
if (e.isDirectory()) {
|
||||
if (p !== "vendor") out.push(...pageModules(dir, p));
|
||||
} else if (e.name.endsWith(".js")) out.push(p);
|
||||
}
|
||||
return out.sort();
|
||||
}
|
||||
const FILES = pageModules(DIR);
|
||||
|
||||
let bad = 0;
|
||||
for (const name of FILES) {
|
||||
const src = fs.readFileSync(path.join(DIR, name), "utf8");
|
||||
try {
|
||||
await import("data:text/javascript," + encodeURIComponent(src));
|
||||
console.log(` ok ${name}`);
|
||||
} catch (err) {
|
||||
// A module that parses but cannot run here (app.js touches `document` at
|
||||
// import, and relative imports cannot resolve from a data: URL) is fine; only a parse failure is a real problem.
|
||||
const parseFailure = err instanceof SyntaxError;
|
||||
if (parseFailure) {
|
||||
bad++;
|
||||
console.error(` FAIL ${name}: ${err.message}`);
|
||||
} else {
|
||||
console.log(` ok ${name} (parsed; not runnable outside a browser)`);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (bad) {
|
||||
console.error(`${bad} file(s) would not parse in a browser.`);
|
||||
process.exit(1);
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
# Screenshot payloads
|
||||
|
||||
Each JSON file here stages one web console screen for the docs, with no agent
|
||||
involved. `node scripts/capture-screenshots.mjs` opens a console session in a
|
||||
throwaway sample project, posts these files, and saves the screens as light
|
||||
and dark WebP images in `docs/screenshots/`.
|
||||
|
||||
| File | Stages |
|
||||
| --- | --- |
|
||||
| `dashboard.json` | The dashboard menu, suggesting the next build phase |
|
||||
| `question.json` | A Plan session with three questions open (also the base of the Ask shot) |
|
||||
| `doc.json` | A living document with settled, assumed and draft sections, and its review card |
|
||||
| `build.json` | A phase being built: the progress bar, the task list and the current task |
|
||||
| `signoff.json` | The completion report and the sign-off card |
|
||||
| `finish.json` | The finished screen after sign-off (posted after `signoff.json`) |
|
||||
| `git.json` | The git board, handed back to you in a sample repository with three changes to commit (the script builds the repository) |
|
||||
|
||||
Refresh every image with `node scripts/capture-screenshots.mjs`, or one with
|
||||
`--only <shot>`.
|
||||
|
||||
## Comparison-only shots
|
||||
|
||||
`--compare` adds the screens the docs never show, so a change to the console
|
||||
can be checked by eye against a "before" set. They are never published: the
|
||||
script refuses `--compare` with an `--out` inside `docs/screenshots/`.
|
||||
|
||||
| File | Stages |
|
||||
| --- | --- |
|
||||
| `stop.json` | A build with a question open, behind the Stop dialog and its handoff choice |
|
||||
| `delete.json` | The dashboard, behind the first step of a spec chip's Delete |
|
||||
| `help.json` | A Plan question, behind Help on its first tab |
|
||||
| `prefs.json` | A Plan question, behind User Preferences |
|
||||
| `cleanup.json` | A Plan question, behind User Preferences scrolled to Cleanup after a scan |
|
||||
| `workspace.json` | A Plan question, behind the Workspace panel with a second folder added (shot last: the console remembers the folder) |
|
||||
|
||||
`node scripts/capture-screenshots.mjs --compare --out <folder outside the repo>`
|
||||
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"workflow": "implement",
|
||||
"title": "task-api: Phase 3",
|
||||
"headline": {
|
||||
"stage": "Phase 3: API endpoints",
|
||||
"cleared": 5,
|
||||
"total": 11
|
||||
},
|
||||
"docs": [
|
||||
{
|
||||
"id": "phase",
|
||||
"title": "Phase 3 tasks",
|
||||
"version": 6,
|
||||
"blocks": [
|
||||
{
|
||||
"id": "tasks",
|
||||
"state": "settled",
|
||||
"md": "- [x] **Task 3.1:** Register the /tasks routes plugin\n- [x] **Task 3.2:** Add GET /tasks with cursor paging\n- [x] **Task 3.3:** Add GET /tasks/:id\n- [x] **Task 3.4:** Add POST /tasks with a Zod schema\n- [x] **Task 3.5:** Add PATCH /tasks/:id for status and fields\n- [ ] **Task 3.6:** Add DELETE /tasks/:id as a soft delete\n- [ ] **Task 3.7:** Filter GET /tasks by status and assignee\n- [ ] **Task 3.8:** Return one error shape for 400, 404 and 409\n- [ ] **Task 3.9:** Document the endpoints in openapi.yaml\n- [ ] **Task 3.10:** Write tests for paging, filters and validation\n- [ ] **Task 3.11:** Run the test suite and record the results"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "phasefile",
|
||||
"title": "phase-3.md",
|
||||
"version": 6,
|
||||
"blocks": [
|
||||
{
|
||||
"id": "body",
|
||||
"state": "settled",
|
||||
"md": "# Phase 3: API endpoints\n\n**Status:** In Progress\n**Estimated Tasks:** 11\n\n## Overview\n\nThe /tasks endpoints: list with paging and filters, read, create, update and soft delete, with one error shape for every failure.\n\n## Prerequisites\n\n- Phase 2 complete (the tasks table and model exist) VERIFIED\n- Postgres runs locally VERIFIED\n\n## Tasks\n\n- [x] **Task 3.1:** Register the /tasks routes plugin\n- [x] **Task 3.2:** Add GET /tasks with cursor paging\n- [x] **Task 3.3:** Add GET /tasks/:id\n- [x] **Task 3.4:** Add POST /tasks with a Zod schema\n- [x] **Task 3.5:** Add PATCH /tasks/:id for status and fields\n- [ ] **Task 3.6:** Add DELETE /tasks/:id as a soft delete\n- [ ] **Task 3.7:** Filter GET /tasks by status and assignee\n- [ ] **Task 3.8:** Return one error shape for 400, 404 and 409\n- [ ] **Task 3.9:** Document the endpoints in openapi.yaml\n- [ ] **Task 3.10:** Write tests for paging, filters and validation\n- [ ] **Task 3.11:** Run the test suite and record the results\n\n## Acceptance Criteria\n\n- Every endpoint validates its input and answers errors in one shape\n- Paging stays stable while tasks are added and removed\n"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "working",
|
||||
"activity": "Task 6 of 11: deleting a task",
|
||||
"quietMinutes": 15
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"workflow": "plan",
|
||||
"title": "Task API",
|
||||
"headline": {
|
||||
"stage": "Step 3 of 7: Signing in",
|
||||
"cleared": 2,
|
||||
"total": 7
|
||||
},
|
||||
"items": [
|
||||
{
|
||||
"id": "q4",
|
||||
"kind": "text",
|
||||
"title": "How callers sign in",
|
||||
"body": "Do callers sign in as a person, or as an app with a key?",
|
||||
"placeholder": "For example: apps use an API key per team."
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"menu": {
|
||||
"note": "task-api is built up to Phase 2 of 4. Phase 3 is next.",
|
||||
"recommend": "plan2code-3-implement",
|
||||
"details": {
|
||||
"plan2code-3-implement": "Phase 3 of 4 is next"
|
||||
}
|
||||
},
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"menu": {
|
||||
"note": "task-api is built up to Phase 2 of 4. Phase 3 is next.",
|
||||
"recommend": "plan2code-3-implement",
|
||||
"details": {
|
||||
"plan2code-3-implement": "Phase 3 of 4 is next"
|
||||
}
|
||||
},
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
{
|
||||
"workflow": "plan",
|
||||
"title": "Task API",
|
||||
"headline": {
|
||||
"stage": "Step 3 of 7: What we've agreed",
|
||||
"cleared": 4,
|
||||
"total": 7,
|
||||
"confidence": "Most of it is settled. Paging is assumed for now."
|
||||
},
|
||||
"docs": [
|
||||
{
|
||||
"id": "map",
|
||||
"title": "What we've agreed",
|
||||
"version": 2,
|
||||
"note": "Added paging",
|
||||
"blocks": [
|
||||
{
|
||||
"id": "b1",
|
||||
"state": "settled",
|
||||
"md": "## Where we're headed\n\nA REST API for a team's tasks: create, list, update and delete them, with filters by status and assignee. Built on Fastify, Postgres and Zod."
|
||||
},
|
||||
{
|
||||
"id": "b2",
|
||||
"state": "assumed",
|
||||
"md": "### Paging\n\nAssuming cursor paging, 50 tasks per page. Still open: the web app may want page numbers."
|
||||
},
|
||||
{
|
||||
"id": "b3",
|
||||
"state": "draft",
|
||||
"md": "### Still to work out\n\n- How clients sign in\n- Whether a deleted task can be restored"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"items": [
|
||||
{
|
||||
"id": "agree",
|
||||
"kind": "review",
|
||||
"title": "Check the plan so far",
|
||||
"doc": "map",
|
||||
"body": "Read what we've agreed, then approve it or say what to change. Paging is marked as assumed.",
|
||||
"verdicts": [
|
||||
{
|
||||
"id": "approve",
|
||||
"label": "Looks right"
|
||||
},
|
||||
{
|
||||
"id": "changes",
|
||||
"label": "I want changes"
|
||||
}
|
||||
],
|
||||
"token": {
|
||||
"approve": "yes",
|
||||
"changes": "needs changes"
|
||||
},
|
||||
"nothingYet": "Nothing is written to disk until you approve.",
|
||||
"fallbackText": "Does what we've agreed look right? Reply yes, or describe what to change."
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"items": [
|
||||
{
|
||||
"id": "signoff",
|
||||
"status": "answered",
|
||||
"answer": {
|
||||
"verdict": "approve"
|
||||
}
|
||||
}
|
||||
],
|
||||
"finish": {
|
||||
"headline": "Phase 3 is built",
|
||||
"body": "11 of 11 tasks, all on disk. Phase 4 (authentication) is next.",
|
||||
"command": "/plan2code-3-implement specs/task-api/overview.md",
|
||||
"doc": "report",
|
||||
"dashboard": true
|
||||
},
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"reread": true,
|
||||
"board": { "describe": "task-schema-and-paging" },
|
||||
"agent": { "status": "waiting" }
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"workflow": "plan",
|
||||
"title": "Task API",
|
||||
"headline": {
|
||||
"stage": "Step 2 of 7: Who calls it",
|
||||
"cleared": 2,
|
||||
"total": 7
|
||||
},
|
||||
"items": [
|
||||
{
|
||||
"id": "q3",
|
||||
"kind": "text",
|
||||
"title": "Who calls the API",
|
||||
"body": "Which apps call the task API first, and what does each need from it?",
|
||||
"placeholder": "For example: the web app lists tasks, the mobile app only updates their status."
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"workflow": "plan",
|
||||
"title": "Task API",
|
||||
"headline": {
|
||||
"stage": "Step 3 of 7: Signing in",
|
||||
"cleared": 2,
|
||||
"total": 7
|
||||
},
|
||||
"items": [
|
||||
{
|
||||
"id": "q4",
|
||||
"kind": "text",
|
||||
"title": "How callers sign in",
|
||||
"body": "Do callers sign in as a person, or as an app with a key?",
|
||||
"placeholder": "For example: apps use an API key per team."
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,117 @@
|
||||
{
|
||||
"workflow": "plan",
|
||||
"title": "Task API",
|
||||
"headline": {
|
||||
"stage": "Step 1 of 7: What we're building",
|
||||
"cleared": 1,
|
||||
"total": 7,
|
||||
"confidence": "A clear idea so far. Who calls the API and how it signs in are still open."
|
||||
},
|
||||
"topics": [
|
||||
{
|
||||
"id": "t1",
|
||||
"title": "What we're building",
|
||||
"status": "current"
|
||||
}
|
||||
],
|
||||
"items": [
|
||||
{
|
||||
"id": "q2",
|
||||
"topic": "t1",
|
||||
"kind": "choice",
|
||||
"title": "How tasks are paged",
|
||||
"body": "A team can have thousands of tasks. How should the list endpoint hand them back?",
|
||||
"options": [
|
||||
{
|
||||
"k": "A",
|
||||
"text": "Cursor paging",
|
||||
"detail": "Stable while tasks are added and removed. No jumping to page 7.",
|
||||
"recommended": true
|
||||
},
|
||||
{
|
||||
"k": "B",
|
||||
"text": "Page numbers",
|
||||
"detail": "Familiar and easy to link to, but rows shift when tasks change mid-scroll."
|
||||
},
|
||||
{
|
||||
"k": "C",
|
||||
"text": "Everything at once",
|
||||
"detail": "Simplest to build; slow and heavy once a team has a few thousand tasks."
|
||||
}
|
||||
],
|
||||
"token": {
|
||||
"A": "a",
|
||||
"B": "b",
|
||||
"C": "c"
|
||||
},
|
||||
"fallbackText": "How tasks are paged: a) cursor paging b) page numbers c) everything at once. My guess: a."
|
||||
},
|
||||
{
|
||||
"id": "q3",
|
||||
"topic": "t1",
|
||||
"kind": "multi",
|
||||
"title": "Day one endpoints",
|
||||
"body": "Which of these should be there on the first day? Anything left unticked waits for a later version.",
|
||||
"options": [
|
||||
{
|
||||
"k": "1",
|
||||
"text": "List and read tasks",
|
||||
"detail": "GET /tasks and GET /tasks/:id, with filters by status and assignee."
|
||||
},
|
||||
{
|
||||
"k": "2",
|
||||
"text": "Create and update tasks",
|
||||
"detail": "POST /tasks and PATCH /tasks/:id, validated."
|
||||
},
|
||||
{
|
||||
"k": "3",
|
||||
"text": "Delete tasks",
|
||||
"detail": "A soft delete, so a task can come back."
|
||||
},
|
||||
{
|
||||
"k": "4",
|
||||
"text": "Comments on a task",
|
||||
"detail": "A thread under each task. Doubles the data model."
|
||||
}
|
||||
],
|
||||
"presets": [
|
||||
{
|
||||
"label": "The essentials",
|
||||
"ks": [
|
||||
"1",
|
||||
"2"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "Everything",
|
||||
"ks": [
|
||||
"1",
|
||||
"2",
|
||||
"3",
|
||||
"4"
|
||||
]
|
||||
}
|
||||
],
|
||||
"token": {
|
||||
"1": "1",
|
||||
"2": "2",
|
||||
"3": "3",
|
||||
"4": "4"
|
||||
},
|
||||
"fallbackText": "Day one endpoints (pick any): 1) list and read 2) create and update 3) delete 4) comments on a task."
|
||||
},
|
||||
{
|
||||
"id": "q4",
|
||||
"topic": "t1",
|
||||
"kind": "text",
|
||||
"title": "Who calls it",
|
||||
"body": "Which apps will call this API, and roughly how many people use them?",
|
||||
"placeholder": "For example: our web app and a mobile app, about 2,000 people across 40 teams.",
|
||||
"token": {},
|
||||
"fallbackText": "Who calls it: which apps will call this API, and roughly how many people use them?"
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,88 @@
|
||||
{
|
||||
"workflow": "implement",
|
||||
"title": "task-api: Phase 3",
|
||||
"headline": {
|
||||
"stage": "Phase 3: API endpoints",
|
||||
"cleared": 11,
|
||||
"total": 11
|
||||
},
|
||||
"docs": [
|
||||
{
|
||||
"id": "phase",
|
||||
"title": "Phase 3 tasks",
|
||||
"version": 12,
|
||||
"blocks": [
|
||||
{
|
||||
"id": "tasks",
|
||||
"state": "settled",
|
||||
"md": "- [x] **Task 3.1:** Register the /tasks routes plugin\n- [x] **Task 3.2:** Add GET /tasks with cursor paging\n- [x] **Task 3.3:** Add GET /tasks/:id\n- [x] **Task 3.4:** Add POST /tasks with a Zod schema\n- [x] **Task 3.5:** Add PATCH /tasks/:id for status and fields\n- [x] **Task 3.6:** Add DELETE /tasks/:id as a soft delete\n- [x] **Task 3.7:** Filter GET /tasks by status and assignee\n- [x] **Task 3.8:** Return one error shape for 400, 404 and 409\n- [x] **Task 3.9:** Document the endpoints in openapi.yaml\n- [x] **Task 3.10:** Write tests for paging, filters and validation\n- [x] **Task 3.11:** Run the test suite and record the results"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "report",
|
||||
"title": "Completion report",
|
||||
"version": 1,
|
||||
"blocks": [
|
||||
{
|
||||
"id": "summary",
|
||||
"state": "settled",
|
||||
"md": "## Summary\n\nThe /tasks endpoints work end to end. Clients can list tasks with cursor paging and filters, read one, create, update and soft delete, and every failure comes back in the same error shape.\n\n**Tasks:** 11 of 11 done, none blocked."
|
||||
},
|
||||
{
|
||||
"id": "tests",
|
||||
"state": "settled",
|
||||
"md": "## Tests\n\n| Suite | Passed | Failed |\n| --- | --- | --- |\n| tasks | 31 | 0 |\n| paging | 8 | 0 |"
|
||||
},
|
||||
{
|
||||
"id": "files",
|
||||
"state": "settled",
|
||||
"md": "## Files\n\n**Created:** `src/tasks/routes.js`, `src/tasks/schema.js`, `src/tasks/paginate.js`, `test/tasks.test.js`\n\n**Modified:** `src/app.js`, `openapi.yaml`"
|
||||
},
|
||||
{
|
||||
"id": "verify",
|
||||
"state": "settled",
|
||||
"md": "## How to check it\n\n1. Run `npm test`: 39 passing.\n2. Create two tasks, then call `GET /tasks?limit=1`: one task and a `nextCursor`.\n3. `PATCH /tasks/:id` with an unknown status answers 400 in the shared error shape."
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"items": [
|
||||
{
|
||||
"id": "signoff",
|
||||
"kind": "review",
|
||||
"title": "Approve this phase",
|
||||
"doc": "report",
|
||||
"body": "Phase 3 is built. Read the report, try the checks, then approve it, review the code first, or say what to change.",
|
||||
"verdicts": [
|
||||
{
|
||||
"id": "review",
|
||||
"label": "Review the code first"
|
||||
},
|
||||
{
|
||||
"id": "approve",
|
||||
"label": "Approve this phase"
|
||||
},
|
||||
{
|
||||
"id": "changes",
|
||||
"label": "I want changes"
|
||||
}
|
||||
],
|
||||
"token": {
|
||||
"review": "review",
|
||||
"approve": "approved",
|
||||
"changes": "needs changes"
|
||||
},
|
||||
"nothingYet": "Nothing is marked complete until you approve.",
|
||||
"gate": {
|
||||
"id": "signoff",
|
||||
"authoritative": true
|
||||
},
|
||||
"fallbackText": "Reply \"approved\" to mark this phase complete, \"review\" to run the code review first, or describe any issues."
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting",
|
||||
"quietMinutes": null
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"workflow": "implement",
|
||||
"title": "task-api: Phase 3",
|
||||
"specDir": "specs/task-api",
|
||||
"headline": {
|
||||
"stage": "Phase 3: API endpoints",
|
||||
"cleared": 2,
|
||||
"total": 4
|
||||
},
|
||||
"docs": [
|
||||
{
|
||||
"id": "phase",
|
||||
"title": "Phase 3 tasks",
|
||||
"blocks": [
|
||||
{
|
||||
"id": "tasks",
|
||||
"state": "settled",
|
||||
"md": "- [x] **Task 3.1:** Add GET /tasks with cursor paging\n- [x] **Task 3.2:** Add POST /tasks\n- [ ] **Task 3.3:** Add PATCH /tasks/:id\n- [ ] **Task 3.4:** Add DELETE /tasks/:id"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"items": [
|
||||
{
|
||||
"id": "keep",
|
||||
"kind": "confirm",
|
||||
"title": "Tests are failing",
|
||||
"body": "Two paging tests fail after Task 3.2. Fix them before going on?",
|
||||
"yesLabel": "Fix them now",
|
||||
"noLabel": "Note them and go on"
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"workflow": "plan",
|
||||
"title": "Task API",
|
||||
"headline": {
|
||||
"stage": "Step 2 of 7: Who calls it",
|
||||
"cleared": 2,
|
||||
"total": 7
|
||||
},
|
||||
"items": [
|
||||
{
|
||||
"id": "q3",
|
||||
"kind": "text",
|
||||
"title": "Who calls the API",
|
||||
"body": "Which apps call the task API first, and what does each need from it?",
|
||||
"placeholder": "For example: the web app lists tasks, the mobile app only updates their status."
|
||||
}
|
||||
],
|
||||
"agent": {
|
||||
"status": "waiting"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,108 @@
|
||||
// Shared helpers for the skill-script tests (scripts/test-*script*.mjs).
|
||||
//
|
||||
// The tests run the scripts the way an agent does: as `node <skill>/scripts/x.mjs`
|
||||
// from the built skills/ tree, against throwaway fixtures in the OS temp dir,
|
||||
// with the clock pinned by PLAN2CODE_NOW. They live in scripts/ so nothing
|
||||
// here ships.
|
||||
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawnSync, execFileSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
export const ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
|
||||
export const SKILLS = path.join(ROOT, "skills");
|
||||
export const NOW = "2026-08-03 14:05";
|
||||
|
||||
export { copyFixture, slashed, fixtureCleanup } from "./fixture-helpers.mjs";
|
||||
|
||||
// Rebuild skills/ on every import, not only when it is missing: a test file run
|
||||
// directly after an edit to src/ must not test a stale tree. The build is
|
||||
// idempotent and takes over a second, once per test file, so `npm test`, whose
|
||||
// script has just built the tree before `node --test`, skips it: npm sets
|
||||
// npm_lifecycle_event for every script it runs.
|
||||
if (process.env.npm_lifecycle_event !== "test") {
|
||||
execFileSync(process.execPath, [path.join(ROOT, "install.js"), "--build-skills"], { stdio: "ignore" });
|
||||
}
|
||||
|
||||
// Env a spawned script or printed git command must not inherit: relocation
|
||||
// vars (GIT_DIR and friends) would redirect every fixture command, a
|
||||
// developer's global git config can perturb printed commands, and stray
|
||||
// SSH_*/PLAN2CODE_* vars change what the scripts report.
|
||||
const AMBIENT_GIT_ENV = [
|
||||
"GIT_DIR",
|
||||
"GIT_WORK_TREE",
|
||||
"GIT_INDEX_FILE",
|
||||
"GIT_COMMON_DIR",
|
||||
"GIT_OBJECT_DIRECTORY",
|
||||
"GIT_CONFIG",
|
||||
"GIT_CONFIG_GLOBAL",
|
||||
"GIT_CONFIG_SYSTEM",
|
||||
"GIT_CONFIG_NOSYSTEM",
|
||||
"SSH_CONNECTION",
|
||||
"PLAN2CODE_PICKER_ECHO",
|
||||
];
|
||||
|
||||
// GIT_CONFIG_GLOBAL wants a real path: os.devNull is `\\.\nul` here, which git
|
||||
// cannot open. An empty file is the portable "no global config".
|
||||
const EMPTY_GITCONFIG = path.join(os.tmpdir(), "p2c-empty-gitconfig");
|
||||
try {
|
||||
fs.writeFileSync(EMPTY_GITCONFIG, "");
|
||||
} catch {}
|
||||
|
||||
export function scrubbedEnv(extra = {}) {
|
||||
const e = { ...process.env };
|
||||
for (const k of AMBIENT_GIT_ENV) delete e[k];
|
||||
return { ...e, GIT_CONFIG_NOSYSTEM: "1", GIT_CONFIG_GLOBAL: EMPTY_GITCONFIG, ...extra };
|
||||
}
|
||||
|
||||
// Every git in a test process that imports this file runs under that same
|
||||
// scrubbed config: fixture commands, the modules a test imports and the
|
||||
// scripts it spawns. Mixed configs disagree: a global core.autocrlf=true once
|
||||
// checked fixtures out with CRLF that the scrubbed scripts read as changed.
|
||||
for (const k of AMBIENT_GIT_ENV) delete process.env[k];
|
||||
Object.assign(process.env, { GIT_CONFIG_NOSYSTEM: "1", GIT_CONFIG_GLOBAL: EMPTY_GITCONFIG });
|
||||
|
||||
export function runScript(skill, script, args, { cwd, env } = {}) {
|
||||
const r = spawnSync(process.execPath, [path.join(SKILLS, skill, "scripts", script), ...args], {
|
||||
cwd: cwd || ROOT,
|
||||
encoding: "utf8",
|
||||
env: scrubbedEnv({ PLAN2CODE_NOW: NOW, ...env }),
|
||||
});
|
||||
let json = null;
|
||||
try {
|
||||
json = JSON.parse(r.stdout);
|
||||
} catch {}
|
||||
return { code: r.status, json, stdout: r.stdout, stderr: r.stderr };
|
||||
}
|
||||
|
||||
export function tmp(name) {
|
||||
return fs.mkdtempSync(path.join(fs.realpathSync.native(os.tmpdir()), `p2c-${name}-`));
|
||||
}
|
||||
|
||||
export function write(root, rel, content) {
|
||||
const p = path.join(root, rel);
|
||||
fs.mkdirSync(path.dirname(p), { recursive: true });
|
||||
fs.writeFileSync(p, content);
|
||||
return p;
|
||||
}
|
||||
|
||||
export const read = (root, rel) => fs.readFileSync(path.join(root, rel), "utf8");
|
||||
|
||||
/** A git runner for `dir`, under the scrubbed config set beside `scrubbedEnv`. */
|
||||
export const gitIn = (dir) => (...a) => execFileSync("git", a, { cwd: dir, stdio: "pipe", encoding: "utf8" });
|
||||
|
||||
export function gitInit(dir, branch = "main") {
|
||||
const g = gitIn(dir);
|
||||
g("init", "-q", "-b", branch);
|
||||
g("config", "user.email", "t@example.com");
|
||||
g("config", "user.name", "Test");
|
||||
g("config", "commit.gpgsign", "false");
|
||||
return g;
|
||||
}
|
||||
|
||||
/** A phase-N.md in the Documentation template's shape. tasks: [[marker, id], ...] */
|
||||
export function phase(n, status, tasks, extra = "") {
|
||||
return `# Phase ${n}: Name ${n}\n\n**Status:** ${status}\n**Estimated Tasks:** ${tasks.length}\n\n## Overview\n\nPhase ${n} builds the thing. More words here.\n\n## Prerequisites\n\n- Something exists\n\n## Tasks\n\n${tasks.map(([m, id]) => `- [${m}] **Task ${id}:** Do ${id}`).join("\n")}\n${extra}\n## Acceptance Criteria\n\n- It works\n`;
|
||||
}
|
||||
@@ -0,0 +1,142 @@
|
||||
// Tests for the shared browser helper (scripts/browser.mjs) and the two dev
|
||||
// scripts that launch a browser through it. Run with:
|
||||
// node --test scripts/test-browser-helper.mjs
|
||||
//
|
||||
// The unit cases hand findBrowser() a fake `exists`, so they run anywhere. The
|
||||
// live cases launch a real Chrome or Edge and skip when none is installed.
|
||||
|
||||
import test from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
||||
|
||||
test("playwright-core is pinned exactly in the root devDependencies", () => {
|
||||
const pkg = JSON.parse(fs.readFileSync(path.join(ROOT, "package.json"), "utf8"));
|
||||
assert.equal(pkg.devDependencies["playwright-core"], "1.64.1");
|
||||
});
|
||||
|
||||
// A fake file system holding only `present`.
|
||||
const only = (...present) => (p) => present.includes(p);
|
||||
|
||||
test("findBrowser picks Chrome, then Edge, and honours PLAN2CODE_TEST_BROWSER", async () => {
|
||||
const { findBrowser, BROWSER_PATHS } = await import("./browser.mjs");
|
||||
const chrome = BROWSER_PATHS.chrome[0];
|
||||
const edge = BROWSER_PATHS.msedge[0];
|
||||
|
||||
assert.deepEqual(findBrowser({ env: {}, exists: only(edge) }), { channel: "msedge", path: edge });
|
||||
assert.deepEqual(findBrowser({ env: {}, exists: only(chrome, edge) }), { channel: "chrome", path: chrome });
|
||||
assert.deepEqual(findBrowser({ env: { PLAN2CODE_TEST_BROWSER: "msedge" }, exists: only(chrome, edge) }), { channel: "msedge", path: edge });
|
||||
assert.deepEqual(findBrowser({ env: { PLAN2CODE_TEST_BROWSER: "chrome" }, exists: only(edge) }), null);
|
||||
assert.deepEqual(findBrowser.checked, BROWSER_PATHS.chrome);
|
||||
assert.throws(() => findBrowser({ env: { PLAN2CODE_TEST_BROWSER: "firefox" }, exists: only(chrome) }), (e) => /chrome/.test(e.message) && /msedge/.test(e.message));
|
||||
|
||||
assert.equal(findBrowser({ env: {}, exists: only() }), null);
|
||||
assert.deepEqual(findBrowser.checked, [...BROWSER_PATHS.chrome, ...BROWSER_PATHS.msedge]);
|
||||
});
|
||||
|
||||
test("browserProblem says what is missing in one line of our own words", async () => {
|
||||
const { browserProblem } = await import("./browser.mjs");
|
||||
const found = { channel: "chrome", path: "C:\chrome.exe" };
|
||||
|
||||
const oldNode = browserProblem({ nodeVersion: "18.19.0", found });
|
||||
assert.equal(oldNode, "Page tests need Node 20 or newer (this is 18.19.0). Users of Plan2Code still only need Node 18.");
|
||||
|
||||
const checked = ["C:\a\chrome.exe", "/usr/bin/microsoft-edge"];
|
||||
const none = browserProblem({ nodeVersion: "24.12.0", found: null, checked });
|
||||
assert.match(none, /^Page tests need Chrome or Edge\. Looked in: /);
|
||||
for (const p of checked) assert.ok(none.includes(p), `names ${p}`);
|
||||
assert.ok(none.endsWith("Install either one, or set PLAN2CODE_TEST_BROWSER."));
|
||||
|
||||
assert.equal(browserProblem({ nodeVersion: "24.12.0", found }), null);
|
||||
for (const line of [oldNode, none]) {
|
||||
assert.ok(!line.includes("\n"));
|
||||
assert.ok(!line.includes("playwright install"));
|
||||
}
|
||||
});
|
||||
|
||||
test("launchBrowser fails with our one line when the forced browser is missing", async () => {
|
||||
const { launchBrowser, BROWSER_PATHS } = await import("./browser.mjs");
|
||||
const edgeOnly = only(BROWSER_PATHS.msedge[0]);
|
||||
await assert.rejects(launchBrowser({}, { env: { PLAN2CODE_TEST_BROWSER: "chrome" }, exists: edgeOnly }), (e) => {
|
||||
assert.equal(e.browserProblem, true);
|
||||
assert.match(e.message, /^Page tests need Chrome or Edge\. Looked in: /);
|
||||
assert.ok(!e.message.includes("\n"));
|
||||
return true;
|
||||
});
|
||||
});
|
||||
|
||||
test("launchBrowser opens a page in the installed browser", async (t) => {
|
||||
const { launchBrowser, findBrowser } = await import("./browser.mjs");
|
||||
if (!findBrowser()) return t.skip("no Chrome or Edge installed");
|
||||
const browser = await launchBrowser();
|
||||
try {
|
||||
const page = await browser.newPage();
|
||||
await page.goto("data:text/html,<p>ok</p>");
|
||||
assert.equal(await page.textContent("p"), "ok");
|
||||
} finally {
|
||||
await browser.close();
|
||||
}
|
||||
});
|
||||
|
||||
// Width and height from a WebP file's first chunk (lossy VP8, lossless VP8L,
|
||||
// or the extended VP8X header).
|
||||
function webpSize(buf) {
|
||||
assert.equal(buf.toString("ascii", 0, 4), "RIFF");
|
||||
assert.equal(buf.toString("ascii", 8, 12), "WEBP");
|
||||
const chunk = buf.toString("ascii", 12, 16);
|
||||
if (chunk === "VP8 ") return { width: buf.readUInt16LE(26) & 0x3fff, height: buf.readUInt16LE(28) & 0x3fff };
|
||||
if (chunk === "VP8L") {
|
||||
const bits = buf.readUInt32LE(21);
|
||||
return { width: (bits & 0x3fff) + 1, height: ((bits >> 14) & 0x3fff) + 1 };
|
||||
}
|
||||
if (chunk === "VP8X") return { width: buf.readUIntLE(24, 3) + 1, height: buf.readUIntLE(27, 3) + 1 };
|
||||
throw new Error(`unknown WebP chunk ${chunk}`);
|
||||
}
|
||||
|
||||
const CAPTURE = path.join(ROOT, "scripts", "capture-screenshots.mjs");
|
||||
|
||||
test("capture-screenshots writes both themes as 2560x1600 WebP (slow)", { timeout: 120000 }, async (t) => {
|
||||
const { findBrowser } = await import("./browser.mjs");
|
||||
if (!findBrowser()) return t.skip("no Chrome or Edge installed");
|
||||
const out = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-shots-test-"));
|
||||
try {
|
||||
const r = spawnSync(process.execPath, [CAPTURE, "--only", "question", "--out", out], { encoding: "utf8", timeout: 110000 });
|
||||
assert.equal(r.status, 0, r.stderr || r.stdout);
|
||||
for (const theme of ["light", "dark"]) {
|
||||
const buf = fs.readFileSync(path.join(out, `question-${theme}.webp`));
|
||||
assert.deepEqual(webpSize(buf), { width: 2560, height: 1600 });
|
||||
}
|
||||
} finally {
|
||||
fs.rmSync(out, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
test("capture-screenshots --compare refuses to write into docs/screenshots", () => {
|
||||
// A shot that does not exist: were the guard ever to break, the run would
|
||||
// stop at "Unknown shot" (which never names docs/screenshots) rather than
|
||||
// shoot every screen into the published folder.
|
||||
const argv = [CAPTURE, "--compare", "--only", "__no-such-shot__", "--out", path.join(ROOT, "docs", "screenshots")];
|
||||
const r = spawnSync(process.execPath, argv, { encoding: "utf8", timeout: 30000 });
|
||||
assert.notEqual(r.status, 0);
|
||||
const lines = r.stderr.trim().split("\n");
|
||||
assert.equal(lines.length, 1, r.stderr);
|
||||
assert.match(lines[0], /docs[\\/]screenshots/);
|
||||
});
|
||||
|
||||
test("capture-screenshots --compare shoots the comparison-only screens (slow)", { timeout: 120000 }, async (t) => {
|
||||
const { findBrowser } = await import("./browser.mjs");
|
||||
if (!findBrowser()) return t.skip("no Chrome or Edge installed");
|
||||
const out = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-compare-test-"));
|
||||
try {
|
||||
const r = spawnSync(process.execPath, [CAPTURE, "--compare", "--only", "help", "--out", out], { encoding: "utf8", timeout: 110000 });
|
||||
assert.equal(r.status, 0, r.stderr || r.stdout);
|
||||
for (const theme of ["light", "dark"]) assert.ok(fs.statSync(path.join(out, `help-${theme}.webp`)).size > 0);
|
||||
} finally {
|
||||
fs.rmSync(out, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
@@ -0,0 +1,54 @@
|
||||
// Keeps the "Before you start" guidance identical in meaning across the newcomer docs.
|
||||
import { test } from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const ROOT = join(dirname(fileURLToPath(import.meta.url)), '..');
|
||||
const DOCS = ['README.md', 'docs/index.html', 'QUICK-REFERENCE.md', '.readme/walkthrough.md'];
|
||||
// Docs that carry the install command themselves; the walkthrough links to the README for it.
|
||||
const WITH_INSTALL = new Set(['README.md', 'docs/index.html', 'QUICK-REFERENCE.md']);
|
||||
const EM_DASH = String.fromCharCode(0x2014);
|
||||
|
||||
function read(file) {
|
||||
return readFileSync(join(ROOT, file), 'utf8');
|
||||
}
|
||||
|
||||
// The first "Before you start" block: from its heading to the next heading (Markdown)
|
||||
// or the end of its container (HTML).
|
||||
function blockOf(file) {
|
||||
const text = read(file);
|
||||
const start = text.search(/^#{2,3} Before you start$|<h3>Before you start<\/h3>/m);
|
||||
assert.ok(start >= 0, `${file} has no "Before you start" block`);
|
||||
const rest = text.slice(start);
|
||||
const body = rest.indexOf('\n') + 1;
|
||||
const next = file.endsWith('.html') ? rest.indexOf('</div>') : rest.slice(body).search(/^#{1,3} /m);
|
||||
const end = file.endsWith('.html') ? next : next < 0 ? -1 : body + next;
|
||||
return end > 0 ? rest.slice(0, end) : rest;
|
||||
}
|
||||
|
||||
for (const file of DOCS) {
|
||||
test(`${file} tells a newcomer how to get started`, () => {
|
||||
const block = blockOf(file);
|
||||
for (const needle of ['Node.js 18', 'node --version', 'nodejs.org', '/plan2code', '$plan2code']) {
|
||||
assert.ok(block.includes(needle), `${file} is missing "${needle}" in its "Before you start" block`);
|
||||
}
|
||||
assert.match(block, /project you want to (work on|work in)/, `${file} does not say to start from your project`);
|
||||
assert.ok(!block.includes(EM_DASH), `${file} has an em dash in its "Before you start" block`);
|
||||
});
|
||||
|
||||
if (!WITH_INSTALL.has(file)) continue;
|
||||
test(`${file} puts the guidance before the install command`, () => {
|
||||
const text = read(file);
|
||||
const guide = text.indexOf('Before you start');
|
||||
const install = text.indexOf('npx --allow-git');
|
||||
assert.ok(guide >= 0 && install >= 0 && guide < install, `${file}: "Before you start" must come before the npx line`);
|
||||
});
|
||||
|
||||
test(`${file} says what a silent install means and how to see why`, () => {
|
||||
const text = read(file);
|
||||
assert.match(text, /no output at all/, `${file} does not say what no output means`);
|
||||
assert.ok(text.includes('git ls-remote https://github.com/jparkerweb/plan2code.git'), `${file} is missing the git ls-remote check`);
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,411 @@
|
||||
// Tests for src/web-console/git-repo.mjs, the one read-only git reader.
|
||||
//
|
||||
// It ships inside the web console, not a skill's scripts/, so these import it
|
||||
// directly and run it against throwaway repos in the OS temp dir. A bare repo
|
||||
// stands in for origin, so pushes, [gone] branches and rebase conflicts all
|
||||
// reproduce locally.
|
||||
|
||||
import { test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { execFileSync } from "node:child_process";
|
||||
import { tmp, write, gitInit, gitIn, copyFixture, slashed, fixtureCleanup } from "./skill-script-helpers.mjs";
|
||||
import {
|
||||
countPending,
|
||||
gitFloor,
|
||||
parseRemoteUrl,
|
||||
parseStatusV2,
|
||||
prUrl,
|
||||
readChanges,
|
||||
snapshot,
|
||||
} from "../src/web-console/git-repo.mjs";
|
||||
|
||||
// A repo with one commit on `branch`, and its git runner.
|
||||
// Built once per branch and copied for each test (fixture-helpers.mjs).
|
||||
test.after(fixtureCleanup);
|
||||
const commitIn = (dir, branch) => {
|
||||
const g = gitInit(dir, branch);
|
||||
write(dir, "a.txt", "a\n");
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", "init");
|
||||
};
|
||||
function repoWithCommit(name, branch = "main") {
|
||||
const repo = copyFixture(name, `commit:${branch}`, (dir) => commitIn(dir, branch));
|
||||
return { repo, g: gitIn(repo) };
|
||||
}
|
||||
|
||||
function bareRemote(name = "origin") {
|
||||
return copyFixture(name, "bare", (dir) => execFileSync("git", ["init", "-q", "--bare", "-b", "main", dir], { stdio: "pipe" }));
|
||||
}
|
||||
|
||||
// A second clone of `bare`, for pushing from somewhere else.
|
||||
function cloneOf(bare, name) {
|
||||
const dir = path.join(tmp(name), "clone");
|
||||
execFileSync("git", ["clone", "-q", bare, dir], { stdio: "pipe" });
|
||||
const g = (...a) => execFileSync("git", a, { cwd: dir, stdio: "pipe", encoding: "utf8" });
|
||||
g("config", "user.email", "t@example.com");
|
||||
g("config", "user.name", "Test");
|
||||
g("config", "commit.gpgsign", "false");
|
||||
return { dir, g };
|
||||
}
|
||||
|
||||
// A repo whose main is pushed to a bare origin.
|
||||
function repoWithOrigin(name) {
|
||||
const base = copyFixture(name, "origin", (dir) => {
|
||||
const repo = path.join(dir, "repo");
|
||||
const bare = path.join(dir, "origin.git");
|
||||
fs.mkdirSync(repo);
|
||||
commitIn(repo, "main");
|
||||
execFileSync("git", ["init", "-q", "--bare", "-b", "main", bare], { stdio: "pipe" });
|
||||
const g = gitIn(repo);
|
||||
g("remote", "add", "origin", slashed(bare));
|
||||
g("push", "-q", "-u", "origin", "main");
|
||||
});
|
||||
const repo = path.join(base, "repo");
|
||||
return { repo, g: gitIn(repo), bare: path.join(base, "origin.git") };
|
||||
}
|
||||
|
||||
const branch = (snap, name) => snap.branches.find((b) => b.name === name);
|
||||
|
||||
/* ======================================================== parseStatusV2 */
|
||||
|
||||
test("parseStatusV2: an initial commit has no oid and no commits", () => {
|
||||
const p = parseStatusV2("# branch.oid (initial)\0# branch.head main\0? new.txt\0");
|
||||
assert.equal(p.oid, null);
|
||||
assert.equal(p.hasCommits, false);
|
||||
assert.equal(p.branch, "main");
|
||||
assert.equal(p.upstream, null);
|
||||
assert.equal(p.ahead, null);
|
||||
assert.equal(p.behind, null);
|
||||
assert.deepEqual(p.files, [{ path: "new.txt", index: " ", worktree: "?", state: "new" }]);
|
||||
});
|
||||
|
||||
test("parseStatusV2: a detached HEAD has no branch", () => {
|
||||
const p = parseStatusV2("# branch.oid 0123456789abcdef0123456789abcdef01234567\0# branch.head (detached)\0");
|
||||
assert.equal(p.branch, null);
|
||||
assert.equal(p.hasCommits, true);
|
||||
assert.equal(p.oid, "0123456789abcdef0123456789abcdef01234567");
|
||||
});
|
||||
|
||||
test("parseStatusV2: branch.ab gives ahead and behind against the upstream", () => {
|
||||
const p = parseStatusV2(
|
||||
"# branch.oid 0123456789abcdef0123456789abcdef01234567\0# branch.head feature/x\0# branch.upstream origin/feature/x\0# branch.ab +2 -1\0",
|
||||
);
|
||||
assert.equal(p.branch, "feature/x");
|
||||
assert.equal(p.upstream, "origin/feature/x");
|
||||
assert.equal(p.ahead, 2);
|
||||
assert.equal(p.behind, 1);
|
||||
});
|
||||
|
||||
test("parseStatusV2: a rename consumes its NUL-separated original path, and letters map . to a space", () => {
|
||||
const h = "0123456789abcdef0123456789abcdef01234567";
|
||||
const text = [
|
||||
"# branch.oid " + h,
|
||||
"# branch.head main",
|
||||
`1 .M N... 100644 100644 100644 ${h} ${h} src/a file.js`,
|
||||
`2 R. N... 100644 100644 100644 ${h} ${h} R100 new name.txt`,
|
||||
"old name.txt",
|
||||
`1 D. N... 100644 000000 000000 ${h} ${h} gone.txt`,
|
||||
`1 A. N... 000000 100644 100644 ${h} ${h} added.txt`,
|
||||
"! ignored.log",
|
||||
"",
|
||||
].join("\0");
|
||||
const p = parseStatusV2(text);
|
||||
assert.deepEqual(p.files, [
|
||||
{ path: "src/a file.js", index: " ", worktree: "M", state: "modified" },
|
||||
{ path: "new name.txt", index: "R", worktree: " ", state: "renamed", origPath: "old name.txt" },
|
||||
{ path: "gone.txt", index: "D", worktree: " ", state: "deleted" },
|
||||
{ path: "added.txt", index: "A", worktree: " ", state: "new" },
|
||||
]);
|
||||
});
|
||||
|
||||
test("parseStatusV2: an unmerged entry goes only into conflicted", () => {
|
||||
const h = "0123456789abcdef0123456789abcdef01234567";
|
||||
const p = parseStatusV2(`# branch.oid ${h}\0# branch.head main\0u UU N... 100644 100644 100644 100644 ${h} ${h} ${h} both.txt\0`);
|
||||
assert.deepEqual(p.conflicted, [{ path: "both.txt", status: "UU" }]);
|
||||
assert.deepEqual(p.files, []);
|
||||
});
|
||||
|
||||
test("parseStatusV2: an untracked folder keeps its trailing slash", () => {
|
||||
const p = parseStatusV2("# branch.oid (initial)\0# branch.head main\0? dist/\0");
|
||||
assert.equal(p.files[0].path, "dist/");
|
||||
assert.equal(p.files[0].worktree, "?");
|
||||
});
|
||||
|
||||
/* ========================================================== readChanges */
|
||||
|
||||
test("readChanges: staged after git add, unstaged otherwise", () => {
|
||||
const { repo, g } = repoWithCommit("gr-staged");
|
||||
write(repo, "b.txt", "b\n");
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", "b");
|
||||
write(repo, "a.txt", "changed\n");
|
||||
write(repo, "b.txt", "changed\n");
|
||||
g("add", "a.txt");
|
||||
const status = execFileSync("git", ["status", "--porcelain=v2", "-z", "--branch"], { cwd: repo, encoding: "utf8" });
|
||||
const changes = readChanges(repo, parseStatusV2(status));
|
||||
const byPath = Object.fromEntries(changes.files.map((f) => [f.path, f]));
|
||||
assert.equal(byPath["a.txt"].staged, true);
|
||||
assert.equal(byPath["b.txt"].staged, false);
|
||||
assert.equal(changes.count, 2);
|
||||
assert.equal(changes.heldBack, 0);
|
||||
});
|
||||
|
||||
/* ======================================================= snapshot: repos */
|
||||
|
||||
test("snapshot: ahead after a local commit, behind after a push from a second clone", () => {
|
||||
const { repo, g, bare } = repoWithOrigin("gr-ab");
|
||||
write(repo, "a.txt", "local\n");
|
||||
g("commit", "-q", "-am", "local");
|
||||
let s = snapshot(repo);
|
||||
assert.equal(s.repo, true);
|
||||
assert.equal(s.head.branch, "main");
|
||||
assert.equal(s.head.upstream, "origin/main");
|
||||
assert.equal(s.head.ahead, 1);
|
||||
assert.equal(s.head.behind, 0);
|
||||
assert.equal(branch(s, "main").ahead, 1);
|
||||
|
||||
const other = cloneOf(bare, "gr-ab-other");
|
||||
write(other.dir, "c.txt", "c\n");
|
||||
other.g("add", "-A");
|
||||
other.g("commit", "-q", "-m", "remote");
|
||||
other.g("push", "-q", "origin", "main");
|
||||
g("fetch", "-q");
|
||||
s = snapshot(repo);
|
||||
assert.equal(s.head.ahead, 1);
|
||||
assert.equal(s.head.behind, 1);
|
||||
const main = branch(s, "main");
|
||||
assert.deepEqual([main.ahead, main.behind, main.gone], [1, 1, false]);
|
||||
assert.equal(main.default, true);
|
||||
assert.equal(main.upstreamRemote, "origin");
|
||||
assert.equal(main.last.subject, "local");
|
||||
assert.equal(main.last.author, "Test");
|
||||
assert.equal(typeof s.lastFetch, "string", "a fetch leaves FETCH_HEAD");
|
||||
});
|
||||
|
||||
test("snapshot: a branch whose remote copy was deleted and pruned is gone", () => {
|
||||
const { repo, g, bare } = repoWithOrigin("gr-gone");
|
||||
g("switch", "-q", "-c", "feature/x");
|
||||
write(repo, "x.txt", "x\n");
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", "x");
|
||||
g("push", "-q", "-u", "origin", "feature/x");
|
||||
const other = cloneOf(bare, "gr-gone-other");
|
||||
other.g("push", "-q", "origin", "--delete", "feature/x");
|
||||
g("fetch", "-q", "--prune");
|
||||
const s = snapshot(repo);
|
||||
const x = branch(s, "feature/x");
|
||||
assert.equal(x.gone, true);
|
||||
assert.equal(x.upstream, "origin/feature/x");
|
||||
assert.equal(x.current, true);
|
||||
assert.equal(s.prUrl, null, "no link for a gone upstream");
|
||||
});
|
||||
|
||||
test("snapshot: merged branches against the default, and remote-only rows", () => {
|
||||
const { repo, g, bare } = repoWithOrigin("gr-merged");
|
||||
g("branch", "done");
|
||||
g("switch", "-q", "-c", "wip");
|
||||
write(repo, "w.txt", "w\n");
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", "wip");
|
||||
g("switch", "-q", "main");
|
||||
const other = cloneOf(bare, "gr-merged-other");
|
||||
other.g("switch", "-q", "-c", "theirs");
|
||||
other.g("push", "-q", "origin", "theirs");
|
||||
g("fetch", "-q");
|
||||
const s = snapshot(repo);
|
||||
assert.equal(branch(s, "done").merged, true);
|
||||
assert.equal(branch(s, "wip").merged, false);
|
||||
assert.equal(branch(s, "main").merged, false, "the default branch is never merged");
|
||||
const theirs = branch(s, "theirs");
|
||||
assert.equal(theirs.remote, "origin");
|
||||
assert.equal(theirs.upstream, null);
|
||||
assert.equal(s.branches.filter((b) => b.name === "main").length, 1, "origin/main is tracked, so no remote-only row");
|
||||
assert.ok(!s.branches.some((b) => b.name === "HEAD"), "origin/HEAD is skipped");
|
||||
});
|
||||
|
||||
test("snapshot: a detached HEAD gives a 7-character short oid", () => {
|
||||
const { repo, g } = repoWithCommit("gr-detached");
|
||||
g("checkout", "-q", "--detach");
|
||||
const s = snapshot(repo);
|
||||
assert.equal(s.head.branch, null);
|
||||
assert.equal(s.head.detached.length, 7);
|
||||
});
|
||||
|
||||
test("snapshot: no commits, no remote and never fetched", () => {
|
||||
const repo = tmp("gr-empty");
|
||||
gitInit(repo);
|
||||
const s = snapshot(repo);
|
||||
assert.equal(s.repo, true);
|
||||
assert.equal(s.hasCommits, false);
|
||||
assert.deepEqual(s.branches, []);
|
||||
assert.deepEqual(s.remotes, []);
|
||||
assert.equal(s.prUrl, null);
|
||||
assert.equal(s.lastFetch, null, "no FETCH_HEAD reads as never refreshed");
|
||||
assert.equal(s.defaultBranch, "main", "an unborn main is the default");
|
||||
assert.equal(s.inProgress, null);
|
||||
});
|
||||
|
||||
test("snapshot: two remotes with a different upstream per branch", () => {
|
||||
const { repo, g } = repoWithOrigin("gr-two");
|
||||
const up = bareRemote("upstream");
|
||||
g("remote", "add", "upstream", up);
|
||||
g("switch", "-q", "-c", "side");
|
||||
g("push", "-q", "-u", "upstream", "side");
|
||||
const s = snapshot(repo);
|
||||
assert.equal(branch(s, "main").upstreamRemote, "origin");
|
||||
assert.equal(branch(s, "side").upstreamRemote, "upstream");
|
||||
assert.deepEqual(s.remotes.map((r) => r.name).sort(), ["origin", "upstream"]);
|
||||
});
|
||||
|
||||
test("snapshot: mid-rebase with a conflict, then the markers removed", () => {
|
||||
const { repo, g } = repoWithCommit("gr-rebase");
|
||||
g("switch", "-q", "-c", "feature");
|
||||
write(repo, "a.txt", "feature\n");
|
||||
g("commit", "-q", "-am", "feature");
|
||||
g("switch", "-q", "main");
|
||||
write(repo, "a.txt", "main\n");
|
||||
g("commit", "-q", "-am", "main");
|
||||
g("switch", "-q", "feature");
|
||||
assert.throws(() => g("rebase", "main"), "the rebase stops on the conflict");
|
||||
let s = snapshot(repo);
|
||||
assert.equal(s.inProgress, "rebase");
|
||||
assert.deepEqual(s.conflicted, [{ path: "a.txt", status: "UU", markers: true }]);
|
||||
write(repo, "a.txt", "resolved\n");
|
||||
s = snapshot(repo);
|
||||
assert.equal(s.conflicted[0].markers, false, "Continue can be offered once no markers remain");
|
||||
g("rebase", "--abort");
|
||||
});
|
||||
|
||||
test("snapshot: an untracked folder is one row, and a .env inside a new folder is held back", () => {
|
||||
const { repo } = repoWithCommit("gr-untracked");
|
||||
for (let i = 0; i < 250; i++) write(repo, `big/f${i}.txt`, "x");
|
||||
write(repo, "cfg/.env", "SECRET=1\n");
|
||||
write(repo, "loose.txt", "x");
|
||||
const s = snapshot(repo);
|
||||
const dirs = Object.fromEntries(s.changes.untrackedDirs.map((d) => [d.path, d.files]));
|
||||
assert.equal(dirs["big/"], 250);
|
||||
assert.equal(dirs["cfg/"], 1);
|
||||
assert.equal(s.changes.count, 3, "two folders and one file");
|
||||
assert.equal(s.changes.heldBack, 1);
|
||||
assert.deepEqual(s.changes.files, [{ path: "loose.txt", state: "new", risky: false, staged: false }]);
|
||||
assert.equal(countPending(repo), 3, "the dashboard count agrees");
|
||||
});
|
||||
|
||||
test("snapshot: the pull-request link for a pushed feature branch", () => {
|
||||
const { repo, g } = repoWithOrigin("gr-pr");
|
||||
g("switch", "-q", "-c", "feature/ABC-1-x");
|
||||
g("push", "-q", "-u", "origin", "feature/ABC-1-x");
|
||||
g("remote", "set-url", "origin", "git@github.com:acme/demo.git");
|
||||
let s = snapshot(repo);
|
||||
assert.equal(s.prUrl, "https://github.com/acme/demo/compare/main...feature/ABC-1-x?quick_pull=1");
|
||||
g("switch", "-q", "main");
|
||||
s = snapshot(repo);
|
||||
assert.equal(s.prUrl, null, "no link from the default branch");
|
||||
});
|
||||
|
||||
test("snapshot: not a repository", () => {
|
||||
const dir = tmp("gr-plain");
|
||||
const s = snapshot(dir);
|
||||
assert.equal(s.repo, false);
|
||||
assert.equal(typeof s.at, "string");
|
||||
assert.equal(countPending(dir), null);
|
||||
});
|
||||
|
||||
/* ================================================ remotes and PR links */
|
||||
|
||||
const HEAD = "feature/ABC-1-x";
|
||||
const BASE = "main";
|
||||
|
||||
test("parseRemoteUrl + prUrl: GitHub, GitLab and Bitbucket in SSH and HTTPS form", () => {
|
||||
const cases = [
|
||||
["git@github.com:jparkerweb/plan2code.git", "https://github.com/jparkerweb/plan2code", "github"],
|
||||
["https://github.com/jparkerweb/plan2code.git", "https://github.com/jparkerweb/plan2code", "github"],
|
||||
["ssh://git@github.com/jparkerweb/plan2code.git", "https://github.com/jparkerweb/plan2code", "github"],
|
||||
["git@gitlab.com:group/sub/proj.git", "https://gitlab.com/group/sub/proj", "gitlab"],
|
||||
["https://user:token@gitlab.com/group/sub/proj.git", "https://gitlab.com/group/sub/proj", "gitlab"],
|
||||
["git@bitbucket.org:ws/repo.git", "https://bitbucket.org/ws/repo", "bitbucket"],
|
||||
["https://someone@bitbucket.org/ws/repo.git", "https://bitbucket.org/ws/repo", "bitbucket"],
|
||||
];
|
||||
for (const [url, web, kind] of cases) {
|
||||
const r = parseRemoteUrl(url);
|
||||
assert.equal(r.web, web, url);
|
||||
assert.equal(r.kind, kind, url);
|
||||
}
|
||||
const gh = parseRemoteUrl(cases[0][0]);
|
||||
assert.equal(prUrl(gh, { base: BASE, head: HEAD }), "https://github.com/jparkerweb/plan2code/compare/main...feature/ABC-1-x?quick_pull=1");
|
||||
assert.equal(
|
||||
prUrl(parseRemoteUrl(cases[3][0]), { base: BASE, head: HEAD }),
|
||||
"https://gitlab.com/group/sub/proj/-/merge_requests/new?merge_request%5Bsource_branch%5D=feature%2FABC-1-x&merge_request%5Btarget_branch%5D=main",
|
||||
);
|
||||
assert.equal(
|
||||
prUrl(parseRemoteUrl(cases[5][0]), { base: BASE, head: HEAD }),
|
||||
"https://bitbucket.org/ws/repo/pull-requests/new?source=feature%2FABC-1-x&dest=main",
|
||||
);
|
||||
});
|
||||
|
||||
test("parseRemoteUrl + prUrl: Azure DevOps over HTTPS with userinfo, ssh.dev.azure.com v3 and visualstudio.com", () => {
|
||||
const web = "https://dev.azure.com/org/project/_git/repo";
|
||||
for (const url of ["https://org@dev.azure.com/org/project/_git/repo", "git@ssh.dev.azure.com:v3/org/project/repo", "ssh://git@ssh.dev.azure.com/v3/org/project/repo"]) {
|
||||
const r = parseRemoteUrl(url);
|
||||
assert.equal(r.web, web, url);
|
||||
assert.equal(r.kind, "azure", url);
|
||||
}
|
||||
const vs = parseRemoteUrl("https://org.visualstudio.com/project/_git/repo");
|
||||
assert.equal(vs.web, "https://org.visualstudio.com/project/_git/repo");
|
||||
assert.equal(vs.kind, "azure");
|
||||
const vsSsh = parseRemoteUrl("org@vs-ssh.visualstudio.com:v3/org/project/repo");
|
||||
assert.equal(vsSsh.web, "https://org.visualstudio.com/project/_git/repo");
|
||||
assert.equal(vsSsh.kind, "azure");
|
||||
assert.equal(
|
||||
prUrl(parseRemoteUrl("git@ssh.dev.azure.com:v3/org/project/repo"), { base: BASE, head: HEAD }),
|
||||
"https://dev.azure.com/org/project/_git/repo/pullrequestcreate?sourceRef=feature%2FABC-1-x&targetRef=main",
|
||||
);
|
||||
});
|
||||
|
||||
test("parseRemoteUrl + prUrl: an unknown host has no link until prHosts names it", () => {
|
||||
const r = parseRemoteUrl("git@git.example.com:team/repo.git");
|
||||
assert.equal(r.host, "git.example.com");
|
||||
assert.equal(r.kind, null);
|
||||
assert.equal(prUrl(r, { base: BASE, head: HEAD }), null);
|
||||
assert.equal(prUrl({ ...r, kind: "none" }, { base: BASE, head: HEAD }), null);
|
||||
|
||||
const { repo, g } = repoWithCommit("gr-prhost");
|
||||
g("remote", "add", "origin", "git@git.example.com:team/repo.git");
|
||||
const s = snapshot(repo, { prHosts: { "git.example.com": "gitlab" } });
|
||||
assert.equal(s.remotes[0].kind, "gitlab");
|
||||
assert.equal(
|
||||
prUrl(s.remotes[0], { base: BASE, head: HEAD }),
|
||||
"https://git.example.com/team/repo/-/merge_requests/new?merge_request%5Bsource_branch%5D=feature%2FABC-1-x&merge_request%5Btarget_branch%5D=main",
|
||||
);
|
||||
assert.equal(snapshot(repo, { prHosts: { "git.example.com": "none" } }).remotes[0].kind, "none");
|
||||
assert.equal(
|
||||
parseRemoteUrl("https://dev.azure.com/org/My%20Project/_git/repo").web,
|
||||
"https://dev.azure.com/org/My%20Project/_git/repo",
|
||||
"an encoded path stays encoded",
|
||||
);
|
||||
assert.equal(parseRemoteUrl("https://git.example.com/a%zz/b.git").web, "https://git.example.com/a%zz/b", "a bad escape does not throw");
|
||||
assert.equal(parseRemoteUrl("C:/repos/origin.git"), null, "a Windows path is not scp-style");
|
||||
assert.equal(parseRemoteUrl("/srv/git/origin.git"), null);
|
||||
});
|
||||
|
||||
/* ================================================== floor and timing */
|
||||
|
||||
test("gitFloor: this machine's git is new enough", () => {
|
||||
const f = gitFloor();
|
||||
assert.equal(f.ok, true, f.message);
|
||||
assert.match(f.version, /^\d+\.\d+\.\d+/);
|
||||
});
|
||||
|
||||
test("snapshot: a 300-branch repo reads in under 5 seconds", () => {
|
||||
const { repo, g } = repoWithCommit("gr-300");
|
||||
const sha = g("rev-parse", "HEAD").trim();
|
||||
const lines = Array.from({ length: 300 }, (_, i) => `create refs/heads/b-${String(i).padStart(3, "0")} ${sha}\n`).join("");
|
||||
execFileSync("git", ["update-ref", "--stdin"], { cwd: repo, input: lines, stdio: ["pipe", "pipe", "pipe"] });
|
||||
const started = Date.now();
|
||||
const s = snapshot(repo);
|
||||
const took = Date.now() - started;
|
||||
assert.equal(s.branches.length, 301);
|
||||
assert.ok(took < 5000, `took ${took} ms`);
|
||||
});
|
||||
@@ -0,0 +1,188 @@
|
||||
// Tests for `node install.js --update` and the install record (~/.plan2code/install.json).
|
||||
// Run with: node --test scripts/test-install-update.mjs
|
||||
//
|
||||
// install.js reads the home directory once, at load, so HOME and USERPROFILE point at a temp
|
||||
// folder before it is required. update() takes its install steps as an argument: the tests
|
||||
// pass stand-ins that record their calls, so nothing reaches the skills CLI, npm or the network.
|
||||
|
||||
import test from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { createRequire } from "node:module";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
||||
const INSTALL = path.join(ROOT, "install.js");
|
||||
const VERSION = JSON.parse(fs.readFileSync(path.join(ROOT, "version.json"), "utf8")).version;
|
||||
|
||||
const HOME = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-install-update-"));
|
||||
process.env.HOME = HOME;
|
||||
process.env.USERPROFILE = HOME;
|
||||
const installer = require(INSTALL);
|
||||
test.after(() => fs.rmSync(HOME, { recursive: true, force: true }));
|
||||
|
||||
const RECORD = path.join(HOME, ".plan2code", "install.json");
|
||||
|
||||
function writeRecord(pieces) {
|
||||
fs.mkdirSync(path.dirname(RECORD), { recursive: true });
|
||||
fs.writeFileSync(RECORD, JSON.stringify({ version: "1.0.0", scope: "global", pieces }));
|
||||
}
|
||||
|
||||
function clearRecord() {
|
||||
fs.rmSync(RECORD, { force: true });
|
||||
}
|
||||
|
||||
/** Stand-in install steps: each logs its piece and options, then returns `codes[piece]` (default 0) or throws `throws[piece]`. */
|
||||
function fakeSteps({ codes = {}, throws = {}, launcherWithSkills = true } = {}) {
|
||||
const calls = [];
|
||||
const steps = {};
|
||||
for (const piece of installer.INSTALL_PIECES) {
|
||||
steps[piece] = async (options) => {
|
||||
calls.push({ piece, options });
|
||||
if (throws[piece]) throw new Error(throws[piece]);
|
||||
let code = codes[piece] ?? 0;
|
||||
if (piece === "skills") {
|
||||
// As the real install(): the skills first, then the command, and 1 if either failed.
|
||||
options.outcome.skills = code === 0;
|
||||
options.outcome.launcher = code === 0 && launcherWithSkills;
|
||||
if (code === 0 && !launcherWithSkills) code = 1;
|
||||
}
|
||||
return code;
|
||||
};
|
||||
}
|
||||
return { steps, calls, ran: () => calls.map((c) => c.piece) };
|
||||
}
|
||||
|
||||
/** Run update() with console output captured: `{ code, out }`. */
|
||||
async function runUpdate(steps) {
|
||||
const lines = [];
|
||||
const log = console.log;
|
||||
console.log = (...args) => lines.push(args.join(" "));
|
||||
try {
|
||||
const code = await installer.update({ steps });
|
||||
return { code, out: lines.join("\n").replace(/\x1b\[[0-9;]*m/g, "") };
|
||||
} finally {
|
||||
console.log = log;
|
||||
}
|
||||
}
|
||||
|
||||
test("install record: recordInstalled and forgetInstalled round trip a sorted set", () => {
|
||||
clearRecord();
|
||||
assert.equal(installer.INSTALL_RECORD, RECORD);
|
||||
assert.equal(installer.readInstallRecord(), null);
|
||||
installer.recordInstalled("loop");
|
||||
installer.recordInstalled("skills");
|
||||
installer.recordInstalled("skills");
|
||||
installer.recordInstalled("not-a-piece");
|
||||
assert.deepEqual(installer.readInstallRecord(), { version: VERSION, scope: "global", pieces: ["loop", "skills"] });
|
||||
installer.forgetInstalled("loop");
|
||||
assert.deepEqual(installer.readInstallRecord().pieces, ["skills"]);
|
||||
installer.forgetInstalled("skills");
|
||||
assert.deepEqual(installer.readInstallRecord().pieces, []);
|
||||
// No temp file is left beside the record.
|
||||
assert.deepEqual(fs.readdirSync(path.dirname(RECORD)), ["install.json"]);
|
||||
});
|
||||
|
||||
test("install record: a missing or unparsable record reads as null, and forgetting needs none", () => {
|
||||
clearRecord();
|
||||
installer.forgetInstalled("skills");
|
||||
assert.equal(fs.existsSync(RECORD), false);
|
||||
fs.writeFileSync(RECORD, "{ not json");
|
||||
assert.equal(installer.readInstallRecord(), null);
|
||||
fs.writeFileSync(RECORD, JSON.stringify({ pieces: "skills" }));
|
||||
assert.equal(installer.readInstallRecord(), null);
|
||||
});
|
||||
|
||||
test("update: with no record it says so and updates the skills and the plan2code command", async () => {
|
||||
clearRecord();
|
||||
const fake = fakeSteps();
|
||||
const { code, out } = await runUpdate(fake.steps);
|
||||
assert.equal(code, 0, out);
|
||||
assert.match(out, new RegExp(`No install record found \\(installed before v${VERSION.replace(/\./g, "\\.")}\\); updating the skills and the plan2code command\\.`));
|
||||
// install() covers the command with the skills, so the launcher step does not run again.
|
||||
assert.deepEqual(fake.ran(), ["skills"]);
|
||||
assert.match(out, /skills: updated/);
|
||||
assert.match(out, /launcher: updated/);
|
||||
});
|
||||
|
||||
test("update: a partial record runs only the listed pieces, in order, unattended", async () => {
|
||||
writeRecord(["loop", "statusline"]);
|
||||
const fake = fakeSteps();
|
||||
const { code, out } = await runUpdate(fake.steps);
|
||||
assert.equal(code, 0, out);
|
||||
assert.deepEqual(fake.ran(), ["statusline", "loop"]);
|
||||
for (const call of fake.calls) assert.equal(call.options.unattended, true, call.piece);
|
||||
assert.doesNotMatch(out, /No install record/);
|
||||
assert.doesNotMatch(out, /skills:/);
|
||||
});
|
||||
|
||||
test("update: a failing piece exits 1 naming it, and the others still run", async () => {
|
||||
writeRecord(["skills", "launcher", "loop", "metrics", "bot"]);
|
||||
const fake = fakeSteps({ codes: { loop: 1 }, throws: { metrics: "npm exploded" } });
|
||||
const { code, out } = await runUpdate(fake.steps);
|
||||
assert.equal(code, 1, out);
|
||||
assert.deepEqual(fake.ran(), ["skills", "loop", "metrics", "bot"]);
|
||||
assert.match(out, /loop: failed: /);
|
||||
assert.match(out, /metrics: failed: npm exploded/);
|
||||
assert.match(out, /bot: updated/);
|
||||
assert.match(out, /Update failed for: loop, metrics/);
|
||||
});
|
||||
|
||||
test("update: when the skills install leaves the command out, the launcher step runs on its own", async () => {
|
||||
writeRecord(["skills", "launcher"]);
|
||||
const fake = fakeSteps({ launcherWithSkills: false });
|
||||
const { code, out } = await runUpdate(fake.steps);
|
||||
assert.equal(code, 0, out);
|
||||
assert.deepEqual(fake.ran(), ["skills", "launcher"]);
|
||||
// install() returned 1 for the command alone: the skills still read as updated.
|
||||
assert.match(out, /skills: updated/);
|
||||
assert.match(out, /launcher: updated/);
|
||||
});
|
||||
|
||||
test("update: a command that fails on the retry is the only piece named", async () => {
|
||||
writeRecord(["skills", "launcher"]);
|
||||
const fake = fakeSteps({ launcherWithSkills: false, codes: { launcher: 1 } });
|
||||
const { code, out } = await runUpdate(fake.steps);
|
||||
assert.equal(code, 1, out);
|
||||
assert.match(out, /skills: updated/);
|
||||
assert.match(out, /Update failed for: launcher\b/);
|
||||
});
|
||||
|
||||
test("update: the real status line step keeps a custom statusLine without asking", async () => {
|
||||
const claudeDir = path.join(HOME, ".claude");
|
||||
const settingsFile = path.join(claudeDir, "settings.json");
|
||||
fs.mkdirSync(claudeDir, { recursive: true });
|
||||
const settings = JSON.stringify({ statusLine: { type: "command", command: "my-own-status-line" } }, null, 2);
|
||||
fs.writeFileSync(settingsFile, settings);
|
||||
clearRecord();
|
||||
// stdin is not a TTY here: a prompt would hang the test until it times out.
|
||||
const log = console.log;
|
||||
console.log = () => {};
|
||||
let code;
|
||||
try {
|
||||
code = await installer.UPDATE_STEPS.statusline({ quiet: true, unattended: true });
|
||||
} finally {
|
||||
console.log = log;
|
||||
}
|
||||
assert.equal(code, 0);
|
||||
assert.equal(fs.readFileSync(settingsFile, "utf8"), settings);
|
||||
assert.ok(fs.existsSync(path.join(claudeDir, "plan2code-statusline.js")));
|
||||
assert.deepEqual(installer.readInstallRecord().pieces, ["statusline"]);
|
||||
});
|
||||
|
||||
test("update: every step is an install function, never an uninstall", () => {
|
||||
assert.deepEqual(Object.keys(installer.UPDATE_STEPS), installer.INSTALL_PIECES);
|
||||
for (const [piece, fn] of Object.entries(installer.UPDATE_STEPS)) {
|
||||
assert.match(fn.name, /^install/, piece);
|
||||
}
|
||||
});
|
||||
|
||||
test("install.js: --update is in the usage line, and an unknown option still exits 1", () => {
|
||||
const result = spawnSync(process.execPath, [INSTALL, "--bogus"], { encoding: "utf8" });
|
||||
assert.equal(result.status, 1);
|
||||
assert.ok(result.stderr.includes("Usage: node install.js [--build-skills | --verify-skills | --update]"), result.stderr);
|
||||
});
|
||||
@@ -0,0 +1,381 @@
|
||||
// Tests for the global `plan2code` launcher. Run with: node --test scripts/test-launcher.mjs
|
||||
//
|
||||
// The launcher is a script that runs on load, so each test spawns it for real: a temp home
|
||||
// for ~/.plan2code/launcher.json, and stand-in `claude` / `devin` / `codex` commands on PATH that
|
||||
// record the arguments they were started with. stdin is a pipe, never a TTY, so the launcher
|
||||
// takes its no-prompt path: no menu and no wait at the model notice.
|
||||
|
||||
import test from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import { createRequire } from "node:module";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
const require = createRequire(import.meta.url);
|
||||
const ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
||||
const LAUNCHER = path.join(ROOT, "src", "launcher", "plan2code.js");
|
||||
const IS_WINDOWS = process.platform === "win32";
|
||||
const NOTICE = "will use the model you last used in it";
|
||||
|
||||
/**
|
||||
* A temp home and a bin dir holding stand-ins for `clis`; each writes its args to <bin>/<cli>.json.
|
||||
* `installed: "X.Y.Z"` runs an installed copy instead, as install.js lays it out: the launcher,
|
||||
* models.json and update-check.mjs in <home>/.plan2code/bin/ beside a version.json saying X.Y.Z.
|
||||
*/
|
||||
function sandbox(clis, { installed } = {}) {
|
||||
const dir = fs.mkdtempSync(path.join(os.tmpdir(), "p2c-launcher-"));
|
||||
const home = path.join(dir, "home");
|
||||
const bin = path.join(dir, "bin");
|
||||
fs.mkdirSync(home);
|
||||
fs.mkdirSync(bin);
|
||||
const consoleHome = path.join(home, ".plan2code", "console");
|
||||
let launcher = LAUNCHER;
|
||||
if (installed) {
|
||||
const binCopy = path.join(home, ".plan2code", "bin");
|
||||
fs.mkdirSync(binCopy, { recursive: true });
|
||||
launcher = path.join(binCopy, "plan2code.js");
|
||||
fs.copyFileSync(LAUNCHER, launcher);
|
||||
fs.copyFileSync(path.join(path.dirname(LAUNCHER), "models.json"), path.join(binCopy, "models.json"));
|
||||
fs.copyFileSync(path.join(ROOT, "src", "web-console", "update-check.mjs"), path.join(binCopy, "update-check.mjs"));
|
||||
fs.writeFileSync(path.join(binCopy, "version.json"), JSON.stringify({ name: "Plan2Code", version: installed }));
|
||||
}
|
||||
const recorder = path.join(bin, "record.js");
|
||||
fs.writeFileSync(
|
||||
recorder,
|
||||
'require("fs").writeFileSync(require("path").join(__dirname, process.argv[2] + ".json"), JSON.stringify(process.argv.slice(3)));\n' +
|
||||
"process.exitCode = Number(process.env.P2C_TEST_EXIT || 0);\n"
|
||||
);
|
||||
for (const cli of clis) {
|
||||
if (IS_WINDOWS) {
|
||||
fs.writeFileSync(path.join(bin, `${cli}.cmd`), `@"${process.execPath}" "${recorder}" ${cli} %*\r\n`);
|
||||
} else {
|
||||
const file = path.join(bin, cli);
|
||||
fs.writeFileSync(file, `#!/bin/sh\nexec "${process.execPath}" "${recorder}" ${cli} "$@"\n`);
|
||||
fs.chmodSync(file, 0o755);
|
||||
}
|
||||
}
|
||||
return {
|
||||
home,
|
||||
stateFile: path.join(home, ".plan2code", "launcher.json"),
|
||||
cacheFile: path.join(consoleHome, "update-check.json"),
|
||||
run: (args, env = {}) =>
|
||||
spawnSync(process.execPath, [launcher, ...args], {
|
||||
cwd: dir,
|
||||
input: "",
|
||||
encoding: "utf8",
|
||||
env: { ...process.env, PATH: bin, HOME: home, USERPROFILE: home, PLAN2CODE_CONSOLE_HOME: consoleHome, ...env },
|
||||
}),
|
||||
argsOf: (cli) => {
|
||||
const file = path.join(bin, `${cli}.json`);
|
||||
return fs.existsSync(file) ? JSON.parse(fs.readFileSync(file, "utf8")) : null;
|
||||
},
|
||||
// A detached release-check refresh may still be writing its cache; retry rather than fail.
|
||||
cleanup: () => fs.rmSync(dir, { recursive: true, force: true, maxRetries: 10, retryDelay: 100 }),
|
||||
};
|
||||
}
|
||||
|
||||
const NOTICE_LINE = /is out \(you have v/;
|
||||
|
||||
/** Write the console's cached release check, `ageMs` old. */
|
||||
function writeCache(box, latest, ageMs = 0) {
|
||||
fs.mkdirSync(path.dirname(box.cacheFile), { recursive: true });
|
||||
fs.writeFileSync(box.cacheFile, JSON.stringify({ checkedAt: Date.now() - ageMs, latest }));
|
||||
}
|
||||
|
||||
test("launcher: Claude Code gets the prompt first, then bypassPermissions and the forwarded args", (t) => {
|
||||
const box = sandbox(["claude"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--verbose"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.deepEqual(box.argsOf("claude"), ["/plan2code", "--permission-mode", "bypassPermissions", "--verbose"]);
|
||||
assert.match(result.stdout, new RegExp(`Claude Code ${NOTICE}`));
|
||||
});
|
||||
|
||||
test("launcher: Devin keeps its args ahead of the -- and the prompt", (t) => {
|
||||
const box = sandbox(["devin"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--verbose"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.deepEqual(box.argsOf("devin"), ["--permission-mode", "bypass", "--verbose", "--", "/plan2code"]);
|
||||
});
|
||||
|
||||
test("launcher: Codex gets the bypass flag, the forwarded args, then the $plan2code prompt", (t) => {
|
||||
const box = sandbox(["codex"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--verbose"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.deepEqual(box.argsOf("codex"), ["--dangerously-bypass-approvals-and-sandbox", "--verbose", "$plan2code"]);
|
||||
});
|
||||
|
||||
test("launcher: --cli codex picks Codex when it is installed beside another CLI", (t) => {
|
||||
const box = sandbox(["claude", "codex"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--cli", "codex"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.equal(box.argsOf("claude"), null);
|
||||
assert.ok(box.argsOf("codex"));
|
||||
});
|
||||
|
||||
test("launcher: the shipped models.json lists every CLI, and every entry has an id and a label", () => {
|
||||
const shipped = JSON.parse(fs.readFileSync(path.join(path.dirname(LAUNCHER), "models.json"), "utf8"));
|
||||
for (const cli of ["claude", "devin", "codex"]) {
|
||||
assert.ok(Array.isArray(shipped[cli]), cli);
|
||||
for (const { id, label } of shipped[cli]) assert.ok(id && label, cli);
|
||||
}
|
||||
});
|
||||
|
||||
test("launcher: Codex takes a forwarded --model ahead of the $plan2code prompt, with no notice", (t) => {
|
||||
const box = sandbox(["codex"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--cli", "codex", "--model", "x"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.doesNotMatch(result.stdout, new RegExp(NOTICE));
|
||||
assert.deepEqual(box.argsOf("codex"), ["--dangerously-bypass-approvals-and-sandbox", "--model", "x", "$plan2code"]);
|
||||
});
|
||||
|
||||
test("launcher: Codex's -m counts as a model already chosen", (t) => {
|
||||
const box = sandbox(["codex"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--cli", "codex", "-m", "x"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.doesNotMatch(result.stdout, new RegExp(NOTICE));
|
||||
assert.deepEqual(box.argsOf("codex"), ["--dangerously-bypass-approvals-and-sandbox", "-m", "x", "$plan2code"]);
|
||||
});
|
||||
|
||||
test("launcher: hasModelFlag reads -m as a model only for Codex", () => {
|
||||
const { hasModelFlag } = require(LAUNCHER);
|
||||
for (const cli of ["claude", "devin", "codex"]) {
|
||||
assert.equal(hasModelFlag(["--model", "x"], cli), true, cli);
|
||||
assert.equal(hasModelFlag(["--model=x"], cli), true, cli);
|
||||
assert.equal(hasModelFlag(["--verbose"], cli), false, cli);
|
||||
}
|
||||
for (const args of [["-m", "x"], ["-m=x"], ["-mx"]]) {
|
||||
assert.equal(hasModelFlag(args, "codex"), true, args.join(" "));
|
||||
assert.equal(hasModelFlag(args, "claude"), false, args.join(" "));
|
||||
}
|
||||
});
|
||||
|
||||
test("launcher: without a terminal, Codex prints the model notice", (t) => {
|
||||
const box = sandbox(["codex"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run([]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.match(result.stdout, new RegExp(`Codex ${NOTICE}`));
|
||||
assert.match(result.stdout, /`codex` on its own/);
|
||||
});
|
||||
|
||||
test("launcher: a forwarded --model skips the model notice", (t) => {
|
||||
const box = sandbox(["claude"]);
|
||||
t.after(box.cleanup);
|
||||
for (const args of [["--model", "opus"], ["--model=opus"]]) {
|
||||
const result = box.run(args);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.doesNotMatch(result.stdout, new RegExp(NOTICE));
|
||||
assert.deepEqual(box.argsOf("claude"), ["/plan2code", "--permission-mode", "bypassPermissions", ...args]);
|
||||
}
|
||||
});
|
||||
|
||||
test("launcher: --cli picks the CLI and is never forwarded; the pick is merged into launcher.json", (t) => {
|
||||
const box = sandbox(["claude", "devin"]);
|
||||
t.after(box.cleanup);
|
||||
fs.mkdirSync(path.dirname(box.stateFile), { recursive: true });
|
||||
fs.writeFileSync(box.stateFile, JSON.stringify({ lastFolder: box.home }));
|
||||
|
||||
for (const args of [["--cli", "devin"], ["--cli=DEVIN"]]) {
|
||||
const result = box.run(args);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.deepEqual(box.argsOf("devin"), ["--permission-mode", "bypass", "--", "/plan2code"]);
|
||||
}
|
||||
assert.equal(box.argsOf("claude"), null);
|
||||
assert.deepEqual(JSON.parse(fs.readFileSync(box.stateFile, "utf8")), { lastFolder: box.home, lastCli: "devin" });
|
||||
});
|
||||
|
||||
test("launcher: with both installed and no terminal to ask in, the last pick wins", (t) => {
|
||||
const box = sandbox(["claude", "devin"]);
|
||||
t.after(box.cleanup);
|
||||
fs.mkdirSync(path.dirname(box.stateFile), { recursive: true });
|
||||
fs.writeFileSync(box.stateFile, JSON.stringify({ lastCli: "devin" }));
|
||||
assert.equal(box.run([]).status, 0);
|
||||
assert.notEqual(box.argsOf("devin"), null);
|
||||
assert.equal(box.argsOf("claude"), null);
|
||||
});
|
||||
|
||||
test("launcher: with all three installed and no terminal, a last pick of codex opens Codex", (t) => {
|
||||
const box = sandbox(["claude", "devin", "codex"]);
|
||||
t.after(box.cleanup);
|
||||
fs.mkdirSync(path.dirname(box.stateFile), { recursive: true });
|
||||
fs.writeFileSync(box.stateFile, JSON.stringify({ lastCli: "codex" }));
|
||||
assert.equal(box.run([]).status, 0);
|
||||
assert.notEqual(box.argsOf("codex"), null);
|
||||
assert.equal(box.argsOf("claude"), null);
|
||||
assert.equal(box.argsOf("devin"), null);
|
||||
});
|
||||
|
||||
test("launcher: an unknown --cli exits 2, a missing CLI 127, and nothing is started", (t) => {
|
||||
const box = sandbox(["claude"]);
|
||||
t.after(box.cleanup);
|
||||
|
||||
const unknown = box.run(["--cli", "bogus"]);
|
||||
assert.equal(unknown.status, 2);
|
||||
assert.match(unknown.stderr, /--cli takes claude, devin or codex, not "bogus"/);
|
||||
|
||||
const missing = box.run(["--cli", "devin"]);
|
||||
assert.equal(missing.status, 127);
|
||||
assert.match(missing.stderr, /the `devin` CLI was not found/);
|
||||
assert.match(missing.stderr, /\n\nTo use Devin:\n/);
|
||||
assert.ok(missing.stderr.includes("1. Install it: https://devin.ai"));
|
||||
assert.ok(missing.stderr.includes("start Devin and type /plan2code."));
|
||||
// Only the steps for the requested CLI: no "install one of" list that contradicts it.
|
||||
assert.doesNotMatch(missing.stderr, /Install one:/);
|
||||
|
||||
const missingCodex = box.run(["--cli", "codex"]);
|
||||
assert.equal(missingCodex.status, 127);
|
||||
assert.ok(missingCodex.stderr.includes("npm i -g @openai/codex"));
|
||||
assert.ok(missingCodex.stderr.includes("type $plan2code."));
|
||||
|
||||
assert.equal(box.argsOf("claude"), null);
|
||||
});
|
||||
|
||||
test("launcher: mergeModels keeps the shipped list first and drops user duplicates", () => {
|
||||
const { mergeModels, modelEntries } = require(LAUNCHER);
|
||||
const shipped = [{ id: "a", label: "A" }, { id: "b", label: "B" }];
|
||||
const user = [{ id: "b", label: "B old" }, { id: "c", label: "C" }, { id: "c", label: "C again" }];
|
||||
assert.deepEqual(mergeModels(shipped, user), [...shipped, { id: "c", label: "C" }]);
|
||||
assert.deepEqual(mergeModels(shipped, []), shipped);
|
||||
// A missing or corrupt user file yields no additions rather than an error.
|
||||
assert.deepEqual(modelEntries(null, "devin"), []);
|
||||
assert.deepEqual(modelEntries({ devin: "nope" }, "devin"), []);
|
||||
assert.deepEqual(modelEntries({ devin: [{ id: 1 }, null, { id: "ok", label: "Ok" }] }, "devin"), [{ id: "ok", label: "Ok" }]);
|
||||
});
|
||||
|
||||
test("launcher: the shipped models.json is curated Devin at low/medium/high only", () => {
|
||||
const shipped = JSON.parse(fs.readFileSync(path.join(path.dirname(LAUNCHER), "models.json"), "utf8"));
|
||||
assert.ok(shipped.claude.length > 0);
|
||||
assert.ok(shipped.devin.length > 0 && shipped.devin.length <= 30);
|
||||
for (const { id, label } of shipped.devin) {
|
||||
assert.ok(id && label);
|
||||
assert.doesNotMatch(id, /(xhigh|max|fast|priority)$/);
|
||||
}
|
||||
});
|
||||
|
||||
test("launcher: with no CLI installed it exits 127 and says how to run the skill from an agent", (t) => {
|
||||
const box = sandbox([]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run([]);
|
||||
assert.equal(result.status, 127);
|
||||
assert.match(result.stderr, /none of `claude`, `devin` or `codex` was found/);
|
||||
assert.ok(result.stderr.includes("type /plan2code"));
|
||||
assert.ok(result.stderr.includes("$plan2code (Codex)"));
|
||||
assert.match(result.stderr, /cd into the project/);
|
||||
});
|
||||
|
||||
test("launcher: a forwarded argument with a space and a cmd metacharacter arrives unchanged", (t) => {
|
||||
// On Windows the stand-in is a .cmd, so this goes through the cmd.exe quoting in quoteForCmd.
|
||||
const box = sandbox(["claude"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["--append-system-prompt", "a b&c"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.deepEqual(box.argsOf("claude"), ["/plan2code", "--permission-mode", "bypassPermissions", "--append-system-prompt", "a b&c"]);
|
||||
});
|
||||
|
||||
test("launcher: the CLI's non-zero exit code is passed through", (t) => {
|
||||
const box = sandbox(["claude"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run([], { P2C_TEST_EXIT: "7" });
|
||||
assert.equal(result.status, 7, result.stderr);
|
||||
assert.notEqual(box.argsOf("claude"), null);
|
||||
});
|
||||
test("launcher: update runs the npx install and starts no agent", (t) => {
|
||||
const box = sandbox(["npx", "claude"]);
|
||||
t.after(box.cleanup);
|
||||
const result = box.run(["update"]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.match(result.stdout, /Updating Plan2Code\.\.\./);
|
||||
const args = box.argsOf("npx");
|
||||
assert.ok(args, "npx was not run");
|
||||
assert.ok(args.includes("--update"), args.join(" "));
|
||||
assert.ok(args.includes("git+https://github.com/jparkerweb/plan2code.git"), args.join(" "));
|
||||
assert.equal(box.argsOf("claude"), null);
|
||||
});
|
||||
|
||||
test("launcher: update passes npx's exit code through", (t) => {
|
||||
const box = sandbox(["npx"]);
|
||||
t.after(box.cleanup);
|
||||
assert.equal(box.run(["update"], { P2C_TEST_EXIT: "3" }).status, 3);
|
||||
});
|
||||
|
||||
test("launcher: release notice prints from a fresh cache", (t) => {
|
||||
const box = sandbox(["claude"], { installed: "1.0.0" });
|
||||
t.after(box.cleanup);
|
||||
writeCache(box, "9.9.9");
|
||||
const result = box.run([]);
|
||||
assert.equal(result.status, 0, result.stderr);
|
||||
assert.ok(result.stdout.includes("Plan2Code v9.9.9 is out (you have v1.0.0). Run: plan2code update"), result.stdout);
|
||||
assert.notEqual(box.argsOf("claude"), null);
|
||||
});
|
||||
|
||||
test("launcher: no notice when current, stale or missing, and the start does not wait", (t) => {
|
||||
// PATH holds only the stand-ins, so the detached refresh finds no git: nothing may wait on it.
|
||||
const cases = [
|
||||
["current", (box) => writeCache(box, "1.0.0")],
|
||||
["stale", (box) => writeCache(box, "9.9.9", 2 * 60 * 60 * 1000)],
|
||||
["missing", () => {}],
|
||||
];
|
||||
for (const [name, setup] of cases) {
|
||||
const box = sandbox(["claude"], { installed: "1.0.0" });
|
||||
t.after(box.cleanup);
|
||||
setup(box);
|
||||
const started = Date.now();
|
||||
const result = box.run([]);
|
||||
const took = Date.now() - started;
|
||||
assert.equal(result.status, 0, `${name}: ${result.stderr}`);
|
||||
assert.doesNotMatch(result.stdout, NOTICE_LINE, name);
|
||||
assert.notEqual(box.argsOf("claude"), null, name);
|
||||
assert.ok(took < 5000, `${name}: the start took ${took} ms`);
|
||||
}
|
||||
});
|
||||
|
||||
test("launcher: compareVersions orders X.Y.Z numerically and refuses anything else", () => {
|
||||
const { compareVersions } = require(LAUNCHER);
|
||||
assert.equal(compareVersions("1.9.0", "1.10.0"), -1);
|
||||
assert.equal(compareVersions("2.0.0", "2.0.0"), 0);
|
||||
assert.equal(compareVersions("3.0.0", "2.9.9"), 1);
|
||||
assert.equal(compareVersions("1.0.0", null), null);
|
||||
assert.equal(compareVersions("v1.0.0", "1.0.0"), null);
|
||||
});
|
||||
|
||||
test("launcher: renderBanner draws Planny and the name, colored only through paint", () => {
|
||||
const { renderBanner, paint } = require(LAUNCHER);
|
||||
const plain = renderBanner(paint(false));
|
||||
assert.doesNotMatch(plain, /\x1b/);
|
||||
for (const part of ["╭───╮", "╰┬─┬╯", "★", "Plan2Code"]) assert.ok(plain.includes(part), part);
|
||||
assert.ok(plain.split("\n").length >= 4);
|
||||
const colored = renderBanner(paint(true));
|
||||
assert.ok(colored.includes("\x1b["));
|
||||
assert.ok(colored.includes("\x1b[0m"));
|
||||
});
|
||||
|
||||
test("launcher: paint wraps text in the escape codes only when color is on", () => {
|
||||
const { paint } = require(LAUNCHER);
|
||||
assert.equal(paint(false).red("x"), "x");
|
||||
assert.equal(paint(true).red("x"), "\x1b[31mx\x1b[0m");
|
||||
});
|
||||
|
||||
test("launcher: a piped run prints no escape codes, with or without NO_COLOR", (t) => {
|
||||
const box = sandbox(["claude"]);
|
||||
t.after(box.cleanup);
|
||||
const none = sandbox([]);
|
||||
t.after(none.cleanup);
|
||||
for (const env of [{}, { NO_COLOR: "1" }]) {
|
||||
const runs = [box.run([], env), box.run(["--cli", "bogus"], env), none.run([], env)];
|
||||
assert.deepEqual(runs.map((r) => r.status), [0, 2, 127]);
|
||||
for (const r of runs) {
|
||||
assert.doesNotMatch(r.stdout, /\x1b/);
|
||||
assert.doesNotMatch(r.stderr, /\x1b/);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
@@ -0,0 +1,189 @@
|
||||
// Tests for plan2code-changelog's scripts/changelog-state.mjs.
|
||||
//
|
||||
// See skill-script-helpers.mjs for how these run.
|
||||
|
||||
import { test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import { execFileSync } from "node:child_process";
|
||||
import { runScript, tmp, write, read, gitInit, gitIn, copyFixture, fixtureCleanup } from "./skill-script-helpers.mjs";
|
||||
|
||||
const S = (cwd, ...a) => runScript("plan2code-changelog", "changelog-state.mjs", a, { cwd });
|
||||
|
||||
const V = (version, body = "### ✨ Added\n\n- **x**: a thing.\n") => `## v${version}\n\n${body}\n`;
|
||||
const LOG = (...entries) => `# Changelog\n\nAll notable changes.\n\n${entries.join("")}`;
|
||||
|
||||
// A repo whose main has CHANGELOG at `top`, plus the runner. Built once per
|
||||
// set of options and copied for each test (fixture-helpers.mjs).
|
||||
test.after(fixtureCleanup);
|
||||
function repo(name, { changelog = LOG(V("1.0.0")), pkg = true } = {}) {
|
||||
const dir = copyFixture(name, JSON.stringify({ changelog, pkg }), (fresh) => {
|
||||
const g = gitInit(fresh, "main");
|
||||
write(fresh, "CHANGELOG.md", changelog);
|
||||
if (pkg) write(fresh, "package.json", `{\n "name": "x",\n "version": "1.0.0",\n "private": true\n}\n`);
|
||||
write(fresh, "a.txt", "a\n");
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", "init");
|
||||
});
|
||||
return { dir, g: gitIn(dir) };
|
||||
}
|
||||
|
||||
const commitAll = (g, msg) => {
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", msg);
|
||||
};
|
||||
|
||||
test("changelog-state: not a repository and no CHANGELOG are exit 3", () => {
|
||||
const plain = tmp("cl-plain");
|
||||
const a = S(plain, "state");
|
||||
assert.equal(a.code, 3);
|
||||
assert.equal(a.json.error, "not-a-repo");
|
||||
const { dir } = repo("cl-nolog", { changelog: "x" });
|
||||
execFileSync("git", ["rm", "-q", "CHANGELOG.md"], { cwd: dir });
|
||||
const b = S(dir, "state");
|
||||
assert.equal(b.code, 3);
|
||||
assert.equal(b.json.error, "no-changelog");
|
||||
});
|
||||
|
||||
test("changelog-state: on the default branch there is no new entry and the version is the base's", () => {
|
||||
const { dir } = repo("cl-main");
|
||||
const r = S(dir, "state");
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.equal(r.json.branch, "main");
|
||||
assert.equal(r.json.onDefault, true);
|
||||
assert.deepEqual([r.json.base.ref, r.json.base.version], ["main", "1.0.0"], "no origin: the local default branch is the base");
|
||||
assert.equal(r.json.topIsNew, false);
|
||||
});
|
||||
|
||||
test("changelog-state: a branch with no entry above main needs a new version, not an extension", () => {
|
||||
const { dir, g } = repo("cl-noentry");
|
||||
g("switch", "-q", "-c", "feature/x");
|
||||
write(dir, "b.txt", "b\n");
|
||||
commitAll(g, "add b");
|
||||
const r = S(dir, "state");
|
||||
assert.equal(r.json.base.version, "1.0.0");
|
||||
assert.equal(r.json.topIsNew, false);
|
||||
assert.equal(r.json.canExtend, false);
|
||||
assert.equal(r.json.entryBump, "none");
|
||||
assert.deepEqual(r.json.commits.map((c) => c.subject), ["add b"]);
|
||||
assert.deepEqual(r.json.files, ["b.txt"]);
|
||||
assert.equal(r.json.entry, "", "main's released entry is not this branch's to compare against");
|
||||
});
|
||||
|
||||
test("changelog-state: an entry above main that nobody else has can be extended", () => {
|
||||
const { dir, g } = repo("cl-extend");
|
||||
g("switch", "-q", "-c", "feature/x");
|
||||
write(dir, "CHANGELOG.md", LOG(V("1.1.0"), V("1.0.0")));
|
||||
commitAll(g, "changelog 1.1.0");
|
||||
write(dir, "b.txt", "b\n");
|
||||
commitAll(g, "later work");
|
||||
write(dir, "c.txt", "c\n");
|
||||
const r = S(dir, "state");
|
||||
assert.equal(r.json.branchTop.version, "1.1.0");
|
||||
assert.equal(r.json.topIsNew, true);
|
||||
assert.equal(r.json.entryBump, "minor");
|
||||
assert.equal(r.json.released, false);
|
||||
assert.deepEqual(r.json.takenBy, []);
|
||||
assert.equal(r.json.canExtend, true);
|
||||
// The gap is what came after the entry was last touched, plus the working tree.
|
||||
assert.deepEqual(r.json.commits.map((c) => c.subject), ["later work"]);
|
||||
assert.deepEqual(r.json.files, ["b.txt"]);
|
||||
assert.deepEqual(r.json.uncommitted, ["c.txt"]);
|
||||
assert.match(r.json.entry, /^## v1\.1\.0/);
|
||||
assert.deepEqual(r.json.sectionHeadings, ["### ✨ Added"]);
|
||||
});
|
||||
|
||||
test("changelog-state: a tagged version is released, and one on another branch is taken", () => {
|
||||
const { dir, g } = repo("cl-spent");
|
||||
g("switch", "-q", "-c", "feature/x");
|
||||
write(dir, "CHANGELOG.md", LOG(V("1.1.0"), V("1.0.0")));
|
||||
commitAll(g, "changelog 1.1.0");
|
||||
g("switch", "-q", "-c", "feature/other");
|
||||
write(dir, "o.txt", "o\n");
|
||||
commitAll(g, "other work");
|
||||
g("switch", "-q", "feature/x");
|
||||
assert.deepEqual(S(dir, "state").json.takenBy, ["feature/other"], "a branch that already holds the version");
|
||||
assert.equal(S(dir, "state").json.canExtend, false);
|
||||
g("branch", "-D", "feature/other");
|
||||
g("tag", "v1.1.0");
|
||||
const r = S(dir, "state");
|
||||
assert.equal(r.json.released, true);
|
||||
assert.equal(r.json.canExtend, false);
|
||||
});
|
||||
|
||||
test("changelog-state: a branch that is only part of this one's history is no claim", () => {
|
||||
const { dir, g } = repo("cl-history");
|
||||
g("switch", "-q", "-c", "feature/x");
|
||||
write(dir, "CHANGELOG.md", LOG(V("1.1.0"), V("1.0.0")));
|
||||
commitAll(g, "changelog 1.1.0");
|
||||
g("branch", "behind-me");
|
||||
write(dir, "b.txt", "b\n");
|
||||
commitAll(g, "more");
|
||||
assert.deepEqual(S(dir, "state").json.takenBy, []);
|
||||
});
|
||||
|
||||
test("changelog-state: reads the heading style and package.json alignment", () => {
|
||||
const log = `# Changelog\n\n## [2.0.0] - 2026-01-02\n\n### Fixed\n\n- y\n\n## [1.0.0] - 2025-12-01\n\n### Added\n\n- x\n`;
|
||||
const { dir } = repo("cl-style", { changelog: log });
|
||||
const r = S(dir, "state");
|
||||
assert.equal(r.json.heading.style, "bracketed");
|
||||
assert.equal(r.json.heading.dated, true);
|
||||
assert.equal(r.json.heading.separator, "-");
|
||||
assert.equal(r.json.package.version, "1.0.0");
|
||||
assert.equal(r.json.package.matches, false, "package.json lags the CHANGELOG's 2.0.0");
|
||||
const b = S(dir, "bump", "--from", "2.0.0", "--kind", "patch");
|
||||
assert.equal(b.json.version, "2.0.1");
|
||||
assert.equal(b.json.heading, "## [2.0.1] - 2026-08-03");
|
||||
});
|
||||
|
||||
test("changelog-state: an Unreleased heading is not a version and package.json is not aligned to it", () => {
|
||||
const log = `# Changelog\n\n## [Unreleased]\n\n### Added\n\n- soon\n\n## [1.0.0] - 2025-12-01\n\n- x\n`;
|
||||
const { dir } = repo("cl-unreleased", { changelog: log });
|
||||
const r = S(dir, "state");
|
||||
assert.equal(r.json.branchTop.unreleased, true);
|
||||
assert.equal(r.json.branchTop.version, null);
|
||||
assert.equal(r.json.topIsNew, false);
|
||||
assert.equal(r.json.package.matches, false);
|
||||
assert.match(r.json.entry, /^## \[Unreleased\]/);
|
||||
});
|
||||
|
||||
test("changelog-state bump: kinds and bad input", () => {
|
||||
const { dir } = repo("cl-bump");
|
||||
assert.equal(S(dir, "bump", "--from", "1.2.3", "--kind", "major").json.version, "2.0.0");
|
||||
assert.equal(S(dir, "bump", "--from", "1.2.3", "--kind", "minor").json.version, "1.3.0");
|
||||
assert.equal(S(dir, "bump", "--from", "v1.2.3", "--kind", "patch").json.version, "1.2.4");
|
||||
assert.equal(S(dir, "bump", "--from", "1.2.3", "--kind", "huge").code, 2);
|
||||
const bad = S(dir, "bump", "--from", "one", "--kind", "patch");
|
||||
assert.equal(bad.code, 4);
|
||||
assert.equal(bad.json.error, "bad-version");
|
||||
});
|
||||
|
||||
test("changelog-state set-package-version: changes the version field and nothing else", () => {
|
||||
const { dir } = repo("cl-pkg");
|
||||
const before = read(dir, "package.json");
|
||||
const r = S(dir, "set-package-version", "--version", "1.1.0");
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.deepEqual([r.json.from, r.json.to, r.json.changed], ["1.0.0", "1.1.0", true]);
|
||||
assert.equal(read(dir, "package.json"), before.replace('"1.0.0"', '"1.1.0"'));
|
||||
assert.equal(S(dir, "set-package-version", "--version", "1.1.0").json.changed, false);
|
||||
write(dir, "package.json", `{ "name": "x" }\n`);
|
||||
assert.equal(S(dir, "set-package-version", "--version", "1.1.0").code, 4);
|
||||
write(dir, "package.json", `{
|
||||
"config": {
|
||||
"version": "9.9.9"
|
||||
},
|
||||
"version": "1.0.0"
|
||||
}
|
||||
`);
|
||||
const nested = S(dir, "set-package-version", "--version", "1.1.0");
|
||||
assert.equal(nested.code, 5);
|
||||
assert.equal(nested.json.error, "ambiguous-version");
|
||||
assert.equal(read(dir, "package.json").includes("9.9.9"), true, "nothing was written");
|
||||
});
|
||||
|
||||
test("changelog-state: new SKILL.md files are reported", () => {
|
||||
const { dir, g } = repo("cl-skill");
|
||||
g("switch", "-q", "-c", "feature/skill");
|
||||
write(dir, "skills/new-thing/SKILL.md", "---\nname: new-thing\n---\n");
|
||||
commitAll(g, "add a skill");
|
||||
assert.deepEqual(S(dir, "state").json.addedSkills, ["skills/new-thing/SKILL.md"]);
|
||||
});
|
||||
@@ -0,0 +1,174 @@
|
||||
// Tests for plan2code-4-finalize's scripts/feedback-payload.mjs.
|
||||
//
|
||||
// See skill-script-helpers.mjs for how these run.
|
||||
|
||||
import { test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { spawnSync } from "node:child_process";
|
||||
import crypto from "node:crypto";
|
||||
import { ROOT, SKILLS, NOW, runScript, tmp, write, read, gitInit, phase } from "./skill-script-helpers.mjs";
|
||||
|
||||
/* ========================================================= feedback-payload.mjs */
|
||||
|
||||
test("feedback-payload: payload from the archive, real prompt hashes, size and truncation", () => {
|
||||
const root = tmp("fb");
|
||||
const spec = "specs--completed/lunch-vote";
|
||||
write(root, `${spec}/PLAN-DRAFT-20260801.md`, '# Plan\n\n<!-- METRICS_JSON {"confidence": 92, "clarification_rounds": 1, "functional_requirements_count": 5, "non_functional_requirements_count": 2, "risk_count": 3, "phase_count": 2, "verification_gaps_found": 0, "confidence_breakdown": {"requirements": 24, "feasibility": 23, "integration": 23, "risk": 22}} -->\n');
|
||||
write(root, `${spec}/overview.md`, '# O\n\n<!-- METRICS_JSON {"step": "document", "total_tasks": 3, "tasks_per_phase": [2, 1], "phase_count": 2, "parallel_groups_identified": 0, "verification_items_added": 1} -->\n\n## User Feedback\n| Field | Value |\n|-------|-------|\n| Rating | 8 |\n| Reason | Good \\| fast |\n| Went Well | Specs |\n| Went Poorly | Review |\n');
|
||||
write(root, `${spec}/phase-1.md`, phase(1, "Complete", [["x", "1.1"], ["x", "1.T"]]));
|
||||
write(root, `${spec}/phase-2.md`, phase(2, "Complete", [["!", "2.1"]]));
|
||||
const outDir = path.join(root, "out");
|
||||
const F = (...a) => runScript("plan2code-4-finalize", "feedback-payload.mjs", [...a, "--root", root]);
|
||||
assert.equal(F("build", "lunch-vote", "--out", outDir).code, 2, "the two judgment counts are required");
|
||||
const b = F("build", "lunch-vote", "--out", outDir, "--set", "verification_failures_found=1", "--set", "documentation_updates_needed=2");
|
||||
assert.equal(b.code, 0, b.stderr);
|
||||
const p = b.json.payload;
|
||||
assert.match(p.run_id, /^run-20260803-140500-[0-9a-f]{4}$/);
|
||||
assert.equal(p.plan2code_version, JSON.parse(fs.readFileSync(path.join(ROOT, "version.json"), "utf8")).version);
|
||||
const srcHash = crypto.createHash("sha256").update(fs.readFileSync(path.join(ROOT, "src", "plan2code-1-plan.md"), "utf8")).digest("hex").slice(0, 12);
|
||||
assert.equal(p.prompt_versions_short.plan, srcHash, "the hash is the src prompt's, recovered from the installed SKILL.md");
|
||||
assert.ok(Object.values(p.prompt_versions_short).every((v) => /^[0-9a-f]{12}$/.test(v)));
|
||||
assert.deepEqual(p.step1.confidence_breakdown, { requirements: 24, feasibility: 23, integration: 23, risk: 22 });
|
||||
assert.equal(p.step1.final_confidence, 92);
|
||||
assert.equal(p.step2.total_tasks, 3);
|
||||
assert.deepEqual(p.step3, { task_completion_rate: 0.67, tasks_completed: 2, tasks_total: 3, blocker_count: 1 });
|
||||
assert.deepEqual(p.step4, { completion_rate_at_audit: 0.67, verification_failures_found: 1, documentation_updates_needed: 2, archival_succeeded: true });
|
||||
assert.deepEqual(p.user_feedback, { overall_rating: 8, rating_reason: "Good | fast", what_went_well: "Specs", what_went_poorly: "Review" });
|
||||
assert.equal(b.json.title, `[Feedback] v${p.plan2code_version} - rating 8/10`);
|
||||
assert.match(b.json.body, /<!-- METRICS_JSON \{"schema_version":"1\.0"/);
|
||||
assert.ok(!/[—]/.test(b.json.title), "no em dash in the issue title");
|
||||
assert.equal(b.json.oversize, false);
|
||||
assert.ok(fs.existsSync(path.join(outDir, "body.md")));
|
||||
// The ingest side parses the body back.
|
||||
const parsed = JSON.parse(b.json.body.match(/<!--\s*METRICS_JSON\s+(\{[\s\S]*?\})\s*-->/)[1]);
|
||||
assert.equal(parsed.schema_version, "1.0");
|
||||
// Oversize, then truncate.
|
||||
const ov = path.join(root, spec, "overview.md");
|
||||
fs.writeFileSync(ov, fs.readFileSync(ov, "utf8").replace("| Good \\| fast |", `| ${"long reason ".repeat(500)} |`));
|
||||
const big = F("build", "lunch-vote", "--out", outDir, "--set", "verification_failures_found=1", "--set", "documentation_updates_needed=2");
|
||||
assert.equal(big.json.oversize, true);
|
||||
assert.match(big.json.next, /--truncate/);
|
||||
const cut = F("build", "lunch-vote", "--out", outDir, "--set", "verification_failures_found=1", "--set", "documentation_updates_needed=2", "--truncate");
|
||||
assert.equal(cut.json.oversize, false);
|
||||
assert.deepEqual(cut.json.truncated, ["rating_reason"]);
|
||||
const dry = runScript("plan2code-4-finalize", "feedback-payload.mjs", ["submit", "--from", outDir, "--dry-run"]);
|
||||
assert.equal(dry.code, 0);
|
||||
assert.match(dry.json.tiers[0], /^gh issue create --repo jparkerweb\/plan2code .*--label community-feedback$/);
|
||||
assert.equal(dry.json.oversize, false);
|
||||
assert.equal(dry.json.urlBytes, cut.json.urlBytes);
|
||||
fs.writeFileSync(ov, "# O\n");
|
||||
assert.equal(F("build", "lunch-vote", "--set", "verification_failures_found=1", "--set", "documentation_updates_needed=2").code, 3, "no feedback table, nothing to submit");
|
||||
});
|
||||
|
||||
/* ================================================= verification regressions */
|
||||
|
||||
test("feedback-payload: truncation always ends, '-->' survives ingest, lenient rating, absent steps are null", () => {
|
||||
const root = tmp("fb2");
|
||||
const spec = "specs--completed/x";
|
||||
const long = (w) => `${w} `.repeat(400).trim();
|
||||
// The visible answers carry markup that must stay text: a stray comment
|
||||
// opener, and a fake payload comment an ingest regex could match first.
|
||||
const fake = '<!-- METRICS_JSON {"schema_version":"1.0"} -->';
|
||||
const inputs = { rating_reason: `see {a} --> b <!-- x ${long("reason")}`, what_went_well: `${fake} ${long("well")}`, what_went_poorly: long("poorly") };
|
||||
write(root, `${spec}/overview.md`, `# O\n\n## User Feedback\n| field | value |\n|---|---|\n| rating | 8/10 |\n| reason | ${inputs.rating_reason} |\n| went well | ${inputs.what_went_well} |\n| went poorly | ${inputs.what_went_poorly} |\n`);
|
||||
write(root, `${spec}/phase-1.md`, phase(1, "Complete", [["x", "1.1"]]));
|
||||
const F = (...a) => runScript("plan2code-4-finalize", "feedback-payload.mjs", [...a, "--root", root]);
|
||||
const sets = ["--set", "verification_failures_found=0", "--set", "documentation_updates_needed=0"];
|
||||
assert.equal(F("build", "x", ...sets, "--set", "bogus=1").code, 2);
|
||||
// Untruncated, the first METRICS_JSON match is the real payload: its answers
|
||||
// come back exactly as typed, not the fake's bare schema_version.
|
||||
const whole = F("build", "x", ...sets, "--out", path.join(root, "whole"));
|
||||
assert.equal(whole.code, 0, whole.stderr);
|
||||
const first = JSON.parse(whole.json.body.match(/<!--\s*METRICS_JSON\s+(\{[\s\S]*?\})\s*-->/)[1]);
|
||||
assert.deepEqual(first.user_feedback, { overall_rating: 8, ...inputs });
|
||||
assert.equal(whole.json.body.split("<!--").length - 1, 1, "the payload's is the only comment that opens");
|
||||
assert.ok(!/<!--(?! METRICS_JSON \{"schema_version":"1\.0","run_id")/.test(whole.json.body), "no comment opens before the payload's");
|
||||
const r = spawnSync(process.execPath, [path.join(SKILLS, "plan2code-4-finalize", "scripts", "feedback-payload.mjs"), "build", "x", ...sets, "--truncate", "--out", path.join(root, "out"), "--root", root], { encoding: "utf8", timeout: 20000, env: { ...process.env, PLAN2CODE_NOW: NOW } });
|
||||
assert.equal(r.status, 0, "build --truncate finishes with every field long");
|
||||
const j = JSON.parse(r.stdout);
|
||||
assert.equal(j.oversize, false);
|
||||
assert.deepEqual(j.truncated, ["rating_reason", "what_went_well", "what_went_poorly"]);
|
||||
assert.equal(j.payload.user_feedback.overall_rating, 8, "8/10 reads as 8, field names in any case");
|
||||
assert.equal(j.payload.step1, null);
|
||||
assert.equal(j.payload.step2, null);
|
||||
// The ingest side's own extraction regex (plan2code-metrics collector.ts).
|
||||
const m = j.body.match(/<!--\s*METRICS_JSON\s+(\{[\s\S]*?\})\s*-->/);
|
||||
const back = JSON.parse(m[1]);
|
||||
assert.match(back.user_feedback.rating_reason, /^see \{a\} --> b <!-- x/);
|
||||
assert.equal(back.user_feedback.what_went_well, j.payload.user_feedback.what_went_well);
|
||||
assert.match(back.user_feedback.what_went_well, /^<!-- METRICS_JSON/, "the fake comment is still just text in the real payload");
|
||||
assert.ok(!/<!--(?! METRICS_JSON \{"schema_version":"1\.0","run_id")/.test(j.body), "no comment opens before the payload's");
|
||||
});
|
||||
|
||||
test("feedback-payload: --truncate never splits an emoji", () => {
|
||||
const root = tmp("fb3");
|
||||
const spec = "specs--completed/x";
|
||||
const reason = "a" + "\u{1F44D}".repeat(400);
|
||||
write(root, `${spec}/overview.md`, `# O\n\n## User Feedback\n| Field | Value |\n|---|---|\n| Rating | 9 |\n| Reason | ${reason} |\n| Went Well | ok |\n| Went Poorly | none |\n`);
|
||||
write(root, `${spec}/phase-1.md`, phase(1, "Complete", [["x", "1.1"]]));
|
||||
const r = runScript("plan2code-4-finalize", "feedback-payload.mjs", ["build", "x", "--set", "verification_failures_found=0", "--set", "documentation_updates_needed=0", "--truncate", "--out", path.join(root, "out"), "--root", root]);
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.equal(r.json.oversize, false);
|
||||
assert.deepEqual(r.json.truncated, ["rating_reason"]);
|
||||
const back = JSON.parse(r.json.body.match(/<!--\s*METRICS_JSON\s+(\{[\s\S]*?\})\s*-->/)[1]);
|
||||
assert.equal(back.user_feedback.rating_reason, r.json.payload.user_feedback.rating_reason);
|
||||
assert.ok(!/[\uD800-\uDBFF](?![\uDC00-\uDFFF])/.test(back.user_feedback.rating_reason), "no lone high surrogate");
|
||||
assert.match(back.user_feedback.rating_reason, /^a(\u{1F44D})+\.\.\.$/u);
|
||||
});
|
||||
|
||||
test("feedback-payload: task counts read the same phase files specs.mjs does, never a stale sibling", () => {
|
||||
const root = tmp("fb5");
|
||||
const spec = "specs--completed/x";
|
||||
write(root, `${spec}/overview.md`, "# O\n\n## User Feedback\n| Field | Value |\n|---|---|\n| Rating | 7 |\n| Reason | r |\n| Went Well | w |\n| Went Poorly | p |\n");
|
||||
write(root, `${spec}/phase-1.md`, phase(1, "Complete", [["x", "1.1"], ["x", "1.2"]]));
|
||||
write(root, `${spec}/phase-1-old.md`, phase(1, "Not Started", [[" ", "1.1"], [" ", "1.2"], [" ", "1.3"]]));
|
||||
const r = runScript("plan2code-4-finalize", "feedback-payload.mjs", ["build", "x", "--set", "verification_failures_found=0", "--set", "documentation_updates_needed=0", "--out", path.join(root, "out"), "--root", root]);
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.deepEqual(r.json.payload.step3, { task_completion_rate: 1, tasks_completed: 2, tasks_total: 2, blocker_count: 0 });
|
||||
const m = runScript("plan2code-4-finalize", "specs.mjs", ["metrics", spec, "--step", "finalize", "--set", "verification_failures_found=0", "--set", "documentation_updates_needed=0", "--root", root]);
|
||||
assert.equal(m.code, 0, m.stderr);
|
||||
assert.equal(m.json.metrics.tasks_total, r.json.payload.step3.tasks_total);
|
||||
assert.equal(m.json.metrics.tasks_completed, r.json.payload.step3.tasks_completed);
|
||||
});
|
||||
|
||||
test("feedback-payload: a bare name in both specs/ and specs--completed/ is ambiguous", () => {
|
||||
const root = tmp("fb4");
|
||||
const table = (rating) => `# O\n\n## User Feedback\n| Field | Value |\n|---|---|\n| Rating | ${rating} |\n| Reason | r |\n| Went Well | w |\n| Went Poorly | p |\n`;
|
||||
write(root, "specs--completed/x/overview.md", table(3));
|
||||
write(root, "specs/x/overview.md", table(7));
|
||||
const sets = ["--set", "verification_failures_found=0", "--set", "documentation_updates_needed=0"];
|
||||
const F = (...a) => runScript("plan2code-4-finalize", "feedback-payload.mjs", [...a, ...sets, "--out", path.join(root, "out"), "--root", root]);
|
||||
const bare = F("build", "x");
|
||||
assert.equal(bare.code, 5);
|
||||
assert.equal(bare.json.error, "ambiguous-spec");
|
||||
assert.match(bare.json.next, /specs\/x/);
|
||||
const live = F("build", "specs/x");
|
||||
assert.equal(live.code, 0, live.stderr);
|
||||
assert.equal(live.json.payload.user_feedback.overall_rating, 7, "the exact path reads this run, not the old archive");
|
||||
assert.equal(live.json.payload.step4.archival_succeeded, false);
|
||||
});
|
||||
|
||||
test("feedback-payload: submit refuses an oversize URL when gh fails, and dry-run says so", () => {
|
||||
const root = tmp("fb5");
|
||||
write(root, "specs--completed/x/overview.md", `# O\n\n## User Feedback\n| Field | Value |\n|---|---|\n| Rating | 6 |\n| Reason | ${"long reason ".repeat(800)} |\n| Went Well | w |\n| Went Poorly | p |\n`);
|
||||
const outDir = path.join(root, "out");
|
||||
const b = runScript("plan2code-4-finalize", "feedback-payload.mjs", ["build", "x", "--set", "verification_failures_found=0", "--set", "documentation_updates_needed=0", "--out", outDir, "--root", root]);
|
||||
assert.equal(b.json.oversize, true);
|
||||
const dry = runScript("plan2code-4-finalize", "feedback-payload.mjs", ["submit", "--from", outDir, "--dry-run"]);
|
||||
assert.equal(dry.code, 0);
|
||||
assert.equal(dry.json.oversize, true);
|
||||
assert.equal(dry.json.urlBytes, b.json.urlBytes);
|
||||
// gh must never succeed here: no PATH but node's own folder (so gh is not
|
||||
// found), and should one turn up anyway, an empty config, no token and a
|
||||
// host that does not resolve.
|
||||
const env = Object.fromEntries(Object.entries(process.env).filter(([k]) => !/^(path|gh_|github_token$)/i.test(k)));
|
||||
Object.assign(env, { PATH: path.dirname(process.execPath), GH_CONFIG_DIR: tmp("fb5-gh"), GH_HOST: "gh.invalid", PLAN2CODE_NOW: NOW });
|
||||
const r = spawnSync(process.execPath, [path.join(SKILLS, "plan2code-4-finalize", "scripts", "feedback-payload.mjs"), "submit", "--from", outDir], { cwd: root, encoding: "utf8", timeout: 70000, env });
|
||||
assert.equal(r.status, 4, r.stderr);
|
||||
const j = JSON.parse(r.stdout);
|
||||
assert.equal(j.error, "oversize");
|
||||
assert.match(j.next, /--truncate/);
|
||||
assert.match(j.next, /gh/);
|
||||
});
|
||||
@@ -0,0 +1,545 @@
|
||||
// Tests for plan2code-0-pathfinder's scripts/pathfinder.mjs.
|
||||
//
|
||||
// See skill-script-helpers.mjs for how these run.
|
||||
|
||||
import { test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { ROOT, SKILLS, NOW, runScript, tmp, write, read, gitInit, phase } from "./skill-script-helpers.mjs";
|
||||
|
||||
/* ============================================================ pathfinder.mjs */
|
||||
|
||||
const B = "> Pathfinder planning note - decisions, not implementation work. Archive with the spec; do not delete.";
|
||||
|
||||
function q(name, { type = "grill · HITL", state = "open", blocked = "none", claimed = "none", resolved = "none", locked = "no", answer = null, evidence = null, skipResolved = false } = {}) {
|
||||
return [
|
||||
B, "", `# ${name}`, "", `Type: ${type}`, `State: ${state}`, `Blocked by: ${blocked}`, `Claimed: ${claimed}`,
|
||||
...(skipResolved ? [] : [`Resolved: ${resolved}`]), `Locked: ${locked}`, "", "## Question", "", `What about ${name}?`, "",
|
||||
...(answer ? ["## Answer", "", answer, ""] : []),
|
||||
...(evidence ? ["## Evidence", "", evidence, ""] : []),
|
||||
].join("\n");
|
||||
}
|
||||
|
||||
const MAP = `${B}
|
||||
|
||||
# Map: audit-export
|
||||
|
||||
*Decisions live in \`questions/\` — one file each. This file is just the index.*
|
||||
|
||||
**Status:** Working
|
||||
**Updated:** 2026-08-01
|
||||
**Confidence:** Requirements-clarity 19/25 · Feasibility-technical 14/25 · Integration-points 20/25 · Risk-assessment 18/25
|
||||
|
||||
## Destination
|
||||
|
||||
A locked plan for exporting audit events.
|
||||
|
||||
## Ground rules
|
||||
|
||||
- \`AGENTS.md\` exists and governs.
|
||||
|
||||
## Question Checklist
|
||||
|
||||
<!-- Rebuilt from questions/ every session. -->
|
||||
|
||||
- [x] [Codebase context](./questions/00-codebase-context.md) — Node and Postgres; a long gist
|
||||
that wraps onto a second line. *(2026-08-01)*
|
||||
- [ ] [Export format](./questions/01-export-format.md)
|
||||
- [ ] [Row-count
|
||||
ceiling](./questions/02-row-count-ceiling.md)
|
||||
- [ ] [Testing posture](./questions/03-testing-posture.md)
|
||||
- [ ] [Delivery channel](./questions/04-delivery-channel.md)
|
||||
- [ ] [Gone question](./questions/09-gone.md)
|
||||
|
||||
## Not yet specified
|
||||
|
||||
- How far back an export may reach.
|
||||
|
||||
## Out of scope
|
||||
|
||||
- Redesign of the schema.
|
||||
`;
|
||||
|
||||
function mapFixture() {
|
||||
const root = tmp("pf");
|
||||
write(root, "AGENTS.md", "# AGENTS.md\n");
|
||||
const pf = "specs/audit-export/pathfinder";
|
||||
write(root, `${pf}/map.md`, MAP);
|
||||
write(root, `${pf}/questions/00-codebase-context.md`, q("Codebase context", { type: "legwork · AFK", state: "resolved", claimed: "2026-08-01 09:00", resolved: "2026-08-01", answer: "Node.\n\n**Gist:** Node and Postgres." }));
|
||||
// An answer under State: open (a crash after writing the answer): reconcile resolves it and backfills the date.
|
||||
write(root, `${pf}/questions/01-export-format.md`, q("Export format", { claimed: "2026-08-02 10:00", locked: "yes", answer: "**Decision.** CSV.\n\n**Rejected**\n\n- *JSONL* - recipients use Excel.\n\n**Gist:** CSV with a BOM.", skipResolved: true }));
|
||||
// A stale claim with no answer: reset.
|
||||
write(root, `${pf}/questions/02-row-count-ceiling.md`, q("Row-count ceiling", { type: "research · AFK", state: "claimed", claimed: "2026-08-02 11:00", evidence: "- half done" }));
|
||||
write(root, `${pf}/questions/03-testing-posture.md`, q("Testing posture"));
|
||||
write(root, `${pf}/questions/04-delivery-channel.md`, q("Delivery channel", { blocked: "02" }));
|
||||
write(root, `${pf}/questions/05-siem-push.md`, q("SIEM push", { state: "out-of-scope" }));
|
||||
return { root, pf };
|
||||
}
|
||||
|
||||
test("pathfinder reconcile: files win, dates backfill, stale claims reset, rows keep their words", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
const dry = P("reconcile", "audit-export", "--dry-run");
|
||||
assert.equal(dry.code, 0, dry.stderr);
|
||||
assert.equal(read(root, `${pf}/map.md`), MAP, "dry-run writes nothing");
|
||||
const r = P("reconcile", "audit-export");
|
||||
assert.deepEqual(r.json.repairs.map((x) => [x.nn, x.repair]), [["01", "state-resolved"], ["01", "resolved-backfilled"], ["02", "stale-claim-reset"]]);
|
||||
assert.match(r.json.repairs[1].detail, /2026-08-02 \(from Claimed:\)/);
|
||||
assert.deepEqual(r.json.refire.map((x) => x.nn), ["02"], "research with no Research complete line is re-fired");
|
||||
assert.equal(r.json.refire[0].partialEvidence, true);
|
||||
const map = read(root, `${pf}/map.md`);
|
||||
assert.match(map, /- \[x\] \[Codebase context\]\(\.\/questions\/00-codebase-context\.md\) — Node and Postgres; a long gist\n that wraps onto a second line\. \*\(2026-08-01\)\*/, "an unchanged row keeps its own wrapped text");
|
||||
assert.match(map, /- \[x\] \[Export format\]\(\.\/questions\/01-export-format\.md\) — CSV with a BOM\. \*\(2026-08-02\)\*/);
|
||||
assert.match(map, /- \[ \] \[Row-count\n ceiling\]\(\.\/questions\/02-row-count-ceiling\.md\)/, "a wrapped link is still one row");
|
||||
assert.match(map, /- \[!\] \[Delivery channel\]\(\.\/questions\/04-delivery-channel\.md\) — Blocked by 02/);
|
||||
assert.match(map, /- \[-\] \[SIEM push\]\(\.\/questions\/05-siem-push\.md\) — out of scope, see below/);
|
||||
assert.ok(!map.includes("09-gone"), "a row with no file is dropped");
|
||||
assert.match(map, /<!-- Rebuilt from questions\/ every session\. -->/);
|
||||
const q1 = read(root, `${pf}/questions/01-export-format.md`);
|
||||
assert.match(q1, /State: resolved\nBlocked by: none\nClaimed: 2026-08-02 10:00\nResolved: 2026-08-02\nLocked: yes/, "Resolved: inserted in schema order");
|
||||
assert.match(read(root, `${pf}/questions/02-row-count-ceiling.md`), /State: open\nBlocked by: none\nClaimed: none/);
|
||||
const again = P("reconcile", "audit-export");
|
||||
assert.deepEqual([again.json.repairs.length, again.json.mapChanges.length, again.json.mapWritten], [0, 0, false], "idempotent");
|
||||
});
|
||||
|
||||
test("pathfinder frontier, claim, resolve, rule-out", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
let f = P("frontier", `${pf}`).json;
|
||||
assert.deepEqual(f.frontier.map((x) => x.nn), ["02", "03"]);
|
||||
assert.deepEqual(f.blocked.map((x) => [x.nn, x.blockedBy.map((b) => b.nn)]), [["04", ["02"]]]);
|
||||
assert.equal(f.nextNN, "10", "09 was linked from the map before reconcile dropped its row: never reissued");
|
||||
assert.match(read(root, `${pf}/map.md`), /^\*\*Confidence:\*\*.*\n\*\*Next NN:\*\* 10$/m, "reconcile keeps the high-water mark at the end of the header block");
|
||||
assert.deepEqual(f.counts, { resolved: 2, total: 5, outOfScope: 1, fog: 1 });
|
||||
assert.deepEqual(f.drift, []);
|
||||
assert.equal(P("claim", "audit-export", "04").code, 5, "blocked");
|
||||
assert.equal(P("claim", "audit-export", "05").code, 5, "out of scope");
|
||||
assert.equal(P("claim", "audit-export", "77").code, 3);
|
||||
const c = P("claim", "audit-export", "2");
|
||||
assert.equal(c.code, 0, c.stderr);
|
||||
assert.equal(c.json.claimed, NOW);
|
||||
assert.match(read(root, `${pf}/questions/02-row-count-ceiling.md`), /State: claimed\nBlocked by: none\nClaimed: 2026-08-03 14:05/);
|
||||
assert.match(read(root, `${pf}/map.md`), /- \[\/\] \[Row-count\n ceiling\]/);
|
||||
assert.equal(P("claim", "audit-export", "03").json.error, "claim-open", "one claim at a time");
|
||||
assert.equal(P("resolve", "audit-export", "02").json.error, "no-answer");
|
||||
const qp = path.join(root, pf, "questions/02-row-count-ceiling.md");
|
||||
fs.appendFileSync(qp, "\n## Answer\n\nFacts.\n");
|
||||
assert.equal(P("resolve", "audit-export", "02").json.error, "no-gist");
|
||||
fs.appendFileSync(qp, "\n**Gist:** 2M rows at the 99th percentile.\n");
|
||||
const res = P("resolve", "audit-export", "02");
|
||||
assert.equal(res.code, 0, res.stderr);
|
||||
assert.deepEqual(res.json.unblocked, [{ nn: "04", name: "Delivery channel" }]);
|
||||
const map = read(root, `${pf}/map.md`);
|
||||
assert.match(map, /- \[x\] \[Row-count ceiling\]\(\.\/questions\/02-row-count-ceiling\.md\) — 2M rows at the 99th percentile\. \*\(2026-08-03\)\*/);
|
||||
assert.match(map, /- \[ \] \[Delivery channel\]\(\.\/questions\/04-delivery-channel\.md\)\n/, "the Blocked by tail goes with the [!] marker");
|
||||
assert.match(map, /^\*\*Updated:\*\* 2026-08-03$/m);
|
||||
const ro = P("rule-out", "audit-export", "03", "--reason", "testing is owned elsewhere");
|
||||
assert.equal(ro.code, 0, ro.stderr);
|
||||
assert.match(read(root, `${pf}/questions/03-testing-posture.md`), /State: out-of-scope[\s\S]*## Question\n\nOut of scope: testing is owned elsewhere/);
|
||||
assert.match(read(root, `${pf}/map.md`), /## Out of scope\n\n- Redesign of the schema\.\n- \[Testing posture\]\(\.\/questions\/03-testing-posture\.md\) — testing is owned elsewhere/);
|
||||
assert.equal(P("rule-out", "audit-export", "04").code, 2, "--reason is required");
|
||||
assert.equal(P("rule-out", "audit-export", "00", "--reason", "x").code, 5, "a resolved decision is not ruled out");
|
||||
});
|
||||
|
||||
test("pathfinder trail: exact footer for forms A, B and C", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
P("claim", "audit-export", "03");
|
||||
const b = P("trail", "audit-export", "--form", "B", "--item", "Q1 Types", "--item", "Q2 Cadence", "--text");
|
||||
assert.equal(b.code, 0, b.stderr);
|
||||
assert.equal(b.stdout, [
|
||||
"🧭 audit-export · Working · 2/5 cleared",
|
||||
" START ●━●··○━◉··⊘··⊝ ····⚑",
|
||||
" ● done · ◉ here · ○ open · ⊘ blocked · ⊝ out of scope · ⚑ destination · ~1 fog",
|
||||
" 1 Codebase context ✔ · 2 Export format ✔ · 3 Row-count ceiling · 4 Testing posture ◀ here",
|
||||
" 5 Delivery channel (blocked:3) · 6 SIEM push (out of scope)",
|
||||
" Confidence: not yet — Feasibility still needs work.",
|
||||
"",
|
||||
"WAITING ON YOU · answer here, in this conversation:",
|
||||
"Q1 Types · Q2 Cadence",
|
||||
"",
|
||||
].join("\n"));
|
||||
assert.equal(P("trail", "audit-export", "--form", "B").code, 2, "Form B names its items");
|
||||
assert.equal(P("trail", "audit-export", "--form", "B", "--item", "1", "--item", "2", "--item", "3", "--item", "4").code, 5, "three-probe cap");
|
||||
assert.equal(P("trail", "audit-export", "--form", "C").json.error, "claim-open", "no menu while a claim is open");
|
||||
const a = P("trail", "audit-export", "--form", "A", "--text").stdout;
|
||||
assert.ok(a.endsWith("NEXT STEP · start a new conversation and run:\n`/plan2code-0-pathfinder specs/audit-export/pathfinder --web`\n"), a);
|
||||
fs.appendFileSync(path.join(root, pf, "questions/03-testing-posture.md"), "\n## Answer\n\nUnit; `Run after each phase`; `Critical paths`.\n\n**Gist:** Unit tests, run after each phase.\n");
|
||||
P("resolve", "audit-export", "03");
|
||||
const c = P("trail", "audit-export", "--form", "C", "--resolved-this-session", "3");
|
||||
assert.equal(c.code, 0, c.stderr);
|
||||
assert.ok(c.json.text.endsWith("OR START FRESH · new conversation, paste:\n`/plan2code-0-pathfinder specs/audit-export/pathfinder --web`"));
|
||||
assert.deepEqual(c.json.menu.options.map((o) => o.label), ["Row-count ceiling", "Start fresh"]);
|
||||
assert.equal(c.json.menu.recommended, "Start fresh", "the checkpoint after ~3 decisions");
|
||||
assert.equal(P("trail", "audit-export", "--form", "C").json.menu.recommended, "Row-count ceiling");
|
||||
});
|
||||
|
||||
test("pathfinder trail: a cleared map arrives; init first only while AGENTS.md is still missing", () => {
|
||||
const root = tmp("pfc");
|
||||
const pf = "specs/done/pathfinder";
|
||||
write(root, `${pf}/map.md`, MAP.replace("**Status:** Working", "**Status:** Cleared").replace("- `AGENTS.md` exists and governs.", "- `AGENTS.md` is absent; continued without it.").replace(/## Not yet specified\n\n- How far back an export may reach\.\n/, "## Not yet specified\n\n").replace("Feasibility-technical 14/25", "Feasibility-technical 22/25"));
|
||||
write(root, `${pf}/questions/00-codebase-context.md`, q("Codebase context", { state: "resolved", resolved: "2026-08-01", answer: "**Gist:** Node." }));
|
||||
write(root, `${pf}/questions/01-export-format.md`, q("Export format", { state: "resolved", resolved: "2026-08-02", answer: "**Gist:** CSV." }));
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "done");
|
||||
assert.equal(P("trail", "done", "--form", "A", "--text").stdout, [
|
||||
"🧭 done · Cleared · 2/2 cleared",
|
||||
" START ●━●━⚑ arrived",
|
||||
" Confidence: solid, but Requirements, Risk are borderline.",
|
||||
"",
|
||||
"NEXT STEP · start a new conversation and run:",
|
||||
"`/plan2code-init`, then `/plan2code-1-plan --web`",
|
||||
"",
|
||||
].join("\n"));
|
||||
write(root, "AGENTS.md", "# AGENTS.md\n");
|
||||
assert.match(P("trail", "done", "--form", "A", "--text").stdout, /run:\n`\/plan2code-1-plan --web`\n$/);
|
||||
assert.equal(P("trail", "done", "--form", "C").code, 5, "no menu on a cleared map");
|
||||
});
|
||||
|
||||
test("pathfinder gate: mechanical checks and hard caps", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
let g = P("gate", "audit-export").json;
|
||||
assert.equal(g.mechanicalPass, false);
|
||||
const failed = g.checks.filter((c) => !c.pass).map((c) => c.id);
|
||||
assert.deepEqual(failed, ["no-open-claimed-blocked", "fog-empty", "hard-caps", "scores-at-least-18"]);
|
||||
assert.ok(g.caps.some((c) => c.dimension === "Requirements" && /not resolved/.test(c.why)));
|
||||
assert.ok(g.caps.some((c) => c.dimension === "Risk" && /Export format records no consequences/.test(c.why)));
|
||||
assert.equal(g.planDraftPath, "specs/audit-export/PLAN-DRAFT-20260803.md");
|
||||
// Settle everything.
|
||||
const qd = path.join(root, pf, "questions");
|
||||
fs.writeFileSync(path.join(qd, "01-export-format.md"), q("Export format", { state: "resolved", resolved: "2026-08-02", locked: "yes", answer: "CSV.\n\n**Consequences**\n\n- Excel.\n\n**Gist:** CSV." }));
|
||||
fs.writeFileSync(path.join(qd, "02-row-count-ceiling.md"), q("Row-count ceiling", { type: "research · AFK", state: "resolved", resolved: "2026-08-02", answer: "**Gist:** 2M." }));
|
||||
fs.writeFileSync(path.join(qd, "03-testing-posture.md"), q("Testing posture", { state: "resolved", resolved: "2026-08-02", answer: "Unit and integration. `Dedicated phase only`. `Moderate (~60-80%)`.\n\n**Gist:** Unit." }));
|
||||
fs.writeFileSync(path.join(qd, "04-delivery-channel.md"), q("Delivery channel", { state: "resolved", resolved: "2026-08-03", blocked: "02", answer: "**Gist:** Link." }));
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("- How far back an export may reach.\n", "").replace("Feasibility-technical 14/25", "Feasibility-technical 20/25"));
|
||||
P("reconcile", "audit-export");
|
||||
g = P("gate", "audit-export").json;
|
||||
assert.deepEqual(g.checks.filter((c) => !c.pass).map((c) => c.id), ["hard-caps"]);
|
||||
assert.match(g.caps[0].why, /research 02 Row-count ceiling is resolved with an empty ## Evidence/);
|
||||
fs.appendFileSync(path.join(qd, "02-row-count-ceiling.md"), "\n## Evidence\n\n- Query plan.\n\n**Research complete:** 2026-08-02\n");
|
||||
g = P("gate", "audit-export").json;
|
||||
assert.equal(g.mechanicalPass, true, JSON.stringify(g.checks));
|
||||
assert.ok(g.judgment.length >= 2, "the gate names what stays judgment");
|
||||
});
|
||||
|
||||
test("pathfinder lint: loop tokens, checkboxes, reserved names, schema, cycles, scraper bait", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
let l = P("lint", "audit-export");
|
||||
assert.equal(l.code, 0, JSON.stringify(l.json.problems));
|
||||
const qd = path.join(root, pf, "questions");
|
||||
fs.appendFileSync(path.join(qd, "03-testing-posture.md"), "\n- [ ] a checkbox\nTASK_COMPLETE\n");
|
||||
fs.writeFileSync(path.join(qd, "06-loop-a.md"), q("Loop A", { blocked: "07" }));
|
||||
fs.writeFileSync(path.join(qd, "07-loop-b.md"), q("Loop B", { blocked: "06", type: "chat · HITL" }));
|
||||
write(root, `${pf}/overview.md`, "nope");
|
||||
write(root, `${pf}/briefs/brief-20260803.md`, "Requirements 18 and 90%\n");
|
||||
write(root, "specs/audit-export/PLAN-DRAFT-20260803.md", "**Charted by:** `/plan2code-0-pathfinder`\n**Confidence:** 85%\n| Requirements | 11 |\n");
|
||||
l = P("lint", "audit-export");
|
||||
assert.equal(l.code, 4);
|
||||
const msgs = l.json.problems.map((p) => `${p.file}: ${p.message}`).join("\n");
|
||||
for (const re of [/03-testing-posture\.md: has a checkbox/, /03-testing-posture\.md: contains the loop completion token TASK_COMPLETE/, /cycle 06 -> 07 -> 06|cycle 07 -> 06 -> 07/, /Type: "chat · HITL"/, /overview\.md is a reserved name/, /brief-20260803\.md: metrics-scraper bait \(bare Requirements/, /brief-20260803\.md: contains %/, /PLAN-DRAFT-20260803\.md: metrics-scraper bait \(overall confidence with %/, /PLAN-DRAFT-20260803\.md: metrics-scraper bait \(bare Requirements/]) {
|
||||
assert.match(msgs, re);
|
||||
}
|
||||
});
|
||||
|
||||
test("pathfinder brief-data: range filtering, frontier notes, plain sections", () => {
|
||||
const { root } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
const today = P("brief-data", "audit-export").json;
|
||||
assert.equal(today.file, "specs/audit-export/pathfinder/briefs/brief-20260803.md");
|
||||
assert.deepEqual(today.decided, []);
|
||||
assert.equal(today.note, "No decisions were recorded in this period.");
|
||||
const full = P("brief-data", "audit-export", "--range", "full").json;
|
||||
assert.deepEqual(full.decided.map((d) => d.name), ["Codebase context", "Export format"]);
|
||||
assert.deepEqual(full.decided[1].rejected, ["*JSONL* - recipients use Excel."]);
|
||||
assert.equal(full.decided[1].hardToReverse, true);
|
||||
assert.equal(full.progress, "2 of 5 decisions made");
|
||||
assert.deepEqual(full.waiting, [{ name: "Delivery channel", waitingOn: ["Row-count ceiling"] }]);
|
||||
assert.deepEqual(full.fog, ["How far back an export may reach."]);
|
||||
assert.deepEqual(full.ruledOut, ["Redesign of the schema."]);
|
||||
assert.equal(full.confidence, "Confidence: not yet — Feasibility still needs work.");
|
||||
const since = P("brief-data", "audit-export", "--range", "since:2026-08-02").json;
|
||||
assert.deepEqual(since.decided.map((d) => d.name), ["Export format"]);
|
||||
assert.deepEqual(P("brief-data", "audit-export", "--range", "2026-08-01..2026-08-01").json.decided.map((d) => d.name), ["Codebase context"]);
|
||||
assert.equal(P("brief-data", "audit-export", "--range", "2026-08-05..2026-08-01").code, 2);
|
||||
assert.equal(P("brief-data", "audit-export", "--range", "yesterday").code, 2);
|
||||
assert.equal(P("brief-data", "nope").code, 3);
|
||||
});
|
||||
|
||||
/* ================================================= verification regressions */
|
||||
|
||||
test("pathfinder: a ## Answer inside a fenced sketch is content, not an answer", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const qd = path.join(root, pf, "questions");
|
||||
fs.writeFileSync(path.join(qd, "03-testing-posture.md"), q("Testing posture", { type: "sketch · HITL", evidence: "```markdown\n## Answer\n\n**Gist:** fake\n```" }));
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
const r = P("reconcile", "audit-export");
|
||||
assert.ok(!r.json.repairs.some((x) => x.nn === "03"), JSON.stringify(r.json.repairs));
|
||||
assert.match(read(root, `${pf}/questions/03-testing-posture.md`), /State: open/);
|
||||
});
|
||||
|
||||
test("pathfinder reconcile: an unrepairable file is skipped and named, nothing half-written, its row kept", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
write(root, `${pf}/questions/07-bare.md`, `${B}\n\n# Bare\n\n## Answer\n\nYes.\n`);
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("- [ ] [Gone question]", "- [ ] [Bare](./questions/07-bare.md)\n- [ ] [Gone question]"));
|
||||
const r = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["reconcile", "audit-export", "--root", root]);
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.deepEqual(r.json.findings.map((f) => [f.file, f.finding]), [["07-bare.md", "unrepairable"]]);
|
||||
assert.match(read(root, `${pf}/questions/01-export-format.md`), /State: resolved/, "the other repairs still landed");
|
||||
assert.equal(read(root, `${pf}/questions/07-bare.md`), `${B}\n\n# Bare\n\n## Answer\n\nYes.\n`, "left untouched");
|
||||
assert.ok(!r.json.mapChanges.some((c) => c.file === "07-bare.md"), JSON.stringify(r.json.mapChanges));
|
||||
assert.match(read(root, `${pf}/map.md`), /^- \[.\] \[Bare\]\(\.\/questions\/07-bare\.md\)$/m, "its row survives");
|
||||
});
|
||||
|
||||
test("pathfinder reconcile: rows stay in place among grouping lines, a re-opened row loses its gist, stray claims clear", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("- [ ] [Export format]", "### Group two\n\n- [x] [Export format]").replace("- [ ] [Export format](./questions/01-export-format.md)", "- [x] [Export format](./questions/01-export-format.md) — old gist *(2026-07-01)*"));
|
||||
fs.writeFileSync(path.join(root, pf, "questions/01-export-format.md"), q("Export format", { claimed: "2026-08-02 10:00" }));
|
||||
const r = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["reconcile", "audit-export", "--root", root]);
|
||||
assert.ok(r.json.repairs.some((x) => x.nn === "01" && x.repair === "stray-claim-cleared"));
|
||||
const map = read(root, `${pf}/map.md`);
|
||||
assert.match(map, /### Group two\n\n- \[ \] \[Export format\]\(\.\/questions\/01-export-format\.md\)\n/, "the group heading keeps its place and the row its old tail is gone");
|
||||
});
|
||||
|
||||
test("pathfinder gate: testing posture by keyword (never from Rejected), research-style consequences count", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const qd = path.join(root, pf, "questions");
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
fs.writeFileSync(path.join(qd, "03-testing-posture.md"), q("Testing posture", { state: "resolved", resolved: "2026-08-02", answer: "Unit + integration, run after each phase, moderate coverage.\n\n**Gist:** Unit." }));
|
||||
fs.writeFileSync(path.join(qd, "01-export-format.md"), q("Export format", { state: "resolved", resolved: "2026-08-02", locked: "yes", answer: "### What this implies\n\n- Excel only.\n\n**Gist:** CSV." }));
|
||||
P("reconcile", "audit-export");
|
||||
let caps = P("gate", "audit-export").json.caps;
|
||||
assert.ok(!caps.some((c) => c.dimension === "Requirements"), JSON.stringify(caps));
|
||||
assert.ok(!caps.some((c) => c.dimension === "Risk"), JSON.stringify(caps));
|
||||
fs.writeFileSync(path.join(qd, "03-testing-posture.md"), q("Testing posture", { state: "resolved", resolved: "2026-08-02", answer: "Unit tests.\n\n**Rejected**\n\n- Run after each phase with Moderate coverage: too slow.\n\n**Gist:** Unit." }));
|
||||
caps = P("gate", "audit-export").json.caps;
|
||||
assert.ok(caps.some((c) => c.dimension === "Requirements" && /cadence/.test(c.why)), "a cadence named only as rejected does not count");
|
||||
});
|
||||
|
||||
test("pathfinder: Form C needs a frontier; names come from the rows; NN is never handed out twice", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("[Testing posture](", "[How we test]("));
|
||||
const c = P("trail", "audit-export", "--form", "C").json;
|
||||
assert.deepEqual(c.menu.options.map((o) => o.label), ["Row-count ceiling", "How we test", "Start fresh"]);
|
||||
fs.rmSync(path.join(root, pf, "questions/05-siem-push.md"));
|
||||
// Without the high-water line (an older map), the links alone still count.
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace(/^\*\*Next NN:\*\*.*\n/m, ""));
|
||||
assert.equal(P("frontier", "audit-export").json.nextNN, "06", "05 is still linked from the map");
|
||||
const qd = path.join(root, pf, "questions");
|
||||
fs.writeFileSync(path.join(qd, "02-row-count-ceiling.md"), q("Row-count ceiling", { blocked: "04" }));
|
||||
fs.writeFileSync(path.join(qd, "03-testing-posture.md"), q("Testing posture", { blocked: "04 (needs the channel)" }));
|
||||
P("reconcile", "audit-export");
|
||||
const none = P("trail", "audit-export", "--form", "C");
|
||||
assert.equal(none.code, 5);
|
||||
assert.equal(none.json.error, "no-frontier");
|
||||
});
|
||||
|
||||
test("pathfinder lint: map %, brief scores and checkboxes, Planning Metrics in a pathfinder draft", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["reconcile", "audit-export", "--root", root]);
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8") + "\n80% sure.\n");
|
||||
write(root, `${pf}/briefs/brief-20260803.md`, "Solid at 22/25.\n- [ ] todo\n");
|
||||
write(root, "specs/audit-export/PLAN-DRAFT-20260803.md", "**Charted by:** `/plan2code-0-pathfinder`\n\n## Planning Metrics\n");
|
||||
const l = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["lint", "audit-export", "--root", root]).json;
|
||||
const msgs = l.problems.map((p) => `${p.level} ${p.message}`).join("\n");
|
||||
assert.match(msgs, /warn contains %; the map/);
|
||||
assert.match(msgs, /error contains a raw NN\/25 score/);
|
||||
assert.match(msgs, /error has a checkbox line/);
|
||||
assert.match(msgs, /error has a ## Planning Metrics section/);
|
||||
});
|
||||
|
||||
test("pathfinder brief-data: calendar dates only, no future since, no NNs or links in what a brief prints", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
assert.equal(P("brief-data", "audit-export", "--range", "since:2026-13-99").json.error, "bad-date");
|
||||
assert.equal(P("brief-data", "audit-export", "--range", "since:2026-09-01").code, 2);
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("- Redesign of the schema.", "- [SIEM push](./questions/05-siem-push.md) — not ours.\n- Nothing yet."));
|
||||
fs.writeFileSync(path.join(root, pf, "questions/04-delivery-channel.md"), q("Delivery channel", { blocked: "09" }));
|
||||
const j = P("brief-data", "audit-export", "--range", "full").json;
|
||||
assert.deepEqual(j.ruledOut, ["SIEM push — not ours."]);
|
||||
assert.deepEqual(j.waiting.find((w) => w.name === "Delivery channel").waitingOn, ["a question that no longer exists"]);
|
||||
});
|
||||
|
||||
/* ===================================================== review-fix regressions */
|
||||
|
||||
test("pathfinder: claim, resolve and rule-out honour --dry-run", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
const snap = () => fs.readdirSync(path.join(root, pf, "questions")).map((n) => read(root, `${pf}/questions/${n}`)).concat(read(root, `${pf}/map.md`));
|
||||
const before = snap();
|
||||
const c = P("claim", "audit-export", "03", "--dry-run");
|
||||
assert.equal(c.code, 0, c.stderr);
|
||||
assert.deepEqual([c.json.dryRun, c.json.mapWritten], [true, false]);
|
||||
assert.deepEqual(snap(), before, "claim --dry-run leaves every file unchanged");
|
||||
fs.appendFileSync(path.join(root, pf, "questions/03-testing-posture.md"), "\n## Answer\n\nUnit.\n\n**Gist:** Unit.\n");
|
||||
const withAnswer = snap();
|
||||
const r = P("resolve", "audit-export", "03", "--dry-run");
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.deepEqual([r.json.dryRun, r.json.mapWritten], [true, false]);
|
||||
assert.deepEqual(snap(), withAnswer, "resolve --dry-run writes nothing");
|
||||
const o = P("rule-out", "audit-export", "02", "--reason", "not ours", "--dry-run");
|
||||
assert.equal(o.code, 0, o.stderr);
|
||||
assert.deepEqual([o.json.dryRun, o.json.mapWritten], [true, false]);
|
||||
assert.deepEqual(snap(), withAnswer, "rule-out --dry-run writes nothing");
|
||||
const real = P("claim", "audit-export", "02");
|
||||
assert.deepEqual([real.json.dryRun, real.json.mapWritten], [false, true]);
|
||||
});
|
||||
|
||||
test("pathfinder: a deleted top NN is never reissued, linked from an answer or not", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
const qd = path.join(root, pf, "questions");
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
// Start from a map with no high-water line and no stale 09 link: reconcile adds the line.
|
||||
fs.writeFileSync(mp, MAP.replace("- [ ] [Gone question](./questions/09-gone.md)\n", ""));
|
||||
fs.writeFileSync(path.join(qd, "06-subsumed.md"), q("Subsumed"));
|
||||
let r = P("reconcile", "audit-export");
|
||||
assert.deepEqual(r.json.mapChanges.find((c) => c.change === "next-nn"), { change: "next-nn", from: null, to: "07" });
|
||||
assert.match(read(root, `${pf}/map.md`), /^\*\*Next NN:\*\* 07$/m);
|
||||
// resolve.md: delete the subsumed file, reconcile drops its row, the absorbing answer links to it.
|
||||
fs.rmSync(path.join(qd, "06-subsumed.md"));
|
||||
fs.appendFileSync(path.join(qd, "04-delivery-channel.md"), "\n## Answer\n\nAbsorbed [Subsumed](./questions/06-subsumed.md).\n\n**Gist:** Link.\n");
|
||||
r = P("reconcile", "audit-export");
|
||||
assert.ok(r.json.mapChanges.some((c) => c.change === "row-dropped" && c.file === "06-subsumed.md"));
|
||||
assert.ok(!read(root, `${pf}/map.md`).includes("06-subsumed"), "the map no longer links it");
|
||||
assert.equal(P("frontier", "audit-export").json.nextNN, "07", "linked from an answer");
|
||||
// Even with the answer's link gone, the high-water mark holds.
|
||||
fs.writeFileSync(path.join(qd, "04-delivery-channel.md"), q("Delivery channel", { blocked: "02" }));
|
||||
assert.equal(P("frontier", "audit-export").json.nextNN, "07", "the **Next NN:** line");
|
||||
assert.equal(P("reconcile", "audit-export").json.nextNN, "07", "reconcile never lowers it");
|
||||
assert.equal(P("lint", "audit-export").code, 0, "lint accepts the line");
|
||||
});
|
||||
|
||||
test("pathfinder: a name with brackets round-trips; reconcile is stable", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
write(root, `${pf}/questions/06-retention.md`, q("Retention [legal] hold"));
|
||||
for (let i = 0; i < 3; i++) assert.equal(P("reconcile", "audit-export").code, 0);
|
||||
const map = read(root, `${pf}/map.md`);
|
||||
assert.equal(map.split("\n").filter((l) => l.includes("06-retention.md")).length, 1, map);
|
||||
assert.match(map, /^- \[ \] \[Retention \[legal\] hold\]\(\.\/questions\/06-retention\.md\)$/m);
|
||||
assert.deepEqual(P("frontier", "audit-export").json.drift, []);
|
||||
assert.equal(P("reconcile", "audit-export").json.mapWritten, false);
|
||||
});
|
||||
|
||||
test("pathfinder: an author's sub-bullet under a row survives resolve, rule-out and a marker change", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8")
|
||||
.replace("- [ ] [Testing posture](./questions/03-testing-posture.md)", "- [ ] [Testing posture](./questions/03-testing-posture.md)\n - note: ask Dana first")
|
||||
.replace("- [ ] [Delivery channel](./questions/04-delivery-channel.md)", "- [ ] [Delivery channel](./questions/04-delivery-channel.md)\n - note: depends on the volume\n and wraps"));
|
||||
P("reconcile", "audit-export");
|
||||
let map = read(root, `${pf}/map.md`);
|
||||
assert.match(map, /- \[!\] \[Delivery channel\]\(\.\/questions\/04-delivery-channel\.md\) — Blocked by 02\n - note: depends on the volume\n and wraps\n/, "kept under a regenerated [!] row");
|
||||
P("claim", "audit-export", "03");
|
||||
fs.appendFileSync(path.join(root, pf, "questions/03-testing-posture.md"), "\n## Answer\n\nUnit.\n\n**Gist:** Unit tests only.\n");
|
||||
assert.equal(P("resolve", "audit-export", "03").code, 0);
|
||||
map = read(root, `${pf}/map.md`);
|
||||
assert.match(map, /- \[x\] \[Testing posture\]\(\.\/questions\/03-testing-posture\.md\) — Unit tests only\. \*\(2026-08-03\)\*\n - note: ask Dana first\n/, "kept on resolve");
|
||||
assert.equal(P("rule-out", "audit-export", "04", "--reason", "not ours").code, 0);
|
||||
map = read(root, `${pf}/map.md`);
|
||||
assert.match(map, /- \[-\] \[Delivery channel\]\(\.\/questions\/04-delivery-channel\.md\) — out of scope, see below\n - note: depends on the volume\n and wraps\n/, "kept on rule-out");
|
||||
assert.deepEqual(P("frontier", "audit-export").json.drift, []);
|
||||
});
|
||||
|
||||
test("pathfinder: AGENTS.md absent reads in the canonical and the skill's own wording", () => {
|
||||
for (const line of ["- `AGENTS.md` is absent.", "- No `AGENTS.md`.", "- No AGENTS.md; init skipped."]) {
|
||||
const { root, pf } = mapFixture();
|
||||
fs.rmSync(path.join(root, "AGENTS.md"));
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("- `AGENTS.md` exists and governs.", line));
|
||||
const g = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["gate", "audit-export", "--root", root]).json;
|
||||
assert.deepEqual([g.agentsAbsent, g.initFirst], [true, true], line);
|
||||
}
|
||||
});
|
||||
|
||||
test("pathfinder lint: a failure carries error, message and next, on stderr too", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["reconcile", "audit-export", "--root", root]);
|
||||
fs.appendFileSync(path.join(root, pf, "questions/03-testing-posture.md"), "\n- [ ] a checkbox\n");
|
||||
const l = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["lint", "audit-export", "--root", root]);
|
||||
assert.equal(l.code, 4);
|
||||
assert.deepEqual([l.json.ok, l.json.error, l.json.message, l.json.next], [false, "lint-failed", "lint found 1 error.", "Fix each error in problems, then rerun lint."]);
|
||||
assert.equal(l.json.errors, 1);
|
||||
assert.equal(l.json.problems.filter((p) => p.level === "error").length, 1);
|
||||
assert.match(l.stderr, /^error: lint found 1 error\.\nnext: Fix each error in problems, then rerun lint\.\n$/);
|
||||
});
|
||||
|
||||
test("pathfinder lint: densely blocked questions check in linear time", () => {
|
||||
const root = tmp("pfd");
|
||||
const pf = "specs/dense/pathfinder";
|
||||
write(root, `${pf}/map.md`, MAP);
|
||||
write(root, `${pf}/questions/00-codebase-context.md`, q("Codebase context", { type: "legwork · AFK", state: "resolved", resolved: "2026-08-01", answer: "**Gist:** Node." }));
|
||||
for (let i = 1; i < 40; i++) {
|
||||
const nn = String(i).padStart(2, "0");
|
||||
const blocked = i === 1 ? "00" : [i - 1, i - 2].map((n) => String(n).padStart(2, "0")).join(", ");
|
||||
write(root, `${pf}/questions/${nn}-q${nn}.md`, q(`Q ${nn}`, { blocked }));
|
||||
}
|
||||
const t0 = Date.now();
|
||||
const l = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["lint", "dense", "--root", root]);
|
||||
const ms = Date.now() - t0;
|
||||
assert.ok(!(l.json.problems || []).some((p) => /cycle/.test(p.message)), JSON.stringify(l.json.problems));
|
||||
assert.ok(ms < 2000, `lint took ${ms} ms`);
|
||||
// A cycle is still found, once, in the same format.
|
||||
write(root, `${pf}/questions/01-q01.md`, q("Q 01", { blocked: "39" }));
|
||||
const c = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["lint", "dense", "--root", root]).json;
|
||||
const cycles = c.problems.filter((p) => /cycle/.test(p.message));
|
||||
assert.ok(cycles.length >= 1, JSON.stringify(c.problems));
|
||||
assert.match(cycles[0].message, /^Blocked by: cycle (\d\d)( -> \d\d)+ -> \1;/);
|
||||
});
|
||||
|
||||
test("pathfinder: a one-digit NN is question 0N everywhere, and lint asks for the rename", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
write(root, `${pf}/questions/6-short.md`, q("Short"));
|
||||
write(root, `${pf}/questions/07-after.md`, q("After", { blocked: "06" }));
|
||||
P("reconcile", "audit-export");
|
||||
const f = P("frontier", "audit-export").json;
|
||||
assert.ok(f.frontier.some((x) => x.nn === "06" && x.name === "Short"), JSON.stringify(f.frontier));
|
||||
assert.deepEqual(f.blocked.find((x) => x.nn === "07").blockedBy, [{ nn: "06", name: "Short", state: "open" }]);
|
||||
assert.equal(P("claim", "audit-export", "6").json.nn, "06");
|
||||
const l = P("lint", "audit-export").json;
|
||||
assert.ok(l.problems.some((p) => p.level === "error" && /6-short\.md$/.test(p.file) && /rename it to 06-short\.md/.test(p.message)), JSON.stringify(l.problems));
|
||||
});
|
||||
|
||||
test("pathfinder: a duplicate map row is reported as drift and dropped by name", () => {
|
||||
const { root, pf } = mapFixture();
|
||||
const P = (...a) => runScript("plan2code-0-pathfinder", "pathfinder.mjs", [...a, "--root", root]);
|
||||
P("reconcile", "audit-export");
|
||||
const mp = path.join(root, pf, "map.md");
|
||||
fs.writeFileSync(mp, fs.readFileSync(mp, "utf8").replace("- [ ] [Testing posture](./questions/03-testing-posture.md)", "- [ ] [Testing posture](./questions/03-testing-posture.md)\n- [ ] [Testing again](./questions/03-testing-posture.md)"));
|
||||
assert.ok(P("frontier", "audit-export").json.drift.includes("map row 03-testing-posture.md appears 2 times"));
|
||||
const r = P("reconcile", "audit-export");
|
||||
assert.deepEqual(r.json.mapChanges, [{ change: "row-dropped", file: "03-testing-posture.md", name: "Testing again", why: "duplicate row" }]);
|
||||
assert.equal(read(root, `${pf}/map.md`).split("\n").filter((l) => l.includes("03-testing-posture.md")).length, 1);
|
||||
assert.deepEqual(P("frontier", "audit-export").json.drift, []);
|
||||
});
|
||||
|
||||
test("pathfinder lint: the chart.md map template lints clean", () => {
|
||||
const chart = fs.readFileSync(path.join(SKILLS, "plan2code-0-pathfinder", "references", "chart.md"), "utf8");
|
||||
const template = chart.split("## The `map.md` template")[1].match(/```markdown\r?\n([\s\S]*?)\r?\n```/)[1];
|
||||
assert.match(template, /^\*\*Next NN:\*\* \d+$/m, "the template carries the high-water line");
|
||||
const root = tmp("pft");
|
||||
write(root, "specs/audit-log-export/pathfinder/map.md", template + "\n");
|
||||
const l = runScript("plan2code-0-pathfinder", "pathfinder.mjs", ["lint", "audit-log-export", "--root", root]);
|
||||
assert.equal(l.code, 0, JSON.stringify(l.json.problems));
|
||||
assert.deepEqual([l.json.errors, l.json.warnings], [0, 0], JSON.stringify(l.json.problems));
|
||||
});
|
||||
@@ -0,0 +1,113 @@
|
||||
// Tests for plan2code-xray's scripts/xray.mjs.
|
||||
//
|
||||
// See skill-script-helpers.mjs for how these run.
|
||||
|
||||
import { test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs";
|
||||
import path from "node:path";
|
||||
import { execFileSync } from "node:child_process";
|
||||
import { runScript, tmp, write, gitInit } from "./skill-script-helpers.mjs";
|
||||
|
||||
const X = (cwd, args, env) => runScript("plan2code-xray", "xray.mjs", args, { cwd, env });
|
||||
|
||||
// One fixture for the file: a.js and b.js always change together, hot.js
|
||||
// changes in most commits and has no test, the others are tested, and
|
||||
// old1.js and old2.js changed together before they were deleted.
|
||||
let fixture;
|
||||
function repo() {
|
||||
if (fixture) return fixture;
|
||||
const dir = tmp("xray");
|
||||
const g = gitInit(dir);
|
||||
const commit = (msg, files) => {
|
||||
for (const [rel, content] of Object.entries(files)) write(dir, rel, content);
|
||||
g("add", "-A");
|
||||
g("commit", "-q", "-m", msg);
|
||||
};
|
||||
commit("Start", { "a.js": "a1\n", "b.js": "b1\n", "hot.js": "h1\n", "c.js": "c1\n", "tests/a.test.js": "t\n", "tests/b.test.js": "t\n", "tests/c.test.js": "t\n" });
|
||||
commit("Change a and b (#12)", { "a.js": "a2\n", "b.js": "b2\n", "hot.js": "h2\n", "package-lock.json": "{}\n" });
|
||||
commit("Change a and b again", { "a.js": "a3\n", "b.js": "b3\n", "hot.js": "h3\n", "package-lock.json": "{ }\n" });
|
||||
commit("Change hot and c", { "hot.js": "h4\nmore\n", "c.js": "c2\n" });
|
||||
commit("Change hot alone", { "hot.js": "h5\nmore\n", "dist/out.js": "x\n" });
|
||||
// Without hot.js, so a-b (support 1) outranks a-hot and b-hot on support, not on name.
|
||||
commit("Change a and b only", { "a.js": "a4\n", "b.js": "b4\n" });
|
||||
for (let i = 1; i <= 3; i++) commit(`Change the old pair ${i}`, { "old1.js": `o${i}\n`, "old2.js": `p${i}\n` });
|
||||
g("rm", "-q", "old1.js", "old2.js");
|
||||
g("commit", "-q", "-m", "Delete the old pair");
|
||||
fixture = dir;
|
||||
return dir;
|
||||
}
|
||||
|
||||
// PATH with git (and node) but no gh: git's own exec dir holds a git binary
|
||||
// on every platform, so the directory that also holds gh is never needed.
|
||||
function pathWithoutGh() {
|
||||
const gitDir = execFileSync("git", ["--exec-path"], { encoding: "utf8" }).trim();
|
||||
const dirs = [path.resolve(gitDir)];
|
||||
const nodeDir = path.dirname(process.execPath);
|
||||
const hasGh = ["gh", "gh.exe"].some((n) => fs.existsSync(path.join(nodeDir, n)));
|
||||
if (!hasGh) dirs.push(nodeDir);
|
||||
const value = dirs.join(path.delimiter);
|
||||
// Windows keys env case-insensitively but a child gets both spellings: set both.
|
||||
return { PATH: value, Path: value };
|
||||
}
|
||||
|
||||
test("xray hotspots: the always-together pair ranks first, the hot file without a test is listed", () => {
|
||||
const r = X(repo(), ["hotspots"]);
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.equal(r.json.ok, true);
|
||||
assert.deepEqual(r.json.window, { commits: 10, capped: false });
|
||||
assert.deepEqual(r.json.churn[0], { file: "hot.js", commits: 5 });
|
||||
assert.ok(!r.json.churn.some((c) => c.file === "package-lock.json" || c.file.startsWith("dist/")), "lockfiles and dist/ are skipped");
|
||||
assert.deepEqual(r.json.pairs[0], { a: "a.js", b: "b.js", together: 4, support: 1 });
|
||||
assert.ok(r.json.pairs[1].support < 1, JSON.stringify(r.json.pairs));
|
||||
assert.ok(r.json.pairs.every((p) => p.together >= 3));
|
||||
const untested = r.json.untested.map((u) => u.file);
|
||||
assert.ok(untested.includes("hot.js"), JSON.stringify(r.json.untested));
|
||||
for (const tested of ["a.js", "b.js", "c.js"]) assert.ok(!untested.includes(tested), `${tested} has a test`);
|
||||
});
|
||||
|
||||
test("xray hotspots: files deleted since drop out of churn and pairs", () => {
|
||||
const r = X(repo(), ["hotspots"]);
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
const named = [...r.json.churn.map((c) => c.file), ...r.json.pairs.flatMap((p) => [p.a, p.b])];
|
||||
assert.ok(!named.some((f) => f.startsWith("old")), JSON.stringify(named));
|
||||
});
|
||||
|
||||
test("xray hotspots: --max-commits below the history sets capped", () => {
|
||||
const r = X(repo(), ["hotspots", "--max-commits", "2"]);
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.deepEqual(r.json.window, { commits: 2, capped: true });
|
||||
assert.equal(X(repo(), ["hotspots", "--top", "1"]).json.churn.length, 1);
|
||||
});
|
||||
|
||||
test("xray history: commits, blame and gh missing when gh is not on PATH", () => {
|
||||
const r = X(repo(), ["history", "hot.js"], pathWithoutGh());
|
||||
assert.equal(r.code, 0, r.stderr);
|
||||
assert.equal(r.json.path, "hot.js");
|
||||
assert.equal(r.json.commits.length, 5);
|
||||
assert.equal(r.json.commits[0].subject, "Change hot alone");
|
||||
assert.equal(r.json.commits[0].author, "Test");
|
||||
assert.match(r.json.commits[0].hash, /^[0-9a-f]{40}$/);
|
||||
assert.equal(r.json.blame.lines, 2);
|
||||
assert.deepEqual(r.json.blame.authors, [{ author: "Test", lines: 2, share: 1 }]);
|
||||
assert.match(r.json.blame.oldest, /^\d{4}-\d{2}-\d{2}$/);
|
||||
assert.deepEqual(r.json.prs, [{ number: 12, subject: "Change a and b (#12)", title: null, summary: null }]);
|
||||
assert.deepEqual(r.json.sources, { git: true, blame: true, gh: "missing" });
|
||||
});
|
||||
|
||||
test("xray: a folder outside any repository is exit 3 not-a-repo", () => {
|
||||
const plain = tmp("xray-plain");
|
||||
for (const args of [["hotspots"], ["history", "x.js"]]) {
|
||||
const r = X(plain, args);
|
||||
assert.equal(r.code, 3);
|
||||
assert.equal(r.json.ok, false);
|
||||
assert.equal(r.json.error, "not-a-repo");
|
||||
assert.match(r.json.next, /explain mode/);
|
||||
}
|
||||
});
|
||||
|
||||
test("xray: --help documents the exit codes", () => {
|
||||
const r = X(repo(), ["--help"]);
|
||||
assert.equal(r.code, 0);
|
||||
assert.match(r.stdout, /Exit:/);
|
||||
});
|
||||