open-plan-annotator 0.2.0 → 0.2.1
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 +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/CLAUDE.md +28 -0
- package/README.md +2 -2
- package/bin/open-plan-annotator.cjs +1 -1
- package/install.cjs +2 -2
- package/package.json +4 -2
|
@@ -12,7 +12,7 @@
|
|
|
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": "0.2.
|
|
15
|
+
"version": "0.2.1",
|
|
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": "0.2.
|
|
4
|
+
"version": "0.2.1",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "ndom91"
|
|
7
7
|
},
|
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# open-plan-annotator: Plan Review Instructions
|
|
2
|
+
|
|
3
|
+
## ALWAYS Use Plan Mode for Non-Trivial Tasks
|
|
4
|
+
|
|
5
|
+
Before beginning any implementation that involves:
|
|
6
|
+
- Creating or modifying more than 2 files
|
|
7
|
+
- Architectural or structural changes
|
|
8
|
+
- Anything the user hasn't explicitly described step-by-step
|
|
9
|
+
- Refactoring, migration, or feature additions
|
|
10
|
+
- Bug fixes that require investigation
|
|
11
|
+
|
|
12
|
+
You MUST use plan mode to present your approach first.
|
|
13
|
+
|
|
14
|
+
## Why This Matters
|
|
15
|
+
|
|
16
|
+
The user has installed the open-plan-annotator plugin specifically to review and annotate your plans before you write code. Skipping plan mode bypasses this workflow entirely and removes the user's ability to give structured feedback.
|
|
17
|
+
|
|
18
|
+
## Plan Quality Standards
|
|
19
|
+
|
|
20
|
+
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
|
+
|
|
26
|
+
## When Plan Mode Is Optional
|
|
27
|
+
|
|
28
|
+
For truly trivial tasks (fix a typo, rename a single variable, answer a factual question), plan mode is not required. When in doubt, use it anyway — the user can always approve immediately.
|
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/open-plan-annotator)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
|
-
[]()
|
|
6
6
|
|
|
7
7
|
A fully local agentic coding plugin (claude-code, opencode) that intercepts plan mode, opens an annotation UI in your browser, and feeds structured feedback back to the agent.
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Select text to <code style="color: purple">strikethrough</code>, <code style="co
|
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
|
|
14
14
|
|
|
15
15
|
## How it works
|
|
16
16
|
|
|
@@ -20,7 +20,7 @@ if (!fs.existsSync(binaryPath)) {
|
|
|
20
20
|
console.error("open-plan-annotator: binary not found, downloading...");
|
|
21
21
|
try {
|
|
22
22
|
execFileSync(process.execPath, [installScript], {
|
|
23
|
-
stdio: ["ignore",
|
|
23
|
+
stdio: ["ignore", 2, "inherit"],
|
|
24
24
|
});
|
|
25
25
|
} catch (e) {
|
|
26
26
|
console.error(
|
package/install.cjs
CHANGED
|
@@ -89,7 +89,7 @@ async function main() {
|
|
|
89
89
|
}
|
|
90
90
|
|
|
91
91
|
const url = getDownloadUrl();
|
|
92
|
-
console.
|
|
92
|
+
console.error(`Downloading open-plan-annotator for ${getPlatformKey()}...`);
|
|
93
93
|
|
|
94
94
|
const buffer = await fetch(url);
|
|
95
95
|
const binaryBuffer = extractBinaryFromTarGz(buffer);
|
|
@@ -99,7 +99,7 @@ async function main() {
|
|
|
99
99
|
}
|
|
100
100
|
|
|
101
101
|
fs.writeFileSync(destPath, binaryBuffer, { mode: 0o755 });
|
|
102
|
-
console.
|
|
102
|
+
console.error(`Installed open-plan-annotator to ${destPath}`);
|
|
103
103
|
}
|
|
104
104
|
|
|
105
105
|
main().catch((err) => {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "open-plan-annotator",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Fully local plugin for interactive plan annotation from your Agentic assistants",
|
|
6
6
|
"author": "ndom91",
|
|
@@ -40,7 +40,9 @@
|
|
|
40
40
|
"lint": "biome check .",
|
|
41
41
|
"lint:fix": "biome check --write .",
|
|
42
42
|
"format": "biome format --write .",
|
|
43
|
-
"do-release": "./scripts/release.sh"
|
|
43
|
+
"do-release": "./scripts/release.sh",
|
|
44
|
+
"prepack": "cp CLAUDE.plugin.md CLAUDE.md",
|
|
45
|
+
"postpack": "rm -f CLAUDE.md"
|
|
44
46
|
},
|
|
45
47
|
"devDependencies": {
|
|
46
48
|
"@biomejs/biome": "^2.4.4"
|