opencode-plan-manager 0.3.0 → 0.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/README.md +45 -5
- package/dist/index.js +64 -64
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -66,10 +66,10 @@ Plan Manager solves this by enforcing **Plan-to-Code Determinism**:
|
|
|
66
66
|
|
|
67
67
|
Add the plugin to your OpenCode configuration file (~/.config/opencode/opencode.json or similar):
|
|
68
68
|
|
|
69
|
-
```
|
|
69
|
+
```jsonc
|
|
70
70
|
{
|
|
71
71
|
"$schema": "https://opencode.ai/config.json",
|
|
72
|
-
"plugin": ["opencode-plan-manager@0.2.0"]
|
|
72
|
+
"plugin": ["opencode-plan-manager@0.2.0"],
|
|
73
73
|
}
|
|
74
74
|
```
|
|
75
75
|
|
|
@@ -85,12 +85,52 @@ Configuration files are loaded with the following precedence (highest to lowest)
|
|
|
85
85
|
2. **User Config:** `~/.config/opencode/plan-manager.json` (global user settings)
|
|
86
86
|
3. **Default Config:** Built-in defaults (used when no config files exist)
|
|
87
87
|
|
|
88
|
-
```
|
|
88
|
+
```jsonc
|
|
89
89
|
{
|
|
90
|
-
"outputFormat": "markdown" // "markdown" (default), "json" or "toon" (see https://github.com/toon-format/toon)
|
|
90
|
+
"outputFormat": "markdown", // "markdown" (default), "json" or "toon" (see https://github.com/toon-format/toon)
|
|
91
91
|
}
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
+
<details>
|
|
95
|
+
<summary>⚠️ Permission Requirement</summary>
|
|
96
|
+
|
|
97
|
+
> Important:
|
|
98
|
+
> If you deny edit permission in your OpenCode configuration (opencode.json) for the .opencode/plans/\* file pattern, the Plan Manager plugin cannot create or update plans.
|
|
99
|
+
> This is because the plugin uses OpenCode’s built-in ask permission method when modifying plan files. This mechanism shows users a summary of the changes and asks for review (accept/reject) before files are edited, increasing transparency and control.
|
|
100
|
+
|
|
101
|
+
What does this mean?
|
|
102
|
+
|
|
103
|
+
- The plan_create and plan_update actions require that AI agents (Plan and Build) have ask or allow permissions for edit on the .opencode/plans/\* pattern.
|
|
104
|
+
- If permission is set to deny, plan creation and modification will fail, and the workflow will not proceed.
|
|
105
|
+
How to ensure compatibility:
|
|
106
|
+
|
|
107
|
+
1. Open your opencode.json config file (usually at ~/.config/opencode/opencode.json).
|
|
108
|
+
2. Check the permissions for .opencode/plans/\*.
|
|
109
|
+
3. Make sure edit edit permission is set to "ask" or "allow" for both the Plan Agent and Build Agent.
|
|
110
|
+
|
|
111
|
+
Here is an example similar to how I configure permissions for the Plan agent:
|
|
112
|
+
|
|
113
|
+
```jsonc
|
|
114
|
+
{
|
|
115
|
+
"agent": {
|
|
116
|
+
"plan": {
|
|
117
|
+
"permission": {
|
|
118
|
+
"edit": {
|
|
119
|
+
"*": "deny", // Deny edits on everything
|
|
120
|
+
".opencode/plans/*": "ask", // Except for plan files, ask for permission
|
|
121
|
+
},
|
|
122
|
+
},
|
|
123
|
+
},
|
|
124
|
+
},
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
References:
|
|
129
|
+
|
|
130
|
+
- https://opencode.ai/docs/permissions
|
|
131
|
+
|
|
132
|
+
</details>
|
|
133
|
+
|
|
94
134
|
---
|
|
95
135
|
|
|
96
136
|
## 🤖 The Agentic Workflow
|
|
@@ -150,7 +190,7 @@ plan_create({
|
|
|
150
190
|
type: "feature",
|
|
151
191
|
description: "Secure auth flow with refresh tokens",
|
|
152
192
|
spec: {
|
|
153
|
-
|
|
193
|
+
description: "Implement secure JWT-based authentication",
|
|
154
194
|
functionals: ["User login", "Token refresh"],
|
|
155
195
|
nonFunctionals: ["Passwords hashed with bcrypt"],
|
|
156
196
|
acceptanceCriterias: ["Successful login returns valid JWT"],
|