open-plan-annotator 0.1.2 → 0.1.3

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.
@@ -0,0 +1,30 @@
1
+ {
2
+ "name": "open-plan-annotator",
3
+ "owner": {
4
+ "name": "ndom91"
5
+ },
6
+ "metadata": {
7
+ "description": "Interactive plan annotation plugin for Claude Code",
8
+ "version": "1.0.0"
9
+ },
10
+ "plugins": [
11
+ {
12
+ "name": "open-plan-annotator",
13
+ "source": "./",
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.3",
16
+ "author": {
17
+ "name": "ndom91"
18
+ },
19
+ "homepage": "https://github.com/ndom91/open-plan-annotator",
20
+ "license": "MIT",
21
+ "keywords": [
22
+ "planning",
23
+ "review",
24
+ "hooks",
25
+ "ExitPlanMode",
26
+ "annotations"
27
+ ]
28
+ }
29
+ ]
30
+ }
@@ -1,10 +1,13 @@
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.2",
4
+ "version": "0.1.3",
5
5
  "author": {
6
- "name": "ndomino"
6
+ "name": "ndom91"
7
7
  },
8
+ "homepage": "https://github.com/ndom91/open-plan-annotator",
9
+ "repository": "https://github.com/ndom91/open-plan-annotator",
10
+ "license": "MIT",
8
11
  "keywords": [
9
12
  "planning",
10
13
  "review",
package/README.md CHANGED
@@ -20,15 +20,38 @@ The server shuts down after you decide. Everything runs locally, nothing leaves
20
20
 
21
21
  ## Install
22
22
 
23
+ **1. Install the binary**
24
+
25
+ ```sh
26
+ npm install -g open-plan-annotator
27
+ ```
28
+
29
+ This downloads the correct binary for your platform (macOS, Linux).
30
+
31
+ **2. Add the marketplace and install the plugin**
32
+
33
+ From within Claude Code:
34
+
35
+ ```
36
+ /plugin marketplace add ndom91/open-plan-annotator
37
+ /plugin install open-plan-annotator@ndom91-open-plan-annotator
38
+ ```
39
+
40
+ This registers the `ExitPlanMode` hook that launches the annotation UI.
41
+
42
+ ### From source
43
+
23
44
  ```sh
45
+ git clone https://github.com/ndom91/open-plan-annotator.git
46
+ cd open-plan-annotator
24
47
  bun install
25
48
  bun run build
26
49
  ```
27
50
 
28
- This produces a single compiled binary at `build/open-plan-annotator`. Add it to your `PATH`, then install the plugin in Claude Code:
51
+ Then load it directly in Claude Code:
29
52
 
30
53
  ```sh
31
- claude plugin add /path/to/open-plan-annotator/plugin
54
+ claude --plugin-dir ./open-plan-annotator
32
55
  ```
33
56
 
34
57
  ## Annotations
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "open-plan-annotator",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "type": "module",
5
5
  "description": "Fully local plugin for interactive plan annotation from your Agentic assistants",
6
6
  "author": "ndom91",
@@ -22,7 +22,9 @@
22
22
  "files": [
23
23
  "bin/open-plan-annotator",
24
24
  "install.cjs",
25
- "plugin/",
25
+ ".claude-plugin/",
26
+ "hooks/",
27
+ "CLAUDE.md",
26
28
  "README.md"
27
29
  ],
28
30
  "scripts": {
@@ -38,7 +40,7 @@
38
40
  "lint": "biome check .",
39
41
  "lint:fix": "biome check --write .",
40
42
  "format": "biome format --write .",
41
- "publish": "./scripts/release.sh"
43
+ "do-release": "./scripts/release.sh"
42
44
  },
43
45
  "devDependencies": {
44
46
  "@biomejs/biome": "^2.4.4"
package/plugin/CLAUDE.md DELETED
@@ -1,28 +0,0 @@
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.
File without changes