mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-17 04:45:33 -08:00
Port upstream skill scripts into v2.4.1: deterministic workflow steps run as Node scripts beside each SKILL.md (specs, pathfinder, feedback payload, commit message, review scope, agent files, handoff path) with tests, the prompt limit rises to 20,000 chars, upstream review fixes are folded in (linked agent files never overwrite AGENTS.md, review stops with no base, paste-safe commit commands, Pathfinder number high-water mark and dry runs), and web console workspace folders are remembered per project and spec, with Finalize forgetting an archived spec's list
AI Assisted
This commit is contained in:
1 parent
c0ea70e838
commit
6a66440095
243 files changed
+23698
-1607
No files matched your search
@@ -2,52 +2,39 @@
|
||||
|
||||
> Loaded by `src/plan2code-4-finalize.md` STEP 6.5. This file has no character limit (see `AGENTS-architecture.md` Reference Files).
|
||||
|
||||
## 1. Generate a fresh `run_id`
|
||||
Everything in the payload is read from files, so a script builds it: the metrics from the `METRICS_JSON` comments the pipeline already wrote, the task counts from the phase files, your Step 5 answers from overview.md's `## User Feedback` table, the installed version, and a sha256 prefix of each prompt. Your part is the two judgment counts, the preview, and the user's approval.
|
||||
|
||||
Compute your own current timestamp and a freshly generated random 4-character hex string — do not reuse the example value shown below or anywhere in this spec. Format: `run-<YYYYMMDD>-<HHMMSS>-<4-hex-chars>` (e.g. `run-20260715-143000-a1b2`).
|
||||
## 1. Build the payload
|
||||
|
||||
## 2. Assemble the payload
|
||||
Step 6 has already archived the spec, so point at the archive:
|
||||
|
||||
Read `PLAN-DRAFT-*.md`, `phase-*.md`, and `overview.md` in `specs--completed/<feature-name>/` (STEP 6 has already archived them there) and reason over their content to gather:
|
||||
|
||||
- `step1`: `final_confidence`, `confidence_breakdown` (`{requirements, feasibility, integration, risk}`), `clarification_rounds`, `tech_stack_revision_rounds`, `verification_gaps_found`, `functional_requirements_count`, `non_functional_requirements_count`, `risk_count`, `phase_count`
|
||||
- `step2`: `total_tasks`, `phase_count`, `parallel_groups_identified`, `requirement_coverage_percent`, `verification_items_added`
|
||||
- `step3`: `task_completion_rate`, `tasks_completed`, `tasks_total`, `blocker_count`
|
||||
- `step4`: `completion_rate_at_audit`, `verification_failures_found`, `documentation_updates_needed`, `archival_succeeded` (safe to read now that Step 6 has run)
|
||||
- `plan2code_version` — from `version.json`
|
||||
- `prompt_versions_short` — first 12 characters of each of the 8 prompt file names' content (`plan`, `revise_plan`, `document`, `implement`, `finalize`, `init`, `init_update`, `quick_task`). You do not have `sha256File()` available — note these as best-effort/approximate if you cannot compute a real hash, or omit the field entirely if you cannot.
|
||||
|
||||
**Never include** `project.name` or any bulky arrays (e.g. `tasks_per_phase`).
|
||||
|
||||
Include the feedback collected at Step 5 as `user_feedback`: `overall_rating`, `rating_reason`, `what_went_well`, `what_went_poorly`.
|
||||
|
||||
Assemble the full nested JSON object matching this schema exactly:
|
||||
|
||||
```json
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"run_id": "run-<YYYYMMDD>-<HHMMSS>-<4-hex>",
|
||||
"plan2code_version": "<from version.json>",
|
||||
"prompt_versions_short": { "plan": "...", "revise_plan": "...", "document": "...", "implement": "...", "finalize": "...", "init": "...", "init_update": "...", "quick_task": "..." },
|
||||
"step1": { "final_confidence": 0, "confidence_breakdown": { "requirements": 0, "feasibility": 0, "integration": 0, "risk": 0 }, "clarification_rounds": 0, "tech_stack_revision_rounds": 0, "verification_gaps_found": 0, "functional_requirements_count": 0, "non_functional_requirements_count": 0, "risk_count": 0, "phase_count": 0 },
|
||||
"step2": { "total_tasks": 0, "phase_count": 0, "parallel_groups_identified": 0, "requirement_coverage_percent": 0, "verification_items_added": 0 },
|
||||
"step3": { "task_completion_rate": 0, "tasks_completed": 0, "tasks_total": 0, "blocker_count": 0 },
|
||||
"step4": { "completion_rate_at_audit": 0, "verification_failures_found": 0, "documentation_updates_needed": 0, "archival_succeeded": true },
|
||||
"user_feedback": { "overall_rating": 0, "rating_reason": "...", "what_went_well": "...", "what_went_poorly": "..." }
|
||||
}
|
||||
```
|
||||
node "<S>/feedback-payload.mjs" build specs--completed/<feature-name> --set verification_failures_found=<N> --set documentation_updates_needed=<N>
|
||||
```
|
||||
|
||||
## 3. Render the GitHub Issue
|
||||
If Step 6 did not archive (the archive target already existed), the spec is still in `specs/`: pass `specs/<feature-name>` instead. A bare `<feature-name>` that exists in both folders stops with exit 5 `ambiguous-spec` rather than guessing, because `specs--completed/<feature-name>` would be the older run.
|
||||
|
||||
- **Title:** `` `[Feedback] v<plan2code_version> — rating <N>/10` `` (e.g. `[Feedback] v1.15.3 — rating 8/10`)
|
||||
- **Body:** a short human-readable markdown summary (version, rating, headline numbers such as completion rate and confidence), followed by the full payload as `<!-- METRICS_JSON {...} -->` (same HTML-comment convention used in Step 7's own summary block)
|
||||
- **Label:** `community-feedback`
|
||||
The two counts are the ones Step 7's METRICS_JSON carries (your Step 2 and Step 4 findings). It prints:
|
||||
|
||||
Estimate the combined URL-encoded size of `title` + `body` + `labels`. If it exceeds roughly 8KB, warn the user and offer to truncate the longest free-text `user_feedback` field(s) — starting with `rating_reason`, then `what_went_well`/`what_went_poorly` — before proceeding. This size limit only affects the browser/print fallback tiers (below), not the `gh` CLI tier.
|
||||
| Field | Use |
|
||||
|---|---|
|
||||
| `title`, `body`, `label` | The exact issue to preview. The body ends with the full payload as `<!-- METRICS_JSON {...} -->` |
|
||||
| `payload` | The schema-1.0 object: a fresh `run_id`, `plan2code_version`, `prompt_versions_short` (12-character sha256 prefixes), `step1`-`step4`, `user_feedback`. It never includes `project.name` or bulky arrays |
|
||||
| `notes` | Missing METRICS_JSON blocks (that step is `null`, which the ingest side reads as not present). Mention them in one line |
|
||||
| `oversize`, `urlBytes`, `next` | The prefilled browser URL is over ~8 KB. Offer to shorten the free-text answers; on yes, rebuild with `--truncate` (trims `rating_reason` first, then `what_went_well` / `what_went_poorly`). Tier 1 (`gh`) has no limit, so declining is fine only when `gh` is installed and signed in (`gh auth status`): if `gh` fails, `submit` stops with exit 4 `oversize` instead of falling back to the browser |
|
||||
| `dir` | Where `payload.json` and `body.md` were written; `submit` needs it |
|
||||
|
||||
## 4. Preview and approval gate
|
||||
| Exit | Meaning | Do |
|
||||
|---|---|---|
|
||||
| 2 `missing-set` | A judgment count is missing | Pass both `--set` values |
|
||||
| 3 `no-feedback` | overview.md has no `## User Feedback` table | Nothing to submit: skip to Step 7 |
|
||||
| 3 `spec-not-found` | Wrong name or not archived | Check `specs--completed/` |
|
||||
| 4 `bad-rating` | The Rating row is not 1-10 | Fix the row, rebuild |
|
||||
| 5 `ambiguous-spec` | A bare name exists in both `specs/` and `specs--completed/` | Pass the exact path: `specs/<feature-name>` if Step 6 did not archive this run |
|
||||
|
||||
Display the exact rendered title, full body (including the `METRICS_JSON` block), and label(s) to the user, mirroring the Step 4 Documentation Review pattern:
|
||||
## 2. Preview and approval gate
|
||||
|
||||
Display the exact `title`, the full `body` (including the `METRICS_JSON` block), and the label to the user, mirroring the Step 4 Documentation Review pattern:
|
||||
|
||||
```
|
||||
⋅
|
||||
@@ -61,12 +48,25 @@ Display the exact rendered title, full body (including the `METRICS_JSON` block)
|
||||
|
||||
Do NOT proceed to submission without an explicit "approve" reply. A "skip" or any non-approval reply cancels this sub-step entirely and proceeds to Step 7 with no submission.
|
||||
|
||||
## 5. Tiered submission
|
||||
## 3. Submit
|
||||
|
||||
On approval, attempt each tier in order until one succeeds:
|
||||
On approval only:
|
||||
|
||||
1. **Tier 1 (primary):** Attempt `gh issue create --repo jparkerweb/plan2code --title "<title>" --body "<body>" --label community-feedback` via your shell tool. If it succeeds, report the created issue URL to the user and stop.
|
||||
2. **Tier 2 (secondary):** If `gh` is not installed or not authenticated (command fails), construct the URL `https://github.com/jparkerweb/plan2code/issues/new?title=<url-encoded title>&body=<url-encoded body>&labels=community-feedback` and attempt to open it in the user's default browser using the OS-appropriate command (`start "<url>"` on Windows, `open "<url>"` on macOS, `xdg-open "<url>"` on Linux). Tell the user they still need to click "Submit issue" themselves since they must be logged in.
|
||||
3. **Tier 3 (tertiary):** If no browser can be opened (e.g. no shell tool access, headless/remote session), print the same URL from Tier 2 to the terminal/chat: "Please open this URL in your browser and click 'Submit issue' to share your feedback: `<url>`".
|
||||
```
|
||||
node "<S>/feedback-payload.mjs" submit --from <dir>
|
||||
```
|
||||
|
||||
After any tier succeeds (or the user manually confirms Tier 3 submission), proceed to Step 7 as normal.
|
||||
It tries each tier in order and reports the one that worked:
|
||||
|
||||
| `tier` | What happened | Tell the user |
|
||||
|---|---|---|
|
||||
| 1 | `gh issue create` succeeded | The issue URL (`issue`) |
|
||||
| 2 | `gh` missing or not signed in (`ghError`); the system was asked to open the prefilled new-issue page | If it opened, they still need to click **Submit new issue**, signed in to GitHub. If nothing opened (a remote or headless session), give them `url` as in tier 3 |
|
||||
| 3 | No browser could be opened (headless or remote session) | "Please open this URL in your browser and click 'Submit new issue' to share your feedback:" plus `url` |
|
||||
|
||||
| Exit | Meaning | Do |
|
||||
|---|---|---|
|
||||
| 3 `no-payload` | `--from` has no `payload.json` / `body.md` | Pass the `dir` that `build` printed |
|
||||
| 4 `oversize` | `gh` failed (`message` says why) and the URL is over ~8 KB, too long for tiers 2 and 3, so neither ran | Offer to shorten the free-text answers: on yes, rebuild with `--truncate` and submit again. Or have the user install `gh` and run `gh auth login`, then submit again |
|
||||
|
||||
`--dry-run` shows the tiers without running them, plus `urlBytes` and `oversize` (when `oversize` is true, only tier 1 can submit). After any tier succeeds (or the user confirms a tier 3 submission), proceed to Step 7 as normal.
|
||||
@@ -556,8 +556,15 @@ enforces it, so never tell someone to keep asking past it.
|
||||
The person can add folders beside the one the session started in (a shared
|
||||
library, a design folder), from the footer's folder label. Together they are
|
||||
the session's **workspace**: context for every skill run in this console
|
||||
session, each folder addressed by a short `@name`. It outlives dashboard hops;
|
||||
a new console session starts with the original folder alone.
|
||||
session, each folder addressed by a short `@name`. It outlives dashboard hops,
|
||||
and it is remembered: every change is saved to `workspaces.json` beside
|
||||
`looks.json` (never into the project), keyed by the folder the session runs
|
||||
in and then by spec. A session with a spec opens on that spec's list, one with
|
||||
none on the project's; a spec with nothing saved starts as a copy of the
|
||||
project's list. The dashboard's picker swaps the list as the selection moves,
|
||||
and a `specDir` you post mid-run takes the current list with it. There is
|
||||
nothing for you to load: `open` prints the list, and a switch of spec on a
|
||||
resume reaches you as ordinary workspace changes on your next `wait`.
|
||||
|
||||
### What you are told
|
||||
|
||||
@@ -767,7 +774,7 @@ that is what the person is there to download. The finish carries no
|
||||
sees the Trail Footer, and without this their last screen promises a question
|
||||
that is never coming.
|
||||
- Post `run` `pathfinder-chart` (id `map`) when a new map is first written,
|
||||
and `pathfinder-research` (id = the question's file slug) as each research
|
||||
and `pathfinder-research` (id = the question's file slug; on `github`, `q<issue-number>`) as each research
|
||||
subagent reports back, or when you resolve a `research` question yourself
|
||||
(Posting an update → Session meter). Other questions score through their
|
||||
answers, so there is nothing to post for them.
|
||||
@@ -820,7 +827,7 @@ know:
|
||||
| 3, Implementation Summary | Written to `overview.md` as usual; mirror it as a doc (marked `saved`) so the page reader sees it land. |
|
||||
| 4, Documentation Review | The proposed-updates table as a doc, and a `multi` naming the documents to update — every option ticked is "approve", unticked ones are skipped. A `review` works instead when the set is all-or-nothing. |
|
||||
| 5, User Feedback | Optional items, `required: false`: the rating as a `choice` of 1 to 10 or a `text`, the three reasons as `text`. The submit-to-maintainer consent is a `confirm`. |
|
||||
| 6, Spec Cleanup | A `confirm` before moving anything, the archive paths in `consequences`. |
|
||||
| 6, Spec Cleanup | A `confirm` before moving anything, the archive paths in `consequences`, and a line that the spec's remembered workspace folders are forgotten too (`console.mjs forget --spec specs/<feature>` after the move). |
|
||||
|
||||
Pass `--spec specs/<feature>` to `open`, or post `specDir` once you know it.
|
||||
Stopping mid-finalize loses nothing
|
||||
|
||||
@@ -41,6 +41,7 @@ import {
|
||||
die,
|
||||
ensureDir,
|
||||
fileStamp,
|
||||
forgetWorkspace,
|
||||
handOff,
|
||||
handleFile,
|
||||
healthOk,
|
||||
@@ -65,6 +66,7 @@ import {
|
||||
readLedger,
|
||||
readWorkspace,
|
||||
reapHandles,
|
||||
rememberedWorkspace,
|
||||
remoteWarning,
|
||||
removeScratch,
|
||||
removeSessions,
|
||||
@@ -73,6 +75,7 @@ import {
|
||||
SESSION_MAX_AGE_MS,
|
||||
sessionDir,
|
||||
sleepSync,
|
||||
specKey,
|
||||
staleScratch,
|
||||
staleSessions,
|
||||
sweepUploads,
|
||||
@@ -317,7 +320,7 @@ async function cmdOpen() {
|
||||
if (launched) appendLedger(dir, { kind: "launch", id: nextLaunchId(readLedger(dir)), workflow: state.workflow });
|
||||
for (const line of ledgerFromPost(dir, openRun, openIssue, state.workflow)) appendLedger(dir, line);
|
||||
} catch {}
|
||||
const workspace = workspaceOnOpen(dir, worktree);
|
||||
const workspace = workspaceOnOpen(dir, worktree, state.specDir);
|
||||
|
||||
// Month-old sessions and scratch files: listed before the print so the
|
||||
// agent can see what went, removed after it so the page waits for nothing.
|
||||
@@ -403,10 +406,11 @@ async function cmdOpen() {
|
||||
* The workspace as `open` hands it to the agent, and the cursor seeded to
|
||||
* match: the agent now has the whole list, so no change up to here is owed.
|
||||
* Read-only on workspace.json, which only the server writes; on a fresh
|
||||
* session the server has not made it yet, so the original folder stands in.
|
||||
* session the server has not made it yet, so what was remembered for this
|
||||
* folder and spec stands in, the same list the server is about to make.
|
||||
*/
|
||||
function workspaceOnOpen(dir, worktree) {
|
||||
const ws = readWorkspace(dir) || initialWorkspace(worktree);
|
||||
function workspaceOnOpen(dir, worktree, specDir) {
|
||||
const ws = readWorkspace(dir) || initialWorkspace(worktree, rememberedWorkspace(worktree, specDir).entry);
|
||||
const missing = ws.folders.filter((f) => !isFolder(f.path)).map((f) => f.id);
|
||||
try {
|
||||
writeWorkspaceCursor(dir, ws.version || 0);
|
||||
@@ -946,6 +950,18 @@ function realNearest(p) {
|
||||
return path.join(fs.realpathSync(existing), path.relative(existing, p));
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------- forget */
|
||||
|
||||
// Drop the folder list remembered for one spec (Finalize, once the spec is
|
||||
// archived). The project's own list and every other spec's are untouched.
|
||||
function cmdForget() {
|
||||
if (typeof args.spec !== "string" || !args.spec.trim()) die("forget needs --spec specs/<idea>", 2);
|
||||
let spec = specKey(args.spec);
|
||||
if (/\.md$/i.test(spec)) spec = spec.slice(0, spec.lastIndexOf("/"));
|
||||
const worktree = repoRoots().worktree;
|
||||
print({ ok: true, spec, forgot: forgetWorkspace(worktree, spec) });
|
||||
}
|
||||
|
||||
/* ----------------------------------------------------------------- help */
|
||||
|
||||
function cmdHelp() {
|
||||
@@ -961,7 +977,8 @@ port, and the filesystem as transport; this CLI is the whole agent surface.
|
||||
first post. --file is optional, and --title defaults to the
|
||||
project's folder name. Also prints workspace: { folders: [{ name,
|
||||
path, description?, original? }], missing? }, the folders this
|
||||
console session reads as context, addressed as @name.
|
||||
console session reads as context, addressed as @name. The list is
|
||||
remembered per folder and spec in workspaces.json beside looks.json.
|
||||
post --session <sid> --file <patch.json>
|
||||
Merge a patch into the session. Prints terminalLine while the
|
||||
server is live. Exit 3 = rejected; stderr says why. A patch may
|
||||
@@ -988,6 +1005,10 @@ port, and the filesystem as transport; this CLI is the whole agent surface.
|
||||
Copy a cited note attachment into specs/<idea>/attachments/. Prints
|
||||
{ ok, path, link, image, reused }; exit 2 = bad usage, 3 = refused or
|
||||
missing. Paste link as it is.
|
||||
forget --spec specs/<idea>
|
||||
Drop the workspace folders remembered for that spec, in this
|
||||
folder (Finalize, after archiving it). Prints { ok, spec, forgot };
|
||||
forgot is false when nothing was saved. Exit 2 = bad usage.
|
||||
status [--session <sid>] [--all]
|
||||
One session, or every session belonging to this project.
|
||||
stop --session <sid> | --all
|
||||
@@ -1206,6 +1227,7 @@ const COMMANDS = {
|
||||
wait: cmdWait,
|
||||
chat: cmdChat,
|
||||
keep: cmdKeep,
|
||||
forget: cmdForget,
|
||||
status: cmdStatus,
|
||||
stop: cmdStop,
|
||||
help: cmdHelp,
|
||||
|
||||
@@ -178,8 +178,8 @@ function lockStale(lock) {
|
||||
// Run fn while holding the session's state lock, and release it however fn
|
||||
// ends. fn must not call process.exit(): the release would never run, and the
|
||||
// next writer would wait out the stale age.
|
||||
export function withStateLock(dir, fn) {
|
||||
const lock = path.join(dir, STATE_LOCK_FILE);
|
||||
export function withStateLock(dir, fn, lockName = STATE_LOCK_FILE) {
|
||||
const lock = path.join(dir, lockName);
|
||||
const deadline = Date.now() + LOCK_WAIT_MS;
|
||||
let fd = null;
|
||||
for (let attempt = 0; fd === null; attempt++) {
|
||||
@@ -188,7 +188,7 @@ export function withStateLock(dir, fn) {
|
||||
} catch (err) {
|
||||
// EPERM / EACCES: on Windows, a lock being deleted still blocks a create.
|
||||
if (!["EEXIST", "EPERM", "EACCES", "EBUSY"].includes(err.code)) throw err;
|
||||
if (Date.now() > deadline) throw new Error("state.json is busy with another writer; try again");
|
||||
if (Date.now() > deadline) throw new Error(`${lockName.replace(/.lock$/, "")} is busy with another writer; try again`);
|
||||
if (err.code === "EEXIST" && lockStale(lock)) {
|
||||
try {
|
||||
fs.rmSync(lock, { force: true });
|
||||
@@ -487,8 +487,9 @@ export async function removeSessions(sessionsDir, sids) {
|
||||
}
|
||||
|
||||
// The console folder's own files that no sweep may ever remove: the person's
|
||||
// looks and the pointer to this console's directory.
|
||||
export const PROTECTED_CONSOLE_FILES = new Set(["looks.json", "console-dir"]);
|
||||
// looks, the folders remembered per project and spec, and the pointer to
|
||||
// this console's directory.
|
||||
export const PROTECTED_CONSOLE_FILES = new Set(["looks.json", "workspaces.json", "console-dir"]);
|
||||
|
||||
function isScratchName(name) {
|
||||
return (
|
||||
@@ -1619,17 +1620,125 @@ export function readWorkspace(dir) {
|
||||
return readJson(path.join(dir, WORKSPACE_FILE), null);
|
||||
}
|
||||
|
||||
// A fresh workspace: just the original folder, named after itself.
|
||||
export function initialWorkspace(worktree) {
|
||||
// A fresh workspace: the original folder, named after itself, plus whatever
|
||||
// was remembered for this folder and spec (rememberedWorkspace() below).
|
||||
export function initialWorkspace(worktree, remembered = null) {
|
||||
const original = { id: "f0", path: worktree, name: defaultName(worktree), description: "", original: true };
|
||||
if (remembered && remembered.original) {
|
||||
if (remembered.original.name) original.name = remembered.original.name;
|
||||
if (remembered.original.description) original.description = remembered.original.description;
|
||||
}
|
||||
const added = ((remembered && remembered.folders) || []).map((f, i) => ({
|
||||
id: "f" + (i + 1),
|
||||
path: f.path,
|
||||
name: f.name,
|
||||
description: f.description || "",
|
||||
...(f.nested ? { nested: true } : {}),
|
||||
}));
|
||||
return { version: 0, folders: [original, ...added], missing: [], changes: [], remote: "" };
|
||||
}
|
||||
|
||||
/* ------------------------------------------------ remembered workspaces */
|
||||
|
||||
// The folder list outlives the console session: one file for the person,
|
||||
// beside looks.json, keyed by the folder a session runs in and then by spec.
|
||||
// Never under specs/: the paths are this machine's, and the server never
|
||||
// writes into a project.
|
||||
//
|
||||
// { "projects": { "<folded worktree>": {
|
||||
// "path": "<worktree>",
|
||||
// "project": { original, folders, at }, // no spec picked
|
||||
// "specs": { "specs/<name>": { original, folders, at } } } } }
|
||||
//
|
||||
// `original` holds the first folder's name and description only (its path is
|
||||
// always the session's own); `folders` the added ones as { path, name,
|
||||
// description, nested? }. Two writers, the server on every change and
|
||||
// `console.mjs forget`, each a read-modify-write of one key.
|
||||
export const WORKSPACES_FILE = path.join(HOME_DIR, "workspaces.json");
|
||||
|
||||
const foldKey = (p) => {
|
||||
const resolved = path.resolve(String(p || ""));
|
||||
return process.platform === "win32" || process.platform === "darwin" ? resolved.toLowerCase() : resolved;
|
||||
};
|
||||
|
||||
// `specs/<name>` with forward slashes and no trailing slash, or "" for none.
|
||||
export function specKey(specDir) {
|
||||
return String(specDir || "")
|
||||
.trim()
|
||||
.replace(/\\/g, "/")
|
||||
.replace(/^\.\//, "")
|
||||
.replace(/\/+$/, "");
|
||||
}
|
||||
|
||||
function readStore() {
|
||||
const saved = readJson(WORKSPACES_FILE, null);
|
||||
return saved && typeof saved.projects === "object" && saved.projects ? saved : { projects: {} };
|
||||
}
|
||||
|
||||
/**
|
||||
* What was remembered for this folder and spec: `{ entry, from }`, where
|
||||
* `from` is "spec" when the spec has its own list, "project" when it falls
|
||||
* back to the project's (a spec's list starts as a copy of it), and null
|
||||
* when nothing was ever saved.
|
||||
*/
|
||||
export function rememberedWorkspace(worktree, specDir) {
|
||||
const project = readStore().projects[foldKey(worktree)];
|
||||
if (!project) return { entry: null, from: null };
|
||||
const spec = specKey(specDir);
|
||||
if (spec && project.specs && project.specs[spec]) return { entry: project.specs[spec], from: "spec" };
|
||||
return project.project ? { entry: project.project, from: "project" } : { entry: null, from: null };
|
||||
}
|
||||
|
||||
// The workspace's folders as the store keeps them.
|
||||
export function rememberable(ws) {
|
||||
const folders = (ws && ws.folders) || [];
|
||||
const first = folders.find((f) => f.original) || {};
|
||||
return {
|
||||
version: 0,
|
||||
folders: [{ id: "f0", path: worktree, name: defaultName(worktree), description: "", original: true }],
|
||||
missing: [],
|
||||
changes: [],
|
||||
remote: "",
|
||||
original: { name: first.name || "", description: first.description || "" },
|
||||
folders: folders
|
||||
.filter((f) => !f.original)
|
||||
.map((f) => ({ path: f.path, name: f.name, description: f.description || "", ...(f.nested ? { nested: true } : {}) })),
|
||||
at: nowIso(),
|
||||
};
|
||||
}
|
||||
|
||||
// Every server and `console.mjs forget` writes the one file, so each
|
||||
// read-modify-write holds this lock beside it.
|
||||
const WORKSPACES_LOCK = "workspaces.json.lock";
|
||||
|
||||
// Save the list for this folder and spec ("" for the project's own).
|
||||
export function rememberWorkspace(worktree, specDir, ws) {
|
||||
ensureDir(path.dirname(WORKSPACES_FILE));
|
||||
withStateLock(path.dirname(WORKSPACES_FILE), () => saveRemembered(worktree, specDir, ws), WORKSPACES_LOCK);
|
||||
}
|
||||
|
||||
function saveRemembered(worktree, specDir, ws) {
|
||||
const store = readStore();
|
||||
const key = foldKey(worktree);
|
||||
const project = store.projects[key] || { path: path.resolve(worktree) };
|
||||
const spec = specKey(specDir);
|
||||
if (spec) project.specs = { ...(project.specs || {}), [spec]: rememberable(ws) };
|
||||
else project.project = rememberable(ws);
|
||||
store.projects[key] = project;
|
||||
writeJsonAtomic(WORKSPACES_FILE, store);
|
||||
}
|
||||
|
||||
// Drop one spec's list (Finalize, once the spec is archived). True when there was one.
|
||||
export function forgetWorkspace(worktree, specDir) {
|
||||
const spec = specKey(specDir);
|
||||
if (!spec || !fs.existsSync(WORKSPACES_FILE)) return false;
|
||||
return withStateLock(path.dirname(WORKSPACES_FILE), () => dropRemembered(worktree, spec), WORKSPACES_LOCK);
|
||||
}
|
||||
|
||||
function dropRemembered(worktree, spec) {
|
||||
const store = readStore();
|
||||
const project = store.projects[foldKey(worktree)];
|
||||
if (!spec || !project || !project.specs || !project.specs[spec]) return false;
|
||||
delete project.specs[spec];
|
||||
writeJsonAtomic(WORKSPACES_FILE, store);
|
||||
return true;
|
||||
}
|
||||
|
||||
// Single-writer rule: only server.mjs may call this.
|
||||
export function writeWorkspace(dir, ws) {
|
||||
return writeJsonAtomic(path.join(dir, WORKSPACE_FILE), ws);
|
||||
|
||||
@@ -2505,6 +2505,9 @@ a.icon-btn { box-sizing: border-box; text-decoration: none; }
|
||||
actions stay put. */
|
||||
.modal.workspace { max-width: 680px; }
|
||||
.modal.workspace[open] { display: flex; flex-direction: column; max-height: calc(100vh - 48px); }
|
||||
.workspace .modal-blurb { margin-bottom: 6px; }
|
||||
.workspace-scope { margin: 0 0 16px; color: var(--ink-3, var(--ink-2)); font-size: 12.5px; }
|
||||
|
||||
.workspace-list {
|
||||
list-style: none; margin: 0; padding: 0;
|
||||
display: grid; gap: 12px;
|
||||
|
||||
@@ -2542,6 +2542,7 @@ function renderDashboard(main) {
|
||||
const specs = specList();
|
||||
if (specs.length) wrap.appendChild(renderSpecPicker(specs));
|
||||
wrap.appendChild(hideUnavailableToggle());
|
||||
if (!local.launching && !launchScoping) syncWorkspaceScope();
|
||||
|
||||
// "Unavailable" is the scan's verdict for the selected spec, not the
|
||||
// momentary greying while a launch is in flight or the server is away, so
|
||||
@@ -2963,6 +2964,11 @@ async function launchSkill(entry) {
|
||||
// cards that take no spec (utilities, setup) launch untargeted even while
|
||||
// a spec is selected.
|
||||
if (target) action.spec = target.dir;
|
||||
// The skill opens on the folders remembered for what it was launched for.
|
||||
// Held until the launch is in flight: the swap's own frame re-renders the
|
||||
// dashboard, which would otherwise sync back to the picker's spec.
|
||||
launchScoping = true;
|
||||
await syncWorkspaceScope(target ? target.dir : "");
|
||||
try {
|
||||
const res = await fetch("/submit", {
|
||||
method: "POST",
|
||||
@@ -2973,6 +2979,7 @@ async function launchSkill(entry) {
|
||||
}),
|
||||
});
|
||||
if (res.status === 409) {
|
||||
launchScoping = false;
|
||||
pendingResult = true;
|
||||
banner("Your last pick is still being picked up. One moment.", "info");
|
||||
return;
|
||||
@@ -2980,10 +2987,12 @@ async function launchSkill(entry) {
|
||||
if (!res.ok) throw new Error(String(res.status));
|
||||
sound("startSkill");
|
||||
local.launching = { skill: entry.skill, title: entry.title, at: Date.now() };
|
||||
launchScoping = false;
|
||||
pendingResult = true;
|
||||
save();
|
||||
render();
|
||||
} catch {
|
||||
launchScoping = false;
|
||||
banner("That did not go through. Nothing was lost; try again.", "warn");
|
||||
}
|
||||
}
|
||||
@@ -5854,6 +5863,32 @@ async function postJson(url, body) {
|
||||
}
|
||||
}
|
||||
|
||||
/* The workspace follows the dashboard's picker: the folders remembered for
|
||||
the selected spec, or the project's own under "Start from scratch". The
|
||||
server swaps the list and remembers every change after it. */
|
||||
let scopeAsked = null;
|
||||
// True from a launch's scope sync until its send has gone (or failed).
|
||||
let launchScoping = false;
|
||||
async function syncWorkspaceScope(spec) {
|
||||
if (!S || S.workflow !== "dashboard" || gone || !wsFrame) return;
|
||||
const want = spec === undefined ? (selSpec() && selSpec().dir) || "" : spec;
|
||||
if ((wsFrame.scope || "") === want || scopeAsked === want) return;
|
||||
scopeAsked = want;
|
||||
const { status, body } = await postJson("/workspace/scope", { spec: want });
|
||||
if (status === 200 && body && Array.isArray(body.folders)) wsFrame = { ...wsFrame, ...body };
|
||||
scopeAsked = null;
|
||||
if ($("workspace-modal").open) renderWorkspace();
|
||||
}
|
||||
|
||||
// The dialog's "Remembered for" line: whose list this is.
|
||||
function workspaceScopeText() {
|
||||
const scope = (wsFrame && wsFrame.scope) || "";
|
||||
if (!scope) return "Remembered for this project, so your next console session here starts with these folders.";
|
||||
const spec = specList().find((s) => s.dir === scope);
|
||||
const name = spec ? spec.name : scope.split("/").pop();
|
||||
return `Remembered for the ${name} spec, and loaded again whenever it is picked.`;
|
||||
}
|
||||
|
||||
const NAME_RULE = "Names use lowercase letters, numbers and hyphens.";
|
||||
const BROWSE_UNAVAILABLE = "Browse isn't available here — type or paste the path.";
|
||||
// The folder whose Remove is waiting on its inline confirm, by id.
|
||||
@@ -5893,6 +5928,7 @@ function renderWorkspace() {
|
||||
}
|
||||
folders.forEach((f, i) => paintWorkspaceRow(list.children[i], f));
|
||||
$("workspace-browse").hidden = Boolean(wsFrame && wsFrame.remote);
|
||||
$("workspace-scope").textContent = workspaceScopeText();
|
||||
}
|
||||
|
||||
function workspaceRow(f) {
|
||||
|
||||
@@ -833,10 +833,28 @@
|
||||
Click the folder name in the middle of the bottom bar. It shows your
|
||||
folder's name and branch, such as <strong>shop · main</strong>, and
|
||||
<strong>shop + 2 folders · main</strong> once you have added some.
|
||||
The workspace lasts for this console session only: it carries across
|
||||
steps you start from the dashboard, and a new console session starts
|
||||
with just the folder you started in.
|
||||
It carries across steps you start from the dashboard.
|
||||
</p>
|
||||
<h4>Remembered for next time</h4>
|
||||
<ul>
|
||||
<li>
|
||||
Every change is saved as you make it, so the next console session in
|
||||
this folder starts with the same folders.
|
||||
</li>
|
||||
<li>
|
||||
Each spec keeps its own list. The first time you pick a spec on the
|
||||
dashboard it starts as a copy of the project's list (the one shown
|
||||
under <strong>Start from scratch</strong>), and after that the two
|
||||
are separate. Picking a spec loads its list; the line under the
|
||||
dialog's title says whose list you are looking at.
|
||||
</li>
|
||||
<li>
|
||||
The lists live in <code>workspaces.json</code> in your own
|
||||
Plan2Code settings folder, beside your look and feel, never in the
|
||||
project. Finalize offers to forget a spec's list when it archives the
|
||||
spec.
|
||||
</li>
|
||||
</ul>
|
||||
<h4>Adding a folder</h4>
|
||||
<ul>
|
||||
<li>
|
||||
@@ -1363,9 +1381,10 @@
|
||||
<h4>What it counts</h4>
|
||||
<p>
|
||||
Each step you run here adds points: a plan or a set of documents
|
||||
weighs more than a single answered question, and a built phase more
|
||||
still, by how many tasks it completed: a big phase adds more than a
|
||||
small one. Every two questions you answer add a point too, so a long
|
||||
weighs more than a quick task, and a built phase more still, by how
|
||||
many tasks it completed: a big phase adds more than a small one.
|
||||
Every two questions you answer within one step add a point too
|
||||
(rounded down, so a single answer adds nothing), so a long
|
||||
back-and-forth counts for more than a short one. Click the ring to see the count and a list of each step that added
|
||||
points, with what it added. It is a rule of thumb, not a
|
||||
reading of Plan2Code's real memory: long sessions tend to make it
|
||||
@@ -2003,6 +2022,7 @@
|
||||
The folders the agent uses as context this session. It reads the extra ones for
|
||||
reference and only changes them if you ask.
|
||||
</p>
|
||||
<p class="workspace-scope" id="workspace-scope"></p>
|
||||
<ul class="workspace-list" id="workspace-list"></ul>
|
||||
<div class="workspace-add">
|
||||
<label class="workspace-add-label" for="workspace-path">Add a folder</label>
|
||||
|
||||
@@ -45,7 +45,10 @@ import {
|
||||
readLedger,
|
||||
readOverview,
|
||||
readWorkspace,
|
||||
rememberWorkspace,
|
||||
rememberedWorkspace,
|
||||
remoteWarning,
|
||||
specKey,
|
||||
typedCount,
|
||||
withStateLock,
|
||||
writeJsonAtomic,
|
||||
@@ -326,7 +329,9 @@ function workspaceNow() {
|
||||
return ws;
|
||||
}
|
||||
const root = sessionWorktree();
|
||||
const fresh = { ...initialWorkspace(root || PROJECT), remote: remoteWarning().remote || "" };
|
||||
const scope = specKey(stateNow?.specDir);
|
||||
const remembered = root ? rememberedWorkspace(root, scope).entry : null;
|
||||
const fresh = { ...initialWorkspace(root || PROJECT, remembered), scope, remote: remoteWarning().remote || "" };
|
||||
// There but unreadable for now (a scanner's lock): never written over, and
|
||||
// never cached, so the next call reads it again.
|
||||
if (stamp) return workspaceSeen.ws || fresh;
|
||||
@@ -347,13 +352,87 @@ function saveWorkspace(ws) {
|
||||
|
||||
// One change: a new version, an entry in the change log the agent is handed,
|
||||
// the file, and every open page.
|
||||
function bumpWorkspace(ws, change) {
|
||||
function bumpWorkspace(ws, change, { remember = true } = {}) {
|
||||
ws.version = (ws.version || 0) + 1;
|
||||
ws.changes = [...(ws.changes || []), { ...change, version: ws.version }];
|
||||
saveWorkspace(ws);
|
||||
// Remembered for the next console session too. A folder gone missing or
|
||||
// found again is not a change of mind, so it is not saved.
|
||||
if (remember) rememberNow(ws);
|
||||
pushState();
|
||||
}
|
||||
|
||||
function rememberNow(ws) {
|
||||
const root = sessionWorktree();
|
||||
if (!root) return;
|
||||
try {
|
||||
rememberWorkspace(root, ws.scope || "", ws);
|
||||
} catch {}
|
||||
}
|
||||
|
||||
/**
|
||||
* Point the workspace at another spec ("" for the project's own list) and
|
||||
* swap in what was remembered there, logging each difference as a change so
|
||||
* the agent's cursor stays truthful. A spec with nothing saved starts from
|
||||
* the project's list (`seed: "project"`, the dashboard picker) or keeps the
|
||||
* list it has and saves it as the spec's (`seed: "current"`, a spec created
|
||||
* mid-run). Folders keep their ids when their path stays.
|
||||
*/
|
||||
function setScope(ws, spec, seed = "project") {
|
||||
const root = sessionWorktree();
|
||||
const next = specKey(spec);
|
||||
if (!root || (ws.scope || "") === next) return false;
|
||||
const found = rememberedWorkspace(root, next);
|
||||
ws.scope = next;
|
||||
if (next && found.from !== "spec" && seed === "current") {
|
||||
saveWorkspace(ws);
|
||||
rememberNow(ws);
|
||||
pushState();
|
||||
return true;
|
||||
}
|
||||
const want = initialWorkspace(root, found.entry).folders;
|
||||
const byPath = new Map(ws.folders.map((f) => [foldPath(path.resolve(f.path)), f]));
|
||||
const kept = new Set();
|
||||
const folders = [];
|
||||
const changes = [];
|
||||
for (const w of want) {
|
||||
const have = w.original ? ws.folders.find((f) => f.original) : byPath.get(foldPath(path.resolve(w.path)));
|
||||
if (!have) {
|
||||
folders.push({ ...w, id: "pending" });
|
||||
changes.push({ kind: "added", name: w.name, path: w.path, description: w.description });
|
||||
continue;
|
||||
}
|
||||
kept.add(have);
|
||||
if (have.name !== w.name) changes.push({ kind: "renamed", from: have.name, name: w.name, path: have.path });
|
||||
if ((have.description || "") !== (w.description || "")) {
|
||||
changes.push({ kind: "described", name: w.name, path: have.path, description: w.description || "" });
|
||||
}
|
||||
folders.push({ ...have, name: w.name, description: w.description || "" });
|
||||
}
|
||||
for (const f of ws.folders) {
|
||||
if (!kept.has(f)) changes.unshift({ kind: "removed", name: f.name, path: f.path });
|
||||
}
|
||||
ws.folders = folders.filter((f) => f.id !== "pending");
|
||||
for (const f of folders.filter((f) => f.id === "pending")) ws.folders.push({ ...f, id: nextFolderId(ws) });
|
||||
ws.missing = (ws.missing || []).filter((id) => ws.folders.some((f) => f.id === id));
|
||||
if (!changes.length) {
|
||||
saveWorkspace(ws);
|
||||
pushState();
|
||||
}
|
||||
for (const c of changes) bumpWorkspace(ws, c, { remember: false });
|
||||
checkFolders(ws);
|
||||
return true;
|
||||
}
|
||||
|
||||
// A spec posted mid-run (Pathfinder or Plan making its folder, a skill that
|
||||
// learns its spec late) takes the workspace with it.
|
||||
function followSpecDir(state) {
|
||||
const spec = specKey(state && state.specDir);
|
||||
if (!spec || !fileStamp(WORKSPACE_PATH)) return;
|
||||
const ws = workspaceNow();
|
||||
if ((ws.scope || "") !== spec) setScope(ws, spec, "current");
|
||||
}
|
||||
|
||||
function isFolder(p) {
|
||||
try {
|
||||
return fs.statSync(p).isDirectory();
|
||||
@@ -370,10 +449,10 @@ function checkFolders(ws) {
|
||||
const marked = ws.missing.includes(f.id);
|
||||
if (!there && !marked) {
|
||||
ws.missing = [...ws.missing, f.id];
|
||||
bumpWorkspace(ws, { kind: "missing", name: f.name, path: f.path });
|
||||
bumpWorkspace(ws, { kind: "missing", name: f.name, path: f.path }, { remember: false });
|
||||
} else if (there && marked) {
|
||||
ws.missing = ws.missing.filter((id) => id !== f.id);
|
||||
bumpWorkspace(ws, { kind: "found", name: f.name, path: f.path });
|
||||
bumpWorkspace(ws, { kind: "found", name: f.name, path: f.path }, { remember: false });
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -402,8 +481,8 @@ function folderIssues(entries) {
|
||||
}
|
||||
|
||||
function workspaceView() {
|
||||
const { folders, missing, remote } = workspaceNow();
|
||||
return { folders, missing: missing || [], remote: remote || "", issues: folderIssues(ledgerEntries()) };
|
||||
const { folders, missing, remote, scope } = workspaceNow();
|
||||
return { folders, missing: missing || [], remote: remote || "", scope: scope || "", issues: folderIssues(ledgerEntries()) };
|
||||
}
|
||||
|
||||
// Whether child sits strictly under parent.
|
||||
@@ -492,6 +571,7 @@ function bootWorkspace() {
|
||||
saveWorkspace(ws);
|
||||
}
|
||||
checkFolders(ws);
|
||||
followSpecDir(stateNow);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1403,6 +1483,24 @@ const server = http.createServer((req, res) => {
|
||||
});
|
||||
}
|
||||
|
||||
// Which list the workspace is: a spec's, or the project's (`spec` empty).
|
||||
// The dashboard's picker sends it as the selection moves and before a
|
||||
// launch, so a skill opens on the list of the spec it was launched for.
|
||||
if (pathname === "/workspace/scope" && req.method === "POST") {
|
||||
if (!originOk(req, port)) return json(res, 403, { error: "bad origin" });
|
||||
return readBody(req, (err, body) => {
|
||||
if (err || !body || typeof body !== "object" || Array.isArray(body)) return json(res, 400, { error: "bad" });
|
||||
const spec = typeof body.spec === "string" ? body.spec : "";
|
||||
if (spec && !/^specs\/[^/\\]+$/.test(specKey(spec))) return json(res, 400, { reason: "bad-spec" });
|
||||
try {
|
||||
setScope(workspaceNow(), spec, "project");
|
||||
} catch (e) {
|
||||
return json(res, 500, { error: String(e.message) });
|
||||
}
|
||||
return json(res, 200, workspaceView());
|
||||
});
|
||||
}
|
||||
|
||||
// Only ever returns a path: the page then adds it through /workspace/add.
|
||||
if (pathname === "/workspace/browse" && req.method === "POST") {
|
||||
if (!originOk(req, port)) return json(res, 403, { error: "bad origin" });
|
||||
@@ -1561,6 +1659,9 @@ function checkState() {
|
||||
try {
|
||||
ensureConversation(parsed);
|
||||
} catch {}
|
||||
try {
|
||||
followSpecDir(parsed);
|
||||
} catch {}
|
||||
pushState();
|
||||
}
|
||||
lastStateStamp = stamp;
|
||||
|
||||
@@ -17,6 +17,6 @@
|
||||
"url": "https://github.com/jparkerweb/plan2code"
|
||||
},
|
||||
"homepage": "https://github.com/jparkerweb/plan2code",
|
||||
"releaseDate": "2026-10-02",
|
||||
"releaseDate": "2026-10-04",
|
||||
"mode": "utility"
|
||||
}
|
||||
Reference in new issue
Block a user