open-plan-annotator 1.2.1 → 1.4.0
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/.claude-plugin/marketplace.json +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/CLAUDE.md +40 -10
- package/LICENSE +22 -0
- package/commands/open-plan-annotator.md +23 -0
- package/package.json +6 -5
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
},
|
|
6
6
|
"metadata": {
|
|
7
7
|
"description": "Interactive plan annotation plugin for Claude Code",
|
|
8
|
-
"version": "1.
|
|
8
|
+
"version": "1.4.0"
|
|
9
9
|
},
|
|
10
10
|
"plugins": [
|
|
11
11
|
{
|
|
12
12
|
"name": "open-plan-annotator",
|
|
13
13
|
"source": "./",
|
|
14
14
|
"description": "Interactive plan annotation UI: review, strikethrough, and comment on Claude's plans before approving. Fully local, no external services.",
|
|
15
|
-
"version": "1.
|
|
15
|
+
"version": "1.4.0",
|
|
16
16
|
"author": {
|
|
17
17
|
"name": "ndom91"
|
|
18
18
|
},
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "open-plan-annotator",
|
|
3
3
|
"description": "Interactive plan annotation UI: review, strikethrough, and comment on Claude's plans before approving. Fully local, no external services.",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.4.0",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "ndom91"
|
|
7
7
|
},
|
package/CLAUDE.md
CHANGED
|
@@ -1,28 +1,58 @@
|
|
|
1
1
|
# open-plan-annotator: Plan Review Instructions
|
|
2
2
|
|
|
3
|
+
## Why This Plugin Exists
|
|
4
|
+
|
|
5
|
+
Markdown plans rendered in chat are read-only for the user. To give feedback they have to retype sections inline, which is awkward in a terminal. open-plan-annotator opens a browser UI where the user can mark up your plan directly — delete lines, replace text, insert steps, leave comments. Their annotations come back to you as structured feedback.
|
|
6
|
+
|
|
7
|
+
**Prefer this workflow whenever the user is expected to give structured feedback on a multi-section proposal.**
|
|
8
|
+
|
|
9
|
+
This is distinct from `plannotator-review` (post-implementation code review). open-plan-annotator runs *before* code is written.
|
|
10
|
+
|
|
3
11
|
## ALWAYS Use Plan Mode for Non-Trivial Tasks
|
|
4
12
|
|
|
5
|
-
|
|
13
|
+
Enter plan mode (which triggers the annotator on `ExitPlanMode`) before implementation that involves:
|
|
14
|
+
|
|
6
15
|
- Creating or modifying more than 2 files
|
|
7
16
|
- Architectural or structural changes
|
|
8
17
|
- Anything the user hasn't explicitly described step-by-step
|
|
9
18
|
- Refactoring, migration, or feature additions
|
|
10
19
|
- Bug fixes that require investigation
|
|
11
20
|
|
|
12
|
-
|
|
21
|
+
## Also Trigger When Drafting Plans Outside Plan Mode
|
|
22
|
+
|
|
23
|
+
Plan-shaped output happens in many contexts beyond `EnterPlanMode`. Enter plan mode (so the annotator fires on exit) whenever you're about to produce:
|
|
13
24
|
|
|
14
|
-
|
|
25
|
+
- A multi-step proposal with numbered or bulleted action items the user is expected to react to
|
|
26
|
+
- A reply containing phrases like "recommended approach", "implementation plan", "proposed fix", "rollout plan", "here's what I'd do"
|
|
27
|
+
- A response to user prompts like "let's plan X", "draft a plan", "what's the approach", "give me options", "how should we tackle this"
|
|
28
|
+
- Any moment you'd otherwise ask "want me to proceed?" / "shall I draft this?" — enter plan mode instead
|
|
15
29
|
|
|
16
|
-
|
|
30
|
+
Rough gate: **structured feedback expected + more than ~5 action items or sections**. Below that bar, a direct answer is fine.
|
|
31
|
+
|
|
32
|
+
## Do NOT Trigger For
|
|
33
|
+
|
|
34
|
+
- Single-line fixes, typos, renames
|
|
35
|
+
- Direct factual answers
|
|
36
|
+
- Status updates or progress reports
|
|
37
|
+
- Plans the user has already approved (don't re-prompt)
|
|
38
|
+
- Pure research or exploration with no proposed actions
|
|
39
|
+
- Trivial questions where a plan would be overhead
|
|
17
40
|
|
|
18
41
|
## Plan Quality Standards
|
|
19
42
|
|
|
20
43
|
When writing a plan, include:
|
|
21
|
-
- A brief summary of what you understood the task to require
|
|
22
|
-
- The specific files you intend to create or modify and why
|
|
23
|
-
- Any assumptions you are making
|
|
24
|
-
- An explicit question if anything is ambiguous
|
|
25
44
|
|
|
26
|
-
|
|
45
|
+
- Brief summary of what you understood the task to require
|
|
46
|
+
- Specific files you intend to create or modify and why
|
|
47
|
+
- Any assumptions you're making
|
|
48
|
+
- Explicit question if anything is ambiguous
|
|
49
|
+
|
|
50
|
+
## Workflow
|
|
51
|
+
|
|
52
|
+
**In plan mode:** draft plan → call `ExitPlanMode` → annotator opens → user annotates → revise based on feedback → re-exit when aligned.
|
|
53
|
+
|
|
54
|
+
**Outside plan mode (inline plan situations):** invoke the `/open-plan-annotator` slash command instead of pasting a plan inline. That command runs the same plan-mode + draft + `ExitPlanMode` flow and routes the plan through the annotator UI. Do not paste a multi-section plan inline and ask "sound good?" — that bypasses the annotator.
|
|
55
|
+
|
|
56
|
+
## Slash Command
|
|
27
57
|
|
|
28
|
-
|
|
58
|
+
`/open-plan-annotator <task>` is the canonical entry point for the plan-and-annotate workflow. Users can invoke it explicitly, and you should invoke it yourself any time you'd otherwise draft an inline plan (see "Also Trigger When Drafting Plans Outside Plan Mode" above). The command enters plan mode, drafts a plan for the task, and exits to trigger the annotator — do not skip straight to implementation.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Nico Domino
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Draft a plan and open it in the annotator UI for user review
|
|
3
|
+
argument-hint: [task description]
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
The user wants a plan drafted and reviewed via the open-plan-annotator UI before any implementation.
|
|
7
|
+
|
|
8
|
+
**Task to plan:** $ARGUMENTS
|
|
9
|
+
|
|
10
|
+
Steps:
|
|
11
|
+
|
|
12
|
+
1. Enter plan mode (`EnterPlanMode`).
|
|
13
|
+
2. Investigate the codebase as needed to draft a concrete plan. Include:
|
|
14
|
+
- Brief summary of what you understood the task to require
|
|
15
|
+
- Specific files you intend to create or modify and why
|
|
16
|
+
- Any assumptions you're making
|
|
17
|
+
- Explicit questions if anything is ambiguous
|
|
18
|
+
3. Call `ExitPlanMode` with the plan. This triggers the open-plan-annotator browser UI.
|
|
19
|
+
4. The user will annotate the plan (deletions, replacements, insertions, comments) in the browser.
|
|
20
|
+
5. If the user denies with annotations, revise the plan based on their feedback and re-exit plan mode.
|
|
21
|
+
6. Only begin implementation after the user approves.
|
|
22
|
+
|
|
23
|
+
Do not skip plan mode. Do not paste a plan inline and ask "sound good?" — that bypasses the annotator UI the user installed this plugin for.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "open-plan-annotator",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Fully local plugin for interactive plan annotation from your Agentic assistants",
|
|
6
6
|
"author": "ndom91",
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
"opencode/config.js",
|
|
40
40
|
"opencode/index.js",
|
|
41
41
|
"hooks/",
|
|
42
|
+
"commands/",
|
|
42
43
|
"CLAUDE.md",
|
|
43
44
|
"README.md"
|
|
44
45
|
],
|
|
@@ -70,9 +71,9 @@
|
|
|
70
71
|
"@opencode-ai/plugin": "^1.2.14"
|
|
71
72
|
},
|
|
72
73
|
"optionalDependencies": {
|
|
73
|
-
"@open-plan-annotator/runtime-darwin-arm64": "1.
|
|
74
|
-
"@open-plan-annotator/runtime-darwin-x64": "1.
|
|
75
|
-
"@open-plan-annotator/runtime-linux-arm64": "1.
|
|
76
|
-
"@open-plan-annotator/runtime-linux-x64": "1.
|
|
74
|
+
"@open-plan-annotator/runtime-darwin-arm64": "1.4.0",
|
|
75
|
+
"@open-plan-annotator/runtime-darwin-x64": "1.4.0",
|
|
76
|
+
"@open-plan-annotator/runtime-linux-arm64": "1.4.0",
|
|
77
|
+
"@open-plan-annotator/runtime-linux-x64": "1.4.0"
|
|
77
78
|
}
|
|
78
79
|
}
|