plan-review 1.0.4 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/skills/plan-review/SKILL.md +26 -6
package/package.json
CHANGED
|
@@ -1,19 +1,25 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: plan-review
|
|
3
|
-
description: Use when the user asks to review a plan, start plan review, or says "I want to review this plan". Triggers on plan review requests for markdown implementation plans, specs, or design docs. Builds and runs the plan-review browser UI, feeds review output back into the conversation.
|
|
3
|
+
description: Use when the user asks to review a plan, start plan review, or says "I want to review this plan". Triggers on plan review requests for markdown implementation plans, specs, or design docs — including plans produced on-the-fly in this conversation. Builds and runs the plan-review browser UI, feeds review output back into the conversation.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Plan Review
|
|
7
7
|
|
|
8
8
|
Launch the plan-review browser UI for interactive review of markdown plans, then feed the structured review output back into this session.
|
|
9
9
|
|
|
10
|
+
Works with two input sources:
|
|
11
|
+
- **A plan file on disk** (path given by the user, or the most recent plan file in the project).
|
|
12
|
+
- **An on-the-fly plan** produced in this conversation (e.g. from plan mode, or markdown the user just pasted). The plan content is piped in via stdin — no temp file needed.
|
|
13
|
+
|
|
10
14
|
## Prerequisites
|
|
11
15
|
|
|
12
16
|
Either the `plan-review` CLI is on `$PATH` (installed via `npm install -g plan-review`) or a local dev checkout exists at `~/desenv/personal/plan-review/`.
|
|
13
17
|
|
|
14
18
|
## Process
|
|
15
19
|
|
|
16
|
-
1. **Identify the plan
|
|
20
|
+
1. **Identify the plan source.** Decide which branch you're in:
|
|
21
|
+
- **File branch** — the user named a file, or pointed at a path, or asked to review "the plan at X". Also the default when you find a single recent match in `docs/superpowers/plans/*.md`. If multiple candidates exist, ask which one.
|
|
22
|
+
- **Inline branch** — the user asks to review "this plan" / "the plan above" / "the plan you just wrote" / pastes markdown, or plan mode just produced a plan in the conversation. No file path exists.
|
|
17
23
|
|
|
18
24
|
2. **Pick the binary.** Prefer the installed CLI; fall back to the local dev build.
|
|
19
25
|
```bash
|
|
@@ -28,11 +34,24 @@ Either the `plan-review` CLI is on `$PATH` (installed via `npm install -g plan-r
|
|
|
28
34
|
fi
|
|
29
35
|
```
|
|
30
36
|
|
|
31
|
-
3. **Run the review.**
|
|
37
|
+
3. **Run the review.**
|
|
38
|
+
|
|
39
|
+
**File branch:**
|
|
32
40
|
```bash
|
|
33
41
|
$PLAN_REVIEW_CMD <plan-file> --browser -o stdout
|
|
34
42
|
```
|
|
35
|
-
|
|
43
|
+
|
|
44
|
+
**Inline branch** — pipe the plan content via a quoted heredoc so markdown is passed through verbatim (no shell expansion, no escaping needed):
|
|
45
|
+
```bash
|
|
46
|
+
$PLAN_REVIEW_CMD --browser -o stdout <<'PLAN_EOF'
|
|
47
|
+
# My Plan
|
|
48
|
+
|
|
49
|
+
## Section 1
|
|
50
|
+
...plan content from this conversation...
|
|
51
|
+
PLAN_EOF
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Both variants open the browser review UI and block until the user clicks "Submit Review", then print structured review output to stdout.
|
|
36
55
|
|
|
37
56
|
4. **Read the output.** The review output is structured markdown with the user's comments anchored to specific sections. Read it and present a summary to the user.
|
|
38
57
|
|
|
@@ -46,5 +65,6 @@ Either the `plan-review` CLI is on `$PATH` (installed via `npm install -g plan-r
|
|
|
46
65
|
- The `--browser` flag opens a three-panel review UI (TOC + content + comments).
|
|
47
66
|
- The `-o stdout` flag ensures the review output comes back to this session.
|
|
48
67
|
- The command will block until the user clicks "Submit Review" in the browser.
|
|
49
|
-
-
|
|
50
|
-
-
|
|
68
|
+
- **File branch only:** if a session exists for this plan, the user is prompted to resume. Use `--fresh` to skip.
|
|
69
|
+
- **Inline branch:** there is no file anchor, so no session resume — the review is ephemeral.
|
|
70
|
+
- Always use a **quoted** heredoc delimiter (`<<'PLAN_EOF'`) so backticks, `$`, and other shell metacharacters in the plan are left alone.
|