mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-07-21 18:33:22 -07:00
Compare commits
31 Commits
v1.3.3
..
aedfe944b2
| Author | SHA1 | Date | |
|---|---|---|---|
| aedfe944b2 | |||
| 9b3c06b498 | |||
| 8fe1bfa805 | |||
| 68542fd778 | |||
| 4656a6ebb7 | |||
| 7e9de755f1 | |||
| 4b20f93bb9 | |||
| 5b3b84f0a9 | |||
| 1015b99a6a | |||
| 20a9e2f040 | |||
| 28bda05cbf | |||
| 5274bdbd51 | |||
| 25d874d87d | |||
| 5e48e98293 | |||
| 8e0b1a2ab2 | |||
| c2579a7b6a | |||
| 9d1104d105 | |||
| 72fed09aab | |||
| 37311a7e68 | |||
| c92865c395 | |||
| 63656d339d | |||
| 628e688ab9 | |||
| 157e55ef2e | |||
| 02fd4efa40 | |||
| 348c8ed7b2 | |||
| 5c2f70a37c | |||
| de46275b51 | |||
| b7b2595fe1 | |||
| 6f98f6bd7f | |||
| 035cc680a7 | |||
| 34704eaf84 |
@@ -0,0 +1,120 @@
|
||||
# Architecture
|
||||
> Part of [AGENTS.md](../AGENTS.md) — project guidance for AI coding agents.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
plan2code/
|
||||
├── src/ # Source workflow prompts (9 markdown files)
|
||||
│ └── 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
|
||||
├── plan2code-loop/ # Autonomous loop CLI tool (Node.js/TypeScript)
|
||||
│ ├── src/ # TypeScript source
|
||||
│ └── dist/ # Built output (tsup)
|
||||
├── plan2code-metrics/ # Recursive self-improvement toolchain
|
||||
│ ├── src/ # TypeScript source
|
||||
│ │ └── prompts/ # Internal AI prompt templates (no char limit)
|
||||
│ └── dist/ # Built output (tsup)
|
||||
├── 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
|
||||
├── scripts/ # Development scripts
|
||||
│ └── 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.)
|
||||
├── .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
|
||||
├── 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
|
||||
└── README.md # User documentation
|
||||
```
|
||||
|
||||
## Key Files
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `install.js` | Main installer - generates and installs workflow files to AI tool directories |
|
||||
| `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 |
|
||||
| `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) |
|
||||
|
||||
## Workflow Prompts (in `src/`)
|
||||
|
||||
| File | Step | Purpose |
|
||||
|------|------|---------|
|
||||
| `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-quick-task.md` | 0 | Lightweight planning for small tasks |
|
||||
| `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-4-finalize.md` | 4 | Validate, summarize, feedback, archive (7 steps) |
|
||||
| `plan2code-handoff.md` | handoff | Compact the conversation into a self-contained handoff document |
|
||||
|
||||
## Naming Convention
|
||||
|
||||
Workflow files follow a strict naming pattern:
|
||||
- **Utilities:** `plan2code-<name>.md` (single dash)
|
||||
- **Numbered steps:** `plan2code-<N>-<name>.md` (single dash, number, single dash)
|
||||
|
||||
Examples:
|
||||
- `plan2code-init.md` (utility)
|
||||
- `plan2code-1-plan.md` (step 1)
|
||||
- `plan2code-1b-revise-plan.md` (step 1b)
|
||||
|
||||
## 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.
|
||||
|
||||
**Pattern:** `src/<source-filename-without-extension>-references/` (e.g., `plan2code-review-references/`)
|
||||
|
||||
**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`).
|
||||
- **TOML platforms** (Gemini CLI): reference files are skipped — TOML embeds content inline, so Read directives won't resolve. The orchestrator's inline fallback text covers this.
|
||||
|
||||
Reference files are NOT subject to the 11,000 character limit. Currently only the review workflow uses this pattern — it serves as the POC for potential adoption by other workflows.
|
||||
|
||||
## 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.
|
||||
|
||||
- `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`.
|
||||
|
||||
**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.
|
||||
|
||||
## 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.
|
||||
|
||||
**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')`.
|
||||
- **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.
|
||||
|
||||
**Layout:**
|
||||
|
||||
```
|
||||
src/statusline-claude/
|
||||
├── statusline.js # Self-contained: config, git, formatters, render
|
||||
├── statusline-config.json # Default config template
|
||||
└── README.md # User docs: install, config, debugging
|
||||
```
|
||||
|
||||
**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`.
|
||||
@@ -0,0 +1,20 @@
|
||||
# Code Style & Gotchas
|
||||
> Part of [AGENTS.md](../AGENTS.md) — project guidance for AI coding agents.
|
||||
|
||||
## 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`
|
||||
- Interactive CLI via `@inquirer/prompts` (select, input, confirm)
|
||||
- **File operations:** Synchronous fs in all packages
|
||||
|
||||
## 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.
|
||||
- **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.
|
||||
- **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.
|
||||
- **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 `\|`.
|
||||
- **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.
|
||||
@@ -0,0 +1,102 @@
|
||||
# Development Commands
|
||||
> Part of [AGENTS.md](../AGENTS.md) — project guidance for AI coding agents.
|
||||
|
||||
## Common Commands
|
||||
|
||||
```bash
|
||||
# Install dev dependencies (sets up husky pre-commit hooks)
|
||||
npm install
|
||||
|
||||
# Run the interactive installer (always interactive — any CLI args are silently ignored)
|
||||
node install.js
|
||||
|
||||
# Plan2Code Loop
|
||||
cd plan2code-loop && npm install # First time setup
|
||||
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
|
||||
```
|
||||
|
||||
## 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 |
|
||||
| `Q` | Quit |
|
||||
|
||||
**CUSTOM sub-menu (`C`):**
|
||||
|
||||
| Option | Action |
|
||||
|--------|--------|
|
||||
| `L` | Show local (per-project) install instructions |
|
||||
| `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 |
|
||||
| `Q` | Return to main menu |
|
||||
|
||||
## 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.)
|
||||
|
||||
## Platform-Specific File 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 · Gemini CLI · 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 |
|
||||
| Gemini CLI (TOML) | `.toml` | `.gemini/commands/` | `~/.gemini/commands/` | None (TOML fields: `description`, `prompt`) |
|
||||
| Pi (pi.dev) | `.md` | `.pi/prompts/` | `~/.pi/agent/prompts/` | YAML frontmatter (`description`) |
|
||||
|
||||
## Editing Workflow Prompts
|
||||
|
||||
When modifying workflow prompts in `src/`:
|
||||
|
||||
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
|
||||
|
||||
## 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 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).
|
||||
@@ -0,0 +1,47 @@
|
||||
# Plan2Code Loop
|
||||
> Part of [AGENTS.md](../AGENTS.md) — project guidance for AI coding agents.
|
||||
|
||||
A separate Node.js CLI tool that autonomously implements specs by looping through tasks.
|
||||
|
||||
## Loop Architecture
|
||||
|
||||
The loop uses an **LLM-driven discovery** approach:
|
||||
- Node app just orchestrates iterations and parses completion markers
|
||||
- The LLM reads spec files (`overview.md`, `phase-X.md`) to discover tasks
|
||||
- The LLM finds unchecked checkboxes, implements ONE task per iteration, marks it complete
|
||||
- No regex parsing of markdown in Node - the AI handles all task discovery
|
||||
|
||||
## Loop Commands
|
||||
|
||||
```bash
|
||||
# Build the loop CLI
|
||||
cd plan2code-loop && npm run build
|
||||
|
||||
# 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. Session state is stored per-spec in `specs/<feature>/.plan2code-loop/`.
|
||||
|
||||
## Loop Modes
|
||||
|
||||
The CLI asks users to choose a loop mode:
|
||||
- **One task per loop** (default) - Each agent invocation implements exactly one task. The Node controller handles git commits.
|
||||
- **One phase per loop** - Each agent invocation implements all remaining tasks in the current phase. The LLM handles git commits (with JIRA ticket ID if provided). The controller parses multiple completion markers from a single iteration.
|
||||
|
||||
## Completion Markers
|
||||
|
||||
The LLM must output one of these formats:
|
||||
- `TASK_COMPLETE: 1.1 - Task description` - Task done successfully
|
||||
- `TASK_BLOCKED: 1.1 - Reason` - Cannot complete task
|
||||
- `PHASE_COMPLETE` - Current phase finished (phase mode only)
|
||||
- `LOOP_COMPLETE` - All phases finished
|
||||
|
||||
## Key Source Files
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `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 |
|
||||
@@ -0,0 +1,82 @@
|
||||
# Plan2Code Metrics
|
||||
> Part of [AGENTS.md](../AGENTS.md) — project guidance for AI coding agents.
|
||||
|
||||
A recursive self-improvement toolchain for plan2code contributors. Collects run metrics, aggregates by prompt generation, diagnoses weak steps via AI, and proposes surgical prompt edits.
|
||||
|
||||
## Metrics Data Flow
|
||||
|
||||
```
|
||||
Collect → Aggregate → Analyze → Improve → Apply
|
||||
```
|
||||
|
||||
1. **Collector** reads project artifacts (`specs/<feature>/`) → writes `RunMetrics` JSON per run
|
||||
2. **Aggregator** groups runs by prompt SHA fingerprint (cohorts) → `aggregated.json`
|
||||
3. **Analyzer** invokes AI with aggregated metrics + prompt contents → diagnosis markdown
|
||||
4. **Improver** invokes AI with diagnosis → validated `PromptEdit[]` proposals (char limit + verbatim checks)
|
||||
5. **Applier** shows interactive diffs → patches `src/plan2code-*.md` files
|
||||
|
||||
## Metrics Commands
|
||||
|
||||
```bash
|
||||
cd plan2code-metrics && npm run build # Build the CLI
|
||||
plan2code-metrics # Run (fully interactive, no flags)
|
||||
```
|
||||
|
||||
## Metrics CLI Menu
|
||||
|
||||
| Option | Action |
|
||||
|--------|--------|
|
||||
| Collect | Read spec artifacts → run JSON |
|
||||
| Import | Copy run JSON from another project |
|
||||
| View | Display cohort metrics with health indicators |
|
||||
| Analyze | AI diagnosis of weak metrics |
|
||||
| Propose | AI improvement proposals with validation |
|
||||
| Apply | Interactive diff review + file patching |
|
||||
|
||||
## Key Source Files
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `types.ts` | All interfaces (`RunMetrics`, `UserFeedback`, `CohortMetrics`, etc.) + `METRIC_TARGETS` |
|
||||
| `collector.ts` | Reads project artifacts → run JSON (parses plan drafts, overview.md, loop logs) |
|
||||
| `aggregator.ts` | Merges runs by prompt generation (SHA cohort) → `aggregated.json` |
|
||||
| `analyzer.ts` | AI diagnosis via `prompts/analyze.md` template |
|
||||
| `improver.ts` | AI proposals via `prompts/improve.md` + validation (char count, old_text match) |
|
||||
| `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 or Copilot CLI) |
|
||||
|
||||
## User Feedback
|
||||
|
||||
The collector parses an optional `## User Feedback` table from `overview.md`:
|
||||
|
||||
```markdown
|
||||
## User Feedback
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| Rating | 8 |
|
||||
| Reason | Smooth workflow |
|
||||
| Went Well | Planning was thorough |
|
||||
| Went Poorly | Some tasks unclear |
|
||||
```
|
||||
|
||||
Feedback is collected during finalize (Step 5) or retroactively via the CLI. Pipe characters in values are escaped as `\|`. The aggregator computes `avg_user_rating` and `feedback_count` per cohort.
|
||||
|
||||
## Supported AI Agents
|
||||
|
||||
- **Claude Code** (recommended): `claude` CLI with `--inputFile` for prompt delivery
|
||||
- **GitHub Copilot CLI**: `copilot` CLI with stdin prompt delivery
|
||||
|
||||
## Metric Targets
|
||||
|
||||
| Metric | Target | Direction |
|
||||
|--------|--------|-----------|
|
||||
| `avg_confidence` | ≥ 90 | higher 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/).
|
||||
@@ -0,0 +1,159 @@
|
||||
---
|
||||
name: plan2code-publish
|
||||
description: "Publish a GitHub Release for jparkerweb/plan2code whenever CHANGELOG.md's top version is ahead of the latest published release on GitHub — after verifying CHANGELOG.md, version.json, and package.json all agree on the version. Use this skill when the user says 'publish a release', 'create a GitHub release', 'cut a release', 'tag a release', 'tag and release', 'is the changelog published', or otherwise mentions publishing/releasing/tagging this repo."
|
||||
---
|
||||
|
||||
# Plan2Code Release Publisher
|
||||
|
||||
Publish a GitHub Release for `jparkerweb/plan2code` whenever `CHANGELOG.md`'s top version is ahead of the latest published release on GitHub. This turns the merged CHANGELOG entry on `main` into an actual GitHub Release (which also creates the `vX.Y.Z` git tag).
|
||||
|
||||
**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 (`uninstallFiles()` in `install.js`) and every re-install's pre-copy cleanup in `install()` both delete every entry matching `/^plan2code-/` under `~/.claude/skills/`, so a copy placed there would be silently removed.
|
||||
|
||||
## Workflow
|
||||
|
||||
### Step 1 — Preflight: clean working tree
|
||||
|
||||
Run `git status --porcelain`. If the output is non-empty, stop immediately — do not switch branches or take any other action. Tell the user:
|
||||
|
||||
> Working tree has uncommitted changes. Commit or stash them, then re-run this skill.
|
||||
|
||||
### Step 2 — Switch to main and pull
|
||||
|
||||
If the working tree is clean, switch to `main` and pull latest. Run these as two separate, non-chained commands (never `&&`/`;`-chain `git`/`gh` commands — Windows PowerShell 5.1 rejects `&&`):
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
### Step 3 — Read the three version sources
|
||||
|
||||
Read all three files at the repo root and extract each version:
|
||||
|
||||
- `CHANGELOG.md` — parse the first `## vX.Y.Z` heading. Strip the leading `v` → `$CHANGELOG_VERSION`. Note: plan2code CHANGELOG headings are `## vX.Y.Z` (v-prefixed, **no** date and **no** brackets) — different from a `## [x.y.z] - YYYY-MM-DD` format.
|
||||
- `version.json` — the `version` field → `$VERSION_JSON`. Also read its `releaseDate` field → `$RELEASE_DATE` (informational only — shown at the confirm step, never part of the sync gate; use `(none)` if absent).
|
||||
- `package.json` (root) → the `version` field → `$PACKAGE_JSON`.
|
||||
|
||||
Also capture from `CHANGELOG.md` the **section body** for the top version: everything from the `## vX.Y.Z` heading line itself (heading **included**) up to — but not including — the next `## v` heading, or end-of-file if there is none. Call this `$SECTION`. Keep the `## vX.Y.Z` heading in `$SECTION`; plan2code release bodies include it.
|
||||
|
||||
### Step 4 — Version-sync preflight (STOP on mismatch)
|
||||
|
||||
All three versions must be identical. This enforces the repo's documented invariant (`.agents-docs/AGENTS-code-style.md` → "Version sync"): `CHANGELOG.md`, `version.json`, and `package.json` must always show the same version number.
|
||||
|
||||
If `$CHANGELOG_VERSION`, `$VERSION_JSON`, and `$PACKAGE_JSON` are **not** all equal, **stop** — do not read the release, do not publish. Report exactly which files disagree:
|
||||
|
||||
> ⚠️ Version files are out of sync — refusing to publish. The repo requires `CHANGELOG.md`, `version.json`, and `package.json` to match.
|
||||
>
|
||||
> - **CHANGELOG.md:** $CHANGELOG_VERSION
|
||||
> - **version.json:** $VERSION_JSON
|
||||
> - **package.json:** $PACKAGE_JSON
|
||||
>
|
||||
> Fix the mismatch first, then re-run this skill. To realign: pick the intended version (normally the highest / newest CHANGELOG entry) and update the other two files to match — see the "Version sync" gotcha in `.agents-docs/AGENTS-code-style.md`.
|
||||
|
||||
This skill never modifies these files — it only reads and compares them.
|
||||
|
||||
### Step 5 — Determine the highest published release
|
||||
|
||||
List every published (non-draft) release and take the numerically-highest semver tag. Do **not** rely on `gh release view` / GitHub's "Latest" flag: that flag returns whatever release is *marked* latest — normally the newest semver, but a maintainer can manually pin it to an older release, which would make the Step 6 ahead-comparison misfire.
|
||||
|
||||
```bash
|
||||
gh release list --repo jparkerweb/plan2code --limit 100 --json tagName,isDraft -q '.[] | select(.isDraft==false) | .tagName'
|
||||
```
|
||||
|
||||
Strip any leading `v` from each returned tag, compare them as numeric `(major, minor, patch)` tuples (the same rule as Step 6), and take the maximum → `$RELEASE_VERSION`. If the command returns no tags or exits non-zero for **any** reason (no releases yet, transient error, etc.), set `$RELEASE_VERSION = "0.0.0"` — no error-text matching is needed.
|
||||
|
||||
### Step 6 — Compare versions
|
||||
|
||||
Compare `$CHANGELOG_VERSION` vs `$RELEASE_VERSION` as a numeric `(major, minor, patch)` tuple. Never do a plain string/lexicographic compare — e.g. `"1.9.0" > "1.10.0"` is true as strings but wrong numerically.
|
||||
|
||||
### Step 7 — Not ahead: no-op
|
||||
|
||||
If `$CHANGELOG_VERSION` ≤ `$RELEASE_VERSION`, print a simple status message showing both versions and stop:
|
||||
|
||||
> CHANGELOG top version ($CHANGELOG_VERSION) is not ahead of the latest published release ($RELEASE_VERSION). Nothing to publish.
|
||||
|
||||
No error is raised and no release is created.
|
||||
|
||||
### Step 8 — Ahead: compute and confirm
|
||||
|
||||
If `$CHANGELOG_VERSION` > `$RELEASE_VERSION`, compute:
|
||||
|
||||
- `tag = "v$CHANGELOG_VERSION"`
|
||||
- `title = "v$CHANGELOG_VERSION"` (plan2code keeps the `v` prefix in release titles)
|
||||
- `notes` = the header line `# What's New 🎉`, then one blank line, then `$SECTION` verbatim (`$SECTION` already starts with the `## vX.Y.Z` heading). Build this as a real multi-line string with **actual newlines** — the `\n\n` shorthand shown elsewhere means "a blank line," never the literal two-character sequence `\` + `n`. Getting this wrong would run the header and the first CHANGELOG heading together with a stray `\n\n` in the published body.
|
||||
|
||||
Present all three to the user and wait for an explicit answer before any write. Offer the optional decorative title suffix — a plain `vX.Y.Z` title is the default, but a release may append one (e.g. `v1.14.0 - 🔍 Review workflow`):
|
||||
|
||||
> 🚀 [Publish Plan2Code Release]
|
||||
>
|
||||
> CHANGELOG is ahead of the latest published release:
|
||||
> - **Current release:** $RELEASE_VERSION
|
||||
> - **CHANGELOG top version:** $CHANGELOG_VERSION
|
||||
> - **version.json releaseDate:** $RELEASE_DATE (informational — read from `version.json`)
|
||||
>
|
||||
> Proposed release:
|
||||
> - **Tag:** $tag
|
||||
> - **Title:** $title
|
||||
> - **Notes:**
|
||||
> ```
|
||||
> $notes
|
||||
> ```
|
||||
>
|
||||
> Publish this release? Reply **yes** to publish as-is, **no** to cancel, or provide a decorative suffix to append to the title (e.g. `⇢ 🎆 Feature Name` or `- 🔍 Feature Name`).
|
||||
|
||||
If the user supplies a suffix, set `title = "v$CHANGELOG_VERSION " + <suffix>` (single space join) and proceed to publish. The tag and notes are unaffected by the suffix.
|
||||
|
||||
### Step 9 — Publish (on approval)
|
||||
|
||||
On approval, write `$notes` to a temp file — never pass multiline text inline via `--notes`, that regresses into a quoting bug — then create the release targeting `main`. Two requirements for the temp file: `$notes` must already hold **real newlines** (per Step 8) because `printf '%s'` / `WriteAllText` write it byte-for-byte — a literal `\n` in the string lands literally in the release body; and it MUST be **UTF-8** because the notes contain emoji (`🎉`, `🐛`, `✨`, `🔧`).
|
||||
|
||||
**bash (preferred in this environment):**
|
||||
|
||||
```bash
|
||||
NOTES_FILE=$(mktemp)
|
||||
printf '%s' "$notes" > "$NOTES_FILE"
|
||||
gh release create "$tag" --repo jparkerweb/plan2code --title "$title" --notes-file "$NOTES_FILE" --target main
|
||||
rm -f "$NOTES_FILE"
|
||||
```
|
||||
|
||||
**PowerShell:** do NOT use `Set-Content` — under Windows PowerShell 5.1 it writes ANSI/UTF-16 by default and mangles the emoji into `??`. Write UTF-8 **without BOM** (a BOM would leak into the release body):
|
||||
|
||||
```powershell
|
||||
$NotesFile = [System.IO.Path]::GetTempFileName()
|
||||
[System.IO.File]::WriteAllText($NotesFile, $notes, [System.Text.UTF8Encoding]::new($false))
|
||||
gh release create "$tag" --repo jparkerweb/plan2code --title "$title" --notes-file "$NotesFile" --target main
|
||||
Remove-Item -Path $NotesFile
|
||||
```
|
||||
|
||||
Always delete the temp file afterward, regardless of whether `gh release create` succeeded or failed.
|
||||
|
||||
**Failure handling — already-exists classification:** if `gh release create` exits non-zero, inspect the error text.
|
||||
|
||||
- If and only if it contains the substring `already exists` (real output: `HTTP 422: Validation Failed` / `Release.tag_name already exists`), report this to the user as already published, not as a raw CLI error:
|
||||
|
||||
> This version ($CHANGELOG_VERSION) was already published as a release — nothing more to do.
|
||||
|
||||
- Every other failure (auth, network, permissions, etc.) must be surfaced to the user verbatim. Never silently reclassify a genuine failure as "already published."
|
||||
|
||||
### Step 10 — Verify
|
||||
|
||||
Confirm the release now exists and report its URL:
|
||||
|
||||
```bash
|
||||
gh release view "$tag" --repo jparkerweb/plan2code
|
||||
```
|
||||
|
||||
Report the release URL to the user.
|
||||
|
||||
## Rules
|
||||
|
||||
- **Repo-local only** — this skill is not part of the installed product; never add it to `install.js`, and never copy it to `~/.claude/skills/` (the uninstaller deletes `plan2code-*` entries there).
|
||||
- **Read-only on version files** — never modify `CHANGELOG.md`, `version.json`, or `package.json`; this skill only reads and compares them.
|
||||
- **Version-sync gate is hard** (Step 4) — if the three version sources disagree, stop and report; do not publish a release from an inconsistent repo.
|
||||
- **Never run a local `git tag` or `git push`** — tag creation is delegated entirely to `gh release create --target main`.
|
||||
- **Always use `--notes-file`**, never inline multiline `--notes`, and always write the notes file as UTF-8 (no BOM) so emoji survive.
|
||||
- **Always clean up the temp notes file**, even on a mid-run error.
|
||||
- **Always get explicit approval before any write** (Step 8) — no release is created without a yes (or a yes-with-suffix).
|
||||
- **Derive the current version from the highest published semver tag** (Step 5), never from GitHub's manually-pinnable "Latest" flag. On an empty or failed release list, treat it as "no prior release" (baseline `0.0.0`) — no error-text matching needed.
|
||||
- **On a `gh release create` failure** (Step 9), only reclassify as already-published when the error contains `already exists` — every other failure must be shown verbatim, never swallowed.
|
||||
- **Idempotent and safe to re-run** at any time — re-running after a successful publish hits the Step 7 no-op; re-running after a race-lost publish hits the Step 9 already-exists handling.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
name: sync-repo
|
||||
description: "Run the encrypted, password-protected repository sync workflow for this project. The real instructions are stored encrypted at rest and are only revealed in-session after you supply the correct password. Invoke explicitly with /sync-repo."
|
||||
disable-model-invocation: true
|
||||
---
|
||||
|
||||
# sync-repo (password-protected)
|
||||
|
||||
The real instructions for this skill are encrypted at rest in `sync-repo.enc`
|
||||
and are NOT readable without the password. Do not guess, reconstruct, or invent
|
||||
the workflow. Follow this launcher exactly.
|
||||
|
||||
## What you (the agent) must do
|
||||
|
||||
1. **Ask the user for the password.** Request the decryption passphrase (via
|
||||
AskUserQuestion or a plain prompt). Do NOT proceed without it. Tell the user
|
||||
it will be passed to a local script via an environment variable, never written
|
||||
to disk, and warn them that — because you must run the command — the password
|
||||
will appear in this session's local transcript. (It never enters the repo.)
|
||||
|
||||
2. **Decrypt to STDOUT only.** Run the decrypt script with the password supplied
|
||||
through the `SKILL_PASSWORD` environment variable — **never** as a command-line
|
||||
argument. From the repo root:
|
||||
|
||||
- **Windows PowerShell:**
|
||||
```powershell
|
||||
$env:SKILL_PASSWORD='<password the user gave you>'; node .\.claude\skills\sync-repo\decrypt.mjs .\.claude\skills\sync-repo\sync-repo.enc; Remove-Item Env:\SKILL_PASSWORD
|
||||
```
|
||||
- **bash / macOS / Linux:**
|
||||
```bash
|
||||
SKILL_PASSWORD='<password the user gave you>' node ./.claude/skills/sync-repo/decrypt.mjs ./.claude/skills/sync-repo/sync-repo.enc
|
||||
```
|
||||
|
||||
3. **Handle the result.**
|
||||
- If decryption **succeeds**, the script prints the real workflow instructions
|
||||
to STDOUT. Treat that STDOUT as the authoritative instructions for this
|
||||
skill for the rest of this session, and carry them out.
|
||||
- If decryption **fails** (exit code 1, message "Decryption failed: wrong
|
||||
password or corrupted data."), the password was wrong or the file is
|
||||
corrupt. Tell the user, ask them to re-enter the password, and retry. Do
|
||||
NOT attempt to reconstruct the instructions from anything else.
|
||||
|
||||
## Hard rules
|
||||
|
||||
- **Never write the decrypted plaintext to a file.** Read it from STDOUT only.
|
||||
`decrypt.mjs` intentionally has no file-output mode.
|
||||
- **Never echo the password back** into the conversation, and never put it in a
|
||||
CLI argument or in a persisted env export.
|
||||
- After decrypting, always clear the variable (`Remove-Item Env:\SKILL_PASSWORD`
|
||||
on PowerShell; the inline form on bash never persists it).
|
||||
|
||||
## Security note (be honest with the user)
|
||||
|
||||
This protects the workflow body **only at rest in the repository**. Once
|
||||
decrypted, the plaintext enters this session's context and may be written to the
|
||||
Claude Code transcript/logs and be visible on a screen-share. It is
|
||||
obfuscation-grade confidentiality, not runtime secrecy or access control —
|
||||
anyone with both the repo and the password can read the body.
|
||||
@@ -0,0 +1,42 @@
|
||||
#!/usr/bin/env node
|
||||
// decrypt.mjs — verifies GCM auth tag, prints plaintext to STDOUT only.
|
||||
// Password from $SKILL_PASSWORD. Exits 1 on wrong password / tamper, leaking nothing.
|
||||
// Usage: SKILL_PASSWORD=... node decrypt.mjs <file.enc>
|
||||
import { readFileSync } from 'node:fs';
|
||||
import { scryptSync, 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;
|
||||
const HEADER = MAGIC.length + 1; // 5
|
||||
|
||||
const password = process.env.SKILL_PASSWORD;
|
||||
if (!password) { console.error('ERROR: set SKILL_PASSWORD env var.'); process.exit(2); }
|
||||
|
||||
const encPath = process.argv[2];
|
||||
if (!encPath) { console.error('Usage: node decrypt.mjs <file.enc>'); process.exit(2); }
|
||||
|
||||
try {
|
||||
const blob = Buffer.from(readFileSync(encPath, 'utf8').trim(), 'base64');
|
||||
if (blob.length < HEADER + SALTLEN + IVLEN + TAGLEN) throw new Error('truncated');
|
||||
if (!blob.subarray(0, MAGIC.length).equals(MAGIC)) throw new Error('bad magic');
|
||||
if (blob[MAGIC.length] !== VERSION) throw new Error('unsupported version');
|
||||
|
||||
let off = HEADER;
|
||||
const salt = blob.subarray(off, off += SALTLEN);
|
||||
const iv = blob.subarray(off, off += IVLEN);
|
||||
const authTag = blob.subarray(off, off += TAGLEN);
|
||||
const ciphertext = blob.subarray(off);
|
||||
|
||||
const key = scryptSync(password, salt, KEYLEN, SCRYPT);
|
||||
const decipher = createDecipheriv('aes-256-gcm', key, iv);
|
||||
decipher.setAuthTag(authTag);
|
||||
// final() throws here if the tag does not verify (wrong password or tampering).
|
||||
const plaintext = Buffer.concat([decipher.update(ciphertext), decipher.final()]);
|
||||
process.stdout.write(plaintext); // STDOUT only — never written to disk.
|
||||
} catch (err) {
|
||||
// Generic message: do not echo crypto internals or any plaintext.
|
||||
console.error('Decryption failed: wrong password or corrupted data.');
|
||||
process.exit(1);
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
#!/usr/bin/env node
|
||||
// encrypt.mjs — AES-256-GCM + scrypt. Password from $SKILL_PASSWORD (never argv).
|
||||
// Usage: SKILL_PASSWORD=... node encrypt.mjs <plaintextFile|-> <outFile.enc>
|
||||
// (pass '-' or omit the input path to read plaintext from STDIN)
|
||||
import { readFileSync, writeFileSync } from 'node:fs';
|
||||
import { scryptSync, randomBytes, createCipheriv } 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;
|
||||
|
||||
const password = process.env.SKILL_PASSWORD;
|
||||
if (!password) { console.error('ERROR: set SKILL_PASSWORD env var.'); process.exit(2); }
|
||||
|
||||
const inPath = process.argv[2];
|
||||
const outPath = process.argv[3];
|
||||
if (!outPath) { console.error('Usage: node encrypt.mjs <plaintextFile|-> <outFile.enc>'); process.exit(2); }
|
||||
|
||||
// readFileSync(0) reads STDIN; use it when no input file (or '-') is given.
|
||||
const plaintext = (!inPath || inPath === '-') ? readFileSync(0) : readFileSync(inPath);
|
||||
|
||||
const salt = randomBytes(SALTLEN);
|
||||
const iv = randomBytes(IVLEN);
|
||||
const key = scryptSync(password, salt, KEYLEN, SCRYPT);
|
||||
const cipher = createCipheriv('aes-256-gcm', key, iv);
|
||||
const ciphertext = Buffer.concat([cipher.update(plaintext), cipher.final()]);
|
||||
const authTag = cipher.getAuthTag(); // 16 bytes
|
||||
|
||||
const blob = Buffer.concat([MAGIC, Buffer.from([VERSION]), salt, iv, authTag, ciphertext]);
|
||||
writeFileSync(outPath, blob.toString('base64') + '\n');
|
||||
console.error(`Wrote ${outPath} (${blob.length} raw bytes, base64-encoded).`);
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,4 @@
|
||||
# The encrypted sync-repo blob is base64 text but must never have its bytes
|
||||
# altered by line-ending normalization. Treat it as binary so autocrlf/eol
|
||||
# settings can never corrupt the ciphertext.
|
||||
*.enc binary
|
||||
+15
-1
@@ -1,3 +1,17 @@
|
||||
specs/
|
||||
specs--completed/
|
||||
dist/
|
||||
CLAUDE.md
|
||||
plan2code-loop/dist
|
||||
plan2code-loop/node_modules
|
||||
plan2code-loop/package-lock.json
|
||||
plan2code-metrics/dist
|
||||
plan2code-metrics/node_modules
|
||||
plan2code-metrics/package-lock.json
|
||||
.plan2code-loop
|
||||
.plan2code-metrics
|
||||
nul
|
||||
.cognition/
|
||||
handoffs/
|
||||
node_modules/
|
||||
package-lock.json
|
||||
SYNC.md
|
||||
@@ -0,0 +1 @@
|
||||
node scripts/validate-char-count.js
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
# Exclude user-generated spec files
|
||||
specs/
|
||||
specs--completed/
|
||||
|
||||
# Exclude development files
|
||||
.husky/
|
||||
.git/
|
||||
.gitignore
|
||||
CLAUDE.md
|
||||
|
||||
# Exclude generated files (installer generates dist/ dynamically)
|
||||
dist/
|
||||
|
||||
# Exclude dependencies (installer will run npm install if needed)
|
||||
node_modules/
|
||||
package-lock.json
|
||||
plan2code-loop/node_modules/
|
||||
plan2code-loop/package-lock.json
|
||||
plan2code-loop/dist/
|
||||
@@ -0,0 +1,62 @@
|
||||
# AGENTS.md
|
||||
|
||||
This file provides guidance to AI coding agents like Claude Code (claude.ai/code), Cursor AI, Codex, Gemini CLI, GitHub Copilot, Devin, Zed, and other AI coding assistants when working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
|
||||
Plan2Code is a structured 4-step workflow methodology for AI-assisted software development. It provides prompt templates that can be installed globally or per-project for various AI coding tools (Claude Code, Cursor, Copilot, Continue, Windsurf, Codeium, Devin, Zed).
|
||||
|
||||
**Version:** Check `version.json` for current version
|
||||
**Author:** Justin Parker
|
||||
**License:** MIT
|
||||
|
||||
## 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.
|
||||
|
||||
## Architecture
|
||||
|
||||
High-level directory structure, key files, workflow prompt inventory, and file naming conventions.
|
||||
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md)
|
||||
|
||||
## Plan2Code Loop
|
||||
|
||||
Autonomous CLI tool (`plan2code-loop/`) that implements specs by looping through tasks. Covers loop architecture, modes (one-task vs one-phase), completion markers, and key source files.
|
||||
|
||||
Details: [Plan2Code Loop](./.agents-docs/AGENTS-plan2code-loop.md)
|
||||
|
||||
## Plan2Code Metrics
|
||||
|
||||
Recursive self-improvement toolchain (`plan2code-metrics/`) for collecting run metrics, aggregating by prompt generation, diagnosing weak steps, and proposing prompt edits.
|
||||
|
||||
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).
|
||||
|
||||
Details: [Architecture](./.agents-docs/AGENTS-architecture.md) (see Status Line section)
|
||||
|
||||
## Development Commands
|
||||
|
||||
Build commands, installer menu options, how the installer generates platform-specific files, platform format table, and how to edit workflow prompts.
|
||||
|
||||
Details: [Development Commands](./.agents-docs/AGENTS-development-commands.md)
|
||||
|
||||
## Code Style & Gotchas
|
||||
|
||||
Language/toolchain conventions for `install.js` vs TypeScript packages, and pitfalls to avoid (version sync, `.gitignore` pre-flight, character limits, User Feedback table format).
|
||||
|
||||
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 `MASCOT` constant in `install.js` and appear in workflow markdown files.
|
||||
|
||||
```
|
||||
╭───╮
|
||||
│ ● │
|
||||
│ ◡ │
|
||||
╰───╯
|
||||
```
|
||||
+515
@@ -2,6 +2,520 @@
|
||||
|
||||
All notable changes to Plan2Code will be documented in this file.
|
||||
|
||||
## v1.16.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **`/plan2code-handoff` skill** — compacts the current conversation into a self-contained handoff document (written to gitignored `./handoffs/<timestamp>-handoff.md`) so a fresh session or another agent can resume the work
|
||||
- Always captures a confirmed **Next task**: infers a candidate from context and requires the user to confirm or fill it in before the file is written
|
||||
- References plan specs, logs, and files by path rather than copying them; strips secrets; suggests follow-on skills and verification steps
|
||||
- Repo-safe: checks `git check-ignore` and warns (without silently editing `.gitignore`) when `handoffs/` isn't ignored in an arbitrary repo
|
||||
- **Repo-local release publisher skill** — new `/plan2code-publish` maintainer skill in `.claude/skills/` cuts a GitHub Release from the top `CHANGELOG.md` entry once `CHANGELOG.md`, `version.json`, and `package.json` agree and the version is ahead of the latest published release. Dev tooling only — deliberately excluded from `install.js`, never installed to `~/.claude/skills/`.
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **Review workflow next-step suggestion made context-aware** — `/plan2code-review` Session End now reconciles three signals: session context (what preceded the review in the conversation), the user's review intent, and on-disk spec state gathered shell-agnostically — a file-search tool's empty result is never treated as proof that no specs exist. Suggestions render only at actual session end, cite their evidence and its source, and conflicting signals ask one targeted question instead of guessing.
|
||||
|
||||
## v1.15.4
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Status line: reasoning effort + context token count** — model segment now appends the current reasoning effort level (e.g. `Sonnet 5 | High`, hidden when the model doesn't support an effort parameter); context bar now shows raw input tokens used alongside the percentage (e.g. `42% (84k)`), independently toggleable via new `items.effort` / `items.contextTokens` config flags
|
||||
|
||||
## v1.15.3
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Session-end summaries across workflows** — consistent closing context in implement, document, finalize, init-update, quick-task, review, and revise-plan
|
||||
- Implement: work summary + upcoming-phases table (task counts, goals) after each phase approval
|
||||
- Document: phase-overview table at close to help plan sessions and review gates
|
||||
- **Sync & Maintain in init-update** — new unified doc-surface sync option (menu item #9)
|
||||
- Covers `AGENTS.md`, `.agents-docs/`, active `specs/`, README, and human docs; tier-voice routing, never duplicates across tiers
|
||||
- Adaptive to repo conventions — detects the human-docs tree, never assumes
|
||||
- **Research steps in plan** — domain research (Phase 1), tech-options research (Phase 4), and an investigate-to-close-gaps rule on the 90% confidence gate
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Spec auto-discovery hardened** — replaced Glob (silently fails on gitignored `specs/`) with explicit shell `ls` across document, implement, finalize, init-update, and revise-plan
|
||||
- **Revision-mode guardrails** — `1b-revise-plan` edits restricted to `specs/` paths only; execution-shaped language removed; cleanup step added
|
||||
- **Commit-message enforcement in implement** — subject ≤100 chars, exactly three `-m` flags, no body
|
||||
- **Finalize documentation review expanded** — audits `AGENTS.md` + `.agents-docs/`, mandates corrections (not just additions), routes facts per tier voice
|
||||
- **Quality language pass** — plan demands edge cases/failure modes and measurable criteria; document and finalize role statements sharpened
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **Review workflow next-step guard** — Review mode no longer suggests `/plan2code-3-implement` when `overview.md` and `phase-*.md` files don't exist. If the document step hasn't been run yet, it now correctly directs users to `/plan2code-2-document` first.
|
||||
|
||||
## v1.15.2
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Review workflow renamed** — `/plan2code-3b-review` → `/plan2code-review`
|
||||
- Removed `3b` step-number prefix; review is now a standalone utility workflow (like `init` and `quick-task`)
|
||||
- Source file: `src/plan2code-review.md` (was `plan2code-3b-review.md`)
|
||||
- Reference directory: `src/plan2code-review-references/` (was `plan2code-3b-review-references/`)
|
||||
- Updated all docs, installer config, architecture docs, and cross-references
|
||||
|
||||
## v1.15.1
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Zed agent support** — Added Zed to all agent support documentation
|
||||
- `README.md` Supported Platforms list
|
||||
- `AGENTS.md` intro and Project Overview
|
||||
- `.agents-docs/AGENTS-development-commands.md` Platform-Specific File Formats table
|
||||
- `install.js` Agent Skills platform label
|
||||
- `src/plan2code-init.md` AGENTS.md template text
|
||||
|
||||
## v1.15.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Claude CLI status line** — Persistent three-line status bar for Claude Code, displaying model, project, git branch, uncommitted diff stats, session duration, context window usage bar, and plan/quota usage. Reads all data from Claude Code's stdin JSON — no API calls, no auth, no background processes.
|
||||
- `src/statusline-claude/statusline.js` — self-contained: stdin parsing, config loader, ANSI formatting, orchestration
|
||||
- `src/statusline-claude/statusline-config.json` — distributed default config
|
||||
- `src/statusline-claude/README.md` — user docs: install, config, usage modes, troubleshooting
|
||||
- **Planny mascot icons** on each line (`╭─╮`, `│★│`, `╰─╯`) in brand colors, with monochrome fallback
|
||||
- **Context window bar** (12-cell `▰▱`) with configurable `autocompactBuffer` (default 33000 tokens) so the percentage reflects *usable* context, not the raw window
|
||||
- **Adaptive plan usage segment** — auto-detects data shape:
|
||||
- Pro/Max/Teams (rate_limits present) → `5h: NN% · 7d: NN%`
|
||||
- Bedrock / Vertex / PAYG (no rate_limits) → `NNk in · NNk out` session tokens
|
||||
- Segment hidden when neither is available
|
||||
- **Real uncommitted diff stats** via `git diff HEAD --numstat` → `+NN -NN`
|
||||
- **Color-coded thresholds** — green / yellow / red for context bar and rate limits
|
||||
- **Separator line** rendered at fixed 55-character width for consistent alignment
|
||||
- **Session cost display** — Estimated session cost shown next to duration (e.g. `49m ($4.62)`) via new `items.sessionCost` config (default on); reads `cost.total_cost_usd` from Claude Code stdin; hidden when zero or unavailable
|
||||
- **Compact mode redesigned** — `"compact": true` now renders two content lines (no mascot icons, no separator) instead of one cramped single line. The single-line variant truncated in narrow terminals — the exact case compact mode was meant to help. Default remains `false`.
|
||||
- **Silent failure** on all errors — never crashes, never blocks the CLI; 1.5s per-call timeouts on git operations; non-git workspaces short-circuit without spawning subprocesses
|
||||
- **Installer integration** — Status line included in `Install All + dev tools` (`A`); also available via `Custom → S` (opt-in).
|
||||
- Copies `statusline.js` verbatim to `~/.claude/plan2code-statusline.js` (single-file design, no bundling)
|
||||
- Registers in `~/.claude/settings.json` under `statusLine` via atomic temp-file + rename write
|
||||
- Preserves existing `statusline-config.json` on reinstall
|
||||
- Detects non-plan2code custom `statusLine` configs — prompts before replacing; auto-backs up to `statusline-previous.json`
|
||||
- Uninstall (`U`) removes bundled script + `settings.json` entry; preserves `statusline-config.json`. Only removes `settings.statusLine` if it points to the plan2code bundle — non-plan2code entries are left intact.
|
||||
|
||||
## v1.14.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Review workflow (Step 3b)** — New `/plan2code-3b-review` command for comprehensive post-implementation code review
|
||||
- 5-step process: scope detection, context analysis, 11-dimension review, spec/test assessment, summary with fix options
|
||||
- Adaptive scope: focused (named files), branch (git diff), or full (subsystem) — auto-detected with user override
|
||||
- 3 severity levels (Critical, Warning, Suggestion) with High-confidence-only findings
|
||||
- Reference file architecture: orchestrator (≤11k chars) + 3 companion reference files loaded via Read directives
|
||||
- Deep verification protocol with use-case tracing for architectural findings and adversarial self-check
|
||||
- Detailed dimension checklists (8 non-obvious items per dimension with anti-patterns and "don't flag" guidance)
|
||||
- False-positive catalog with detection shortcuts to prevent common false findings
|
||||
- Finding verification gate — re-reads source at each cited line before presenting
|
||||
- Mnemonic fix options: `H` (high-priority), `A` (all), `S` (specify by number)
|
||||
- Post-fix Plan/Apply/Verify pipeline — enterprise-grade fix quality with full validation
|
||||
- Doc review mode — >70% doc changes triggers editorial critique
|
||||
- Graceful degradation for agents that can't read external files
|
||||
- Spec-aware when `specs/` exists; works standalone for any codebase
|
||||
- Context-aware session end with pipeline state detection
|
||||
- Registered in installer for all 14+ platform destinations
|
||||
- Installer copies reference directories for all 13+ platform targets
|
||||
- Reference content inlined into TOML output (Gemini CLI) so platforms that cannot resolve runtime file reads still get full workflow depth
|
||||
- Uninstall now removes orphaned `*-references/` directories even when prompt files were already removed manually
|
||||
- Implement workflow session-end now suggests review after each phase
|
||||
|
||||
## v1.13.0
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Simplified workflow naming convention** — All workflow and skill files unified to single-dash naming, eliminating double-dash (`--`) and triple-dash (`---`) conventions
|
||||
- Renamed 8 source prompt files in `src/` (e.g., `plan2code---init.md` → `plan2code-init.md`, `plan2code-1--plan.md` → `plan2code-1-plan.md`)
|
||||
- Updated `install.js` `SOURCE_PROMPTS` metadata and `generateFilename()` to emit single-dash names
|
||||
- Updated all cross-references inside workflow prompt markdown content
|
||||
- Updated documentation: `README.md`, `QUICK-REFERENCE.md`, `AGENTS.md`, `.agents-docs/AGENTS-architecture.md`
|
||||
- Updated tooling references in `plan2code-loop/`, `plan2code-bot/`, and `plan2code-metrics/`
|
||||
- Fixed pre-existing broken test assertion in `plan2code-bot` step-instructions test
|
||||
- Repaired Windows-1252 / U+FFFD encoding artifacts (em-dashes) in `plan2code-loop` and `plan2code-bot` source files
|
||||
|
||||
### 🎁 Added
|
||||
|
||||
- **Devin platform support** — Added Devin to supported platforms list across `README.md`, `AGENTS.md`, `install.js` Agent Skills targets, `.agents-docs/AGENTS-development-commands.md`, and the `/plan2code-init` prompt
|
||||
- **CLAUDE.md MANDATORY FIRST STEP template** — `/plan2code-init` and `/plan2code-init-update` now generate a CLAUDE.md template containing a `CRITICAL — MANDATORY FIRST STEP` directive that forces Claude Code to read AGENTS.md before responding to any user message
|
||||
|
||||
## v1.12.0
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Resilient code references in workflow prompts** — Workflow prompts now explicitly guide AI agents to use semantic anchors (function names, class names, code patterns) instead of line numbers, which become stale as tasks modify files during implementation
|
||||
- **Document mode** (`plan2code-2-document.md`) — New "Code references" block in Task Writing section lists four preferred anchor types with examples; line numbers allowed only as supplemental context
|
||||
- **Revise-plan mode** (`plan2code-1b-revise-plan.md`) — Matching code reference rule added to Step 3 (Execute Revisions) so revised and new tasks follow the same convention
|
||||
- **Implement mode** (`plan2code-3-implement.md`) — New "Verify locations" row in Code Consistency Rules table instructs agents to treat line numbers as approximate and locate by function/symbol name
|
||||
|
||||
## v1.11.1
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Task complexity check in Document workflow** — Enhanced task writing guidance with lightweight cognitive complexity heuristics (inspired by PR #26)
|
||||
- "Time-boxed" criterion now includes explicit split triggers: 5+ logic branches, 2+ integration points, or shared interface mutation
|
||||
- New "Complexity check" prompt: before finalizing each task, LLM considers logic branches, distinct behaviors, integration points, shared interface impact, and error/edge cases
|
||||
- Tasks complex on 3+ signals must be split; adjacent trivial tasks forming a cohesive unit should be combined
|
||||
- Process step 7 updated to reinforce the complexity check during phase file authoring
|
||||
|
||||
## v1.11.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **plan2code-bot** — New autonomous workflow test runner (`plan2code-bot/`) that uses the Claude Agent SDK to simulate a human running the entire plan2code workflow end-to-end
|
||||
- Two auto-detected modes: **new-project** (generates an app idea, creates a subdirectory, runs init through finalize) and **enhancement** (scans existing codebase, proposes a realistic enhancement)
|
||||
- `--idea` flag to seed the idea generator with a specific concept
|
||||
- `--resume` flag to continue incomplete runs from saved state — skips previously succeeded steps and restores idea, config, and implement pass counter
|
||||
- State file (`.plan2code-bot-state.json`) saved after each step; automatically deleted on full success, preserved on failure for later resume
|
||||
- Resume auto-detects state files in current directory (enhancement mode) or immediate subdirectories (new-project mode)
|
||||
- Artifact validation after each step (aborts on missing expected outputs)
|
||||
- **LLM-as-judge evaluation system** — Always-on quality assessment that transforms bot from "yes-man" to authentic QA agent
|
||||
- **Intelligent decision making**: Uses LLM to answer `AskUserQuestion` prompts based on current observations (tools used, files created, errors) instead of hardcoded keyword matching
|
||||
- **Post-step evaluation**: Comprehensive quality assessment after each step using step-specific criteria (score 0-100, strengths, weaknesses, suggestions, critical issues)
|
||||
- **Observation tracking**: Full execution history captured (tools, files, messages, errors, questions with LLM reasoning)
|
||||
- **Quality gate**: Blocks finalization if average score < 60, ensuring minimum quality standards
|
||||
- **Evaluation artifacts**: Creates `BOT-EVALUATION.md` (quality assessments) and `BOT-NOTES.md` (execution observations) for metrics analysis
|
||||
- **Color-coded output**: Green (≥85), yellow (70-84), red (<70) score display in console
|
||||
- **Honest scoring**: Evaluation criteria emphasize realistic assessment (most work scores 70-85, not inflated)
|
||||
- **Metrics-ready data**: Structured `EvaluationResult` and `ExecutionObservation` in state file for `plan2code-metrics` analysis
|
||||
- Bot-friendly skill installation (copies plan2code skills with `disable-model-invocation` stripped)
|
||||
- Implement step loops up to 10 passes until all phases are complete
|
||||
- Installer integration: `C > B` menu option to install bot CLI only
|
||||
|
||||
## v1.10.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Retry logic with escalating timeouts in loop controller** — Timed-out iterations now retry automatically instead of silently continuing
|
||||
- Default base timeout reduced from 30 minutes to 3 minutes per attempt
|
||||
- Up to 5 retry attempts per iteration (configurable via `maxRetries`)
|
||||
- Each retry escalates timeout by +30 seconds (attempt 0 = base, attempt 1 = base + 30s, etc.)
|
||||
- New `executeWithRetry()` method wraps `executeIteration()` with retry loop
|
||||
- Fatal timeout (all attempts exhausted) stops the loop cleanly with a logged error
|
||||
- Spinner displays elapsed seconds during each attempt; retries show attempt count
|
||||
- `maxRetries` field added to `SessionConfig` and `DEFAULT_CONFIG`
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Append-only scratchpad enforcement in loop prompt templates** — Both task-mode and phase-mode templates now explicitly prohibit editing or reorganizing existing scratchpad content
|
||||
- Instruction changed from "append to scratchpad.md" to "add a new entry at the **bottom**"
|
||||
- Added rule: "Never edit, reorganize, or insert into existing content — only append new entries to the end of the file"
|
||||
- **AGENTS.md restructured into progressive discovery format** — AGENTS.md converted to a lightweight index with summaries and markdown links; full detail moved to `.agents-docs/` section files
|
||||
- `.agents-docs/AGENTS-architecture.md` — Architecture overview and key design decisions
|
||||
- `.agents-docs/AGENTS-code-style.md` — Code style conventions
|
||||
- `.agents-docs/AGENTS-development-commands.md` — Development commands and setup
|
||||
- `.agents-docs/AGENTS-plan2code-loop.md` — Loop CLI architecture and commands
|
||||
- `.agents-docs/AGENTS-plan2code-metrics.md` — Metrics toolchain details
|
||||
- `init-update` prompt updated with `.agents-docs/` detection in pre-flight check
|
||||
- **Agents mode emoji updated** — Loop controller agents-mode indicator changed from wheel to hammer
|
||||
|
||||
## v1.9.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Pi (pi.dev) platform support** — New target for the Pi terminal-based coding agent
|
||||
- Local prompt templates installed to `.pi/prompts/` (flat `.md` with YAML `description` frontmatter)
|
||||
- Global prompt templates installed to `~/.pi/agent/prompts/`
|
||||
- Pi users already get skill support via existing `.agents/skills/` target; this adds native slash command access
|
||||
- No new helper functions needed — Pi uses the same flat-file-with-YAML pattern as Windsurf, Copilot CLI, and Codeium
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
- `AGENTS.md` Platform-Specific File Formats table updated with Pi row
|
||||
- `README.md` Supported Platforms list updated with Pi (pi.dev)
|
||||
## v1.9.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Progressive discovery for AGENTS.md** — Init and init-update prompts now generate AGENTS.md as a lightweight index with summaries and markdown links, plus `.agents-docs/` section files containing full detail
|
||||
- **Init prompt** — New `## Progressive Discovery` section defines index format, always-inline sections (Project Overview, Git Commit Messages, How to Use This File), `.agents-docs/` directory setup, grouping heuristics, and opt-in restructure offer for existing single-file AGENTS.md
|
||||
- **Init-update prompt** — `.agents-docs/` detection in pre-flight check, legacy migration offer, edit routing (inline sections → AGENTS.md, detailed sections → `.agents-docs/` files), section file lifecycle (create, delete, orphan cleanup), enhanced summary with file count, new update rule 9 (route edits to correct file)
|
||||
- **Reference templates** updated in both prompts to include `.agents-docs/` in the bullet list
|
||||
- **"How to Use This File"** added as a required content section in generated AGENTS.md files
|
||||
|
||||
## v1.8.2
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **Inflated metrics task counts** — Metrics collector regex now matches only `**Task X.N:**` checkbox items instead of all checkboxes, fixing ~100-200% count inflation from prerequisite and acceptance criteria checkboxes
|
||||
- `collectStep2` (`tasks_per_phase`) uses Task-pattern-only regex
|
||||
- `collectStep3` (`phaseTotal`, `phaseCompleted`, `blockerCount`) all use Task-pattern-only regex
|
||||
- Step 4 overview fallback left unchanged (correctly counts Phase Checklist checkboxes)
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Document workflow** — Checkbox format `- [ ]` now restricted to Task items only; Prerequisites, Acceptance Criteria, and Success Criteria use plain bullet lists (no checkboxes)
|
||||
- **Implement workflow** — Prerequisite verification changed from checkbox-based (`[x]`/`[?]`/`[!]`) to inline annotation approach (`VERIFIED`/`ASSUMED: [reason]`/`BLOCKED: [reason]`); added clarifying note that checkbox states apply to Task items and Phase Checklist only
|
||||
- **Finalize workflow** — Task completion audit now specifies counting only `**Task X.N:**` checkbox items
|
||||
- **Loop prompt templates** — Both task-mode and phase-mode templates updated: prerequisites use plain bullets with inline annotations instead of checkboxes; Checkbox States section scoped to "Task items only"
|
||||
|
||||
## v1.8.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **User feedback collection** — Optional 1-10 rating with reason, what went well, and what went poorly
|
||||
- Finalize prompt (Step 5) asks for optional feedback before archival, writes structured table to `overview.md`
|
||||
- Collector parses `## User Feedback` table from `overview.md` into `RunMetrics.user_feedback`
|
||||
- Aggregator computes `avg_user_rating` and `feedback_count` per cohort
|
||||
- CLI offers interactive feedback collection if none found during metrics collection
|
||||
- Analysis and improvement prompts reference `avg_user_rating` metric target (≥ 7.0)
|
||||
- `UserFeedback` type exported from public API
|
||||
- **Pipe-safe feedback parsing** — User text containing `|` characters is escaped on write and correctly unescaped on parse using negative lookbehind regex
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **Duplicate run files** — Interactive feedback no longer creates a second run JSON; the original is deleted before re-collecting
|
||||
- **Finalize step ordering** — Feedback collection moved to Step 5 (before archival at Step 6), ensuring `overview.md` is written while still in the active spec directory
|
||||
|
||||
## v1.8.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **plan2code-metrics** — New recursive self-improvement toolchain for plan2code contributors (`plan2code-metrics/`)
|
||||
- Fully interactive menu-driven CLI — no flags, all inputs collected via prompts
|
||||
- **Collect** metrics from completed project specs (plan, document, implement, finalize steps)
|
||||
- **Import** run data from other projects for cross-project aggregation
|
||||
- **View** metrics status with health indicators and generation-over-generation deltas
|
||||
- **Analyze** weak steps via AI-powered diagnosis (Claude Code or GitHub Copilot CLI)
|
||||
- **Generate** surgical improvement proposals with automatic validation (char count limits, edit verification)
|
||||
- **Review and apply** proposals with interactive diff review
|
||||
- Cohort-based aggregation groups runs by prompt generation (SHA fingerprint of prompt files)
|
||||
- Supports both Claude Code and GitHub Copilot CLI as AI backends
|
||||
- Standalone TypeScript package with tsup build (ESM), installed via `npm link`
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **plan2code-4--finalize.md** — Added "Metrics Capture (Contributors)" note in Step 6 directing contributors to run `plan2code-metrics` after finalization
|
||||
- **plan2code-loop index.ts** — Added dim hint "run plan2code-metrics" after session summary
|
||||
|
||||
## v1.7.0
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **4 new platform targets** — Gemini CLI, Crush, Amp, and OpenCode now supported
|
||||
- Gemini CLI installs as TOML commands (`.gemini/commands/plan2code-*.toml`)
|
||||
- Crush installs as skill subdirs (`~/.config/crush/skills/` on Unix, `%LOCALAPPDATA%\crush\skills\` on Windows)
|
||||
- Amp and OpenCode covered via shared Agent Skills target (`.agents/skills/`)
|
||||
- **Claude Code Skills format** — Migrated from flat `.claude/commands/*.md` to `.claude/skills/<skill-name>/SKILL.md` with `disable-model-invocation: true` frontmatter
|
||||
- **Agent Skills cross-tool target** — Single `.agents/skills/` install covers Amp, Gemini CLI, and OpenCode simultaneously
|
||||
- **Legacy cleanup** — Old `.claude/commands/plan2code-*.md` files automatically removed on install and uninstall
|
||||
- **TOML generation** — New `generateTomlContent()` produces Gemini CLI command files using TOML literal multi-line strings
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- `AGENTS.md` Platform-Specific File Formats table expanded to 5 columns with 4 new platform rows
|
||||
- `docs/index.html` hero section updated with 4 new platform pills
|
||||
- `README.md` Supported Platforms list updated with 4 new platforms
|
||||
|
||||
## v1.6.2
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Installer menu simplified** — Replaced the 7-platform picker with a clean 4-option menu (I/U/C/Q)
|
||||
- `I` — Install Plan2Code for all platforms + loop CLI
|
||||
- `U` — Uninstall (with confirmation prompt)
|
||||
- `C` — CUSTOM sub-menu: `L` (local install instructions), `O` (loop CLI only), `Q` (back)
|
||||
- `Q` — Quit
|
||||
- Any CLI arguments (e.g. `--dry-run`, `--platform`) are now silently ignored; installer always runs interactively
|
||||
- **README installation section** — npx install method promoted to primary recommended install path; updated menu example
|
||||
|
||||
### 🗑️ Removed
|
||||
|
||||
- CLI flags `--dry-run`, `--platform`, `--local`, `--uninstall`, `--help`, `--loop`, `--uninstall-loop` (all removed; installer is always interactive)
|
||||
- `displayHelp()` function removed from `install.js`
|
||||
|
||||
## v1.6.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **NPX installation support** - Team members can now install directly from GitHub without cloning
|
||||
- Added `name`, `version`, and `bin` fields to `package.json` for npm compatibility
|
||||
- Installation via `npx git+ssh://git@github.com/jparkerweb/plan2code.git` (SSH)
|
||||
- Installation via `npx git+https://github.com/jparkerweb/plan2code.git` (HTTPS)
|
||||
- Installer runs from temporary location and cleans up automatically
|
||||
- Updated README.md with Quick Start section showing both authentication methods
|
||||
- Added `.npmignore` file to suppress npm warnings during npx execution
|
||||
|
||||
## v1.6.0
|
||||
|
||||
### 🏎️ Improved
|
||||
|
||||
- **Reduced workflow file sizes** - All 4 over-target source prompts compressed to ≤ 11,000 characters for Windsurf IDE compatibility (12,000 char limit minus header buffer)
|
||||
- `plan2code-3--implement.md` - 14,806 → 8,533 chars (42% reduction)
|
||||
- `plan2code-1--plan.md` - 13,587 → 10,348 chars (24% reduction)
|
||||
- `plan2code-4--finalize.md` - 12,012 → 8,586 chars (29% reduction)
|
||||
- `plan2code-2--document.md` - 11,842 → 9,031 chars (24% reduction)
|
||||
- All functional workflow behavior preserved
|
||||
- Compression techniques: template-to-section-list specs, removed bad examples, consolidated redundant sections, simplified decorative boxes, imperative directives
|
||||
|
||||
### 🧪 Testing
|
||||
|
||||
- **Pre-commit character count validation** - Husky pre-commit hook prevents workflow files from exceeding 11,000 characters
|
||||
- `scripts/validate-char-count.js` - Cross-platform Node.js validation script using only built-in modules
|
||||
- `.husky/pre-commit` - Git hook trigger calling the validation script
|
||||
- Root `package.json` with husky as sole devDependency (`private: true`)
|
||||
- `.gitignore` updated with `node_modules/` and `package-lock.json`
|
||||
|
||||
## v1.5.4
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **AI Assisted commit attribution** - All git commit messages now include an `AI Assisted` footer for transparency
|
||||
- **Init mode** - Generated AGENTS.md files include a Git Commit Messages section instructing agents to always append `AI Assisted`
|
||||
- **Init-update mode** - New "Git Commit Messages" menu option (option 7) for adding or modifying commit message conventions
|
||||
- **Loop task mode** - `createTaskCommit()` automatically appends `AI Assisted` footer to every commit
|
||||
- **Loop phase mode** - Prompt template instructs LLM to include `-m "AI Assisted"` as final flag on every commit
|
||||
- **Implement mode** - User-facing git commit suggestions after phase approval include `-m "AI Assisted"`
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **README loop install instructions** - Replaced inline text with formatted code block showing both install options
|
||||
|
||||
## v1.5.3
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Loop mode selection** - Plan2Code Loop now asks users to choose between two loop modes:
|
||||
- **One task per loop** (default) - Each agent invocation implements exactly one task. Node controller handles git commits after each task. Same behavior as before.
|
||||
- **One phase per loop** - Each agent invocation implements all remaining tasks in the current phase. The LLM handles git commits after each task (with JIRA ticket ID). Ideal for related tasks and smart models with higher context windows.
|
||||
- **Phase-mode prompt template** - New `LOOP_PROMPT_TEMPLATE_PHASE` instructs the LLM to complete all tasks in the current phase, create git commits per task, and output `TASK_COMPLETE` markers for each
|
||||
- **Multi-marker completion detection** - New `checkForAllCompletions()` function parses all `TASK_COMPLETE`, `TASK_BLOCKED`, and `PREREQ_COMPLETE` markers from a single agent output
|
||||
- **`PHASE_COMPLETE` marker** - New completion marker for phase mode indicating current phase is done (distinct from `LOOP_COMPLETE` which means all phases done)
|
||||
- **`loopMode` config field** - New `SessionConfig.loopMode` field (`'task' | 'phase'`) persisted in session state for resume support
|
||||
- **Documentation auto-discovery** - Documentation workflow now auto-discovers features to document
|
||||
- Automatically finds `specs/*/PLAN-DRAFT-*.md` files
|
||||
- If only one feature exists, uses it without prompting
|
||||
- If multiple features exist, presents list and asks user to choose
|
||||
- Automatically reads `PLAN-CONVERSATION-*.md` if present (optional, for context)
|
||||
- **Documentation Verification Pass** - Documentation workflow now cross-references against PLAN-DRAFT before finalizing
|
||||
- New Process Step 7 with sub-steps: 7A (re-read PLAN-DRAFT), 7B (cross-reference sections), 7C (fix gaps), 7D (output summary)
|
||||
- New "Documentation Verification Pass" section with mapping table showing which PLAN-DRAFT sections to verify against which spec files
|
||||
- Gap handling: Missing items added with `<!-- VERIFICATION: Added - FR-X from PLAN-DRAFT -->` markers
|
||||
- Session end output now includes verification summary table showing Items in PLAN-DRAFT / Covered / Added per section
|
||||
- Added reminders: "Always run verification pass before finalizing" and "PLAN-DRAFT is the source of truth"
|
||||
- **Conversation Logging** - Planning workflow now saves the full planning conversation before creating PLAN-DRAFT
|
||||
- New file: `specs/<feature-name>/PLAN-CONVERSATION-<YYYYMMDD>.md` created in Phase 7
|
||||
- Contains full conversation transcript organized by phase with speaker attribution (`[AGENT]` vs `[USER RESPONSE]`)
|
||||
- Decision summary tables with user quotes, confirmed requirements, approved technologies, and assumptions
|
||||
- Serves as source of truth for plan verification
|
||||
- **PLAN-DRAFT Verification Pass** - New STEP 7C verifies PLAN-DRAFT against conversation log
|
||||
- Cross-references all requirements, tech decisions, risks, and assumptions
|
||||
- Missing items added with `<!-- VERIFICATION: Added from Phase X -->` markers
|
||||
- Outputs verification summary showing what was captured vs added
|
||||
- **Conversation Log field in PLAN-DRAFT** - New header field links to the conversation log file
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Installer default option** - Pressing Enter without selecting an option now defaults to `A` (Install to ALL platforms + loop CLI) instead of quitting
|
||||
- **Planning output location changed** - PLAN-DRAFT and conversation log now created in feature subdirectory
|
||||
- New location: `specs/<feature-name>/PLAN-DRAFT-<date>.md` and `specs/<feature-name>/PLAN-CONVERSATION-<date>.md`
|
||||
- Date format: YYYYMMDD (e.g., `20250204`) instead of full timestamp
|
||||
- Uppercase `PLAN-CONVERSATION` for consistency with `PLAN-DRAFT`
|
||||
- Feature directory created during planning (Step 1) instead of documentation (Step 2)
|
||||
- Documentation step no longer archives PLAN-DRAFT (already in correct location)
|
||||
- **Planning Phase 7 restructured** - Now has three sub-steps:
|
||||
- STEP 7A: Save Conversation Log (new)
|
||||
- STEP 7B: Create PLAN-DRAFT (existing behavior, uses same timestamp)
|
||||
- STEP 7C: Verification Pass (new)
|
||||
- **Session End example updated** - Now shows both conversation log and PLAN-DRAFT files
|
||||
- **Important Reminders expanded** - Added reminders about conversation log and verification pass
|
||||
|
||||
### 🐛 Fixed
|
||||
|
||||
- **`.gitignore` missing `specs/` entries in phase mode** - `ensureGitignore()` only ran inside `createTaskCommit()`, which is never called in phase mode. Moved `ensureGitRepo()` and `ensureGitignore()` to run once at startup in `Controller.run()` as a pre-flight step, ensuring `.gitignore` entries are set before the first iteration regardless of loop mode
|
||||
|
||||
## v1.5.2
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **AI Agent File Sync** - Init and Init-Update workflows now detect and sync other AI agent config files
|
||||
- Detects 6 file types: CLAUDE.md, GEMINI.md, .cursorrules, .github/copilot-instructions.md, .cursor/rules/, .windsurf/rules/
|
||||
- Offers to replace with references to AGENTS.md as single source of truth
|
||||
- User confirmation required before any modifications
|
||||
- Correct relative paths for each file location (./AGENTS.md, ../AGENTS.md, ../../AGENTS.md)
|
||||
- **Knowledge Transfer** - Init mode now uses existing CLAUDE.md content as context when creating new AGENTS.md
|
||||
- Preserves project knowledge during migration to AGENTS.md
|
||||
|
||||
## v1.5.1
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Prerequisite verification workflow** - Agents now verify/complete prerequisites before starting phase tasks
|
||||
- Implementation mode processes prerequisites in order: verify, complete, or mark assumed
|
||||
- Loop prompt treats prerequisites as "Task 0.X" - one per iteration before tasks
|
||||
- New completion markers: `PREREQ_COMPLETE` and `PREREQ_ASSUMED`
|
||||
- **New checkbox state `[?]`** - "Assumed complete, couldn't verify" for prerequisites that can't be validated
|
||||
- Use when prerequisite cannot be programmatically verified (e.g., "Design approved by stakeholder")
|
||||
- Agents skip `[?]` items like `[x]` items
|
||||
- **Re-opened phase handling in Revision mode** - Properly handle adding tasks to completed phases
|
||||
- New "Re-opening" impact type (Medium-High risk) in impact assessment
|
||||
- New tasks in completed phases get `🆕 ADDED` flag
|
||||
- Phase checkbox changes from `[x]` to `[ ]` in overview.md when new tasks added
|
||||
- "Phases Re-opened" section in revision summary
|
||||
- Consistency check now verifies phase completion status matches task completion
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Installer UI refresh** - Cleaner, narrower layout for better terminal compatibility
|
||||
- Narrower menu boxes (65 characters instead of 76)
|
||||
- Smaller mascot display at end of installation
|
||||
- Added first-time user documentation link after successful install
|
||||
- Updated menu descriptions to show "+ loop CLI" for relevant options
|
||||
- **Planning workflow guardrails** - Prevent users from skipping the documentation step
|
||||
- Added critical reminder after Phase 7 to direct to `/plan2code-2--document`
|
||||
- Added workflow order reminder in Session End section: Plan → Document → Implement → Finalize
|
||||
- Updated example closing message to emphasize documentation as next step
|
||||
- Added workflow order to Important Reminders section
|
||||
- **AGENTS.md pre-flight message** - Improved guidance for new projects
|
||||
- Message now explains that new projects can continue without AGENTS.md
|
||||
- Suggests creating basic AGENTS.md first with rules can still be valuable
|
||||
|
||||
## v1.5.0 - 2026-01-22
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Plan2Code Loop** - New autonomous CLI tool for hands-off spec implementation
|
||||
- Separate Node.js/TypeScript tool in `plan2code-loop/` directory
|
||||
- LLM-driven task discovery - AI reads spec files and finds unchecked tasks
|
||||
- Iterates through tasks one at a time, marking checkboxes as complete
|
||||
- Structured completion markers: `TASK_COMPLETE: 1.1 - description`
|
||||
- Session persistence with scratchpad and iteration logging
|
||||
- Supports Claude Code and GitHub Copilot CLI agents
|
||||
- **Installer integration** for loop CLI
|
||||
- Option `A` now installs prompts to all platforms AND builds/links the loop CLI
|
||||
- Option `O` builds and links plan2code-loop CLI only
|
||||
- Option `U` uninstalls prompts AND unlinks the loop CLI
|
||||
|
||||
### 📝 Documentation
|
||||
|
||||
- Updated README.md with "Autonomous Loop" section explaining when to use loop vs manual Step 3
|
||||
- Updated QUICK-REFERENCE.md with loop commands and decision tree
|
||||
- Updated AGENTS.md with loop architecture, commands, and completion markers
|
||||
|
||||
## v1.4.0 - 2026-01-09
|
||||
|
||||
### ✨ Added
|
||||
|
||||
- **Parallel Phase Execution** - Run multiple implementation phases simultaneously in separate agent instances
|
||||
- Documentation Mode auto-detects parallel-eligible phases based on file conflicts and dependencies
|
||||
- Implementation Mode presents phase selection UI when parallel options are available
|
||||
- New "Parallel Execution Groups" section in `overview.md` tracks which phases can run together
|
||||
- Conflict detection criteria: file overlap, prerequisite dependencies, data/output dependencies, shared state
|
||||
- Users can start multiple `/plan2code-3--implement` sessions to work on different parallel phases
|
||||
- **In-Progress Phase Tracking** - Track which phases are actively being worked on
|
||||
- New `[/]` checkbox status indicates a phase is in-progress (between `[ ]` pending and `[x]` complete)
|
||||
- Phases marked `[/]` when an agent starts working, `[x]` when user approves completion
|
||||
- Aborted phases stay `[/]` to enable resume - never reset back to `[ ]`
|
||||
- Parallel selection UI shows `[IN PROGRESS]` vs `[AVAILABLE]` status for each phase
|
||||
- Single in-progress phase prompts user to confirm resume (prevents accidental overlap)
|
||||
- Supports multiple agent sessions on parallel phases with clear visibility of what's active
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Documentation Mode process** - Added step 6 "Analyze phases for parallel execution eligibility"
|
||||
- **Implementation Mode detection** - Now checks for parallel siblings before starting phase
|
||||
- **Implementation Mode phase selection** - 4-case decision logic for parallel, resume, auto-start scenarios
|
||||
- **Session end summaries** - Documentation Mode now reports parallel execution groups
|
||||
- **Abort handling** - Phases remain `[/]` on abort with clear resume instructions
|
||||
|
||||
## v1.3.3 - 2025-12-30
|
||||
|
||||
### ✨ Added
|
||||
@@ -22,6 +536,7 @@ All notable changes to Plan2Code will be documented in this file.
|
||||
|
||||
## v1.3.2 - 2025-12-25
|
||||
|
||||
|
||||
### 🔧 Changed
|
||||
|
||||
- **Phase file naming convention** - Changed from `Phase X.md` to `phase-X.md` (lowercase, hyphen instead of space)
|
||||
|
||||
+70
-24
@@ -3,64 +3,110 @@
|
||||
## Commands
|
||||
|
||||
| Step | Command | Input | Output |
|
||||
| ------ | ---------------------------| --------------- | ------------------------- |
|
||||
| Init | /plan2code---init | None | AGENTS.md file |
|
||||
| Update | /plan2code---init-update | AGENTS.md | Updated AGENTS.md |
|
||||
| 0 | /plan2code---quick-task | Requirements | Conversational plan |
|
||||
| 1 | /plan2code-1--plan | Requirements | PLAN-DRAFT.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 |
|
||||
| ------ | ------------------------------- | --------------- | ----------------------------------- |
|
||||
| Init | /plan2code-init | None | AGENTS.md file |
|
||||
| Update | /plan2code-init-update | AGENTS.md | Updated AGENTS.md |
|
||||
| 0 | /plan2code-quick-task | Requirements | Conversational plan |
|
||||
| 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/ |
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
specs/
|
||||
├── PLAN-DRAFT-<timestamp>.md # From Step 1
|
||||
└── <feature-name>/
|
||||
├── PLAN-DRAFT-<date>.md # From Step 1 (verified plan)
|
||||
├── PLAN-CONVERSATION-<date>.md # From Step 1 (conversation log)
|
||||
├── overview.md # From Step 2
|
||||
└── Phase X.md # From Step 2
|
||||
└── phase-X.md # From Step 2
|
||||
|
||||
specs--completed/ # After Step 4
|
||||
└── <feature-name>/ # Archived specs
|
||||
```
|
||||
|
||||
Note: `<date>` uses YYYYMMDD format (e.g., `20250204`)
|
||||
|
||||
## Key Rules
|
||||
|
||||
- Start NEW conversation for each step (and each implementation phase)
|
||||
- ONE phase per conversation
|
||||
- ONE phase per conversation (but parallel phases can run in separate instances)
|
||||
- Reply "approved" to complete phases
|
||||
- 90% confidence required before planning completes
|
||||
- Never look in `specs--completed/` (it's archived specs)
|
||||
|
||||
## Phase Status
|
||||
|
||||
| Checkbox | Status | Meaning |
|
||||
|----------|--------|---------|
|
||||
| `[ ]` | Pending | Not started |
|
||||
| `[/]` | In Progress | Agent working (or paused) |
|
||||
| `[x]` | Complete | Approved |
|
||||
|
||||
## 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
|
||||
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 |
|
||||
| Need to change plan | Use `/plan2code-1b--revise-plan` |
|
||||
| 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 |
|
||||
| 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
|
||||
|
||||
```
|
||||
New to a project?
|
||||
└── /plan2code---init → Generate AGENTS.md for project-specific guidance
|
||||
└── /plan2code-init → Generate AGENTS.md for project-specific guidance
|
||||
|
||||
Learned something during a session?
|
||||
└── /plan2code---init-update → Add learnings to AGENTS.md
|
||||
└── /plan2code-init-update → Add learnings to AGENTS.md
|
||||
|
||||
Is it a quick, small task?
|
||||
├── Yes → /plan2code---quick-task (standalone)
|
||||
└── No → /plan2code-1--plan (full workflow)
|
||||
├── /plan2code-2--document
|
||||
├── /plan2code-3--implement (repeat per phase)
|
||||
└── /plan2code-4--finalize
|
||||
├── Yes → /plan2code-quick-task (standalone)
|
||||
└── No → /plan2code-1-plan (full workflow)
|
||||
├── /plan2code-2-document
|
||||
├── /plan2code-3-implement (repeat per phase)
|
||||
│ └── OR: plan2code-loop (autonomous alternative)
|
||||
└── /plan2code-4-finalize
|
||||
|
||||
Need to revise mid-implementation?
|
||||
└── /plan2code-1b--revise-plan
|
||||
└── /plan2code-1b-revise-plan
|
||||
```
|
||||
|
||||
## 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/`
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
A structured 4-step workflow for developing features and projects with AI assistance. This methodology emphasizes thorough planning before implementation, ensuring well-documented, maintainable code.
|
||||
|
||||
<img src="docs/plan2code.jpg" alt="Plan2Code Workflow" height="400">
|
||||
<img src="docs/desk.jpg" alt="Plan2Code Workflow" height="275">
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -15,16 +15,18 @@ A structured 4-step workflow for developing features and projects with AI assist
|
||||
New Chat New Chat New Chat (per phase) New Chat
|
||||
```
|
||||
|
||||
| Command | Use When |
|
||||
|---------|----------|
|
||||
| `/plan2code---init` | Generate AGENTS.md file for new/existing projects |
|
||||
| `/plan2code---init-update` | Update AGENTS.md with new learnings from coding sessions |
|
||||
| `/plan2code---quick-task` | Small, quick tasks that don't need full workflow |
|
||||
| `/plan2code-1--plan` | Starting a new feature (full planning) |
|
||||
| `/plan2code-1b--revise-plan` | Requirements change mid-implementation |
|
||||
| `/plan2code-2--document` | After planning, create implementation specs |
|
||||
| `/plan2code-3--implement` | Execute implementation (one phase per conversation) |
|
||||
| `/plan2code-4--finalize` | All phases complete, ready to archive |
|
||||
| Command | When to Use |
|
||||
|----------------------------------|----------------------------------------------------------|
|
||||
| `/plan2code-init` | Generate AGENTS.md file for new/existing projects |
|
||||
| `/plan2code-init-update` | Update AGENTS.md with new learnings from coding sessions |
|
||||
| `/plan2code-quick-task` | Small, quick tasks that don't need full workflow |
|
||||
| `/plan2code-review` | Post-phase code review (after key features or milestones)|
|
||||
| `/plan2code-1-plan` | Starting a new feature (full planning) |
|
||||
| `/plan2code-1b-revise-plan` | Requirements change mid-implementation |
|
||||
| `/plan2code-2-document` | After planning, create implementation specs |
|
||||
| `/plan2code-3-implement` | Execute implementation (one phase per conversation) |
|
||||
| `/plan2code-4-finalize` | All phases complete, ready to archive |
|
||||
| `/plan2code-handoff` | Compact the conversation into a handoff doc for a fresh session |
|
||||
|
||||
**Key Rules:**
|
||||
- Start NEW conversation for each step (and each implementation phase)
|
||||
@@ -38,115 +40,105 @@ See [QUICK-REFERENCE.md](QUICK-REFERENCE.md) for full reference card.
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
**Node.js** (v14 or later) is required. If you don't have it:
|
||||
- Download from [nodejs.org](https://nodejs.org/)
|
||||
- Or: `brew install node` (macOS) | `winget install OpenJS.NodeJS` (Windows) | `sudo apt install nodejs` (Linux)
|
||||
|
||||
### Quick Start
|
||||
|
||||
```bash
|
||||
git clone https://github.com/jparkerweb/plan2code.git
|
||||
cd plan2code
|
||||
node install.js
|
||||
```
|
||||
|
||||
The interactive installer will guide you through:
|
||||
- **Global installation** (recommended) - commands available in all projects
|
||||
- **Local/project installation** - commands for a specific project only
|
||||
- **Uninstall** - remove previously installed files
|
||||
Plan2Code includes an interactive installer that generates and installs workflow files for all major AI coding assistants.
|
||||
|
||||
<img src="docs/install-script.jpg" width="600">
|
||||
|
||||
### Prerequisites
|
||||
|
||||
The install script requires **Node.js** (v14 or later). If you don't have Node.js installed:
|
||||
|
||||
1. Download from [nodejs.org](https://nodejs.org/) (recommended)
|
||||
2. Or use a package manager:
|
||||
- **macOS:** `brew install node`
|
||||
- **Windows:** `winget install OpenJS.NodeJS` or `choco install nodejs`
|
||||
- **Linux:** `sudo apt install nodejs` (Debian/Ubuntu) or `sudo dnf install nodejs` (Fedora)
|
||||
|
||||
### Supported Platforms
|
||||
|
||||
| Platform | Global Location | Invocation |
|
||||
|----------|-----------------|------------|
|
||||
| Claude Code | `~/.claude/commands/` | `/plan2code-1--plan` |
|
||||
| Copilot CLI | `~/.copilot/agents/` | `--agent=plan2code-1--plan` |
|
||||
| VS Code Copilot | `~/Library/Application Support/Code/User/prompts/` | Slash commands |
|
||||
| Windsurf | `~/.codeium/windsurf/global_workflows/` | `/plan2code-1--plan` |
|
||||
| Cursor | `~/.cursor/commands/` | `/plan2code-1--plan` |
|
||||
| Continue | `~/.continue/prompts/` | `/plan2code-1--plan` |
|
||||
| Antigravity | `.agent/workflows/` (project only) | `/plan2code-1--plan` |
|
||||
- Claude Code
|
||||
- Cursor
|
||||
- Windsurf
|
||||
- Continue
|
||||
- Codeium (IntelliJ)
|
||||
- GitHub Copilot CLI
|
||||
- VS Code GitHub Copilot
|
||||
- Gemini CLI
|
||||
- Crush
|
||||
- Pi (pi.dev)
|
||||
- Amp
|
||||
- OpenCode
|
||||
- Devin
|
||||
- Zed
|
||||
|
||||
### CLI Options
|
||||
### Install via npx (Recommended — No Clone Required)
|
||||
|
||||
Run the interactive installer directly using `npx` with your preferred GitHub authentication method:
|
||||
|
||||
**If you use SSH keys:**
|
||||
```bash
|
||||
npx git+ssh://git@github.com/jparkerweb/plan2code.git
|
||||
```
|
||||
|
||||
**If you use HTTPS authentication:**
|
||||
```bash
|
||||
npx git+https://github.com/jparkerweb/plan2code.git
|
||||
```
|
||||
|
||||
This downloads the installer to a temporary location, runs it, installs the workflow files to your machine, and cleans up automatically. The installed workflows remain on your system and work independently. To update or reinstall, simply run the command again.
|
||||
|
||||
### Standard Installation (Clone Method)
|
||||
|
||||
#### No Clone Required
|
||||
|
||||
Run the interactive installer directly using `npx` with your preferred GitHub authentication method:
|
||||
|
||||
**If you use SSH keys:**
|
||||
```bash
|
||||
npx git+ssh://git@github.com/jparkerweb/plan2code.git
|
||||
```
|
||||
|
||||
**If you use HTTPS authentication:**
|
||||
```bash
|
||||
npx git+https://github.com/jparkerweb/plan2code.git
|
||||
```
|
||||
|
||||
This downloads the installer to a temporary location, runs it, installs the workflow files to your machine, and cleans up automatically. The installed workflows remain on your system and work independently. To update or reinstall, simply run the command again.
|
||||
|
||||
#### Standard Installation (Clone Method)
|
||||
|
||||
```bash
|
||||
node install.js # Interactive menu
|
||||
node install.js --platform claude # Install specific platform
|
||||
node install.js --local # Install to current project instead of global
|
||||
node install.js --dry-run # Preview what would be installed
|
||||
node install.js --uninstall # Remove installed files
|
||||
node install.js --help # Show all options
|
||||
# Clone the repository
|
||||
git clone https://github.com/jparkerweb/plan2code.git
|
||||
cd plan2code
|
||||
|
||||
# Run the interactive installer
|
||||
node install.js
|
||||
|
||||
# OPTIONAL: Install dev dependencies (ONLY if you plan to modify/contribute to Plan2Code)
|
||||
npm install
|
||||
```
|
||||
|
||||
The installer displays an interactive menu:
|
||||
|
||||
```
|
||||
╔════════════════════════════════════════════════════════════════╗
|
||||
║ INSTALL PLAN2CODE ║
|
||||
╠════════════════════════════════════════════════════════════════╣
|
||||
║ I. INSTALL Install Plan2Code for all platforms ║
|
||||
║ U. UNINSTALL Remove Plan2Code files ║
|
||||
║ C. CUSTOM Advanced options ║
|
||||
║ Q. QUIT Exit ║
|
||||
╚════════════════════════════════════════════════════════════════╝
|
||||
|
||||
SELECT OPTION (I, U, C, Q) [I]:
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary>Platform Details</summary>
|
||||
## Status Line — Claude CLI (Optional)
|
||||
|
||||
### Claude Code CLI
|
||||
|
||||
Type `/plan2code-1--plan` in chat. Restart Claude Code after installation.
|
||||
|
||||
**Docs:** [Claude Code Slash Commands](https://code.claude.com/docs/en/slash-commands)
|
||||
|
||||
### GitHub Copilot CLI
|
||||
|
||||
```bash
|
||||
copilot --agent=plan2code-1--plan --prompt "I want to build a REST API"
|
||||
```
|
||||
|
||||
Requires: `npm install -g @github/copilot@latest`
|
||||
|
||||
**Docs:** [GitHub Copilot CLI Custom Agents](https://docs.github.com/en/copilot/concepts/agents/about-copilot-cli)
|
||||
|
||||
### VS Code GitHub Copilot
|
||||
|
||||
Open Copilot Chat (`Ctrl+Shift+I`), type `/` to see prompts. Requires per-project install via `node install.js --local`.
|
||||
|
||||
**Docs:** [VS Code Copilot Prompt Files](https://code.visualstudio.com/docs/copilot/customization/prompt-files)
|
||||
|
||||
### Windsurf IDE
|
||||
|
||||
Type `/plan2code-1--plan` in Cascade. Note: 12,000 character limit per workflow.
|
||||
|
||||
**Docs:** [Windsurf Workflows](https://docs.windsurf.com/windsurf/cascade/workflows)
|
||||
|
||||
### Cursor AI
|
||||
|
||||
Type `/` in chat, select command from dropdown.
|
||||
|
||||
**Docs:** [Cursor Commands](https://docs.cursor.com/agent/chat/commands)
|
||||
|
||||
### Google Antigravity
|
||||
|
||||
Type `/plan2code-1--plan` in chat. Requires per-project install via `node install.js --local`.
|
||||
|
||||
**Docs:** [Customize Antigravity](https://atamel.dev/posts/2025/11-25_customize_antigravity_rules_workflows/)
|
||||
|
||||
### Continue (VS Code/JetBrains)
|
||||
|
||||
Type `/plan2code-1--plan` in chat. Install the Continue extension first.
|
||||
|
||||
**Docs:** [Continue Prompts](https://docs.continue.dev/customize/deep-dives/prompts)
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary>Manual Installation</summary>
|
||||
|
||||
If your AI tool isn't listed or you prefer manual setup:
|
||||
|
||||
1. **Copy/Paste:** Copy contents from `src/plan2code-*.md` files into your conversation
|
||||
2. **File Reference:** Tell the AI: `Please follow the instructions in src/plan2code-1--plan.md`
|
||||
3. **Custom Integration:** Adapt files from `dist/` directories to your tool's format
|
||||
|
||||
</details>
|
||||
A persistent three-line status bar for Claude Code showing model, project, git branch, uncommitted diff stats, context usage, and plan quota. Included in `node install.js` → `A` (Install All + dev tools), or available individually via Custom → Status Line. See [src/statusline-claude/README.md](src/statusline-claude/README.md) for details.
|
||||
|
||||
---
|
||||
|
||||
@@ -180,7 +172,7 @@ Fresh conversations prevent context pollution and ensure the AI focuses on the c
|
||||
5. **Technical Specification** - Break down implementation phases, identify risks
|
||||
6. **Transition Decision** - Finalize plan when confidence reaches 90%+
|
||||
|
||||
**Output:** `specs/PLAN-DRAFT-<timestamp>.md` containing the complete implementation plan
|
||||
**Output:** `specs/<feature-name>/PLAN-DRAFT-<date>.md` and `specs/<feature-name>/PLAN-CONVERSATION-<date>.md` (date format: YYYYMMDD)
|
||||
|
||||
**Key Behaviors:**
|
||||
|
||||
@@ -195,19 +187,21 @@ Fresh conversations prevent context pollution and ensure the AI focuses on the c
|
||||
|
||||
**Purpose:** Transform the planning output into structured, actionable implementation documents.
|
||||
|
||||
**Required Context:** Attach or reference the `specs/PLAN-DRAFT-<timestamp>.md` from Step 1 (or provide the planning conversation).
|
||||
**Required Context:** Attach or reference the `specs/<feature-name>/PLAN-DRAFT-<date>.md` from Step 1 (or provide the planning conversation).
|
||||
|
||||
**Output Structure:**
|
||||
|
||||
```
|
||||
specs/
|
||||
└── <feature-name>/
|
||||
├── overview.md # High-level overview with phase checkboxes
|
||||
├── overview.md # High-level overview with phase checkboxes and parallel groups
|
||||
├── Phase 1.md # Detailed tasks for Phase 1
|
||||
├── Phase 2.md # Detailed tasks for Phase 2
|
||||
└── Phase N.md # ...additional phases
|
||||
```
|
||||
|
||||
The `overview.md` includes a "Parallel Execution Groups" section that identifies which phases can be run simultaneously in separate agent instances.
|
||||
|
||||
**Document Format:**
|
||||
|
||||
- Each phase file contains detailed one-story-point tasks
|
||||
@@ -228,11 +222,14 @@ specs/
|
||||
**Workflow:**
|
||||
|
||||
1. Identify the next uncompleted phase (unchecked in `overview.md`)
|
||||
2. Implement ALL tasks in that phase exactly as specified
|
||||
3. Update `Phase X.md` checkboxes as tasks complete `[x]`
|
||||
4. Update `overview.md` phase checkbox when phase completes
|
||||
5. Perform code review to ensure nothing was missed
|
||||
6. Add completion summary to the phase document
|
||||
2. Check for parallel execution options (if phases can run simultaneously)
|
||||
3. Implement ALL tasks in that phase exactly as specified
|
||||
4. Update `Phase X.md` checkboxes as tasks complete `[x]`
|
||||
5. Update `overview.md` phase checkbox when phase completes
|
||||
6. Perform code review to ensure nothing was missed
|
||||
7. Add completion summary to the phase document
|
||||
|
||||
**Parallel Execution:** If the next phase is part of a parallel-eligible group, you'll be prompted to choose which phase to implement. This allows running multiple agent instances simultaneously on different phases that don't conflict with each other.
|
||||
|
||||
**Key Rules:**
|
||||
|
||||
@@ -244,6 +241,31 @@ specs/
|
||||
|
||||
---
|
||||
|
||||
### Review Mode 🔬 (Optional)
|
||||
|
||||
**Purpose:** Comprehensive post-implementation code review with adaptive scope and spec compliance checking.
|
||||
|
||||
**AI Role:** Critical review specialist -- independent second opinion
|
||||
|
||||
**When to use:** After completing implementation phases, especially key features or milestones. Can be run after any phase, not just before finalization.
|
||||
|
||||
**What it does:**
|
||||
|
||||
1. Determines review scope — detects conversation context, user-specified scope, or gathers git changes as fallback
|
||||
2. Understands context and determines review strategy
|
||||
3. Analyzes across 11 dimensions (correctness, security, performance, spec compliance, etc.)
|
||||
4. Generates findings ranked by severity (Critical, Warning, Suggestion)
|
||||
5. Offers to fix issues, then provides commit guidance
|
||||
|
||||
**Key Behaviors:**
|
||||
|
||||
- Uses companion reference files for deep verification, detailed dimension checklists, and false-positive detection (loaded automatically during review)
|
||||
- Reviews all changed files across 11 dimensions; prioritizes by risk when batches exceed 50 files
|
||||
- Spec-aware when `specs/` exists; works standalone without specs
|
||||
- Review phase is read-only; fixes only on user request with verification
|
||||
|
||||
---
|
||||
|
||||
### Step 4: Finalization Mode 🧹
|
||||
|
||||
**Purpose:** Validate implementation, create summaries, and archive documentation.
|
||||
@@ -260,35 +282,18 @@ specs/
|
||||
|
||||
---
|
||||
|
||||
## How to Use These Prompts
|
||||
## How to Use
|
||||
|
||||
### Option 1: Platform-Specific Slash Commands (Recommended)
|
||||
|
||||
This repository includes pre-configured workflow files for all major AI coding assistants. See the [Installation](#installation) section above for platform-specific setup instructions.
|
||||
|
||||
**Quick commands after setup:**
|
||||
After running `node install.js`, use the slash commands directly in your AI tool:
|
||||
|
||||
```
|
||||
/plan # Start planning a new feature
|
||||
/document # Create implementation docs from plan
|
||||
/implement # Begin/continue implementation
|
||||
/finalize # Wrap up after all phases complete
|
||||
/plan2code-1-plan # Start planning a new feature
|
||||
/plan2code-2-document # Create implementation docs from plan
|
||||
/plan2code-3-implement # Begin/continue implementation
|
||||
/plan2code-review # Post-phase code review (optional)
|
||||
/plan2code-4-finalize # Wrap up after all phases complete
|
||||
```
|
||||
|
||||
### Option 2: Direct File Reference
|
||||
|
||||
Reference the prompt files directly in your conversation:
|
||||
|
||||
```
|
||||
Please follow the instructions in src/plan2code-1--plan.md
|
||||
|
||||
I want to build a user authentication system with OAuth support.
|
||||
```
|
||||
|
||||
### Option 3: Copy/Paste
|
||||
|
||||
Copy the contents of each prompt file and paste at the beginning of your conversation when starting that step.
|
||||
|
||||
---
|
||||
|
||||
## Complete Workflow Example
|
||||
@@ -305,14 +310,14 @@ AI: 🤔 [REQUIREMENTS ANALYSIS]
|
||||
... asks clarifying questions, works through phases ...
|
||||
|
||||
AI: 🤔 [TRANSITION DECISION]
|
||||
Confidence: 92%. Creating specs/PLAN DRAFT.md...
|
||||
Confidence: 92%. Creating specs/task-api/PLAN-DRAFT-20250204.md...
|
||||
```
|
||||
|
||||
**Session 2 - Documentation (New Chat):**
|
||||
|
||||
```
|
||||
User: [Paste or invoke Step 2 prompt]
|
||||
[Attach: specs/PLAN DRAFT.md]
|
||||
[Attach: specs/task-api/PLAN-DRAFT-20250204.md]
|
||||
|
||||
AI: 📝 [DOCUMENTATION]
|
||||
Creating specs/task-api/overview.md...
|
||||
@@ -372,18 +377,24 @@ AI: 🧹 [SPEC CLEANUP]
|
||||
|
||||
The checkbox system enables seamless progress tracking across multiple sessions:
|
||||
|
||||
**overview.md:**
|
||||
**Phase Status (overview.md):**
|
||||
|
||||
| Checkbox | Status | Meaning |
|
||||
|----------|--------|---------|
|
||||
| `[ ]` | Pending | Not yet started |
|
||||
| `[/]` | In Progress | Agent actively working (or paused/aborted) |
|
||||
| `[x]` | Complete | Finished and approved |
|
||||
|
||||
```markdown
|
||||
## Phases
|
||||
|
||||
- [x] Phase 1: Project Setup
|
||||
- [x] Phase 2: Database Models
|
||||
- [ ] Phase 3: API Endpoints <- Next phase to implement
|
||||
- [ ] Phase 4: Authentication
|
||||
- [/] Phase 3: API Endpoints <- In progress (agent working)
|
||||
- [ ] Phase 4: Authentication <- Next available
|
||||
```
|
||||
|
||||
**Phase 3.md:**
|
||||
**Task Status (phase-X.md):**
|
||||
|
||||
```markdown
|
||||
## Tasks
|
||||
@@ -395,6 +406,8 @@ The checkbox system enables seamless progress tracking across multiple sessions:
|
||||
- [ ] Implement DELETE /tasks/:id
|
||||
```
|
||||
|
||||
The `[/]` status enables parallel execution - multiple agents can work on different phases simultaneously, and you can see which phases are actively being worked on.
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
@@ -415,12 +428,70 @@ The checkbox system enables seamless progress tracking across multiple sessions:
|
||||
| Step | Required Input |
|
||||
| ------------------ | ---------------------------------------------------- |
|
||||
| Step 1 (Plan) | None (describe your feature/project) |
|
||||
| Step 2 (Document) | `specs/PLAN DRAFT.md` or planning conversation |
|
||||
| Step 2 (Document) | `specs/<feature>/PLAN-DRAFT-<date>.md` or planning conversation |
|
||||
| Step 3 (Implement) | `specs/<feature>/overview.md` (auto-detects phase) |
|
||||
| Review (Optional) | Scope guidance (e.g., "review last 2 phases", "just the auth module", "whole PR"). Auto-detects changes and specs if no scope given. |
|
||||
| Step 4 (Finalize) | `specs/<feature>/overview.md` |
|
||||
|
||||
---
|
||||
|
||||
## Autonomous Loop (Alternative to Step 3)
|
||||
|
||||
For hands-off implementation, Plan2Code includes an optional autonomous loop CLI that iterates through your spec tasks automatically.
|
||||
|
||||
> **Note:** The loop is an **alternative** to `/plan2code-3-implement`, not a replacement. Use the manual Step 3 workflow when you want direct control over each phase, or use the loop when you prefer autonomous execution.
|
||||
|
||||
### When to Use Each
|
||||
|
||||
| Approach | Best For |
|
||||
|----------|----------|
|
||||
| `/plan2code-3-implement` | Interactive control, reviewing each phase, complex logic requiring human judgment |
|
||||
| `plan2code-loop` | Straightforward implementations, batch processing, overnight runs |
|
||||
|
||||
### Installing the Loop
|
||||
|
||||
```bash
|
||||
# From the plan2code root directory:
|
||||
|
||||
# Option 1: Install everything (recommended)
|
||||
node install.js # Select I at the menu
|
||||
|
||||
# Option 2: Install loop only
|
||||
node install.js # Select C, then O at the menu
|
||||
```
|
||||
|
||||
### Using the Loop
|
||||
|
||||
```bash
|
||||
# Run the loop - fully interactive
|
||||
plan2code-loop
|
||||
```
|
||||
|
||||
The CLI will:
|
||||
1. Auto-detect specs in `./specs/` directory
|
||||
2. Let you select a spec if multiple are found
|
||||
3. Prompt to continue if an existing session is found
|
||||
4. Ask for JIRA ticket ID, agent selection, loop mode, and max iterations
|
||||
|
||||
### Loop Modes
|
||||
|
||||
| Mode | Behavior | Git Commits | Best For |
|
||||
|------|----------|-------------|----------|
|
||||
| **One task per loop** (default) | Each agent call implements one task | Node controller commits after each task | Smaller models, cautious execution |
|
||||
| **One phase per loop** | Each agent call implements all tasks in a phase | LLM commits after each task (with JIRA ID) | Smart models with larger context windows, related tasks |
|
||||
|
||||
Session state is stored per-spec in `specs/<feature>/.plan2code-loop/`, keeping each feature's progress isolated.
|
||||
|
||||
The loop will:
|
||||
1. Read your `overview.md` and phase files
|
||||
2. Find the first unchecked task (or phase, in phase mode)
|
||||
3. Implement it and mark the checkbox complete
|
||||
4. Repeat until all tasks are done or max iterations reached
|
||||
|
||||
See [plan2code-loop/](plan2code-loop/) for full documentation.
|
||||
|
||||
---
|
||||
|
||||
## File Structure After Complete Implementation
|
||||
|
||||
```
|
||||
@@ -456,9 +527,9 @@ Feel free to modify these prompts to fit your workflow:
|
||||
|
||||
**Slash commands/workflows not recognized:**
|
||||
|
||||
- Check if your project's `.gitignore` includes patterns like `.windsurf/`, `.cursor/`, `.continue/`, or `.agent/`
|
||||
- Many AI tools don't recognize workflows in gitignored directories
|
||||
- Solution: Use global installation by copying the directories to your home directory (e.g., `cp -r .windsurf ~/`)
|
||||
- Ensure you ran `node install.js` and selected the appropriate platform
|
||||
- Restart your AI tool after installation
|
||||
- For per-project installation, ensure the directory isn't in `.gitignore`
|
||||
|
||||
**AI jumps ahead to implementation during planning:**
|
||||
|
||||
@@ -481,5 +552,3 @@ Feel free to modify these prompts to fit your workflow:
|
||||
**Too many/few phases:**
|
||||
|
||||
- Adjust during Step 2 (Documentation) - phases should represent logical groupings of work
|
||||
|
||||
|
||||
|
||||
+25
-5
@@ -985,6 +985,25 @@
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="step">
|
||||
<div class="step-content">
|
||||
<div class="step-header">
|
||||
<div class="step-number headline">review</div>
|
||||
<div class="step-icon" style="color: var(--accent);">🔬</div>
|
||||
</div>
|
||||
<h2 class="step-title subheadline">Review</h2>
|
||||
<p class="step-description">
|
||||
Optional post-implementation code review. An independent senior-engineer second opinion that questions assumptions and surfaces defects with fresh eyes — recommended after key features or milestones.
|
||||
</p>
|
||||
<ul class="step-points">
|
||||
<li>Adaptive scope: focused files, branch changes, or a full subsystem</li>
|
||||
<li>Analyzes across 11 dimensions (correctness, security, performance, spec compliance, and more)</li>
|
||||
<li>Findings ranked by severity with concrete, evidence-based fixes</li>
|
||||
<li>Read-only by default; applies fixes only on request, then verifies</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="step">
|
||||
<div class="step-content">
|
||||
<div class="step-header">
|
||||
@@ -1080,7 +1099,7 @@
|
||||
<div class="start-step">
|
||||
<div class="start-step-number headline">02</div>
|
||||
<div class="start-step-content">
|
||||
<h3 class="subheadline">Start a new chat with <span class="code-line">/plan2code-1--plan</span></h3>
|
||||
<h3 class="subheadline">Start a new chat with <span class="code-line">/plan2code-1-plan</span></h3>
|
||||
<p>Describe your feature or project. The AI will work through planning phases until reaching 90% confidence in the solution.</p>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1090,10 +1109,11 @@
|
||||
<h3 class="subheadline">Follow the 4-step workflow</h3>
|
||||
<p>New conversation for each step:</p>
|
||||
<ul class="code-list">
|
||||
<li><span class="code-line">/plan2code-1--plan</span></li>
|
||||
<li><span class="code-line">/plan2code-2--document</span></li>
|
||||
<li><span class="code-line">/plan2code-3--implement</span> <span class="gray">(per phase)</span></li>
|
||||
<li><span class="code-line">/plan2code-4--finalize</span></li>
|
||||
<li><span class="code-line">/plan2code-1-plan</span></li>
|
||||
<li><span class="code-line">/plan2code-2-document</span></li>
|
||||
<li><span class="code-line">/plan2code-3-implement</span> <span class="gray">(per phase)</span></li>
|
||||
<li><span class="code-line">/plan2code-review</span> <span class="gray">(optional)</span></li>
|
||||
<li><span class="code-line">/plan2code-4-finalize</span></li>
|
||||
</ul>
|
||||
<br>
|
||||
<p>Clean context, maximum clarity!</p>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 147 KiB |
+1673
-323
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "plan2code",
|
||||
"version": "1.16.0",
|
||||
"private": true,
|
||||
"bin": {
|
||||
"plan2code": "./install.js"
|
||||
},
|
||||
"scripts": {
|
||||
"prepare": "husky",
|
||||
"test": "node scripts/validate-char-count.js"
|
||||
},
|
||||
"devDependencies": {
|
||||
"husky": "^9.0.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
# Changelog
|
||||
|
||||
## 1.1.0
|
||||
|
||||
### Resume support
|
||||
- Add `--resume` flag to continue incomplete runs from saved state
|
||||
- Skip previously succeeded steps when resuming (init, plan, document, implement, finalize)
|
||||
- Restore idea name, description, project directory, and implement pass counter from state
|
||||
- Auto-detect state files in current directory (enhancement mode) or subdirectories (new-project mode)
|
||||
- Delete state file automatically after a fully successful run
|
||||
- Preserve state file on failure for later resume
|
||||
- Add `deleteState()` and `findExistingState()` utilities to bot-state module
|
||||
- Add bot-state unit tests (saveState, loadState, deleteState, findExistingState)
|
||||
|
||||
### Idea generation improvements
|
||||
- Expand idea categories from binary CLI/web-app coin flip to 12 diverse categories (games, dashboards, browser extensions, desktop utilities, etc.)
|
||||
- Add guidance to avoid defaulting to developer-centric tools (git analyzers, code formatters)
|
||||
- Strengthen `--idea` seed clause so the LLM stays aligned with the user's theme instead of ignoring it
|
||||
- Update system prompt to encourage creative, cross-domain ideas
|
||||
|
||||
### Init step overhaul (new projects)
|
||||
- Init now creates a minimal AGENTS.md stub (name, description, status) instead of running the full `/plan2code-init` skill
|
||||
- Prevents hallucinated architecture, commands, and `.agents-docs/` files before the plan step runs
|
||||
- Init evaluation criteria updated to reward minimalism and penalize premature detail
|
||||
|
||||
### Implement step overhaul
|
||||
- Implement step now works directly with Read/Write/Edit/Glob/Grep tools instead of delegating to Skill sub-session
|
||||
- Inlined step-by-step process: find specs, pick phase, implement tasks, mark checkboxes
|
||||
- Fixes issue where Skill sub-sessions did all work invisibly, causing zero tool observations
|
||||
|
||||
### Observation tracking fix
|
||||
- Capture `tool_use` blocks from the assistant message stream in session-runner as a fallback when `canUseTool` callback doesn't fire
|
||||
- Add deduplication in ObservationCollector to prevent double-counting from both sources
|
||||
- Fixes all steps reporting 0 tools used / 0 files created in BOT-NOTES and evaluations
|
||||
|
||||
### Evaluator improvements
|
||||
- Increase evaluator `maxTurns` from 3 to 30 so it has room for tool calls before producing the scored response
|
||||
- Add warning log when evaluation parser can't find SCORE in output (was silently defaulting to 50)
|
||||
|
||||
## 1.0.0
|
||||
|
||||
- Initial release
|
||||
- Two auto-detected modes: new-project and enhancement
|
||||
- `--idea` flag to seed the idea generator
|
||||
- Full workflow execution: init → plan → document → implement → finalize
|
||||
- Artifact validation after each step
|
||||
- State persistence to `.plan2code-bot-state.json`
|
||||
- Auto-responder for autonomous Claude Agent SDK sessions
|
||||
- Bot-friendly skill installation (strips `disable-model-invocation`)
|
||||
@@ -0,0 +1,234 @@
|
||||
# LLM-as-Judge Evaluation System
|
||||
|
||||
## Overview
|
||||
|
||||
The plan2code-bot now includes an **always-on LLM-as-judge evaluation system** that transforms it from a "yes-man" into an authentic QA agent. This provides realistic quality signals for `plan2code-metrics` to analyze and drive recursive self-improvement.
|
||||
|
||||
## Key Features
|
||||
|
||||
### 1. Intelligent Decision Making (Real-Time)
|
||||
|
||||
**What:** During execution, when `AskUserQuestion` is called, the bot uses an LLM to make thoughtful decisions based on current observations.
|
||||
|
||||
**How it works:**
|
||||
- Collects observations up to the current point (tools used, files created, errors)
|
||||
- Queries LLM with context: "Given what you've seen, should you approve this plan?"
|
||||
- LLM inspects current artifacts using Read/Glob/Grep
|
||||
- Returns evidence-based answer with reasoning
|
||||
- All decisions are recorded for metrics analysis
|
||||
|
||||
**Example:**
|
||||
```
|
||||
Question: "Approve this plan?"
|
||||
Observations: Created PLAN-DRAFT.md, 3 phases, 42s duration, no errors
|
||||
LLM reads PLAN-DRAFT.md, evaluates quality
|
||||
LLM decides: "Yes, approve - phases are well-scoped and realistic"
|
||||
```
|
||||
|
||||
### 2. Post-Step Evaluation
|
||||
|
||||
**What:** After each step completes, the bot evaluates quality using step-specific criteria.
|
||||
|
||||
**How it works:**
|
||||
- Collects complete execution observations
|
||||
- Queries LLM with evaluation criteria for the step
|
||||
- LLM inspects final artifacts
|
||||
- Returns structured evaluation (score, strengths, weaknesses, suggestions)
|
||||
- Writes `specs/<feature>/BOT-EVALUATION.md` and `specs/<feature>/BOT-NOTES.md` (falls back to project root if no spec folder exists yet, e.g. during `init`)
|
||||
|
||||
**Example output:**
|
||||
```markdown
|
||||
# Evaluation: plan Step
|
||||
|
||||
**Score:** 78/100
|
||||
|
||||
## Strengths
|
||||
- Clear phase breakdown with realistic scope
|
||||
- Tech stack choices appropriate
|
||||
|
||||
## Weaknesses
|
||||
- Phase 3 description too vague
|
||||
- No testing strategy mentioned
|
||||
|
||||
## Suggestions
|
||||
- Expand Phase 3 with concrete tasks
|
||||
- Add explicit testing phase
|
||||
```
|
||||
|
||||
### 3. Quality Gate
|
||||
|
||||
**What:** Before finalize, checks that average quality score is acceptable.
|
||||
|
||||
**How it works:**
|
||||
- Calculates average score across all evaluated steps
|
||||
- If average < 60, blocks finalization
|
||||
- Displays clear message about quality issues
|
||||
- User must review `specs/<feature>/BOT-EVALUATION.md` and fix problems
|
||||
|
||||
## Files Created
|
||||
|
||||
### New Files
|
||||
|
||||
1. **`src/observation-collector.ts`**
|
||||
- Tracks execution details (tools, files, messages, errors, questions)
|
||||
- Provides snapshots for real-time decisions
|
||||
- Captures complete history for evaluation
|
||||
|
||||
2. **`src/intelligent-responder.ts`**
|
||||
- Replaces hardcoded auto-responder
|
||||
- Uses LLM to answer AskUserQuestion prompts
|
||||
- Provides reasoning for all decisions
|
||||
- Falls back gracefully if LLM unavailable
|
||||
|
||||
3. **`src/prompts/evaluation-criteria.ts`**
|
||||
- Step-specific evaluation criteria (init, plan, document, implement, finalize)
|
||||
- Quality checks, common pitfalls, scoring guidance
|
||||
- Emphasizes honest scoring (most work should score 70-85)
|
||||
|
||||
4. **`src/evaluator.ts`**
|
||||
- Post-step evaluation using LLM-as-judge
|
||||
- Queries LLM with observations and criteria
|
||||
- Parses structured evaluation output
|
||||
- Writes `specs/<feature>/BOT-EVALUATION.md` and `specs/<feature>/BOT-NOTES.md`
|
||||
|
||||
### Modified Files
|
||||
|
||||
1. **`src/types.ts`**
|
||||
- Added interfaces: `ToolObservation`, `QuestionContext`, `ExecutionObservation`, `EvaluationResult`
|
||||
- Extended `StepResult` with `evaluation` and `observations` fields
|
||||
|
||||
2. **`src/session-runner.ts`**
|
||||
- Added `collector` parameter to `SessionOptions`
|
||||
- Returns `observations` in `SessionResult`
|
||||
- Records all messages for observation tracking
|
||||
- Uses intelligent responder instead of auto-responder
|
||||
|
||||
3. **`src/cli.ts`**
|
||||
- Creates `ObservationCollector` for each step
|
||||
- Always runs evaluation after successful steps
|
||||
- Displays scores with color coding (green/yellow/red)
|
||||
- Implements quality gate before finalize
|
||||
- Shows evaluation summary in step output
|
||||
|
||||
4. **`src/bin/plan2code-bot.ts`**
|
||||
- Updated help text to mention LLM-as-judge evaluation
|
||||
- No new CLI flags (evaluation is always on)
|
||||
|
||||
### Deleted Files
|
||||
|
||||
1. **`src/auto-responder.ts`** - Replaced by intelligent-responder.ts
|
||||
2. **`src/auto-responder.test.ts`** - No longer needed
|
||||
|
||||
## Output Files (Created During Execution)
|
||||
|
||||
Both files are written to `specs/<feature>/` so they stay co-located with the feature they describe. If no spec folder exists yet (e.g. during `init`), they fall back to the project root.
|
||||
|
||||
### BOT-EVALUATION.md
|
||||
|
||||
Contains evaluation results for each step:
|
||||
- Score (0-100)
|
||||
- Strengths identified
|
||||
- Weaknesses found
|
||||
- Suggestions for improvement
|
||||
- Critical issues (if any)
|
||||
- Full reasoning from LLM
|
||||
|
||||
### BOT-NOTES.md
|
||||
|
||||
Contains execution observations:
|
||||
- Duration, tool counts, file changes
|
||||
- Questions asked and LLM reasoning for answers
|
||||
- Tool usage timeline
|
||||
- Files created/modified
|
||||
- Assistant output summary
|
||||
|
||||
## Data Structure for Metrics
|
||||
|
||||
All evaluation data is structured in `StepResult`:
|
||||
|
||||
```typescript
|
||||
{
|
||||
step: 'plan',
|
||||
success: true,
|
||||
duration: 42000,
|
||||
evaluation: {
|
||||
score: 78,
|
||||
strengths: ["Clear phases", "Realistic scope"],
|
||||
weaknesses: ["Phase 3 too vague"],
|
||||
suggestions: ["Add specific tasks to Phase 3"],
|
||||
criticalIssues: [],
|
||||
reasoning: "...",
|
||||
timestamp: 1234567890,
|
||||
evaluatorModel: 'claude-sonnet-4-5'
|
||||
},
|
||||
observations: {
|
||||
tools: [{ toolName, input, output, timestamp }, ...],
|
||||
questionsAsked: [
|
||||
{
|
||||
question: "Approve plan?",
|
||||
selectedAnswer: "Yes, approve",
|
||||
llmReasoning: "Phases are well-scoped...",
|
||||
timestamp: 1234567890
|
||||
}
|
||||
],
|
||||
filesCreated: [...],
|
||||
filesModified: [...],
|
||||
errors: []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Benefits for Recursive Improvement
|
||||
|
||||
1. **Authentic Signals:** Real quality scores identify actual problem areas
|
||||
2. **Detailed Context:** Observations + reasoning explain WHY failures happen
|
||||
3. **Correlation Analysis:** Link patterns (tool usage, duration, errors) to quality
|
||||
4. **Continuous Loop:** Better metrics → improved workflows → higher scores → repeat
|
||||
|
||||
## Usage
|
||||
|
||||
No special flags needed - evaluation is always on:
|
||||
|
||||
```bash
|
||||
# New project
|
||||
plan2code-bot --idea "todo app"
|
||||
|
||||
# Enhancement
|
||||
cd my-project && plan2code-bot
|
||||
|
||||
# Resume with evaluation data preserved
|
||||
plan2code-bot --resume
|
||||
```
|
||||
|
||||
## Verification
|
||||
|
||||
After running the bot, check:
|
||||
|
||||
1. **`specs/<feature>/BOT-EVALUATION.md`** - Should show realistic scores (not all 100s)
|
||||
2. **`specs/<feature>/BOT-NOTES.md`** - Should show LLM reasoning for decisions
|
||||
3. **Console output** - Should display color-coded scores after each step
|
||||
4. **State file** (`.plan2code-bot-state.json`) - Should include evaluation data
|
||||
|
||||
## Trade-offs
|
||||
|
||||
### Latency
|
||||
- Adds ~2-3s per AskUserQuestion call (~15-20s total per run)
|
||||
- Worth it for authentic evaluation
|
||||
|
||||
### Token Cost
|
||||
- ~20-26K tokens per run (~$0.60 with Opus 4.6)
|
||||
- Investment pays off through metrics-driven improvement
|
||||
|
||||
### Determinism
|
||||
- LLM decisions vary between runs (non-deterministic)
|
||||
- Realistic - humans vary too
|
||||
- Metrics average over many runs
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
Potential improvements:
|
||||
- Model selection per step (use Haiku for simple decisions)
|
||||
- Configurable quality gate threshold
|
||||
- Historical score tracking across runs
|
||||
- Comparison with previous evaluations
|
||||
- More sophisticated scoring (weighted by step importance)
|
||||
@@ -0,0 +1,111 @@
|
||||
# plan2code-bot
|
||||
|
||||
Autonomous workflow test runner for plan2code. Uses the Claude Agent SDK to simulate a human running through the entire plan2code workflow (init, plan, document, implement, finalize) end-to-end.
|
||||
|
||||
## Two Modes (Auto-Detected)
|
||||
|
||||
1. **New Project Mode** — No `AGENTS.md` in cwd: generates an app idea, creates a subdirectory, writes IDEA.md, runs init, then all 4 steps.
|
||||
2. **Enhancement Mode** — `AGENTS.md` exists in cwd: scans the existing codebase and proposes a realistic enhancement, writes IDEA.md, then runs plan through finalize.
|
||||
|
||||
## Installation
|
||||
|
||||
From the plan2code root:
|
||||
|
||||
```bash
|
||||
node install.js
|
||||
# Select C > B to install bot only, or I to install everything
|
||||
```
|
||||
|
||||
Or manually:
|
||||
|
||||
```bash
|
||||
cd plan2code-bot
|
||||
npm install
|
||||
npm run build
|
||||
npm link
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# New project mode (run from an empty directory)
|
||||
mkdir /tmp/test-bot && cd /tmp/test-bot
|
||||
plan2code-bot
|
||||
|
||||
# Enhancement mode (run from an existing project with AGENTS.md)
|
||||
cd my-project
|
||||
plan2code-bot
|
||||
|
||||
# Seed the idea generator with a specific concept
|
||||
plan2code-bot --idea "web app that displays the current weather as vector images"
|
||||
|
||||
# Resume a previous incomplete run
|
||||
plan2code-bot --resume
|
||||
```
|
||||
|
||||
### `--idea`
|
||||
|
||||
Pass a quoted string after `--idea` to seed the idea generator with a specific concept. The AI will use it as inspiration rather than generating a completely random idea. Wrap the value in double quotes so the shell treats it as a single argument.
|
||||
|
||||
```bash
|
||||
# Specific app concept
|
||||
plan2code-bot --idea "web app that displays the current weather as vector images"
|
||||
|
||||
# Short keyword to nudge the category
|
||||
plan2code-bot --idea "markdown editor"
|
||||
|
||||
# Detailed constraint
|
||||
plan2code-bot --idea "CLI tool that converts CSV files to SQLite databases with type inference"
|
||||
|
||||
# Works in enhancement mode too — guides what kind of enhancement to propose
|
||||
cd my-existing-project
|
||||
plan2code-bot --idea "add dark mode support"
|
||||
```
|
||||
|
||||
Without `--idea`, the bot picks a random category (CLI tool or web app) and invents something on its own.
|
||||
|
||||
### `--resume`
|
||||
|
||||
Resume a previous incomplete run. The bot searches for a `.plan2code-bot-state.json` file in the current directory (enhancement mode) or in immediate subdirectories (new-project mode). If found, it restores the idea, config, and progress — skipping steps that already succeeded and continuing from where it left off.
|
||||
|
||||
```bash
|
||||
# A run failed at the implement step — resume it
|
||||
plan2code-bot --resume
|
||||
|
||||
# Can combine with --idea (idea is ignored when resuming since it's restored from state)
|
||||
plan2code-bot --resume --idea "ignored when state exists"
|
||||
```
|
||||
|
||||
If no state file is found, the bot starts a fresh run.
|
||||
|
||||
## How It Works
|
||||
|
||||
1. Detects mode based on presence of `AGENTS.md`
|
||||
2. Generates an idea (new app or enhancement) via Claude, optionally guided by `--idea` seed
|
||||
3. Writes `IDEA.md` to the project directory
|
||||
4. Installs bot-friendly copies of plan2code skills (strips `disable-model-invocation` so sessions can invoke them)
|
||||
5. Runs each workflow step as a separate Claude Agent SDK session:
|
||||
- **init** — generates `AGENTS.md` (new-project mode only)
|
||||
- **plan** — creates plan draft in `specs/<feature>/`
|
||||
- **document** — produces `overview.md` and `phase-*.md` files
|
||||
- **implement** — loops until all phases are complete (max 10 passes)
|
||||
- **finalize** — validates and archives to `specs--completed/`
|
||||
6. Validates expected artifacts after each step (aborts on missing artifacts)
|
||||
7. Moves `IDEA.md` into `specs/<feature>/` after the plan step so it stays with its feature
|
||||
8. Auto-responds to `AskUserQuestion` prompts (approvals, testing gates, name questions)
|
||||
9. Saves state to `.plan2code-bot-state.json` after each step
|
||||
|
||||
## State File
|
||||
|
||||
After each step, the bot saves its state to `.plan2code-bot-state.json` in the project directory. This includes the config, all step results, and progress tracking.
|
||||
|
||||
- **On full success** — the state file is automatically deleted (clean finish)
|
||||
- **On failure/incomplete** — the state file is preserved so you can `--resume` later
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm run build # Build with tsup
|
||||
npm run dev # Watch mode
|
||||
npm test # Run tests (vitest)
|
||||
```
|
||||
@@ -0,0 +1,36 @@
|
||||
{
|
||||
"name": "plan2code-bot",
|
||||
"version": "1.1.0",
|
||||
"description": "Plan2Code Bot - Autonomous workflow runner for testing plan2code end-to-end",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"plan2code-bot": "./dist/bin/plan2code-bot.js"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"dev": "tsup --watch",
|
||||
"start": "node dist/bin/plan2code-bot.js",
|
||||
"test": "vitest run",
|
||||
"prepublishOnly": "npm run build"
|
||||
},
|
||||
"dependencies": {
|
||||
"@anthropic-ai/claude-agent-sdk": "^0.2.63",
|
||||
"chalk": "^5.6.2",
|
||||
"fs-extra": "^11.3.3",
|
||||
"ora": "^9.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/node": "^25.0.3",
|
||||
"tsup": "^8.5.1",
|
||||
"typescript": "^5.9.3",
|
||||
"vitest": "^4.0.18"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,116 @@
|
||||
import { runCLI } from '../cli.js';
|
||||
|
||||
function showHelp(): void {
|
||||
console.log(`
|
||||
+----------------------------------------------------------------+
|
||||
— PLAN2CODEDE-BOT —
|
||||
—----------------------------------------------------------------—
|
||||
— Autonomous workflow test runner foplan2codede —
|
||||
— Features LLM-as-judge for honest quality evaluation —
|
||||
+----------------------------------------------------------------+
|
||||
|
||||
Usage:
|
||||
plan2code-bot [options]
|
||||
|
||||
Options:
|
||||
--help Show this help message
|
||||
--idea <string> Seed the idea generator with a specific concept
|
||||
Example: --idea "web app for weather"
|
||||
Example: --idea="CLI tool for CSV conversion"
|
||||
--resume Resume a previous incomplete run
|
||||
|
||||
Modes:
|
||||
— New Project Mode - Run from empty directory
|
||||
The bot generates an app idea, creates a subdirectory, writes
|
||||
IDEA.md, runs init, then all 4 workflow steps.
|
||||
|
||||
— Enhancement Mode - Run from directory with AGENTS.md
|
||||
The bot scans the existing codebase, proposes an enhancement,
|
||||
writes IDEA.md, then runs plan through finalize.
|
||||
|
||||
Evaluation:
|
||||
The bot acts as an authentic QA agent, using LLM-based decision
|
||||
making during execution and providing honest quality assessments
|
||||
after each step. Results are written to specs/<feature>/BOT-EVALUATION.md
|
||||
and specs/<feature>/BOT-NOTES.md for metrics analysis.
|
||||
|
||||
Examples:
|
||||
# New project (from empty directory)
|
||||
plan2code-bot
|
||||
|
||||
# Enhancement (from existing project)
|
||||
cd my-project && plan2code-bot
|
||||
|
||||
# With specific idea
|
||||
plan2code-bot --idea "markdown editor with live preview"
|
||||
|
||||
# Resume incomplete run
|
||||
plan2code-bot --resume
|
||||
|
||||
Documentation:
|
||||
https://jparkerweb.github.io/plan2code
|
||||
`);
|
||||
}
|
||||
|
||||
function stripQuotes(str: string): string {
|
||||
// Remove surrounding quotes if present (both single and double)
|
||||
if ((str.startsWith('"') && str.endsWith('"')) ||
|
||||
(str.startsWith("'") && str.endsWith("'"))) {
|
||||
return str.slice(1, -1);
|
||||
}
|
||||
return str;
|
||||
}
|
||||
|
||||
function parseArgs(): { idea?: string; resume?: boolean; help?: boolean } {
|
||||
const args = process.argv.slice(2);
|
||||
|
||||
// Check for --help
|
||||
if (args.includes('--help') || args.includes('-h')) {
|
||||
return { help: true };
|
||||
}
|
||||
|
||||
// Parse --idea (supports both --idea="value" and --idea "value")
|
||||
let idea: string | undefined;
|
||||
for (let i = 0; i < args.length; i++) {
|
||||
const arg = args[i];
|
||||
|
||||
// Format: --idea="value"
|
||||
if (arg.startsWith('--idea=')) {
|
||||
idea = stripQuotes(arg.substring('--idea='.length));
|
||||
break;
|
||||
}
|
||||
|
||||
// Format: --idea "value"
|
||||
if (arg === '--idea' && i + 1 < args.length) {
|
||||
idea = stripQuotes(args[i + 1]);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse --resume
|
||||
const resume = args.includes('--resume');
|
||||
|
||||
return { idea, resume: resume || undefined };
|
||||
}
|
||||
|
||||
async function main() {
|
||||
try {
|
||||
const { idea, resume, help } = parseArgs();
|
||||
|
||||
if (help) {
|
||||
showHelp();
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
await runCLI({ idea, resume });
|
||||
process.exit(0);
|
||||
} catch (err) {
|
||||
if (err instanceof Error && err.message.includes('User force closed')) {
|
||||
process.exit(0);
|
||||
}
|
||||
console.error(err instanceof Error ? err.message : String(err));
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
main();
|
||||
@@ -0,0 +1,121 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'path';
|
||||
import os from 'os';
|
||||
import { saveState, loadState, deleteState, findExistingState } from './bot-state.js';
|
||||
import type { BotState } from './types.js';
|
||||
|
||||
function makeTmpDir(): string {
|
||||
return fs.mkdtempSync(path.join(os.tmpdir(), 'bot-state-test-'));
|
||||
}
|
||||
|
||||
function makeState(projectDir: string): BotState {
|
||||
return {
|
||||
config: {
|
||||
workDir: path.dirname(projectDir),
|
||||
projectDir,
|
||||
ideaName: 'test-idea',
|
||||
ideaDescription: 'A test idea',
|
||||
mode: 'new-project',
|
||||
},
|
||||
steps: [],
|
||||
currentStep: null,
|
||||
implementPasses: 0,
|
||||
allPhasesComplete: false,
|
||||
};
|
||||
}
|
||||
|
||||
describe('bot-state', () => {
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = makeTmpDir();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
fs.removeSync(tmpDir);
|
||||
});
|
||||
|
||||
describe('saveState', () => {
|
||||
it('writes valid JSON', () => {
|
||||
const projectDir = path.join(tmpDir, 'project');
|
||||
fs.ensureDirSync(projectDir);
|
||||
const state = makeState(projectDir);
|
||||
|
||||
saveState(state);
|
||||
|
||||
const filePath = path.join(projectDir, '.plan2code-bot-state.json');
|
||||
expect(fs.existsSync(filePath)).toBe(true);
|
||||
const parsed = fs.readJsonSync(filePath);
|
||||
expect(parsed.config.ideaName).toBe('test-idea');
|
||||
});
|
||||
});
|
||||
|
||||
describe('loadState', () => {
|
||||
it('returns state from file', () => {
|
||||
const projectDir = path.join(tmpDir, 'project');
|
||||
fs.ensureDirSync(projectDir);
|
||||
const state = makeState(projectDir);
|
||||
saveState(state);
|
||||
|
||||
const loaded = loadState(projectDir);
|
||||
expect(loaded).not.toBeNull();
|
||||
expect(loaded!.config.ideaName).toBe('test-idea');
|
||||
expect(loaded!.implementPasses).toBe(0);
|
||||
});
|
||||
|
||||
it('returns null when file does not exist', () => {
|
||||
const result = loadState(path.join(tmpDir, 'nonexistent'));
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('deleteState', () => {
|
||||
it('removes the file', () => {
|
||||
const projectDir = path.join(tmpDir, 'project');
|
||||
fs.ensureDirSync(projectDir);
|
||||
const state = makeState(projectDir);
|
||||
saveState(state);
|
||||
|
||||
const filePath = path.join(projectDir, '.plan2code-bot-state.json');
|
||||
expect(fs.existsSync(filePath)).toBe(true);
|
||||
|
||||
deleteState(projectDir);
|
||||
expect(fs.existsSync(filePath)).toBe(false);
|
||||
});
|
||||
|
||||
it('is a no-op when file does not exist', () => {
|
||||
// Should not throw
|
||||
deleteState(path.join(tmpDir, 'nonexistent'));
|
||||
});
|
||||
});
|
||||
|
||||
describe('findExistingState', () => {
|
||||
it('finds state in workDir (enhancement mode)', () => {
|
||||
const state = makeState(tmpDir);
|
||||
state.config.projectDir = tmpDir;
|
||||
state.config.mode = 'enhancement';
|
||||
saveState(state);
|
||||
|
||||
const found = findExistingState(tmpDir);
|
||||
expect(found).not.toBeNull();
|
||||
expect(found!.config.ideaName).toBe('test-idea');
|
||||
});
|
||||
|
||||
it('finds state in a subdirectory (new-project mode)', () => {
|
||||
const projectDir = path.join(tmpDir, 'my-app');
|
||||
fs.ensureDirSync(projectDir);
|
||||
const state = makeState(projectDir);
|
||||
saveState(state);
|
||||
|
||||
const found = findExistingState(tmpDir);
|
||||
expect(found).not.toBeNull();
|
||||
expect(found!.config.projectDir).toBe(projectDir);
|
||||
});
|
||||
|
||||
it('returns null when no state exists', () => {
|
||||
const found = findExistingState(tmpDir);
|
||||
expect(found).toBeNull();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,48 @@
|
||||
import fs from 'fs-extra';
|
||||
import path from 'path';
|
||||
import type { BotState } from './types.js';
|
||||
|
||||
const STATE_FILE = '.plan2code-bot-state.json';
|
||||
|
||||
export function saveState(state: BotState): void {
|
||||
const filePath = path.join(state.config.projectDir, STATE_FILE);
|
||||
fs.writeJsonSync(filePath, state, { spaces: 2 });
|
||||
}
|
||||
|
||||
export function loadState(projectDir: string): BotState | null {
|
||||
const filePath = path.join(projectDir, STATE_FILE);
|
||||
if (!fs.existsSync(filePath)) {
|
||||
return null;
|
||||
}
|
||||
return fs.readJsonSync(filePath) as BotState;
|
||||
}
|
||||
|
||||
export function deleteState(projectDir: string): void {
|
||||
const filePath = path.join(projectDir, STATE_FILE);
|
||||
if (fs.existsSync(filePath)) {
|
||||
fs.removeSync(filePath);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search for an existing state file in workDir (enhancement mode)
|
||||
* or in immediate subdirectories (new-project mode).
|
||||
*/
|
||||
export function findExistingState(workDir: string): BotState | null {
|
||||
// Enhancement mode: state is in workDir directly
|
||||
const direct = loadState(workDir);
|
||||
if (direct) return direct;
|
||||
|
||||
// New-project mode: state is in a subdirectory
|
||||
try {
|
||||
for (const entry of fs.readdirSync(workDir, { withFileTypes: true })) {
|
||||
if (entry.isDirectory()) {
|
||||
const sub = loadState(path.join(workDir, entry.name));
|
||||
if (sub) return sub;
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// workDir not readable — ignore
|
||||
}
|
||||
return null;
|
||||
}
|
||||
@@ -0,0 +1,195 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import fs from 'fs-extra';
|
||||
import os from 'os';
|
||||
import path from 'path';
|
||||
import { validateStepArtifacts, installSkillsForBot } from './cli.js';
|
||||
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'p2c-cli-test-'));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
fs.removeSync(tmpDir);
|
||||
});
|
||||
|
||||
// ── validateStepArtifacts ───────────────────────────────────────────
|
||||
|
||||
describe('validateStepArtifacts', () => {
|
||||
describe('init', () => {
|
||||
it('valid when AGENTS.md exists', () => {
|
||||
fs.writeFileSync(path.join(tmpDir, 'AGENTS.md'), '# Agents');
|
||||
const result = validateStepArtifacts('init', tmpDir);
|
||||
expect(result.valid).toBe(true);
|
||||
expect(result.missing).toEqual([]);
|
||||
});
|
||||
|
||||
it('missing when AGENTS.md does not exist', () => {
|
||||
const result = validateStepArtifacts('init', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('AGENTS.md');
|
||||
});
|
||||
});
|
||||
|
||||
describe('plan', () => {
|
||||
it('valid when specs/feature/PLAN-DRAFT-*.md exists', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(path.join(specDir, 'PLAN-DRAFT-v1.md'), '# Plan');
|
||||
const result = validateStepArtifacts('plan', tmpDir);
|
||||
expect(result.valid).toBe(true);
|
||||
});
|
||||
|
||||
it('missing when specs/ is absent', () => {
|
||||
const result = validateStepArtifacts('plan', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('specs/ directory');
|
||||
});
|
||||
|
||||
it('missing when specs/ has dirs but no plan draft files', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(path.join(specDir, 'notes.md'), '# Notes');
|
||||
const result = validateStepArtifacts('plan', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('specs/*/PLAN-DRAFT-*.md');
|
||||
});
|
||||
});
|
||||
|
||||
describe('document', () => {
|
||||
it('valid when overview.md and phase-*.md exist', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(path.join(specDir, 'overview.md'), '# Overview');
|
||||
fs.writeFileSync(path.join(specDir, 'phase-1.md'), '# Phase 1');
|
||||
const result = validateStepArtifacts('document', tmpDir);
|
||||
expect(result.valid).toBe(true);
|
||||
});
|
||||
|
||||
it('missing overview.md when absent', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(path.join(specDir, 'phase-1.md'), '# Phase 1');
|
||||
const result = validateStepArtifacts('document', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('specs/*/overview.md');
|
||||
});
|
||||
|
||||
it('missing phase files when absent', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(path.join(specDir, 'overview.md'), '# Overview');
|
||||
const result = validateStepArtifacts('document', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('specs/*/phase-*.md files');
|
||||
});
|
||||
|
||||
it('accepts phase files inside phases/ subdirectory', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
const phasesDir = path.join(specDir, 'phases');
|
||||
fs.ensureDirSync(phasesDir);
|
||||
fs.writeFileSync(path.join(specDir, 'overview.md'), '# Overview');
|
||||
fs.writeFileSync(path.join(phasesDir, 'phase-1.md'), '# Phase 1');
|
||||
const result = validateStepArtifacts('document', tmpDir);
|
||||
expect(result.valid).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('finalize', () => {
|
||||
it('valid when specs--completed/ has a subdirectory', () => {
|
||||
fs.ensureDirSync(path.join(tmpDir, 'specs--completed', 'my-feature'));
|
||||
const result = validateStepArtifacts('finalize', tmpDir);
|
||||
expect(result.valid).toBe(true);
|
||||
});
|
||||
|
||||
it('missing when specs--completed/ is absent', () => {
|
||||
const result = validateStepArtifacts('finalize', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('specs--completed/ directory');
|
||||
});
|
||||
|
||||
it('missing when specs--completed/ is empty', () => {
|
||||
fs.ensureDirSync(path.join(tmpDir, 'specs--completed'));
|
||||
const result = validateStepArtifacts('finalize', tmpDir);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.missing).toContain('archived spec in specs--completed/');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// ── installSkillsForBot ─────────────────────────────────────────────
|
||||
|
||||
describe('installSkillsForBot', () => {
|
||||
let fakeHome: string;
|
||||
let projectDir: string;
|
||||
let origHome: string | undefined;
|
||||
let origUserProfile: string | undefined;
|
||||
|
||||
beforeEach(() => {
|
||||
fakeHome = fs.mkdtempSync(path.join(os.tmpdir(), 'p2c-home-'));
|
||||
projectDir = fs.mkdtempSync(path.join(os.tmpdir(), 'p2c-proj-'));
|
||||
origHome = process.env.HOME;
|
||||
origUserProfile = process.env.USERPROFILE;
|
||||
process.env.HOME = fakeHome;
|
||||
process.env.USERPROFILE = fakeHome;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
process.env.HOME = origHome;
|
||||
process.env.USERPROFILE = origUserProfile;
|
||||
fs.removeSync(fakeHome);
|
||||
fs.removeSync(projectDir);
|
||||
});
|
||||
|
||||
it('copies skills from user dir to project .claude/skills/', () => {
|
||||
const srcDir = path.join(fakeHome, '.claude', 'skills', 'plan2code-init');
|
||||
fs.ensureDirSync(srcDir);
|
||||
fs.writeFileSync(path.join(srcDir, 'SKILL.md'), '---\nname: init\n---\nSome content');
|
||||
|
||||
installSkillsForBot(projectDir);
|
||||
|
||||
const dest = path.join(projectDir, '.claude', 'skills', 'plan2code-init', 'SKILL.md');
|
||||
expect(fs.existsSync(dest)).toBe(true);
|
||||
expect(fs.readFileSync(dest, 'utf-8')).toContain('Some content');
|
||||
});
|
||||
|
||||
it('strips disable-model-invocation: true from copied SKILL.md', () => {
|
||||
const srcDir = path.join(fakeHome, '.claude', 'skills', 'plan2code-1-plan');
|
||||
fs.ensureDirSync(srcDir);
|
||||
fs.writeFileSync(
|
||||
path.join(srcDir, 'SKILL.md'),
|
||||
'disable-model-invocation: true\n---\nname: plan\n---\nPlan content',
|
||||
);
|
||||
|
||||
installSkillsForBot(projectDir);
|
||||
|
||||
const dest = path.join(projectDir, '.claude', 'skills', 'plan2code-1-plan', 'SKILL.md');
|
||||
const content = fs.readFileSync(dest, 'utf-8');
|
||||
expect(content).not.toContain('disable-model-invocation');
|
||||
expect(content).toContain('Plan content');
|
||||
});
|
||||
|
||||
it('preserves rest of skill content', () => {
|
||||
const srcDir = path.join(fakeHome, '.claude', 'skills', 'plan2code-2-document');
|
||||
fs.ensureDirSync(srcDir);
|
||||
const original = 'disable-model-invocation: true\n---\nname: doc\n---\nLine 1\nLine 2\nLine 3';
|
||||
fs.writeFileSync(path.join(srcDir, 'SKILL.md'), original);
|
||||
|
||||
installSkillsForBot(projectDir);
|
||||
|
||||
const dest = path.join(projectDir, '.claude', 'skills', 'plan2code-2-document', 'SKILL.md');
|
||||
const content = fs.readFileSync(dest, 'utf-8');
|
||||
expect(content).toContain('Line 1');
|
||||
expect(content).toContain('Line 2');
|
||||
expect(content).toContain('Line 3');
|
||||
expect(content).toContain('name: doc');
|
||||
});
|
||||
|
||||
it('skips gracefully when source skill does not exist', () => {
|
||||
// No skills in fakeHome — should not throw
|
||||
expect(() => installSkillsForBot(projectDir)).not.toThrow();
|
||||
// No .claude/skills/ created in project
|
||||
expect(fs.existsSync(path.join(projectDir, '.claude', 'skills'))).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,587 @@
|
||||
import fs from 'fs-extra';
|
||||
import path from 'path';
|
||||
import chalk from 'chalk';
|
||||
import ora from 'ora';
|
||||
import { generateNewAppIdea, generateEnhancementIdea } from './idea-generator.js';
|
||||
import { runSession } from './session-runner.js';
|
||||
import { buildStepPrompt } from './prompts/step-instructions.js';
|
||||
import { checkAllPhasesComplete } from './step-detector.js';
|
||||
import { saveState, loadState, deleteState, findExistingState } from './bot-state.js';
|
||||
import { ObservationCollector } from './observation-collector.js';
|
||||
import { evaluateStep } from './evaluator.js';
|
||||
import type { BotConfig, BotMode, BotState, StepName, StepResult } from './types.js';
|
||||
|
||||
const BANNER = `
|
||||
╔══════════════════════════════════════╗
|
||||
║ plan2code-bot v1.1.0 ║
|
||||
║ Autonomous Workflow Test Runner ║
|
||||
╚══════════════════════════════════════╝
|
||||
`;
|
||||
|
||||
const MAX_IMPLEMENT_PASSES = 10;
|
||||
|
||||
/** Skill name mapping: bot step name → installed skill directory name */
|
||||
const SKILL_MAP: Record<StepName, string> = {
|
||||
init: 'plan2code-init',
|
||||
plan: 'plan2code-1-plan',
|
||||
document: 'plan2code-2-document',
|
||||
implement: 'plan2code-3-implement',
|
||||
finalize: 'plan2code-4-finalize',
|
||||
};
|
||||
|
||||
/**
|
||||
* Install bot-friendly copies of plan2code skills into the project's .claude/skills/.
|
||||
* The global skills have `disable-model-invocation: true` which prevents the autonomous
|
||||
* session from invoking them via the Skill tool. We copy them with that flag removed
|
||||
* so the session can invoke the real workflow prompts instead of guessing.
|
||||
*/
|
||||
export function installSkillsForBot(projectDir: string): void {
|
||||
const userSkillsDir = path.join(
|
||||
process.env.HOME || process.env.USERPROFILE || '',
|
||||
'.claude',
|
||||
'skills',
|
||||
);
|
||||
const projectSkillsDir = path.join(projectDir, '.claude', 'skills');
|
||||
|
||||
for (const skillName of Object.values(SKILL_MAP)) {
|
||||
const srcFile = path.join(userSkillsDir, skillName, 'SKILL.md');
|
||||
if (!fs.existsSync(srcFile)) continue;
|
||||
|
||||
const content = fs.readFileSync(srcFile, 'utf-8');
|
||||
// Remove the disable-model-invocation line so the bot session can invoke the skill
|
||||
const patched = content.replace(/^disable-model-invocation:\s*true\n?/m, '');
|
||||
|
||||
const destDir = path.join(projectSkillsDir, skillName);
|
||||
fs.ensureDirSync(destDir);
|
||||
fs.writeFileSync(path.join(destDir, 'SKILL.md'), patched);
|
||||
}
|
||||
}
|
||||
|
||||
export function validateStepArtifacts(step: StepName, projectDir: string): { valid: boolean; missing: string[] } {
|
||||
const missing: string[] = [];
|
||||
|
||||
switch (step) {
|
||||
case 'init': {
|
||||
const agentsPath = path.join(projectDir, 'AGENTS.md');
|
||||
if (!fs.existsSync(agentsPath)) missing.push('AGENTS.md');
|
||||
break;
|
||||
}
|
||||
case 'plan': {
|
||||
const specsDir = path.join(projectDir, 'specs');
|
||||
if (!fs.existsSync(specsDir)) {
|
||||
missing.push('specs/ directory');
|
||||
} else {
|
||||
const entries = fs.readdirSync(specsDir, { withFileTypes: true });
|
||||
const specDirs = entries.filter((e) => e.isDirectory());
|
||||
const hasPlanDraft = specDirs.some((d) => {
|
||||
const files = fs.readdirSync(path.join(specsDir, d.name));
|
||||
return files.some((f) => /plan[-_]?draft/i.test(f));
|
||||
});
|
||||
if (!hasPlanDraft) missing.push('specs/*/PLAN-DRAFT-*.md');
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'document': {
|
||||
const specsDir = path.join(projectDir, 'specs');
|
||||
if (!fs.existsSync(specsDir)) {
|
||||
missing.push('specs/ directory');
|
||||
} else {
|
||||
const entries = fs.readdirSync(specsDir, { withFileTypes: true });
|
||||
const specDirs = entries.filter((e) => e.isDirectory());
|
||||
let foundOverview = false;
|
||||
let foundPhaseFile = false;
|
||||
for (const d of specDirs) {
|
||||
const specPath = path.join(specsDir, d.name);
|
||||
const files = fs.readdirSync(specPath);
|
||||
if (files.some((f) => f === 'overview.md')) foundOverview = true;
|
||||
if (files.some((f) => /^phase[-_]?\d+.*\.md$/i.test(f))) foundPhaseFile = true;
|
||||
// Also check phases/ subdirectory
|
||||
const phasesSubdir = path.join(specPath, 'phases');
|
||||
if (fs.existsSync(phasesSubdir)) {
|
||||
const subFiles = fs.readdirSync(phasesSubdir);
|
||||
if (subFiles.some((f) => /phase/i.test(f))) foundPhaseFile = true;
|
||||
}
|
||||
}
|
||||
if (!foundOverview) missing.push('specs/*/overview.md');
|
||||
if (!foundPhaseFile) missing.push('specs/*/phase-*.md files');
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'finalize': {
|
||||
const completedDir = path.join(projectDir, 'specs--completed');
|
||||
if (!fs.existsSync(completedDir)) {
|
||||
missing.push('specs--completed/ directory');
|
||||
} else {
|
||||
const entries = fs.readdirSync(completedDir, { withFileTypes: true });
|
||||
const specDirs = entries.filter((e) => e.isDirectory());
|
||||
if (specDirs.length === 0) missing.push('archived spec in specs--completed/');
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return { valid: missing.length === 0, missing };
|
||||
}
|
||||
|
||||
function detectMode(workDir: string): BotMode {
|
||||
const agentsPath = path.join(workDir, 'AGENTS.md');
|
||||
return fs.existsSync(agentsPath) ? 'enhancement' : 'new-project';
|
||||
}
|
||||
|
||||
function formatDuration(ms: number): string {
|
||||
const seconds = Math.floor(ms / 1000);
|
||||
const minutes = Math.floor(seconds / 60);
|
||||
const remainingSeconds = seconds % 60;
|
||||
if (minutes > 0) {
|
||||
return `${minutes}m ${remainingSeconds}s`;
|
||||
}
|
||||
return `${seconds}s`;
|
||||
}
|
||||
|
||||
async function runStep(
|
||||
step: StepName,
|
||||
config: BotConfig,
|
||||
state: BotState,
|
||||
): Promise<StepResult> {
|
||||
const spinner = ora({
|
||||
text: chalk.cyan(`Running ${step} step...`),
|
||||
spinner: 'dots',
|
||||
}).start();
|
||||
|
||||
const prompt = buildStepPrompt(step, config);
|
||||
|
||||
try {
|
||||
// Create observation collector
|
||||
const collector = new ObservationCollector(step);
|
||||
|
||||
const result = await runSession({
|
||||
prompt,
|
||||
config,
|
||||
step,
|
||||
maxTurns: step === 'implement' ? 80 : 50,
|
||||
collector,
|
||||
});
|
||||
|
||||
if (result.success) {
|
||||
spinner.succeed(
|
||||
chalk.green(`${step} completed in ${formatDuration(result.duration)}`)
|
||||
);
|
||||
|
||||
// Run evaluation
|
||||
spinner.text = chalk.cyan('Evaluating step quality...');
|
||||
spinner.start();
|
||||
|
||||
const evaluation = await evaluateStep(step, result.observations, config.projectDir);
|
||||
|
||||
spinner.succeed(
|
||||
chalk.cyan(`Evaluation complete: ${formatScore(evaluation.score)}`)
|
||||
);
|
||||
|
||||
// Display evaluation summary
|
||||
console.log(chalk.dim(` Score: ${formatScore(evaluation.score)}`));
|
||||
if (evaluation.strengths.length > 0) {
|
||||
console.log(chalk.green(` ✓ ${evaluation.strengths[0]}`));
|
||||
}
|
||||
if (evaluation.weaknesses.length > 0) {
|
||||
console.log(chalk.yellow(` ⚠ ${evaluation.weaknesses[0]}`));
|
||||
}
|
||||
|
||||
const stepResult: StepResult = {
|
||||
step,
|
||||
success: result.success,
|
||||
sessionId: result.sessionId,
|
||||
duration: result.duration,
|
||||
error: null,
|
||||
evaluation,
|
||||
observations: result.observations,
|
||||
};
|
||||
|
||||
return stepResult;
|
||||
} else {
|
||||
spinner.fail(chalk.red(`${step} failed after ${formatDuration(result.duration)}`));
|
||||
|
||||
return {
|
||||
step,
|
||||
success: false,
|
||||
sessionId: result.sessionId,
|
||||
duration: result.duration,
|
||||
error: 'Session failed',
|
||||
observations: result.observations,
|
||||
};
|
||||
}
|
||||
} catch (error) {
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
spinner.fail(chalk.red(`${step} error: ${errorMsg}`));
|
||||
return {
|
||||
step,
|
||||
success: false,
|
||||
sessionId: null,
|
||||
duration: 0,
|
||||
error: errorMsg,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
function formatScore(score: number): string {
|
||||
if (score >= 85) return chalk.green(`${score}/100`);
|
||||
if (score >= 70) return chalk.yellow(`${score}/100`);
|
||||
return chalk.red(`${score}/100`);
|
||||
}
|
||||
|
||||
export interface CLIOptions {
|
||||
idea?: string;
|
||||
resume?: boolean;
|
||||
}
|
||||
|
||||
/** Check if a step completed successfully in a saved state */
|
||||
function stepSucceeded(state: BotState, step: StepName): boolean {
|
||||
return state.steps.some((s) => s.step === step && s.success);
|
||||
}
|
||||
|
||||
export async function runCLI(options: CLIOptions = {}): Promise<void> {
|
||||
console.log(chalk.cyan(BANNER));
|
||||
|
||||
const workDir = process.cwd();
|
||||
|
||||
// Check for resumable state
|
||||
let resuming = false;
|
||||
let savedState: BotState | null = null;
|
||||
|
||||
if (options.resume) {
|
||||
savedState = findExistingState(workDir);
|
||||
if (savedState) {
|
||||
resuming = true;
|
||||
console.log(chalk.yellow('Resuming previous incomplete run...'));
|
||||
} else {
|
||||
console.log(chalk.dim('No previous state found, starting fresh.'));
|
||||
}
|
||||
}
|
||||
|
||||
const mode = resuming ? savedState!.config.mode : detectMode(workDir);
|
||||
|
||||
console.log(chalk.dim(`Working directory: ${workDir}`));
|
||||
console.log(chalk.dim(`Mode: ${mode === 'new-project' ? 'New Project' : 'Enhancement'}`));
|
||||
if (options.idea) {
|
||||
console.log(chalk.dim(`Idea seed: ${options.idea}`));
|
||||
}
|
||||
console.log('');
|
||||
|
||||
let ideaName: string;
|
||||
let ideaDescription: string;
|
||||
let projectDir: string;
|
||||
|
||||
if (resuming) {
|
||||
// Restore from saved state
|
||||
ideaName = savedState!.config.ideaName;
|
||||
ideaDescription = savedState!.config.ideaDescription;
|
||||
projectDir = savedState!.config.projectDir;
|
||||
console.log(chalk.green(`Restored idea: ${ideaName}`));
|
||||
console.log(chalk.dim(` ${ideaDescription}`));
|
||||
console.log('');
|
||||
} else {
|
||||
// Step 1: Generate idea
|
||||
const ideaSpinner = ora({
|
||||
text: chalk.cyan('Generating idea...'),
|
||||
spinner: 'dots',
|
||||
}).start();
|
||||
|
||||
try {
|
||||
if (mode === 'new-project') {
|
||||
const idea = await generateNewAppIdea(options.idea);
|
||||
ideaName = idea.name;
|
||||
ideaDescription = idea.description;
|
||||
} else {
|
||||
const idea = await generateEnhancementIdea(workDir, options.idea);
|
||||
ideaName = idea.name;
|
||||
ideaDescription = idea.description;
|
||||
}
|
||||
ideaSpinner.succeed(chalk.green(`Idea generated: ${ideaName}`));
|
||||
} catch (error) {
|
||||
ideaSpinner.fail(chalk.red('Failed to generate idea'));
|
||||
throw error;
|
||||
}
|
||||
|
||||
console.log(chalk.dim(` ${ideaDescription}`));
|
||||
console.log('');
|
||||
|
||||
// Determine project directory
|
||||
projectDir = mode === 'new-project'
|
||||
? path.join(workDir, ideaName)
|
||||
: workDir;
|
||||
|
||||
// Create project directory for new projects
|
||||
if (mode === 'new-project') {
|
||||
fs.ensureDirSync(projectDir);
|
||||
}
|
||||
}
|
||||
|
||||
// Install bot-friendly skills (without disable-model-invocation)
|
||||
installSkillsForBot(projectDir);
|
||||
console.log(chalk.dim('Installed plan2code skills for bot sessions'));
|
||||
|
||||
// Write IDEA.md (only if not resuming past plan step, since it gets moved)
|
||||
if (!resuming || !stepSucceeded(savedState!, 'plan')) {
|
||||
const ideaContent = `# ${ideaName}\n\n${ideaDescription}\n`;
|
||||
fs.writeFileSync(path.join(projectDir, 'IDEA.md'), ideaContent);
|
||||
console.log(chalk.dim(`Wrote IDEA.md to ${projectDir}`));
|
||||
}
|
||||
console.log('');
|
||||
|
||||
// Build config
|
||||
const config: BotConfig = {
|
||||
workDir,
|
||||
projectDir,
|
||||
ideaDescription,
|
||||
ideaName,
|
||||
mode,
|
||||
};
|
||||
|
||||
// Initialize or restore state
|
||||
const state: BotState = resuming
|
||||
? { ...savedState!, config }
|
||||
: {
|
||||
config,
|
||||
steps: [],
|
||||
currentStep: null,
|
||||
implementPasses: 0,
|
||||
allPhasesComplete: false,
|
||||
};
|
||||
|
||||
// Step 2: Run init (new project only)
|
||||
if (mode === 'new-project') {
|
||||
if (resuming && stepSucceeded(savedState!, 'init')) {
|
||||
console.log(chalk.dim('--- Init (skipped — previously succeeded) ---'));
|
||||
} else {
|
||||
console.log(chalk.bold('--- Init ---'));
|
||||
state.currentStep = 'init';
|
||||
const initResult = await runStep('init', config, state);
|
||||
state.steps.push(initResult);
|
||||
saveState(state);
|
||||
|
||||
if (!initResult.success) {
|
||||
console.log(chalk.red('\nInit failed. Aborting.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
const initValidation = validateStepArtifacts('init', projectDir);
|
||||
if (!initValidation.valid) {
|
||||
console.log(chalk.yellow(` ⚠ Missing artifacts: ${initValidation.missing.join(', ')}`));
|
||||
initResult.success = false;
|
||||
initResult.error = `Missing artifacts: ${initValidation.missing.join(', ')}`;
|
||||
console.log(chalk.red('\nInit artifacts missing. Aborting.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
}
|
||||
|
||||
// Step 3: Plan
|
||||
if (resuming && stepSucceeded(savedState!, 'plan')) {
|
||||
console.log(chalk.dim('--- Plan (skipped — previously succeeded) ---'));
|
||||
} else {
|
||||
console.log(chalk.bold('--- Plan ---'));
|
||||
state.currentStep = 'plan';
|
||||
const planResult = await runStep('plan', config, state);
|
||||
state.steps.push(planResult);
|
||||
saveState(state);
|
||||
|
||||
if (!planResult.success) {
|
||||
console.log(chalk.red('\nPlan step failed. Aborting.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
const planValidation = validateStepArtifacts('plan', projectDir);
|
||||
if (!planValidation.valid) {
|
||||
console.log(chalk.yellow(` ⚠ Missing artifacts: ${planValidation.missing.join(', ')}`));
|
||||
planResult.success = false;
|
||||
planResult.error = `Missing artifacts: ${planValidation.missing.join(', ')}`;
|
||||
console.log(chalk.red('\nPlan artifacts missing. Aborting.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
|
||||
// Move IDEA.md into the spec directory so it stays with its feature
|
||||
const ideaPath = path.join(projectDir, 'IDEA.md');
|
||||
if (fs.existsSync(ideaPath)) {
|
||||
const specEntries = fs.readdirSync(path.join(projectDir, 'specs'), { withFileTypes: true });
|
||||
const firstSpecDir = specEntries.find((e) => e.isDirectory());
|
||||
if (firstSpecDir) {
|
||||
const dest = path.join(projectDir, 'specs', firstSpecDir.name, 'IDEA.md');
|
||||
fs.moveSync(ideaPath, dest, { overwrite: true });
|
||||
console.log(chalk.dim(`Moved IDEA.md → specs/${firstSpecDir.name}/IDEA.md`));
|
||||
}
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
|
||||
// Step 4: Document
|
||||
if (resuming && stepSucceeded(savedState!, 'document')) {
|
||||
console.log(chalk.dim('--- Document (skipped — previously succeeded) ---'));
|
||||
} else {
|
||||
console.log(chalk.bold('--- Document ---'));
|
||||
state.currentStep = 'document';
|
||||
const docResult = await runStep('document', config, state);
|
||||
state.steps.push(docResult);
|
||||
saveState(state);
|
||||
|
||||
if (!docResult.success) {
|
||||
console.log(chalk.red('\nDocument step failed. Aborting.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
const docValidation = validateStepArtifacts('document', projectDir);
|
||||
if (!docValidation.valid) {
|
||||
console.log(chalk.yellow(` ⚠ Missing artifacts: ${docValidation.missing.join(', ')}`));
|
||||
docResult.success = false;
|
||||
docResult.error = `Missing artifacts: ${docValidation.missing.join(', ')}`;
|
||||
console.log(chalk.red('\nDocument artifacts missing. Aborting.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
|
||||
// Step 5: Implement (loop until all phases complete)
|
||||
if (resuming && savedState!.allPhasesComplete) {
|
||||
console.log(chalk.dim('--- Implement (skipped — all phases already complete) ---'));
|
||||
} else {
|
||||
console.log(chalk.bold('--- Implement ---'));
|
||||
while (state.implementPasses < MAX_IMPLEMENT_PASSES) {
|
||||
state.implementPasses++;
|
||||
state.currentStep = 'implement';
|
||||
|
||||
console.log(chalk.dim(` Pass ${state.implementPasses}/${MAX_IMPLEMENT_PASSES}`));
|
||||
const implResult = await runStep('implement', config, state);
|
||||
state.steps.push(implResult);
|
||||
saveState(state);
|
||||
|
||||
if (!implResult.success) {
|
||||
console.log(chalk.yellow(`\nImplement pass ${state.implementPasses} failed. Continuing...`));
|
||||
}
|
||||
|
||||
// Check if all phases are complete
|
||||
if (checkAllPhasesComplete(projectDir)) {
|
||||
state.allPhasesComplete = true;
|
||||
saveState(state);
|
||||
console.log(chalk.green(' All phases complete!'));
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!state.allPhasesComplete && state.implementPasses >= MAX_IMPLEMENT_PASSES) {
|
||||
console.log(chalk.yellow(`\nMax implement passes (${MAX_IMPLEMENT_PASSES}) reached.`));
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
|
||||
// Step 6: Finalize
|
||||
if (resuming && stepSucceeded(savedState!, 'finalize')) {
|
||||
console.log(chalk.dim('--- Finalize (skipped — previously succeeded) ---'));
|
||||
} else {
|
||||
console.log(chalk.bold('--- Finalize ---'));
|
||||
|
||||
// Check quality gate: average score must be >= 60
|
||||
const evaluatedSteps = state.steps.filter((s) => s.evaluation);
|
||||
if (evaluatedSteps.length > 0) {
|
||||
const avgScore =
|
||||
evaluatedSteps.reduce((sum, s) => sum + (s.evaluation?.score ?? 0), 0) /
|
||||
evaluatedSteps.length;
|
||||
|
||||
console.log(chalk.dim(` Average quality score: ${formatScore(Math.round(avgScore))}`));
|
||||
|
||||
if (avgScore < 60) {
|
||||
console.log(
|
||||
chalk.red(
|
||||
'\n⚠ Quality gate failed: Average score is below 60. Please review and fix issues before finalizing.'
|
||||
)
|
||||
);
|
||||
console.log(chalk.dim(' Check specs/<feature>/BOT-EVALUATION.md for detailed feedback.'));
|
||||
printSummary(state, workDir, false);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
state.currentStep = 'finalize';
|
||||
const finalizeResult = await runStep('finalize', config, state);
|
||||
state.steps.push(finalizeResult);
|
||||
saveState(state);
|
||||
|
||||
if (finalizeResult.success) {
|
||||
const finalValidation = validateStepArtifacts('finalize', projectDir);
|
||||
if (!finalValidation.valid) {
|
||||
console.log(chalk.yellow(` ⚠ Missing artifacts: ${finalValidation.missing.join(', ')}`));
|
||||
finalizeResult.success = false;
|
||||
finalizeResult.error = `Missing artifacts: ${finalValidation.missing.join(', ')}`;
|
||||
saveState(state);
|
||||
}
|
||||
}
|
||||
}
|
||||
console.log('');
|
||||
|
||||
// Determine overall success
|
||||
const allSucceeded = state.steps.length > 0 && state.steps.every((s) => s.success);
|
||||
printSummary(state, workDir, allSucceeded);
|
||||
|
||||
// Clean up state file on full success
|
||||
if (allSucceeded) {
|
||||
deleteState(projectDir);
|
||||
console.log(chalk.dim('Cleaned up state file (run succeeded)'));
|
||||
} else {
|
||||
console.log(chalk.dim('State file preserved for resume (run incomplete)'));
|
||||
}
|
||||
console.log('');
|
||||
}
|
||||
|
||||
function printSummary(state: BotState, workDir: string, allSucceeded: boolean): void {
|
||||
const { ideaName, mode, projectDir } = state.config;
|
||||
|
||||
console.log(chalk.cyan('═══════════════════════════════════════'));
|
||||
console.log(chalk.bold(' Bot Run Summary'));
|
||||
console.log(chalk.cyan('═══════════════════════════════════════'));
|
||||
console.log(chalk.dim(` Project: ${ideaName}`));
|
||||
console.log(chalk.dim(` Mode: ${mode}`));
|
||||
console.log(chalk.dim(` Directory: ${projectDir}`));
|
||||
console.log('');
|
||||
|
||||
const totalDuration = state.steps.reduce((sum, s) => sum + s.duration, 0);
|
||||
const successCount = state.steps.filter((s) => s.success).length;
|
||||
|
||||
for (const step of state.steps) {
|
||||
const icon = step.success ? chalk.green('✓') : chalk.red('✗');
|
||||
const scoreText = step.evaluation
|
||||
? ` [${formatScore(step.evaluation.score)}]`
|
||||
: '';
|
||||
console.log(
|
||||
` ${icon} ${step.step.padEnd(12)} ${formatDuration(step.duration)}${scoreText}`
|
||||
);
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
||||
// Display average quality score if available
|
||||
const evaluatedSteps = state.steps.filter((s) => s.evaluation);
|
||||
if (evaluatedSteps.length > 0) {
|
||||
const avgScore =
|
||||
evaluatedSteps.reduce((sum, s) => sum + (s.evaluation?.score ?? 0), 0) /
|
||||
evaluatedSteps.length;
|
||||
console.log(
|
||||
chalk.dim(` Average quality: ${formatScore(Math.round(avgScore))}`)
|
||||
);
|
||||
}
|
||||
|
||||
console.log(
|
||||
chalk.dim(
|
||||
` Total: ${successCount}/${state.steps.length} steps succeeded in ${formatDuration(totalDuration)}`
|
||||
)
|
||||
);
|
||||
console.log(chalk.dim(` Implement passes: ${state.implementPasses}`));
|
||||
if (!allSucceeded) {
|
||||
console.log(
|
||||
chalk.dim(
|
||||
` State saved to: ${path.relative(workDir, projectDir)}/.plan2code-bot-state.json`
|
||||
)
|
||||
);
|
||||
}
|
||||
console.log('');
|
||||
}
|
||||
@@ -0,0 +1,311 @@
|
||||
import { query } from '@anthropic-ai/claude-agent-sdk';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'path';
|
||||
import type { EvaluationResult, ExecutionObservation, StepName } from './types.js';
|
||||
import { getCriteriaForStep } from './prompts/evaluation-criteria.js';
|
||||
|
||||
/**
|
||||
* Evaluates a completed step using LLM-as-judge.
|
||||
* Returns honest quality assessment based on observations and artifacts.
|
||||
*/
|
||||
export async function evaluateStep(
|
||||
step: StepName,
|
||||
observations: ExecutionObservation,
|
||||
projectDir: string
|
||||
): Promise<EvaluationResult> {
|
||||
const criteria = getCriteriaForStep(step);
|
||||
const prompt = buildEvaluationPrompt(step, observations, criteria, projectDir);
|
||||
|
||||
try {
|
||||
// Query LLM with ability to inspect artifacts
|
||||
const session = query({
|
||||
prompt,
|
||||
options: {
|
||||
maxTurns: 30,
|
||||
cwd: projectDir,
|
||||
permissionMode: 'bypassPermissions',
|
||||
allowDangerouslySkipPermissions: true,
|
||||
allowedTools: ['Read', 'Glob', 'Grep'],
|
||||
systemPrompt:
|
||||
'You are a QA engineer evaluating completed work. Be thorough, honest, and constructive.',
|
||||
},
|
||||
});
|
||||
|
||||
let output = '';
|
||||
for await (const message of session) {
|
||||
if (message.type === 'assistant') {
|
||||
for (const block of message.message.content) {
|
||||
if (block.type === 'text') output += block.text;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const evaluation = parseEvaluationOutput(output, step);
|
||||
|
||||
// Write evaluation files
|
||||
await writeEvaluationFiles(evaluation, observations, projectDir);
|
||||
|
||||
return evaluation;
|
||||
} catch (error) {
|
||||
console.warn('Evaluation failed, using fallback:', error);
|
||||
return createFallbackEvaluation(step, observations);
|
||||
}
|
||||
}
|
||||
|
||||
function buildEvaluationPrompt(
|
||||
step: StepName,
|
||||
observations: ExecutionObservation,
|
||||
criteria: ReturnType<typeof getCriteriaForStep>,
|
||||
projectDir: string
|
||||
): string {
|
||||
const duration = observations.endTime - observations.startTime;
|
||||
const durationSec = Math.floor(duration / 1000);
|
||||
|
||||
const toolsSummary = observations.tools
|
||||
.map((t) => `- ${t.toolName} (${new Date(t.timestamp).toISOString()})`)
|
||||
.join('\n');
|
||||
|
||||
const filesSummary = [
|
||||
...observations.filesCreated.map((f) => `CREATED: ${f}`),
|
||||
...observations.filesModified.map((f) => `MODIFIED: ${f}`),
|
||||
].join('\n');
|
||||
|
||||
const questionsSummary = observations.questionsAsked
|
||||
.map(
|
||||
(q) =>
|
||||
`Q: ${q.question}\nA: ${q.selectedAnswer}\nReasoning: ${q.llmReasoning}`
|
||||
)
|
||||
.join('\n\n');
|
||||
|
||||
return `You are a QA engineer evaluating the quality of a completed workflow step.
|
||||
|
||||
## Step Information
|
||||
- Step: ${step}
|
||||
- Duration: ${durationSec}s
|
||||
- Tools used: ${observations.tools.length}
|
||||
- Files created: ${observations.filesCreated.length}
|
||||
- Files modified: ${observations.filesModified.length}
|
||||
- Errors: ${observations.errors.length}
|
||||
|
||||
## Execution Details
|
||||
|
||||
### Tools Used
|
||||
${toolsSummary || '(none)'}
|
||||
|
||||
### Files Changed
|
||||
${filesSummary || '(none)'}
|
||||
|
||||
${observations.questionsAsked.length > 0 ? `### Questions & Decisions\n${questionsSummary}` : ''}
|
||||
|
||||
${observations.errors.length > 0 ? `### Errors Encountered\n${observations.errors.join('\n')}` : ''}
|
||||
|
||||
## Evaluation Criteria
|
||||
|
||||
**Key Artifacts Expected:**
|
||||
${criteria.keyArtifacts.map((a) => `- ${a}`).join('\n')}
|
||||
|
||||
**Quality Checks:**
|
||||
${criteria.qualityChecks.map((c) => `- ${c}`).join('\n')}
|
||||
|
||||
**Common Pitfalls to Watch For:**
|
||||
${criteria.commonPitfalls.map((p) => `- ${p}`).join('\n')}
|
||||
|
||||
**Scoring Guidance:**
|
||||
${criteria.scoringGuidance}
|
||||
|
||||
## Your Task
|
||||
|
||||
Evaluate this step honestly and thoroughly:
|
||||
|
||||
1. **Inspect the artifacts** using Read, Glob, and Grep tools
|
||||
2. **Check against quality criteria** listed above
|
||||
3. **Identify strengths and weaknesses** based on actual evidence
|
||||
4. **Provide constructive suggestions** for improvement
|
||||
5. **Assign an honest score** (0-100) following the guidance
|
||||
|
||||
Be critical but fair. Most work scores 70-85. Don't inflate scores.
|
||||
|
||||
## Response Format
|
||||
|
||||
SCORE: <number 0-100>
|
||||
|
||||
STRENGTHS:
|
||||
- <strength 1>
|
||||
- <strength 2>
|
||||
- <strength 3>
|
||||
|
||||
WEAKNESSES:
|
||||
- <weakness 1>
|
||||
- <weakness 2>
|
||||
|
||||
SUGGESTIONS:
|
||||
- <suggestion 1>
|
||||
- <suggestion 2>
|
||||
|
||||
CRITICAL_ISSUES:
|
||||
- <critical issue 1 (or "None")>
|
||||
|
||||
REASONING:
|
||||
<1-2 paragraphs explaining your evaluation, referencing specific files/evidence>
|
||||
|
||||
Provide honest, evidence-based evaluation.`;
|
||||
}
|
||||
|
||||
function parseEvaluationOutput(
|
||||
output: string,
|
||||
step: StepName
|
||||
): EvaluationResult {
|
||||
// Extract score
|
||||
const scoreMatch = output.match(/SCORE:\s*(\d+)/i);
|
||||
if (!scoreMatch) {
|
||||
console.warn(`Evaluation parser: no SCORE found in output (${output.length} chars). Defaulting to 50.`);
|
||||
}
|
||||
const score = scoreMatch ? parseInt(scoreMatch[1], 10) : 50;
|
||||
|
||||
// Extract sections
|
||||
const strengthsMatch = output.match(
|
||||
/STRENGTHS:\s*((?:- .+\n?)+)/i
|
||||
);
|
||||
const weaknessesMatch = output.match(
|
||||
/WEAKNESSES:\s*((?:- .+\n?)+)/i
|
||||
);
|
||||
const suggestionsMatch = output.match(
|
||||
/SUGGESTIONS:\s*((?:- .+\n?)+)/i
|
||||
);
|
||||
const criticalMatch = output.match(
|
||||
/CRITICAL_ISSUES:\s*((?:- .+\n?)+)/i
|
||||
);
|
||||
const reasoningMatch = output.match(/REASONING:\s*(.+?)(?=\n\n|$)/is);
|
||||
|
||||
const parseList = (text: string | undefined): string[] => {
|
||||
if (!text) return [];
|
||||
return text
|
||||
.split('\n')
|
||||
.map((line) => line.replace(/^-\s*/, '').trim())
|
||||
.filter((line) => line.length > 0 && !line.toLowerCase().includes('none'));
|
||||
};
|
||||
|
||||
return {
|
||||
step,
|
||||
score: Math.max(0, Math.min(100, score)),
|
||||
strengths: parseList(strengthsMatch?.[1]),
|
||||
weaknesses: parseList(weaknessesMatch?.[1]),
|
||||
suggestions: parseList(suggestionsMatch?.[1]),
|
||||
criticalIssues: parseList(criticalMatch?.[1]),
|
||||
timestamp: Date.now(),
|
||||
evaluatorModel: 'claude-sonnet-4-5',
|
||||
reasoning: reasoningMatch?.[1]?.trim() || 'No reasoning provided',
|
||||
};
|
||||
}
|
||||
|
||||
function createFallbackEvaluation(
|
||||
step: StepName,
|
||||
observations: ExecutionObservation
|
||||
): EvaluationResult {
|
||||
return {
|
||||
step,
|
||||
score: 50,
|
||||
strengths: ['Step completed'],
|
||||
weaknesses: ['Evaluation failed - using fallback'],
|
||||
suggestions: ['Re-run with evaluation enabled'],
|
||||
criticalIssues: ['Evaluation system unavailable'],
|
||||
timestamp: Date.now(),
|
||||
evaluatorModel: 'fallback',
|
||||
reasoning: 'Evaluation failed, using fallback. Cannot provide detailed assessment.',
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the active spec subdirectory (e.g. specs/<feature>/).
|
||||
* Falls back to projectDir if no spec folder exists yet (e.g. during init).
|
||||
*/
|
||||
function resolveOutputDir(projectDir: string): string {
|
||||
const specsDir = path.join(projectDir, 'specs');
|
||||
if (fs.existsSync(specsDir)) {
|
||||
const entries = fs.readdirSync(specsDir, { withFileTypes: true });
|
||||
const firstSpec = entries.find((e) => e.isDirectory());
|
||||
if (firstSpec) {
|
||||
return path.join(specsDir, firstSpec.name);
|
||||
}
|
||||
}
|
||||
return projectDir;
|
||||
}
|
||||
|
||||
async function writeEvaluationFiles(
|
||||
evaluation: EvaluationResult,
|
||||
observations: ExecutionObservation,
|
||||
projectDir: string
|
||||
): Promise<void> {
|
||||
const outputDir = resolveOutputDir(projectDir);
|
||||
|
||||
// Write BOT-EVALUATION.md
|
||||
const evalContent = formatEvaluationMarkdown(evaluation);
|
||||
const evalPath = path.join(outputDir, 'BOT-EVALUATION.md');
|
||||
|
||||
if (fs.existsSync(evalPath)) {
|
||||
// Append to existing file
|
||||
const existing = fs.readFileSync(evalPath, 'utf-8');
|
||||
fs.writeFileSync(evalPath, existing + '\n\n---\n\n' + evalContent);
|
||||
} else {
|
||||
fs.writeFileSync(evalPath, evalContent);
|
||||
}
|
||||
|
||||
// Write BOT-NOTES.md
|
||||
const notesContent = formatObservationsMarkdown(observations);
|
||||
const notesPath = path.join(outputDir, 'BOT-NOTES.md');
|
||||
|
||||
if (fs.existsSync(notesPath)) {
|
||||
const existing = fs.readFileSync(notesPath, 'utf-8');
|
||||
fs.writeFileSync(notesPath, existing + '\n\n---\n\n' + notesContent);
|
||||
} else {
|
||||
fs.writeFileSync(notesPath, notesContent);
|
||||
}
|
||||
}
|
||||
|
||||
function formatEvaluationMarkdown(evaluation: EvaluationResult): string {
|
||||
return `# Evaluation: ${evaluation.step} Step
|
||||
|
||||
**Score:** ${evaluation.score}/100
|
||||
**Timestamp:** ${new Date(evaluation.timestamp).toISOString()}
|
||||
**Evaluator:** ${evaluation.evaluatorModel}
|
||||
|
||||
## Strengths
|
||||
${evaluation.strengths.map((s) => `- ${s}`).join('\n') || '(none)'}
|
||||
|
||||
## Weaknesses
|
||||
${evaluation.weaknesses.map((w) => `- ${w}`).join('\n') || '(none)'}
|
||||
|
||||
## Suggestions for Improvement
|
||||
${evaluation.suggestions.map((s) => `- ${s}`).join('\n') || '(none)'}
|
||||
|
||||
${evaluation.criticalIssues.length > 0 ? `## Critical Issues\n${evaluation.criticalIssues.map((i) => `- ${i}`).join('\n')}\n` : ''}
|
||||
|
||||
## Reasoning
|
||||
${evaluation.reasoning}`;
|
||||
}
|
||||
|
||||
function formatObservationsMarkdown(observations: ExecutionObservation): string {
|
||||
const duration = observations.endTime - observations.startTime;
|
||||
const durationSec = Math.floor(duration / 1000);
|
||||
|
||||
return `# Observations: ${observations.step} Step
|
||||
|
||||
**Duration:** ${durationSec}s
|
||||
**Tools Used:** ${observations.tools.length}
|
||||
**Files Created:** ${observations.filesCreated.length}
|
||||
**Files Modified:** ${observations.filesModified.length}
|
||||
**Errors:** ${observations.errors.length}
|
||||
|
||||
${observations.questionsAsked.length > 0 ? `## Questions Asked & Answers\n\n${observations.questionsAsked.map((q) => `### Question: "${q.question}"\n**Selected:** "${q.selectedAnswer}"\n**Reasoning:** ${q.llmReasoning}`).join('\n\n')}\n` : ''}
|
||||
|
||||
## Tool Usage
|
||||
${observations.tools.map((t) => `- ${t.toolName}`).join('\n')}
|
||||
|
||||
## Files Created
|
||||
${observations.filesCreated.map((f) => `- ${f}`).join('\n') || '(none)'}
|
||||
|
||||
## Files Modified
|
||||
${observations.filesModified.map((f) => `- ${f}`).join('\n') || '(none)'}
|
||||
|
||||
${observations.assistantMessages.length > 0 ? `## Assistant Output Summary\n${observations.assistantMessages.slice(0, 3).map((m) => `> ${m.substring(0, 100)}...`).join('\n')}\n` : ''}`;
|
||||
}
|
||||
@@ -0,0 +1,114 @@
|
||||
import { query } from '@anthropic-ai/claude-agent-sdk';
|
||||
|
||||
interface IdeaResult {
|
||||
name: string;
|
||||
description: string;
|
||||
}
|
||||
|
||||
function parseIdea(text: string): IdeaResult {
|
||||
const nameMatch = text.match(/NAME:\s*(.+)/i);
|
||||
const descMatch = text.match(/DESCRIPTION:\s*([\s\S]+?)(?:\n\n|$)/i);
|
||||
|
||||
const name = nameMatch?.[1]?.trim() ?? 'auto-project';
|
||||
const description = descMatch?.[1]?.trim() ?? text.trim();
|
||||
|
||||
// Ensure kebab-case
|
||||
const kebabName = name
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, '-')
|
||||
.replace(/^-|-$/g, '');
|
||||
|
||||
return { name: kebabName, description };
|
||||
}
|
||||
|
||||
export async function generateNewAppIdea(seed?: string): Promise<IdeaResult> {
|
||||
const categories = [
|
||||
'CLI tool',
|
||||
'single-page web app',
|
||||
'REST API service',
|
||||
'browser extension',
|
||||
'interactive data visualization dashboard',
|
||||
'terminal-based game',
|
||||
'real-time web app (using WebSockets)',
|
||||
'static site generator or theme',
|
||||
'browser-based game',
|
||||
'desktop utility (using Electron or Tauri)',
|
||||
'chat bot or conversational tool',
|
||||
'automation script or workflow tool',
|
||||
];
|
||||
const category = categories[Math.floor(Math.random() * categories.length)];
|
||||
|
||||
const seedClause = seed
|
||||
? `\n\nThe user provided this seed for inspiration. Stay closely aligned with the theme and intent of the seed — build on it, don't ignore it:\n"${seed}"`
|
||||
: '';
|
||||
|
||||
const prompt = `Generate a random, creative idea for a ${category}. The project should be achievable in a single coding session (1-2 hours) and should be interesting but not overly complex.
|
||||
|
||||
IMPORTANT: Be creative and diverse with your ideas. Avoid defaulting to developer-centric tools (git analyzers, code formatters, repo scanners, etc.) unless the category specifically calls for it. Think about ideas that would appeal to a broad audience — productivity, entertainment, education, health, finance, art, music, social, cooking, travel, fitness, etc.${seedClause}
|
||||
|
||||
Respond in EXACTLY this format (no other text):
|
||||
NAME: <kebab-case-project-name>
|
||||
DESCRIPTION: <2-3 sentence description of what the app does, its key features, and the tech stack to use>`;
|
||||
|
||||
const session = query({
|
||||
prompt,
|
||||
options: {
|
||||
maxTurns: 1,
|
||||
systemPrompt: 'You are a wildly creative project idea generator. You come up with surprising, fun, and diverse software project ideas spanning many domains — not just developer tools. Respond only in the exact format requested.',
|
||||
},
|
||||
});
|
||||
|
||||
let output = '';
|
||||
for await (const message of session) {
|
||||
if (message.type === 'assistant') {
|
||||
for (const block of message.message.content) {
|
||||
if (block.type === 'text') {
|
||||
output += block.text;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return parseIdea(output);
|
||||
}
|
||||
|
||||
export async function generateEnhancementIdea(projectDir: string, seed?: string): Promise<IdeaResult> {
|
||||
const seedClause = seed
|
||||
? `\n\nUse this as inspiration for the enhancement: "${seed}"`
|
||||
: '';
|
||||
|
||||
const prompt = `You are in a project directory. Scan the existing codebase to understand what it does, then propose a realistic enhancement (new feature, refactor, improvement, or extension).
|
||||
|
||||
Use the Read, Glob, and Grep tools to explore the project. Look at:
|
||||
- Package.json or similar config files for project info
|
||||
- Source files for current functionality
|
||||
- README or docs for context${seedClause}
|
||||
|
||||
Then respond in EXACTLY this format (no other text):
|
||||
NAME: <kebab-case-enhancement-name>
|
||||
DESCRIPTION: <2-3 sentence description of the enhancement, what it adds/changes, and why it would be valuable>`;
|
||||
|
||||
const session = query({
|
||||
prompt,
|
||||
options: {
|
||||
maxTurns: 8,
|
||||
cwd: projectDir,
|
||||
tools: { type: 'preset', preset: 'claude_code' },
|
||||
allowedTools: ['Read', 'Glob', 'Grep'],
|
||||
systemPrompt: { type: 'preset', preset: 'claude_code' },
|
||||
},
|
||||
});
|
||||
|
||||
let output = '';
|
||||
for await (const message of session) {
|
||||
if (message.type === 'assistant') {
|
||||
for (const block of message.message.content) {
|
||||
if (block.type === 'text') {
|
||||
output += block.text;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return parseIdea(output);
|
||||
}
|
||||
@@ -0,0 +1,2 @@
|
||||
export { runCLI } from './cli.js';
|
||||
export type { BotConfig, BotMode, BotState, StepName, StepResult } from './types.js';
|
||||
@@ -0,0 +1,243 @@
|
||||
import { query } from '@anthropic-ai/claude-agent-sdk';
|
||||
import type { BotConfig, ExecutionObservation, StepName } from './types.js';
|
||||
import type { ObservationCollector } from './observation-collector.js';
|
||||
|
||||
interface AskUserQuestionInput {
|
||||
questions: Array<{
|
||||
question: string;
|
||||
options: Array<{ label: string; description: string }>;
|
||||
multiSelect?: boolean;
|
||||
}>;
|
||||
}
|
||||
|
||||
interface IntelligentAnswers {
|
||||
answers: Record<string, string>;
|
||||
reasoning: Record<string, string>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an intelligent responder that uses LLM-as-judge for ALL decisions.
|
||||
* Replaces the old hardcoded auto-responder logic.
|
||||
*/
|
||||
export function createIntelligentResponder(
|
||||
config: BotConfig,
|
||||
step: StepName,
|
||||
collector: ObservationCollector
|
||||
) {
|
||||
return async (
|
||||
toolName: string,
|
||||
input: Record<string, unknown>
|
||||
): Promise<{ behavior: 'allow'; updatedInput?: Record<string, unknown> } | { behavior: 'deny'; message: string }> => {
|
||||
// Record every tool invocation for observations
|
||||
collector.recordToolUse(toolName, input, undefined, true);
|
||||
|
||||
// Handle AskUserQuestion with LLM-generated answers
|
||||
if (toolName === 'AskUserQuestion') {
|
||||
const askInput = input as unknown as AskUserQuestionInput;
|
||||
|
||||
// Get current observations to provide context to LLM
|
||||
const observations = collector.getSnapshot();
|
||||
|
||||
// Generate answers using LLM-as-judge
|
||||
const answers = await generateIntelligentAnswers(
|
||||
askInput,
|
||||
observations,
|
||||
config,
|
||||
step
|
||||
);
|
||||
|
||||
// Record each question/answer pair for metrics
|
||||
for (const q of askInput.questions) {
|
||||
const answer = answers.answers[q.question];
|
||||
const reasoning = answers.reasoning[q.question] || 'No reasoning provided';
|
||||
collector.recordQuestion(q.question, q.options, answer, reasoning);
|
||||
}
|
||||
|
||||
return {
|
||||
behavior: 'allow',
|
||||
updatedInput: { ...input, answers: answers.answers },
|
||||
};
|
||||
}
|
||||
|
||||
// Allow all other tools
|
||||
return { behavior: 'allow' };
|
||||
};
|
||||
}
|
||||
|
||||
async function generateIntelligentAnswers(
|
||||
askInput: AskUserQuestionInput,
|
||||
observations: ExecutionObservation,
|
||||
config: BotConfig,
|
||||
step: StepName
|
||||
): Promise<IntelligentAnswers> {
|
||||
const prompt = buildDecisionPrompt(askInput, observations, config, step);
|
||||
|
||||
try {
|
||||
// Query LLM for decision (single turn, read-only tools)
|
||||
const session = query({
|
||||
prompt,
|
||||
options: {
|
||||
maxTurns: 1,
|
||||
cwd: config.projectDir,
|
||||
permissionMode: 'bypassPermissions',
|
||||
allowDangerouslySkipPermissions: true,
|
||||
allowedTools: ['Read', 'Glob', 'Grep'],
|
||||
systemPrompt: 'You are a QA engineer reviewing work-in-progress. Be thoughtful and honest.',
|
||||
},
|
||||
});
|
||||
|
||||
let output = '';
|
||||
for await (const message of session) {
|
||||
if (message.type === 'assistant') {
|
||||
for (const block of message.message.content) {
|
||||
if (block.type === 'text') output += block.text;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return parseDecisionOutput(output, askInput);
|
||||
} catch (error) {
|
||||
console.warn('LLM decision failed, using fallback logic:', error);
|
||||
// Fallback to reasonable defaults if LLM fails
|
||||
return generateFallbackAnswers(askInput, step);
|
||||
}
|
||||
}
|
||||
|
||||
function buildDecisionPrompt(
|
||||
askInput: AskUserQuestionInput,
|
||||
observations: ExecutionObservation,
|
||||
config: BotConfig,
|
||||
step: StepName
|
||||
): string {
|
||||
const duration = observations.endTime - observations.startTime;
|
||||
const toolSummary = observations.tools
|
||||
.map((t) => `- ${t.toolName}`)
|
||||
.join('\n');
|
||||
const filesSummary = [
|
||||
...observations.filesCreated.map((f) => `CREATED: ${f}`),
|
||||
...observations.filesModified.map((f) => `MODIFIED: ${f}`),
|
||||
].join('\n');
|
||||
|
||||
const questionsText = askInput.questions
|
||||
.map((q, i) => {
|
||||
const optionsText = q.options
|
||||
.map((o, j) => ` ${j + 1}. ${o.label} - ${o.description}`)
|
||||
.join('\n');
|
||||
return `QUESTION ${i + 1}: ${q.question}\nOptions:\n${optionsText}`;
|
||||
})
|
||||
.join('\n\n');
|
||||
|
||||
return `You are a QA engineer reviewing a workflow step in progress.
|
||||
|
||||
## Context
|
||||
- Step: ${step}
|
||||
- Mode: ${config.mode}
|
||||
- Duration so far: ${Math.floor(duration / 1000)}s
|
||||
- Tools used: ${observations.tools.length}
|
||||
- Errors encountered: ${observations.errors.length}
|
||||
|
||||
## What's Happened So Far
|
||||
|
||||
### Tools Used
|
||||
${toolSummary || '(none yet)'}
|
||||
|
||||
### Files Changed
|
||||
${filesSummary || '(none yet)'}
|
||||
|
||||
${observations.errors.length > 0 ? `### Errors\n${observations.errors.join('\n')}` : ''}
|
||||
|
||||
## Questions to Answer
|
||||
|
||||
${questionsText}
|
||||
|
||||
## Your Task
|
||||
|
||||
You need to answer these questions as a thoughtful QA engineer would:
|
||||
1. Use Read, Glob, and Grep tools to inspect the current state of artifacts if needed
|
||||
2. Consider what you've observed (tools used, files created, errors)
|
||||
3. For each question, select the most appropriate answer
|
||||
4. Provide brief reasoning for your choice
|
||||
|
||||
Respond in this format:
|
||||
|
||||
QUESTION 1:
|
||||
ANSWER: <option label>
|
||||
REASONING: <1-2 sentences explaining your choice>
|
||||
|
||||
QUESTION 2:
|
||||
ANSWER: <option label>
|
||||
REASONING: <1-2 sentences>
|
||||
|
||||
Be honest. If work looks incomplete or problematic, don't approve it.
|
||||
If tests should be run but haven't been, don't skip them without good reason.
|
||||
Act like a real developer who cares about quality.`;
|
||||
}
|
||||
|
||||
function parseDecisionOutput(
|
||||
output: string,
|
||||
askInput: AskUserQuestionInput
|
||||
): IntelligentAnswers {
|
||||
const answers: Record<string, string> = {};
|
||||
const reasoning: Record<string, string> = {};
|
||||
|
||||
// Parse structured output
|
||||
const questionBlocks = output.split(/QUESTION \d+:/i).slice(1);
|
||||
|
||||
askInput.questions.forEach((q, i) => {
|
||||
const block = questionBlocks[i] || '';
|
||||
|
||||
const answerMatch = block.match(/ANSWER:\s*(.+?)(?=\n|$)/i);
|
||||
const reasoningMatch = block.match(/REASONING:\s*(.+?)(?=\n\n|$)/is);
|
||||
|
||||
const selectedLabel = answerMatch?.[1]?.trim() || '';
|
||||
|
||||
// Find matching option by label (case-insensitive partial match)
|
||||
const matchedOption = q.options.find(
|
||||
(opt) =>
|
||||
opt.label.toLowerCase().includes(selectedLabel.toLowerCase()) ||
|
||||
selectedLabel.toLowerCase().includes(opt.label.toLowerCase())
|
||||
);
|
||||
|
||||
answers[q.question] = matchedOption?.label || q.options[0].label;
|
||||
reasoning[q.question] = reasoningMatch?.[1]?.trim() || 'No reasoning provided';
|
||||
});
|
||||
|
||||
return { answers, reasoning };
|
||||
}
|
||||
|
||||
function generateFallbackAnswers(
|
||||
askInput: AskUserQuestionInput,
|
||||
step: StepName
|
||||
): IntelligentAnswers {
|
||||
// Simple fallback: pick first option for most questions
|
||||
// For approval questions, approve; for testing, skip
|
||||
const answers: Record<string, string> = {};
|
||||
const reasoning: Record<string, string> = {};
|
||||
|
||||
for (const q of askInput.questions) {
|
||||
const questionLower = q.question.toLowerCase();
|
||||
|
||||
if (questionLower.includes('approve') || questionLower.includes('proceed')) {
|
||||
const approveOption = q.options.find(
|
||||
(o) =>
|
||||
o.label.toLowerCase().includes('approve') ||
|
||||
o.label.toLowerCase().includes('yes')
|
||||
);
|
||||
answers[q.question] = approveOption?.label || q.options[0].label;
|
||||
reasoning[q.question] = 'Fallback approval (LLM unavailable)';
|
||||
} else if (questionLower.includes('test')) {
|
||||
const skipOption = q.options.find(
|
||||
(o) =>
|
||||
o.label.toLowerCase().includes('skip') ||
|
||||
o.label.toLowerCase().includes('none')
|
||||
);
|
||||
answers[q.question] = skipOption?.label || q.options[0].label;
|
||||
reasoning[q.question] = 'Fallback skip (LLM unavailable)';
|
||||
} else {
|
||||
answers[q.question] = q.options[0].label;
|
||||
reasoning[q.question] = 'Fallback first option (LLM unavailable)';
|
||||
}
|
||||
}
|
||||
|
||||
return { answers, reasoning };
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
import type { ExecutionObservation, StepName } from './types.js';
|
||||
|
||||
/**
|
||||
* Collects detailed observations during step execution.
|
||||
* Tracks tool usage, messages, errors, file changes, and questions asked.
|
||||
*/
|
||||
export class ObservationCollector {
|
||||
private observations: ExecutionObservation;
|
||||
private recentToolKeys: Set<string> = new Set();
|
||||
|
||||
constructor(step: StepName) {
|
||||
this.observations = {
|
||||
step,
|
||||
startTime: Date.now(),
|
||||
endTime: 0,
|
||||
tools: [],
|
||||
assistantMessages: [],
|
||||
errors: [],
|
||||
filesCreated: [],
|
||||
filesModified: [],
|
||||
questionsAsked: [],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Records a tool invocation with its input and output.
|
||||
* Deduplicates if the same tool+input is recorded from both canUseTool and the message stream.
|
||||
*/
|
||||
recordToolUse(
|
||||
toolName: string,
|
||||
input: Record<string, unknown>,
|
||||
output: unknown,
|
||||
allowed: boolean
|
||||
): void {
|
||||
// Deduplicate based on tool name + serialized input (within a short time window)
|
||||
const key = `${toolName}:${JSON.stringify(input)}`;
|
||||
if (this.recentToolKeys.has(key)) {
|
||||
return;
|
||||
}
|
||||
this.recentToolKeys.add(key);
|
||||
// Clean up old keys periodically to avoid unbounded growth
|
||||
if (this.recentToolKeys.size > 500) {
|
||||
const entries = [...this.recentToolKeys];
|
||||
this.recentToolKeys = new Set(entries.slice(entries.length - 250));
|
||||
}
|
||||
|
||||
this.observations.tools.push({
|
||||
toolName,
|
||||
input,
|
||||
output,
|
||||
timestamp: Date.now(),
|
||||
allowed,
|
||||
autoAnswered: toolName === 'AskUserQuestion',
|
||||
});
|
||||
|
||||
// Extract file paths from common tools
|
||||
if (toolName === 'Write' && input.file_path) {
|
||||
this.observations.filesCreated.push(input.file_path as string);
|
||||
}
|
||||
if (toolName === 'Edit' && input.file_path) {
|
||||
this.observations.filesModified.push(input.file_path as string);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Records messages from the session (assistant text, errors).
|
||||
*/
|
||||
recordMessage(message: any): void {
|
||||
if (message.type === 'assistant') {
|
||||
for (const block of message.message.content) {
|
||||
if (block.type === 'text') {
|
||||
this.observations.assistantMessages.push(block.text);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (message.type === 'error') {
|
||||
this.observations.errors.push(message.error?.message ?? 'Unknown error');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Records a question that was asked and the LLM-generated answer.
|
||||
*/
|
||||
recordQuestion(
|
||||
question: string,
|
||||
options: Array<{ label: string; description: string }>,
|
||||
selectedAnswer: string,
|
||||
llmReasoning: string
|
||||
): void {
|
||||
this.observations.questionsAsked.push({
|
||||
question,
|
||||
options,
|
||||
llmReasoning,
|
||||
selectedAnswer,
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a snapshot of current observations (for real-time decision making).
|
||||
*/
|
||||
getSnapshot(): ExecutionObservation {
|
||||
return { ...this.observations, endTime: Date.now() };
|
||||
}
|
||||
|
||||
/**
|
||||
* Finalizes observations and returns the complete record.
|
||||
*/
|
||||
finalize(): ExecutionObservation {
|
||||
this.observations.endTime = Date.now();
|
||||
return { ...this.observations };
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,158 @@
|
||||
import type { StepName } from '../types.js';
|
||||
|
||||
export interface StepEvaluationCriteria {
|
||||
step: StepName;
|
||||
keyArtifacts: string[];
|
||||
qualityChecks: string[];
|
||||
commonPitfalls: string[];
|
||||
scoringGuidance: string;
|
||||
}
|
||||
|
||||
export const EVALUATION_CRITERIA: Record<StepName, StepEvaluationCriteria> = {
|
||||
init: {
|
||||
step: 'init',
|
||||
keyArtifacts: ['AGENTS.md', 'IDEA.md'],
|
||||
qualityChecks: [
|
||||
'AGENTS.md exists with project name and description',
|
||||
'AGENTS.md includes a brief intro line and a Status section indicating the project is in planning phase',
|
||||
'AGENTS.md does NOT contain hallucinated architecture, commands, file structures, or tech stack details',
|
||||
'No .agents-docs/ directory was created (too early for detail files)',
|
||||
'No project scaffolding (package.json, dependencies, src/) was created',
|
||||
'IDEA.md exists with the project idea',
|
||||
],
|
||||
commonPitfalls: [
|
||||
'Hallucinating architecture or tech stack details before the plan step',
|
||||
'Creating .agents-docs/ detail files with invented content',
|
||||
'Scaffolding project files or installing dependencies prematurely',
|
||||
],
|
||||
scoringGuidance: `
|
||||
100 = Perfect: AGENTS.md stub with intro line, project name/description, and status section. IDEA.md present. Nothing else created.
|
||||
85-95 = Good but minor extra content beyond the expected stub format (e.g., an extra placeholder heading)
|
||||
70-84 = AGENTS.md exists but includes some hallucinated details (e.g., assumed tech stack or commands)
|
||||
50-69 = Significant hallucination (e.g., .agents-docs/ created with invented content, project scaffolded)
|
||||
<50 = Major problems (e.g., AGENTS.md missing, full project structure hallucinated)
|
||||
|
||||
The expected AGENTS.md format is: intro line, Project Overview (name + description), and a Status section. This is the target for a 100 score.
|
||||
`,
|
||||
},
|
||||
|
||||
plan: {
|
||||
step: 'plan',
|
||||
keyArtifacts: ['specs/*/PLAN-DRAFT-*.md', 'IDEA.md'],
|
||||
qualityChecks: [
|
||||
'Plan breaks work into clear, achievable phases',
|
||||
'Each phase has specific goals and deliverables',
|
||||
'Technical approach is appropriate',
|
||||
'Scope is realistic for the idea',
|
||||
'Dependencies between phases are identified',
|
||||
],
|
||||
commonPitfalls: [
|
||||
'Phases too vague ("polish the app")',
|
||||
'Missing specific tasks within phases',
|
||||
'No testing strategy mentioned',
|
||||
'Overly ambitious scope',
|
||||
'Missing file paths or specific actions',
|
||||
],
|
||||
scoringGuidance: `
|
||||
100 = Exceptional plan: detailed phases, realistic scope, clear tasks, testing included
|
||||
85-95 = Good plan with minor improvements possible (e.g., one phase could be more specific)
|
||||
70-84 = Acceptable but has vague sections or missing testing strategy
|
||||
50-69 = Significant issues (e.g., multiple vague phases, unrealistic scope)
|
||||
<50 = Major problems (e.g., no clear phases, plan doesn't match idea)
|
||||
|
||||
Most plans should score 70-85. Be critical of vague language.
|
||||
`,
|
||||
},
|
||||
|
||||
document: {
|
||||
step: 'document',
|
||||
keyArtifacts: ['specs/*/overview.md', 'specs/*/phase-*.md files'],
|
||||
qualityChecks: [
|
||||
'overview.md provides clear project summary',
|
||||
'Each phase file has specific tasks with checkboxes',
|
||||
'File paths are explicit (not generic)',
|
||||
'Dependencies between tasks are identified',
|
||||
'Technical details are specific',
|
||||
'Acceptance criteria are clear',
|
||||
],
|
||||
commonPitfalls: [
|
||||
'Tasks too generic ("implement feature X")',
|
||||
'Missing file paths',
|
||||
'No checkboxes or unclear task structure',
|
||||
'Missing dependencies',
|
||||
'Overly verbose or lacking specifics',
|
||||
],
|
||||
scoringGuidance: `
|
||||
100 = Exceptional documentation: specific tasks, explicit file paths, clear dependencies
|
||||
85-95 = Good documentation with minor vagueness in one or two tasks
|
||||
70-84 = Acceptable but multiple tasks lack specifics or file paths
|
||||
50-69 = Significant issues (e.g., many generic tasks, missing file paths)
|
||||
<50 = Major problems (e.g., tasks don't match plan, fundamentally vague)
|
||||
|
||||
Most documentation should score 70-85. Penalize generic language heavily.
|
||||
`,
|
||||
},
|
||||
|
||||
implement: {
|
||||
step: 'implement',
|
||||
keyArtifacts: ['actual code files', 'checked-off tasks in phase files'],
|
||||
qualityChecks: [
|
||||
'Phase tasks are being completed',
|
||||
'Code files are actually created/modified',
|
||||
'Implementation follows the documented plan',
|
||||
'No major errors blocking progress',
|
||||
'Tests are written (if applicable)',
|
||||
],
|
||||
commonPitfalls: [
|
||||
'Tasks marked complete but files not actually changed',
|
||||
'Implementation deviates significantly from plan',
|
||||
'Errors not addressed',
|
||||
'Skipping tests without justification',
|
||||
'Working on wrong phase',
|
||||
],
|
||||
scoringGuidance: `
|
||||
100 = Exceptional implementation: all tasks complete, code works, tests pass
|
||||
85-95 = Good implementation with minor issues or incomplete tests
|
||||
70-84 = Acceptable but some tasks incomplete or code has issues
|
||||
50-69 = Significant issues (e.g., many tasks incomplete, code doesn't work)
|
||||
<50 = Major problems (e.g., wrong phase, no actual work done)
|
||||
|
||||
Implementation scoring depends heavily on actual progress. Be realistic.
|
||||
`,
|
||||
},
|
||||
|
||||
finalize: {
|
||||
step: 'finalize',
|
||||
keyArtifacts: ['specs--completed/', 'README or docs', 'final code state'],
|
||||
qualityChecks: [
|
||||
'All phases are marked complete',
|
||||
'Spec moved to specs--completed/',
|
||||
'Documentation is updated',
|
||||
'Code is in working state',
|
||||
'No obvious loose ends',
|
||||
],
|
||||
commonPitfalls: [
|
||||
'Incomplete phases',
|
||||
'Missing specs--completed/ move',
|
||||
'Documentation not updated',
|
||||
'Code broken or incomplete',
|
||||
'Unrealistic self-assessment',
|
||||
],
|
||||
scoringGuidance: `
|
||||
100 = Exceptional finalization: everything complete, polished, documented
|
||||
85-95 = Good finalization with minor issues
|
||||
70-84 = Acceptable but some loose ends or documentation gaps
|
||||
50-69 = Significant issues (e.g., incomplete phases, broken code)
|
||||
<50 = Major problems (e.g., work not actually done, fundamentally incomplete)
|
||||
|
||||
Finalize scores should reflect overall project quality. Be honest.
|
||||
`,
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* Gets evaluation criteria for a specific step.
|
||||
*/
|
||||
export function getCriteriaForStep(step: StepName): StepEvaluationCriteria {
|
||||
return EVALUATION_CRITERIA[step];
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { buildStepPrompt } from './step-instructions.js';
|
||||
import type { BotConfig } from '../types.js';
|
||||
|
||||
const config: BotConfig = {
|
||||
workDir: '/tmp/work',
|
||||
projectDir: '/tmp/work/my-app',
|
||||
ideaDescription: 'A todo app with drag-and-drop',
|
||||
ideaName: 'drag-todo',
|
||||
mode: 'new-project',
|
||||
};
|
||||
|
||||
describe('buildStepPrompt', () => {
|
||||
it('each step includes the autonomous preamble', () => {
|
||||
const steps = ['init', 'plan', 'document', 'implement', 'finalize'] as const;
|
||||
for (const step of steps) {
|
||||
const prompt = buildStepPrompt(step, config);
|
||||
expect(prompt).toContain('running autonomously');
|
||||
}
|
||||
});
|
||||
|
||||
it('init prompt includes /plan2code-init skill invocation', () => {
|
||||
const prompt = buildStepPrompt('init', config);
|
||||
expect(prompt).toContain('/plan2code-init');
|
||||
});
|
||||
|
||||
it('plan prompt includes /plan2code-1-plan skill invocation', () => {
|
||||
const prompt = buildStepPrompt('plan', config);
|
||||
expect(prompt).toContain('/plan2code-1-plan');
|
||||
});
|
||||
|
||||
it('document prompt includes /plan2code-2-document skill invocation', () => {
|
||||
const prompt = buildStepPrompt('document', config);
|
||||
expect(prompt).toContain('/plan2code-2-document');
|
||||
});
|
||||
|
||||
it('implement prompt instructs direct tool usage without skill invocation', () => {
|
||||
const prompt = buildStepPrompt('implement', config);
|
||||
expect(prompt).toContain('Do NOT use the Skill tool');
|
||||
});
|
||||
|
||||
it('finalize prompt includes /plan2code-4-finalize skill invocation', () => {
|
||||
const prompt = buildStepPrompt('finalize', config);
|
||||
expect(prompt).toContain('/plan2code-4-finalize');
|
||||
});
|
||||
|
||||
it('plan prompt includes project name and description', () => {
|
||||
const prompt = buildStepPrompt('plan', config);
|
||||
expect(prompt).toContain('drag-todo');
|
||||
expect(prompt).toContain('A todo app with drag-and-drop');
|
||||
});
|
||||
|
||||
it('init prompt includes project name and description', () => {
|
||||
const prompt = buildStepPrompt('init', config);
|
||||
expect(prompt).toContain('drag-todo');
|
||||
expect(prompt).toContain('A todo app with drag-and-drop');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,131 @@
|
||||
import type { BotConfig, StepName } from '../types.js';
|
||||
|
||||
const AUTONOMOUS_PREAMBLE = `You are running autonomously as part of an automated test pipeline. Do NOT pause for human input. When you encounter questions or approval gates, make reasonable decisions and proceed. If asked for confirmation, approve. If asked to choose, pick the most reasonable option. Complete the entire step without stopping.`;
|
||||
|
||||
export function buildStepPrompt(step: StepName, config: BotConfig): string {
|
||||
switch (step) {
|
||||
case 'init':
|
||||
return buildInitPrompt(config);
|
||||
case 'plan':
|
||||
return buildPlanPrompt(config);
|
||||
case 'document':
|
||||
return buildDocumentPrompt(config);
|
||||
case 'implement':
|
||||
return buildImplementPrompt(config);
|
||||
case 'finalize':
|
||||
return buildFinalizePrompt(config);
|
||||
}
|
||||
}
|
||||
|
||||
function buildInitPrompt(config: BotConfig): string {
|
||||
return `${AUTONOMOUS_PREAMBLE}
|
||||
|
||||
This is a brand new project with no existing code. Create a minimal stub AGENTS.md file and an IDEA.md file. Do NOT run the /plan2code-init skill — there is no codebase to analyze yet.
|
||||
|
||||
The project idea is: ${config.ideaDescription}
|
||||
The project name is: ${config.ideaName}
|
||||
|
||||
## What to create
|
||||
|
||||
### AGENTS.md
|
||||
Create a minimal stub with ONLY the following — do NOT invent architecture, tech stack details, commands, or file structures:
|
||||
|
||||
\`\`\`markdown
|
||||
# AGENTS.md
|
||||
|
||||
This file provides guidance to AI coding agents when working with code in this repository.
|
||||
|
||||
## Project Overview
|
||||
**Name:** ${config.ideaName}
|
||||
**Description:** ${config.ideaDescription}
|
||||
|
||||
## Status
|
||||
This project is in the planning phase. Architecture, commands, and detailed documentation will be added after the plan and document steps are complete.
|
||||
\`\`\`
|
||||
|
||||
### IDEA.md
|
||||
If IDEA.md does not already exist, create it with the project name and description.
|
||||
|
||||
## Rules
|
||||
- Do NOT create .agents-docs/ or any detail files — there is nothing to document yet
|
||||
- Do NOT hallucinate architecture, dependencies, file structures, or tech stack choices
|
||||
- Do NOT install dependencies or scaffold project files
|
||||
- ONLY create the two files above`;
|
||||
}
|
||||
|
||||
function buildPlanPrompt(config: BotConfig): string {
|
||||
return `${AUTONOMOUS_PREAMBLE}
|
||||
|
||||
Run the /plan2code-1-plan skill to create a plan for this project.
|
||||
|
||||
Read the IDEA.md file first to understand the project. The project is: ${config.ideaDescription}
|
||||
|
||||
When making decisions during planning:
|
||||
- Set confidence levels reasonably high (85-95%)
|
||||
- Accept the generated tech stack without revision
|
||||
- Do not request additional reference files
|
||||
- Approve the plan when asked for sign-off
|
||||
- Keep scope small and achievable (3-4 phases max)
|
||||
- Use the project name: ${config.ideaName}`;
|
||||
}
|
||||
|
||||
function buildDocumentPrompt(config: BotConfig): string {
|
||||
return `${AUTONOMOUS_PREAMBLE}
|
||||
|
||||
Run the /plan2code-2-document skill to transform the plan into implementation specs.
|
||||
|
||||
Read the existing plan output in specs/ first to understand what was planned.
|
||||
|
||||
When making decisions:
|
||||
- Accept all generated documentation
|
||||
- Approve phase breakdowns and task lists
|
||||
- Do not request changes to the generated docs`;
|
||||
}
|
||||
|
||||
function buildImplementPrompt(config: BotConfig): string {
|
||||
return `${AUTONOMOUS_PREAMBLE}
|
||||
|
||||
You are a senior software engineer implementing a project phase. Do NOT use the Skill tool — implement directly using Read, Write, Edit, Glob, and Grep tools.
|
||||
|
||||
## Process
|
||||
|
||||
1. **Find the spec**: Read \`specs/*/overview.md\` to find the phase checklist
|
||||
2. **Pick the next phase**: Find the first phase marked \`[ ]\` (pending) or \`[/]\` (in-progress)
|
||||
3. **Read the phase file**: Read the corresponding \`phase-X.md\` from the same directory
|
||||
4. **Mark phase in-progress**: Update \`[ ]\` to \`[/]\` in overview.md
|
||||
5. **Implement each task sequentially**:
|
||||
- Read the task specification completely
|
||||
- Write the code using Write or Edit tools — create real files, not code blocks
|
||||
- Mark the task \`[x]\` in the phase file immediately after completing it
|
||||
6. **Complete the phase**: After all tasks, fill in the "Phase Completion Summary" in the phase file
|
||||
7. **Mark phase complete**: Update \`[/]\` to \`[x]\` in overview.md
|
||||
|
||||
## Rules
|
||||
|
||||
- Follow AGENTS.md if it exists
|
||||
- Implement specs EXACTLY — no creative additions or unsolicited improvements
|
||||
- Write task completion status (\`[x]\`) to disk immediately after each task — never batch
|
||||
- Only create files mentioned in the spec tasks
|
||||
- Use the specified file paths, function names, and structures from the spec
|
||||
- No placeholder code — fully implement every function
|
||||
- Match existing codebase conventions
|
||||
- Do NOT run git commands
|
||||
- Skip running tests unless explicitly listed as a phase task
|
||||
|
||||
## Project info
|
||||
- Project: ${config.ideaName}
|
||||
- Description: ${config.ideaDescription}
|
||||
- Project directory: ${config.projectDir}`;
|
||||
}
|
||||
|
||||
function buildFinalizePrompt(config: BotConfig): string {
|
||||
return `${AUTONOMOUS_PREAMBLE}
|
||||
|
||||
Run the /plan2code-4-finalize skill to validate and archive the completed project.
|
||||
|
||||
When making decisions:
|
||||
- Approve all documentation updates
|
||||
- Accept the completion summary
|
||||
- If asked for a rating or feedback, give 8/10 and positive feedback
|
||||
- Complete the archival process fully`;
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
import { describe, it, expect, vi } from 'vitest';
|
||||
|
||||
// Mock the SDK before importing session-runner
|
||||
vi.mock('@anthropic-ai/claude-agent-sdk', () => ({
|
||||
query: vi.fn(),
|
||||
}));
|
||||
|
||||
import { query } from '@anthropic-ai/claude-agent-sdk';
|
||||
import { runSession } from './session-runner.js';
|
||||
import { ObservationCollector } from './observation-collector.js';
|
||||
import type { BotConfig } from './types.js';
|
||||
|
||||
const config: BotConfig = {
|
||||
workDir: '/tmp/work',
|
||||
projectDir: '/tmp/work/my-app',
|
||||
ideaDescription: 'test app',
|
||||
ideaName: 'test-app',
|
||||
mode: 'new-project',
|
||||
};
|
||||
|
||||
describe('runSession', () => {
|
||||
it('returns success: false when output is empty', async () => {
|
||||
// Simulate a session that yields an assistant message with empty text
|
||||
const mockQuery = vi.mocked(query);
|
||||
mockQuery.mockReturnValue(
|
||||
(async function* () {
|
||||
yield {
|
||||
type: 'assistant' as const,
|
||||
session_id: 'sess-1',
|
||||
message: { content: [{ type: 'text' as const, text: '' }] },
|
||||
};
|
||||
yield {
|
||||
type: 'result' as const,
|
||||
session_id: 'sess-1',
|
||||
};
|
||||
})() as any,
|
||||
);
|
||||
|
||||
const collector = new ObservationCollector('init');
|
||||
const result = await runSession({
|
||||
prompt: 'do something',
|
||||
config,
|
||||
step: 'init',
|
||||
collector,
|
||||
});
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.output.trim()).toBe('');
|
||||
expect(result.observations).toBeDefined();
|
||||
});
|
||||
|
||||
it('returns success: true when output has content', async () => {
|
||||
const mockQuery = vi.mocked(query);
|
||||
mockQuery.mockReturnValue(
|
||||
(async function* () {
|
||||
yield {
|
||||
type: 'assistant' as const,
|
||||
session_id: 'sess-2',
|
||||
message: { content: [{ type: 'text' as const, text: 'AGENTS.md has been created successfully' }] },
|
||||
};
|
||||
yield {
|
||||
type: 'result' as const,
|
||||
session_id: 'sess-2',
|
||||
};
|
||||
})() as any,
|
||||
);
|
||||
|
||||
const collector = new ObservationCollector('init');
|
||||
const result = await runSession({
|
||||
prompt: 'do something',
|
||||
config,
|
||||
step: 'init',
|
||||
collector,
|
||||
});
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.output).toContain('AGENTS.md');
|
||||
expect(result.sessionId).toBe('sess-2');
|
||||
expect(result.observations).toBeDefined();
|
||||
expect(result.observations.step).toBe('init');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,77 @@
|
||||
import { query } from '@anthropic-ai/claude-agent-sdk';
|
||||
import { createIntelligentResponder } from './intelligent-responder.js';
|
||||
import type { BotConfig, ExecutionObservation, StepName } from './types.js';
|
||||
import type { ObservationCollector } from './observation-collector.js';
|
||||
|
||||
export interface SessionOptions {
|
||||
prompt: string;
|
||||
config: BotConfig;
|
||||
step: StepName;
|
||||
maxTurns?: number;
|
||||
collector: ObservationCollector;
|
||||
}
|
||||
|
||||
export interface SessionResult {
|
||||
sessionId: string | null;
|
||||
output: string;
|
||||
success: boolean;
|
||||
duration: number;
|
||||
observations: ExecutionObservation;
|
||||
}
|
||||
|
||||
export async function runSession(options: SessionOptions): Promise<SessionResult> {
|
||||
const { prompt, config, step, maxTurns = 50, collector } = options;
|
||||
const startTime = Date.now();
|
||||
let output = '';
|
||||
let sessionId: string | null = null;
|
||||
|
||||
try {
|
||||
const session = query({
|
||||
prompt,
|
||||
options: {
|
||||
cwd: config.projectDir,
|
||||
maxTurns,
|
||||
permissionMode: 'bypassPermissions',
|
||||
allowDangerouslySkipPermissions: true,
|
||||
canUseTool: createIntelligentResponder(config, step, collector),
|
||||
systemPrompt: { type: 'preset', preset: 'claude_code' },
|
||||
settingSources: ['project'],
|
||||
},
|
||||
});
|
||||
|
||||
for await (const message of session) {
|
||||
// Record all messages for observations
|
||||
collector.recordMessage(message);
|
||||
|
||||
if (message.type === 'assistant') {
|
||||
sessionId = message.session_id ?? sessionId;
|
||||
for (const block of message.message.content) {
|
||||
if (block.type === 'text') {
|
||||
output += block.text + '\n';
|
||||
} else if (block.type === 'tool_use') {
|
||||
// Capture tool invocations from the message stream as a fallback
|
||||
// in case canUseTool doesn't fire (e.g., Skill sub-sessions)
|
||||
collector.recordToolUse(
|
||||
block.name,
|
||||
block.input as Record<string, unknown>,
|
||||
undefined,
|
||||
true
|
||||
);
|
||||
}
|
||||
}
|
||||
} else if (message.type === 'result') {
|
||||
sessionId = message.session_id ?? sessionId;
|
||||
}
|
||||
}
|
||||
|
||||
const duration = Date.now() - startTime;
|
||||
const hasOutput = output.trim().length > 0;
|
||||
const observations = collector.finalize();
|
||||
return { sessionId, output, success: hasOutput, duration, observations };
|
||||
} catch (error) {
|
||||
const duration = Date.now() - startTime;
|
||||
const errorMsg = error instanceof Error ? error.message : String(error);
|
||||
const observations = collector.finalize();
|
||||
return { sessionId, output, success: false, duration, observations };
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import fs from 'fs-extra';
|
||||
import os from 'os';
|
||||
import path from 'path';
|
||||
import { checkAllPhasesComplete, detectStepCompletion } from './step-detector.js';
|
||||
|
||||
let tmpDir: string;
|
||||
|
||||
beforeEach(() => {
|
||||
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'p2c-test-'));
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
fs.removeSync(tmpDir);
|
||||
});
|
||||
|
||||
// ── checkAllPhasesComplete ──────────────────────────────────────────
|
||||
|
||||
describe('checkAllPhasesComplete', () => {
|
||||
it('returns false when no specs/ directory exists', () => {
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(false);
|
||||
});
|
||||
|
||||
it('returns false when specs/ has no subdirectories', () => {
|
||||
fs.ensureDirSync(path.join(tmpDir, 'specs'));
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(false);
|
||||
});
|
||||
|
||||
it('returns false when spec dir exists but has no overview.md and no phase files', () => {
|
||||
// This is the false-positive bug we fixed — an empty spec dir should NOT be "complete"
|
||||
fs.ensureDirSync(path.join(tmpDir, 'specs', 'my-feature'));
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(false);
|
||||
});
|
||||
|
||||
it('returns true when overview.md has all phases checked [x]', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(
|
||||
path.join(specDir, 'overview.md'),
|
||||
`# Overview\n- [x] Phase 1: Setup\n- [x] Phase 2: Core\n- [x] Phase 3: Polish\n`,
|
||||
);
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(true);
|
||||
});
|
||||
|
||||
it('returns false when overview.md has unchecked [ ] phases', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(
|
||||
path.join(specDir, 'overview.md'),
|
||||
`# Overview\n- [x] Phase 1: Setup\n- [ ] Phase 2: Core\n- [ ] Phase 3: Polish\n`,
|
||||
);
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(false);
|
||||
});
|
||||
|
||||
it('returns true via fallback: phase-*.md files with all checked, no overview.md', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(
|
||||
path.join(specDir, 'phase-1.md'),
|
||||
`# Phase 1\n- [x] Task A\n- [x] Task B\n`,
|
||||
);
|
||||
fs.writeFileSync(
|
||||
path.join(specDir, 'phase-2.md'),
|
||||
`# Phase 2\n- [x] Task C\n`,
|
||||
);
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(true);
|
||||
});
|
||||
|
||||
it('returns false via fallback: phase-*.md with unchecked items', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
fs.ensureDirSync(specDir);
|
||||
fs.writeFileSync(
|
||||
path.join(specDir, 'phase-1.md'),
|
||||
`# Phase 1\n- [x] Task A\n- [ ] Task B\n`,
|
||||
);
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(false);
|
||||
});
|
||||
|
||||
it('returns true via nested phases/ subdirectory fallback with all checked', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
const phasesDir = path.join(specDir, 'phases');
|
||||
fs.ensureDirSync(phasesDir);
|
||||
fs.writeFileSync(
|
||||
path.join(phasesDir, 'phase-1.md'),
|
||||
`# Phase 1\n- [x] Task A\n- [x] Task B\n`,
|
||||
);
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(true);
|
||||
});
|
||||
|
||||
it('returns false via nested phases/ with unchecked items', () => {
|
||||
const specDir = path.join(tmpDir, 'specs', 'my-feature');
|
||||
const phasesDir = path.join(specDir, 'phases');
|
||||
fs.ensureDirSync(phasesDir);
|
||||
fs.writeFileSync(
|
||||
path.join(phasesDir, 'phase-1.md'),
|
||||
`# Phase 1\n- [x] Task A\n- [ ] Task B\n`,
|
||||
);
|
||||
expect(checkAllPhasesComplete(tmpDir)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
// ── detectStepCompletion ────────────────────────────────────────────
|
||||
|
||||
describe('detectStepCompletion', () => {
|
||||
it('init: completed when output mentions agents.md created', () => {
|
||||
const result = detectStepCompletion('AGENTS.md has been created successfully', 'init');
|
||||
expect(result.completed).toBe(true);
|
||||
expect(result.nextStep).toBe('plan');
|
||||
});
|
||||
|
||||
it('init: not completed for unrelated output', () => {
|
||||
const result = detectStepCompletion('Hello world, nothing happened', 'init');
|
||||
expect(result.completed).toBe(false);
|
||||
expect(result.nextStep).toBeNull();
|
||||
});
|
||||
|
||||
it('plan: completed when plan is saved', () => {
|
||||
const result = detectStepCompletion('The plan has been saved and finalized', 'plan');
|
||||
expect(result.completed).toBe(true);
|
||||
expect(result.nextStep).toBe('document');
|
||||
});
|
||||
|
||||
it('plan: not completed for unrelated output', () => {
|
||||
const result = detectStepCompletion('Reading the codebase...', 'plan');
|
||||
expect(result.completed).toBe(false);
|
||||
expect(result.nextStep).toBeNull();
|
||||
});
|
||||
|
||||
it('document: completed when overview.md is mentioned', () => {
|
||||
const result = detectStepCompletion('Created overview.md with all phases', 'document');
|
||||
expect(result.completed).toBe(true);
|
||||
expect(result.nextStep).toBe('implement');
|
||||
});
|
||||
|
||||
it('document: not completed for unrelated output', () => {
|
||||
const result = detectStepCompletion('Thinking about the design...', 'document');
|
||||
expect(result.completed).toBe(false);
|
||||
expect(result.nextStep).toBeNull();
|
||||
});
|
||||
|
||||
it('implement: completed when phase is done', () => {
|
||||
const result = detectStepCompletion('Phase 1 is now complete!', 'implement');
|
||||
expect(result.completed).toBe(true);
|
||||
expect(result.nextStep).toBe('finalize');
|
||||
});
|
||||
|
||||
it('implement: not completed for unrelated output', () => {
|
||||
const result = detectStepCompletion('Working on some files', 'implement');
|
||||
expect(result.completed).toBe(false);
|
||||
expect(result.nextStep).toBeNull();
|
||||
});
|
||||
|
||||
it('finalize: completed when finalize is done', () => {
|
||||
const result = detectStepCompletion('Finalize step is complete and archived', 'finalize');
|
||||
expect(result.completed).toBe(true);
|
||||
expect(result.nextStep).toBeNull(); // last step
|
||||
});
|
||||
|
||||
it('finalize: not completed for unrelated output', () => {
|
||||
const result = detectStepCompletion('Just starting...', 'finalize');
|
||||
expect(result.completed).toBe(false);
|
||||
expect(result.nextStep).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,151 @@
|
||||
import fs from 'fs-extra';
|
||||
import path from 'path';
|
||||
import type { StepName } from './types.js';
|
||||
|
||||
export interface DetectionResult {
|
||||
completed: boolean;
|
||||
nextStep: StepName | null;
|
||||
needsAnotherImplementPass: boolean;
|
||||
}
|
||||
|
||||
const STEP_ORDER: StepName[] = ['init', 'plan', 'document', 'implement', 'finalize'];
|
||||
|
||||
export function detectStepCompletion(output: string, step: StepName): DetectionResult {
|
||||
const lowerOutput = output.toLowerCase();
|
||||
|
||||
let completed = false;
|
||||
|
||||
switch (step) {
|
||||
case 'init':
|
||||
completed = lowerOutput.includes('agents.md') && (
|
||||
lowerOutput.includes('created') ||
|
||||
lowerOutput.includes('generated') ||
|
||||
lowerOutput.includes('written')
|
||||
);
|
||||
break;
|
||||
|
||||
case 'plan':
|
||||
completed = lowerOutput.includes('plan') && (
|
||||
lowerOutput.includes('complete') ||
|
||||
lowerOutput.includes('approved') ||
|
||||
lowerOutput.includes('finalized') ||
|
||||
lowerOutput.includes('saved')
|
||||
);
|
||||
break;
|
||||
|
||||
case 'document':
|
||||
completed = lowerOutput.includes('overview.md') || (
|
||||
lowerOutput.includes('document') && lowerOutput.includes('complete')
|
||||
);
|
||||
break;
|
||||
|
||||
case 'implement':
|
||||
completed = lowerOutput.includes('phase') && (
|
||||
lowerOutput.includes('complete') ||
|
||||
lowerOutput.includes('done') ||
|
||||
lowerOutput.includes('finished')
|
||||
);
|
||||
break;
|
||||
|
||||
case 'finalize':
|
||||
completed = lowerOutput.includes('finalize') && (
|
||||
lowerOutput.includes('complete') ||
|
||||
lowerOutput.includes('archived') ||
|
||||
lowerOutput.includes('done')
|
||||
);
|
||||
break;
|
||||
}
|
||||
|
||||
// Determine next step
|
||||
const currentIdx = STEP_ORDER.indexOf(step);
|
||||
const nextStep = currentIdx < STEP_ORDER.length - 1 ? STEP_ORDER[currentIdx + 1] : null;
|
||||
|
||||
return {
|
||||
completed,
|
||||
nextStep: completed ? nextStep : null,
|
||||
needsAnotherImplementPass: false,
|
||||
};
|
||||
}
|
||||
|
||||
export function checkAllPhasesComplete(projectDir: string): boolean {
|
||||
const specsDir = path.join(projectDir, 'specs');
|
||||
|
||||
if (!fs.existsSync(specsDir)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const entries = fs.readdirSync(specsDir, { withFileTypes: true });
|
||||
const specDirs = entries.filter((e) => e.isDirectory());
|
||||
|
||||
if (specDirs.length === 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
let foundPhaseTracking = false;
|
||||
|
||||
for (const dir of specDirs) {
|
||||
const specPath = path.join(specsDir, dir.name);
|
||||
|
||||
// Try overview.md first
|
||||
const overviewPath = path.join(specPath, 'overview.md');
|
||||
if (fs.existsSync(overviewPath)) {
|
||||
foundPhaseTracking = true;
|
||||
if (hasUncheckedPhases(fs.readFileSync(overviewPath, 'utf-8'))) {
|
||||
return false;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// Fallback: look for phase-*.md or PHASE-*.md in the spec dir
|
||||
const phaseFiles = findPhaseFiles(specPath);
|
||||
if (phaseFiles.length > 0) {
|
||||
foundPhaseTracking = true;
|
||||
for (const pf of phaseFiles) {
|
||||
if (hasUncheckedPhases(fs.readFileSync(pf, 'utf-8'))) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// Fallback: look inside a phases/ subdirectory
|
||||
const phasesSubdir = path.join(specPath, 'phases');
|
||||
if (fs.existsSync(phasesSubdir)) {
|
||||
const subPhaseFiles = findPhaseFiles(phasesSubdir);
|
||||
if (subPhaseFiles.length > 0) {
|
||||
foundPhaseTracking = true;
|
||||
for (const pf of subPhaseFiles) {
|
||||
if (hasUncheckedPhases(fs.readFileSync(pf, 'utf-8'))) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Only return true if we positively confirmed all phases are checked off
|
||||
return foundPhaseTracking;
|
||||
}
|
||||
|
||||
function hasUncheckedPhases(content: string): boolean {
|
||||
const lines = content.split('\n');
|
||||
|
||||
const phaseLines = lines.filter((line) =>
|
||||
line.match(/^[-*]\s*\[[ x]\]/i) && line.toLowerCase().includes('phase')
|
||||
);
|
||||
|
||||
if (phaseLines.length > 0) {
|
||||
return phaseLines.some((line) => line.includes('[ ]'));
|
||||
}
|
||||
|
||||
// No phase-specific checkboxes — check for any unchecked boxes
|
||||
return lines.some((line) => /^[-*]\s*\[ \]/.test(line));
|
||||
}
|
||||
|
||||
function findPhaseFiles(dir: string): string[] {
|
||||
if (!fs.existsSync(dir)) return [];
|
||||
const entries = fs.readdirSync(dir);
|
||||
return entries
|
||||
.filter((name) => /^phase[-_]?\d+.*\.md$/i.test(name))
|
||||
.map((name) => path.join(dir, name));
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
export type BotMode = 'new-project' | 'enhancement';
|
||||
|
||||
export interface BotConfig {
|
||||
workDir: string;
|
||||
projectDir: string;
|
||||
ideaDescription: string;
|
||||
ideaName: string;
|
||||
mode: BotMode;
|
||||
}
|
||||
|
||||
export type StepName = 'init' | 'plan' | 'document' | 'implement' | 'finalize';
|
||||
|
||||
export interface ToolObservation {
|
||||
toolName: string;
|
||||
input: Record<string, unknown>;
|
||||
output?: unknown;
|
||||
timestamp: number;
|
||||
allowed: boolean;
|
||||
autoAnswered?: boolean;
|
||||
}
|
||||
|
||||
export interface QuestionContext {
|
||||
question: string;
|
||||
options: Array<{ label: string; description: string }>;
|
||||
llmReasoning: string;
|
||||
selectedAnswer: string;
|
||||
timestamp: number;
|
||||
}
|
||||
|
||||
export interface ExecutionObservation {
|
||||
step: StepName;
|
||||
startTime: number;
|
||||
endTime: number;
|
||||
tools: ToolObservation[];
|
||||
assistantMessages: string[];
|
||||
errors: string[];
|
||||
filesCreated: string[];
|
||||
filesModified: string[];
|
||||
questionsAsked: QuestionContext[];
|
||||
}
|
||||
|
||||
export interface EvaluationResult {
|
||||
step: StepName;
|
||||
score: number;
|
||||
strengths: string[];
|
||||
weaknesses: string[];
|
||||
suggestions: string[];
|
||||
criticalIssues: string[];
|
||||
timestamp: number;
|
||||
evaluatorModel: string;
|
||||
reasoning: string;
|
||||
}
|
||||
|
||||
export interface StepResult {
|
||||
step: StepName;
|
||||
success: boolean;
|
||||
sessionId: string | null;
|
||||
duration: number;
|
||||
error: string | null;
|
||||
evaluation?: EvaluationResult;
|
||||
observations?: ExecutionObservation;
|
||||
}
|
||||
|
||||
export interface BotState {
|
||||
config: BotConfig;
|
||||
steps: StepResult[];
|
||||
currentStep: StepName | null;
|
||||
implementPasses: number;
|
||||
allPhasesComplete: boolean;
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2022"],
|
||||
"outDir": "dist",
|
||||
"rootDir": ".",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"resolveJsonModule": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"sourceMap": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
|
||||
export default defineConfig({
|
||||
entry: {
|
||||
'bin/plan2code-bot': 'src/bin/plan2code-bot.ts',
|
||||
index: 'src/index.ts',
|
||||
},
|
||||
format: ['esm'],
|
||||
dts: false,
|
||||
clean: true,
|
||||
sourcemap: true,
|
||||
banner: {
|
||||
js: '#!/usr/bin/env node',
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
include: ['src/**/*.test.ts'],
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,210 @@
|
||||
# Plan2Code Loop
|
||||
|
||||
An autonomous CLI tool that implements Plan2Code specs by looping through tasks automatically.
|
||||
|
||||
> **Note:** This is an **alternative** to `/plan2code-3-implement`, not a replacement. Use the manual Step 3 workflow when you want interactive control over each phase, or use this loop when you prefer hands-off autonomous execution.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# From the plan2code root directory:
|
||||
|
||||
# Option 1: Install everything (recommended)
|
||||
node install.js # Select option A
|
||||
|
||||
# Option 2: Install loop only
|
||||
node install.js # Select option O
|
||||
|
||||
# Option 3: Manual build and link
|
||||
cd plan2code-loop
|
||||
npm install
|
||||
npm run build
|
||||
npm link
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Simply run the command - everything is interactive:
|
||||
|
||||
```bash
|
||||
plan2code-loop
|
||||
```
|
||||
|
||||
The CLI will:
|
||||
1. Auto-detect specs in `./specs/` directory
|
||||
2. Let you select a spec if multiple are found
|
||||
3. Prompt to continue if an existing session is found
|
||||
4. Ask for JIRA ticket ID, agent selection, loop mode, and max iterations
|
||||
|
||||
## How It Works
|
||||
|
||||
The loop uses an **LLM-driven discovery** approach:
|
||||
|
||||
1. **Spec Selection** - Interactive menu to select from discovered specs
|
||||
2. **Task Discovery** - The AI reads `overview.md` and phase files to find unchecked tasks
|
||||
3. **Implementation** - The AI implements tasks (one per iteration in task mode, or all in a phase in phase mode)
|
||||
4. **Checkbox Update** - The AI marks tasks complete in the markdown file
|
||||
5. **Scratchpad Update** - The AI appends notes to the per-spec scratchpad
|
||||
6. **Completion Marker** - The AI outputs structured markers (e.g., `TASK_COMPLETE: 1.1 - description`)
|
||||
7. **Loop** - Repeat until all tasks done or max iterations reached
|
||||
|
||||
### Loop Modes
|
||||
|
||||
The CLI asks you to choose a loop mode:
|
||||
|
||||
| Mode | Behavior | Git Commits | Best For |
|
||||
|------|----------|-------------|----------|
|
||||
| **One task per loop** (default) | Each agent invocation implements exactly one task | Node controller commits after each task | Smaller models, careful step-by-step execution |
|
||||
| **One phase per loop** | Each agent invocation implements all remaining tasks in the current phase | LLM commits after each task (with JIRA ID if provided) | Smart models with larger context windows, keeping related tasks together |
|
||||
|
||||
### Why LLM-Driven?
|
||||
|
||||
The Node app does NOT parse markdown to find tasks. Instead, the AI reads the spec files directly and decides what to work on. This is:
|
||||
|
||||
- **More flexible** - Works with any reasonable markdown format
|
||||
- **Smarter** - AI can handle edge cases and ambiguity
|
||||
- **Simpler** - Node code is just orchestration, not parsing
|
||||
|
||||
## Completion Markers
|
||||
|
||||
The AI must output one of these markers at the end of each iteration:
|
||||
|
||||
```
|
||||
TASK_COMPLETE: 1.1 - Initialize project structure
|
||||
TASK_BLOCKED: 2.3 - Missing API credentials
|
||||
PHASE_COMPLETE
|
||||
LOOP_COMPLETE
|
||||
```
|
||||
|
||||
| Marker | Meaning |
|
||||
|--------|---------|
|
||||
| `TASK_COMPLETE: X.X - desc` | Task implemented and marked complete |
|
||||
| `TASK_BLOCKED: X.X - reason` | Cannot complete task (explains why) |
|
||||
| `PHASE_COMPLETE` | Current phase finished (phase mode only) |
|
||||
| `LOOP_COMPLETE` | All phases finished |
|
||||
|
||||
In **phase mode**, the AI outputs multiple `TASK_COMPLETE` markers (one per task) within a single iteration, followed by `PHASE_COMPLETE` or `LOOP_COMPLETE`.
|
||||
|
||||
## Session Files
|
||||
|
||||
Session state is stored **per-spec** inside the spec directory:
|
||||
|
||||
```
|
||||
specs/my-feature/
|
||||
├── overview.md
|
||||
├── phase-1.md
|
||||
├── phase-2.md
|
||||
└── .plan2code-loop/ # Per-spec session state
|
||||
├── config.json # Session configuration
|
||||
├── scratchpad.md # LLM-managed progress notes
|
||||
├── iteration.log # JSON log of each iteration
|
||||
└── spec.hash # Hash for detecting spec changes
|
||||
```
|
||||
|
||||
The scratchpad is managed by the LLM itself - after each task, the AI appends notes about what was done, decisions made, and files changed. This helps future iterations skip exploration.
|
||||
|
||||
## Supported Agents
|
||||
|
||||
| Agent | Status |
|
||||
|-------|--------|
|
||||
| Claude Code | Supported |
|
||||
| GitHub Copilot CLI | Supported |
|
||||
|
||||
The loop uses your configured default model for each agent.
|
||||
|
||||
## Example Session
|
||||
|
||||
```
|
||||
$ plan2code-loop
|
||||
|
||||
╭──────────────────────────────────────╮
|
||||
│ │
|
||||
│ 🔮 Plany's Loop │
|
||||
│ Autonomous Implementation │
|
||||
│ │
|
||||
╰──────────────────────────────────────╯
|
||||
|
||||
Found spec: specs/todo-app
|
||||
Feature: Todo App
|
||||
Phases: 0/3
|
||||
Tasks: 0/15
|
||||
|
||||
══════════════════════════════════════════════
|
||||
Spec: Todo App
|
||||
══════════════════════════════════════════════
|
||||
Phases: 0/3
|
||||
Tasks: 0/15
|
||||
|
||||
? JIRA Ticket ID (optional): PROJ-123
|
||||
? Select AI agent: Claude Code
|
||||
? Tasks per loop iteration: One task per loop (default)
|
||||
? Maximum iterations: 100
|
||||
|
||||
Starting Plan2Code Loop
|
||||
══════════════════════════════════════════════
|
||||
Agent: Claude Code
|
||||
Model: default
|
||||
Spec: C:\projects\my-app\specs\todo-app
|
||||
Loop mode: One task per loop
|
||||
Max iterations: 100
|
||||
|
||||
Iteration 1/100
|
||||
[1/100] Task 1.1: Initialize project with Vite (45s)
|
||||
✓ Completed: Task 1.1: Initialize project with Vite
|
||||
|
||||
Iteration 2/100
|
||||
[2/100] Task 1.2: Configure TypeScript (32s)
|
||||
✓ Completed: Task 1.2: Configure TypeScript
|
||||
|
||||
...
|
||||
|
||||
Session Summary
|
||||
══════════════════════════════════════════════
|
||||
Total iterations: 12
|
||||
Tasks completed: 12
|
||||
Exit reason: all_complete
|
||||
|
||||
Session files saved to specs/todo-app/.plan2code-loop:
|
||||
- config.json (session configuration)
|
||||
- scratchpad.md (LLM-managed notes)
|
||||
- iteration.log (history)
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Build
|
||||
npm run build
|
||||
|
||||
# Link for global usage
|
||||
npm link
|
||||
|
||||
# Unlink
|
||||
npm unlink
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
src/
|
||||
├── bin/plan2code-loop.ts # CLI entry point
|
||||
├── index.ts # Main exports
|
||||
├── controller.ts # Loop orchestration
|
||||
├── cli.ts # Interactive prompts
|
||||
├── agents/ # Agent implementations
|
||||
│ ├── claude-code.ts
|
||||
│ └── copilot-cli.ts
|
||||
├── prompt/ # Prompt building
|
||||
│ ├── templates.ts
|
||||
│ └── builder.ts
|
||||
├── state/ # Session state management
|
||||
│ └── manager.ts
|
||||
├── spec/ # Spec utilities (for CLI display)
|
||||
│ └── utils.ts
|
||||
└── utils/ # Utilities
|
||||
├── completion.ts # Marker parsing
|
||||
└── logger.ts
|
||||
```
|
||||
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"name": "plan2code-loop",
|
||||
"version": "1.6.2",
|
||||
"description": "Plan2Code Loop - Autonomous spec-driven implementation CLI",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"plan2code-loop": "./dist/bin/plan2code-loop.js"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"keywords": [
|
||||
"cli",
|
||||
"ai",
|
||||
"agent",
|
||||
"automation",
|
||||
"claude",
|
||||
"copilot",
|
||||
"spec-driven"
|
||||
],
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"dev": "tsup --watch",
|
||||
"start": "node dist/bin/plan2code-loop.js",
|
||||
"prepublishOnly": "npm run build"
|
||||
},
|
||||
"dependencies": {
|
||||
"@inquirer/prompts": "^8.1.0",
|
||||
"chalk": "^5.6.2",
|
||||
"execa": "^9.6.1",
|
||||
"fs-extra": "^11.3.3",
|
||||
"ora": "^9.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/node": "^25.0.3",
|
||||
"tsup": "^8.5.1",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
import type { Agent, AgentConfig, AgentExecutionOptions, AgentExecutionResult } from './types.js';
|
||||
import { executeCommand } from '../utils/process.js';
|
||||
import { writeFileSync, unlinkSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { tmpdir } from 'os';
|
||||
|
||||
const claudeCodeConfig: AgentConfig = {
|
||||
name: 'claude-code',
|
||||
displayName: 'Claude Code',
|
||||
command: 'claude',
|
||||
models: [
|
||||
{ value: 'default', label: 'Default (use Claude config)' },
|
||||
],
|
||||
defaultModel: 'default',
|
||||
flags: {
|
||||
prompt: '--print',
|
||||
model: '--model',
|
||||
skipPermissions: '--dangerously-skip-permissions',
|
||||
},
|
||||
};
|
||||
|
||||
class ClaudeCodeAgent implements Agent {
|
||||
readonly config = claudeCodeConfig;
|
||||
|
||||
async execute(options: AgentExecutionOptions): Promise<AgentExecutionResult> {
|
||||
// Write prompt to temp file - more reliable than stdin on Windows
|
||||
const tempFile = join(tmpdir(), `plan2code-prompt-${Date.now()}.txt`);
|
||||
writeFileSync(tempFile, options.prompt, 'utf-8');
|
||||
|
||||
try {
|
||||
// Build args: flags first, then read prompt from temp file via shell
|
||||
const args: string[] = [
|
||||
this.config.flags.prompt, // --print for non-interactive mode
|
||||
this.config.flags.skipPermissions,
|
||||
];
|
||||
|
||||
// Only add --model if not using default
|
||||
if (options.model && options.model !== 'default') {
|
||||
args.push(this.config.flags.model, options.model);
|
||||
}
|
||||
|
||||
// Use stdin from the temp file
|
||||
const result = await executeCommand({
|
||||
command: this.config.command,
|
||||
args,
|
||||
cwd: options.cwd,
|
||||
timeout: options.timeout,
|
||||
signal: options.signal,
|
||||
stdinFile: tempFile,
|
||||
});
|
||||
|
||||
return {
|
||||
stdout: result.stdout,
|
||||
stderr: result.stderr,
|
||||
exitCode: result.exitCode,
|
||||
timedOut: result.timedOut,
|
||||
cancelled: result.cancelled,
|
||||
duration: result.duration,
|
||||
};
|
||||
} finally {
|
||||
// Clean up temp file
|
||||
try {
|
||||
unlinkSync(tempFile);
|
||||
} catch {
|
||||
// Ignore cleanup errors
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async isAvailable(): Promise<boolean> {
|
||||
// Run claude --version to verify it's actually installed and working
|
||||
const result = await executeCommand({
|
||||
command: this.config.command,
|
||||
args: ['--version'],
|
||||
cwd: process.cwd(),
|
||||
timeout: 5000,
|
||||
});
|
||||
return result.exitCode === 0;
|
||||
}
|
||||
}
|
||||
|
||||
export const claudeCodeAgent = new ClaudeCodeAgent();
|
||||
@@ -0,0 +1,70 @@
|
||||
import type { Agent, AgentConfig, AgentExecutionOptions, AgentExecutionResult } from './types.js';
|
||||
import { executeCommand } from '../utils/process.js';
|
||||
|
||||
const copilotCliConfig: AgentConfig = {
|
||||
name: 'copilot-cli',
|
||||
displayName: 'GitHub Copilot CLI',
|
||||
command: 'copilot',
|
||||
models: [
|
||||
{ value: 'claude-sonnet-4', label: 'Claude Sonnet 4 (Default)' },
|
||||
{ value: 'claude-sonnet-4.5', label: 'Claude Sonnet 4.5' },
|
||||
{ value: 'claude-opus-4.5', label: 'Claude Opus 4.5' },
|
||||
{ value: 'gpt-5', label: 'GPT-5' },
|
||||
{ value: 'gpt-5-mini', label: 'GPT-5 Mini' },
|
||||
{ value: 'gemini-3-pro-preview', label: 'Gemini 3 Pro' },
|
||||
],
|
||||
defaultModel: 'claude-sonnet-4',
|
||||
flags: {
|
||||
prompt: '-p',
|
||||
model: '--model',
|
||||
skipPermissions: '--allow-all-tools',
|
||||
silent: '-s',
|
||||
},
|
||||
};
|
||||
|
||||
class CopilotCliAgent implements Agent {
|
||||
readonly config = copilotCliConfig;
|
||||
|
||||
async execute(options: AgentExecutionOptions): Promise<AgentExecutionResult> {
|
||||
// Use stdin for prompt to handle multi-line text properly
|
||||
const args: string[] = [];
|
||||
|
||||
// Only add --model if not using default
|
||||
if (options.model && options.model !== 'default') {
|
||||
args.push(this.config.flags.model, options.model);
|
||||
}
|
||||
|
||||
args.push(this.config.flags.skipPermissions, this.config.flags.silent!);
|
||||
|
||||
const result = await executeCommand({
|
||||
command: this.config.command,
|
||||
args,
|
||||
cwd: options.cwd,
|
||||
timeout: options.timeout,
|
||||
signal: options.signal,
|
||||
stdin: options.prompt,
|
||||
});
|
||||
|
||||
return {
|
||||
stdout: result.stdout,
|
||||
stderr: result.stderr,
|
||||
exitCode: result.exitCode,
|
||||
timedOut: result.timedOut,
|
||||
cancelled: result.cancelled,
|
||||
duration: result.duration,
|
||||
};
|
||||
}
|
||||
|
||||
async isAvailable(): Promise<boolean> {
|
||||
// Run copilot --version to verify it's installed
|
||||
const result = await executeCommand({
|
||||
command: this.config.command,
|
||||
args: ['--version'],
|
||||
cwd: process.cwd(),
|
||||
timeout: 5000,
|
||||
});
|
||||
return result.exitCode === 0;
|
||||
}
|
||||
}
|
||||
|
||||
export const copilotCliAgent = new CopilotCliAgent();
|
||||
@@ -0,0 +1,19 @@
|
||||
export type {
|
||||
Agent,
|
||||
AgentConfig,
|
||||
AgentExecutionOptions,
|
||||
AgentExecutionResult,
|
||||
ModelOption,
|
||||
} from './types.js';
|
||||
|
||||
export { agentRegistry } from './registry.js';
|
||||
export { claudeCodeAgent } from './claude-code.js';
|
||||
export { copilotCliAgent } from './copilot-cli.js';
|
||||
|
||||
// Register all agents
|
||||
import { agentRegistry } from './registry.js';
|
||||
import { claudeCodeAgent } from './claude-code.js';
|
||||
import { copilotCliAgent } from './copilot-cli.js';
|
||||
|
||||
agentRegistry.register(claudeCodeAgent);
|
||||
agentRegistry.register(copilotCliAgent);
|
||||
@@ -0,0 +1,34 @@
|
||||
import type { Agent } from './types.js';
|
||||
|
||||
class AgentRegistry {
|
||||
private agents: Map<string, Agent> = new Map();
|
||||
|
||||
register(agent: Agent): void {
|
||||
this.agents.set(agent.config.name, agent);
|
||||
}
|
||||
|
||||
get(name: string): Agent | undefined {
|
||||
return this.agents.get(name);
|
||||
}
|
||||
|
||||
getAll(): Agent[] {
|
||||
return Array.from(this.agents.values());
|
||||
}
|
||||
|
||||
getAvailable(): Promise<Agent[]> {
|
||||
return Promise.all(
|
||||
this.getAll().map(async (agent) => ({
|
||||
agent,
|
||||
available: await agent.isAvailable(),
|
||||
}))
|
||||
).then((results) =>
|
||||
results.filter((r) => r.available).map((r) => r.agent)
|
||||
);
|
||||
}
|
||||
|
||||
getNames(): string[] {
|
||||
return Array.from(this.agents.keys());
|
||||
}
|
||||
}
|
||||
|
||||
export const agentRegistry = new AgentRegistry();
|
||||
@@ -0,0 +1,42 @@
|
||||
export interface ModelOption {
|
||||
value: string;
|
||||
label: string;
|
||||
}
|
||||
|
||||
export interface AgentConfig {
|
||||
name: string;
|
||||
displayName: string;
|
||||
command: string;
|
||||
models: ModelOption[];
|
||||
defaultModel: string;
|
||||
flags: {
|
||||
prompt: string;
|
||||
model: string;
|
||||
skipPermissions: string;
|
||||
silent?: string;
|
||||
};
|
||||
}
|
||||
|
||||
export interface AgentExecutionOptions {
|
||||
prompt: string;
|
||||
model: string;
|
||||
timeout: number; // milliseconds
|
||||
verbose: boolean;
|
||||
cwd: string;
|
||||
signal?: AbortSignal; // For cancellation
|
||||
}
|
||||
|
||||
export interface AgentExecutionResult {
|
||||
stdout: string;
|
||||
stderr: string;
|
||||
exitCode: number;
|
||||
timedOut: boolean;
|
||||
cancelled: boolean;
|
||||
duration: number; // milliseconds
|
||||
}
|
||||
|
||||
export interface Agent {
|
||||
config: AgentConfig;
|
||||
execute(options: AgentExecutionOptions): Promise<AgentExecutionResult>;
|
||||
isAvailable(): Promise<boolean>;
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
import { run } from '../index.js';
|
||||
import { logger } from '../utils/index.js';
|
||||
|
||||
async function main() {
|
||||
try {
|
||||
const result = await run();
|
||||
|
||||
if (!result) {
|
||||
process.exit(0);
|
||||
}
|
||||
|
||||
// Exit codes per spec
|
||||
switch (result.exitReason) {
|
||||
case 'all_complete':
|
||||
logger.success('Loop completed successfully - all tasks done!');
|
||||
process.exit(0);
|
||||
case 'max_iterations':
|
||||
logger.warning('Loop ended: max iterations reached');
|
||||
process.exit(1);
|
||||
case 'interrupted':
|
||||
logger.info('Loop interrupted by user');
|
||||
process.exit(2);
|
||||
case 'error':
|
||||
logger.error('Loop ended with error');
|
||||
process.exit(3);
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
logger.error(error instanceof Error ? error.message : String(error));
|
||||
process.exit(3);
|
||||
}
|
||||
}
|
||||
|
||||
main();
|
||||
@@ -0,0 +1,240 @@
|
||||
import path from 'path';
|
||||
import { confirm, input, select } from '@inquirer/prompts';
|
||||
import { agentRegistry } from './agents/index.js';
|
||||
import { StateManager, type SessionConfig, type LoopMode } from './state/index.js';
|
||||
import { detectSpecDirectories, getSpecProgress } from './spec/utils.js';
|
||||
import { logger } from './utils/index.js';
|
||||
|
||||
export interface SessionSetupResult {
|
||||
config: SessionConfig;
|
||||
isResume: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect and select a spec directory
|
||||
*/
|
||||
async function selectSpec(cwd: string = process.cwd()): Promise<string | null> {
|
||||
// Auto-detect spec directories
|
||||
const specDirs = await detectSpecDirectories(cwd);
|
||||
|
||||
if (specDirs.length === 0) {
|
||||
logger.error('No spec directories found!');
|
||||
logger.info('Expected: specs/<feature>/overview.md');
|
||||
logger.info('');
|
||||
logger.info('To get started:');
|
||||
logger.info('');
|
||||
logger.info('1. Create a spec using `plan2code-1-plan`');
|
||||
logger.info(' command in our AI Agent');
|
||||
logger.info('');
|
||||
logger.info('2. Come back here and run `plan2code-loop`');
|
||||
logger.info(' as an alternative to `plan2code-3-implement`');
|
||||
logger.info('');
|
||||
return null;
|
||||
}
|
||||
|
||||
if (specDirs.length === 1) {
|
||||
const spec = specDirs[0];
|
||||
const progress = await getSpecProgress(spec);
|
||||
logger.info(`Found spec: ${path.relative(cwd, spec)}`);
|
||||
logger.dim(` Feature: ${progress.featureName}`);
|
||||
logger.dim(` Phases: ${progress.totalPhases}`);
|
||||
return spec;
|
||||
}
|
||||
|
||||
// Multiple specs - let user choose
|
||||
const choices = await Promise.all(
|
||||
specDirs.map(async (spec) => {
|
||||
const progress = await getSpecProgress(spec);
|
||||
const relativePath = path.relative(cwd, spec);
|
||||
return {
|
||||
name: `${progress.featureName} (${progress.totalPhases} phases) - ${relativePath}`,
|
||||
value: spec,
|
||||
};
|
||||
})
|
||||
);
|
||||
|
||||
const selectedSpec = await select({
|
||||
message: 'Select spec to implement:',
|
||||
choices,
|
||||
});
|
||||
|
||||
return selectedSpec;
|
||||
}
|
||||
|
||||
/**
|
||||
* Select AI agent
|
||||
*/
|
||||
async function selectAgent(): Promise<string> {
|
||||
const allAgents = agentRegistry.getAll();
|
||||
|
||||
const agentName = await select({
|
||||
message: 'Select AI agent:',
|
||||
choices: allAgents.map((agent) => ({
|
||||
name: agent.config.displayName,
|
||||
value: agent.config.name,
|
||||
})),
|
||||
});
|
||||
|
||||
return agentName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prompt for JIRA ticket ID
|
||||
*/
|
||||
async function promptJiraTicketId(): Promise<string | undefined> {
|
||||
const ticketId = await input({
|
||||
message: 'JIRA Ticket ID (optional, for commit messages):',
|
||||
});
|
||||
|
||||
return ticketId.trim() || undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Select maximum iterations
|
||||
*/
|
||||
async function selectMaxIterations(): Promise<number> {
|
||||
const choices = [15, 30, 50, 75, 100, 125, 150, 200];
|
||||
|
||||
const max = await select({
|
||||
message: 'Maximum iterations:',
|
||||
choices: choices.map((n) => ({
|
||||
name: n.toString(),
|
||||
value: n,
|
||||
})),
|
||||
default: 100,
|
||||
});
|
||||
|
||||
return max;
|
||||
}
|
||||
|
||||
/**
|
||||
* Select loop mode: one task per loop or one phase per loop
|
||||
*/
|
||||
async function selectLoopMode(): Promise<LoopMode> {
|
||||
const mode = await select<LoopMode>({
|
||||
message: 'Tasks per loop iteration:',
|
||||
choices: [
|
||||
{
|
||||
name: 'One task per loop (default)',
|
||||
value: 'task' as LoopMode,
|
||||
},
|
||||
{
|
||||
name: 'One phase per loop (related tasks together)',
|
||||
value: 'phase' as LoopMode,
|
||||
},
|
||||
],
|
||||
default: 'task',
|
||||
});
|
||||
|
||||
return mode;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle existing session - returns action to take
|
||||
*/
|
||||
async function handleExistingSession(
|
||||
stateManager: StateManager,
|
||||
specPath: string
|
||||
): Promise<'continue' | 'fresh' | 'new'> {
|
||||
const state = await stateManager.detectSessionState(specPath);
|
||||
|
||||
if (state === 'new') {
|
||||
return 'new';
|
||||
}
|
||||
|
||||
if (state === 'continue') {
|
||||
const config = await stateManager.readConfig();
|
||||
const lastIter = config?.currentIteration ?? 0;
|
||||
|
||||
logger.info(`Found existing session at iteration ${lastIter}`);
|
||||
|
||||
const continueSession = await confirm({
|
||||
message: 'Continue previous session?',
|
||||
default: true,
|
||||
});
|
||||
|
||||
return continueSession ? 'continue' : 'fresh';
|
||||
}
|
||||
|
||||
if (state === 'changed') {
|
||||
logger.warning('Spec has changed since last session.');
|
||||
|
||||
const startFresh = await confirm({
|
||||
message: 'Start fresh? (This will clear previous progress)',
|
||||
default: false,
|
||||
});
|
||||
|
||||
return startFresh ? 'fresh' : 'continue';
|
||||
}
|
||||
|
||||
return 'new';
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup session via interactive prompts
|
||||
*/
|
||||
export async function setupSession(
|
||||
stateManager: StateManager
|
||||
): Promise<SessionSetupResult | null> {
|
||||
// Show Planny welcome
|
||||
logger.welcome();
|
||||
|
||||
// Select spec
|
||||
const specPath = await selectSpec(process.cwd());
|
||||
if (!specPath) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Set spec path on state manager for per-spec state directory
|
||||
stateManager.setSpecPath(specPath);
|
||||
|
||||
// Show spec progress
|
||||
const progress = await getSpecProgress(specPath);
|
||||
console.log();
|
||||
logger.header(`Spec: ${progress.featureName}`);
|
||||
logger.info(`Phases: ${progress.totalPhases}`);
|
||||
console.log();
|
||||
|
||||
// Check for existing session
|
||||
const sessionAction = await handleExistingSession(stateManager, specPath);
|
||||
|
||||
if (sessionAction === 'continue') {
|
||||
const existingConfig = await stateManager.readConfig();
|
||||
if (existingConfig) {
|
||||
const agent = await selectAgent();
|
||||
existingConfig.agent = agent;
|
||||
await stateManager.writeConfig(existingConfig);
|
||||
logger.info('Resuming previous session...');
|
||||
return { config: existingConfig, isResume: true };
|
||||
}
|
||||
}
|
||||
|
||||
if (sessionAction === 'fresh') {
|
||||
await stateManager.clearState();
|
||||
}
|
||||
|
||||
// Collect new session configuration
|
||||
const jiraTicketId = await promptJiraTicketId();
|
||||
const agent = await selectAgent();
|
||||
const loopMode = await selectLoopMode();
|
||||
const maxIterations = await selectMaxIterations();
|
||||
|
||||
const config: SessionConfig = {
|
||||
agent,
|
||||
model: 'default',
|
||||
maxIterations,
|
||||
specPath,
|
||||
timeout: 3,
|
||||
maxRetries: 5,
|
||||
verbose: false,
|
||||
startedAt: new Date().toISOString(),
|
||||
currentIteration: 0,
|
||||
jiraTicketId,
|
||||
loopMode,
|
||||
};
|
||||
|
||||
// Initialize session
|
||||
await stateManager.initializeNewSession(config);
|
||||
|
||||
return { config, isResume: false };
|
||||
}
|
||||
@@ -0,0 +1,522 @@
|
||||
import { agentRegistry, type Agent, type AgentExecutionResult } from './agents/index.js';
|
||||
import { StateManager, type SessionConfig, type IterationLogEntry } from './state/index.js';
|
||||
import { buildLoopPrompt } from './prompt/index.js';
|
||||
import { checkForCompletion, checkForAllCompletions, logger, ensureGitRepo, ensureGitignore, type CompletionCheckResult } from './utils/index.js';
|
||||
|
||||
export interface TaskCompleteInfo {
|
||||
marker: string;
|
||||
taskId?: string;
|
||||
taskName?: string;
|
||||
}
|
||||
|
||||
export interface ControllerOptions {
|
||||
config: SessionConfig;
|
||||
stateManager: StateManager;
|
||||
onIteration?: (iteration: number, max: number) => void;
|
||||
onTaskComplete?: (info: TaskCompleteInfo) => void | Promise<void>;
|
||||
onLoopComplete?: () => void;
|
||||
}
|
||||
|
||||
export interface LoopResult {
|
||||
completed: boolean;
|
||||
iterations: number;
|
||||
finalMarker?: string;
|
||||
exitReason: 'all_complete' | 'max_iterations' | 'interrupted' | 'error';
|
||||
tasksCompleted: number;
|
||||
prereqsCompleted: number;
|
||||
error?: Error;
|
||||
}
|
||||
|
||||
export class Controller {
|
||||
private readonly config: SessionConfig;
|
||||
private readonly stateManager: StateManager;
|
||||
private readonly agent: Agent;
|
||||
private readonly onIteration?: (iteration: number, max: number) => void;
|
||||
private readonly onTaskComplete?: (info: TaskCompleteInfo) => void | Promise<void>;
|
||||
private readonly onLoopComplete?: () => void;
|
||||
private interrupted = false;
|
||||
private abortController: AbortController | null = null;
|
||||
private tasksCompleted = 0;
|
||||
private prereqsCompleted = 0;
|
||||
|
||||
constructor(options: ControllerOptions) {
|
||||
this.config = options.config;
|
||||
this.stateManager = options.stateManager;
|
||||
this.onIteration = options.onIteration;
|
||||
this.onTaskComplete = options.onTaskComplete;
|
||||
this.onLoopComplete = options.onLoopComplete;
|
||||
|
||||
const agent = agentRegistry.get(this.config.agent);
|
||||
if (!agent) {
|
||||
throw new Error(`Agent not found: ${this.config.agent}`);
|
||||
}
|
||||
this.agent = agent;
|
||||
}
|
||||
|
||||
private async buildPrompt(): Promise<string> {
|
||||
return buildLoopPrompt({
|
||||
specPath: this.config.specPath,
|
||||
iteration: this.config.currentIteration + 1,
|
||||
maxIterations: this.config.maxIterations,
|
||||
stateManager: this.stateManager,
|
||||
loopMode: this.config.loopMode || 'task',
|
||||
jiraTicketId: this.config.jiraTicketId,
|
||||
});
|
||||
}
|
||||
|
||||
private computeTimeoutMs(attempt: number): number {
|
||||
const baseMs = this.config.timeout * 60 * 1000;
|
||||
return baseMs + (attempt * 30 * 1000);
|
||||
}
|
||||
|
||||
private formatDuration(ms: number): string {
|
||||
const totalSec = Math.round(ms / 1000);
|
||||
const min = Math.floor(totalSec / 60);
|
||||
const sec = totalSec % 60;
|
||||
if (min === 0) return `${sec}s`;
|
||||
if (sec === 0) return `${min}m`;
|
||||
return `${min}m ${sec}s`;
|
||||
}
|
||||
|
||||
private async executeWithRetry(prompt: string, iterNum: number): Promise<AgentExecutionResult | 'fatal_timeout'> {
|
||||
const maxAttempts = (this.config.maxRetries ?? 5) + 1;
|
||||
|
||||
for (let attempt = 0; attempt < maxAttempts; attempt++) {
|
||||
const timeoutMs = this.computeTimeoutMs(attempt);
|
||||
|
||||
if (attempt > 0) {
|
||||
const prevTimeoutMs = this.computeTimeoutMs(attempt - 1);
|
||||
logger.warning(
|
||||
`Timed out after ${this.formatDuration(prevTimeoutMs)}, retrying (${attempt}/${maxAttempts - 1})...`
|
||||
);
|
||||
}
|
||||
|
||||
const spinnerBase = attempt > 0
|
||||
? `Waiting for AI Agent response (retry ${attempt}/${maxAttempts - 1})`
|
||||
: 'Waiting for AI Agent response (please be patient)';
|
||||
const spinner = logger.spinner(spinnerBase);
|
||||
const startTime = Date.now();
|
||||
|
||||
const elapsedInterval = setInterval(() => {
|
||||
const elapsed = Math.round((Date.now() - startTime) / 1000);
|
||||
spinner.text = `${spinnerBase} ... (${elapsed}s)`;
|
||||
}, 1000);
|
||||
|
||||
const result = await this.executeIteration(prompt, timeoutMs);
|
||||
clearInterval(elapsedInterval);
|
||||
spinner.stop();
|
||||
|
||||
// Cancelled or interrupted — return immediately, don't retry
|
||||
if (result.cancelled || this.interrupted) {
|
||||
return result;
|
||||
}
|
||||
|
||||
// Completed (success or error exit code) — return to caller
|
||||
if (!result.timedOut) {
|
||||
return result;
|
||||
}
|
||||
|
||||
// Timed out — retry if attempts remain, otherwise fatal
|
||||
if (attempt < maxAttempts - 1) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// All attempts exhausted
|
||||
logger.error(
|
||||
`Iteration ${iterNum} timed out on all ${maxAttempts} attempt${maxAttempts === 1 ? '' : 's'}. Stopping loop.`
|
||||
);
|
||||
const entry: IterationLogEntry = {
|
||||
iteration: iterNum,
|
||||
timestamp: new Date().toISOString(),
|
||||
duration: result.duration,
|
||||
exitCode: -1,
|
||||
status: 'timeout',
|
||||
};
|
||||
await this.stateManager.appendIterationLog(entry);
|
||||
return 'fatal_timeout';
|
||||
}
|
||||
|
||||
return 'fatal_timeout'; // unreachable, satisfies TS
|
||||
}
|
||||
|
||||
private async executeIteration(prompt: string, timeoutMs: number): Promise<AgentExecutionResult> {
|
||||
// Create new AbortController for this iteration
|
||||
this.abortController = new AbortController();
|
||||
|
||||
const result = await this.agent.execute({
|
||||
prompt,
|
||||
model: this.config.model,
|
||||
timeout: timeoutMs,
|
||||
verbose: this.config.verbose,
|
||||
cwd: process.cwd(),
|
||||
signal: this.abortController.signal,
|
||||
});
|
||||
|
||||
this.abortController = null;
|
||||
return result;
|
||||
}
|
||||
|
||||
private createLogEntry(
|
||||
result: AgentExecutionResult,
|
||||
status: IterationLogEntry['status'],
|
||||
marker?: string
|
||||
): IterationLogEntry {
|
||||
return {
|
||||
iteration: this.config.currentIteration + 1,
|
||||
timestamp: new Date().toISOString(),
|
||||
duration: result.duration,
|
||||
exitCode: result.exitCode,
|
||||
status,
|
||||
completionMarker: marker,
|
||||
};
|
||||
}
|
||||
|
||||
private formatTaskDisplay(completion: CompletionCheckResult): string {
|
||||
if (completion.taskId && completion.taskName) {
|
||||
return `Task ${completion.taskId}: ${completion.taskName}`;
|
||||
} else if (completion.taskId) {
|
||||
return `Task ${completion.taskId}`;
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
private displayIterationResult(result: AgentExecutionResult, iterNum: number, completion: CompletionCheckResult): void {
|
||||
const duration = Math.round(result.duration / 1000);
|
||||
const taskDisplay = this.formatTaskDisplay(completion);
|
||||
|
||||
// Show iteration completion with task info if available
|
||||
if (taskDisplay) {
|
||||
logger.iteration(iterNum, this.config.maxIterations, `${taskDisplay} (${duration}s)`);
|
||||
} else {
|
||||
logger.iteration(iterNum, this.config.maxIterations, `completed in ${duration}s`);
|
||||
}
|
||||
|
||||
// Verbose mode: show full output
|
||||
if (this.config.verbose) {
|
||||
console.log();
|
||||
logger.dim('--- Agent Output ---');
|
||||
console.log(result.stdout);
|
||||
if (result.stderr) {
|
||||
logger.dim('--- Agent Stderr ---');
|
||||
console.log(result.stderr);
|
||||
}
|
||||
logger.dim('--- End Output ---');
|
||||
console.log();
|
||||
} else if (result.exitCode !== 0 && result.stderr.trim()) {
|
||||
logger.error(` ${result.stderr.trim().split('\n')[0]}`);
|
||||
}
|
||||
}
|
||||
|
||||
async run(): Promise<LoopResult> {
|
||||
// Pre-flight: verify agent CLI is available
|
||||
const isAvailable = await this.agent.isAvailable();
|
||||
if (!isAvailable) {
|
||||
logger.error(`"${this.agent.config.displayName}" is not available!`);
|
||||
logger.info(`Please ensure the "${this.agent.config.command}" command is installed and available in your PATH.`);
|
||||
throw new Error(`Agent "${this.agent.config.displayName}" is not available. Please install it and try again.`);
|
||||
}
|
||||
|
||||
// Ensure git repo and .gitignore are set up before any iterations
|
||||
const gitReady = await ensureGitRepo(process.cwd());
|
||||
if (!gitReady) {
|
||||
throw new Error('Failed to initialize a git repository in the current working directory. Cannot start Plan2Code Loop.');
|
||||
}
|
||||
ensureGitignore(process.cwd());
|
||||
|
||||
const loopModeLabel = (this.config.loopMode || 'task') === 'phase' ? 'One phase per loop' : 'One task per loop';
|
||||
logger.header('Starting Plan2Code Loop');
|
||||
logger.info(`Agent: ${this.agent.config.displayName}`);
|
||||
logger.info(`Model: ${this.config.model}`);
|
||||
logger.info(`Spec: ${this.config.specPath}`);
|
||||
logger.info(`Loop mode: ${loopModeLabel}`);
|
||||
logger.info(`Max iterations: ${this.config.maxIterations}`);
|
||||
console.log();
|
||||
|
||||
while (this.config.currentIteration < this.config.maxIterations) {
|
||||
if (this.interrupted) {
|
||||
return {
|
||||
completed: false,
|
||||
iterations: this.config.currentIteration,
|
||||
exitReason: 'interrupted',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
};
|
||||
}
|
||||
|
||||
const iterNum = this.config.currentIteration + 1;
|
||||
this.onIteration?.(iterNum, this.config.maxIterations);
|
||||
|
||||
console.log();
|
||||
logger.info(`Iteration ${iterNum}/${this.config.maxIterations}`);
|
||||
|
||||
// Build prompt - simple, just spec path and iteration info
|
||||
const prompt = await this.buildPrompt();
|
||||
|
||||
try {
|
||||
const retryResult = await this.executeWithRetry(prompt, iterNum);
|
||||
|
||||
if (retryResult === 'fatal_timeout') {
|
||||
return {
|
||||
completed: false,
|
||||
iterations: this.config.currentIteration,
|
||||
exitReason: 'error',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
error: new Error(`Iteration ${iterNum} failed after all retry attempts`),
|
||||
};
|
||||
}
|
||||
|
||||
const result = retryResult;
|
||||
|
||||
// Check if cancelled
|
||||
if (result.cancelled || this.interrupted) {
|
||||
logger.info('Agent process cancelled');
|
||||
|
||||
const entry: IterationLogEntry = {
|
||||
iteration: iterNum,
|
||||
timestamp: new Date().toISOString(),
|
||||
duration: result.duration,
|
||||
exitCode: -1,
|
||||
status: 'interrupted',
|
||||
};
|
||||
await this.stateManager.appendIterationLog(entry);
|
||||
|
||||
return {
|
||||
completed: false,
|
||||
iterations: this.config.currentIteration,
|
||||
exitReason: 'interrupted',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
};
|
||||
}
|
||||
|
||||
// Branch completion handling based on loop mode
|
||||
const isPhaseMode = (this.config.loopMode || 'task') === 'phase';
|
||||
|
||||
if (isPhaseMode) {
|
||||
// Phase mode: parse ALL completion markers from output
|
||||
const allCompletions = checkForAllCompletions(result.stdout + result.stderr);
|
||||
|
||||
// Determine status
|
||||
let status: IterationLogEntry['status'] = 'running';
|
||||
if (allCompletions.tasks.length > 0 || allCompletions.loopComplete || allCompletions.phaseComplete) {
|
||||
const hasBlocked = allCompletions.tasks.some(t => t.marker === 'TASK_BLOCKED');
|
||||
const hasCompleted = allCompletions.tasks.some(t => t.marker === 'TASK_COMPLETE' || t.marker === 'PREREQ_COMPLETE' || t.marker === 'PREREQ_ASSUMED');
|
||||
status = hasCompleted || allCompletions.phaseComplete || allCompletions.loopComplete ? 'completed' : hasBlocked ? 'blocked' : 'running';
|
||||
} else if (result.timedOut) {
|
||||
status = 'timeout';
|
||||
} else if (result.exitCode !== 0) {
|
||||
status = 'error';
|
||||
}
|
||||
|
||||
// Log iteration with count of tasks
|
||||
const markerSummary = allCompletions.tasks.map(t => `${t.marker}: ${t.taskId}`).join(', ');
|
||||
const logEntry = this.createLogEntry(result, status, markerSummary || undefined);
|
||||
await this.stateManager.appendIterationLog(logEntry);
|
||||
|
||||
// Display each completed task
|
||||
const duration = Math.round(result.duration / 1000);
|
||||
for (const task of allCompletions.tasks) {
|
||||
if (task.marker === 'TASK_COMPLETE') {
|
||||
this.tasksCompleted++;
|
||||
const taskDisplay = this.formatTaskDisplay(task);
|
||||
logger.success(taskDisplay ? `Completed: ${taskDisplay}` : 'Task completed!');
|
||||
} else if (task.marker === 'PREREQ_COMPLETE') {
|
||||
this.prereqsCompleted++;
|
||||
const prereqDisplay = task.taskId && task.taskName
|
||||
? `Prereq ${task.taskId}: ${task.taskName}`
|
||||
: task.taskId ? `Prereq ${task.taskId}` : 'Prerequisite';
|
||||
logger.success(`Verified: ${prereqDisplay}`);
|
||||
} else if (task.marker === 'PREREQ_ASSUMED') {
|
||||
this.prereqsCompleted++;
|
||||
const prereqDisplay = task.taskId && task.taskName
|
||||
? `Prereq ${task.taskId}: ${task.taskName}`
|
||||
: task.taskId ? `Prereq ${task.taskId}` : 'Prerequisite';
|
||||
logger.success(`Assumed: ${prereqDisplay}`);
|
||||
} else if (task.marker === 'TASK_BLOCKED') {
|
||||
const blockInfo = task.taskId
|
||||
? `Task ${task.taskId} blocked: ${task.reason || 'Unknown reason'}`
|
||||
: `Task blocked: ${task.reason || 'Unknown reason'}`;
|
||||
logger.warning(blockInfo);
|
||||
}
|
||||
}
|
||||
|
||||
// Show phase-level summary
|
||||
if (allCompletions.tasks.length > 0) {
|
||||
const completedCount = allCompletions.tasks.filter(t => t.marker === 'TASK_COMPLETE').length;
|
||||
const prereqCount = allCompletions.tasks.filter(t => t.marker === 'PREREQ_COMPLETE' || t.marker === 'PREREQ_ASSUMED').length;
|
||||
const blockedCount = allCompletions.tasks.filter(t => t.marker === 'TASK_BLOCKED').length;
|
||||
const parts: string[] = [];
|
||||
if (completedCount > 0) parts.push(`${completedCount} task(s) completed`);
|
||||
if (prereqCount > 0) parts.push(`${prereqCount} prereq(s) verified`);
|
||||
if (blockedCount > 0) parts.push(`${blockedCount} blocked`);
|
||||
logger.iteration(iterNum, this.config.maxIterations,
|
||||
`Phase done: ${parts.join(', ')} (${duration}s)`);
|
||||
} else {
|
||||
logger.iteration(iterNum, this.config.maxIterations, `completed in ${duration}s`);
|
||||
}
|
||||
|
||||
// Verbose output
|
||||
if (this.config.verbose) {
|
||||
console.log();
|
||||
logger.dim('--- Agent Output ---');
|
||||
console.log(result.stdout);
|
||||
if (result.stderr) {
|
||||
logger.dim('--- Agent Stderr ---');
|
||||
console.log(result.stderr);
|
||||
}
|
||||
logger.dim('--- End Output ---');
|
||||
console.log();
|
||||
} else if (result.exitCode !== 0 && result.stderr.trim()) {
|
||||
logger.error(` ${result.stderr.trim().split('\n')[0]}`);
|
||||
}
|
||||
|
||||
// Handle LOOP_COMPLETE
|
||||
if (allCompletions.loopComplete) {
|
||||
this.onLoopComplete?.();
|
||||
logger.success('All tasks complete!');
|
||||
return {
|
||||
completed: true,
|
||||
iterations: iterNum,
|
||||
finalMarker: 'LOOP_COMPLETE',
|
||||
exitReason: 'all_complete',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
};
|
||||
}
|
||||
} else {
|
||||
// Task mode (default): existing single-marker logic
|
||||
const completion = checkForCompletion(result.stdout + result.stderr);
|
||||
|
||||
// Determine status
|
||||
let status: IterationLogEntry['status'] = 'running';
|
||||
if (completion.completed) {
|
||||
if (completion.marker === 'TASK_BLOCKED') {
|
||||
status = 'blocked';
|
||||
} else {
|
||||
status = 'completed';
|
||||
}
|
||||
} else if (result.timedOut) {
|
||||
status = 'timeout';
|
||||
} else if (result.exitCode !== 0) {
|
||||
status = 'error';
|
||||
}
|
||||
|
||||
// Log iteration
|
||||
const logEntry = this.createLogEntry(result, status, completion.marker);
|
||||
await this.stateManager.appendIterationLog(logEntry);
|
||||
|
||||
// Display iteration result with task info from completion marker
|
||||
this.displayIterationResult(result, iterNum, completion);
|
||||
|
||||
// Handle completion markers
|
||||
if (completion.completed) {
|
||||
const taskDisplay = this.formatTaskDisplay(completion);
|
||||
|
||||
if (completion.marker === 'TASK_COMPLETE') {
|
||||
this.tasksCompleted++;
|
||||
await this.onTaskComplete?.({
|
||||
marker: completion.marker,
|
||||
taskId: completion.taskId,
|
||||
taskName: completion.taskName,
|
||||
});
|
||||
logger.success(taskDisplay ? `Completed: ${taskDisplay}` : 'Task completed!');
|
||||
} else if (completion.marker === 'PREREQ_COMPLETE' || completion.marker === 'PREREQ_ASSUMED') {
|
||||
this.prereqsCompleted++;
|
||||
await this.onTaskComplete?.({
|
||||
marker: completion.marker,
|
||||
taskId: completion.taskId,
|
||||
taskName: completion.taskName,
|
||||
});
|
||||
const prereqDisplay = completion.taskId && completion.taskName
|
||||
? `Prereq ${completion.taskId}: ${completion.taskName}`
|
||||
: completion.taskId ? `Prereq ${completion.taskId}` : 'Prerequisite';
|
||||
const verb = completion.marker === 'PREREQ_COMPLETE' ? 'Verified' : 'Assumed';
|
||||
logger.success(`${verb}: ${prereqDisplay}`);
|
||||
} else if (completion.marker === 'TASK_BLOCKED') {
|
||||
const blockInfo = completion.taskId
|
||||
? `Task ${completion.taskId} blocked: ${completion.reason || 'Unknown reason'}`
|
||||
: `Task blocked: ${completion.reason || 'Unknown reason'}`;
|
||||
logger.warning(blockInfo);
|
||||
} else if (completion.marker === 'LOOP_COMPLETE') {
|
||||
// Commit any final changes before completing
|
||||
this.tasksCompleted++;
|
||||
await this.onTaskComplete?.({
|
||||
marker: completion.marker,
|
||||
taskId: completion.taskId,
|
||||
taskName: completion.taskName || 'Final implementation complete',
|
||||
});
|
||||
this.onLoopComplete?.();
|
||||
logger.success('All tasks complete!');
|
||||
return {
|
||||
completed: true,
|
||||
iterations: iterNum,
|
||||
finalMarker: 'LOOP_COMPLETE',
|
||||
exitReason: 'all_complete',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Increment iteration and update spec hash (so resume doesn't see false changes)
|
||||
await this.stateManager.incrementIteration();
|
||||
await this.stateManager.updateSpecHash(this.config.specPath);
|
||||
this.config.currentIteration++;
|
||||
|
||||
// Handle error (but continue - LLM might recover)
|
||||
if (result.exitCode !== 0) {
|
||||
// In phase mode, check if any tasks completed despite error exit code
|
||||
const hasCompletions = isPhaseMode
|
||||
? checkForAllCompletions(result.stdout + result.stderr).tasks.length > 0
|
||||
: checkForCompletion(result.stdout + result.stderr).completed;
|
||||
if (!hasCompletions) {
|
||||
logger.warning(`Iteration ${iterNum} exited with code ${result.exitCode}, continuing...`);
|
||||
}
|
||||
}
|
||||
|
||||
} catch (error) {
|
||||
clearInterval(elapsedInterval);
|
||||
spinner.stop();
|
||||
logger.error(`Iteration ${iterNum} failed: ${error}`);
|
||||
|
||||
// Log the error
|
||||
const entry: IterationLogEntry = {
|
||||
iteration: iterNum,
|
||||
timestamp: new Date().toISOString(),
|
||||
duration: 0,
|
||||
exitCode: -1,
|
||||
status: 'error',
|
||||
};
|
||||
await this.stateManager.appendIterationLog(entry);
|
||||
|
||||
return {
|
||||
completed: false,
|
||||
iterations: this.config.currentIteration,
|
||||
exitReason: 'error',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
error: error instanceof Error ? error : new Error(String(error)),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Max iterations reached
|
||||
logger.warning('Max iterations reached');
|
||||
return {
|
||||
completed: false,
|
||||
iterations: this.config.currentIteration,
|
||||
exitReason: 'max_iterations',
|
||||
tasksCompleted: this.tasksCompleted,
|
||||
prereqsCompleted: this.prereqsCompleted,
|
||||
};
|
||||
}
|
||||
|
||||
interrupt(): void {
|
||||
this.interrupted = true;
|
||||
if (this.abortController) {
|
||||
this.abortController.abort();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
import path from 'path';
|
||||
import { StateManager } from './state/index.js';
|
||||
import { Controller, type LoopResult, type TaskCompleteInfo } from './controller.js';
|
||||
import { setupSession } from './cli.js';
|
||||
import { logger, createTaskCommit } from './utils/index.js';
|
||||
|
||||
export async function run(): Promise<LoopResult | null> {
|
||||
// Ensure agents are registered
|
||||
await import('./agents/index.js');
|
||||
|
||||
const stateManager = new StateManager();
|
||||
|
||||
const result = await setupSession(stateManager);
|
||||
if (!result) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const { config, isResume } = result;
|
||||
|
||||
if (isResume) {
|
||||
logger.info(`Resuming from iteration ${config.currentIteration}`);
|
||||
}
|
||||
|
||||
const controller = new Controller({
|
||||
config,
|
||||
stateManager,
|
||||
onIteration: (iter, max) => {
|
||||
// Could add git checkpoint logic here if needed
|
||||
},
|
||||
onTaskComplete: async (info: TaskCompleteInfo) => {
|
||||
// Create git commit for completed task
|
||||
const taskName = info.taskName || info.taskId || 'Task completed';
|
||||
await createTaskCommit({
|
||||
taskName,
|
||||
jiraTicketId: config.jiraTicketId,
|
||||
cwd: process.cwd(),
|
||||
});
|
||||
},
|
||||
onLoopComplete: () => {
|
||||
// All tasks completed callback
|
||||
},
|
||||
});
|
||||
|
||||
// Setup interrupt handler
|
||||
const handleInterrupt = () => {
|
||||
logger.warning('\nInterrupt received, saving state...');
|
||||
controller.interrupt();
|
||||
};
|
||||
|
||||
process.on('SIGINT', handleInterrupt);
|
||||
process.on('SIGTERM', handleInterrupt);
|
||||
|
||||
try {
|
||||
const loopResult = await controller.run();
|
||||
|
||||
// Display summary
|
||||
console.log();
|
||||
logger.header('Session Summary');
|
||||
logger.info(`Total iterations: ${loopResult.iterations}`);
|
||||
logger.info(`Tasks completed: ${loopResult.tasksCompleted}`);
|
||||
if (loopResult.prereqsCompleted > 0) {
|
||||
logger.info(`Prerequisites verified: ${loopResult.prereqsCompleted}`);
|
||||
}
|
||||
logger.info(`Exit reason: ${loopResult.exitReason}`);
|
||||
if (loopResult.finalMarker) {
|
||||
logger.info(`Completion marker: ${loopResult.finalMarker}`);
|
||||
}
|
||||
if (loopResult.error) {
|
||||
logger.error(`Error: ${loopResult.error.message}`);
|
||||
}
|
||||
|
||||
// Show completion celebration and finalize reminder when all phases complete
|
||||
if (loopResult.exitReason === 'all_complete') {
|
||||
logger.allPhasesComplete();
|
||||
}
|
||||
|
||||
// Show state file locations (now per-spec)
|
||||
console.log();
|
||||
logger.dim(`Session files saved to ${path.relative(process.cwd(), stateManager.getStateDir())}:`);
|
||||
logger.dim(' - config.json (session configuration)');
|
||||
logger.dim(' - scratchpad.md (LLM-managed notes)');
|
||||
logger.dim(' - iteration.log (history)');
|
||||
|
||||
return loopResult;
|
||||
} finally {
|
||||
process.off('SIGINT', handleInterrupt);
|
||||
process.off('SIGTERM', handleInterrupt);
|
||||
}
|
||||
}
|
||||
|
||||
// Re-export types and classes
|
||||
export { Controller, type ControllerOptions, type LoopResult, type TaskCompleteInfo } from './controller.js';
|
||||
export { StateManager } from './state/index.js';
|
||||
export { setupSession } from './cli.js';
|
||||
export { agentRegistry, type Agent, type AgentConfig } from './agents/index.js';
|
||||
export { detectSpecDirectories, getSpecProgress } from './spec/index.js';
|
||||
@@ -0,0 +1,39 @@
|
||||
import type { StateManager, LoopMode } from '../state/index.js';
|
||||
import { LOOP_PROMPT_TEMPLATE, LOOP_PROMPT_TEMPLATE_PHASE } from './templates.js';
|
||||
|
||||
export interface PromptContext {
|
||||
specPath: string;
|
||||
iteration: number;
|
||||
maxIterations: number;
|
||||
stateManager: StateManager;
|
||||
loopMode: LoopMode;
|
||||
jiraTicketId?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the prompt for the AI agent
|
||||
* Selects template based on loop mode (task vs phase)
|
||||
*/
|
||||
export async function buildLoopPrompt(context: PromptContext): Promise<string> {
|
||||
const { specPath, iteration, maxIterations, stateManager, loopMode, jiraTicketId } = context;
|
||||
|
||||
// Read scratchpad content for session continuity (LLM writes to this)
|
||||
const scratchpadContent = await stateManager.readScratchpad();
|
||||
|
||||
// Project root is where plan2code-loop was invoked from
|
||||
const projectRoot = process.cwd();
|
||||
|
||||
// Select template based on loop mode
|
||||
const template = loopMode === 'phase' ? LOOP_PROMPT_TEMPLATE_PHASE : LOOP_PROMPT_TEMPLATE;
|
||||
|
||||
// Template substitution
|
||||
const prompt = template
|
||||
.replace(/{{projectRoot}}/g, projectRoot)
|
||||
.replace(/{{specPath}}/g, specPath)
|
||||
.replace(/{{iteration}}/g, iteration.toString())
|
||||
.replace(/{{maxIterations}}/g, maxIterations.toString())
|
||||
.replace(/{{scratchpadContent}}/g, scratchpadContent || '(First iteration - no previous progress)')
|
||||
.replace(/{{jiraTicketId}}/g, jiraTicketId || '');
|
||||
|
||||
return prompt;
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
export {
|
||||
buildLoopPrompt,
|
||||
type PromptContext,
|
||||
} from './builder.js';
|
||||
|
||||
export { LOOP_PROMPT_TEMPLATE, LOOP_PROMPT_TEMPLATE_PHASE } from './templates.js';
|
||||
@@ -0,0 +1,200 @@
|
||||
export const LOOP_PROMPT_TEMPLATE = `# PLAN2CODE-LOOP: Autonomous Task Implementation
|
||||
|
||||
## CRITICAL CONSTRAINT
|
||||
**IMPLEMENT EXACTLY ONE TASK PER ITERATION.**
|
||||
Do NOT implement multiple tasks. Do NOT complete an entire phase.
|
||||
Find the FIRST unchecked task, implement ONLY that task, then STOP and report.
|
||||
|
||||
## Project Information
|
||||
- **Project Root:** \`{{projectRoot}}\`
|
||||
- **Spec Location:** \`{{specPath}}\`
|
||||
- Read \`AGENTS.md\` for project-specific guidance if available
|
||||
|
||||
## IMPORTANT: File Locations
|
||||
- Write ALL code files relative to the **project root** (\`{{projectRoot}}\`)
|
||||
- The spec directory (\`{{specPath}}\`) is for documentation ONLY - never write code there
|
||||
- Example: Create \`{{projectRoot}}/src/index.ts\`, NOT \`{{specPath}}/src/index.ts\`
|
||||
|
||||
## Iteration
|
||||
{{iteration}} of {{maxIterations}}
|
||||
|
||||
## Task Discovery Process
|
||||
1. Read \`{{specPath}}/overview.md\` to see all phases
|
||||
2. Find the FIRST phase with an unchecked checkbox (\`- [ ]\` or \`- [/]\`)
|
||||
3. Read that phase's file (e.g., \`phase-1.md\`)
|
||||
4. Check the \`## Prerequisites\` section FIRST
|
||||
5. Find the FIRST unverified prerequisite (no "VERIFIED" or "ASSUMED" annotation)
|
||||
- If found, verify/complete it, then annotate "VERIFIED" or "ASSUMED: [reason]" inline
|
||||
6. Only if ALL prerequisites are verified or assumed, find the FIRST unchecked task (\`- [ ]\`)
|
||||
7. That is your ONE task - implement ONLY that task
|
||||
|
||||
## Checkbox States (Task items only)
|
||||
- \`[ ]\` = incomplete/pending (do the FIRST one you find)
|
||||
- \`[x]\` = complete (skip)
|
||||
- \`[?]\` = assumed complete, couldn't verify (skip)
|
||||
- \`[!]\` = blocked (skip)
|
||||
|
||||
Prerequisites use plain bullets with inline annotations, not checkboxes.
|
||||
|
||||
## Implementation Steps
|
||||
1. Read and understand the single task
|
||||
2. Implement it completely
|
||||
3. Validate it works (run tests if applicable and double-check code)
|
||||
4. Mark ONLY that task's checkbox as \`[x]\` in the phase file
|
||||
5. If that was the LAST task in the phase, also mark the phase \`[x]\` in overview.md
|
||||
6. Output your completion marker and STOP
|
||||
|
||||
## Git Policy
|
||||
**DO NOT create git commits.** The orchestration system handles commits automatically after each task completion. Just implement the code and leave changes uncommitted.
|
||||
|
||||
## Completion Markers (REQUIRED FORMAT)
|
||||
Output exactly ONE of these at the end, including the task ID and description:
|
||||
|
||||
**PREREQ_COMPLETE: [prereq_id] - [description]**
|
||||
Example: \`PREREQ_COMPLETE: P1.1 - Verified Phase 1 complete\`
|
||||
|
||||
**PREREQ_ASSUMED: [prereq_id] - [description]**
|
||||
Example: \`PREREQ_ASSUMED: P2.1 - Design approval (cannot verify)\`
|
||||
|
||||
**TASK_COMPLETE: [task_id] - [task_description]**
|
||||
Example: \`TASK_COMPLETE: 1.1 - Initialize project structure\`
|
||||
|
||||
**TASK_BLOCKED: [task_id] - [reason]**
|
||||
Example: \`TASK_BLOCKED: 2.3 - Missing API credentials\`
|
||||
|
||||
**LOOP_COMPLETE**
|
||||
Use only when ALL phases in overview.md are marked complete.
|
||||
|
||||
## Scratchpad Management
|
||||
|
||||
After completing each task, add a new entry at the **bottom** of \`{{specPath}}/.plan2code-loop/scratchpad.md\`.
|
||||
Never edit, reorganize, or insert into existing content — only append new entries to the end of the file.
|
||||
|
||||
Each entry should include:
|
||||
- Task completed and Phase item reference
|
||||
- Key decisions made and reasoning
|
||||
- Files changed
|
||||
- Any blockers or notes for next iteration
|
||||
|
||||
Keep entries concise. Sacrifice grammar for concision. This file helps future iterations skip exploration.
|
||||
|
||||
If key patterns or learnings were discovered, update \`./AGENTS.md\` if it exists.
|
||||
|
||||
## Previous Session Context
|
||||
{{scratchpadContent}}
|
||||
|
||||
---
|
||||
|
||||
Remember: ONE TASK ONLY. Find it, implement it, mark it done, output TASK_COMPLETE with the task ID and description, then stop.
|
||||
`;
|
||||
|
||||
export const LOOP_PROMPT_TEMPLATE_PHASE = `# PLAN2CODE-LOOP: Autonomous Phase Implementation
|
||||
|
||||
## CRITICAL CONSTRAINT
|
||||
**IMPLEMENT ALL REMAINING TASKS IN THE CURRENT PHASE.**
|
||||
Find the first incomplete phase, then implement every remaining task in that phase before stopping.
|
||||
Complete each task fully before moving to the next task within the phase.
|
||||
|
||||
## Project Information
|
||||
- **Project Root:** \`{{projectRoot}}\`
|
||||
- **Spec Location:** \`{{specPath}}\`
|
||||
- Read \`AGENTS.md\` for project-specific guidance if available
|
||||
|
||||
## IMPORTANT: File Locations
|
||||
- Write ALL code files relative to the **project root** (\`{{projectRoot}}\`)
|
||||
- The spec directory (\`{{specPath}}\`) is for documentation ONLY - never write code there
|
||||
- Example: Create \`{{projectRoot}}/src/index.ts\`, NOT \`{{specPath}}/src/index.ts\`
|
||||
|
||||
## Iteration
|
||||
{{iteration}} of {{maxIterations}}
|
||||
|
||||
## Phase Discovery Process
|
||||
1. Read \`{{specPath}}/overview.md\` to see all phases
|
||||
2. Find the FIRST phase with an unchecked checkbox (\`- [ ]\` or \`- [/]\`)
|
||||
3. Read that phase's file (e.g., \`phase-1.md\`)
|
||||
4. Check the \`## Prerequisites\` section FIRST
|
||||
5. Verify ALL unverified prerequisites first, in order
|
||||
- Annotate each "VERIFIED" or "ASSUMED: [reason]" inline
|
||||
6. Once ALL prerequisites are verified, implement ALL unchecked tasks in order
|
||||
7. Continue until every task in the phase is marked \`[x]\`
|
||||
|
||||
## Checkbox States (Task items only)
|
||||
- \`[ ]\` = incomplete/pending
|
||||
- \`[x]\` = complete (skip)
|
||||
- \`[?]\` = assumed complete, couldn't verify (skip)
|
||||
- \`[!]\` = blocked (skip, note in scratchpad)
|
||||
|
||||
Prerequisites use plain bullets with inline annotations, not checkboxes.
|
||||
|
||||
## Implementation Steps (repeat for EACH task in the phase)
|
||||
1. Read and understand the task
|
||||
2. Implement it completely
|
||||
3. Validate it works (run tests if applicable and double-check code)
|
||||
4. Mark that task's checkbox as \`[x]\` in the phase file
|
||||
5. **Create a git commit** for this task (see Git Policy below)
|
||||
6. Output a TASK_COMPLETE marker for this task
|
||||
7. Move to the next unchecked task in the same phase
|
||||
8. When ALL tasks in the phase are done, mark the phase \`[x]\` in overview.md
|
||||
|
||||
## Git Policy
|
||||
**YOU are responsible for creating git commits after each task.** The orchestration system does NOT handle commits in phase mode.
|
||||
|
||||
After completing each task:
|
||||
\`\`\`bash
|
||||
git add -A
|
||||
git commit -m "<commit message>"
|
||||
\`\`\`
|
||||
|
||||
**Commit message format:**
|
||||
\`\`\`
|
||||
git add -A
|
||||
git commit -m "Task X.Y: description" -m "{{jiraTicketId}}" -m "AI Assisted"
|
||||
\`\`\`
|
||||
- With JIRA ticket: three \`-m\` flags (description, ticket ID, AI Assisted)
|
||||
- Without JIRA ticket: two \`-m\` flags (description, AI Assisted)
|
||||
- ALWAYS include "AI Assisted" as the final \`-m\` flag
|
||||
|
||||
Replace X.Y with the actual task ID and description with a concise summary of what was implemented.
|
||||
|
||||
## Completion Markers (REQUIRED FORMAT)
|
||||
Output one of these **after each task** you complete:
|
||||
|
||||
**PREREQ_COMPLETE: [prereq_id] - [description]**
|
||||
Example: \`PREREQ_COMPLETE: P1.1 - Verified Phase 1 complete\`
|
||||
|
||||
**PREREQ_ASSUMED: [prereq_id] - [description]**
|
||||
Example: \`PREREQ_ASSUMED: P2.1 - Design approval (cannot verify)\`
|
||||
|
||||
**TASK_COMPLETE: [task_id] - [task_description]**
|
||||
Example: \`TASK_COMPLETE: 1.1 - Initialize project structure\`
|
||||
|
||||
**TASK_BLOCKED: [task_id] - [reason]**
|
||||
Example: \`TASK_BLOCKED: 2.3 - Missing API credentials\`
|
||||
If a task is blocked, skip it and continue to the next task.
|
||||
|
||||
After ALL tasks in the phase are complete (or blocked), output:
|
||||
**PHASE_COMPLETE** - if only this phase is done
|
||||
**LOOP_COMPLETE** - if ALL phases in overview.md are now marked complete
|
||||
|
||||
## Scratchpad Management
|
||||
|
||||
After completing each task, add a new entry at the **bottom** of \`{{specPath}}/.plan2code-loop/scratchpad.md\`.
|
||||
Never edit, reorganize, or insert into existing content — only append new entries to the end of the file.
|
||||
|
||||
Each entry should include:
|
||||
- Task completed and Phase item reference
|
||||
- Key decisions made and reasoning
|
||||
- Files changed
|
||||
- Any blockers or notes for next iteration
|
||||
|
||||
Keep entries concise. Sacrifice grammar for concision. This file helps future iterations skip exploration.
|
||||
|
||||
If key patterns or learnings were discovered, update \`./AGENTS.md\` if it exists.
|
||||
|
||||
## Previous Session Context
|
||||
{{scratchpadContent}}
|
||||
|
||||
---
|
||||
|
||||
Remember: Complete ALL tasks in the current phase. Implement each task, commit it, output TASK_COMPLETE, then continue to the next. Stop only when the phase is done.
|
||||
`;
|
||||
@@ -0,0 +1,4 @@
|
||||
export {
|
||||
detectSpecDirectories,
|
||||
getSpecProgress,
|
||||
} from './utils.js';
|
||||
@@ -0,0 +1,70 @@
|
||||
import path from 'path';
|
||||
import fs from 'fs-extra';
|
||||
|
||||
/**
|
||||
* Auto-detect spec directories in the project
|
||||
* Looks for directories containing overview.md
|
||||
*/
|
||||
export async function detectSpecDirectories(cwd: string = process.cwd()): Promise<string[]> {
|
||||
const specsDir = path.join(cwd, 'specs');
|
||||
const specsDirs: string[] = [];
|
||||
|
||||
if (await fs.pathExists(specsDir)) {
|
||||
// Look for overview.md files in subdirectories
|
||||
const entries = await fs.readdir(specsDir, { withFileTypes: true });
|
||||
|
||||
for (const entry of entries) {
|
||||
if (entry.isDirectory()) {
|
||||
const overviewPath = path.join(specsDir, entry.name, 'overview.md');
|
||||
if (await fs.pathExists(overviewPath)) {
|
||||
specsDirs.push(path.join(specsDir, entry.name));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Also check if specs/ itself contains overview.md
|
||||
const rootOverview = path.join(specsDir, 'overview.md');
|
||||
if (await fs.pathExists(rootOverview)) {
|
||||
specsDirs.push(specsDir);
|
||||
}
|
||||
}
|
||||
|
||||
return specsDirs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple progress stats by counting phase-*.md files
|
||||
* Used for CLI display only - LLM handles actual task discovery
|
||||
*/
|
||||
export async function getSpecProgress(specPath: string): Promise<{
|
||||
featureName: string;
|
||||
totalPhases: number;
|
||||
}> {
|
||||
const overviewPath = path.join(specPath, 'overview.md');
|
||||
|
||||
// Extract feature name from overview.md
|
||||
let featureName = path.basename(specPath);
|
||||
try {
|
||||
const overviewContent = await fs.readFile(overviewPath, 'utf8');
|
||||
const h1Match = overviewContent.match(/^#\s+(.+)$/m);
|
||||
if (h1Match) {
|
||||
featureName = h1Match[1].trim();
|
||||
}
|
||||
} catch {
|
||||
// Use directory name as fallback
|
||||
}
|
||||
|
||||
// Count phase-*.md files
|
||||
let totalPhases = 0;
|
||||
try {
|
||||
const entries = await fs.readdir(specPath);
|
||||
totalPhases = entries.filter(name => /^phase-\d+\.md$/i.test(name)).length;
|
||||
} catch {
|
||||
// Directory read failed
|
||||
}
|
||||
|
||||
return {
|
||||
featureName,
|
||||
totalPhases,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
export type LoopMode = 'task' | 'phase';
|
||||
|
||||
export interface SessionConfig {
|
||||
agent: string; // "claude-code" | "copilot-cli"
|
||||
model: string; // Selected model
|
||||
maxIterations: number; // 5-50
|
||||
timeout: number; // Base timeout in minutes per iteration attempt
|
||||
maxRetries: number; // Max retry attempts per iteration (timeout increments by 30s each retry)
|
||||
verbose: boolean;
|
||||
specPath: string; // Path to the spec directory
|
||||
startedAt: string; // ISO timestamp
|
||||
currentIteration: number;
|
||||
jiraTicketId?: string; // JIRA ticket ID for commit messages
|
||||
loopMode: LoopMode; // "task" = one task per loop, "phase" = one phase per loop
|
||||
}
|
||||
|
||||
export interface IterationLogEntry {
|
||||
iteration: number;
|
||||
timestamp: string; // ISO timestamp
|
||||
duration: number; // milliseconds
|
||||
exitCode: number;
|
||||
status: 'running' | 'completed' | 'error' | 'timeout' | 'interrupted' | 'blocked';
|
||||
completionMarker?: string;
|
||||
}
|
||||
|
||||
export type SessionState = 'new' | 'continue' | 'changed';
|
||||
|
||||
export const DEFAULT_CONFIG: Partial<SessionConfig> = {
|
||||
maxIterations: 100,
|
||||
timeout: 3,
|
||||
maxRetries: 5,
|
||||
verbose: false,
|
||||
currentIteration: 0,
|
||||
loopMode: 'task',
|
||||
};
|
||||
@@ -0,0 +1,9 @@
|
||||
import { createHash } from 'crypto';
|
||||
|
||||
export function computeHash(content: string): string {
|
||||
return createHash('sha256').update(content).digest('hex').slice(0, 16);
|
||||
}
|
||||
|
||||
export function hashesMatch(a: string, b: string): boolean {
|
||||
return a === b;
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
export {
|
||||
type SessionConfig,
|
||||
type IterationLogEntry,
|
||||
type SessionState,
|
||||
type LoopMode,
|
||||
DEFAULT_CONFIG,
|
||||
} from './config.js';
|
||||
|
||||
export { StateManager } from './manager.js';
|
||||
export { computeHash, hashesMatch } from './hash.js';
|
||||
@@ -0,0 +1,231 @@
|
||||
import path from 'path';
|
||||
import fs from 'fs-extra';
|
||||
import type { SessionConfig, IterationLogEntry, SessionState } from './config.js';
|
||||
import { DEFAULT_CONFIG } from './config.js';
|
||||
import { computeHash, hashesMatch } from './hash.js';
|
||||
|
||||
const SCRATCHPAD_TEMPLATE = `# Scratchpad
|
||||
|
||||
Session notes appended by LLM during implementation.
|
||||
|
||||
---
|
||||
|
||||
`;
|
||||
|
||||
export class StateManager {
|
||||
private readonly stateDir: string;
|
||||
private readonly configPath: string;
|
||||
private readonly scratchpadPath: string;
|
||||
private readonly logPath: string;
|
||||
private readonly hashPath: string;
|
||||
private specPath: string | null = null;
|
||||
|
||||
constructor(cwd: string = process.cwd()) {
|
||||
// Default to project root - will be updated when spec is selected
|
||||
this.stateDir = path.join(cwd, '.plan2code-loop');
|
||||
this.configPath = path.join(this.stateDir, 'config.json');
|
||||
this.scratchpadPath = path.join(this.stateDir, 'scratchpad.md');
|
||||
this.logPath = path.join(this.stateDir, 'iteration.log');
|
||||
this.hashPath = path.join(this.stateDir, 'spec.hash');
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the spec path and update all state paths to be inside the spec directory
|
||||
*/
|
||||
setSpecPath(specPath: string): void {
|
||||
this.specPath = specPath;
|
||||
const stateDir = path.join(specPath, '.plan2code-loop');
|
||||
// Update all paths to be relative to spec directory
|
||||
(this as any).stateDir = stateDir;
|
||||
(this as any).configPath = path.join(stateDir, 'config.json');
|
||||
(this as any).scratchpadPath = path.join(stateDir, 'scratchpad.md');
|
||||
(this as any).logPath = path.join(stateDir, 'iteration.log');
|
||||
(this as any).hashPath = path.join(stateDir, 'spec.hash');
|
||||
}
|
||||
|
||||
// Directory operations
|
||||
|
||||
async ensureStateDir(): Promise<boolean> {
|
||||
const existed = await fs.pathExists(this.stateDir);
|
||||
await fs.ensureDir(this.stateDir);
|
||||
return existed;
|
||||
}
|
||||
|
||||
getStateDir(): string {
|
||||
return this.stateDir;
|
||||
}
|
||||
|
||||
// Config operations
|
||||
|
||||
async readConfig(): Promise<SessionConfig | null> {
|
||||
try {
|
||||
const content = await fs.readFile(this.configPath, 'utf8');
|
||||
return JSON.parse(content) as SessionConfig;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async writeConfig(config: SessionConfig): Promise<void> {
|
||||
await fs.writeFile(
|
||||
this.configPath,
|
||||
JSON.stringify(config, null, 2),
|
||||
'utf8'
|
||||
);
|
||||
}
|
||||
|
||||
async updateConfig(updates: Partial<SessionConfig>): Promise<SessionConfig> {
|
||||
const existing = await this.readConfig();
|
||||
const updated = { ...DEFAULT_CONFIG, ...existing, ...updates } as SessionConfig;
|
||||
await this.writeConfig(updated);
|
||||
return updated;
|
||||
}
|
||||
|
||||
async incrementIteration(): Promise<number> {
|
||||
const config = await this.readConfig();
|
||||
if (!config) throw new Error('No session config found');
|
||||
config.currentIteration++;
|
||||
await this.writeConfig(config);
|
||||
return config.currentIteration;
|
||||
}
|
||||
|
||||
// Session state detection
|
||||
|
||||
async hasExistingSession(): Promise<boolean> {
|
||||
const [configExists, scratchpadExists] = await Promise.all([
|
||||
fs.pathExists(this.configPath),
|
||||
fs.pathExists(this.scratchpadPath),
|
||||
]);
|
||||
return configExists || scratchpadExists;
|
||||
}
|
||||
|
||||
async detectSessionState(specPath: string): Promise<SessionState> {
|
||||
// Ensure we're using the correct spec path
|
||||
this.setSpecPath(specPath);
|
||||
|
||||
const hasSession = await this.hasExistingSession();
|
||||
if (!hasSession) {
|
||||
return 'new';
|
||||
}
|
||||
|
||||
// Check if the spec path has changed
|
||||
const existingConfig = await this.readConfig();
|
||||
if (existingConfig && existingConfig.specPath !== specPath) {
|
||||
return 'changed';
|
||||
}
|
||||
|
||||
// Check if spec content has changed (using hash of overview.md)
|
||||
const specChanged = await this.hasSpecChanged(specPath);
|
||||
return specChanged ? 'changed' : 'continue';
|
||||
}
|
||||
|
||||
// Hash management for spec change detection
|
||||
|
||||
async computeSpecHash(specPath: string): Promise<string> {
|
||||
const overviewPath = path.join(specPath, 'overview.md');
|
||||
try {
|
||||
const content = await fs.readFile(overviewPath, 'utf8');
|
||||
return computeHash(content);
|
||||
} catch {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
async readStoredHash(): Promise<string | null> {
|
||||
try {
|
||||
return await fs.readFile(this.hashPath, 'utf8');
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async storeHash(hash: string): Promise<void> {
|
||||
await fs.writeFile(this.hashPath, hash, 'utf8');
|
||||
}
|
||||
|
||||
async hasSpecChanged(specPath: string): Promise<boolean> {
|
||||
const stored = await this.readStoredHash();
|
||||
if (!stored) return true;
|
||||
const current = await this.computeSpecHash(specPath);
|
||||
return !hashesMatch(stored, current);
|
||||
}
|
||||
|
||||
async updateSpecHash(specPath: string): Promise<void> {
|
||||
const hash = await this.computeSpecHash(specPath);
|
||||
await this.storeHash(hash);
|
||||
}
|
||||
|
||||
// Scratchpad operations
|
||||
|
||||
async initializeScratchpad(): Promise<void> {
|
||||
await fs.writeFile(this.scratchpadPath, SCRATCHPAD_TEMPLATE, 'utf8');
|
||||
}
|
||||
|
||||
async readScratchpad(): Promise<string> {
|
||||
try {
|
||||
return await fs.readFile(this.scratchpadPath, 'utf8');
|
||||
} catch {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
|
||||
async writeScratchpad(content: string): Promise<void> {
|
||||
await fs.writeFile(this.scratchpadPath, content, 'utf8');
|
||||
}
|
||||
|
||||
// Iteration log operations
|
||||
|
||||
async appendIterationLog(entry: IterationLogEntry): Promise<void> {
|
||||
const line = JSON.stringify(entry) + '\n';
|
||||
await fs.appendFile(this.logPath, line, 'utf8');
|
||||
}
|
||||
|
||||
async readIterationLog(): Promise<IterationLogEntry[]> {
|
||||
try {
|
||||
const content = await fs.readFile(this.logPath, 'utf8');
|
||||
return content
|
||||
.trim()
|
||||
.split('\n')
|
||||
.filter(Boolean)
|
||||
.map((line) => JSON.parse(line) as IterationLogEntry);
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
async getLastIteration(): Promise<IterationLogEntry | null> {
|
||||
const log = await this.readIterationLog();
|
||||
return log.length > 0 ? log[log.length - 1] : null;
|
||||
}
|
||||
|
||||
// State clearing and initialization
|
||||
|
||||
async clearState(): Promise<void> {
|
||||
const filesToDelete = [
|
||||
this.scratchpadPath,
|
||||
this.configPath,
|
||||
this.logPath,
|
||||
this.hashPath,
|
||||
];
|
||||
|
||||
await Promise.all(
|
||||
filesToDelete.map((file) => fs.remove(file).catch(() => {}))
|
||||
);
|
||||
}
|
||||
|
||||
async initializeNewSession(config: SessionConfig): Promise<void> {
|
||||
// Ensure spec path is set before initializing
|
||||
this.setSpecPath(config.specPath);
|
||||
|
||||
await this.clearState();
|
||||
await this.ensureStateDir();
|
||||
await this.initializeScratchpad();
|
||||
await this.writeConfig({
|
||||
...config,
|
||||
startedAt: new Date().toISOString(),
|
||||
currentIteration: 0,
|
||||
});
|
||||
const hash = await this.computeSpecHash(config.specPath);
|
||||
await this.storeHash(hash);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,169 @@
|
||||
// Completion markers for plan2code-loop
|
||||
const COMPLETION_MARKERS = ['TASK_COMPLETE', 'TASK_BLOCKED', 'LOOP_COMPLETE', 'PREREQ_COMPLETE', 'PREREQ_ASSUMED'] as const;
|
||||
|
||||
export type CompletionMarker = (typeof COMPLETION_MARKERS)[number];
|
||||
|
||||
export interface CompletionCheckResult {
|
||||
completed: boolean;
|
||||
marker?: CompletionMarker;
|
||||
taskId?: string; // e.g., "1.1", "2.3"
|
||||
taskName?: string; // e.g., "Initialize project structure"
|
||||
reason?: string; // For TASK_BLOCKED: reason
|
||||
}
|
||||
|
||||
export function checkForCompletion(output: string): CompletionCheckResult {
|
||||
// Check for LOOP_COMPLETE first (highest priority)
|
||||
if (output.includes('LOOP_COMPLETE')) {
|
||||
return { completed: true, marker: 'LOOP_COMPLETE' };
|
||||
}
|
||||
|
||||
// Check for TASK_COMPLETE with task info
|
||||
// Format: TASK_COMPLETE: 1.1 - Task description
|
||||
// Or: TASK_COMPLETE: 1.1: Task description
|
||||
// Or: TASK_COMPLETE[1.1]: Task description
|
||||
const completeMatch = output.match(/TASK_COMPLETE[:\[\s]+(\d+\.\d+)[\]:\-\s]+(.+?)(?:\n|$)/i);
|
||||
if (completeMatch) {
|
||||
return {
|
||||
completed: true,
|
||||
marker: 'TASK_COMPLETE',
|
||||
taskId: completeMatch[1],
|
||||
taskName: completeMatch[2].trim(),
|
||||
};
|
||||
}
|
||||
|
||||
// Simple TASK_COMPLETE without structured info - try to extract task from context
|
||||
if (output.includes('TASK_COMPLETE')) {
|
||||
// Try to find task info nearby
|
||||
const taskMatch = output.match(/(?:task|completed?)\s+(\d+\.\d+)[:\s]+([^\n]{5,80})/i);
|
||||
return {
|
||||
completed: true,
|
||||
marker: 'TASK_COMPLETE',
|
||||
taskId: taskMatch?.[1],
|
||||
taskName: taskMatch?.[2]?.trim(),
|
||||
};
|
||||
}
|
||||
|
||||
// Check for PREREQ_COMPLETE with prereq info
|
||||
// Format: PREREQ_COMPLETE: P1.1 - Verified Phase 1 complete
|
||||
const prereqMatch = output.match(/PREREQ_COMPLETE[:\[\s]+([^\]:\-\s]+)[\]:\-\s]+(.+?)(?:\n|$)/i);
|
||||
if (prereqMatch) {
|
||||
return {
|
||||
completed: true,
|
||||
marker: 'PREREQ_COMPLETE',
|
||||
taskId: prereqMatch[1],
|
||||
taskName: prereqMatch[2].trim(),
|
||||
};
|
||||
}
|
||||
|
||||
// Check for PREREQ_ASSUMED with prereq info
|
||||
// Format: PREREQ_ASSUMED: P2.1 - Design approval (cannot verify)
|
||||
const assumedMatch = output.match(/PREREQ_ASSUMED[:\[\s]+([^\]:\-\s]+)[\]:\-\s]+(.+?)(?:\n|$)/i);
|
||||
if (assumedMatch) {
|
||||
return {
|
||||
completed: true,
|
||||
marker: 'PREREQ_ASSUMED',
|
||||
taskId: assumedMatch[1],
|
||||
taskName: assumedMatch[2].trim(),
|
||||
};
|
||||
}
|
||||
|
||||
// Check for TASK_BLOCKED with task info and reason
|
||||
// Format: TASK_BLOCKED: 1.1 - Reason why blocked
|
||||
const blockedWithTaskMatch = output.match(/TASK_BLOCKED[:\[\s]+(\d+\.\d+)[\]:\-\s]+(.+?)(?:\n|$)/i);
|
||||
if (blockedWithTaskMatch) {
|
||||
return {
|
||||
completed: true,
|
||||
marker: 'TASK_BLOCKED',
|
||||
taskId: blockedWithTaskMatch[1],
|
||||
reason: blockedWithTaskMatch[2].trim(),
|
||||
};
|
||||
}
|
||||
|
||||
// TASK_BLOCKED with just reason (no task ID)
|
||||
const blockedMatch = output.match(/TASK_BLOCKED:\s*(.+?)(?:\n|$)/);
|
||||
if (blockedMatch) {
|
||||
return {
|
||||
completed: true,
|
||||
marker: 'TASK_BLOCKED',
|
||||
reason: blockedMatch[1].trim()
|
||||
};
|
||||
}
|
||||
|
||||
// Simple TASK_BLOCKED without any info
|
||||
if (output.includes('TASK_BLOCKED')) {
|
||||
return { completed: true, marker: 'TASK_BLOCKED', reason: 'No reason provided' };
|
||||
}
|
||||
|
||||
return { completed: false };
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract ALL completion markers from output (for phase mode).
|
||||
* Returns an array of all TASK_COMPLETE/TASK_BLOCKED markers found,
|
||||
* plus whether LOOP_COMPLETE or PHASE_COMPLETE was present.
|
||||
*/
|
||||
export function checkForAllCompletions(output: string): {
|
||||
tasks: CompletionCheckResult[];
|
||||
loopComplete: boolean;
|
||||
phaseComplete: boolean;
|
||||
} {
|
||||
const tasks: CompletionCheckResult[] = [];
|
||||
let loopComplete = false;
|
||||
let phaseComplete = false;
|
||||
|
||||
if (output.includes('LOOP_COMPLETE')) {
|
||||
loopComplete = true;
|
||||
}
|
||||
|
||||
if (output.includes('PHASE_COMPLETE')) {
|
||||
phaseComplete = true;
|
||||
}
|
||||
|
||||
// Find all TASK_COMPLETE markers with task info
|
||||
// Format: TASK_COMPLETE: 1.1 - Task description
|
||||
const completeRegex = /TASK_COMPLETE[:\[\s]+(\d+\.\d+)[\]:\-\s]+(.+?)(?:\n|$)/gi;
|
||||
let match: RegExpExecArray | null;
|
||||
while ((match = completeRegex.exec(output)) !== null) {
|
||||
tasks.push({
|
||||
completed: true,
|
||||
marker: 'TASK_COMPLETE',
|
||||
taskId: match[1],
|
||||
taskName: match[2].trim(),
|
||||
});
|
||||
}
|
||||
|
||||
// Find all TASK_BLOCKED markers with task info
|
||||
const blockedRegex = /TASK_BLOCKED[:\[\s]+(\d+\.\d+)[\]:\-\s]+(.+?)(?:\n|$)/gi;
|
||||
while ((match = blockedRegex.exec(output)) !== null) {
|
||||
tasks.push({
|
||||
completed: true,
|
||||
marker: 'TASK_BLOCKED',
|
||||
taskId: match[1],
|
||||
reason: match[2].trim(),
|
||||
});
|
||||
}
|
||||
|
||||
// Find PREREQ_COMPLETE markers
|
||||
const prereqRegex = /PREREQ_COMPLETE[:\[\s]+([^\]:\-\s]+)[\]:\-\s]+(.+?)(?:\n|$)/gi;
|
||||
while ((match = prereqRegex.exec(output)) !== null) {
|
||||
tasks.push({
|
||||
completed: true,
|
||||
marker: 'PREREQ_COMPLETE',
|
||||
taskId: match[1],
|
||||
taskName: match[2].trim(),
|
||||
});
|
||||
}
|
||||
|
||||
// Find PREREQ_ASSUMED markers
|
||||
const assumedRegex = /PREREQ_ASSUMED[:\[\s]+([^\]:\-\s]+)[\]:\-\s]+(.+?)(?:\n|$)/gi;
|
||||
while ((match = assumedRegex.exec(output)) !== null) {
|
||||
tasks.push({
|
||||
completed: true,
|
||||
marker: 'PREREQ_ASSUMED',
|
||||
taskId: match[1],
|
||||
taskName: match[2].trim(),
|
||||
});
|
||||
}
|
||||
|
||||
return { tasks, loopComplete, phaseComplete };
|
||||
}
|
||||
@@ -0,0 +1,136 @@
|
||||
import { execa } from 'execa';
|
||||
import { existsSync, readFileSync, writeFileSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { logger } from './logger.js';
|
||||
|
||||
export interface GitCommitOptions {
|
||||
taskName: string;
|
||||
jiraTicketId?: string;
|
||||
cwd?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if directory is a git repository
|
||||
*/
|
||||
export async function isGitRepo(cwd: string): Promise<boolean> {
|
||||
const result = await execa('git', ['rev-parse', '--git-dir'], { cwd, reject: false });
|
||||
return result.exitCode === 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize a git repository if one doesn't exist
|
||||
*/
|
||||
export async function ensureGitRepo(cwd: string): Promise<boolean> {
|
||||
if (await isGitRepo(cwd)) {
|
||||
return true;
|
||||
}
|
||||
|
||||
logger.info('Initializing git repository...');
|
||||
const result = await execa('git', ['init'], { cwd, reject: false });
|
||||
|
||||
if (result.exitCode !== 0) {
|
||||
logger.error(`Failed to initialize git repo: ${result.stderr}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
logger.success('Git repository initialized');
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Required entries for the .gitignore file
|
||||
*/
|
||||
const REQUIRED_GITIGNORE_ENTRIES = ['specs/', 'specs--completed/', '.plan2code-loop', '.plan2code-metrics', 'nul', 'node_modules/'];
|
||||
|
||||
/**
|
||||
* Ensure .gitignore exists with required entries
|
||||
*/
|
||||
export function ensureGitignore(cwd: string): void {
|
||||
const gitignorePath = join(cwd, '.gitignore');
|
||||
let content = '';
|
||||
|
||||
if (existsSync(gitignorePath)) {
|
||||
content = readFileSync(gitignorePath, 'utf-8');
|
||||
}
|
||||
|
||||
const lines = content.split('\n').map(line => line.trim());
|
||||
const missingEntries = REQUIRED_GITIGNORE_ENTRIES.filter(entry => !lines.includes(entry));
|
||||
|
||||
if (missingEntries.length > 0) {
|
||||
const needsNewline = content.length > 0 && !content.endsWith('\n');
|
||||
const newContent = content + (needsNewline ? '\n' : '') + missingEntries.join('\n') + '\n';
|
||||
writeFileSync(gitignorePath, newContent);
|
||||
logger.dim(`Added to .gitignore: ${missingEntries.join(', ')}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a local git commit for a completed task
|
||||
*/
|
||||
export async function createTaskCommit(options: GitCommitOptions): Promise<boolean> {
|
||||
const { taskName, jiraTicketId, cwd = process.cwd() } = options;
|
||||
|
||||
logger.dim(`Git commit check in: ${cwd}`);
|
||||
|
||||
try {
|
||||
// Ensure we have a git repo
|
||||
if (!await ensureGitRepo(cwd)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Ensure .gitignore exists with required entries
|
||||
ensureGitignore(cwd);
|
||||
|
||||
// Check if there are any changes to commit
|
||||
const statusResult = await execa('git', ['status', '--porcelain'], { cwd, reject: false });
|
||||
|
||||
// Debug: show what git status returned
|
||||
if (statusResult.stdout?.trim()) {
|
||||
logger.dim(`Git status found changes:\n${statusResult.stdout.slice(0, 500)}`);
|
||||
}
|
||||
|
||||
if (statusResult.exitCode !== 0) {
|
||||
logger.error(`Git status failed: ${statusResult.stderr}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!statusResult.stdout?.trim()) {
|
||||
logger.dim('No changes to commit');
|
||||
return false;
|
||||
}
|
||||
|
||||
// Stage all changes
|
||||
const addResult = await execa('git', ['add', '-A'], { cwd, reject: false });
|
||||
if (addResult.exitCode !== 0) {
|
||||
logger.error(`Git add failed: ${addResult.stderr}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
// Build commit message
|
||||
let commitMessage = taskName;
|
||||
if (jiraTicketId) {
|
||||
commitMessage = `${taskName}\n\n${jiraTicketId}\nAI Assisted`;
|
||||
} else {
|
||||
commitMessage = `${taskName}\n\nAI Assisted`;
|
||||
}
|
||||
|
||||
// Create the commit
|
||||
const commitResult = await execa('git', ['commit', '-m', commitMessage], { cwd, reject: false });
|
||||
|
||||
if (commitResult.exitCode !== 0) {
|
||||
// Check if it's just "nothing to commit" vs actual error
|
||||
if (commitResult.stdout?.includes('nothing to commit') || commitResult.stderr?.includes('nothing to commit')) {
|
||||
logger.dim('No changes to commit');
|
||||
return false;
|
||||
}
|
||||
logger.error(`Git commit failed: ${commitResult.stderr || commitResult.stdout}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
logger.success(`Created commit: ${taskName}${jiraTicketId ? ` (${jiraTicketId})` : ''}`);
|
||||
return true;
|
||||
} catch (error) {
|
||||
logger.error(`Failed to create commit: ${error instanceof Error ? error.message : String(error)}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
export { logger, MASCOT, type Logger } from './logger.js';
|
||||
export {
|
||||
checkForCompletion,
|
||||
checkForAllCompletions,
|
||||
type CompletionMarker,
|
||||
type CompletionCheckResult
|
||||
} from './completion.js';
|
||||
export {
|
||||
executeCommand,
|
||||
type ExecuteOptions,
|
||||
type ExecuteResult
|
||||
} from './process.js';
|
||||
export {
|
||||
createTaskCommit,
|
||||
isGitRepo,
|
||||
ensureGitRepo,
|
||||
ensureGitignore,
|
||||
type GitCommitOptions
|
||||
} from './git.js';
|
||||
@@ -0,0 +1,126 @@
|
||||
import chalk from 'chalk';
|
||||
import ora, { type Ora } from 'ora';
|
||||
|
||||
// mascot - our friendly robot assistant
|
||||
export const MASCOT = {
|
||||
// Full mascot for headers
|
||||
full: [
|
||||
' ╭───╮ ',
|
||||
' │ ● │ ',
|
||||
' │ ◡ │ ',
|
||||
' ╰───╯ ',
|
||||
],
|
||||
// Mini mascot for inline use
|
||||
mini: '(◉‿◉)',
|
||||
// Waving mascot for greetings
|
||||
wave: [
|
||||
' ╭───╮ ',
|
||||
' │ ● │ ',
|
||||
' │ ◡ │ ',
|
||||
' ╰───╯ ',
|
||||
],
|
||||
// Celebration mascot for completion
|
||||
celebrate: [
|
||||
' ╭───╮ ',
|
||||
' │ ★ │ ',
|
||||
' │ ◡ │ ',
|
||||
' ╰───╯ ',
|
||||
],
|
||||
};
|
||||
|
||||
export const logger = {
|
||||
info: (message: string) => console.log(chalk.blue('i'), message),
|
||||
success: (message: string) => console.log(chalk.green('+'), message),
|
||||
warning: (message: string) => console.log(chalk.yellow('!'), message),
|
||||
error: (message: string) => console.log(chalk.red('x'), message),
|
||||
|
||||
dim: (message: string) => console.log(chalk.dim(message)),
|
||||
bold: (message: string) => console.log(chalk.bold(message)),
|
||||
|
||||
header: (message: string) => {
|
||||
console.log();
|
||||
console.log(chalk.cyan.bold(message));
|
||||
console.log(chalk.cyan('-'.repeat(message.length)));
|
||||
},
|
||||
|
||||
task: (phase: number, taskId: string, description: string) => {
|
||||
console.log(
|
||||
chalk.cyan(`[Phase ${phase}]`),
|
||||
chalk.yellow(`Task ${taskId}:`),
|
||||
chalk.white(description)
|
||||
);
|
||||
},
|
||||
|
||||
iteration: (num: number, max: number, status: string) => {
|
||||
console.log(
|
||||
chalk.cyan(`[${num}/${max}]`),
|
||||
chalk.white(status)
|
||||
);
|
||||
},
|
||||
|
||||
specContent: (content: string) => {
|
||||
console.log(chalk.dim('-'.repeat(50)));
|
||||
console.log(chalk.white(content));
|
||||
console.log(chalk.dim('-'.repeat(50)));
|
||||
},
|
||||
|
||||
spinner: (text: string): Ora => ora({ text, color: 'cyan' }).start(),
|
||||
|
||||
// Display mascot with optional message
|
||||
mascot: (variant: keyof typeof MASCOT = 'full', message?: string) => {
|
||||
console.log();
|
||||
const mascot = MASCOT[variant];
|
||||
if (Array.isArray(mascot)) {
|
||||
const mascotLines = [...mascot];
|
||||
if (message) {
|
||||
// Add message next to mascot (at the "mouth" line)
|
||||
mascotLines[4] = mascotLines[4] + ' ' + chalk.cyan(message);
|
||||
}
|
||||
mascotLines.forEach((line) => console.log(chalk.yellow(line)));
|
||||
} else {
|
||||
// Mini variant
|
||||
console.log(chalk.yellow(mascot), message ? chalk.cyan(message) : '');
|
||||
}
|
||||
console.log();
|
||||
},
|
||||
|
||||
// Welcome banner with mascot
|
||||
welcome: () => {
|
||||
console.log();
|
||||
console.log(chalk.cyan.bold('═'.repeat(50)));
|
||||
MASCOT.wave.forEach((line, i) => {
|
||||
if (i === 4) {
|
||||
console.log(chalk.yellow(line) + ' ' + chalk.cyan.bold("Hi!"));
|
||||
} else if (i === 5) {
|
||||
console.log(chalk.yellow(line) + ' ' + chalk.dim('I\'m Your Plan2Code assistant'));
|
||||
} else {
|
||||
console.log(chalk.yellow(line));
|
||||
}
|
||||
});
|
||||
console.log(chalk.cyan.bold('═'.repeat(50)));
|
||||
console.log();
|
||||
},
|
||||
|
||||
// Completion celebration with reminder
|
||||
allPhasesComplete: () => {
|
||||
console.log();
|
||||
console.log(chalk.green.bold('═'.repeat(50)));
|
||||
MASCOT.celebrate.forEach((line, i) => {
|
||||
if (i === 4) {
|
||||
console.log(chalk.yellow(line) + ' ' + chalk.green.bold('All phases complete!'));
|
||||
} else if (i === 5) {
|
||||
console.log(chalk.yellow(line) + ' ' + chalk.cyan('Great work!'));
|
||||
} else {
|
||||
console.log(chalk.yellow(line));
|
||||
}
|
||||
});
|
||||
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.dim(' This will ensure quality, completeness, and proper documentation.'));
|
||||
console.log();
|
||||
},
|
||||
};
|
||||
|
||||
export type Logger = typeof logger;
|
||||
@@ -0,0 +1,81 @@
|
||||
import { execa, type Options as ExecaOptions } from 'execa';
|
||||
|
||||
const MAX_OUTPUT_SIZE = 10 * 1024 * 1024; // 10MB
|
||||
|
||||
function truncateOutput(output: string, maxSize: number): string {
|
||||
if (output.length > maxSize) {
|
||||
return output.slice(0, maxSize) + '\n...[truncated]';
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
export interface ExecuteOptions {
|
||||
command: string;
|
||||
args: string[];
|
||||
cwd: string;
|
||||
timeout: number; // milliseconds
|
||||
env?: Record<string, string>;
|
||||
signal?: AbortSignal; // For cancellation
|
||||
stdin?: string; // Input to pass via stdin as string
|
||||
stdinFile?: string; // Path to file to pipe as stdin
|
||||
}
|
||||
|
||||
export interface ExecuteResult {
|
||||
stdout: string;
|
||||
stderr: string;
|
||||
exitCode: number;
|
||||
timedOut: boolean;
|
||||
cancelled: boolean;
|
||||
duration: number; // milliseconds
|
||||
}
|
||||
|
||||
export async function executeCommand(
|
||||
options: ExecuteOptions
|
||||
): Promise<ExecuteResult> {
|
||||
const startTime = Date.now();
|
||||
|
||||
try {
|
||||
const execaOptions: ExecaOptions = {
|
||||
cwd: options.cwd,
|
||||
timeout: options.timeout,
|
||||
env: { ...process.env, ...options.env },
|
||||
reject: false,
|
||||
all: true,
|
||||
};
|
||||
|
||||
// Add cancellation signal if provided
|
||||
if (options.signal) {
|
||||
(execaOptions as any).cancelSignal = options.signal;
|
||||
}
|
||||
|
||||
// Add stdin input if provided (string or file)
|
||||
if (options.stdin) {
|
||||
(execaOptions as any).input = options.stdin;
|
||||
} else if (options.stdinFile) {
|
||||
(execaOptions as any).inputFile = options.stdinFile;
|
||||
}
|
||||
|
||||
const result = await execa(options.command, options.args, execaOptions);
|
||||
|
||||
return {
|
||||
stdout: truncateOutput(result.stdout || '', MAX_OUTPUT_SIZE),
|
||||
stderr: truncateOutput(result.stderr || '', MAX_OUTPUT_SIZE),
|
||||
exitCode: result.exitCode ?? 1,
|
||||
timedOut: result.timedOut ?? false,
|
||||
cancelled: result.isCanceled ?? false,
|
||||
duration: Date.now() - startTime,
|
||||
};
|
||||
} catch (error: any) {
|
||||
// Check if this was a cancellation
|
||||
const isCancelled = error?.isCanceled || options.signal?.aborted;
|
||||
|
||||
return {
|
||||
stdout: error?.stdout || '',
|
||||
stderr: error?.stderr || (error instanceof Error ? error.message : String(error)),
|
||||
exitCode: isCancelled ? -1 : 1,
|
||||
timedOut: false,
|
||||
cancelled: isCancelled,
|
||||
duration: Date.now() - startTime,
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2022"],
|
||||
"outDir": "dist",
|
||||
"rootDir": ".",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"resolveJsonModule": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"sourceMap": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
|
||||
export default defineConfig({
|
||||
entry: {
|
||||
'bin/plan2code-loop': 'src/bin/plan2code-loop.ts',
|
||||
index: 'src/index.ts',
|
||||
},
|
||||
format: ['esm'],
|
||||
dts: false,
|
||||
clean: true,
|
||||
sourcemap: true,
|
||||
banner: {
|
||||
js: '#!/usr/bin/env node',
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,289 @@
|
||||
# plan2code-metrics
|
||||
|
||||
Recursive self-improvement toolchain for plan2code contributors. Collects metrics from completed project specs, aggregates them across runs and prompt generations, then uses AI to diagnose weak steps and propose targeted edits to the workflow prompts.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
```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
|
||||
|
||||
# After finishing any project spec (steps 1-4):
|
||||
cd your-project
|
||||
plan2code-metrics # → "Collect metrics" → pick your spec dir → done (5 sec)
|
||||
|
||||
# When you're curious or have 3+ runs:
|
||||
plan2code-metrics # → "View metrics status" to see the dashboard
|
||||
# → "Run analysis" for AI diagnosis of weak spots
|
||||
# → "Generate improvement proposal" for prompt edits
|
||||
# → "Review and apply" to patch src/plan2code-*.md
|
||||
```
|
||||
|
||||
**One habit:** collect after every finished spec. Everything else is on-demand.
|
||||
|
||||
### How Many Runs Do I Need?
|
||||
|
||||
| Runs | What You Get |
|
||||
|------|-------------|
|
||||
| **1** | Raw data and basic dashboard. Start here. |
|
||||
| **3+** | AI analysis unlocks (warns below 3 that results may be unreliable). Pattern detection starts working. |
|
||||
| **5-10+** | Averages stabilize. Generation-over-generation comparisons become meaningful. |
|
||||
|
||||
More is always better — each run adds a data point. You're looking for trends, not individual scores.
|
||||
|
||||
### The Feedback Loop
|
||||
|
||||
```
|
||||
Use plan2code on a project (steps 1-4)
|
||||
|
|
||||
v
|
||||
Collect metrics from the finished spec <-- do this every time
|
||||
|
|
||||
v
|
||||
Aggregate across runs (automatic)
|
||||
|
|
||||
v
|
||||
Analyze weak spots (AI-powered, 3+ runs)
|
||||
|
|
||||
v
|
||||
Generate prompt improvements
|
||||
|
|
||||
v
|
||||
Apply edits to src/plan2code-*.md
|
||||
|
|
||||
v
|
||||
Prompts have new SHA hashes = new "generation"
|
||||
|
|
||||
v
|
||||
Use improved prompts on next project
|
||||
|
|
||||
v
|
||||
Collect again, compare generations <-- the loop closes
|
||||
```
|
||||
|
||||
After applying edits, the prompt file SHA hashes change. The next collected run falls into a **new cohort** (generation). The dashboard then shows generation-over-generation deltas — "Did confidence go up? Did blockers decrease?" — so you can measure whether your edits actually helped.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
Requires Node.js >= 18.
|
||||
|
||||
### Via the plan2code installer (recommended)
|
||||
|
||||
From the plan2code repo root:
|
||||
|
||||
```bash
|
||||
node install.js
|
||||
```
|
||||
|
||||
Choose **A** (Install All + dev tools) to install prompts, loop CLI, bot, metrics, and status line together. Or choose **C** (Custom) then **M** (Metrics) to install just the metrics CLI.
|
||||
|
||||
The installer handles `npm install`, `npm run build`, and global linking automatically. After install, `plan2code-metrics` is available from any directory.
|
||||
|
||||
### Manual install
|
||||
|
||||
If you prefer to install manually or are developing on the metrics package:
|
||||
|
||||
```bash
|
||||
cd plan2code-metrics
|
||||
npm install
|
||||
npm run build
|
||||
npm link
|
||||
```
|
||||
|
||||
To run without linking:
|
||||
|
||||
```bash
|
||||
npm start
|
||||
# or
|
||||
node dist/bin/plan2code-metrics.js
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Run `plan2code-metrics` from inside (or near) a plan2code repository. The CLI is fully interactive — no flags, all inputs collected via prompts.
|
||||
|
||||
```
|
||||
plan2code-metrics
|
||||
```
|
||||
|
||||
### Main Menu
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| **Collect metrics** | Parse a completed project spec and extract step-by-step metrics into a run JSON |
|
||||
| **Import run data** | Copy a run JSON from another project into the local metrics store |
|
||||
| **View metrics status** | Show aggregated metrics with health indicators and generation deltas |
|
||||
| **Run analysis** | AI-powered diagnosis of weak steps (requires Claude Code or Copilot CLI) |
|
||||
| **Generate improvement proposal** | AI generates surgical prompt edits based on a diagnosis |
|
||||
| **Review and apply** | Interactive diff review to accept/reject individual edits |
|
||||
|
||||
### Each Time You Finish a Spec
|
||||
|
||||
After completing Step 4 (finalize) on any project:
|
||||
|
||||
```bash
|
||||
cd your-project
|
||||
plan2code-metrics
|
||||
```
|
||||
|
||||
Pick **"Collect metrics"** and point it at your spec directory (`specs/<feature>/` or `specs--completed/<feature>/`). It reads your artifacts, extracts ~30 metrics, and writes a run JSON. Takes about 5 seconds.
|
||||
|
||||
The data stays local to that project in `.plan2code-metrics/runs/`. To aggregate across multiple projects, use **"Import"** to copy run files into one central location.
|
||||
|
||||
### Cross-Project Aggregation
|
||||
|
||||
If you use plan2code across several repos, you can consolidate all run data in one place:
|
||||
|
||||
```bash
|
||||
# From your central repo (e.g., the plan2code repo itself):
|
||||
plan2code-metrics
|
||||
# → "Import run data"
|
||||
# → Paste path to: /path/to/other-project/.plan2code-metrics/runs/run-xxx.json
|
||||
```
|
||||
|
||||
Imported runs are copied locally and included in all future aggregations, analyses, and comparisons.
|
||||
|
||||
## What It Measures
|
||||
|
||||
Each collection scrapes your spec files and extracts:
|
||||
|
||||
### Step 1 (Plan) — from `PLAN-DRAFT-*.md` and `PLAN-CONVERSATION-*.md`
|
||||
|
||||
- **Confidence score** — overall planning confidence percentage
|
||||
- **Confidence breakdown** — requirements, feasibility, integration, risk sub-scores
|
||||
- **Clarification rounds** — how many rounds of Q&A occurred
|
||||
- **Verification gaps found** — missing requirements caught during verification
|
||||
- **Functional/non-functional requirement counts** — FR- and NFR- headings
|
||||
- **Risk count** — risk table entries
|
||||
- **Phase count** — number of implementation phases planned
|
||||
|
||||
### Step 2 (Document) — from `overview.md` and `phase-*.md`
|
||||
|
||||
- **Total tasks** — checkbox count across all phases
|
||||
- **Tasks per phase** — distribution of work
|
||||
- **Phase count** — number of phase files
|
||||
- **Parallel groups** — parallel execution groups identified
|
||||
- **Requirement coverage** — coverage percentage if present
|
||||
- **Verification items** — verification checklist items added
|
||||
|
||||
### Step 3 (Implement) — from `.plan2code-loop/` data (loop mode only)
|
||||
|
||||
- **Task completion rate** — completed / total tasks
|
||||
- **Blocker count** — tasks marked TASK_BLOCKED
|
||||
- **Blocker categories** — normalized reasons for blocks
|
||||
- **Total iterations** — loop iteration count
|
||||
- **Avg iteration duration** — mean time per iteration
|
||||
- **Exit code distribution** — process exit codes
|
||||
- **Completion marker success rate** — valid markers / total iterations
|
||||
|
||||
### Step 4 (Finalize) — from `overview.md` and directory structure
|
||||
|
||||
- **Completion rate at audit** — tasks done at finalization time
|
||||
- **Verification failures** — tasks marked with `[!]`
|
||||
- **Documentation updates needed** — TODO/FIXME/update markers
|
||||
- **Archival success** — whether spec was moved to `specs--completed/`
|
||||
|
||||
### Health Targets
|
||||
|
||||
The dashboard compares key metrics against targets:
|
||||
|
||||
| Metric | Target | Direction |
|
||||
|--------|--------|-----------|
|
||||
| avg_confidence | 90 | >= |
|
||||
| avg_clarification_rounds | 2.0 | <= |
|
||||
| avg_verification_gaps_found | 2.0 | <= |
|
||||
| avg_parallel_groups | 0.5 | >= |
|
||||
| avg_task_completion_rate | 0.95 | >= |
|
||||
| avg_blocker_count | 1.5 | <= |
|
||||
| avg_completion_marker_success_rate | 0.95 | >= |
|
||||
| avg_verification_failures_found | 1.0 | <= |
|
||||
| archival_success_rate | 0.99 | >= |
|
||||
|
||||
Green checkmark = meeting target. Red X = below target (with the target shown).
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Collect
|
||||
|
||||
Reads completed project artifacts from `specs/` or `specs--completed/` and extracts metrics for each workflow step. Output: `.plan2code-metrics/runs/run-<timestamp>.json`
|
||||
|
||||
### 2. Aggregate
|
||||
|
||||
Merges all run files into `aggregated.json`, grouped by **prompt generation** — a SHA fingerprint of the 8 workflow prompt files. Two runs that used identical prompt files belong to the same cohort.
|
||||
|
||||
### 3. Analyze
|
||||
|
||||
Sends aggregated metrics to an AI model with an analyst prompt. The AI produces a diagnosis identifying the weakest workflow steps and root causes. No edits are proposed at this stage.
|
||||
|
||||
Output: `.plan2code-metrics/proposals/<timestamp>-diagnosis.md`
|
||||
|
||||
### 4. Improve
|
||||
|
||||
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
|
||||
|
||||
Output: `.plan2code-metrics/proposals/prop-<timestamp>.json`
|
||||
|
||||
### 5. Apply
|
||||
|
||||
Interactive diff review for each proposed edit. Accept, reject, or skip individual changes. Applied edits are patched directly into `src/plan2code-*.md`.
|
||||
|
||||
## Data Directory
|
||||
|
||||
All metrics data lives in `.plan2code-metrics/` (add to `.gitignore` if desired):
|
||||
|
||||
```
|
||||
.plan2code-metrics/
|
||||
├── runs/ # Individual run JSONs
|
||||
│ ├── run-20260215-120000-a1b2.json
|
||||
│ └── run-20260220-090000-c3d4.json
|
||||
├── aggregated.json # Merged cohort data
|
||||
└── proposals/ # Diagnoses and improvement proposals
|
||||
├── 20260220-diagnosis.md
|
||||
└── prop-20260220.json
|
||||
```
|
||||
|
||||
## AI Backends
|
||||
|
||||
The analysis and improvement steps require an AI agent. Two backends are supported:
|
||||
|
||||
| Backend | Command | Notes |
|
||||
|---------|---------|-------|
|
||||
| **Claude Code** | `claude` | Uses `--print` mode. Recommended. |
|
||||
| **GitHub Copilot CLI** | `copilot` | Uses stdin piping with `--allow-all-tools -s`. |
|
||||
|
||||
Model selection is interactive — choose from available models when prompted.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
src/
|
||||
├── bin/plan2code-metrics.ts # Entry point
|
||||
├── cli.ts # Interactive menu (main loop)
|
||||
├── types.ts # RunMetrics, PromptProposal, CohortMetrics, etc.
|
||||
├── collector.ts # Reads project artifacts → run JSON
|
||||
├── aggregator.ts # Merges runs → aggregated.json (cohort grouping)
|
||||
├── analyzer.ts # AI diagnosis via LLM invocation
|
||||
├── improver.ts # AI improvement proposal + validation
|
||||
├── applier.ts # Interactive diff review + file patching
|
||||
├── invoke-llm.ts # Unified LLM invocation (Claude Code / Copilot CLI)
|
||||
├── index.ts # Public API exports
|
||||
└── prompts/
|
||||
├── analyze.md # AI prompt template for diagnosis
|
||||
└── improve.md # AI prompt template for improvement proposals
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm run dev # Watch mode (rebuilds on change)
|
||||
npm run build # Production build
|
||||
npm test # Run unit tests
|
||||
npm run test:watch # Watch mode tests
|
||||
npm start # Run the CLI
|
||||
```
|
||||
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"name": "plan2code-metrics",
|
||||
"version": "1.0.0",
|
||||
"description": "Plan2Code Metrics - Recursive self-improvement toolchain for plan2code contributors",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
"plan2code-metrics": "./dist/bin/plan2code-metrics.js"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"keywords": [
|
||||
"cli",
|
||||
"ai",
|
||||
"metrics",
|
||||
"plan2code",
|
||||
"contributor-tooling"
|
||||
],
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"dev": "tsup --watch",
|
||||
"start": "node dist/bin/plan2code-metrics.js",
|
||||
"test": "vitest run",
|
||||
"test:watch": "vitest",
|
||||
"prepublishOnly": "npm run build"
|
||||
},
|
||||
"dependencies": {
|
||||
"@inquirer/prompts": "^8.1.0",
|
||||
"chalk": "^5.6.2",
|
||||
"execa": "^9.6.1",
|
||||
"fs-extra": "^11.3.3",
|
||||
"ora": "^9.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/node": "^25.0.3",
|
||||
"tsup": "^8.5.1",
|
||||
"typescript": "^5.9.3",
|
||||
"vitest": "^3.1.1"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,154 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { avg, rate, buildCohortKey, backfillPromptVersions } from './aggregator.js';
|
||||
import type { PromptVersions } from './types.js';
|
||||
|
||||
// ── avg() ─────────────────────────────────────────────────────────────────────
|
||||
|
||||
describe('avg', () => {
|
||||
it('returns null for empty array', () => {
|
||||
expect(avg([])).toBeNull();
|
||||
});
|
||||
|
||||
it('returns null for all-null/undefined values', () => {
|
||||
expect(avg([null, undefined, null])).toBeNull();
|
||||
});
|
||||
|
||||
it('computes correct average for valid numbers', () => {
|
||||
expect(avg([10, 20, 30])).toBe(20);
|
||||
});
|
||||
|
||||
it('filters out null/undefined/NaN from mixed arrays', () => {
|
||||
expect(avg([10, null, 20, undefined, NaN, 30])).toBe(20);
|
||||
});
|
||||
});
|
||||
|
||||
// ── rate() ────────────────────────────────────────────────────────────────────
|
||||
|
||||
describe('rate', () => {
|
||||
it('returns null for empty array', () => {
|
||||
expect(rate([])).toBeNull();
|
||||
});
|
||||
|
||||
it('returns null for all-null values', () => {
|
||||
expect(rate([null, null])).toBeNull();
|
||||
});
|
||||
|
||||
it('returns 1.0 for all-true', () => {
|
||||
expect(rate([true, true, true])).toBe(1.0);
|
||||
});
|
||||
|
||||
it('returns 0.0 for all-false', () => {
|
||||
expect(rate([false, false, false])).toBe(0.0);
|
||||
});
|
||||
|
||||
it('computes correct rate for mixed true/false', () => {
|
||||
expect(rate([true, false, true, false])).toBe(0.5);
|
||||
});
|
||||
|
||||
it('filters out null/undefined from mixed arrays', () => {
|
||||
expect(rate([true, null, false, undefined])).toBe(0.5);
|
||||
});
|
||||
});
|
||||
|
||||
// ── backfillPromptVersions() ──────────────────────────────────────────────────
|
||||
|
||||
const FULL_VERSIONS: PromptVersions = {
|
||||
plan: 'sha256:aaa',
|
||||
revise_plan: 'sha256:bbb',
|
||||
document: 'sha256:ccc',
|
||||
implement: 'sha256:ddd',
|
||||
finalize: 'sha256:eee',
|
||||
init: 'sha256:fff',
|
||||
init_update: 'sha256:ggg',
|
||||
quick_task: 'sha256:hhh',
|
||||
};
|
||||
|
||||
describe('backfillPromptVersions', () => {
|
||||
it('returns all 8 fields with sentinels when given empty-ish object', () => {
|
||||
const result = backfillPromptVersions({} as PromptVersions);
|
||||
expect(Object.keys(result)).toHaveLength(8);
|
||||
for (const val of Object.values(result)) {
|
||||
expect(val).toBe('sha256:missing');
|
||||
}
|
||||
});
|
||||
|
||||
it('preserves existing values, fills missing with sha256:missing', () => {
|
||||
const partial = { plan: 'sha256:aaa', implement: 'sha256:ddd' } as PromptVersions;
|
||||
const result = backfillPromptVersions(partial);
|
||||
expect(result.plan).toBe('sha256:aaa');
|
||||
expect(result.implement).toBe('sha256:ddd');
|
||||
expect(result.revise_plan).toBe('sha256:missing');
|
||||
expect(result.document).toBe('sha256:missing');
|
||||
expect(result.finalize).toBe('sha256:missing');
|
||||
expect(result.init).toBe('sha256:missing');
|
||||
expect(result.init_update).toBe('sha256:missing');
|
||||
expect(result.quick_task).toBe('sha256:missing');
|
||||
});
|
||||
|
||||
it('returns unchanged object when all 8 fields present', () => {
|
||||
const result = backfillPromptVersions(FULL_VERSIONS);
|
||||
expect(result).toEqual(FULL_VERSIONS);
|
||||
});
|
||||
});
|
||||
|
||||
// ── buildCohortKey() ──────────────────────────────────────────────────────────
|
||||
|
||||
describe('buildCohortKey', () => {
|
||||
it('returns 12-char hex string', () => {
|
||||
const key = buildCohortKey(FULL_VERSIONS);
|
||||
expect(key).toMatch(/^[0-9a-f]{12}$/);
|
||||
});
|
||||
|
||||
it('is deterministic (same input → same output)', () => {
|
||||
const key1 = buildCohortKey(FULL_VERSIONS);
|
||||
const key2 = buildCohortKey(FULL_VERSIONS);
|
||||
expect(key1).toBe(key2);
|
||||
});
|
||||
|
||||
it('old 4-field run with backfill sentinels produces same key as raw 4-field object', () => {
|
||||
// Simulate an old run that only had 4 fields
|
||||
const oldRun = {
|
||||
plan: 'sha256:aaa',
|
||||
implement: 'sha256:ddd',
|
||||
document: 'sha256:ccc',
|
||||
finalize: 'sha256:eee',
|
||||
} as PromptVersions;
|
||||
|
||||
// After backfill, the missing fields get 'sha256:missing'
|
||||
const backfilled = backfillPromptVersions(oldRun);
|
||||
|
||||
// buildCohortKey filters out 'sha256:missing', so both should match
|
||||
const keyDirect = buildCohortKey(oldRun);
|
||||
const keyBackfilled = buildCohortKey(backfilled);
|
||||
expect(keyDirect).toBe(keyBackfilled);
|
||||
});
|
||||
|
||||
it('different prompt versions → different keys', () => {
|
||||
const altered = { ...FULL_VERSIONS, plan: 'sha256:zzz' };
|
||||
expect(buildCohortKey(FULL_VERSIONS)).not.toBe(buildCohortKey(altered));
|
||||
});
|
||||
|
||||
it('key is independent of field insertion order', () => {
|
||||
const ordered: PromptVersions = {
|
||||
plan: 'sha256:aaa',
|
||||
revise_plan: 'sha256:bbb',
|
||||
document: 'sha256:ccc',
|
||||
implement: 'sha256:ddd',
|
||||
finalize: 'sha256:eee',
|
||||
init: 'sha256:fff',
|
||||
init_update: 'sha256:ggg',
|
||||
quick_task: 'sha256:hhh',
|
||||
};
|
||||
const reversed: PromptVersions = {
|
||||
quick_task: 'sha256:hhh',
|
||||
init_update: 'sha256:ggg',
|
||||
init: 'sha256:fff',
|
||||
finalize: 'sha256:eee',
|
||||
implement: 'sha256:ddd',
|
||||
document: 'sha256:ccc',
|
||||
revise_plan: 'sha256:bbb',
|
||||
plan: 'sha256:aaa',
|
||||
};
|
||||
expect(buildCohortKey(ordered)).toBe(buildCohortKey(reversed));
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,219 @@
|
||||
/**
|
||||
* aggregator.ts
|
||||
* Merges all run JSON files into aggregated.json, grouped by prompt generation (SHA fingerprint).
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import crypto from 'crypto';
|
||||
import type { RunMetrics, AggregatedMetrics, CohortMetrics, PromptVersions } from './types.js';
|
||||
|
||||
// ── Helpers ───────────────────────────────────────────────────────────────────
|
||||
|
||||
export function avg(values: (number | null | undefined)[]): number | null {
|
||||
const valid = values.filter((v): v is number => v != null && !isNaN(v));
|
||||
if (valid.length === 0) return null;
|
||||
return valid.reduce((a, b) => a + b, 0) / valid.length;
|
||||
}
|
||||
|
||||
export function rate(values: (boolean | null | undefined)[]): number | null {
|
||||
const valid = values.filter((v): v is boolean => v != null);
|
||||
if (valid.length === 0) return null;
|
||||
return valid.filter(v => v).length / valid.length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a stable cohort key from the sorted prompt_versions object.
|
||||
* Two runs with identical prompt files get the same cohort key.
|
||||
*/
|
||||
export function buildCohortKey(promptVersions: PromptVersions): string {
|
||||
// Filter out missing sentinels so old runs (4 fields) keep their original key
|
||||
const entries = Object.entries(promptVersions)
|
||||
.filter(([, v]) => v !== 'sha256:missing')
|
||||
.sort(([a], [b]) => a.localeCompare(b));
|
||||
const str = JSON.stringify(Object.fromEntries(entries));
|
||||
return crypto.createHash('sha256').update(str).digest('hex').slice(0, 12);
|
||||
}
|
||||
|
||||
/**
|
||||
* Backfill missing PromptVersions fields for old run files (pre-v1.1).
|
||||
*/
|
||||
export function backfillPromptVersions(pv: PromptVersions): PromptVersions {
|
||||
return {
|
||||
plan: pv.plan ?? 'sha256:missing',
|
||||
revise_plan: pv.revise_plan ?? 'sha256:missing',
|
||||
document: pv.document ?? 'sha256:missing',
|
||||
implement: pv.implement ?? 'sha256:missing',
|
||||
finalize: pv.finalize ?? 'sha256:missing',
|
||||
init: pv.init ?? 'sha256:missing',
|
||||
init_update: pv.init_update ?? 'sha256:missing',
|
||||
quick_task: pv.quick_task ?? 'sha256:missing',
|
||||
};
|
||||
}
|
||||
|
||||
// ── Load run files ────────────────────────────────────────────────────────────
|
||||
|
||||
export function loadRunFiles(runsDir: string): RunMetrics[] {
|
||||
if (!fs.existsSync(runsDir)) return [];
|
||||
|
||||
const files = fs.readdirSync(runsDir)
|
||||
.filter(f => f.endsWith('.json') && f.startsWith('run-'))
|
||||
.sort();
|
||||
|
||||
const runs: RunMetrics[] = [];
|
||||
for (const file of files) {
|
||||
try {
|
||||
const content = fs.readFileSync(path.join(runsDir, file), 'utf8');
|
||||
const data = JSON.parse(content) as RunMetrics;
|
||||
data.prompt_versions = backfillPromptVersions(data.prompt_versions);
|
||||
runs.push(data);
|
||||
} catch (err) {
|
||||
console.warn(`Warning: could not parse ${file}: ${err}`);
|
||||
}
|
||||
}
|
||||
return runs;
|
||||
}
|
||||
|
||||
// ── Build cohort metrics ──────────────────────────────────────────────────────
|
||||
|
||||
function buildCohort(runs: RunMetrics[], cohortKey: string): CohortMetrics {
|
||||
const runIds = runs.map(r => r.run_id);
|
||||
const timestamps = runs
|
||||
.flatMap(r => [r.project.started_at, r.project.completed_at])
|
||||
.filter((t): t is string => t != null)
|
||||
.sort();
|
||||
|
||||
// Step 1 averages
|
||||
const avgConfidence = avg(runs.map(r => r.step1_plan.final_confidence));
|
||||
const avgClarification = avg(runs.map(r => r.step1_plan.clarification_rounds));
|
||||
const avgVerifGaps = avg(runs.map(r => r.step1_plan.verification_gaps_found));
|
||||
const avgFRCount = avg(runs.map(r => r.step1_plan.functional_requirements_count));
|
||||
const avgNFRCount = avg(runs.map(r => r.step1_plan.non_functional_requirements_count));
|
||||
const avgRiskCount = avg(runs.map(r => r.step1_plan.risk_count));
|
||||
const avgPhaseStep1 = avg(runs.map(r => r.step1_plan.phase_count));
|
||||
|
||||
// Step 2 averages
|
||||
const avgTotalTasks = avg(runs.map(r => r.step2_document.total_tasks));
|
||||
const avgPhaseStep2 = avg(runs.map(r => r.step2_document.phase_count));
|
||||
const avgParallelGroups = avg(runs.map(r => r.step2_document.parallel_groups_identified));
|
||||
const avgReqCoverage = avg(runs.map(r => r.step2_document.requirement_coverage_percent));
|
||||
const avgVerifItems = avg(runs.map(r => r.step2_document.verification_items_added));
|
||||
|
||||
// Step 3 averages
|
||||
const avgCompletionRate = avg(runs.map(r => r.step3_implement.task_completion_rate));
|
||||
const avgBlockerCount = avg(runs.map(r => r.step3_implement.blocker_count));
|
||||
|
||||
// Step 4 averages
|
||||
const avgCompletionAtAudit = avg(runs.map(r => r.step4_finalize.completion_rate_at_audit));
|
||||
const avgVerifFailures = avg(runs.map(r => r.step4_finalize.verification_failures_found));
|
||||
const avgDocUpdates = avg(runs.map(r => r.step4_finalize.documentation_updates_needed));
|
||||
const archivalRate = rate(runs.map(r => r.step4_finalize.archival_succeeded));
|
||||
|
||||
// User feedback
|
||||
const feedbackRuns = runs.filter(r => r.user_feedback != null);
|
||||
const avgUserRating = avg(feedbackRuns.map(r => r.user_feedback!.overall_rating));
|
||||
const feedbackCount = feedbackRuns.length;
|
||||
|
||||
return {
|
||||
cohort_key: cohortKey,
|
||||
prompt_versions: runs[0].prompt_versions,
|
||||
run_count: runs.length,
|
||||
run_ids: runIds,
|
||||
first_seen: timestamps[0] ?? runs[0].run_id,
|
||||
last_seen: timestamps[timestamps.length - 1] ?? runs[runs.length - 1].run_id,
|
||||
|
||||
avg_confidence: avgConfidence,
|
||||
avg_clarification_rounds: avgClarification,
|
||||
avg_verification_gaps_found: avgVerifGaps,
|
||||
avg_functional_requirements_count: avgFRCount,
|
||||
avg_non_functional_requirements_count: avgNFRCount,
|
||||
avg_risk_count: avgRiskCount,
|
||||
avg_phase_count_step1: avgPhaseStep1,
|
||||
|
||||
avg_total_tasks: avgTotalTasks,
|
||||
avg_phase_count_step2: avgPhaseStep2,
|
||||
avg_parallel_groups: avgParallelGroups,
|
||||
avg_requirement_coverage_percent: avgReqCoverage,
|
||||
avg_verification_items_added: avgVerifItems,
|
||||
|
||||
avg_task_completion_rate: avgCompletionRate,
|
||||
avg_blocker_count: avgBlockerCount,
|
||||
|
||||
avg_completion_rate_at_audit: avgCompletionAtAudit,
|
||||
avg_verification_failures_found: avgVerifFailures,
|
||||
avg_documentation_updates_needed: avgDocUpdates,
|
||||
archival_success_rate: archivalRate,
|
||||
|
||||
avg_user_rating: avgUserRating,
|
||||
feedback_count: feedbackCount,
|
||||
};
|
||||
}
|
||||
|
||||
// ── Main aggregator ───────────────────────────────────────────────────────────
|
||||
|
||||
export function aggregate(runsDir: string, outputPath: string): AggregatedMetrics {
|
||||
const runs = loadRunFiles(runsDir);
|
||||
|
||||
// Group by cohort key
|
||||
const cohortMap = new Map<string, RunMetrics[]>();
|
||||
for (const run of runs) {
|
||||
const key = buildCohortKey(run.prompt_versions);
|
||||
if (!cohortMap.has(key)) cohortMap.set(key, []);
|
||||
cohortMap.get(key)!.push(run);
|
||||
}
|
||||
|
||||
// Sort cohorts by first seen
|
||||
const cohorts: CohortMetrics[] = [];
|
||||
for (const [key, cohortRuns] of cohortMap) {
|
||||
cohorts.push(buildCohort(cohortRuns, key));
|
||||
}
|
||||
cohorts.sort((a, b) => a.first_seen.localeCompare(b.first_seen));
|
||||
|
||||
// Determine current cohort (most recent)
|
||||
const currentCohortKey = cohorts.length > 0
|
||||
? cohorts[cohorts.length - 1].cohort_key
|
||||
: null;
|
||||
|
||||
const aggregated: AggregatedMetrics = {
|
||||
schema_version: '1.0',
|
||||
last_updated: new Date().toISOString(),
|
||||
total_runs: runs.length,
|
||||
cohorts,
|
||||
current_cohort_key: currentCohortKey,
|
||||
};
|
||||
|
||||
// Write to output path
|
||||
const dir = path.dirname(outputPath);
|
||||
fs.mkdirSync(dir, { recursive: true });
|
||||
fs.writeFileSync(outputPath, JSON.stringify(aggregated, null, 2), 'utf8');
|
||||
|
||||
return aggregated;
|
||||
}
|
||||
|
||||
export function loadAggregated(outputPath: string): AggregatedMetrics | null {
|
||||
try {
|
||||
const content = fs.readFileSync(outputPath, 'utf8');
|
||||
return JSON.parse(content) as AggregatedMetrics;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Import a single run JSON from another project into the local runs dir.
|
||||
* Returns true if imported, false if already present.
|
||||
*/
|
||||
export function importRun(runJsonPath: string, runsDir: string): boolean {
|
||||
const content = fs.readFileSync(runJsonPath, 'utf8');
|
||||
const run = JSON.parse(content) as RunMetrics;
|
||||
run.prompt_versions = backfillPromptVersions(run.prompt_versions);
|
||||
const destPath = path.join(runsDir, `${run.run_id}.json`);
|
||||
|
||||
if (fs.existsSync(destPath)) {
|
||||
return false; // Already imported
|
||||
}
|
||||
|
||||
fs.mkdirSync(runsDir, { recursive: true });
|
||||
fs.writeFileSync(destPath, JSON.stringify(run, null, 2), 'utf8');
|
||||
return true;
|
||||
}
|
||||
@@ -0,0 +1,128 @@
|
||||
/**
|
||||
* analyzer.ts
|
||||
* Reads aggregated.json + prompt file contents, builds analysis prompt, invokes AI.
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import type { AggregatedMetrics } from './types.js';
|
||||
import { invokeLLM, type AgentType } from './invoke-llm.js';
|
||||
|
||||
const ANALYZE_PROMPT_PATH = new URL('../src/prompts/analyze.md', import.meta.url).pathname
|
||||
.replace(/^\/([A-Za-z]:)/, '$1'); // Fix Windows path
|
||||
|
||||
// ── Helpers ───────────────────────────────────────────────────────────────────
|
||||
|
||||
function readPromptFiles(plan2codeRoot: string): Record<string, string> {
|
||||
const srcDir = path.join(plan2codeRoot, 'src');
|
||||
const promptFiles = [
|
||||
'plan2code-1-plan.md',
|
||||
'plan2code-1b-revise-plan.md',
|
||||
'plan2code-2-document.md',
|
||||
'plan2code-3-implement.md',
|
||||
'plan2code-4-finalize.md',
|
||||
'plan2code-init.md',
|
||||
'plan2code-init-update.md',
|
||||
'plan2code-quick-task.md',
|
||||
];
|
||||
|
||||
const contents: Record<string, string> = {};
|
||||
for (const file of promptFiles) {
|
||||
try {
|
||||
contents[file] = fs.readFileSync(path.join(srcDir, file), 'utf8');
|
||||
} catch {
|
||||
contents[file] = '(file not found)';
|
||||
}
|
||||
}
|
||||
return contents;
|
||||
}
|
||||
|
||||
function interpolate(template: string, vars: Record<string, string>): string {
|
||||
let result = template;
|
||||
for (const [key, value] of Object.entries(vars)) {
|
||||
result = result.replaceAll(`{{${key}}}`, value);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
function generateDiagnosisId(): string {
|
||||
const now = new Date();
|
||||
const ts = now.toISOString().replace(/[-:T.Z]/g, '').slice(0, 14);
|
||||
return `diag-${ts}`;
|
||||
}
|
||||
|
||||
// ── Main analyzer ─────────────────────────────────────────────────────────────
|
||||
|
||||
export interface AnalyzerOptions {
|
||||
aggregatedPath: string; // Path to aggregated.json
|
||||
plan2codeRoot: string; // Path to plan2code repo root
|
||||
proposalsDir: string; // Where to save diagnosis output
|
||||
model?: string; // AI model to use (default: agent's default)
|
||||
agent?: AgentType; // Agent to use (default: claude-code)
|
||||
}
|
||||
|
||||
export async function runAnalysis(opts: AnalyzerOptions): Promise<string> {
|
||||
const { aggregatedPath, plan2codeRoot, proposalsDir, model = 'default', agent = 'claude-code' } = opts;
|
||||
|
||||
// Load aggregated metrics
|
||||
let aggregated: AggregatedMetrics | null = null;
|
||||
try {
|
||||
aggregated = JSON.parse(fs.readFileSync(aggregatedPath, 'utf8')) as AggregatedMetrics;
|
||||
} catch {
|
||||
throw new Error(`Could not read aggregated metrics at ${aggregatedPath}. Run "Collect metrics" and "Import run data" first.`);
|
||||
}
|
||||
|
||||
if (aggregated.total_runs === 0) {
|
||||
throw new Error('No runs in aggregated metrics. Collect and import some runs first.');
|
||||
}
|
||||
|
||||
// Read prompt files
|
||||
const promptContents = readPromptFiles(plan2codeRoot);
|
||||
|
||||
// Format for interpolation
|
||||
const promptContentsStr = Object.entries(promptContents)
|
||||
.map(([file, content]) => `## ${file}\n\n${content}`)
|
||||
.join('\n\n---\n\n');
|
||||
|
||||
const aggregatedStr = JSON.stringify(aggregated, null, 2);
|
||||
|
||||
// Load analyze prompt template
|
||||
let analyzeTemplate: string;
|
||||
try {
|
||||
analyzeTemplate = fs.readFileSync(ANALYZE_PROMPT_PATH, 'utf8');
|
||||
} catch {
|
||||
// Fallback: look relative to cwd
|
||||
const altPath = path.join(process.cwd(), 'src', 'prompts', 'analyze.md');
|
||||
analyzeTemplate = fs.readFileSync(altPath, 'utf8');
|
||||
}
|
||||
|
||||
const fullPrompt = interpolate(analyzeTemplate, {
|
||||
aggregatedMetrics: aggregatedStr,
|
||||
promptContents: promptContentsStr,
|
||||
});
|
||||
|
||||
// Invoke Claude
|
||||
console.log(`\nInvoking AI analysis (agent: ${agent}, model: ${model === 'default' ? 'user default' : model})...`);
|
||||
console.log('This may take a minute...\n');
|
||||
|
||||
let diagnosisContent: string;
|
||||
try {
|
||||
diagnosisContent = await invokeLLM({
|
||||
prompt: fullPrompt,
|
||||
model,
|
||||
agent,
|
||||
timeout: 300_000,
|
||||
});
|
||||
} catch (err) {
|
||||
throw new Error(`AI invocation failed: ${err instanceof Error ? err.message : String(err)}\n\nMake sure the ${agent} CLI is installed and authenticated.`);
|
||||
}
|
||||
|
||||
// Save diagnosis
|
||||
const diagId = generateDiagnosisId();
|
||||
fs.mkdirSync(proposalsDir, { recursive: true });
|
||||
const diagPath = path.join(proposalsDir, `${diagId}-diagnosis.md`);
|
||||
fs.writeFileSync(diagPath, diagnosisContent, 'utf8');
|
||||
|
||||
console.log(`Diagnosis saved to: ${diagPath}`);
|
||||
return diagPath;
|
||||
}
|
||||
@@ -0,0 +1,201 @@
|
||||
/**
|
||||
* applier.ts
|
||||
* Interactive review of a PromptProposal: display colored diff per edit,
|
||||
* user approves/rejects each edit, apply approved edits to src files.
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { confirm } from '@inquirer/prompts';
|
||||
import chalk from 'chalk';
|
||||
import type { PromptEdit, PromptProposal } from './types.js';
|
||||
import { validateEdit } from './improver.js';
|
||||
|
||||
const CHAR_LIMIT = 11_000;
|
||||
|
||||
// ── Diff display ──────────────────────────────────────────────────────────────
|
||||
|
||||
function displayEditDiff(edit: PromptEdit, index: number, total: number): void {
|
||||
console.log();
|
||||
console.log(chalk.bold(`─── Edit ${index + 1} of ${total} ───────────────────────────────────`));
|
||||
console.log(chalk.cyan(`File: ${edit.file}`));
|
||||
console.log(chalk.gray(`Rationale: ${edit.rationale}`));
|
||||
console.log(chalk.gray(`Expected impact: ${edit.expected_metric_impact}`));
|
||||
console.log(chalk.gray(`Char impact: ${edit.char_count_before} → ${edit.char_count_after} (${edit.char_count_delta >= 0 ? '+' : ''}${edit.char_count_delta})`));
|
||||
|
||||
// Show char count status
|
||||
if (edit.char_count_after > CHAR_LIMIT) {
|
||||
console.log(chalk.red(`⚠ WARNING: Would exceed ${CHAR_LIMIT} char limit!`));
|
||||
} else {
|
||||
const headroom = CHAR_LIMIT - edit.char_count_after;
|
||||
console.log(chalk.green(`✓ Char count OK (${headroom} chars headroom after edit)`));
|
||||
}
|
||||
|
||||
console.log();
|
||||
console.log(chalk.bold('── REMOVED (old_text) ──'));
|
||||
|
||||
// Show old text with line-level context
|
||||
const oldLines = edit.old_text.split('\n');
|
||||
for (const line of oldLines) {
|
||||
console.log(chalk.red('- ') + chalk.red(line));
|
||||
}
|
||||
|
||||
console.log();
|
||||
console.log(chalk.bold('── ADDED (new_text) ──'));
|
||||
|
||||
const newLines = edit.new_text.split('\n');
|
||||
for (const line of newLines) {
|
||||
console.log(chalk.green('+ ') + chalk.green(line));
|
||||
}
|
||||
|
||||
console.log();
|
||||
}
|
||||
|
||||
// ── Apply edit to file ────────────────────────────────────────────────────────
|
||||
|
||||
function applyEdit(edit: PromptEdit, plan2codeRoot: string): boolean {
|
||||
// Reject path traversal attempts
|
||||
if (edit.file.includes('..') || path.isAbsolute(edit.file)) {
|
||||
console.error(chalk.red(`✗ Rejected: "${edit.file}" contains path traversal or absolute path`));
|
||||
return false;
|
||||
}
|
||||
|
||||
const filePath = path.join(plan2codeRoot, 'src', edit.file);
|
||||
try {
|
||||
let content = fs.readFileSync(filePath, 'utf8');
|
||||
if (!content.includes(edit.old_text)) {
|
||||
console.error(chalk.red(`✗ Cannot apply: old_text not found in ${edit.file} (may have been modified by a previous edit)`));
|
||||
return false;
|
||||
}
|
||||
content = content.replace(edit.old_text, edit.new_text);
|
||||
|
||||
// Post-apply char count check
|
||||
if (content.length > CHAR_LIMIT) {
|
||||
console.error(chalk.red(`✗ Cannot apply: would exceed ${CHAR_LIMIT} char limit (${content.length} chars)`));
|
||||
return false;
|
||||
}
|
||||
|
||||
fs.writeFileSync(filePath, content, 'utf8');
|
||||
console.log(chalk.green(`✓ Applied edit to ${edit.file} (now ${content.length} chars)`));
|
||||
return true;
|
||||
} catch (err) {
|
||||
console.error(chalk.red(`✗ Failed to apply edit: ${err instanceof Error ? err.message : String(err)}`));
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// ── Main applier ──────────────────────────────────────────────────────────────
|
||||
|
||||
export interface ApplierOptions {
|
||||
proposalPath: string;
|
||||
plan2codeRoot: string;
|
||||
proposalsDir: string;
|
||||
}
|
||||
|
||||
export interface ApplierResult {
|
||||
approved: number;
|
||||
rejected: number;
|
||||
applied: number;
|
||||
failed: number;
|
||||
}
|
||||
|
||||
export async function reviewAndApply(opts: ApplierOptions): Promise<ApplierResult> {
|
||||
const { proposalPath, plan2codeRoot, proposalsDir } = opts;
|
||||
|
||||
// Load proposal
|
||||
let proposal: PromptProposal;
|
||||
try {
|
||||
proposal = JSON.parse(fs.readFileSync(proposalPath, 'utf8')) as PromptProposal;
|
||||
} catch {
|
||||
throw new Error(`Could not read proposal at ${proposalPath}`);
|
||||
}
|
||||
|
||||
if (proposal.proposals.length === 0) {
|
||||
console.log(chalk.yellow('No edits in this proposal.'));
|
||||
return { approved: 0, rejected: 0, applied: 0, failed: 0 };
|
||||
}
|
||||
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('=== Plan2Code Prompt Improvement Review ==='));
|
||||
console.log(chalk.gray(`Proposal: ${proposal.proposal_id}`));
|
||||
console.log(chalk.gray(`Created: ${proposal.created_at}`));
|
||||
console.log(chalk.gray(`Based on: ${proposal.based_on_runs.length} run(s)`));
|
||||
console.log(chalk.gray(`Edits: ${proposal.proposals.length}`));
|
||||
|
||||
// Re-validate all edits against current file state
|
||||
const promptContents: Record<string, string> = {};
|
||||
const srcDir = path.join(plan2codeRoot, 'src');
|
||||
for (const edit of proposal.proposals) {
|
||||
if (!promptContents[edit.file]) {
|
||||
try {
|
||||
promptContents[edit.file] = fs.readFileSync(path.join(srcDir, edit.file), 'utf8');
|
||||
} catch {
|
||||
promptContents[edit.file] = '';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let approved = 0;
|
||||
let rejected = 0;
|
||||
let applied = 0;
|
||||
let failed = 0;
|
||||
|
||||
for (let i = 0; i < proposal.proposals.length; i++) {
|
||||
const edit = proposal.proposals[i];
|
||||
|
||||
// Re-validate
|
||||
const validation = validateEdit(edit, promptContents);
|
||||
if (!validation.valid) {
|
||||
console.log();
|
||||
console.log(chalk.red(`✗ Edit ${i + 1} is no longer valid (files may have changed):`));
|
||||
for (const err of validation.errors) {
|
||||
console.log(chalk.red(` - ${err}`));
|
||||
}
|
||||
rejected++;
|
||||
continue;
|
||||
}
|
||||
|
||||
displayEditDiff(edit, i, proposal.proposals.length);
|
||||
|
||||
const approve = await confirm({
|
||||
message: `Apply this edit to ${edit.file}?`,
|
||||
default: true,
|
||||
});
|
||||
|
||||
if (!approve) {
|
||||
console.log(chalk.gray('Skipped.'));
|
||||
rejected++;
|
||||
continue;
|
||||
}
|
||||
|
||||
approved++;
|
||||
const success = applyEdit(edit, plan2codeRoot);
|
||||
if (success) {
|
||||
applied++;
|
||||
// Update in-memory content to reflect the edit
|
||||
promptContents[edit.file] = promptContents[edit.file].replace(edit.old_text, edit.new_text);
|
||||
} else {
|
||||
failed++;
|
||||
}
|
||||
}
|
||||
|
||||
// Update proposal status
|
||||
proposal.status = applied > 0 ? 'applied' : 'rejected';
|
||||
fs.writeFileSync(proposalPath, JSON.stringify(proposal, null, 2), 'utf8');
|
||||
|
||||
// Summary
|
||||
console.log();
|
||||
console.log(chalk.bold('─── Review Complete ──────────────────────────────────'));
|
||||
console.log(`Approved: ${chalk.green(String(approved))} Rejected: ${chalk.red(String(rejected))} Applied: ${chalk.green(String(applied))} Failed: ${chalk.red(String(failed))}`);
|
||||
|
||||
if (applied > 0) {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('Next steps — create a PR with your changes:'));
|
||||
console.log(chalk.gray(' git add src/'));
|
||||
console.log(chalk.gray(` git commit -m "metrics: apply prompt improvements (${proposal.proposal_id})"`));
|
||||
console.log(chalk.gray(' git push -u origin HEAD'));
|
||||
console.log(chalk.gray(' gh pr create --title "metrics: apply gen N improvements"'));
|
||||
}
|
||||
|
||||
return { approved, rejected, applied, failed };
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
import { runCLI } from '../cli.js';
|
||||
|
||||
async function main() {
|
||||
try {
|
||||
await runCLI();
|
||||
process.exit(0);
|
||||
} catch (err) {
|
||||
if (err instanceof Error && err.message.includes('User force closed')) {
|
||||
// Ctrl+C — exit cleanly
|
||||
process.exit(0);
|
||||
}
|
||||
console.error(err instanceof Error ? err.message : String(err));
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
main();
|
||||
@@ -0,0 +1,841 @@
|
||||
/**
|
||||
* cli.ts
|
||||
* 100% interactive menu-driven CLI for plan2code-metrics.
|
||||
* No flags — all inputs collected via @inquirer/prompts.
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
import os from 'os';
|
||||
import path from 'path';
|
||||
import { select, input, confirm } from '@inquirer/prompts';
|
||||
import chalk from 'chalk';
|
||||
import ora from 'ora';
|
||||
import { collectRun } from './collector.js';
|
||||
import { aggregate, loadAggregated, importRun, loadRunFiles } from './aggregator.js';
|
||||
import { runAnalysis } from './analyzer.js';
|
||||
import { generateImprovement } from './improver.js';
|
||||
import { reviewAndApply } from './applier.js';
|
||||
import type { AggregatedMetrics, CohortMetrics } from './types.js';
|
||||
import { METRIC_TARGETS } from './types.js';
|
||||
import { AGENTS, type AgentType } from './invoke-llm.js';
|
||||
|
||||
// ── Session state (set at startup via interactive prompts) ───────────────────
|
||||
|
||||
let resolvedPlan2CodeRoot = '';
|
||||
let resolvedProjectRoot = '';
|
||||
|
||||
// ── Persisted user config (~/.plan2code-metrics.json) ──────────────────────
|
||||
|
||||
const USER_CONFIG_PATH = path.join(os.homedir(), '.plan2code-metrics.json');
|
||||
|
||||
interface UserConfig {
|
||||
plan2codeRepoPath?: string;
|
||||
}
|
||||
|
||||
function loadUserConfig(): UserConfig {
|
||||
try {
|
||||
return JSON.parse(fs.readFileSync(USER_CONFIG_PATH, 'utf8'));
|
||||
} catch {
|
||||
return {};
|
||||
}
|
||||
}
|
||||
|
||||
function saveUserConfig(config: UserConfig): void {
|
||||
try {
|
||||
fs.writeFileSync(USER_CONFIG_PATH, JSON.stringify(config, null, 2), 'utf8');
|
||||
} catch { /* best-effort */ }
|
||||
}
|
||||
|
||||
// ── Defaults ──────────────────────────────────────────────────────────────────
|
||||
|
||||
const DEFAULT_METRICS_DIR = '.plan2code-metrics';
|
||||
const DEFAULT_RUNS_SUBDIR = 'runs';
|
||||
const DEFAULT_AGGREGATED_FILE = 'aggregated.json';
|
||||
const DEFAULT_PROPOSALS_SUBDIR = 'proposals';
|
||||
|
||||
function getMetricsDirs(baseDir = resolvedProjectRoot) {
|
||||
const metricsDir = path.join(baseDir, DEFAULT_METRICS_DIR);
|
||||
return {
|
||||
metricsDir,
|
||||
runsDir: path.join(metricsDir, DEFAULT_RUNS_SUBDIR),
|
||||
aggregatedPath: path.join(metricsDir, DEFAULT_AGGREGATED_FILE),
|
||||
proposalsDir: path.join(metricsDir, DEFAULT_PROPOSALS_SUBDIR),
|
||||
};
|
||||
}
|
||||
|
||||
// Detect plan2code root (either this directory or parent directories)
|
||||
function detectPlan2CodeRoot(): string | null {
|
||||
let dir = process.cwd();
|
||||
for (let i = 0; i < 5; i++) {
|
||||
const srcDir = path.join(dir, 'src');
|
||||
if (
|
||||
fs.existsSync(path.join(srcDir, 'plan2code-1-plan.md')) &&
|
||||
fs.existsSync(path.join(srcDir, 'plan2code-2-document.md'))
|
||||
) {
|
||||
return dir;
|
||||
}
|
||||
const parent = path.dirname(dir);
|
||||
if (parent === dir) break;
|
||||
dir = parent;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
// Detect plan2code version
|
||||
function detectPlan2CodeVersion(plan2codeRoot: string): string {
|
||||
try {
|
||||
const versionPath = path.join(plan2codeRoot, 'version.json');
|
||||
const content = JSON.parse(fs.readFileSync(versionPath, 'utf8'));
|
||||
return content.version ?? '0.0.0';
|
||||
} catch {
|
||||
try {
|
||||
const pkg = JSON.parse(fs.readFileSync(path.join(plan2codeRoot, 'package.json'), 'utf8'));
|
||||
return pkg.version ?? '0.0.0';
|
||||
} catch {
|
||||
return '0.0.0';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Metric health helpers ─────────────────────────────────────────────────────
|
||||
|
||||
function metricStatus(key: string, value: number | null): string {
|
||||
if (value == null) return chalk.gray('N/A');
|
||||
const target = METRIC_TARGETS[key as keyof typeof METRIC_TARGETS];
|
||||
if (!target) return chalk.white(String(Math.round(value * 100) / 100));
|
||||
|
||||
const ok = target.direction === 'gte' ? value >= target.target : value <= target.target;
|
||||
const formatted = Number.isInteger(value) ? String(value) : value.toFixed(2);
|
||||
return ok ? chalk.green(`✓ ${formatted}`) : chalk.red(`✗ ${formatted} (target: ${target.direction === 'gte' ? '≥' : '≤'}${target.target})`);
|
||||
}
|
||||
|
||||
// ── Agent + model selection ───────────────────────────────────────────────────
|
||||
|
||||
async function selectAgentAndModel(): Promise<{ agent: AgentType; model: string }> {
|
||||
const agentChoice = await select({
|
||||
message: 'Which AI agent?',
|
||||
choices: Object.values(AGENTS).map(a => ({ name: a.displayName, value: a.name })),
|
||||
});
|
||||
|
||||
return { agent: agentChoice, model: AGENTS[agentChoice].defaultModel };
|
||||
}
|
||||
|
||||
// ── Flow: Collect metrics ─────────────────────────────────────────────────────
|
||||
|
||||
async function flowCollect(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Collect Metrics ──'));
|
||||
|
||||
const sourceChoice = await select({
|
||||
message: 'Where is the completed project spec?',
|
||||
choices: [
|
||||
{ name: 'Archived spec (specs--completed/<feature-name>/)', value: 'archived' },
|
||||
{ name: 'Active spec directory (specs/<feature-name>/)', value: 'active' },
|
||||
{ name: 'Custom path', value: 'custom' },
|
||||
],
|
||||
});
|
||||
|
||||
let specDir: string;
|
||||
let projectName: string;
|
||||
|
||||
if (sourceChoice === 'active' || sourceChoice === 'archived') {
|
||||
const baseSubdir = sourceChoice === 'active' ? 'specs' : 'specs--completed';
|
||||
const baseDir = path.join(resolvedProjectRoot, baseSubdir);
|
||||
|
||||
if (!fs.existsSync(baseDir)) {
|
||||
console.log(chalk.red(`No ${baseSubdir}/ directory found in ${resolvedProjectRoot}`));
|
||||
return;
|
||||
}
|
||||
|
||||
const entries = fs.readdirSync(baseDir)
|
||||
.filter(f => fs.statSync(path.join(baseDir, f)).isDirectory());
|
||||
|
||||
if (entries.length === 0) {
|
||||
console.log(chalk.red(`No spec directories found in ${baseSubdir}/`));
|
||||
return;
|
||||
}
|
||||
|
||||
const chosen = await select({
|
||||
message: 'Select spec directory:',
|
||||
choices: entries.map(e => ({ name: e, value: e })),
|
||||
});
|
||||
|
||||
specDir = path.join(baseDir, chosen);
|
||||
projectName = chosen;
|
||||
} else {
|
||||
specDir = await input({
|
||||
message: 'Enter full path to spec directory:',
|
||||
validate: (v) => fs.existsSync(v) ? true : 'Directory not found',
|
||||
});
|
||||
projectName = await input({
|
||||
message: 'Project name (for metrics label):',
|
||||
default: path.basename(specDir),
|
||||
});
|
||||
}
|
||||
|
||||
// Detect plan2code root
|
||||
const plan2codeRoot = resolvedPlan2CodeRoot;
|
||||
const plan2codeVersion = detectPlan2CodeVersion(plan2codeRoot);
|
||||
|
||||
const { runsDir, aggregatedPath } = getMetricsDirs();
|
||||
|
||||
const spinner = ora('Collecting metrics from project artifacts...').start();
|
||||
try {
|
||||
const metrics = await collectRun({
|
||||
specDir,
|
||||
projectName,
|
||||
plan2codeRoot,
|
||||
plan2codeVersion,
|
||||
outputDir: runsDir,
|
||||
});
|
||||
|
||||
spinner.succeed(`Metrics collected: ${metrics.run_id}`);
|
||||
console.log(chalk.gray(` Saved to: ${runsDir}/${metrics.run_id}.json`));
|
||||
|
||||
// Re-aggregate
|
||||
aggregate(runsDir, aggregatedPath);
|
||||
console.log(chalk.gray(' Aggregated metrics updated.'));
|
||||
|
||||
// Show summary
|
||||
console.log();
|
||||
console.log(chalk.bold('Collected:'));
|
||||
console.log(` Step 1 (Plan): ${metrics.step1_plan.present ? chalk.green('✓') : chalk.gray('—')}`);
|
||||
console.log(` Step 2 (Document): ${metrics.step2_document.present ? chalk.green('✓') : chalk.gray('—')}`);
|
||||
console.log(` Step 3 (Implement): ${metrics.step3_implement.present ? chalk.green('✓') : chalk.gray('—')}`);
|
||||
console.log(` Step 4 (Finalize): ${metrics.step4_finalize.present ? chalk.green('✓') : chalk.gray('—')}`);
|
||||
console.log(` User Feedback: ${metrics.user_feedback ? chalk.green(`✓ (${metrics.user_feedback.overall_rating}/10)`) : chalk.gray('—')}`);
|
||||
|
||||
// Offer to collect feedback interactively if not present
|
||||
if (!metrics.user_feedback) {
|
||||
console.log();
|
||||
const wantFeedback = await confirm({
|
||||
message: 'No user feedback found in overview.md. Would you like to provide feedback now?',
|
||||
default: false,
|
||||
});
|
||||
|
||||
if (wantFeedback) {
|
||||
const rating = await input({
|
||||
message: 'Overall rating (1-10):',
|
||||
validate: (v) => {
|
||||
const n = parseInt(v, 10);
|
||||
return (n >= 1 && n <= 10) ? true : 'Must be a number between 1 and 10';
|
||||
},
|
||||
});
|
||||
const reason = await input({ message: 'Rating reason:' });
|
||||
const wentWell = await input({ message: 'What went well?' });
|
||||
const wentPoorly = await input({ message: 'What went poorly?' });
|
||||
|
||||
// Write the feedback table into overview.md
|
||||
const overviewPath = path.join(specDir, 'overview.md');
|
||||
let overviewContent = '';
|
||||
try {
|
||||
overviewContent = fs.readFileSync(overviewPath, 'utf8');
|
||||
} catch { /* empty */ }
|
||||
|
||||
// Escape pipe characters in user text to prevent table parsing issues
|
||||
const esc = (s: string) => s.replace(/\|/g, '\\|');
|
||||
|
||||
const feedbackTable = [
|
||||
'',
|
||||
'## User Feedback',
|
||||
'| Field | Value |',
|
||||
'|-------|-------|',
|
||||
`| Rating | ${rating} |`,
|
||||
`| Reason | ${esc(reason)} |`,
|
||||
`| Went Well | ${esc(wentWell)} |`,
|
||||
`| Went Poorly | ${esc(wentPoorly)} |`,
|
||||
'',
|
||||
].join('\n');
|
||||
|
||||
fs.writeFileSync(overviewPath, overviewContent + feedbackTable, 'utf8');
|
||||
console.log(chalk.green('✓ Feedback written to overview.md'));
|
||||
|
||||
// Delete the original run (without feedback) before re-collecting
|
||||
const originalRunPath = path.join(runsDir, `${metrics.run_id}.json`);
|
||||
try { fs.unlinkSync(originalRunPath); } catch { /* ignore */ }
|
||||
|
||||
// Re-collect and re-aggregate
|
||||
const reSpinner = ora('Re-collecting metrics with feedback...').start();
|
||||
const updatedMetrics = await collectRun({
|
||||
specDir,
|
||||
projectName,
|
||||
plan2codeRoot,
|
||||
plan2codeVersion,
|
||||
outputDir: runsDir,
|
||||
});
|
||||
aggregate(runsDir, aggregatedPath);
|
||||
reSpinner.succeed(`Updated: ${updatedMetrics.run_id} (rating: ${updatedMetrics.user_feedback?.overall_rating}/10)`);
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
spinner.fail(`Collection failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
}
|
||||
|
||||
// ── Flow: Import run data ─────────────────────────────────────────────────────
|
||||
|
||||
async function flowImport(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Import Run Data ──'));
|
||||
console.log(chalk.gray('Copy a run JSON from another project into this repo for aggregation.'));
|
||||
console.log();
|
||||
|
||||
const sourcePath = await input({
|
||||
message: 'Path to run JSON file (e.g., /path/to/project/.plan2code-metrics/runs/run-xxx.json):',
|
||||
validate: (v) => {
|
||||
if (!fs.existsSync(v)) return 'File not found';
|
||||
if (!v.endsWith('.json')) return 'Must be a .json file';
|
||||
return true;
|
||||
},
|
||||
});
|
||||
|
||||
const { runsDir, aggregatedPath } = getMetricsDirs();
|
||||
|
||||
try {
|
||||
const imported = importRun(sourcePath, runsDir);
|
||||
if (!imported) {
|
||||
console.log(chalk.yellow('Run already imported (same run_id exists).'));
|
||||
} else {
|
||||
console.log(chalk.green(`✓ Imported ${path.basename(sourcePath)}`));
|
||||
}
|
||||
|
||||
const spinner = ora('Re-aggregating...').start();
|
||||
const aggregated = aggregate(runsDir, aggregatedPath);
|
||||
spinner.succeed(`Aggregated metrics updated (${aggregated.total_runs} total runs)`);
|
||||
} catch (err) {
|
||||
console.error(chalk.red(`Import failed: ${err instanceof Error ? err.message : String(err)}`));
|
||||
}
|
||||
}
|
||||
|
||||
// ── Flow: View metrics status ─────────────────────────────────────────────────
|
||||
|
||||
async function flowViewStatus(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Metrics Status & History ──'));
|
||||
|
||||
const { runsDir, aggregatedPath } = getMetricsDirs();
|
||||
const aggregated = loadAggregated(aggregatedPath);
|
||||
|
||||
if (!aggregated || aggregated.total_runs === 0) {
|
||||
console.log(chalk.yellow('No metrics collected yet. Use "Collect metrics" to get started.'));
|
||||
return;
|
||||
}
|
||||
|
||||
console.log();
|
||||
console.log(chalk.bold(`Total runs: ${aggregated.total_runs} | Generations: ${aggregated.cohorts.length}`));
|
||||
console.log(chalk.gray(`Last updated: ${aggregated.last_updated}`));
|
||||
|
||||
for (let i = 0; i < aggregated.cohorts.length; i++) {
|
||||
const cohort = aggregated.cohorts[i];
|
||||
const isCurrent = cohort.cohort_key === aggregated.current_cohort_key;
|
||||
const label = isCurrent ? chalk.bold.green('[CURRENT]') : '';
|
||||
|
||||
console.log();
|
||||
console.log(chalk.bold(`Generation ${i + 1} (sha:${cohort.cohort_key}) — ${cohort.run_count} run(s) ${label}`));
|
||||
console.log(chalk.gray(` Period: ${cohort.first_seen?.slice(0, 10)} → ${cohort.last_seen?.slice(0, 10)}`));
|
||||
|
||||
// Step 1 metrics
|
||||
if (cohort.avg_confidence != null || cohort.avg_clarification_rounds != null) {
|
||||
console.log(chalk.bold(' Step 1 (Plan):'));
|
||||
if (cohort.avg_confidence != null)
|
||||
console.log(` avg_confidence: ${metricStatus('avg_confidence', cohort.avg_confidence)}`);
|
||||
if (cohort.avg_clarification_rounds != null)
|
||||
console.log(` avg_clarification_rounds: ${metricStatus('avg_clarification_rounds', cohort.avg_clarification_rounds)}`);
|
||||
if (cohort.avg_verification_gaps_found != null)
|
||||
console.log(` avg_verification_gaps: ${metricStatus('avg_verification_gaps_found', cohort.avg_verification_gaps_found)}`);
|
||||
}
|
||||
|
||||
// Step 2 metrics
|
||||
if (cohort.avg_total_tasks != null || cohort.avg_parallel_groups != null) {
|
||||
console.log(chalk.bold(' Step 2 (Document):'));
|
||||
if (cohort.avg_total_tasks != null)
|
||||
console.log(` avg_total_tasks: ${chalk.white(cohort.avg_total_tasks.toFixed(1))}`);
|
||||
if (cohort.avg_parallel_groups != null)
|
||||
console.log(` avg_parallel_groups: ${metricStatus('avg_parallel_groups', cohort.avg_parallel_groups)}`);
|
||||
if (cohort.avg_verification_items_added != null)
|
||||
console.log(` avg_verification_items: ${metricStatus('avg_verification_items_added', cohort.avg_verification_items_added)}`);
|
||||
}
|
||||
|
||||
// Step 3 metrics
|
||||
if (cohort.avg_task_completion_rate != null || cohort.avg_blocker_count != null) {
|
||||
console.log(chalk.bold(' Step 3 (Implement):'));
|
||||
if (cohort.avg_task_completion_rate != null)
|
||||
console.log(` avg_task_completion_rate: ${metricStatus('avg_task_completion_rate', cohort.avg_task_completion_rate)}`);
|
||||
if (cohort.avg_blocker_count != null)
|
||||
console.log(` avg_blocker_count: ${metricStatus('avg_blocker_count', cohort.avg_blocker_count)}`);
|
||||
}
|
||||
|
||||
// Step 4 metrics
|
||||
if (cohort.avg_completion_rate_at_audit != null || cohort.archival_success_rate != null) {
|
||||
console.log(chalk.bold(' Step 4 (Finalize):'));
|
||||
if (cohort.avg_completion_rate_at_audit != null)
|
||||
console.log(` avg_completion_at_audit: ${chalk.white(cohort.avg_completion_rate_at_audit.toFixed(2))}`);
|
||||
if (cohort.avg_verification_failures_found != null)
|
||||
console.log(` avg_verif_failures: ${metricStatus('avg_verification_failures_found', cohort.avg_verification_failures_found)}`);
|
||||
if (cohort.archival_success_rate != null)
|
||||
console.log(` archival_success_rate: ${metricStatus('archival_success_rate', cohort.archival_success_rate)}`);
|
||||
}
|
||||
|
||||
// User feedback
|
||||
if (cohort.feedback_count > 0) {
|
||||
console.log(chalk.bold(' User Feedback:'));
|
||||
console.log(` avg_user_rating: ${metricStatus('avg_user_rating', cohort.avg_user_rating)}`);
|
||||
console.log(` feedback_count: ${chalk.white(String(cohort.feedback_count))}`);
|
||||
}
|
||||
|
||||
// Compare with previous generation
|
||||
if (i > 0) {
|
||||
const prev = aggregated.cohorts[i - 1];
|
||||
const deltas: string[] = [];
|
||||
if (cohort.avg_confidence != null && prev.avg_confidence != null) {
|
||||
const d = cohort.avg_confidence - prev.avg_confidence;
|
||||
deltas.push(`confidence ${d >= 0 ? chalk.green(`▲${d.toFixed(1)}`) : chalk.red(`▼${Math.abs(d).toFixed(1)}`)}`);
|
||||
}
|
||||
if (cohort.avg_task_completion_rate != null && prev.avg_task_completion_rate != null) {
|
||||
const d = cohort.avg_task_completion_rate - prev.avg_task_completion_rate;
|
||||
deltas.push(`completion ${d >= 0 ? chalk.green(`▲${(d * 100).toFixed(1)}%`) : chalk.red(`▼${(Math.abs(d) * 100).toFixed(1)}%`)}`);
|
||||
}
|
||||
if (deltas.length > 0) {
|
||||
console.log(chalk.gray(` vs Gen ${i}: ${deltas.join(' ')}`));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Run list
|
||||
const runs = loadRunFiles(runsDir);
|
||||
if (runs.length > 0) {
|
||||
console.log();
|
||||
console.log(chalk.bold(`Run files (${runs.length}):`));
|
||||
for (const run of runs.slice(-10)) {
|
||||
console.log(chalk.gray(` ${run.run_id} ${run.project.name} v${run.plan2code_version}`));
|
||||
}
|
||||
if (runs.length > 10) {
|
||||
console.log(chalk.gray(` ... and ${runs.length - 10} more`));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Flow: Run analysis ────────────────────────────────────────────────────────
|
||||
|
||||
async function flowRunAnalysis(): Promise<string | null> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Run Analysis (Diagnose Weak Steps) ──'));
|
||||
|
||||
const { aggregatedPath, proposalsDir } = getMetricsDirs();
|
||||
const plan2codeRoot = resolvedPlan2CodeRoot;
|
||||
|
||||
const aggregated = loadAggregated(aggregatedPath);
|
||||
if (!aggregated || aggregated.total_runs === 0) {
|
||||
console.log(chalk.yellow('No aggregated metrics found. Collect and import runs first.'));
|
||||
return null;
|
||||
}
|
||||
|
||||
if (aggregated.total_runs < 3) {
|
||||
const proceed = await confirm({
|
||||
message: `Only ${aggregated.total_runs} run(s) available (≥3 recommended for reliable analysis). Proceed anyway?`,
|
||||
default: false,
|
||||
});
|
||||
if (!proceed) return null;
|
||||
}
|
||||
|
||||
const { agent, model } = await selectAgentAndModel();
|
||||
|
||||
try {
|
||||
const diagPath = await runAnalysis({
|
||||
aggregatedPath,
|
||||
plan2codeRoot,
|
||||
proposalsDir,
|
||||
model,
|
||||
agent,
|
||||
});
|
||||
|
||||
console.log();
|
||||
console.log(chalk.green('✓ Analysis complete'));
|
||||
console.log(chalk.gray(`Diagnosis: ${diagPath}`));
|
||||
|
||||
const viewNow = await confirm({
|
||||
message: 'Open diagnosis in console?',
|
||||
default: true,
|
||||
});
|
||||
|
||||
if (viewNow) {
|
||||
const content = fs.readFileSync(diagPath, 'utf8');
|
||||
console.log();
|
||||
console.log(chalk.dim('─'.repeat(60)));
|
||||
console.log(content);
|
||||
console.log(chalk.dim('─'.repeat(60)));
|
||||
}
|
||||
|
||||
return diagPath;
|
||||
} catch (err) {
|
||||
console.error(chalk.red(`Analysis failed: ${err instanceof Error ? err.message : String(err)}`));
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// ── Flow: Generate improvement proposal ──────────────────────────────────────
|
||||
|
||||
async function flowGenerateProposal(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Generate Improvement Proposal ──'));
|
||||
|
||||
const { aggregatedPath, proposalsDir, runsDir } = getMetricsDirs();
|
||||
const plan2codeRoot = resolvedPlan2CodeRoot;
|
||||
|
||||
// Find diagnosis files
|
||||
let diagFiles: string[] = [];
|
||||
if (fs.existsSync(proposalsDir)) {
|
||||
diagFiles = fs.readdirSync(proposalsDir)
|
||||
.filter(f => f.endsWith('-diagnosis.md'))
|
||||
.sort()
|
||||
.reverse(); // most recent first
|
||||
}
|
||||
|
||||
let diagnosisPath: string;
|
||||
|
||||
if (diagFiles.length === 0) {
|
||||
console.log(chalk.yellow('No diagnosis files found. Running analysis first...'));
|
||||
const diagPath = await flowRunAnalysis();
|
||||
if (!diagPath) return;
|
||||
diagnosisPath = diagPath;
|
||||
} else {
|
||||
const choice = await select({
|
||||
message: 'Select diagnosis to base proposal on:',
|
||||
choices: [
|
||||
...diagFiles.map(f => ({ name: f, value: path.join(proposalsDir, f) })),
|
||||
{ name: '(run new analysis first)', value: '__new__' },
|
||||
],
|
||||
});
|
||||
|
||||
if (choice === '__new__') {
|
||||
const diagPath = await flowRunAnalysis();
|
||||
if (!diagPath) return;
|
||||
diagnosisPath = diagPath;
|
||||
} else {
|
||||
diagnosisPath = choice;
|
||||
}
|
||||
}
|
||||
|
||||
const { agent, model } = await selectAgentAndModel();
|
||||
|
||||
try {
|
||||
const result = await generateImprovement({
|
||||
diagnosisPath,
|
||||
plan2codeRoot,
|
||||
proposalsDir,
|
||||
runsDir,
|
||||
model,
|
||||
agent,
|
||||
});
|
||||
|
||||
console.log();
|
||||
console.log(chalk.green(`✓ Proposal generated: ${result.proposal.proposal_id}`));
|
||||
console.log(chalk.gray(` Valid edits: ${result.validEditCount}`));
|
||||
console.log(chalk.gray(` Invalid edits: ${result.invalidEditCount} (rejected)`));
|
||||
console.log(chalk.gray(` Saved to: ${result.proposalPath}`));
|
||||
|
||||
if (result.validEditCount > 0) {
|
||||
const reviewNow = await confirm({
|
||||
message: 'Review and apply edits now?',
|
||||
default: true,
|
||||
});
|
||||
|
||||
if (reviewNow) {
|
||||
await reviewAndApply({
|
||||
proposalPath: result.proposalPath,
|
||||
plan2codeRoot,
|
||||
proposalsDir,
|
||||
});
|
||||
}
|
||||
}
|
||||
} catch (err) {
|
||||
console.error(chalk.red(`Proposal generation failed: ${err instanceof Error ? err.message : String(err)}`));
|
||||
}
|
||||
}
|
||||
|
||||
// ── Flow: Review and apply proposal ──────────────────────────────────────────
|
||||
|
||||
async function flowReviewAndApply(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Review and Apply a Proposal ──'));
|
||||
|
||||
const { proposalsDir } = getMetricsDirs();
|
||||
const plan2codeRoot = resolvedPlan2CodeRoot;
|
||||
|
||||
if (!fs.existsSync(proposalsDir)) {
|
||||
console.log(chalk.yellow('No proposals directory found. Generate a proposal first.'));
|
||||
return;
|
||||
}
|
||||
|
||||
const proposalFiles = fs.readdirSync(proposalsDir)
|
||||
.filter(f => /^prop-\d+\.json$/.test(f))
|
||||
.sort()
|
||||
.reverse(); // most recent first
|
||||
|
||||
if (proposalFiles.length === 0) {
|
||||
console.log(chalk.yellow('No proposal files found. Generate a proposal first.'));
|
||||
return;
|
||||
}
|
||||
|
||||
const chosen = await select({
|
||||
message: 'Select proposal to review:',
|
||||
choices: proposalFiles.map(f => {
|
||||
try {
|
||||
const p = JSON.parse(fs.readFileSync(path.join(proposalsDir, f), 'utf8'));
|
||||
const label = `${f} [${p.status}] ${p.proposals?.length ?? 0} edits`;
|
||||
return { name: label, value: path.join(proposalsDir, f) };
|
||||
} catch {
|
||||
return { name: f, value: path.join(proposalsDir, f) };
|
||||
}
|
||||
}),
|
||||
});
|
||||
|
||||
await reviewAndApply({
|
||||
proposalPath: chosen,
|
||||
plan2codeRoot,
|
||||
proposalsDir,
|
||||
});
|
||||
}
|
||||
|
||||
// ── Flow: Delete metrics data ─────────────────────────────────────────────────
|
||||
|
||||
async function flowDelete(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.cyan('── Delete Metrics Data ──'));
|
||||
|
||||
const { metricsDir, runsDir, aggregatedPath, proposalsDir } = getMetricsDirs();
|
||||
|
||||
if (!fs.existsSync(metricsDir)) {
|
||||
console.log(chalk.yellow('No metrics data found (.plan2code-metrics/ does not exist).'));
|
||||
return;
|
||||
}
|
||||
|
||||
const scope = await select({
|
||||
message: 'What do you want to delete?',
|
||||
choices: [
|
||||
{ name: 'Delete specific run(s)', value: 'select' },
|
||||
{ name: 'Delete all runs and aggregated data', value: 'runs' },
|
||||
{ name: 'Delete everything (runs, aggregated data, proposals)', value: 'all' },
|
||||
{ name: 'Cancel', value: 'cancel' },
|
||||
],
|
||||
});
|
||||
|
||||
if (scope === 'cancel') return;
|
||||
|
||||
if (scope === 'select') {
|
||||
const runs = loadRunFiles(runsDir);
|
||||
if (runs.length === 0) {
|
||||
console.log(chalk.yellow('No run files found.'));
|
||||
return;
|
||||
}
|
||||
|
||||
const choices = runs.map(r => ({
|
||||
name: `${r.run_id} ${r.project.name} v${r.plan2code_version}`,
|
||||
value: r.run_id,
|
||||
}));
|
||||
|
||||
// Select runs one at a time since @inquirer/prompts select is single-choice
|
||||
const toDelete: string[] = [];
|
||||
let selecting = true;
|
||||
while (selecting) {
|
||||
const remaining = choices.filter(c => !toDelete.includes(c.value));
|
||||
if (remaining.length === 0) break;
|
||||
|
||||
const chosen = await select({
|
||||
message: `Select a run to delete (${toDelete.length} selected so far):`,
|
||||
choices: [
|
||||
...remaining,
|
||||
{ name: toDelete.length > 0 ? `Done selecting (delete ${toDelete.length})` : 'Cancel', value: '__done__' },
|
||||
],
|
||||
});
|
||||
|
||||
if (chosen === '__done__') {
|
||||
selecting = false;
|
||||
} else {
|
||||
toDelete.push(chosen);
|
||||
console.log(chalk.gray(` + ${chosen}`));
|
||||
}
|
||||
}
|
||||
|
||||
if (toDelete.length === 0) return;
|
||||
|
||||
const confirmed = await confirm({
|
||||
message: `Delete ${toDelete.length} run(s)? This cannot be undone.`,
|
||||
default: false,
|
||||
});
|
||||
if (!confirmed) return;
|
||||
|
||||
let deleted = 0;
|
||||
for (const runId of toDelete) {
|
||||
const filePath = path.join(runsDir, `${runId}.json`);
|
||||
try {
|
||||
fs.unlinkSync(filePath);
|
||||
deleted++;
|
||||
} catch {
|
||||
console.log(chalk.yellow(` Could not delete ${runId}.json`));
|
||||
}
|
||||
}
|
||||
|
||||
console.log(chalk.green(`✓ Deleted ${deleted} run(s).`));
|
||||
|
||||
// Re-aggregate with remaining runs
|
||||
const remainingRuns = loadRunFiles(runsDir);
|
||||
if (remainingRuns.length > 0) {
|
||||
aggregate(runsDir, aggregatedPath);
|
||||
console.log(chalk.gray(` Aggregated metrics updated (${remainingRuns.length} runs remaining).`));
|
||||
} else {
|
||||
try { fs.unlinkSync(aggregatedPath); } catch { /* ignore */ }
|
||||
console.log(chalk.gray(' No runs remaining — aggregated data removed.'));
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// scope === 'runs' or 'all'
|
||||
const label = scope === 'all'
|
||||
? 'ALL metrics data (runs, aggregated data, and proposals)'
|
||||
: 'all runs and aggregated data';
|
||||
|
||||
const confirmed = await confirm({
|
||||
message: `Delete ${label}? This cannot be undone.`,
|
||||
default: false,
|
||||
});
|
||||
if (!confirmed) return;
|
||||
|
||||
// Delete run files
|
||||
let runCount = 0;
|
||||
if (fs.existsSync(runsDir)) {
|
||||
const files = fs.readdirSync(runsDir).filter(f => f.endsWith('.json'));
|
||||
for (const f of files) {
|
||||
try { fs.unlinkSync(path.join(runsDir, f)); runCount++; } catch { /* ignore */ }
|
||||
}
|
||||
}
|
||||
|
||||
// Delete aggregated file
|
||||
try { fs.unlinkSync(aggregatedPath); } catch { /* ignore */ }
|
||||
|
||||
console.log(chalk.green(`✓ Deleted ${runCount} run(s) and aggregated data.`));
|
||||
|
||||
if (scope === 'all') {
|
||||
// Delete proposals
|
||||
let proposalCount = 0;
|
||||
if (fs.existsSync(proposalsDir)) {
|
||||
const files = fs.readdirSync(proposalsDir);
|
||||
for (const f of files) {
|
||||
try { fs.unlinkSync(path.join(proposalsDir, f)); proposalCount++; } catch { /* ignore */ }
|
||||
}
|
||||
try { fs.rmdirSync(proposalsDir); } catch { /* ignore */ }
|
||||
}
|
||||
console.log(chalk.green(`✓ Deleted ${proposalCount} proposal file(s).`));
|
||||
}
|
||||
}
|
||||
|
||||
// ── Main menu ─────────────────────────────────────────────────────────────────
|
||||
|
||||
export async function runCLI(): Promise<void> {
|
||||
console.log();
|
||||
console.log(chalk.bold.white('plan2code-metrics'));
|
||||
console.log(chalk.gray('Recursive self-improvement toolchain for plan2code contributors'));
|
||||
console.log();
|
||||
|
||||
// ── Prompt for paths ────────────────────────────────────────────────────────
|
||||
|
||||
const userConfig = loadUserConfig();
|
||||
const savedRoot = userConfig.plan2codeRepoPath && fs.existsSync(userConfig.plan2codeRepoPath)
|
||||
? userConfig.plan2codeRepoPath
|
||||
: null;
|
||||
const detectedRoot = savedRoot ?? detectPlan2CodeRoot();
|
||||
|
||||
const s2cPath = await input({
|
||||
message: 'Path to plan2code repo:',
|
||||
default: detectedRoot ?? undefined,
|
||||
validate: (v) => {
|
||||
if (!v.trim()) return 'Path is required';
|
||||
const resolved = path.resolve(v.trim());
|
||||
if (!fs.existsSync(resolved)) return 'Directory not found';
|
||||
return true;
|
||||
},
|
||||
});
|
||||
resolvedPlan2CodeRoot = path.resolve(s2cPath.trim());
|
||||
|
||||
// Persist the path for next run
|
||||
if (resolvedPlan2CodeRoot !== userConfig.plan2codeRepoPath) {
|
||||
saveUserConfig({ ...userConfig, plan2codeRepoPath: resolvedPlan2CodeRoot });
|
||||
}
|
||||
|
||||
// Warn if the path doesn't look like a plan2code repo
|
||||
const hasSrcPrompts =
|
||||
fs.existsSync(path.join(resolvedPlan2CodeRoot, 'src', 'plan2code-1-plan.md')) &&
|
||||
fs.existsSync(path.join(resolvedPlan2CodeRoot, 'src', 'plan2code-2-document.md'));
|
||||
if (!hasSrcPrompts) {
|
||||
console.log(chalk.yellow('⚠ No src/plan2code-*.md prompts found at that path. Hashing and analysis may be limited.'));
|
||||
}
|
||||
|
||||
const projPath = await input({
|
||||
message: 'Path to project repo (metrics source):',
|
||||
default: process.cwd(),
|
||||
validate: (v) => {
|
||||
if (!v.trim()) return 'Path is required';
|
||||
const resolved = path.resolve(v.trim());
|
||||
if (!fs.existsSync(resolved)) return 'Directory not found';
|
||||
return true;
|
||||
},
|
||||
});
|
||||
resolvedProjectRoot = path.resolve(projPath.trim());
|
||||
|
||||
// Display resolved paths
|
||||
const version = detectPlan2CodeVersion(resolvedPlan2CodeRoot);
|
||||
console.log();
|
||||
console.log(chalk.gray(`plan2code repo: ${resolvedPlan2CodeRoot} (v${version})`));
|
||||
console.log(chalk.gray(`project repo: ${resolvedProjectRoot}`));
|
||||
console.log();
|
||||
|
||||
let continueLoop = true;
|
||||
while (continueLoop) {
|
||||
const action = await select({
|
||||
message: 'What would you like to do?',
|
||||
choices: [
|
||||
{ name: 'Collect metrics for a completed project', value: 'collect' },
|
||||
{ name: 'Import run data from another project', value: 'import' },
|
||||
{ name: 'View metrics status and history', value: 'view' },
|
||||
{ name: 'Run analysis (diagnose weak steps)', value: 'analyze' },
|
||||
{ name: 'Generate improvement proposal', value: 'propose' },
|
||||
{ name: 'Review and apply a proposal', value: 'apply' },
|
||||
{ name: chalk.red('Delete metrics data'), value: 'delete' },
|
||||
{ name: 'Exit', value: 'exit' },
|
||||
],
|
||||
});
|
||||
|
||||
switch (action) {
|
||||
case 'collect':
|
||||
await flowCollect();
|
||||
break;
|
||||
case 'import':
|
||||
await flowImport();
|
||||
break;
|
||||
case 'view':
|
||||
await flowViewStatus();
|
||||
break;
|
||||
case 'analyze':
|
||||
await flowRunAnalysis();
|
||||
break;
|
||||
case 'propose':
|
||||
await flowGenerateProposal();
|
||||
break;
|
||||
case 'apply':
|
||||
await flowReviewAndApply();
|
||||
break;
|
||||
case 'delete':
|
||||
await flowDelete();
|
||||
break;
|
||||
case 'exit':
|
||||
continueLoop = false;
|
||||
break;
|
||||
}
|
||||
|
||||
if (continueLoop && action !== 'exit') {
|
||||
console.log();
|
||||
}
|
||||
}
|
||||
|
||||
console.log(chalk.gray('Goodbye.'));
|
||||
}
|
||||
@@ -0,0 +1,633 @@
|
||||
/**
|
||||
* collector.ts
|
||||
* Reads finished project artifacts and writes a RunMetrics JSON file.
|
||||
* Zero dependency on plan2code-loop internals — reads files directly.
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import crypto from 'crypto';
|
||||
import type {
|
||||
RunMetrics,
|
||||
PromptVersions,
|
||||
Step1PlanMetrics,
|
||||
Step2DocumentMetrics,
|
||||
Step3ImplementMetrics,
|
||||
Step4FinalizeMetrics,
|
||||
UserFeedback,
|
||||
} from './types.js';
|
||||
|
||||
// ── Helpers ──────────────────────────────────────────────────────────────────
|
||||
|
||||
function sha256File(filePath: string): string {
|
||||
try {
|
||||
const content = fs.readFileSync(filePath, 'utf8');
|
||||
return 'sha256:' + crypto.createHash('sha256').update(content).digest('hex');
|
||||
} catch {
|
||||
return 'sha256:missing';
|
||||
}
|
||||
}
|
||||
|
||||
function readFileSafe(filePath: string): string | null {
|
||||
try {
|
||||
return fs.readFileSync(filePath, 'utf8');
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract METRICS_JSON HTML comment blocks from a file.
|
||||
* Format: <!-- METRICS_JSON {"key": value, ...} -->
|
||||
* A file may contain multiple blocks (e.g., overview.md has document + finalize).
|
||||
* If `stepFilter` is provided, returns only the block with matching "step" field.
|
||||
* Returns parsed object or null if not found / invalid.
|
||||
*/
|
||||
function extractMetricsJson(content: string, stepFilter?: string): Record<string, unknown> | null {
|
||||
const re = /<!--\s*METRICS_JSON\s+(\{[\s\S]*?\})\s*-->/g;
|
||||
let match: RegExpExecArray | null;
|
||||
while ((match = re.exec(content)) !== null) {
|
||||
try {
|
||||
const parsed = JSON.parse(match[1]) as Record<string, unknown>;
|
||||
if (!stepFilter || parsed['step'] === stepFilter) {
|
||||
return parsed;
|
||||
}
|
||||
} catch {
|
||||
// try next match
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/** Strip the "## Success Criteria" section so its checkboxes aren't counted as tasks. */
|
||||
function stripSuccessCriteriaSection(overview: string): string {
|
||||
return overview.replace(/^## Success Criteria\s*\n[\s\S]*?(?=\n## |\n*$)/m, '');
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract canonical task counts from the Completion Summary section.
|
||||
* Supports two formats found in real specs:
|
||||
* - Bold text: "**Completion Rate:** 100% (5/5 tasks)"
|
||||
* - Table row: "| Total Tasks | 28 (28/28 complete — 100%) |"
|
||||
* Returns null when no parseable counts are found.
|
||||
*/
|
||||
function parseCompletionSummaryTaskCount(overview: string): { completed: number; total: number } | null {
|
||||
const summaryMatch = overview.match(/## Completion Summary\s*\n([\s\S]*?)(?=\n## |\n*$)/);
|
||||
if (!summaryMatch) return null;
|
||||
const summary = summaryMatch[1];
|
||||
|
||||
// "Completion Rate: X% (Y/Z tasks)" — handles bold markdown and various separators
|
||||
const rateMatch = summary.match(/\**Completion(?:\s+Rate)?\**[:\s*]+\d{1,3}%\s*\((\d+)\/(\d+)\s*tasks?\)/i);
|
||||
if (rateMatch) return { completed: parseInt(rateMatch[1], 10), total: parseInt(rateMatch[2], 10) };
|
||||
|
||||
// "Total Tasks | 28 (28/28 complete"
|
||||
const tableMatch = summary.match(/Total Tasks\s*\|\s*(\d+)\s*\((\d+)\/(\d+)\s*complete/i);
|
||||
if (tableMatch) return { completed: parseInt(tableMatch[2], 10), total: parseInt(tableMatch[3], 10) };
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
function generateRunId(): string {
|
||||
const now = new Date();
|
||||
const ts = now.toISOString().replace(/[-:T]/g, '').slice(0, 14);
|
||||
const rand = crypto.randomBytes(2).toString('hex');
|
||||
return `run-${ts.slice(0, 8)}-${ts.slice(8, 14)}-${rand}`;
|
||||
}
|
||||
|
||||
// ── Prompt version hashing ────────────────────────────────────────────────────
|
||||
|
||||
export function collectPromptVersions(plan2codeRoot: string): PromptVersions {
|
||||
const srcDir = path.join(plan2codeRoot, 'src');
|
||||
return {
|
||||
plan: sha256File(path.join(srcDir, 'plan2code-1-plan.md')),
|
||||
revise_plan: sha256File(path.join(srcDir, 'plan2code-1b-revise-plan.md')),
|
||||
document: sha256File(path.join(srcDir, 'plan2code-2-document.md')),
|
||||
implement: sha256File(path.join(srcDir, 'plan2code-3-implement.md')),
|
||||
finalize: sha256File(path.join(srcDir, 'plan2code-4-finalize.md')),
|
||||
init: sha256File(path.join(srcDir, 'plan2code-init.md')),
|
||||
init_update: sha256File(path.join(srcDir, 'plan2code-init-update.md')),
|
||||
quick_task: sha256File(path.join(srcDir, 'plan2code-quick-task.md')),
|
||||
};
|
||||
}
|
||||
|
||||
// ── Step 1: Plan ──────────────────────────────────────────────────────────────
|
||||
|
||||
export function collectStep1(specDir: string): Step1PlanMetrics {
|
||||
// Find PLAN-DRAFT-*.md files
|
||||
let draftFiles: string[] = [];
|
||||
let convFiles: string[] = [];
|
||||
try {
|
||||
const files = fs.readdirSync(specDir);
|
||||
draftFiles = files
|
||||
.filter(f => f.startsWith('PLAN-DRAFT-') && f.endsWith('.md'))
|
||||
.map(f => path.join(specDir, f));
|
||||
convFiles = files
|
||||
.filter(f => f.startsWith('PLAN-CONVERSATION-') && f.endsWith('.md'))
|
||||
.map(f => path.join(specDir, f));
|
||||
} catch {
|
||||
return { present: false, final_confidence: null, confidence_breakdown: null,
|
||||
clarification_rounds: null, tech_stack_revision_rounds: null,
|
||||
verification_gaps_found: null, functional_requirements_count: null,
|
||||
non_functional_requirements_count: null, risk_count: null, phase_count: null };
|
||||
}
|
||||
|
||||
if (draftFiles.length === 0) {
|
||||
return { present: false, final_confidence: null, confidence_breakdown: null,
|
||||
clarification_rounds: null, tech_stack_revision_rounds: null,
|
||||
verification_gaps_found: null, functional_requirements_count: null,
|
||||
non_functional_requirements_count: null, risk_count: null, phase_count: null };
|
||||
}
|
||||
|
||||
// Use the latest draft file
|
||||
draftFiles.sort();
|
||||
const latestDraft = readFileSafe(draftFiles[draftFiles.length - 1]) ?? '';
|
||||
|
||||
// ── Primary source: METRICS_JSON HTML comment ──
|
||||
// Format: <!-- METRICS_JSON {"confidence": 95, "clarification_rounds": 0, ...} -->
|
||||
const metricsJson = extractMetricsJson(latestDraft);
|
||||
if (metricsJson) {
|
||||
const num = (key: string): number | null => {
|
||||
const v = metricsJson[key];
|
||||
return typeof v === 'number' ? v : null;
|
||||
};
|
||||
const bd = metricsJson['confidence_breakdown'] as Record<string, number> | undefined;
|
||||
return {
|
||||
present: true,
|
||||
final_confidence: num('confidence'),
|
||||
confidence_breakdown: bd ? {
|
||||
requirements: bd.requirements ?? null,
|
||||
feasibility: bd.feasibility ?? null,
|
||||
integration: bd.integration ?? null,
|
||||
risk: bd.risk ?? null,
|
||||
} : null,
|
||||
clarification_rounds: num('clarification_rounds'),
|
||||
tech_stack_revision_rounds: num('tech_stack_revision_rounds'),
|
||||
verification_gaps_found: num('verification_gaps_found'),
|
||||
functional_requirements_count: num('functional_requirements_count'),
|
||||
non_functional_requirements_count: num('non_functional_requirements_count'),
|
||||
risk_count: num('risk_count'),
|
||||
phase_count: num('phase_count'),
|
||||
};
|
||||
}
|
||||
|
||||
// ── Fallback: structured ## Planning Metrics appendix ──
|
||||
// Handles both plain (confidence: 95) and bold (**confidence:** 95) field formats
|
||||
// Planning Metrics is typically the last section, so we capture greedily to end,
|
||||
// but stop at the next ## heading or --- if present.
|
||||
const metricsSection = latestDraft.match(/^##\s+Planning\s+Metrics\s*\n([\s\S]+?)(?:\n##\s|\n---)/m)
|
||||
?? latestDraft.match(/^##\s+Planning\s+Metrics\s*\n([\s\S]+)/m);
|
||||
const metricsBlock = metricsSection?.[1] ?? '';
|
||||
const parseMetricField = (field: string): number | null => {
|
||||
// Match plain "field: N" or bold "**field:** N"
|
||||
const m = metricsBlock.match(new RegExp(`^\\**${field}\\**[:\\s*]+?(\\d+)`, 'm'));
|
||||
return m ? parseInt(m[1], 10) : null;
|
||||
};
|
||||
|
||||
// ── Confidence ──
|
||||
let finalConfidence = parseMetricField('confidence');
|
||||
if (finalConfidence === null) {
|
||||
// Fallback: prose scraping — handle bold markdown like **Confidence:** 95%
|
||||
const confMatch = latestDraft.match(/(?:Overall|Final|Total)?\s*\**[Cc]onfidence\**[:\s*]+(\d{1,3})%/);
|
||||
if (confMatch) {
|
||||
finalConfidence = parseInt(confMatch[1], 10);
|
||||
} else {
|
||||
const tableMatch = latestDraft.match(/[|]\s*[Cc]onfidence\s*[|]\s*(\d{1,3})/);
|
||||
if (tableMatch) finalConfidence = parseInt(tableMatch[1], 10);
|
||||
}
|
||||
}
|
||||
|
||||
// Confidence breakdown (requirements, feasibility, integration, risk)
|
||||
let confidenceBreakdown: Step1PlanMetrics['confidence_breakdown'] = null;
|
||||
const reqMatch = latestDraft.match(/[Rr]equirements?[:\s|]+(\d{1,2})/);
|
||||
const feasMatch = latestDraft.match(/[Ff]easibility[:\s|]+(\d{1,2})/);
|
||||
const intMatch = latestDraft.match(/[Ii]ntegration[:\s|]+(\d{1,2})/);
|
||||
const riskMatch = latestDraft.match(/[Rr]isk[:\s|]+(\d{1,2})/);
|
||||
if (reqMatch || feasMatch || intMatch || riskMatch) {
|
||||
confidenceBreakdown = {
|
||||
requirements: reqMatch ? parseInt(reqMatch[1], 10) : null,
|
||||
feasibility: feasMatch ? parseInt(feasMatch[1], 10) : null,
|
||||
integration: intMatch ? parseInt(intMatch[1], 10) : null,
|
||||
risk: riskMatch ? parseInt(riskMatch[1], 10) : null,
|
||||
};
|
||||
}
|
||||
|
||||
// ── Clarification rounds ──
|
||||
let clarificationRounds = parseMetricField('clarification_rounds');
|
||||
|
||||
// ── Verification gaps ──
|
||||
let verificationGaps = parseMetricField('verification_gaps_found');
|
||||
|
||||
// ── Functional / non-functional requirements ──
|
||||
let frCount = parseMetricField('functional_requirements_count');
|
||||
if (frCount === null) {
|
||||
frCount = (latestDraft.match(/###\s+FR-/g) ?? []).length || null;
|
||||
}
|
||||
let nfrCount = parseMetricField('non_functional_requirements_count');
|
||||
if (nfrCount === null) {
|
||||
nfrCount = (latestDraft.match(/###\s+NFR-/g) ?? []).length || null;
|
||||
}
|
||||
|
||||
// ── Risk count ──
|
||||
let riskCount = parseMetricField('risk_count');
|
||||
if (riskCount === null) {
|
||||
const riskRows = latestDraft.match(/^\s*[|][^|]*(?:High|Medium|Low|Critical)[^|]*[|]/gm) ?? [];
|
||||
riskCount = riskRows.length || null;
|
||||
}
|
||||
|
||||
// ── Phase count ──
|
||||
let phaseCount = parseMetricField('phase_count');
|
||||
if (phaseCount === null) {
|
||||
phaseCount = (latestDraft.match(/^##\s+Phase\s+\d/gm) ?? []).length || null;
|
||||
}
|
||||
|
||||
// ── Tech stack revision rounds (conversation file only) ──
|
||||
let techStackRevisions: number | null = null;
|
||||
|
||||
// Fall back to conversation file scraping for fields not found in appendix
|
||||
if (convFiles.length > 0) {
|
||||
convFiles.sort();
|
||||
const latestConv = readFileSafe(convFiles[convFiles.length - 1]) ?? '';
|
||||
if (clarificationRounds === null) {
|
||||
const clarRounds = (latestConv.match(/^##\s+(?:Clarification|Round)\s+\d/gm) ?? []).length;
|
||||
clarificationRounds = clarRounds || null;
|
||||
}
|
||||
const techRounds = (latestConv.match(/^##\s+(?:Tech\s+Stack|Technology)\s+Revision/gmi) ?? []).length;
|
||||
techStackRevisions = techRounds || null;
|
||||
if (verificationGaps === null) {
|
||||
const gapMatches = latestConv.match(/(?:verification\s+gap|gap\s+found|missing\s+requirement)/gi) ?? [];
|
||||
verificationGaps = gapMatches.length || null;
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
present: true,
|
||||
final_confidence: finalConfidence,
|
||||
confidence_breakdown: confidenceBreakdown,
|
||||
clarification_rounds: clarificationRounds,
|
||||
tech_stack_revision_rounds: techStackRevisions,
|
||||
verification_gaps_found: verificationGaps,
|
||||
functional_requirements_count: frCount,
|
||||
non_functional_requirements_count: nfrCount,
|
||||
risk_count: riskCount,
|
||||
phase_count: phaseCount,
|
||||
};
|
||||
}
|
||||
|
||||
// ── Step 2: Document ──────────────────────────────────────────────────────────
|
||||
|
||||
export function collectStep2(specDir: string): Step2DocumentMetrics {
|
||||
const overviewPath = path.join(specDir, 'overview.md');
|
||||
const overview = readFileSafe(overviewPath);
|
||||
|
||||
if (!overview) {
|
||||
return { present: false, total_tasks: null, tasks_per_phase: null,
|
||||
phase_count: null, parallel_groups_identified: null,
|
||||
requirement_coverage_percent: null, verification_items_added: null };
|
||||
}
|
||||
|
||||
// ── Primary source: METRICS_JSON in overview.md ──
|
||||
const step2Json = extractMetricsJson(overview, 'document');
|
||||
if (step2Json) {
|
||||
const num = (key: string): number | null => {
|
||||
const v = step2Json[key];
|
||||
return typeof v === 'number' ? v : null;
|
||||
};
|
||||
const tpp = step2Json['tasks_per_phase'];
|
||||
return {
|
||||
present: true,
|
||||
total_tasks: num('total_tasks'),
|
||||
tasks_per_phase: Array.isArray(tpp) ? tpp : null,
|
||||
phase_count: num('phase_count'),
|
||||
parallel_groups_identified: num('parallel_groups_identified') ?? 0,
|
||||
requirement_coverage_percent: num('requirement_coverage_percent'),
|
||||
verification_items_added: num('verification_items_added'),
|
||||
};
|
||||
}
|
||||
|
||||
// ── Fallback: regex scraping ──
|
||||
|
||||
// Detect Parallel Execution Groups table
|
||||
const parallelGroups = (overview.match(/Parallel\s+Execution\s+Group/gi) ?? []).length;
|
||||
|
||||
// Count phase files (scanned first so we can use sum as a total_tasks fallback)
|
||||
let phaseCount = 0;
|
||||
let tasksPerPhase: number[] = [];
|
||||
try {
|
||||
const files = fs.readdirSync(specDir);
|
||||
const phaseFiles = files
|
||||
.filter(f => /^phase-\d+\.md$/i.test(f))
|
||||
.sort();
|
||||
phaseCount = phaseFiles.length;
|
||||
for (const pf of phaseFiles) {
|
||||
const content = readFileSafe(path.join(specDir, pf)) ?? '';
|
||||
const count = (content.match(/^\s*-\s+\[[ x!/?]\]\s+\*\*Task\s+\d/gm) ?? []).length;
|
||||
tasksPerPhase.push(count);
|
||||
}
|
||||
} catch {
|
||||
// leave empty
|
||||
}
|
||||
|
||||
// total_tasks priority:
|
||||
// 1. Completion Summary canonical count
|
||||
// 2. Sum of phase file task counts
|
||||
// 3. Stripped overview checkboxes (excluding Success Criteria)
|
||||
const summaryCount = parseCompletionSummaryTaskCount(overview);
|
||||
const phaseSum = tasksPerPhase.length > 0 ? tasksPerPhase.reduce((a, b) => a + b, 0) : 0;
|
||||
const strippedOverview = stripSuccessCriteriaSection(overview);
|
||||
const strippedCheckboxCount = (strippedOverview.match(/^\s*-\s+\[[ x!/?]\]/gm) ?? []).length;
|
||||
|
||||
let totalTasks: number;
|
||||
if (summaryCount) {
|
||||
totalTasks = summaryCount.total;
|
||||
} else if (phaseSum > 0) {
|
||||
totalTasks = phaseSum;
|
||||
} else {
|
||||
totalTasks = strippedCheckboxCount;
|
||||
}
|
||||
|
||||
// Requirement coverage: look for coverage percentage in overview
|
||||
let reqCoverage: number | null = null;
|
||||
const covMatch = overview.match(/[Cc]overage[:\s]+(\d{1,3})%/);
|
||||
if (covMatch) reqCoverage = parseInt(covMatch[1], 10);
|
||||
|
||||
// Verification items added (look for verification checklist items)
|
||||
const verifItems = (overview.match(/(?:verify|verification|test|check):\s*\[[ x]\]/gi) ?? []).length;
|
||||
|
||||
return {
|
||||
present: true,
|
||||
total_tasks: totalTasks || null,
|
||||
tasks_per_phase: tasksPerPhase.length > 0 ? tasksPerPhase : null,
|
||||
phase_count: phaseCount || null,
|
||||
parallel_groups_identified: parallelGroups || 0,
|
||||
requirement_coverage_percent: reqCoverage,
|
||||
verification_items_added: verifItems || null,
|
||||
};
|
||||
}
|
||||
|
||||
// ── Step 3: Implement ──────────────────────────────────────────────────────────
|
||||
|
||||
export function collectStep3(specDir: string): Step3ImplementMetrics {
|
||||
// Discover phase-*.md files
|
||||
let phaseFiles: string[] = [];
|
||||
try {
|
||||
const files = fs.readdirSync(specDir);
|
||||
phaseFiles = files
|
||||
.filter(f => /^phase-\d+\.md$/i.test(f))
|
||||
.sort();
|
||||
} catch {
|
||||
// leave empty
|
||||
}
|
||||
|
||||
// Read overview.md for Completion Summary
|
||||
const overviewPath = path.join(specDir, 'overview.md');
|
||||
const overview = readFileSafe(overviewPath);
|
||||
const summaryCount = overview ? parseCompletionSummaryTaskCount(overview) : null;
|
||||
|
||||
// ── Primary source: METRICS_JSON in overview.md (from finalize step) ──
|
||||
if (overview) {
|
||||
const step3Json = extractMetricsJson(overview, 'finalize');
|
||||
if (step3Json) {
|
||||
const num = (key: string): number | null => {
|
||||
const v = step3Json[key];
|
||||
return typeof v === 'number' ? v : null;
|
||||
};
|
||||
const total = num('tasks_total');
|
||||
const completed = num('tasks_completed');
|
||||
return {
|
||||
present: true,
|
||||
task_completion_rate: total && total > 0 && completed != null ? completed / total : null,
|
||||
tasks_completed: completed,
|
||||
tasks_total: total,
|
||||
blocker_count: num('blocker_count') ?? 0,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// ── Fallback: regex scraping ──
|
||||
|
||||
// present = true if phase files exist OR overview has completion data
|
||||
const present = phaseFiles.length > 0 || summaryCount != null;
|
||||
if (!present) {
|
||||
return { present: false, task_completion_rate: null, tasks_completed: null,
|
||||
tasks_total: null, blocker_count: null };
|
||||
}
|
||||
|
||||
// Count checkboxes in phase files
|
||||
let phaseTotal = 0;
|
||||
let phaseCompleted = 0;
|
||||
let blockerCount = 0;
|
||||
for (const pf of phaseFiles) {
|
||||
const content = readFileSafe(path.join(specDir, pf)) ?? '';
|
||||
phaseTotal += (content.match(/^\s*-\s+\[[ x!/?]\]\s+\*\*Task\s+\d/gm) ?? []).length;
|
||||
phaseCompleted += (content.match(/^\s*-\s+\[x\]\s+\*\*Task\s+\d/gm) ?? []).length;
|
||||
blockerCount += (content.match(/^\s*-\s+\[!\]\s+\*\*Task\s+\d/gm) ?? []).length;
|
||||
}
|
||||
|
||||
// Count checkboxes in overview (stripped of Success Criteria)
|
||||
let overviewTotal = 0;
|
||||
let overviewCompleted = 0;
|
||||
if (overview) {
|
||||
const stripped = stripSuccessCriteriaSection(overview);
|
||||
overviewTotal = (stripped.match(/^\s*-\s+\[[ x!/?]\]/gm) ?? []).length;
|
||||
overviewCompleted = (stripped.match(/^\s*-\s+\[x\]/gm) ?? []).length;
|
||||
}
|
||||
|
||||
// Task counts priority:
|
||||
// 1. Completion Summary in overview.md
|
||||
// 2. Checkbox counting in phase files
|
||||
// 3. Checkbox counting in overview.md (stripped of Success Criteria)
|
||||
let tasksTotal: number | null = null;
|
||||
let tasksCompleted: number | null = null;
|
||||
if (summaryCount) {
|
||||
tasksTotal = summaryCount.total;
|
||||
tasksCompleted = summaryCount.completed;
|
||||
} else if (phaseTotal > 0) {
|
||||
tasksTotal = phaseTotal;
|
||||
tasksCompleted = phaseCompleted;
|
||||
} else if (overviewTotal > 0) {
|
||||
tasksTotal = overviewTotal;
|
||||
tasksCompleted = overviewCompleted;
|
||||
}
|
||||
|
||||
const taskCompletionRate = tasksTotal && tasksTotal > 0 && tasksCompleted != null
|
||||
? tasksCompleted / tasksTotal
|
||||
: null;
|
||||
|
||||
return {
|
||||
present: true,
|
||||
task_completion_rate: taskCompletionRate,
|
||||
tasks_completed: tasksCompleted,
|
||||
tasks_total: tasksTotal,
|
||||
blocker_count: blockerCount,
|
||||
};
|
||||
}
|
||||
|
||||
// ── Step 4: Finalize ──────────────────────────────────────────────────────────
|
||||
|
||||
export function collectStep4(specDir: string): Step4FinalizeMetrics {
|
||||
// Check if spec was archived (specs--completed exists at parent level)
|
||||
const specDirName = path.basename(specDir);
|
||||
const parentDir = path.dirname(specDir);
|
||||
const completedPath = path.join(parentDir, '..', 'specs--completed', specDirName);
|
||||
const archivalSucceeded = fs.existsSync(completedPath);
|
||||
|
||||
// Read overview for completion metrics
|
||||
const overviewPath = path.join(specDir, 'overview.md');
|
||||
|
||||
// If archived, try from archived location
|
||||
const effectiveOverviewPath = archivalSucceeded
|
||||
? path.join(completedPath, 'overview.md')
|
||||
: overviewPath;
|
||||
|
||||
const overview = readFileSafe(effectiveOverviewPath) ?? readFileSafe(overviewPath);
|
||||
if (!overview) {
|
||||
return { present: false, completion_rate_at_audit: null,
|
||||
verification_failures_found: null, documentation_updates_needed: null,
|
||||
archival_succeeded: archivalSucceeded };
|
||||
}
|
||||
|
||||
// ── Primary source: METRICS_JSON in overview.md ──
|
||||
const step4Json = extractMetricsJson(overview, 'finalize');
|
||||
if (step4Json) {
|
||||
const num = (key: string): number | null => {
|
||||
const v = step4Json[key];
|
||||
return typeof v === 'number' ? v : null;
|
||||
};
|
||||
return {
|
||||
present: true,
|
||||
completion_rate_at_audit: num('completion_rate_at_audit'),
|
||||
verification_failures_found: num('verification_failures_found') ?? 0,
|
||||
documentation_updates_needed: num('documentation_updates_needed'),
|
||||
archival_succeeded: archivalSucceeded,
|
||||
};
|
||||
}
|
||||
|
||||
// ── Fallback: regex scraping ──
|
||||
|
||||
// Completion rate: prefer Completion Summary, fall back to stripped overview checkboxes
|
||||
let completionRate: number | null = null;
|
||||
const summaryCount = parseCompletionSummaryTaskCount(overview);
|
||||
if (summaryCount) {
|
||||
completionRate = summaryCount.total > 0 ? summaryCount.completed / summaryCount.total : null;
|
||||
} else {
|
||||
const stripped = stripSuccessCriteriaSection(overview);
|
||||
const totalTasks = (stripped.match(/^\s*-\s+\[[ x!/?]\]/gm) ?? []).length;
|
||||
const completedTasks = (stripped.match(/^\s*-\s+\[x\]/gm) ?? []).length;
|
||||
completionRate = totalTasks > 0 ? completedTasks / totalTasks : null;
|
||||
}
|
||||
|
||||
// Verification failures: look for [!] tasks or "verification failed" text
|
||||
const blockedTasks = (overview.match(/^\s*-\s+\[!\]/gm) ?? []).length;
|
||||
|
||||
// Documentation updates needed (look for TODO or "update" markers)
|
||||
const docUpdates = (overview.match(/(?:TODO|FIXME|update\s+(?:README|CHANGELOG|docs))/gi) ?? []).length;
|
||||
|
||||
return {
|
||||
present: true,
|
||||
completion_rate_at_audit: completionRate,
|
||||
verification_failures_found: blockedTasks || 0,
|
||||
documentation_updates_needed: docUpdates || null,
|
||||
archival_succeeded: archivalSucceeded,
|
||||
};
|
||||
}
|
||||
|
||||
// ── User Feedback ─────────────────────────────────────────────────────────
|
||||
|
||||
export function collectUserFeedback(specDir: string): UserFeedback | null {
|
||||
// Try both active and archived locations for overview.md
|
||||
const overviewPath = path.join(specDir, 'overview.md');
|
||||
const specDirName = path.basename(specDir);
|
||||
const parentDir = path.dirname(specDir);
|
||||
const completedPath = path.join(parentDir, '..', 'specs--completed', specDirName, 'overview.md');
|
||||
|
||||
const overview = readFileSafe(overviewPath) ?? readFileSafe(completedPath);
|
||||
if (!overview) return null;
|
||||
|
||||
// Look for ## User Feedback section with a markdown table
|
||||
const feedbackMatch = overview.match(
|
||||
/## User Feedback\s*\n\s*\|[^\n]*\|\s*\n\s*\|[-| ]+\|\s*\n([\s\S]*?)(?=\n##\s|\n*$)/
|
||||
);
|
||||
if (!feedbackMatch) return null;
|
||||
|
||||
const tableBody = feedbackMatch[1];
|
||||
|
||||
// Parse table rows: | Field | Value |
|
||||
// Use regex to split only on unescaped pipes, preserving whitespace in values
|
||||
const rows = tableBody.split('\n').filter(l => l.trim().startsWith('|'));
|
||||
const fields: Record<string, string> = {};
|
||||
for (const row of rows) {
|
||||
// Split on unescaped pipes (not preceded by backslash)
|
||||
const cells = row.split(/(?<!\\)\|/).map(c => c.trim()).filter(c => c.length > 0);
|
||||
if (cells.length >= 2) {
|
||||
const value = cells.slice(1).join('|').replace(/\\\|/g, '|');
|
||||
fields[cells[0].toLowerCase()] = value;
|
||||
}
|
||||
}
|
||||
|
||||
const rating = parseInt(fields['rating'] ?? '', 10);
|
||||
if (isNaN(rating) || rating < 1 || rating > 10) return null;
|
||||
|
||||
return {
|
||||
overall_rating: rating,
|
||||
rating_reason: fields['reason'] ?? '',
|
||||
what_went_well: fields['went well'] ?? '',
|
||||
what_went_poorly: fields['went poorly'] ?? '',
|
||||
};
|
||||
}
|
||||
|
||||
// ── Main collector ────────────────────────────────────────────────────────────
|
||||
|
||||
export interface CollectorOptions {
|
||||
specDir: string; // Path to the spec directory (specs/<feature-name>)
|
||||
projectName: string; // Human-readable project name
|
||||
plan2codeRoot: string; // Path to the plan2code repo (for prompt hashing)
|
||||
plan2codeVersion: string; // e.g. "1.7.0"
|
||||
outputDir: string; // Where to write <run-id>.json
|
||||
}
|
||||
|
||||
export async function collectRun(opts: CollectorOptions): Promise<RunMetrics> {
|
||||
const {
|
||||
specDir,
|
||||
projectName,
|
||||
plan2codeRoot,
|
||||
plan2codeVersion,
|
||||
outputDir,
|
||||
} = opts;
|
||||
|
||||
const runId = generateRunId();
|
||||
|
||||
// Get started_at / completed_at from spec directory mtime / iteration.log
|
||||
let startedAt: string | null = null;
|
||||
let completedAt: string | null = null;
|
||||
try {
|
||||
const stat = fs.statSync(specDir);
|
||||
startedAt = stat.birthtime.toISOString();
|
||||
completedAt = stat.mtime.toISOString();
|
||||
} catch {
|
||||
// leave null
|
||||
}
|
||||
|
||||
const metrics: RunMetrics = {
|
||||
schema_version: '1.0',
|
||||
run_id: runId,
|
||||
plan2code_version: plan2codeVersion,
|
||||
prompt_versions: collectPromptVersions(plan2codeRoot),
|
||||
project: {
|
||||
name: projectName,
|
||||
started_at: startedAt,
|
||||
completed_at: completedAt,
|
||||
},
|
||||
step1_plan: collectStep1(specDir),
|
||||
step2_document: collectStep2(specDir),
|
||||
step3_implement: collectStep3(specDir),
|
||||
step4_finalize: collectStep4(specDir),
|
||||
user_feedback: collectUserFeedback(specDir),
|
||||
};
|
||||
|
||||
// Write to output dir
|
||||
fs.mkdirSync(outputDir, { recursive: true });
|
||||
const outPath = path.join(outputDir, `${runId}.json`);
|
||||
fs.writeFileSync(outPath, JSON.stringify(metrics, null, 2), 'utf8');
|
||||
|
||||
return metrics;
|
||||
}
|
||||
@@ -0,0 +1,139 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { validateEdit, parseProposalFromResponse } from './improver.js';
|
||||
import type { PromptEdit } from './types.js';
|
||||
|
||||
// ── Shared fixtures ───────────────────────────────────────────────────────────
|
||||
|
||||
const PROMPT_CONTENTS: Record<string, string> = {
|
||||
'plan2code-1-plan.md': 'This is the plan prompt content. It has some text here.',
|
||||
'plan2code-2-document.md': 'Document prompt with repeated text. repeated text. Done.',
|
||||
'plan2code-3-implement.md': 'Implement prompt content.',
|
||||
};
|
||||
|
||||
function makeEdit(overrides: Partial<PromptEdit> = {}): PromptEdit {
|
||||
return {
|
||||
file: 'plan2code-1-plan.md',
|
||||
rationale: 'test rationale',
|
||||
expected_metric_impact: 'test impact',
|
||||
char_count_before: PROMPT_CONTENTS['plan2code-1-plan.md'].length,
|
||||
char_count_after: PROMPT_CONTENTS['plan2code-1-plan.md'].length,
|
||||
char_count_delta: 0,
|
||||
old_text: 'some text',
|
||||
new_text: 'better text',
|
||||
...overrides,
|
||||
};
|
||||
}
|
||||
|
||||
// ── validateEdit() ────────────────────────────────────────────────────────────
|
||||
|
||||
describe('validateEdit', () => {
|
||||
it('valid edit passes with no errors', () => {
|
||||
const result = validateEdit(makeEdit(), PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(true);
|
||||
expect(result.errors).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('rejects path traversal (../ in file path)', () => {
|
||||
const result = validateEdit(makeEdit({ file: '../etc/passwd' }), PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors[0]).toMatch(/path traversal/i);
|
||||
});
|
||||
|
||||
it('rejects absolute paths', () => {
|
||||
const result = validateEdit(makeEdit({ file: '/etc/passwd' }), PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors[0]).toMatch(/path traversal|absolute/i);
|
||||
});
|
||||
|
||||
it('errors when file not found in promptContents', () => {
|
||||
const result = validateEdit(makeEdit({ file: 'nonexistent.md' }), PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors[0]).toMatch(/not found/i);
|
||||
});
|
||||
|
||||
it('errors when old_text not found in file content', () => {
|
||||
const result = validateEdit(makeEdit({ old_text: 'hallucinated text' }), PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors[0]).toMatch(/not found verbatim/i);
|
||||
});
|
||||
|
||||
it('warns when old_text appears multiple times', () => {
|
||||
const edit = makeEdit({
|
||||
file: 'plan2code-2-document.md',
|
||||
old_text: 'repeated text',
|
||||
char_count_before: PROMPT_CONTENTS['plan2code-2-document.md'].length,
|
||||
char_count_after: PROMPT_CONTENTS['plan2code-2-document.md'].length,
|
||||
});
|
||||
const result = validateEdit(edit, PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(true);
|
||||
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);
|
||||
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);
|
||||
});
|
||||
|
||||
it('warns when reported char counts diverge from actual (>10 chars off)', () => {
|
||||
const edit = makeEdit({
|
||||
char_count_before: 999,
|
||||
char_count_after: 999,
|
||||
});
|
||||
const result = validateEdit(edit, PROMPT_CONTENTS);
|
||||
expect(result.valid).toBe(true);
|
||||
expect(result.warnings.some(w => /char_count_before.*differs/i.test(w))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
// ── parseProposalFromResponse() ───────────────────────────────────────────────
|
||||
|
||||
describe('parseProposalFromResponse', () => {
|
||||
const sampleEdit = {
|
||||
file: 'test.md',
|
||||
rationale: 'r',
|
||||
expected_metric_impact: 'e',
|
||||
char_count_before: 100,
|
||||
char_count_after: 110,
|
||||
char_count_delta: 10,
|
||||
old_text: 'old',
|
||||
new_text: 'new',
|
||||
};
|
||||
|
||||
it('parses JSON from markdown code block (```json ... ```)', () => {
|
||||
const response = `Here is my proposal:\n\n\`\`\`json\n${JSON.stringify([sampleEdit])}\n\`\`\`\n\nDone.`;
|
||||
const result = parseProposalFromResponse(response);
|
||||
expect(result).toHaveLength(1);
|
||||
expect(result![0].file).toBe('test.md');
|
||||
});
|
||||
|
||||
it('parses JSON from bare code block (``` ... ```)', () => {
|
||||
const response = `Proposal:\n\n\`\`\`\n${JSON.stringify([sampleEdit])}\n\`\`\``;
|
||||
const result = parseProposalFromResponse(response);
|
||||
expect(result).toHaveLength(1);
|
||||
expect(result![0].old_text).toBe('old');
|
||||
});
|
||||
|
||||
it('parses bare JSON array with old_text field', () => {
|
||||
const response = `Some preamble\n${JSON.stringify([sampleEdit])}\nSome postamble`;
|
||||
const result = parseProposalFromResponse(response);
|
||||
expect(result).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('returns null for non-JSON response', () => {
|
||||
const result = parseProposalFromResponse('No changes needed at this time.');
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('returns null for malformed JSON', () => {
|
||||
const result = parseProposalFromResponse('```json\n{broken json]\n```');
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('returns null for empty response', () => {
|
||||
const result = parseProposalFromResponse('');
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,288 @@
|
||||
/**
|
||||
* improver.ts
|
||||
* Reads diagnosis + prompt files, invokes AI, parses PromptEdit[] from response.
|
||||
* Validates: old_text verbatim match, char count limits.
|
||||
*/
|
||||
|
||||
import fs from 'fs';
|
||||
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 IMPROVE_PROMPT_PATH = new URL('../src/prompts/improve.md', import.meta.url).pathname
|
||||
.replace(/^\/([A-Za-z]:)/, '$1'); // Fix Windows path
|
||||
|
||||
// ── Helpers ───────────────────────────────────────────────────────────────────
|
||||
|
||||
function interpolate(template: string, vars: Record<string, string>): string {
|
||||
let result = template;
|
||||
for (const [key, value] of Object.entries(vars)) {
|
||||
result = result.replaceAll(`{{${key}}}`, value);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
function generateProposalId(): string {
|
||||
const now = new Date();
|
||||
const ts = now.toISOString().replace(/[-:T.Z]/g, '').slice(0, 14);
|
||||
return `prop-${ts}`;
|
||||
}
|
||||
|
||||
function readPromptFiles(plan2codeRoot: string): Record<string, string> {
|
||||
const srcDir = path.join(plan2codeRoot, 'src');
|
||||
const promptFiles = [
|
||||
'plan2code-1-plan.md',
|
||||
'plan2code-1b-revise-plan.md',
|
||||
'plan2code-2-document.md',
|
||||
'plan2code-3-implement.md',
|
||||
'plan2code-4-finalize.md',
|
||||
'plan2code-init.md',
|
||||
'plan2code-init-update.md',
|
||||
'plan2code-quick-task.md',
|
||||
];
|
||||
|
||||
const contents: Record<string, string> = {};
|
||||
for (const file of promptFiles) {
|
||||
try {
|
||||
contents[file] = fs.readFileSync(path.join(srcDir, file), 'utf8');
|
||||
} catch {
|
||||
contents[file] = '';
|
||||
}
|
||||
}
|
||||
return contents;
|
||||
}
|
||||
|
||||
// ── Edit validation ───────────────────────────────────────────────────────────
|
||||
|
||||
export interface ValidationResult {
|
||||
valid: boolean;
|
||||
errors: string[];
|
||||
warnings: string[];
|
||||
}
|
||||
|
||||
export function validateEdit(
|
||||
edit: PromptEdit,
|
||||
promptContents: Record<string, string>,
|
||||
): ValidationResult {
|
||||
const errors: string[] = [];
|
||||
const warnings: string[] = [];
|
||||
|
||||
// Reject path traversal attempts
|
||||
if (edit.file.includes('..') || path.isAbsolute(edit.file)) {
|
||||
errors.push(`Rejected: "${edit.file}" contains path traversal or absolute path.`);
|
||||
return { valid: false, errors, warnings };
|
||||
}
|
||||
|
||||
// Check target file exists
|
||||
const fileContent = promptContents[edit.file];
|
||||
if (fileContent === undefined) {
|
||||
errors.push(`Target file "${edit.file}" not found. Valid files: ${Object.keys(promptContents).join(', ')}`);
|
||||
return { valid: false, errors, warnings };
|
||||
}
|
||||
|
||||
// Check old_text exists verbatim in the file
|
||||
if (!fileContent.includes(edit.old_text)) {
|
||||
errors.push(`old_text not found verbatim in "${edit.file}". The AI may have hallucinated text.`);
|
||||
} else {
|
||||
// Warn if old_text appears more than once (ambiguous match)
|
||||
const occurrences = fileContent.split(edit.old_text).length - 1;
|
||||
if (occurrences > 1) {
|
||||
warnings.push(`old_text appears ${occurrences} times in "${edit.file}". Only the first occurrence will be replaced.`);
|
||||
}
|
||||
}
|
||||
|
||||
// Check char count after edit
|
||||
const afterContent = fileContent.replace(edit.old_text, edit.new_text);
|
||||
if (afterContent.length > CHAR_LIMIT) {
|
||||
errors.push(`Edit would cause "${edit.file}" to exceed ${CHAR_LIMIT} char limit (would be ${afterContent.length} chars).`);
|
||||
}
|
||||
|
||||
// Verify reported char counts match reality
|
||||
const actualBefore = fileContent.length;
|
||||
const actualAfter = afterContent.length;
|
||||
if (Math.abs(edit.char_count_before - actualBefore) > 10) {
|
||||
warnings.push(`Reported char_count_before (${edit.char_count_before}) differs from actual (${actualBefore}).`);
|
||||
}
|
||||
if (Math.abs(edit.char_count_after - actualAfter) > 10) {
|
||||
warnings.push(`Reported char_count_after (${edit.char_count_after}) differs from actual (${actualAfter}).`);
|
||||
}
|
||||
|
||||
return { valid: errors.length === 0, errors, warnings };
|
||||
}
|
||||
|
||||
// ── AI response parsing ───────────────────────────────────────────────────────
|
||||
|
||||
export function parseProposalFromResponse(response: string): PromptEdit[] | null {
|
||||
// Look for JSON code block containing PromptEdit[]
|
||||
const jsonBlockMatch = response.match(/```(?:json)?\s*(\[[\s\S]*?\])\s*```/);
|
||||
if (!jsonBlockMatch) {
|
||||
// Try bare JSON array
|
||||
const bareMatch = response.match(/(\[[\s\S]*"old_text"[\s\S]*\])/);
|
||||
if (!bareMatch) return null;
|
||||
try {
|
||||
return JSON.parse(bareMatch[1]) as PromptEdit[];
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
return JSON.parse(jsonBlockMatch[1]) as PromptEdit[];
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// ── Main improver ─────────────────────────────────────────────────────────────
|
||||
|
||||
export interface ImproverOptions {
|
||||
diagnosisPath: string; // Path to diagnosis markdown file
|
||||
plan2codeRoot: string; // Path to plan2code repo root
|
||||
proposalsDir: string; // Where to save proposal JSON
|
||||
runsDir: string; // For tracking which runs this is based on
|
||||
model?: string;
|
||||
agent?: AgentType; // Agent to use (default: claude-code)
|
||||
}
|
||||
|
||||
export interface ImproverResult {
|
||||
proposalPath: string;
|
||||
proposal: PromptProposal;
|
||||
validationResults: Array<{ edit: PromptEdit; result: ValidationResult }>;
|
||||
validEditCount: number;
|
||||
invalidEditCount: number;
|
||||
}
|
||||
|
||||
export async function generateImprovement(opts: ImproverOptions): Promise<ImproverResult> {
|
||||
const { diagnosisPath, plan2codeRoot, proposalsDir, runsDir, model = 'default', agent = 'claude-code' } = opts;
|
||||
|
||||
// Load diagnosis
|
||||
let diagnosisContent: string;
|
||||
try {
|
||||
diagnosisContent = fs.readFileSync(diagnosisPath, 'utf8');
|
||||
} catch {
|
||||
throw new Error(`Could not read diagnosis file at ${diagnosisPath}`);
|
||||
}
|
||||
|
||||
// Read prompt files
|
||||
const promptContents = readPromptFiles(plan2codeRoot);
|
||||
const srcDir = path.join(plan2codeRoot, 'src');
|
||||
|
||||
// Build char counts for each file
|
||||
const charCounts = Object.entries(promptContents)
|
||||
.map(([file, content]) => `| ${file} | ${content.length} | ${CHAR_LIMIT} | ${CHAR_LIMIT - content.length} headroom |`)
|
||||
.join('\n');
|
||||
|
||||
const promptContentsStr = Object.entries(promptContents)
|
||||
.map(([file, content]) => `## ${file} (${content.length} chars)\n\n${content}`)
|
||||
.join('\n\n---\n\n');
|
||||
|
||||
// Load improve prompt template
|
||||
let improveTemplate: string;
|
||||
try {
|
||||
improveTemplate = fs.readFileSync(IMPROVE_PROMPT_PATH, 'utf8');
|
||||
} catch {
|
||||
const altPath = path.join(process.cwd(), 'src', 'prompts', 'improve.md');
|
||||
improveTemplate = fs.readFileSync(altPath, 'utf8');
|
||||
}
|
||||
|
||||
const fullPrompt = interpolate(improveTemplate, {
|
||||
diagnosisContent,
|
||||
promptContents: promptContentsStr,
|
||||
charCounts: `| File | Current Chars | Limit | Headroom |\n|------|--------------|-------|----------|\n${charCounts}`,
|
||||
});
|
||||
|
||||
// Invoke Claude
|
||||
console.log(`\nInvoking AI improvement proposal (agent: ${agent}, model: ${model === 'default' ? 'user default' : model})...`);
|
||||
console.log('This may take a minute...\n');
|
||||
|
||||
let aiResponse: string;
|
||||
try {
|
||||
aiResponse = await invokeLLM({
|
||||
prompt: fullPrompt,
|
||||
model,
|
||||
agent,
|
||||
timeout: 300_000,
|
||||
});
|
||||
} catch (err) {
|
||||
throw new Error(`AI invocation failed: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
|
||||
// Parse edits
|
||||
const rawEdits = parseProposalFromResponse(aiResponse);
|
||||
if (!rawEdits || rawEdits.length === 0) {
|
||||
throw new Error('Could not parse PromptEdit[] from AI response. The AI may not have produced a valid JSON block.');
|
||||
}
|
||||
|
||||
// Enforce max edits per cycle
|
||||
const MAX_EDITS = 5;
|
||||
if (rawEdits.length > MAX_EDITS) {
|
||||
console.warn(`\n⚠ AI generated ${rawEdits.length} edits (max is ${MAX_EDITS}). Truncating to first ${MAX_EDITS}.`);
|
||||
rawEdits.length = MAX_EDITS;
|
||||
}
|
||||
|
||||
// Validate each edit
|
||||
const validationResults: ImproverResult['validationResults'] = [];
|
||||
const validEdits: PromptEdit[] = [];
|
||||
|
||||
for (const edit of rawEdits) {
|
||||
const result = validateEdit(edit, promptContents);
|
||||
validationResults.push({ edit, result });
|
||||
|
||||
if (result.valid) {
|
||||
// Compute accurate char counts
|
||||
const fileContent = promptContents[edit.file] ?? '';
|
||||
const afterContent = fileContent.replace(edit.old_text, edit.new_text);
|
||||
edit.char_count_before = fileContent.length;
|
||||
edit.char_count_after = afterContent.length;
|
||||
edit.char_count_delta = afterContent.length - fileContent.length;
|
||||
validEdits.push(edit);
|
||||
} else {
|
||||
console.warn(`\n⚠ Edit rejected for "${edit.file}":`);
|
||||
for (const err of result.errors) {
|
||||
console.warn(` - ${err}`);
|
||||
}
|
||||
}
|
||||
|
||||
for (const warn of result.warnings) {
|
||||
console.warn(` Warning: ${warn}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Get run IDs that contributed to this analysis
|
||||
const runIds: string[] = [];
|
||||
try {
|
||||
const files = fs.readdirSync(runsDir)
|
||||
.filter(f => f.startsWith('run-') && f.endsWith('.json'));
|
||||
runIds.push(...files.map(f => f.replace('.json', '')));
|
||||
} catch { /* no runs dir */ }
|
||||
|
||||
// Build proposal
|
||||
const proposalId = generateProposalId();
|
||||
const proposal: PromptProposal = {
|
||||
proposal_id: proposalId,
|
||||
created_at: new Date().toISOString(),
|
||||
based_on_runs: runIds,
|
||||
analyst_model: model,
|
||||
proposals: validEdits,
|
||||
status: 'pending',
|
||||
diagnosis_file: path.basename(diagnosisPath),
|
||||
};
|
||||
|
||||
// Save proposal JSON
|
||||
fs.mkdirSync(proposalsDir, { recursive: true });
|
||||
const proposalPath = path.join(proposalsDir, `${proposalId}.json`);
|
||||
fs.writeFileSync(proposalPath, JSON.stringify(proposal, null, 2), 'utf8');
|
||||
|
||||
// Also save raw AI response alongside
|
||||
const rawPath = path.join(proposalsDir, `${proposalId}-raw.md`);
|
||||
fs.writeFileSync(rawPath, aiResponse, 'utf8');
|
||||
|
||||
return {
|
||||
proposalPath,
|
||||
proposal,
|
||||
validationResults,
|
||||
validEditCount: validEdits.length,
|
||||
invalidEditCount: rawEdits.length - validEdits.length,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
// Public API for plan2code-metrics
|
||||
export { collectRun, collectPromptVersions } from './collector.js';
|
||||
export { aggregate, loadAggregated, loadRunFiles, importRun } from './aggregator.js';
|
||||
export { runAnalysis } from './analyzer.js';
|
||||
export { generateImprovement, validateEdit, parseProposalFromResponse } from './improver.js';
|
||||
export { reviewAndApply } from './applier.js';
|
||||
export { invokeLLM, AGENTS } from './invoke-llm.js';
|
||||
export type { AgentType, InvokeLLMOptions } from './invoke-llm.js';
|
||||
export { runCLI } from './cli.js';
|
||||
export { METRIC_TARGETS } from './types.js';
|
||||
export type {
|
||||
RunMetrics,
|
||||
UserFeedback,
|
||||
PromptVersions,
|
||||
PromptEdit,
|
||||
PromptProposal,
|
||||
AggregatedMetrics,
|
||||
CohortMetrics,
|
||||
} from './types.js';
|
||||
@@ -0,0 +1,90 @@
|
||||
/**
|
||||
* invoke-llm.ts
|
||||
* Unified LLM invocation for plan2code-metrics.
|
||||
* Supports Claude Code (temp file → stdin) and Copilot CLI (stdin string).
|
||||
* Mirrors the agent pattern from plan2code-loop.
|
||||
*/
|
||||
|
||||
import { execa } from 'execa';
|
||||
import { writeFileSync, unlinkSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { tmpdir } from 'os';
|
||||
|
||||
// ── Agent definitions ────────────────────────────────────────────────────────
|
||||
|
||||
export type AgentType = 'claude-code' | 'copilot-cli';
|
||||
|
||||
export interface AgentDef {
|
||||
name: AgentType;
|
||||
displayName: string;
|
||||
command: string;
|
||||
defaultModel: string;
|
||||
}
|
||||
|
||||
export const AGENTS: Record<AgentType, AgentDef> = {
|
||||
'claude-code': {
|
||||
name: 'claude-code',
|
||||
displayName: 'Claude Code',
|
||||
command: 'claude',
|
||||
defaultModel: 'default',
|
||||
},
|
||||
'copilot-cli': {
|
||||
name: 'copilot-cli',
|
||||
displayName: 'GitHub Copilot CLI',
|
||||
command: 'copilot',
|
||||
defaultModel: 'claude-sonnet-4',
|
||||
},
|
||||
};
|
||||
|
||||
// ── Invocation ───────────────────────────────────────────────────────────────
|
||||
|
||||
export interface InvokeLLMOptions {
|
||||
prompt: string;
|
||||
model: string;
|
||||
agent: AgentType;
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
export async function invokeLLM(opts: InvokeLLMOptions): Promise<string> {
|
||||
const { prompt, model, agent, timeout = 300_000 } = opts;
|
||||
const def = AGENTS[agent];
|
||||
|
||||
if (agent === 'claude-code') {
|
||||
// Write prompt to temp file — more reliable than stdin on Windows
|
||||
const tempFile = join(tmpdir(), `plan2code-metrics-prompt-${Date.now()}.txt`);
|
||||
writeFileSync(tempFile, prompt, 'utf-8');
|
||||
|
||||
try {
|
||||
const args: string[] = [
|
||||
'--print',
|
||||
'--dangerously-skip-permissions',
|
||||
];
|
||||
// Only add --model if not using default
|
||||
if (model && model !== 'default') {
|
||||
args.push('--model', model);
|
||||
}
|
||||
|
||||
const result = await execa(def.command, args, {
|
||||
inputFile: tempFile,
|
||||
timeout,
|
||||
});
|
||||
return result.stdout;
|
||||
} finally {
|
||||
try { unlinkSync(tempFile); } catch { /* ignore cleanup errors */ }
|
||||
}
|
||||
} else {
|
||||
// Copilot CLI: pipe prompt via stdin string
|
||||
const args: string[] = [];
|
||||
// Only add --model if not using default
|
||||
if (model && model !== 'default') {
|
||||
args.push('--model', model);
|
||||
}
|
||||
args.push('--allow-all-tools', '-s');
|
||||
|
||||
const result = await execa(def.command, args, {
|
||||
input: prompt,
|
||||
timeout,
|
||||
});
|
||||
return result.stdout;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,100 @@
|
||||
# PLAN2CODE METRICS ANALYSIS REQUEST
|
||||
|
||||
You are a senior AI systems analyst specializing in prompt engineering quality assessment. Your role is to diagnose weaknesses in the plan2code workflow prompts by examining aggregated run metrics.
|
||||
|
||||
**IMPORTANT:** Do NOT propose specific edits in this response. Diagnosis only. The improvement step is separate.
|
||||
|
||||
---
|
||||
|
||||
## Aggregated Run Metrics
|
||||
|
||||
The following JSON contains metrics aggregated from real plan2code project runs, grouped by prompt "generation" (a cohort is identified by the SHA fingerprint of the src/plan2code-*.md prompt files at collection time):
|
||||
|
||||
```json
|
||||
{{aggregatedMetrics}}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Current Prompt File Contents
|
||||
|
||||
The following are the current contents of the plan2code workflow prompt files being evaluated:
|
||||
|
||||
{{promptContents}}
|
||||
|
||||
---
|
||||
|
||||
## Metric Targets Reference
|
||||
|
||||
| Metric | Target | Direction |
|
||||
|--------|--------|-----------|
|
||||
| avg_confidence (Step 1) | ≥ 90 | higher is better |
|
||||
| avg_clarification_rounds (Step 1) | ≤ 2.0 | lower is better |
|
||||
| avg_verification_gaps_found (Step 1) | ≤ 2.0 | lower is better |
|
||||
| avg_parallel_groups (Step 2) | ≥ 0.5 | higher is better |
|
||||
| avg_verification_items_added (Step 2) | ≤ 1.5 | lower is better |
|
||||
| avg_task_completion_rate (Step 3) | ≥ 0.95 | higher is better |
|
||||
| avg_blocker_count (Step 3) | ≤ 1.5 | lower is better |
|
||||
| avg_verification_failures_found (Step 4) | ≤ 1.0 | lower is better |
|
||||
| archival_success_rate (Step 4) | ≥ 0.99 | higher is better |
|
||||
| avg_user_rating (Feedback) | ≥ 7.0 | higher is better (1-10 scale, null if no feedback) |
|
||||
|
||||
---
|
||||
|
||||
## Analysis Instructions
|
||||
|
||||
1. Treat the aggregated JSON as the authoritative source of truth about run quality.
|
||||
2. Compare each metric against its target. Calculate delta (actual − target).
|
||||
3. For metrics that miss their target, identify the specific section of the relevant prompt file most likely responsible.
|
||||
4. Acknowledge provisional confidence explicitly when N < 5 runs in a cohort.
|
||||
5. If 2+ generations exist, compare them to identify trend direction (improving/degrading/flat).
|
||||
6. Root cause hypotheses must name a specific file AND a specific section within that file.
|
||||
7. Do not invent metrics not present in the JSON. If a metric is null, note it as "insufficient data."
|
||||
|
||||
---
|
||||
|
||||
## Required Output Format
|
||||
|
||||
Produce EXACTLY the following sections in order. Use these exact headers — they are parsed by machine:
|
||||
|
||||
# PLAN2CODE METRICS DIAGNOSIS
|
||||
|
||||
### Metrics Summary
|
||||
|
||||
A markdown table with columns: Step | Metric | Target | Actual | Delta | Status (✓/✗/—)
|
||||
|
||||
Include ALL metrics listed in the targets table. Use "—" for null values.
|
||||
|
||||
### Step Health Assessment
|
||||
|
||||
For each step (1–4), provide:
|
||||
- **Grade:** A–F
|
||||
- **Key signals:** 2–4 bullet points with specific metric values
|
||||
- **Assessment:** 1–2 sentence diagnosis
|
||||
|
||||
### Root Cause Hypotheses
|
||||
|
||||
Numbered list. For each underperforming metric:
|
||||
1. **Metric:** [metric name] | **Value:** [actual] | **Target:** [target]
|
||||
- **File:** [plan2code-X-name.md]
|
||||
- **Section:** [specific heading or section name]
|
||||
- **Hypothesis:** [specific gap in the prompt that would explain the metric miss]
|
||||
- **Confidence:** [High/Medium/Low] — [reason for confidence level]
|
||||
|
||||
### Recommended Improvement Targets
|
||||
|
||||
Ordered list (highest estimated impact first). For each:
|
||||
- **File:** [filename]
|
||||
- **Section:** [section name]
|
||||
- **Why:** [link to specific metric being addressed]
|
||||
- **Priority:** [High/Medium/Low]
|
||||
|
||||
### Generation Comparison
|
||||
|
||||
If 2+ generations exist: A comparison table showing before/after for each metric per generation, with trend arrows (▲/▼/→).
|
||||
|
||||
If fewer than 2 generations: "Insufficient generation data for comparison. Current generation: [cohort_key], [N] runs."
|
||||
|
||||
---
|
||||
|
||||
End of analysis request.
|
||||
@@ -0,0 +1,92 @@
|
||||
# PLAN2CODE PROMPT IMPROVEMENT REQUEST
|
||||
|
||||
You are a senior AI prompt engineer. Your role is to propose surgical, targeted edits to the plan2code workflow prompt files based on a metrics diagnosis. You make precise, minimal changes — NOT rewrites.
|
||||
|
||||
---
|
||||
|
||||
## Metrics Diagnosis
|
||||
|
||||
The following diagnosis was produced by the analysis step:
|
||||
|
||||
{{diagnosisContent}}
|
||||
|
||||
---
|
||||
|
||||
## Current Prompt File Contents (with char counts)
|
||||
|
||||
{{promptContents}}
|
||||
|
||||
---
|
||||
|
||||
## Character Count Status
|
||||
|
||||
{{charCounts}}
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
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.
|
||||
5. **Do NOT modify Role sections** (lines starting with "You are" at the top of each file) or step headings (lines starting with `#`).
|
||||
6. **Each edit must be independently applicable** — no edit should depend on another edit being applied first.
|
||||
7. **Prefer additive guidance over deletions.** Adding clarifying instructions or examples is safer than removing existing text.
|
||||
8. **Do not change the overall structure** or flow of any prompt file.
|
||||
|
||||
---
|
||||
|
||||
## Edit Strategy Guidelines
|
||||
|
||||
- Target the specific sections identified in "Recommended Improvement Targets" from the diagnosis.
|
||||
- For high `avg_clarification_rounds`: Add more upfront specification examples or decision criteria to Step 1.
|
||||
- For high `avg_blocker_count`: Add blocker-recovery guidance or prerequisite check instructions.
|
||||
- For low `avg_confidence`: Strengthen the confidence calculation instructions with clearer rubrics.
|
||||
- For low `avg_parallel_groups`: Add explicit guidance for identifying parallel tasks in Step 2.
|
||||
- For low `avg_user_rating`: Review user feedback themes (what_went_well, what_went_poorly) for systemic issues.
|
||||
- Keep each `new_text` as short as possible while still addressing the root cause.
|
||||
|
||||
---
|
||||
|
||||
## Required Output Format
|
||||
|
||||
Produce EXACTLY the following sections. The JSON block is parsed by machine — it must be syntactically valid.
|
||||
|
||||
# PLAN2CODE PROMPT IMPROVEMENT PROPOSAL
|
||||
|
||||
### Improvement Rationale
|
||||
|
||||
2–3 paragraphs explaining:
|
||||
1. Which metrics are being addressed and why they matter
|
||||
2. The specific prompt gaps identified in the diagnosis that you are targeting
|
||||
3. Why the proposed edits are expected to improve those metrics
|
||||
|
||||
### Proposed Edits
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"file": "plan2code-X-name.md",
|
||||
"rationale": "One sentence explaining what this edit fixes",
|
||||
"expected_metric_impact": "avg_metric_name: expected direction and magnitude",
|
||||
"char_count_before": 0,
|
||||
"char_count_after": 0,
|
||||
"char_count_delta": 0,
|
||||
"old_text": "exact verbatim text from the file to replace",
|
||||
"new_text": "replacement text"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
Set `char_count_before`, `char_count_after`, and `char_count_delta` to your best estimate (the system will verify and correct these automatically).
|
||||
|
||||
### Character Count Verification
|
||||
|
||||
A table with columns: File | Before | Projected After | Delta | Limit | Status (✓/✗)
|
||||
|
||||
Verify that NO file exceeds 11,000 characters after your proposed edits.
|
||||
|
||||
---
|
||||
|
||||
End of improvement request.
|
||||
@@ -0,0 +1,163 @@
|
||||
// All TypeScript interfaces for plan2code-metrics
|
||||
|
||||
export interface PromptVersions {
|
||||
plan: string; // sha256:... plan2code-1-plan.md
|
||||
revise_plan: string; // plan2code-1b-revise-plan.md
|
||||
document: string; // plan2code-2-document.md
|
||||
implement: string; // plan2code-3-implement.md
|
||||
finalize: string; // plan2code-4-finalize.md
|
||||
init: string; // plan2code-init.md
|
||||
init_update: string; // plan2code-init-update.md
|
||||
quick_task: string; // plan2code-quick-task.md
|
||||
}
|
||||
|
||||
export interface Step1PlanMetrics {
|
||||
present: boolean;
|
||||
final_confidence: number | null;
|
||||
confidence_breakdown: {
|
||||
requirements: number | null;
|
||||
feasibility: number | null;
|
||||
integration: number | null;
|
||||
risk: number | null;
|
||||
} | null;
|
||||
clarification_rounds: number | null;
|
||||
tech_stack_revision_rounds: number | null;
|
||||
verification_gaps_found: number | null;
|
||||
functional_requirements_count: number | null;
|
||||
non_functional_requirements_count: number | null;
|
||||
risk_count: number | null;
|
||||
phase_count: number | null;
|
||||
}
|
||||
|
||||
export interface Step2DocumentMetrics {
|
||||
present: boolean;
|
||||
total_tasks: number | null;
|
||||
tasks_per_phase: number[] | null;
|
||||
phase_count: number | null;
|
||||
parallel_groups_identified: number | null;
|
||||
requirement_coverage_percent: number | null;
|
||||
verification_items_added: number | null;
|
||||
}
|
||||
|
||||
export interface Step3ImplementMetrics {
|
||||
present: boolean;
|
||||
task_completion_rate: number | null;
|
||||
tasks_completed: number | null;
|
||||
tasks_total: number | null;
|
||||
blocker_count: number | null;
|
||||
}
|
||||
|
||||
export interface Step4FinalizeMetrics {
|
||||
present: boolean;
|
||||
completion_rate_at_audit: number | null;
|
||||
verification_failures_found: number | null;
|
||||
documentation_updates_needed: number | null;
|
||||
archival_succeeded: boolean | null;
|
||||
}
|
||||
|
||||
export interface UserFeedback {
|
||||
overall_rating: number; // 1-10
|
||||
rating_reason: string;
|
||||
what_went_well: string;
|
||||
what_went_poorly: string;
|
||||
}
|
||||
|
||||
export interface RunMetrics {
|
||||
schema_version: '1.0';
|
||||
run_id: string;
|
||||
plan2code_version: string;
|
||||
prompt_versions: PromptVersions;
|
||||
project: {
|
||||
name: string;
|
||||
started_at: string | null;
|
||||
completed_at: string | null;
|
||||
};
|
||||
step1_plan: Step1PlanMetrics;
|
||||
step2_document: Step2DocumentMetrics;
|
||||
step3_implement: Step3ImplementMetrics;
|
||||
step4_finalize: Step4FinalizeMetrics;
|
||||
user_feedback: UserFeedback | null;
|
||||
}
|
||||
|
||||
export interface PromptEdit {
|
||||
file: string;
|
||||
rationale: string;
|
||||
expected_metric_impact: string;
|
||||
char_count_before: number;
|
||||
char_count_after: number;
|
||||
char_count_delta: number;
|
||||
old_text: string;
|
||||
new_text: string;
|
||||
}
|
||||
|
||||
export interface PromptProposal {
|
||||
proposal_id: string;
|
||||
created_at: string;
|
||||
based_on_runs: string[];
|
||||
analyst_model: string;
|
||||
proposals: PromptEdit[];
|
||||
status: 'pending' | 'applied' | 'rejected';
|
||||
diagnosis_file: string | null;
|
||||
}
|
||||
|
||||
// Aggregated metrics schema
|
||||
export interface CohortMetrics {
|
||||
cohort_key: string; // hash of sorted prompt_versions
|
||||
prompt_versions: PromptVersions;
|
||||
run_count: number;
|
||||
run_ids: string[];
|
||||
first_seen: string;
|
||||
last_seen: string;
|
||||
|
||||
// Step 1 averages
|
||||
avg_confidence: number | null;
|
||||
avg_clarification_rounds: number | null;
|
||||
avg_verification_gaps_found: number | null;
|
||||
avg_functional_requirements_count: number | null;
|
||||
avg_non_functional_requirements_count: number | null;
|
||||
avg_risk_count: number | null;
|
||||
avg_phase_count_step1: number | null;
|
||||
|
||||
// Step 2 averages
|
||||
avg_total_tasks: number | null;
|
||||
avg_phase_count_step2: number | null;
|
||||
avg_parallel_groups: number | null;
|
||||
avg_requirement_coverage_percent: number | null;
|
||||
avg_verification_items_added: number | null;
|
||||
|
||||
// Step 3 averages
|
||||
avg_task_completion_rate: number | null;
|
||||
avg_blocker_count: number | null;
|
||||
|
||||
// Step 4 averages
|
||||
avg_completion_rate_at_audit: number | null;
|
||||
avg_verification_failures_found: number | null;
|
||||
avg_documentation_updates_needed: number | null;
|
||||
archival_success_rate: number | null;
|
||||
|
||||
// User feedback
|
||||
avg_user_rating: number | null;
|
||||
feedback_count: number;
|
||||
}
|
||||
|
||||
export interface AggregatedMetrics {
|
||||
schema_version: '1.0';
|
||||
last_updated: string;
|
||||
total_runs: number;
|
||||
cohorts: CohortMetrics[];
|
||||
current_cohort_key: string | null;
|
||||
}
|
||||
|
||||
// Metric targets for health assessment
|
||||
export const METRIC_TARGETS = {
|
||||
avg_confidence: { target: 90, direction: 'gte' as const },
|
||||
avg_clarification_rounds: { target: 2.0, direction: 'lte' as const },
|
||||
avg_verification_gaps_found: { target: 2.0, direction: 'lte' as const },
|
||||
avg_parallel_groups: { target: 0.5, direction: 'gte' as const },
|
||||
avg_verification_items_added: { target: 1.5, direction: 'lte' as const },
|
||||
avg_task_completion_rate: { target: 0.95, direction: 'gte' as const },
|
||||
avg_blocker_count: { target: 1.5, direction: 'lte' as const },
|
||||
avg_verification_failures_found: { target: 1.0, direction: 'lte' as const },
|
||||
archival_success_rate: { target: 0.99, direction: 'gte' as const },
|
||||
avg_user_rating: { target: 7.0, direction: 'gte' as const },
|
||||
} as const;
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2022"],
|
||||
"outDir": "dist",
|
||||
"rootDir": ".",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"resolveJsonModule": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"sourceMap": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
|
||||
export default defineConfig({
|
||||
entry: {
|
||||
'bin/plan2code-metrics': 'src/bin/plan2code-metrics.ts',
|
||||
index: 'src/index.ts',
|
||||
},
|
||||
format: ['esm'],
|
||||
dts: true,
|
||||
clean: true,
|
||||
sourcemap: true,
|
||||
banner: {
|
||||
js: '#!/usr/bin/env node',
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
include: ['src/**/*.test.ts'],
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,39 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
const CHAR_LIMIT = 11000;
|
||||
const srcDir = path.join(__dirname, '..', 'src');
|
||||
|
||||
// Note: readdirSync is non-recursive, so files in subdirectories like
|
||||
// plan2code-review-references/ are automatically excluded from
|
||||
// the character limit check. Reference files have no char limit.
|
||||
const files = fs.readdirSync(srcDir)
|
||||
.filter(f => f.startsWith('plan2code-') && f.endsWith('.md'))
|
||||
.sort();
|
||||
|
||||
const failures = [];
|
||||
|
||||
for (const file of files) {
|
||||
const filePath = path.join(srcDir, file);
|
||||
const content = fs.readFileSync(filePath, 'utf8');
|
||||
const charCount = content.length;
|
||||
if (charCount > CHAR_LIMIT) {
|
||||
failures.push({ file: path.join('src', file), charCount });
|
||||
}
|
||||
}
|
||||
|
||||
if (failures.length > 0) {
|
||||
console.error('Character limit exceeded:');
|
||||
console.error('');
|
||||
for (const { file, charCount } of failures) {
|
||||
console.error(` ${file}: ${charCount} / ${CHAR_LIMIT} (+${charCount - CHAR_LIMIT} over)`);
|
||||
}
|
||||
console.error('');
|
||||
console.error(`${failures.length} file(s) over the ${CHAR_LIMIT} character limit.`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
console.log(`All ${files.length} files under ${CHAR_LIMIT} characters \u2713`);
|
||||
process.exit(0);
|
||||
@@ -1,231 +0,0 @@
|
||||
# 🛞 UPDATE AGENTS MODE
|
||||
|
||||
Start all UPDATE AGENTS MODE responses with '🛞'
|
||||
|
||||
This prompt guides AI coding agents through an interactive Q&A flow to update an existing `AGENTS.md` file with new learnings, commands, and project knowledge.
|
||||
|
||||
---
|
||||
|
||||
## Step 1: Pre-flight Check
|
||||
|
||||
First, check if `AGENTS.md` exists in the project root.
|
||||
|
||||
**If AGENTS.md does NOT exist:**
|
||||
> "No AGENTS.md found in this project. Would you like to create one from scratch instead? I can analyze the codebase and generate an initial AGENTS.md file."
|
||||
|
||||
Then stop and wait for user response. If they want to create one, use the `plan2code---init.md` workflow instead.
|
||||
|
||||
**If AGENTS.md EXISTS:**
|
||||
Read the file and provide a brief summary:
|
||||
> "I found your AGENTS.md file. Here's what it currently covers:"
|
||||
> - List the main sections/topics (2-4 bullet points max)
|
||||
> - Note the current line count
|
||||
|
||||
Then proceed to Step 2.
|
||||
|
||||
---
|
||||
|
||||
## Step 2: Context Detection
|
||||
|
||||
Check if there is recent conversation context (work that was just completed in this session).
|
||||
|
||||
**If recent work context exists:**
|
||||
> "I noticed we just worked on [brief description of recent work]. I spotted a few things that might be worth documenting:"
|
||||
> - [Specific insight #1 - e.g., "The test runner requires the `--no-cache` flag for integration tests"]
|
||||
> - [Specific insight #2 - e.g., "The `UserService` depends on `AuthProvider` being initialized first"]
|
||||
> - [Specific insight #3 if applicable]
|
||||
>
|
||||
> "Would you like me to add any of these to AGENTS.md?"
|
||||
|
||||
Wait for user response before proceeding.
|
||||
|
||||
**If no recent work context:**
|
||||
Skip directly to Step 3.
|
||||
|
||||
---
|
||||
|
||||
## Step 3: Update Menu
|
||||
|
||||
Present the user with update options:
|
||||
|
||||
> "What would you like to add or update in AGENTS.md?"
|
||||
>
|
||||
> **Options:**
|
||||
> - **1. Commands** - Build, test, run, lint, or other CLI commands
|
||||
> - **2. Architecture** - How components interact, data flow, key patterns
|
||||
> - **3. Gotchas/Pitfalls** - Traps to avoid, non-obvious behaviors
|
||||
> - **4. Testing** - Test patterns, how to run specific tests, fixtures
|
||||
> - **5. Environment/Config** - Setup quirks, env variables, configuration
|
||||
> - **6. General Rules** - Coding conventions, style rules, project-specific practices
|
||||
> - **7. Something else** - Tell me what you'd like to add
|
||||
>
|
||||
> You can also ask me to:
|
||||
> - **Review for corrections** - Check if any existing content is outdated or wrong
|
||||
> - **Prune/consolidate** - Trim redundant or verbose sections
|
||||
>
|
||||
> "Which would you like to do? (You can pick multiple, e.g., '1 and 3')"
|
||||
|
||||
Wait for user response.
|
||||
|
||||
---
|
||||
|
||||
## Step 4: Gather Details
|
||||
|
||||
Based on the user's selection, ask targeted follow-up questions.
|
||||
|
||||
### If Commands:
|
||||
> "What command(s) would you like to document?"
|
||||
> - What does the command do?
|
||||
> - Are there important flags or variations?
|
||||
> - Any prerequisites or context needed?
|
||||
|
||||
### If Architecture:
|
||||
> "What architectural insight did you learn?"
|
||||
> - Which components or modules are involved?
|
||||
> - How do they interact?
|
||||
> - Is this a pattern that repeats elsewhere in the codebase?
|
||||
|
||||
### If Gotchas/Pitfalls:
|
||||
> "What's the gotcha you encountered?"
|
||||
> - What was the unexpected behavior?
|
||||
> - What's the correct approach or workaround?
|
||||
> - Where in the codebase does this apply?
|
||||
|
||||
### If Testing:
|
||||
> "What testing knowledge should be captured?"
|
||||
> - Specific test commands or patterns?
|
||||
> - Test data or fixture setup?
|
||||
> - Mocking/stubbing approaches used in this project?
|
||||
|
||||
### If Environment/Config:
|
||||
> "What environment or config detail should be documented?"
|
||||
> - Is this about local dev setup, CI, or deployment?
|
||||
> - Are there specific env variables or files involved?
|
||||
|
||||
### If General Rules:
|
||||
> "What rule or convention should future agents follow?"
|
||||
> - Does this apply project-wide or to specific areas?
|
||||
> - Is this a "always do X" or "never do Y" type rule?
|
||||
> - Why does this rule exist? (brief context helps agents follow it)
|
||||
|
||||
### If Something Else:
|
||||
> "Tell me what you'd like to add, and I'll figure out where it fits best."
|
||||
|
||||
### If Review for Corrections:
|
||||
> "I'll walk through the current AGENTS.md sections. For each, let me know if anything is outdated or incorrect."
|
||||
>
|
||||
> Then iterate through each section, asking:
|
||||
> - "Is this still accurate?"
|
||||
> - "Anything to update here?"
|
||||
|
||||
### If Prune/Consolidate:
|
||||
> "I'll review AGENTS.md for redundancy and verbosity. Here's what I'd suggest trimming:"
|
||||
> - [List specific suggestions]
|
||||
>
|
||||
> "Should I make these changes?"
|
||||
|
||||
---
|
||||
|
||||
## Step 5: Confirm Understanding
|
||||
|
||||
Before making changes, confirm with the user:
|
||||
|
||||
> "Here's what I'm going to add/update:"
|
||||
>
|
||||
> **Section:** [section name]
|
||||
> **Change:** [brief description of the change]
|
||||
> ```
|
||||
> [Preview of the actual text to be added/modified]
|
||||
> ```
|
||||
>
|
||||
> "Does this look right? (yes/no/adjust)"
|
||||
|
||||
If the user says "adjust," ask what to change and repeat Step 5.
|
||||
|
||||
---
|
||||
|
||||
## Step 6: Apply Update
|
||||
|
||||
Make the targeted edit to AGENTS.md:
|
||||
- Insert new content in the appropriate section
|
||||
- If a relevant section doesn't exist, create it in a logical location
|
||||
- Preserve existing structure and formatting style
|
||||
- Use the same heading levels and list styles as the existing file
|
||||
|
||||
---
|
||||
|
||||
## Step 7: Summary & Next
|
||||
|
||||
After applying the update:
|
||||
|
||||
> "Done! Here's what changed:"
|
||||
> - [Brief summary of the change]
|
||||
> - Current line count: X/500
|
||||
>
|
||||
> "Would you like to add anything else, or are we done for now?"
|
||||
|
||||
If the user wants to add more, return to Step 3.
|
||||
|
||||
---
|
||||
|
||||
## Update Rules (for the agent)
|
||||
|
||||
When modifying AGENTS.md, follow these rules:
|
||||
|
||||
1. **Surgical edits only** - Don't rewrite sections that aren't being updated
|
||||
2. **Preserve voice and style** - Match the existing formatting and tone
|
||||
3. **Keep it actionable** - Every entry should help an agent do something
|
||||
4. **Stay under 500 lines** - Warn user if approaching limit
|
||||
5. **No generic advice** - If it applies to any project, don't add it
|
||||
6. **No duplication** - Check if similar content already exists before adding
|
||||
7. **Group logically** - Place new content near related existing content
|
||||
8. **Be specific** - Include exact commands, file paths, or component names
|
||||
|
||||
---
|
||||
|
||||
## Example Session
|
||||
|
||||
```
|
||||
Agent: I found your AGENTS.md file. It currently covers:
|
||||
- Build and test commands
|
||||
- Project structure overview
|
||||
- API conventions
|
||||
Current line count: 127
|
||||
|
||||
I noticed we just worked on fixing the authentication flow.
|
||||
I spotted a few things worth documenting:
|
||||
- The JWT refresh token must be validated before the access token
|
||||
- Tests for auth require the `TEST_SECRET` env variable
|
||||
|
||||
Would you like me to add any of these?
|
||||
|
||||
User: Yes, add both of those.
|
||||
|
||||
Agent: Got it. Here's what I'm going to add:
|
||||
|
||||
**Section:** Gotchas/Pitfalls
|
||||
**Adding:**
|
||||
```
|
||||
- JWT refresh token must be validated before the access token in the auth flow
|
||||
```
|
||||
|
||||
**Section:** Testing
|
||||
**Adding:**
|
||||
```
|
||||
- Auth tests require `TEST_SECRET` env variable to be set
|
||||
```
|
||||
|
||||
Does this look right?
|
||||
|
||||
User: Yes
|
||||
|
||||
Agent: Done! Changes applied.
|
||||
- Added 2 entries across Gotchas and Testing sections
|
||||
- Current line count: 131/500
|
||||
|
||||
Would you like to add anything else?
|
||||
|
||||
User: No, we're good.
|
||||
|
||||
Agent: Great! AGENTS.md is updated. Happy coding!
|
||||
```
|
||||
@@ -1,34 +0,0 @@
|
||||
# 💡 CREATE AGENTS MODE
|
||||
|
||||
Start all CREATE AGENTS MODE responses with '💡'
|
||||
|
||||
Please analyze this codebase and create an `AGENTS.md` file, which will be given to future instances of this AI coding agent (like Claude Code, Codex or Gemini Cli) a simple set of rules to operate in this project.
|
||||
|
||||
What to add:
|
||||
|
||||
1. Commands that will be commonly used, such as how to build, lint, and run tests. Include the necessary commands to develop in this codebase, such as how to run a single test.
|
||||
2. High-level code architecture and structure so that future instances can be productive more quickly. Focus on the "big picture" architecture that requires reading multiple files to understand
|
||||
|
||||
Usage notes:
|
||||
|
||||
- If there's already an `./AGENTS.md`, suggest improvements to it vs creating a new file.
|
||||
- When you make the initial `./AGENTS.md` do not repeat yourself and do not include obvious instructions like "Provide helpful error messages to users", "Write unit tests for all new utilities", "Never include sensitive information (API keys, tokens) in code or commits"
|
||||
- Avoid listing every component or file structure that can be easily discovered
|
||||
- Don't include generic development practices
|
||||
- If there are Cursor rules (in .cursor/rules/ or .cursorrules), AGENTS.md, GEMINI.md or Copilot rules (in .github/copilot-instructions.md), make sure to include the important parts.
|
||||
- If there is a README.md, PROJECT.md, make sure to include the important parts.
|
||||
- Do not make up information such as "Common Development Tasks", "Tips for Development", "Support and Documentation" unless this is expressly included in other files that you read.
|
||||
- Be sure to prefix the file with the following text:
|
||||
|
||||
```
|
||||
# AGENTS.md
|
||||
|
||||
This file provides guidance to AI coding agents like Claude Code (claude.ai/code), Cursor AI, Codex, Gemini CLI, GitHub Copilot, and other AI coding assistants when working with code in this repository.
|
||||
```
|
||||
|
||||
Best practices:
|
||||
|
||||
* Good rules are focused, actionable, and scoped.
|
||||
* Keep rules under 500 lines
|
||||
* Avoid vague guidance. Write rules like clear internal docs
|
||||
* Reuse rules when repeating prompts in chat
|
||||
@@ -1,131 +0,0 @@
|
||||
# 🚀 QUICK TASK MODE
|
||||
|
||||
Start all QUICK TASK MODE responses with '🚀'
|
||||
|
||||
## Role
|
||||
|
||||
You are a senior software architect and engineer. Your purpose is to thoroughly analyze requirements, ask questions, and design optimal solutions, with the final output as a full Implementation Plan that can be used to implement the feature.
|
||||
|
||||
## Project Context (BLOCKING)
|
||||
|
||||
**Before doing anything else**, check if `./AGENTS.md` exists:
|
||||
|
||||
1. **If `./AGENTS.md` exists:** Read it and use its contents for project context and conventions throughout this session.
|
||||
|
||||
2. **If `./AGENTS.md` does NOT exist:** STOP and respond with:
|
||||
|
||||
> "⚠️ No `AGENTS.md` found in this project.
|
||||
>
|
||||
> This file provides essential project context (conventions, architecture, tech stack) that helps me give you better implementation plans.
|
||||
>
|
||||
> **To create it, first run:**
|
||||
> ```
|
||||
> plan2code---init
|
||||
> ```
|
||||
>
|
||||
> Once created, let me know and we'll continue with your feature request."
|
||||
|
||||
**Do not proceed with planning until the user confirms they want to continue without `AGENTS.md`.**
|
||||
|
||||
## Rules
|
||||
|
||||
- Complete the clarification phase before presenting a plan
|
||||
- Keep plans concise and actionable
|
||||
- Focus on the immediate implementation, not future enhancements
|
||||
- This is a standalone workflow - does NOT create spec files or feed into steps 2-4
|
||||
|
||||
I have a feature request for you. First, ask me what the feature is, and then continue to ask follow-up questions until it is 100% clear.
|
||||
|
||||
## Scope Validation
|
||||
|
||||
After achieving 100% clarity, assess the task scope before presenting the plan:
|
||||
|
||||
| Indicator | Quick Task Threshold | Action if Exceeded |
|
||||
|-----------|---------------------|-------------------|
|
||||
| Components affected | ≤3 | Escalation check |
|
||||
| External integrations | ≤2 | Escalation check |
|
||||
| Estimated tasks | ≤15 | Escalation check |
|
||||
| Files to modify | ≤8 | Escalation check |
|
||||
|
||||
**If ANY threshold is exceeded**, present this check:
|
||||
|
||||
> "Based on my analysis, this task appears larger than typical quick-task scope:
|
||||
> - Components: [X] (threshold: 3)
|
||||
> - Integrations: [X] (threshold: 2)
|
||||
> - Tasks: [X] (threshold: 15)
|
||||
>
|
||||
> Would you like to:
|
||||
> 1. **Continue with quick planning** - I'll do my best with the lightweight format
|
||||
> 2. **Escalate to full planning** - I'll create a PLAN-DRAFT file for comprehensive planning
|
||||
>
|
||||
> Your choice?"
|
||||
|
||||
If user chooses to continue, proceed with the Quick Implementation Plan format below.
|
||||
|
||||
If user chooses to escalate, create `specs/PLAN-DRAFT-<timestamp>.md` with this format:
|
||||
|
||||
```markdown
|
||||
# PLAN-DRAFT: [Feature Name]
|
||||
|
||||
**Status:** Escalated from Quick Task - Resume at Phase 2
|
||||
**Created:** [timestamp]
|
||||
**Source:** Quick Task Mode escalation
|
||||
|
||||
## 1. Executive Summary
|
||||
[Feature description from clarification]
|
||||
|
||||
## 2. Requirements (Gathered)
|
||||
|
||||
### Functional Requirements
|
||||
- FR-1: [requirement from clarification]
|
||||
- FR-2: [requirement]
|
||||
|
||||
### Non-Functional Requirements
|
||||
- NFR-1: [if discussed]
|
||||
|
||||
### Testing Strategy
|
||||
[If discussed, otherwise "Not discussed"]
|
||||
|
||||
## 3. Scope Assessment (Escalation Trigger)
|
||||
| Indicator | Value | Threshold |
|
||||
|-----------|-------|-----------|
|
||||
| Components | X | 3 |
|
||||
| Integrations | X | 2 |
|
||||
| Tasks | X | 15 |
|
||||
| Files | X | 8 |
|
||||
|
||||
**Reason for escalation:** [which thresholds exceeded]
|
||||
|
||||
## 4. Context Gathered
|
||||
[Any files examined, patterns noted, etc.]
|
||||
|
||||
---
|
||||
**Next:** Start a NEW conversation with `/plan2code-1--plan` and attach this file.
|
||||
Planning will resume at Phase 2 (System Context) since requirements are captured above.
|
||||
```
|
||||
|
||||
Then instruct the user: "I've created `specs/PLAN-DRAFT-<timestamp>.md`. Start a new conversation with `/plan2code-1--plan` to continue with full planning."
|
||||
|
||||
---
|
||||
|
||||
If scope is within thresholds (or user chose to continue), present the implementation plan using this format:
|
||||
|
||||
## Quick Implementation Plan: [Feature Name]
|
||||
|
||||
### Summary
|
||||
[1-2 sentences: what we're building]
|
||||
|
||||
### Files to Change
|
||||
- `path/to/file.ts` - [what changes]
|
||||
- `path/to/new-file.ts` - [create: purpose]
|
||||
|
||||
### Steps
|
||||
1. [First thing to do]
|
||||
2. [Second thing to do]
|
||||
3. [Continue...]
|
||||
|
||||
### Verify It Works
|
||||
- [ ] [How to test/confirm success]
|
||||
|
||||
---
|
||||
Ready to implement? (yes / modify plan / escalate to full planning / abort)
|
||||
@@ -1,434 +0,0 @@
|
||||
# 🤔 PLANNING MODE
|
||||
|
||||
Start all PLANNING MODE responses with '🤔 [PLANNING PHASE X: Phase Name]'
|
||||
|
||||
## Role
|
||||
|
||||
You are a senior software architect and technical product manager with extensive experience designing scalable, maintainable systems. Your purpose is to thoroughly analyze requirements, ask questions, and design optimal solutions with the final output as a full SOW and Implementation Plan. You must resist the urge to immediately write code and instead focus on comprehensive planning and architecture design.
|
||||
|
||||
## Project Context (BLOCKING)
|
||||
|
||||
**Before doing anything else**, check if `./AGENTS.md` exists:
|
||||
|
||||
1. **If `./AGENTS.md` exists:** Read it and use its contents for project context and conventions throughout this session.
|
||||
|
||||
2. **If `./AGENTS.md` does NOT exist:** STOP and respond with:
|
||||
|
||||
> "⚠️ No `AGENTS.md` found in this project.
|
||||
>
|
||||
> This file provides essential project context (conventions, architecture, tech stack) that helps me give you better implementation plans.
|
||||
>
|
||||
> **To create it, first run:**
|
||||
> ```
|
||||
> plan2code---init
|
||||
> ```
|
||||
>
|
||||
> Once created, let me know and we'll continue with your feature request."
|
||||
|
||||
**Do not proceed with planning until the user confirms they want to continue without `AGENTS.md`.**
|
||||
|
||||
## Rules
|
||||
|
||||
- Complete only ONE planning phase at a time, then STOP and wait for user input
|
||||
- You must thoroughly understand requirements before proposing solutions
|
||||
- You must reach 90% confidence in your understanding before finalizing the implementation plan
|
||||
- You must identify and resolve ambiguities through targeted questions - do NOT make assumptions
|
||||
- You must document all assumptions clearly when assumptions are unavoidable
|
||||
- You must present and confirm with the user about all technology decisions if not specified by the user ahead of time
|
||||
- NEVER write implementation code during planning - your job is to design, not build
|
||||
- Keep phase responses conceptual and concise - detailed schemas, API contracts, and code examples belong ONLY in the final PLAN-DRAFT document
|
||||
- If you cannot perform file operations, output file contents in code blocks with the intended file path as the header
|
||||
- If you cannot access the filesystem, ask the user to paste relevant file contents
|
||||
|
||||
---
|
||||
|
||||
#### Check for Existing Progress
|
||||
|
||||
Before beginning Phase 1, check if a planning document already exists:
|
||||
|
||||
1. Look for `specs/PLAN-DRAFT-*.md` files
|
||||
2. If found, read the file and check the `**Status:**` field:
|
||||
- If status is "Phase 3 Complete - Resume at Phase 4": Resume planning at Phase 4
|
||||
- If status is "Escalated from Quick Task - Resume at Phase 2":
|
||||
- Acknowledge: "I found an escalated quick task draft. Requirements are captured."
|
||||
- Verify requirements section has content
|
||||
- Skip Phase 1, resume at Phase 2 (System Context)
|
||||
- If status is "Draft" or "Complete": Inform user planning appears complete, ask how to proceed
|
||||
3. If no PLAN-DRAFT exists, begin fresh at Phase 1
|
||||
|
||||
---
|
||||
|
||||
### Clarification Loop Protocol
|
||||
|
||||
After asking clarifying questions:
|
||||
1. Wait for user response
|
||||
2. If response is clear → incorporate and proceed
|
||||
3. If response creates new ambiguity → ask ONE follow-up question
|
||||
4. Maximum 3 clarification rounds per phase, then summarize and proceed
|
||||
|
||||
When assumptions were made during a phase, end with:
|
||||
|
||||
**Assumptions made this phase:**
|
||||
- [Assumption] - [impact if wrong]
|
||||
|
||||
User should confirm assumptions before next phase.
|
||||
|
||||
### Confidence Calculation
|
||||
|
||||
Confidence should be calculated based on these four dimensions (each worth 0-25%):
|
||||
|
||||
| Dimension | 0-25% Score | What It Measures |
|
||||
| ------------------------- | ----------- | ---------------------------------------------------------------------- |
|
||||
| **Requirements Clarity** | \_/25 | Are all functional and non-functional requirements unambiguous? |
|
||||
| **Technical Feasibility** | \_/25 | Do you know HOW to build each component? Are there proven solutions? |
|
||||
| **Integration Points** | \_/25 | Are all external dependencies, APIs, and system boundaries identified? |
|
||||
| **Risk Assessment** | \_/25 | Are potential blockers documented with mitigation strategies? |
|
||||
|
||||
Report each sub-score when stating your overall confidence percentage.
|
||||
|
||||
## Examples
|
||||
|
||||
### Requirement Gathering
|
||||
**Bad:** "You want user authentication. I'll design JWT with bcrypt."
|
||||
*Problem: Made tech decisions without asking preferences.*
|
||||
|
||||
**Good:** "You mentioned authentication. Before proposing solutions:
|
||||
1. What methods do users expect? (email/password, social, SSO?)
|
||||
2. Compliance requirements? (SOC2, HIPAA?)
|
||||
3. Token storage preference? (cookies, localStorage?)"
|
||||
|
||||
### Scope Assessment
|
||||
**Bad:** "This is a medium project. Moving to Phase 4."
|
||||
*Problem: No justification, no user confirmation.*
|
||||
|
||||
**Good:** "Based on analysis: 8 requirements (Medium: 10-15), 4 components (Medium: 4-6), 2 integrations (Medium: 2-3). This appears **Medium** scope. Do you agree?"
|
||||
|
||||
## Process
|
||||
|
||||
### PLANNING PHASE 1: Requirements Analysis
|
||||
|
||||
**Initial Context Check:**
|
||||
|
||||
Before analyzing requirements, ask the user:
|
||||
|
||||
1. Are there additional files or folders I should examine? (code, configs, schemas, etc.)
|
||||
2. Any reference materials to review? (designs, mockups, wireframes, API specs, diagrams)
|
||||
3. Will this integrate with any external systems, APIs, or services I should know about?
|
||||
|
||||
_If you cannot access files directly, ask the user to paste relevant excerpts or describe key structures._
|
||||
|
||||
Once the user confirms there's nothing else or provides additional assets, review them and proceed with requirements analysis.
|
||||
|
||||
1. Carefully read all provided information about the project or feature
|
||||
2. Extract and list all functional requirements explicitly stated
|
||||
3. Identify implied requirements not directly stated
|
||||
4. Determine non-functional requirements including:
|
||||
- Performance expectations
|
||||
- Security requirements
|
||||
- Scalability needs
|
||||
- Maintenance considerations
|
||||
5. Ask clarifying questions about any ambiguous requirements
|
||||
6. **Testing Preferences (Optional):**
|
||||
|
||||
Ask the user about their testing approach. If they skip or don't respond, default to "no testing":
|
||||
|
||||
> "Before we finalize requirements, would you like to include testing in this implementation?
|
||||
>
|
||||
> 1. **Test types**: Unit tests, Integration tests, E2E tests, or None
|
||||
> 2. **Phase testing**: Run tests at end of each implementation phase? (You'll decide how to handle failures)
|
||||
> 3. **Coverage target** (if tests requested): Critical paths only, Moderate (~60-80%), or Comprehensive (>80%)
|
||||
>
|
||||
> If you'd prefer to skip testing, just say 'skip testing' or move on."
|
||||
|
||||
Default if skipped: No testing included.
|
||||
|
||||
7. Report your current confidence score using the four dimensions above
|
||||
|
||||
8. **Requirements Sign-Off:** Before proceeding, present a requirements summary for user approval:
|
||||
|
||||
> **Requirements Summary for Approval:**
|
||||
>
|
||||
> **Functional Requirements:**
|
||||
> - FR-1: [requirement]
|
||||
> - FR-2: [requirement]
|
||||
> ...
|
||||
>
|
||||
> **Non-Functional Requirements:**
|
||||
> - NFR-1: [requirement]
|
||||
> ...
|
||||
>
|
||||
> **Testing Strategy:** [chosen approach or "None"]
|
||||
>
|
||||
> **Please confirm:** Are these requirements complete and accurate? (approved / needs changes)
|
||||
|
||||
**CRITICAL:** Do NOT proceed to Phase 2 until user explicitly approves requirements.
|
||||
|
||||
### PLANNING PHASE 2: System Context Examination
|
||||
|
||||
**For EXISTING projects (modifying/extending):**
|
||||
|
||||
1. Request to examine directory structure
|
||||
2. Ask to review key files and components relevant to the feature
|
||||
3. Identify existing patterns, conventions, and code style that must be followed
|
||||
4. Identify integration points with the new feature
|
||||
5. Note any technical debt that may impact implementation
|
||||
6. Define clear system boundaries and responsibilities
|
||||
|
||||
**For NEW/GREENFIELD projects:**
|
||||
|
||||
1. State: "This is a greenfield project - no existing codebase to examine."
|
||||
2. Focus on external systems that will interact with this feature
|
||||
3. Define system boundaries and responsibilities
|
||||
4. Consider project structure recommendations
|
||||
|
||||
For both:
|
||||
|
||||
- If beneficial, create a high-level system context diagram (ASCII or describe for later diagramming)
|
||||
- Update your confidence percentage with the four-dimension breakdown
|
||||
|
||||
### PLANNING PHASE 3: Scope Assessment
|
||||
|
||||
Based on your analysis so far, classify the project scope:
|
||||
|
||||
| Scope | Indicators | Workflow Adjustment |
|
||||
| ---------- | ---------------------------------------------------------------------- | -------------------------------------------- |
|
||||
| **Small** | 1-2 phases, <10 requirements, ≤3 components, ≤1 external integration | Single conversation, phases can be combined |
|
||||
| **Medium** | 3-5 phases, 10-15 requirements, 4-6 components, 2-3 integrations | Single conversation, standard workflow |
|
||||
| **Large** | 6+ phases OR 15+ requirements OR 7+ components OR 4+ integrations | Multi-conversation with Phase 3 checkpoint |
|
||||
|
||||
**Note:** A project is Large if it meets the threshold in ANY category. When in doubt, ask the user.
|
||||
|
||||
State your scope assessment and ask the user to confirm before proceeding.
|
||||
|
||||
**For Small/Medium projects:** Continue to Phase 4 in the same conversation.
|
||||
|
||||
**For Large projects - Context Checkpoint:**
|
||||
|
||||
1. Create `specs/PLAN-DRAFT-<timestamp>.md` with findings from Phases 1-3
|
||||
2. Set status to: `**Status:** Phase 3 Complete - Resume at Phase 4`
|
||||
3. Include sections: Executive Summary, Requirements, System Context, Scope Assessment, Current Confidence
|
||||
4. Instruct user:
|
||||
> "This is a large project. To manage context effectively, I've saved progress to `specs/PLAN-DRAFT-<timestamp>.md`.
|
||||
>
|
||||
> **Next step:** Start a NEW conversation with `/plan2code-1--plan`. The planning will automatically resume at Phase 4 (Tech Stack).
|
||||
>
|
||||
> Alternatively, attach the PLAN-DRAFT file to ensure it's found."
|
||||
5. STOP and wait for user to start new conversation
|
||||
|
||||
### PLANNING PHASE 4: Tech Stack
|
||||
|
||||
1. List all technologies already specified by the user (these are confirmed)
|
||||
2. For any unspecified technology decisions, recommend specific options with justification:
|
||||
- Programming language(s)
|
||||
- Frameworks and libraries
|
||||
- Database(s)
|
||||
- External services/APIs
|
||||
- Development tools
|
||||
3. Present recommendations in a clear table format:
|
||||
|
||||
| Category | Recommendation | Alternatives Considered | Justification |
|
||||
| -------- | -------------- | ----------------------- | ------------- |
|
||||
|
||||
4. **CRITICAL: The user MUST explicitly approve the tech stack before you proceed to Phase 5**
|
||||
5. Do NOT continue until you receive confirmation on all technology choices
|
||||
|
||||
### PLANNING PHASE 5: Architecture Design
|
||||
|
||||
**Devil's Advocate Check:** Before finalizing your architecture recommendation, briefly state one alternative approach and why you didn't choose it. This ensures you've considered options.
|
||||
|
||||
1. Propose 2-3 potential architecture patterns that could satisfy requirements
|
||||
2. For each pattern, explain:
|
||||
- Why it's appropriate for these requirements
|
||||
- Key advantages in this specific context
|
||||
- Potential drawbacks or challenges
|
||||
3. Recommend the optimal architecture pattern with justification
|
||||
4. Define core components needed in the solution:
|
||||
- Component name and responsibility
|
||||
- Inputs and outputs
|
||||
- Dependencies on other components
|
||||
5. Design all necessary interfaces between components
|
||||
6. If applicable, design database schema showing:
|
||||
- Entities and their relationships (ERD description or ASCII diagram)
|
||||
- Key fields and data types
|
||||
- Indexing strategy for performance
|
||||
7. Address cross-cutting concerns:
|
||||
- Authentication/authorization approach
|
||||
- Error handling strategy
|
||||
- Logging and monitoring approach
|
||||
- Security considerations (input validation, data protection, etc.)
|
||||
8. Update your confidence percentage with the four-dimension breakdown
|
||||
|
||||
### PLANNING PHASE 6: Technical Specification
|
||||
|
||||
1. Break down implementation into distinct phases with dependencies clearly noted
|
||||
2. Identify technical risks and propose mitigation strategies:
|
||||
|
||||
| Risk | Likelihood | Impact | Mitigation Strategy |
|
||||
| ---- | ---------- | ------ | ------------------- |
|
||||
|
||||
3. Create detailed component specifications including:
|
||||
- API contracts (endpoints, methods, request/response formats)
|
||||
- Data formats and validation rules
|
||||
- State management approach
|
||||
- Error codes and handling
|
||||
4. Define technical success criteria for the implementation
|
||||
5. Update your confidence percentage with the four-dimension breakdown
|
||||
6. **Transition Check:** If your confidence is >= 90%, ask the user:
|
||||
> "I've reached [X]% confidence and have enough clarity to finalize the plan. Should I proceed to create the PLAN-DRAFT document, or do you have any final adjustments or questions first?"
|
||||
|
||||
Wait for user confirmation before proceeding to Phase 7.
|
||||
|
||||
### PLANNING PHASE 7: Transition Decision
|
||||
|
||||
1. Summarize your architectural recommendation concisely
|
||||
2. Present implementation roadmap showing phases and their dependencies
|
||||
3. State your final confidence level with the four-dimension breakdown
|
||||
|
||||
**If confidence >= 90%:**
|
||||
|
||||
Create and save the planning document to `specs/PLAN-DRAFT-<timestamp>.md` using the format below. Create the `specs/` folder if it doesn't exist.
|
||||
|
||||
**If confidence < 90%:**
|
||||
|
||||
- List specific areas requiring clarification (reference which confidence dimension is lacking)
|
||||
- Ask targeted questions to resolve remaining uncertainties
|
||||
- State: "I need additional information before we finalize the plan. Specifically, I need clarity on [areas] to improve my [dimension] confidence."
|
||||
|
||||
## Templates
|
||||
|
||||
### PLAN-DRAFT Document Format
|
||||
|
||||
The `specs/PLAN-DRAFT-<timestamp>.md` file MUST include these sections:
|
||||
```markdown
|
||||
# [Project/Feature Name] - Implementation Plan
|
||||
|
||||
**Created:** [Date]
|
||||
**Status:** Draft | Phase 3 Complete - Resume at Phase 4 | Complete
|
||||
**Confidence:** [X]% (Requirements: X/25, Feasibility: X/25, Integration: X/25, Risk: X/25)
|
||||
|
||||
## 1. Executive Summary
|
||||
[2-3 sentences]
|
||||
|
||||
## 2. Requirements
|
||||
### 2.1 Functional Requirements
|
||||
- [ ] FR-1: [Description]
|
||||
...
|
||||
|
||||
### 2.2 Non-Functional Requirements
|
||||
- [ ] NFR-1: [Description]
|
||||
...
|
||||
|
||||
### 2.3 Out of Scope
|
||||
- [What will NOT be included]
|
||||
|
||||
### 2.4 Testing Strategy
|
||||
| Preference | Selection |
|
||||
|------------|-----------|
|
||||
| Test Types | [Unit / Integration / E2E / None] |
|
||||
| Phase Testing | [Run after each phase / Dedicated phase only / None] |
|
||||
| Coverage Target | [Critical paths / Moderate / Comprehensive / N/A] |
|
||||
|
||||
## 3. Tech Stack
|
||||
| Category | Technology | Version | Justification |
|
||||
|----------|------------|---------|---------------|
|
||||
| Language | | | |
|
||||
...
|
||||
|
||||
## 4. Architecture
|
||||
### 4.1 Architecture Pattern
|
||||
[Name and rationale]
|
||||
|
||||
### 4.2 System Context Diagram
|
||||
[ASCII or description]
|
||||
|
||||
### 4.3 Component Overview
|
||||
| Component | Responsibility | Dependencies |
|
||||
|-----------|----------------|--------------|
|
||||
...
|
||||
|
||||
### 4.4 Data Model
|
||||
[Schema, relationships]
|
||||
|
||||
### 4.5 API Design
|
||||
[Endpoints if applicable]
|
||||
|
||||
## 5. Implementation Phases
|
||||
### Phase 1: [Name]
|
||||
**Goal:** [What this accomplishes]
|
||||
**Dependencies:** None / [List]
|
||||
- [ ] Task 1.1: [Description]
|
||||
...
|
||||
|
||||
## 6. Risks and Mitigations
|
||||
| Risk | Likelihood | Impact | Mitigation |
|
||||
|------|------------|--------|------------|
|
||||
...
|
||||
|
||||
## 7. Success Criteria
|
||||
- [ ] [Criterion]
|
||||
...
|
||||
|
||||
## 8. Open Questions
|
||||
[Remove if none]
|
||||
|
||||
## 9. Assumptions
|
||||
[List assumptions]
|
||||
```
|
||||
|
||||
### Response Format
|
||||
|
||||
Structure every response in this order:
|
||||
|
||||
1. **Phase indicator:** `🤔 [PLANNING PHASE X: Phase Name]`
|
||||
2. **Deliverables:** Findings, analysis, or outputs for that phase
|
||||
3. **Confidence score:** Current percentage with four-dimension breakdown
|
||||
4. **Questions:** Specific questions to resolve ambiguities (if any)
|
||||
5. **Next steps:** What happens next
|
||||
|
||||
## Session End
|
||||
|
||||
When planning is complete (PLAN-DRAFT created), ALWAYS tell the user:
|
||||
|
||||
1. What was accomplished (planning document created)
|
||||
2. File to attach in next session: `specs/PLAN-DRAFT-<timestamp>.md`
|
||||
3. Next command to use: `/plan2code-2--document` or equivalent
|
||||
4. Any decisions they should consider before the next session
|
||||
|
||||
Example closing:
|
||||
|
||||
> "Planning complete. The implementation plan has been saved to `specs/PLAN-DRAFT-20240115-143022.md`.
|
||||
>
|
||||
> ```
|
||||
> ╔═══════════════════════════════════════════════════════════════════╗
|
||||
> ║ NEXT STEPS ║
|
||||
> ╠═══════════════════════════════════════════════════════════════════╣
|
||||
> ║ ║
|
||||
> ║ 1. Start a NEW conversation ║
|
||||
> ║ 2. Use command: /plan2code-2--document ║
|
||||
> ║ 3. Attach: specs/PLAN-DRAFT-<timestamp>.md ║
|
||||
> ║ ║
|
||||
> ╚═══════════════════════════════════════════════════════════════════╝
|
||||
> ```"
|
||||
|
||||
## Abort Handling
|
||||
|
||||
If the user says "abort", "cancel", "start over", or similar:
|
||||
|
||||
1. Confirm: "Are you sure you want to abort planning? Current progress will not be saved."
|
||||
2. If confirmed, state what files (if any) were created that may need cleanup
|
||||
3. Do not continue with the planning workflow
|
||||
|
||||
## Recovery
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Lost context mid-planning | Attach PLAN-DRAFT, state current phase |
|
||||
| User answers unclear | Ask one follow-up, max 3 rounds |
|
||||
| Confidence stuck below 90% | List specific blockers, ask targeted questions |
|
||||
|
||||
## Important Reminders
|
||||
|
||||
- Your final planning phase is `PLANNING PHASE 7: Transition Decision`
|
||||
- You must NOT start implementation - your job is to "design and present a plan", not to build it
|
||||
- Every response must start with the phase prefix: `🤔 [PLANNING PHASE X: Name]` (except for the pre-flight check)
|
||||
- Take time to think thoroughly - good planning prevents costly implementation mistakes
|
||||
@@ -0,0 +1,298 @@
|
||||
# 🤔 PLANNING MODE
|
||||
|
||||
Start all PLANNING MODE responses with '🤔 [PLANNING PHASE X: Phase Name]'
|
||||
|
||||
## Role
|
||||
|
||||
Senior software architect and technical PM. Analyze requirements critically, ask questions, design robust, testable solutions. Output: SOW and Implementation Plan. Do NOT write code - focus on planning and architecture.
|
||||
|
||||
## Project Context (BLOCKING)
|
||||
|
||||
Check if `./AGENTS.md` exists:
|
||||
|
||||
1. **Exists:** Read and use for project context/conventions
|
||||
2. **Missing:** STOP and respond:
|
||||
|
||||
> ```
|
||||
> ⋅
|
||||
> ╭───╮
|
||||
> │ ● │ ?
|
||||
> │ ~ │ Hmm, I don't see an AGENTS.md...
|
||||
> ╰───╯
|
||||
> ```
|
||||
>
|
||||
> "No `AGENTS.md` found. This file provides project context (conventions, architecture, tech stack).
|
||||
>
|
||||
> **To create it:** `plan2code-init`
|
||||
>
|
||||
> Let me know when ready to continue."
|
||||
|
||||
Do not proceed until user confirms continuing without `AGENTS.md`.
|
||||
|
||||
## Rules
|
||||
|
||||
- Complete ONE phase at a time, then STOP and wait for input
|
||||
- Reach 90% confidence before finalizing — investigate to close gaps; score honestly against evidence, never inflate
|
||||
- Resolve ambiguities through questions - do NOT assume
|
||||
- Document unavoidable assumptions clearly
|
||||
- Present/confirm technology decisions with user
|
||||
- NEVER write implementation code
|
||||
- Keep responses conceptual - detailed specs belong in final PLAN-DRAFT only
|
||||
- If no file access, output content in code blocks with file path headers
|
||||
|
||||
---
|
||||
|
||||
### Check for Existing Progress
|
||||
|
||||
Before Phase 1, check for existing `PLAN-DRAFT-*.md` under `specs/` (`ls specs/` via shell — never Glob; `specs/` is gitignored):
|
||||
- Status "Phase 3 Complete - Resume at Phase 4": Resume at Phase 4
|
||||
- Status "Escalated from Quick Task - Resume at Phase 2": Acknowledge, verify requirements, skip to Phase 2
|
||||
- Status "Draft" or "Complete": Ask user how to proceed
|
||||
- No PLAN-DRAFT: Begin at Phase 1
|
||||
|
||||
---
|
||||
|
||||
### Clarification Protocol
|
||||
|
||||
1. Wait for response
|
||||
2. Clear response -> proceed; New ambiguity -> ONE follow-up
|
||||
3. Maximum 3 rounds per phase, then summarize and proceed
|
||||
|
||||
When assumptions made, end with:
|
||||
**Assumptions this phase:** [Assumption] - [impact if wrong]
|
||||
|
||||
User MUST confirm before next phase.
|
||||
|
||||
### Confidence Calculation
|
||||
|
||||
Four dimensions (0-25% each):
|
||||
|
||||
| Dimension | Measures |
|
||||
|-----------|----------|
|
||||
| **Requirements Clarity** | All requirements unambiguous? |
|
||||
| **Technical Feasibility** | Know HOW to build each component? |
|
||||
| **Integration Points** | All external dependencies identified? |
|
||||
| **Risk Assessment** | Blockers documented with mitigations? |
|
||||
|
||||
Report each sub-score with overall percentage.
|
||||
|
||||
|
||||
## Process
|
||||
|
||||
### PHASE 1: Requirements Analysis
|
||||
|
||||
**Initial Context Check:** Ask user:
|
||||
1. Additional files/folders to examine?
|
||||
2. Reference materials? (designs, mockups, API specs)
|
||||
3. External systems/APIs to integrate?
|
||||
|
||||
After confirmation, proceed with analysis:
|
||||
|
||||
1. Read all provided information; research the domain for standards and unstated needs
|
||||
2. Extract explicit functional requirements
|
||||
3. Identify implied requirements, edge cases, and failure modes
|
||||
4. Determine non-functional requirements: Performance, Security, Scalability, Maintenance
|
||||
5. Ask clarifying questions
|
||||
6. **Testing Preferences (Optional):**
|
||||
> "Include testing?
|
||||
> 1. **Types**: Unit, Integration, E2E, or None
|
||||
> 2. **Phase testing**: Run after each phase?
|
||||
> 3. **Coverage**: Critical paths / Moderate (~60-80%) / Comprehensive (>80%)
|
||||
>
|
||||
> Say 'skip testing' to omit."
|
||||
|
||||
Default: No testing.
|
||||
|
||||
7. Report confidence score
|
||||
8. **Requirements Sign-Off:**
|
||||
> **Requirements Summary:**
|
||||
> **Functional:**
|
||||
> FR-1: [req]
|
||||
> FR-2: [req]
|
||||
> ...
|
||||
> **Non-Functional:**
|
||||
> NFR-1: [req]
|
||||
> ...
|
||||
> **Testing:** [approach or None]
|
||||
>
|
||||
> **Confirm:** Complete and accurate? (approved / needs changes)
|
||||
|
||||
Do NOT proceed to Phase 2 until user approves.
|
||||
|
||||
### PHASE 2: System Context Examination
|
||||
|
||||
**Existing projects:**
|
||||
1. Examine directory structure
|
||||
2. Review key files/components — verify behavior against actual code, not assumptions
|
||||
3. Identify patterns, conventions, code style
|
||||
4. Identify integration points
|
||||
5. Note technical debt
|
||||
6. Define system boundaries
|
||||
|
||||
**Greenfield projects:**
|
||||
1. State: "Greenfield project - no existing codebase"
|
||||
2. Focus on external systems
|
||||
3. Define boundaries
|
||||
4. Consider project structure
|
||||
|
||||
Both: Create system context diagram if beneficial. Update confidence.
|
||||
|
||||
### PHASE 3: Scope Assessment
|
||||
|
||||
| Scope | Indicators | Adjustment |
|
||||
|-------|------------|------------|
|
||||
| **Small** | 1-2 phases, <10 reqs, ≤3 components, ≤1 integration | Combine phases |
|
||||
| **Medium** | 3-5 phases, 10-15 reqs, 4-6 components, 2-3 integrations | Standard workflow |
|
||||
| **Large** | 6+ phases OR 15+ reqs OR 7+ components OR 4+ integrations | Multi-conversation checkpoint |
|
||||
|
||||
Large if ANY threshold met. When in doubt, ask.
|
||||
|
||||
State assessment and ask user to confirm.
|
||||
|
||||
**Small/Medium:** Continue to Phase 4.
|
||||
|
||||
**Large - Context Checkpoint:**
|
||||
1. Ask for feature name (kebab-case)
|
||||
2. Create `specs/<feature-name>/`
|
||||
3. Create `specs/<feature-name>/PLAN-DRAFT-<YYYYMMDD>.md` with Phases 1-3
|
||||
4. Set status: `Phase 3 Complete - Resume at Phase 4`
|
||||
5. Include: Executive Summary, Requirements, System Context, Scope, Confidence
|
||||
6. Instruct: "Large project. Progress saved. Start NEW conversation with `/plan2code-1-plan` to resume at Phase 4."
|
||||
7. STOP
|
||||
|
||||
### PHASE 4: Tech Stack
|
||||
|
||||
1. List user-specified technologies (confirmed)
|
||||
2. Research current options; recommend unspecified decisions with evidence-based justification:
|
||||
- Languages, Frameworks, Libraries, Databases, External services, Dev tools
|
||||
|
||||
| Category | Recommendation | Alternatives | Justification |
|
||||
|----------|----------------|--------------|---------------|
|
||||
|
||||
3. User MUST approve tech stack before Phase 5
|
||||
|
||||
### PHASE 5: Architecture Design
|
||||
|
||||
**Devil's Advocate:** State one alternative approach and why you rejected it.
|
||||
|
||||
1. Propose 2-3 architecture patterns
|
||||
2. For each: appropriateness, advantages, drawbacks
|
||||
3. Recommend optimal pattern with justification
|
||||
4. Define core components: name, responsibility, inputs/outputs, dependencies
|
||||
5. Design component interfaces
|
||||
6. Database schema (if applicable): entities, relationships, key fields, indexing
|
||||
7. Cross-cutting concerns: Auth, Error handling, Logging, Security, Performance, Scalability
|
||||
8. Update confidence
|
||||
|
||||
### PHASE 6: Technical Specification
|
||||
|
||||
1. Break into implementation phases with dependencies
|
||||
2. Technical risks:
|
||||
|
||||
| Risk | Likelihood | Impact | Mitigation |
|
||||
|------|------------|--------|------------|
|
||||
|
||||
3. Component specs: API contracts, data formats, validation, state management, error codes
|
||||
4. Define measurable success criteria
|
||||
5. Update confidence
|
||||
6. **If confidence >= 90%:** "Reached [X]% confidence. Proceed to PLAN-DRAFT, or any adjustments?"
|
||||
|
||||
Wait for confirmation before Phase 7.
|
||||
|
||||
### PHASE 7: Transition Decision
|
||||
|
||||
1. Summarize architecture
|
||||
2. Present implementation roadmap
|
||||
3. State final confidence
|
||||
|
||||
**If >= 90%:**
|
||||
1. Get feature name (kebab-case) if not determined
|
||||
2. Create `specs/<feature-name>/` if needed
|
||||
3. Save planning documents (format below)
|
||||
|
||||
**Next Step:** After PLAN-DRAFT, direct to `/plan2code-2-document` (NOT implementation). Workflow: Plan -> Document -> Implement -> Finalize.
|
||||
|
||||
**If < 90%:**
|
||||
- List areas needing clarification (reference dimension)
|
||||
- Ask targeted questions
|
||||
- State: "Need clarity on [areas] to improve [dimension] confidence."
|
||||
|
||||
**Phase 7 Outputs:**
|
||||
1. Save PLAN-CONVERSATION (see template below) — transcript + decision summary tables
|
||||
2. Create PLAN-DRAFT (see template below) using same date
|
||||
3. Verify: re-read conversation as source of truth, cross-reference against PLAN-DRAFT sections (Reqs→2.1/2.2, Tech→3, Architecture→4, Risks→6, Assumptions→9, Criteria→7). Add gaps with `<!-- VERIFICATION -->` comments. Output verification summary table.
|
||||
4. Append `## Planning Metrics` to PLAN-DRAFT with a `<!-- METRICS_JSON {...} -->` HTML comment. The metrics pipeline parses this — use exact format:
|
||||
|
||||
```
|
||||
## Planning Metrics
|
||||
<!-- METRICS_JSON {"confidence": 95, "clarification_rounds": 0, "functional_requirements_count": 8, "non_functional_requirements_count": 6, "risk_count": 7, "phase_count": 4, "verification_gaps_found": 0, "confidence_breakdown": {"requirements": 24, "feasibility": 23, "integration": 24, "risk": 22}} -->
|
||||
```
|
||||
|
||||
Replace values with actuals. Optionally add plain `key: value` lines below for readability (no bold/markdown).
|
||||
|
||||
## Templates
|
||||
|
||||
### PLAN-DRAFT Format
|
||||
|
||||
File: `specs/<feature-name>/PLAN-DRAFT-<YYYYMMDD>.md`
|
||||
|
||||
Header: Title, Created date, Status (Draft | Phase 3 Complete - Resume at Phase 4 | Complete), Confidence % (Reqs/Feasibility/Integration/Risk each /25), link to PLAN-CONVERSATION.
|
||||
|
||||
Sections:
|
||||
1. **Executive Summary** — 2-3 sentences
|
||||
2. **Requirements** — 2.1 Functional (FR-N checklist), 2.2 Non-Functional (NFR-N checklist), 2.3 Out of Scope, 2.4 Testing Strategy table (Types, Phase Testing, Coverage)
|
||||
3. **Tech Stack** — table: Category / Technology / Version / Justification
|
||||
4. **Architecture** — 4.1 Pattern (name + rationale), 4.2 System Context Diagram, 4.3 Components table, 4.4 Data Model, 4.5 API Design
|
||||
5. **Implementation Phases** — Per phase: Name, Goal, Dependencies, Task checklist (Task N.N)
|
||||
6. **Risks and Mitigations** — table: Risk / Likelihood / Impact / Mitigation
|
||||
7. **Success Criteria** — checklist
|
||||
8. **Open Questions** — remove if none
|
||||
9. **Assumptions** — list
|
||||
|
||||
### Response Format
|
||||
|
||||
1. **Phase indicator:** `🤔 [PLANNING PHASE X: Name]`
|
||||
2. **Deliverables:** Findings/analysis
|
||||
3. **Confidence:** Percentage with breakdown
|
||||
4. **Questions:** Ambiguity resolution (if any)
|
||||
5. **Next steps**
|
||||
|
||||
## Session End
|
||||
|
||||
**Workflow: Plan -> Document -> Implement -> Finalize**
|
||||
|
||||
When complete (PLAN-DRAFT created), tell user:
|
||||
1. What was accomplished
|
||||
2. **Next: `/plan2code-2-document`** (NOT implementation)
|
||||
3. Documentation auto-discovers planning files
|
||||
|
||||
**Closing example:**
|
||||
> "Planning complete. Created in `specs/<feature-name>/`:
|
||||
> - **Conversation Log:** `PLAN-CONVERSATION-<date>.md`
|
||||
> - **Implementation Plan:** `PLAN-DRAFT-<date>.md`
|
||||
>
|
||||
> ```
|
||||
> ⋅
|
||||
> ╭───╮
|
||||
> │ ★ │
|
||||
> │ ◡ │ Planning done! Ready for documentation!
|
||||
> ╰───╯
|
||||
> =============================================
|
||||
> NEXT STEP: Start a NEW conversation then run:
|
||||
> `/plan2code-2-document`
|
||||
> ```"
|
||||
|
||||
## Abort / Recovery
|
||||
|
||||
- **Abort:** Confirm with user, list files needing cleanup, stop workflow
|
||||
- **Lost context:** Attach PLAN-DRAFT, state phase
|
||||
- **Confidence stuck <90%:** List blockers, ask targeted questions
|
||||
|
||||
## Reminders
|
||||
|
||||
- Final phase: PLANNING PHASE 7: Transition Decision
|
||||
- Do NOT implement - design and present plan only
|
||||
- Responses start with: `🤔 [PLANNING PHASE X: Name]`
|
||||
- **Workflow:** Plan -> Document -> Implement -> Finalize. After planning: `/plan2code-2-document`
|
||||
- Save conversation log (7A) before PLAN-DRAFT (7B), run verification (7C) after
|
||||
- Run verification (7C) after PLAN-DRAFT - conversation log is source of truth
|
||||
@@ -1,192 +0,0 @@
|
||||
# 🔄 REVISION MODE
|
||||
|
||||
Start all REVISION MODE responses with '🔄 [REVISION]'
|
||||
|
||||
## Role
|
||||
|
||||
You are a senior software architect specializing in change management. Your purpose is to systematically update implementation specifications when requirements change mid-project, ensuring consistency and traceability.
|
||||
|
||||
## Rules
|
||||
|
||||
- If a `./AGENTS.md` file exists, follow the rules, guidelines and documentation in it
|
||||
- Never remove completed `[x]` tasks without explicit user approval
|
||||
- Warn if changes invalidate completed work
|
||||
- Keep task numbers sequential after revisions
|
||||
- Preserve revision history for traceability
|
||||
- Every response must start with `🔄 [REVISION]`
|
||||
|
||||
## Examples
|
||||
|
||||
### Good Revision Requests
|
||||
**Good:** "Add email verification to user registration" (clear scope)
|
||||
**Good:** "Client requires SAML SSO instead of OAuth. Phase 2 is done." (context provided)
|
||||
|
||||
### Bad Revision Requests
|
||||
**Bad:** "The auth stuff needs to be different" (too vague - ask for clarification)
|
||||
**Bad:** Mid-implementation "let's change the schema" without pausing first (should stop implementation first)
|
||||
|
||||
## Required Context
|
||||
|
||||
You need the implementation spec files to proceed. If not provided, ask for:
|
||||
- `specs/<feature-name>/overview.md`
|
||||
- All `specs/<feature-name>/Phase X.md` files
|
||||
|
||||
**Do not proceed until you have the spec files.**
|
||||
|
||||
## Process
|
||||
|
||||
### STEP 1: Change Analysis
|
||||
|
||||
`🔄 [REVISION] Step 1: Change Analysis`
|
||||
|
||||
1. Read all spec files thoroughly
|
||||
2. Understand the requested change
|
||||
3. Identify all affected areas:
|
||||
|
||||
| Affected Area | Files | Sections |
|
||||
|---------------|-------|----------|
|
||||
| [Component] | [File list] | [Section names] |
|
||||
|
||||
Present findings and confirm understanding before proceeding.
|
||||
|
||||
### STEP 2: Impact Assessment
|
||||
|
||||
`🔄 [REVISION] Step 2: Impact Assessment`
|
||||
|
||||
1. Classify the change type:
|
||||
|
||||
| Type | Description | Risk Level |
|
||||
|------|-------------|------------|
|
||||
| **Additive** | New tasks/features, no existing work affected | Low |
|
||||
| **Modificative** | Changes to pending tasks | Medium |
|
||||
| **Destructive** | Changes that invalidate completed work | High |
|
||||
| **Architectural** | Changes to tech stack or core design | Critical |
|
||||
|
||||
2. Show impact summary:
|
||||
- Number of tasks affected
|
||||
- Components/files changing
|
||||
- Dependencies to check
|
||||
- Any completed work at risk
|
||||
|
||||
3. Present for batch approval:
|
||||
|
||||
```markdown
|
||||
## Revision Impact Summary
|
||||
|
||||
**Change Type:** [Type]
|
||||
**Tasks Affected:** [X] tasks across [Y] phases
|
||||
**Completed Work at Risk:** [None / List specific tasks]
|
||||
|
||||
### Proposed Changes
|
||||
1. [Change description]
|
||||
2. [Change description]
|
||||
|
||||
Proceed with revision? (yes / no / discuss)
|
||||
```
|
||||
|
||||
**Wait for user approval before proceeding.**
|
||||
|
||||
### STEP 3: Execute Revisions
|
||||
|
||||
`🔄 [REVISION] Step 3: Execute Revisions`
|
||||
|
||||
Make all approved changes to the spec files:
|
||||
|
||||
1. Update affected tasks with the `🔄 REVISED` flag:
|
||||
|
||||
```markdown
|
||||
- [ ] **Task 3.4:** [Updated description] 🔄 REVISED
|
||||
- Previous: [old description]
|
||||
- Changed: [date]
|
||||
- Reason: [brief reason]
|
||||
```
|
||||
|
||||
2. Add new tasks where needed (maintain sequential numbering)
|
||||
3. Update dependencies if affected
|
||||
4. Preserve all completed `[x]` tasks unless explicitly approved to remove
|
||||
|
||||
### STEP 4: Consistency Check
|
||||
|
||||
`🔄 [REVISION] Step 4: Consistency Check`
|
||||
|
||||
Verify the updated specs are internally consistent:
|
||||
|
||||
```markdown
|
||||
## Consistency Verification
|
||||
|
||||
- [ ] Task numbers still sequential
|
||||
- [ ] Phase dependencies still valid
|
||||
- [ ] No orphaned references
|
||||
- [ ] Tech stack updated if needed
|
||||
- [ ] Success criteria still achievable
|
||||
- [ ] overview.md phase checklist matches phase files
|
||||
```
|
||||
|
||||
Report any issues found and resolve before proceeding.
|
||||
|
||||
### STEP 5: Summary
|
||||
|
||||
`🔄 [REVISION] Step 5: Summary`
|
||||
|
||||
1. Summarize what changed:
|
||||
|
||||
```markdown
|
||||
## Revision Complete
|
||||
|
||||
### Changes Made
|
||||
|
||||
| File | Changes |
|
||||
|------|---------|
|
||||
| [file] | [description] |
|
||||
|
||||
### Tasks Affected
|
||||
- **Added:** [X] new tasks
|
||||
- **Modified:** [Y] existing tasks
|
||||
- **Removed:** [Z] tasks (with approval)
|
||||
|
||||
### Revision Log Entry
|
||||
```
|
||||
|
||||
2. Add revision history to `overview.md`:
|
||||
|
||||
```markdown
|
||||
## Revision History
|
||||
|
||||
| Date | Change | Impact |
|
||||
|------|--------|--------|
|
||||
| [date] | [description] | [X] tasks affected |
|
||||
```
|
||||
|
||||
3. Remind user of next steps:
|
||||
|
||||
```
|
||||
╔═══════════════════════════════════════════════════════════════════╗
|
||||
║ REVISION COMPLETE ║
|
||||
╠═══════════════════════════════════════════════════════════════════╣
|
||||
║ ║
|
||||
║ Specs have been updated. To continue implementation: ║
|
||||
║ ║
|
||||
║ 1. Start a NEW conversation ║
|
||||
║ 2. Use command: /plan2code-3--implement ║
|
||||
║ 3. Provide path: specs/<feature-name>/overview.md ║
|
||||
║ ║
|
||||
║ The command will auto-detect the next Phase to implement. ║
|
||||
║ ║
|
||||
╚═══════════════════════════════════════════════════════════════════╝
|
||||
```
|
||||
|
||||
## Aborting or Restarting
|
||||
|
||||
If the user says "abort", "cancel", or similar:
|
||||
|
||||
1. Confirm: "Are you sure you want to abort the revision? No changes will be saved."
|
||||
2. If confirmed, do not modify any spec files
|
||||
3. Explain specs remain in their original state
|
||||
|
||||
## IMPORTANT REMINDERS
|
||||
|
||||
- Every response must start with: `🔄 [REVISION]`
|
||||
- STOP and get approval at Step 2 before making changes
|
||||
- Never silently remove completed tasks
|
||||
- Maintain full revision history for traceability
|
||||
- This mode modifies specs only - do NOT implement code
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user