open-plan-annotator 0.1.13 → 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.
@@ -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.1.13",
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.1.13",
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
@@ -1,11 +1,16 @@
1
1
  # open-plan-annotator
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/open-plan-annotator?style=flat-square)](https://www.npmjs.com/package/open-plan-annotator)
4
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
5
+ [![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux-pink?style=flat-square)]()
6
+
3
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.
4
8
 
5
- Select text to strikethrough, replace, insert, or comment — then approve the plan or request changes.
9
+ Select text to <code style="color: purple">strikethrough</code>, <code style="color: orange">replace</code>, <code style="color: blue">insert</code>, or <code style="color: red">comment</code> — then approve the plan or request changes.
10
+
11
+
12
+ ![](.github/assets/screenshot_01.png)
6
13
 
7
- ![](.github/assets/screenshot_001.png)
8
- > UI for annotating LLM Plans
9
14
 
10
15
  ## How it works
11
16
 
@@ -26,7 +31,12 @@ The server shuts down after you decide. Everything runs locally, nothing leaves
26
31
  npm install -g open-plan-annotator
27
32
  ```
28
33
 
29
- This downloads the correct binary for your platform (macOS, Linux).
34
+ This JS shim downloads the correct binary for your platform (macOS, Linux).
35
+
36
+ > [!NOTE]
37
+ > If using pnpm, postinstall scripts will be blocked by default. You can run the
38
+ > 'open-plan-annotator' manually to trigger a download, or the first invocation
39
+ > by Claude will also trigger the binary download.
30
40
 
31
41
  **2. Add the marketplace and install the plugin**
32
42
 
@@ -39,6 +49,11 @@ From within Claude Code:
39
49
 
40
50
  This registers the `ExitPlanMode` hook that launches the annotation UI.
41
51
 
52
+
53
+ > [!NOTE]
54
+ > The first run might take a few seconds if you hadn't installed the binary, as
55
+ > Claude will trigger the download then.
56
+
42
57
  ### From source
43
58
 
44
59
  ```sh
@@ -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", "inherit", "inherit"],
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.log(`Downloading open-plan-annotator for ${getPlatformKey()}...`);
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.log(`Installed open-plan-annotator to ${destPath}`);
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.1.13",
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"