@narumitw/pi-plan-mode 0.59.5 → 0.60.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/CHANGELOG.md +228 -0
- package/README.md +40 -13
- package/dist/chunks/{chunk-MJV6WNHK.ts → chunk-UJ6TV2YV.ts} +102 -86
- package/dist/chunks/chunk-UJ6TV2YV.ts.map +7 -0
- package/dist/chunks/{interactive-ui-F7FMN7FT.ts → interactive-ui-EMUWYNHT.ts} +15 -2
- package/dist/chunks/interactive-ui-EMUWYNHT.ts.map +7 -0
- package/dist/index.ts +616 -32
- package/dist/index.ts.map +4 -4
- package/docs/command-workflows.md +30 -0
- package/package.json +5 -4
- package/src/finalization-request.ts +3 -0
- package/src/interaction-contract.ts +73 -0
- package/src/interaction-coordinator.ts +379 -0
- package/src/plan-action-controller.ts +11 -2
- package/src/plan-action-menus.ts +18 -0
- package/src/plan-mode.ts +115 -24
- package/src/presentation.ts +42 -9
- package/src/question-renderer.ts +174 -0
- package/src/question-tool.ts +32 -4
- package/src/state.ts +40 -0
- package/dist/chunks/chunk-MJV6WNHK.ts.map +0 -7
- package/dist/chunks/interactive-ui-F7FMN7FT.ts.map +0 -7
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# @narumitw/pi-plan-mode
|
|
2
|
+
|
|
3
|
+
## 0.60.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 522796b: Add free discussion within Plan mode. Switch with F2 when no native Pi binding uses it, or use the active `/plan` menu. Switching discards unfinished questionnaire answers without changing the main prompt draft. Discussion keeps read-only restrictions and stores completed plans without opening an automatic action menu. Restore the interaction mode with the workflow; new workflows start with questionnaires enabled.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- 227aedc: Preserve wide graphemes in expanded question details and prevent leading combining marks from making decorative prefixes exceed the viewport. Apply the same bounds to questions, answers, notes, cancellations, and errors.
|
|
12
|
+
- b6da988: Show compact, themed question-and-answer summaries in the transcript, with full questions and notes available when tool output is expanded.
|
|
13
|
+
- Updated dependencies [4f79c28]
|
|
14
|
+
- @narumitw/pi-tui-kit@0.69.1
|
|
15
|
+
|
|
16
|
+
## 0.59.6
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- 6c76ef1: Report inline Plan questions, Notes template editing, and Progress settings as waiting for user input on supported Pi hosts and terminals. Add optional consumer-owned blocked metadata to Kit custom interactions and questionnaires without marking loaders or changing RPC and print behavior. Settle host-disposed interactions and drain their work without interrupting native reset or restoring stale editor drafts.
|
|
21
|
+
- e484010: Include the existing package-root CHANGELOG.md in extension tarballs so Pi can show native update notices. Keep Changesets version headings and Pi's first-observation and collapseChangelog behavior unchanged.
|
|
22
|
+
- Updated dependencies [54f2700]
|
|
23
|
+
- Updated dependencies [6c76ef1]
|
|
24
|
+
- @narumitw/pi-tui-kit@0.69.0
|
|
25
|
+
|
|
26
|
+
## 0.59.5
|
|
27
|
+
|
|
28
|
+
### Patch Changes
|
|
29
|
+
|
|
30
|
+
- 9d3e0d7: Prevent passive UI timers from keeping Node alive while preserving status expiry, settings reloads, paste handling, and cleanup.
|
|
31
|
+
- Updated dependencies [9d3e0d7]
|
|
32
|
+
- @narumitw/pi-tui-kit@0.68.1
|
|
33
|
+
|
|
34
|
+
## 0.59.4
|
|
35
|
+
|
|
36
|
+
### Patch Changes
|
|
37
|
+
|
|
38
|
+
- 9f80b89: Reuse published Kit interaction ownership for native Progress and Subagents settings while preserving ordered saves, rollback, and durable-save recovery after the screen closes.
|
|
39
|
+
|
|
40
|
+
Share passive widget framing in Subagents, Tool, Plan Mode, and Cache Hit Monitor. Keep domain rendering and lifecycle ownership local, bound narrow and invalid widths, and retain lazy loading of Kit menus and other interactive APIs.
|
|
41
|
+
- Updated dependencies [077137a]
|
|
42
|
+
- Updated dependencies [9f80b89]
|
|
43
|
+
- Updated dependencies [efc474c]
|
|
44
|
+
- @narumitw/pi-tui-kit@0.66.0
|
|
45
|
+
|
|
46
|
+
## 0.59.3
|
|
47
|
+
|
|
48
|
+
### Patch Changes
|
|
49
|
+
|
|
50
|
+
- fed7bfb: Handle Pi custom-message run starts without consuming queued file quotes, clearing ready plans, or applying user-prompt Goal ownership logic.
|
|
51
|
+
|
|
52
|
+
## 0.59.2
|
|
53
|
+
|
|
54
|
+
### Patch Changes
|
|
55
|
+
|
|
56
|
+
- 2708319: Require Pi TUI Kit's published questionnaire custom-editor fix so existing lockfiles cannot retain a Kit release that bypasses the configured editor factory or mishandles editor submissions and key-release cycles.
|
|
57
|
+
|
|
58
|
+
## 0.59.1
|
|
59
|
+
|
|
60
|
+
### Patch Changes
|
|
61
|
+
|
|
62
|
+
- 000bd50: Use Pi's publicly configured custom editor factory for TUI questionnaire answers and notes. Custom editors own editing and submission keys, while Ctrl+C remains hard cancellation and the main prompt editor stays untouched. Preserve raw expanded drafts, fragmented paste safety, default-editor and non-TUI behavior, and release questionnaire-owned editor instances when the interaction ends.
|
|
63
|
+
|
|
64
|
+
Honor custom editor submission values without replacing intentional normalization with the original draft, and retain editor-owned key-release cycles across answer and note transitions.
|
|
65
|
+
- Updated dependencies [000bd50]
|
|
66
|
+
- @narumitw/pi-tui-kit@0.65.2
|
|
67
|
+
|
|
68
|
+
## 0.59.0
|
|
69
|
+
|
|
70
|
+
### Minor Changes
|
|
71
|
+
|
|
72
|
+
- 51d8c21: Restrict `safeSubcommands` trust to individual parsed Bash and PowerShell segments. A matching prefix no longer exempts trailing commands or bypasses the shell parser: every segment must pass its own policy, and unsupported syntax such as redirects and multiline input remains blocked.
|
|
73
|
+
|
|
74
|
+
This is a compatibility change from full-command trust. Simple configured commands and trusted arguments remain supported, but chains require each additional segment to be independently permitted. Run workflows requiring parser-unsupported syntax outside Plan mode after review. The settings schema is unchanged, and explicitly trusted commands and their arguments can still mutate data or execute code; this setting is not a read-only guarantee or sandbox.
|
|
75
|
+
|
|
76
|
+
## 0.58.4
|
|
77
|
+
|
|
78
|
+
### Patch Changes
|
|
79
|
+
|
|
80
|
+
- 9621cda: Distinguish inactive Pi tools from Plan-policy blocks in Settings and the pre-start picker, and explain how to enable built-in search tools through Pi settings without changing tool activation or execution policy.
|
|
81
|
+
- dbc6e8e: Allow explicit selection of native MCP and orchestration tools in Plan Mode. Honor registered callable exposure without direct activation while preserving automatic core defaults, frozen workflow policies, and per-call nested safety checks.
|
|
82
|
+
- acb3aaf: Allow case-insensitive inspection flags such as `rg -i` and `grep -i` in the Plan mode shell policy.
|
|
83
|
+
|
|
84
|
+
## 0.58.3
|
|
85
|
+
|
|
86
|
+
### Patch Changes
|
|
87
|
+
|
|
88
|
+
- 26e8801: Make Plan-mode shortcut changes explicitly take effect after `/reload` or restarting Pi. Keep startup shortcut registrations stable, remove ineffective live rebinding, and show the configured and startup-loaded values with reload guidance in Settings. Other settings retain their existing reload behavior.
|
|
89
|
+
- Updated dependencies [e6db042]
|
|
90
|
+
- @narumitw/pi-tui-kit@0.65.1
|
|
91
|
+
|
|
92
|
+
## 0.58.2
|
|
93
|
+
|
|
94
|
+
### Patch Changes
|
|
95
|
+
|
|
96
|
+
- 8abd5b7: Keep generated extension runtime graphs inside Pi's Jiti-loaded TypeScript path to avoid duplicate peer-runtime evaluation during startup. Add measured generated runtimes for Context Management, Herdr, and TypeSafe Search.
|
|
97
|
+
|
|
98
|
+
## 0.58.1
|
|
99
|
+
|
|
100
|
+
### Patch Changes
|
|
101
|
+
|
|
102
|
+
- 67a3049: Adapt provider, transcript, usage, deferred-tool, and telemetry behavior to Pi's current runtime contracts, including accurate cache-warming accounting and exclusion from ordinary generation traces.
|
|
103
|
+
|
|
104
|
+
## 0.58.0
|
|
105
|
+
|
|
106
|
+
### Minor Changes
|
|
107
|
+
|
|
108
|
+
- b745330: Add persistent fresh implementation model and thinking defaults with a same-as-plan fallback.
|
|
109
|
+
- 0ef037d: Add one-shot model and thinking selection before fresh ready-plan implementation.
|
|
110
|
+
|
|
111
|
+
### Patch Changes
|
|
112
|
+
|
|
113
|
+
- 7c9a062: Defer automatic ready-plan fresh session handoffs until lifecycle dispatch and prompt cleanup finish.
|
|
114
|
+
- Updated dependencies [4485b49]
|
|
115
|
+
- Updated dependencies [6b1e009]
|
|
116
|
+
- @narumitw/pi-tui-kit@0.62.0
|
|
117
|
+
|
|
118
|
+
## 0.57.1
|
|
119
|
+
|
|
120
|
+
### Patch Changes
|
|
121
|
+
|
|
122
|
+
- 31b3dde: Remove the implementation model and thinking selectors, restoring Plan implementation handoffs to the current model and normal thinking behavior.
|
|
123
|
+
|
|
124
|
+
## 0.57.0
|
|
125
|
+
|
|
126
|
+
### Minor Changes
|
|
127
|
+
|
|
128
|
+
- e2af16b: Add optional implementation model and thinking defaults plus per-menu implementation options for same-session and fresh-session handoffs. Apply choices only at implementation start without changing Pi defaults or automatically restoring the planner's model after a run ends.
|
|
129
|
+
|
|
130
|
+
### Patch Changes
|
|
131
|
+
|
|
132
|
+
- Updated dependencies [317f7bd]
|
|
133
|
+
- @narumitw/pi-tui-kit@0.61.0
|
|
134
|
+
|
|
135
|
+
## 0.56.0
|
|
136
|
+
|
|
137
|
+
### Minor Changes
|
|
138
|
+
|
|
139
|
+
- e230348: Allow narrowly validated local `hostname`, `tasklist`, `Get-Process`, and `Get-Service` inspections in Plan mode by default.
|
|
140
|
+
- 708cc2e: Let users add arbitrary `safeSubcommands` entries and treat every configured command-subcommand prefix as fully trusted for Plan-mode Bash and PowerShell calls.
|
|
141
|
+
|
|
142
|
+
## 0.55.3
|
|
143
|
+
|
|
144
|
+
### Patch Changes
|
|
145
|
+
|
|
146
|
+
- 14068d2: Allow reviewed Git inspections to use current-working-directory `git -C <path>` forms, and report actionable reasons when Plan mode denies an unavailable, inactive, frozen, blocked, or unselected tool.
|
|
147
|
+
|
|
148
|
+
## 0.55.2
|
|
149
|
+
|
|
150
|
+
### Patch Changes
|
|
151
|
+
|
|
152
|
+
- Updated dependencies [40182e5]
|
|
153
|
+
- @narumitw/pi-tui-kit@0.59.0
|
|
154
|
+
|
|
155
|
+
## 0.55.1
|
|
156
|
+
|
|
157
|
+
### Patch Changes
|
|
158
|
+
|
|
159
|
+
- b99b3db: Resolve explicitly selected tools registered before the first Plan request without mutating Pi's active tool schemas.
|
|
160
|
+
|
|
161
|
+
## 0.55.0
|
|
162
|
+
|
|
163
|
+
### Minor Changes
|
|
164
|
+
|
|
165
|
+
- b59cdbc: Remove the `toolVisibility` setting and keep Plan helper schemas stable from startup.
|
|
166
|
+
Retired settings keys are ignored and preserved, while globally visible helper metadata now distinguishes `/plan` from ordinary planning workflows.
|
|
167
|
+
|
|
168
|
+
## 0.54.0
|
|
169
|
+
|
|
170
|
+
### Minor Changes
|
|
171
|
+
|
|
172
|
+
- ab467e0: Allow Pi's active native PowerShell tool to run reviewed read-only file, directory, Git, and GitHub inspections in Plan mode while blocking mutation and unsupported dynamic syntax.
|
|
173
|
+
|
|
174
|
+
## 0.53.1
|
|
175
|
+
|
|
176
|
+
### Patch Changes
|
|
177
|
+
|
|
178
|
+
- 02878f5: Add an editor-style divider above the Plan mode widget.
|
|
179
|
+
- 3346683: Publish generated lazy chunks at the JavaScript paths referenced by each extension runtime so deferred menus and implementations load correctly through Pi's Jiti loader.
|
|
180
|
+
- Updated dependencies [b9eba3a]
|
|
181
|
+
- @narumitw/pi-tui-kit@0.58.0
|
|
182
|
+
|
|
183
|
+
## 0.53.0
|
|
184
|
+
|
|
185
|
+
### Minor Changes
|
|
186
|
+
|
|
187
|
+
- c194597: Make conversation-history-only implementation the default, use Codex-style kickoff prompts without active-plan injection, and clarify Plan reinjection controls.
|
|
188
|
+
- e74ee84: Add configurable Plan helper visibility and default to revealing the helper tools on the first successful Plan activation.
|
|
189
|
+
- 67eb77b: Remove the `--plan` startup flag. Start Plan mode after launch with `/plan start` or begin with a prompt through `/plan <prompt>`.
|
|
190
|
+
- da265a0: Keep Plan and Normal requests on one append-only conversation with stable tool schemas, versioned mode contracts, and a runtime Plan tool allowlist that no longer activates inactive tools.
|
|
191
|
+
|
|
192
|
+
### Patch Changes
|
|
193
|
+
|
|
194
|
+
- df584db: Keep unused resumed sessions free of mode contracts and reject `/tree` navigation to internal transition markers.
|
|
195
|
+
- 5be9aa2: Prevent active agent runs from mixing Plan and Normal tool contracts, and retry explicit structured finalization once after settlement when the model responds with prose only.
|
|
196
|
+
|
|
197
|
+
## 0.52.0
|
|
198
|
+
|
|
199
|
+
### Minor Changes
|
|
200
|
+
|
|
201
|
+
- 85d13c8: Coordinate Plan-mode activation through Workflow Mutex Protocol v1 so cooperating agent workflows cannot start in the same Pi session.
|
|
202
|
+
|
|
203
|
+
## 0.51.1
|
|
204
|
+
|
|
205
|
+
### Patch Changes
|
|
206
|
+
|
|
207
|
+
- 8540d0f: Simplify single-question TUI questionnaires with a plain header and immediate answer submission while retaining tabbed Review for multiple questions.
|
|
208
|
+
- 5785cb4: Reuse Pi TUI Kit's questionnaire runner while preserving Plan mode answer and lifecycle behavior.
|
|
209
|
+
- Updated dependencies [8540d0f]
|
|
210
|
+
- @narumitw/pi-tui-kit@0.57.1
|
|
211
|
+
|
|
212
|
+
## 0.51.0
|
|
213
|
+
|
|
214
|
+
### Minor Changes
|
|
215
|
+
|
|
216
|
+
- 416da47: Add tabbed TUI Plan questions with answer notes and final review.
|
|
217
|
+
|
|
218
|
+
## 0.50.1
|
|
219
|
+
|
|
220
|
+
### Patch Changes
|
|
221
|
+
|
|
222
|
+
- 30bc076: Load each extension from a generated TypeScript runtime to reduce Jiti package startup work while preserving existing first-use boundaries.
|
|
223
|
+
|
|
224
|
+
## 0.50.0
|
|
225
|
+
|
|
226
|
+
### Minor Changes
|
|
227
|
+
|
|
228
|
+
- 160f2fc: Add an optional `toggleShortcut` setting and a **Plan mode shortcut** Settings row so the global Plan-mode keybinding can be chosen, and keep it disabled while the setting is omitted. Reload the settings file automatically when it changes and rebind the configured shortcut immediately after a Settings save.
|
package/README.md
CHANGED
|
@@ -8,7 +8,8 @@ Use a Codex-like `/plan` mode to explore a codebase, resolve important questions
|
|
|
8
8
|
|
|
9
9
|
- Starts and manages Plan mode through `/plan`, `/plan start`, or `/plan <prompt>`.
|
|
10
10
|
- Blocks mutations, inactive helpers, and unsafe shell forms while keeping helper schemas stable.
|
|
11
|
-
-
|
|
11
|
+
- Switches between structured questionnaires and free discussion without leaving read-only planning.
|
|
12
|
+
- Uses explicit completion for a decision-ready plan.
|
|
12
13
|
- Reviews the complete plan before implementation, export, save, further planning, or discard.
|
|
13
14
|
- Implements in the planning session or a fresh linked session with the approved plan.
|
|
14
15
|
- Configures persistent or one-shot destination model and thinking choices for fresh implementation.
|
|
@@ -46,7 +47,7 @@ Install only from sources you trust because Pi extensions run with Pi's permissi
|
|
|
46
47
|
Run `/plan` to open the state-aware menu, then start Plan mode and ask the agent to inspect and design the change.
|
|
47
48
|
Run `/plan <prompt>` when the first planning request is already known.
|
|
48
49
|
|
|
49
|
-
##
|
|
50
|
+
## 🧭 How it works
|
|
50
51
|
|
|
51
52
|
Plan mode keeps exploration and implementation on opposite sides of an explicit review boundary:
|
|
52
53
|
|
|
@@ -55,7 +56,7 @@ flowchart LR
|
|
|
55
56
|
start["Start: /plan or /plan with a prompt"]
|
|
56
57
|
start --> explore["Explore safely: inspect and clarify"]
|
|
57
58
|
explore --> complete["Complete the plan with plan_mode_complete"]
|
|
58
|
-
complete --> review["Review the ready plan"]
|
|
59
|
+
complete --> review["Review the ready plan: use /plan in discussion"]
|
|
59
60
|
review -->|Revise| explore
|
|
60
61
|
review -->|Implement here| current["Current session: planning context retained"]
|
|
61
62
|
review -->|Start fresh| fresh["Fresh session: approved plan transferred"]
|
|
@@ -77,7 +78,12 @@ sequenceDiagram
|
|
|
77
78
|
Plan->>User: Ask material questions when needed
|
|
78
79
|
User-->>Plan: Answer or refine the request
|
|
79
80
|
Plan->>Pi: Submit the complete plan
|
|
80
|
-
|
|
81
|
+
alt Questionnaires enabled
|
|
82
|
+
Pi-->>User: Show the ready-plan action menu
|
|
83
|
+
else Free discussion
|
|
84
|
+
Pi-->>User: Display and store the ready plan without a menu
|
|
85
|
+
User->>Pi: Open /plan when ready
|
|
86
|
+
end
|
|
81
87
|
alt Implement here
|
|
82
88
|
Pi->>Work: Restore Normal mode in the current session
|
|
83
89
|
else Start fresh and implement
|
|
@@ -89,7 +95,7 @@ sequenceDiagram
|
|
|
89
95
|
|
|
90
96
|
| Command | Purpose |
|
|
91
97
|
| --- | --- |
|
|
92
|
-
| `/plan` | Start or manage planning, review a plan, or choose same-session or fresh-session implementation. |
|
|
98
|
+
| `/plan` | Start or manage planning, switch questionnaire/discussion mode, review a plan, or choose same-session or fresh-session implementation. |
|
|
93
99
|
| `/plan start` | Enter Plan mode without sending a model message. |
|
|
94
100
|
| `/plan <prompt>` | Start planning with a prompt, or send a follow-up while already active. |
|
|
95
101
|
| `/plan tools` | Choose a session-specific tool policy, then start; cancellation changes nothing. |
|
|
@@ -114,7 +120,7 @@ See [command workflows](./docs/command-workflows.md) for tool selection, busy-st
|
|
|
114
120
|
## 🔒 Security and privacy
|
|
115
121
|
|
|
116
122
|
While Plan mode is active, the policy blocks built-in editing tools and instructs the agent not to edit files or implement the change.
|
|
117
|
-
It should explore first and ask structured questions when a preference or tradeoff materially changes the plan.
|
|
123
|
+
It should explore first and ask structured questions when a preference or tradeoff materially changes the plan, or ask in plain text during free discussion.
|
|
118
124
|
Configure persistent defaults or a one-workflow tool override before activation; active and ready workflows lock those controls.
|
|
119
125
|
|
|
120
126
|
Plan mode registers `plan_mode_question` and `plan_mode_complete` during extension load and never changes their active status itself.
|
|
@@ -161,6 +167,19 @@ Trusted commands can still mutate data or execute code with Pi's permissions; se
|
|
|
161
167
|
|
|
162
168
|
## 🧭 Planning and implementation
|
|
163
169
|
|
|
170
|
+
Each new Plan workflow starts with questionnaires enabled.
|
|
171
|
+
In TUI, F2 switches between questionnaires and free discussion only when the main editor is idle or the current workflow's questionnaire is open; it does not toggle Plan mode itself.
|
|
172
|
+
If an effective native Pi keybinding uses F2, this shortcut is not registered or shown; use the active `/plan` menu instead.
|
|
173
|
+
Other running work does not accept the toggle.
|
|
174
|
+
Switching from a questionnaire discards all unfinished answers and notes, leaves the main prompt draft unchanged, and stops the questionnaire run without sending a message.
|
|
175
|
+
Enabling questionnaires again does not call the model or reopen old questions.
|
|
176
|
+
|
|
177
|
+
Free discussion keeps the same read-only restrictions and allows plain-text questions without questionnaire dialogs.
|
|
178
|
+
Completed plans are still displayed, stored, and marked `plan ready`, but no automatic action menu opens; use `/plan` manually to implement, save, export, revise, exit, or enable questionnaires.
|
|
179
|
+
The editor widget shows the interaction mode and the available F2 or `/plan` entry point, including when a plan is ready.
|
|
180
|
+
The interaction mode restores with the active workflow on reload or resume; a new workflow starts with questionnaires enabled.
|
|
181
|
+
See [interaction switching](./docs/command-workflows.md#questionnaires-and-free-discussion) for RPC behavior and recovery.
|
|
182
|
+
|
|
164
183
|
`plan_mode_question` follows Codex's `request_user_input` pattern: the agent can ask 1-3 concise questions, each with meaningful options and a free-form Other path.
|
|
165
184
|
In TUI mode, a single question shows its header as plain muted text, submits as soon as its preset or custom answer is confirmed, and does not show tabs, Review, or question-navigation controls.
|
|
166
185
|
Add an optional note with `n` before confirming a single preset answer.
|
|
@@ -170,12 +189,14 @@ Use up and down to choose an option, Enter to record it and advance, or `n` to r
|
|
|
170
189
|
Press `n` again on an answered item to edit or clear its note.
|
|
171
190
|
Revisit a question to replace its answer; changing the chosen option clears its prior note.
|
|
172
191
|
Review lists every answer and note, blocks incomplete submission, and requires returning to a question to edit its answer or note.
|
|
192
|
+
The transcript shows a compact summary of each answer instead of raw tool JSON. Expand the tool output to read the full questions, answers, and notes.
|
|
173
193
|
Custom answers and notes retain their raw submitted text in the tool result, while terminal rendering is sanitized.
|
|
174
194
|
In TUI mode, a custom editor registered through Pi's `ctx.ui.setEditorComponent()` also handles answer and note editing in a separate instance, without changing the main prompt draft.
|
|
175
195
|
While that editor is active, it controls Escape and submission keys; Ctrl+C still cancels the question.
|
|
176
196
|
The editor's submitted value is retained, including any whitespace normalization it intentionally applies.
|
|
177
197
|
Without a custom editor, existing editing and cancellation behavior is unchanged.
|
|
178
198
|
The TUI rejects either field above 4,000 characters instead of truncating it.
|
|
199
|
+
On Pi 1.5 or later, the inline question prompt reports `question` waiting status to supported terminals until it closes. Older hosts keep the same question UI without this terminal status.
|
|
179
200
|
RPC keeps the existing sequential `select` and `editor` dialogs because Pi RPC cannot render custom TUI components.
|
|
180
201
|
If you cancel or no interactive UI is available, the agent should ask a concise plain-text question or proceed only with a clearly stated low-risk assumption instead of prematurely producing a final plan.
|
|
181
202
|
|
|
@@ -196,7 +217,8 @@ Termination is best effort: if a model puts it in a parallel tool batch, Pi term
|
|
|
196
217
|
The prompt therefore requires the completion call to be standalone and last.
|
|
197
218
|
The extension deliberately does not infer completion from phrases such as “I will present the plan,” and ordinary research or clarification turns never trigger automatic retries.
|
|
198
219
|
`/plan finalize` and its exact canonical finalization prompt are explicit recovery requests.
|
|
199
|
-
|
|
220
|
+
With questionnaires enabled, if one of those requests ends normally without a valid structured question or completed plan, Plan mode waits for `agent_settled` and retries once with stronger tool guidance.
|
|
221
|
+
In free discussion, `/plan finalize` can finish the plan or ask a remaining material question in plain text; it does not start this structured-tool retry.
|
|
200
222
|
A valid question, accepted completion, user cancellation, explicit exit, workflow supersession, reload, session replacement, or shutdown cancels the retry.
|
|
201
223
|
A second prose-only failure leaves Plan mode active, warns in interactive modes, and requires another explicit `/plan finalize` request.
|
|
202
224
|
|
|
@@ -276,14 +298,16 @@ The extension deliberately does not infer completion from assistant prose or age
|
|
|
276
298
|
Under **Off — conversation history only**, implementation messages remain ordinary conversation history and there is no active plan for `/plan exit` to remove.
|
|
277
299
|
Choosing Stay before implementation keeps the plan ready.
|
|
278
300
|
Revision feedback starts another Plan-mode turn and clears the previous implementable plan until an updated completion arrives.
|
|
279
|
-
|
|
301
|
+
With questionnaires enabled, for clarification-only follow-ups, the agent answers and resubmits the complete unchanged plan so it remains implementable.
|
|
302
|
+
Free discussion can continue in plain text and uses the same revision flow when the user sends a follow-up.
|
|
280
303
|
Before saving or implementation, exit/off discards the ready plan and removes its completion result from later non-Plan model context.
|
|
281
304
|
|
|
282
305
|
While Plan mode is enabled, the extension also publishes a compact status for Pi statuslines.
|
|
283
306
|
With `@narumitw/pi-statusline`, this appears in the extension status area:
|
|
284
307
|
|
|
285
|
-
- `plan active`: Plan mode is enabled and
|
|
286
|
-
- `plan
|
|
308
|
+
- `plan active`: Plan mode is enabled with questionnaires available and is gathering context or drafting a plan.
|
|
309
|
+
- `plan discussion`: Free discussion is active with questionnaires paused; file edits remain blocked.
|
|
310
|
+
- `plan ready`: A completed plan is stored until you implement it, export it, save it, continue planning, or exit Plan mode; the widget still shows free discussion when active.
|
|
287
311
|
- `plan saved`: One completed plan is stored outside model context in the current session until you implement or clear it.
|
|
288
312
|
- `plan implementing`: The exact accepted plan is guaranteed under **Through first implementation run** or **Until manually cleared**.
|
|
289
313
|
|
|
@@ -300,6 +324,7 @@ During a guaranteed-plan implementation, it removes both the original implementa
|
|
|
300
324
|
Plan and Normal requests share one append-only conversation.
|
|
301
325
|
The extension appends one hidden, model-visible, versioned Plan contract before the first Plan prompt and one Normal contract before the first post-Plan Normal or implementation prompt.
|
|
302
326
|
Ordinary linear turns do not rewrite or duplicate these contracts.
|
|
327
|
+
A separate versioned interaction contract is appended when a workflow starts or the user switches between questionnaires and discussion; existing Plan contracts and conversation history are not rewritten.
|
|
303
328
|
The Plan contract explains native-tool opt-in and per-call nested enforcement; this wording changes future Plan transitions without rewriting existing transition messages.
|
|
304
329
|
**Implement here** retains the Plan dialogue, structured questions, tool calls, completion evidence, and `Implement the plan.` kickoff in order.
|
|
305
330
|
**Start fresh and implement** is the isolation path and transfers only the approved plan plus the Normal contract to a linked session.
|
|
@@ -374,8 +399,9 @@ The optional file is read at session start and watched for changes; only an expl
|
|
|
374
399
|
```
|
|
375
400
|
|
|
376
401
|
By default, Plan mode inherits thinking, allows active safe built-ins, uses the planning model and thinking level for fresh implementation, exports to `PLAN.md`, and relies on ordinary conversation history after implementation starts.
|
|
377
|
-
The shortcut is disabled unless configured; enabling, changing, or removing it takes effect after `/reload` or restarting Pi.
|
|
378
|
-
Until then,
|
|
402
|
+
The existing Plan-mode toggle shortcut (`toggleShortcut`) is disabled unless configured; enabling, changing, or removing it takes effect after `/reload` or restarting Pi.
|
|
403
|
+
Until then, that shortcut binding stays unchanged.
|
|
404
|
+
This setting is unrelated to the conditional F2 questionnaire/discussion toggle and does not configure it.
|
|
379
405
|
Settings saves apply to later workflows; an active implementation keeps its captured reinjection policy.
|
|
380
406
|
The export destination affects the next export immediately.
|
|
381
407
|
Inactive built-in `grep`, `find`, and `ls` must be [enabled in Pi settings](./docs/settings.md#enable-inactive-built-in-search-tools-in-pi); Plan policy only grants execution permission.
|
|
@@ -396,7 +422,8 @@ This extension maps Codex's `ModeKind::Plan` behavior onto Pi's extension API:
|
|
|
396
422
|
|
|
397
423
|
- Plan mode is conversational collaboration, not TODO or progress tracking.
|
|
398
424
|
- `/plan <prompt>` enters Plan mode before submitting the prompt.
|
|
399
|
-
-
|
|
425
|
+
- With questionnaires enabled, the agent uses `plan_mode_question` for material preferences; free discussion permits plain-text questions.
|
|
426
|
+
- The agent completes with a standalone `plan_mode_complete` call instead of prose detection.
|
|
400
427
|
- `update_plan` is blocked until the explicit implementation boundary restores Normal mode.
|
|
401
428
|
- The default `clear-on-start` policy uses conversation history; `clear-after-first-run` and `keep` add exact-plan guarantees.
|
|
402
429
|
- Append-only Plan and Normal contracts keep helper schemas stable, but Pi's tool policy is risk reduction rather than Codex sandbox enforcement.
|
|
@@ -803,86 +803,6 @@ function createImplementationRetentionCoordinator() {
|
|
|
803
803
|
};
|
|
804
804
|
}
|
|
805
805
|
|
|
806
|
-
// src/plan-export.ts
|
|
807
|
-
import { mkdir as mkdir2, writeFile as writeFile2 } from "node:fs/promises";
|
|
808
|
-
import { dirname as dirname2, resolve } from "node:path";
|
|
809
|
-
import { stripVTControlCharacters } from "node:util";
|
|
810
|
-
import { withFileMutationQueue } from "@earendil-works/pi-coding-agent";
|
|
811
|
-
async function exportStoredPlan(state, requestedPath, ctx, lifecycle, defaultPath = DEFAULT_PLAN_EXPORT_PATH) {
|
|
812
|
-
const plan = (state.enabled ? state.latestPlan : void 0)?.trim() ?? state.savedPlan?.plan.trim() ?? state.activeImplementation?.plan.trim();
|
|
813
|
-
if (!plan) {
|
|
814
|
-
const error = new Error("No completed plan is available to export. Use /plan finalize when planning is complete.");
|
|
815
|
-
if (!ctx.hasUI) throw error;
|
|
816
|
-
ctx.ui.notify(error.message, "warning");
|
|
817
|
-
return false;
|
|
818
|
-
}
|
|
819
|
-
const isCurrent = () => !lifecycle || lifecycle.isCurrent() && (!lifecycle.getState || lifecycle.getState() === state);
|
|
820
|
-
let result;
|
|
821
|
-
try {
|
|
822
|
-
result = await exportPlanToFile(plan, requestedPath, ctx.cwd, lifecycle?.signal, isCurrent, defaultPath);
|
|
823
|
-
} catch (error) {
|
|
824
|
-
if (lifecycle?.signal.aborted || !isCurrent()) return false;
|
|
825
|
-
if (!ctx.hasUI) throw error;
|
|
826
|
-
const detail2 = error instanceof Error ? error.message : String(error);
|
|
827
|
-
ctx.ui.notify(safeNotification(`Unable to export plan: ${detail2}`), "error");
|
|
828
|
-
return false;
|
|
829
|
-
}
|
|
830
|
-
if (!isCurrent()) return false;
|
|
831
|
-
const finishedReady = state.enabled && Boolean(state.latestPlan?.trim()) && lifecycle?.finishReady !== void 0;
|
|
832
|
-
if (finishedReady) lifecycle.finishReady?.();
|
|
833
|
-
const detail = finishedReady ? " Plan mode disabled." : "";
|
|
834
|
-
ctx.ui.notify(safeNotification(`Plan exported to ${result.path}.${detail}`), "info");
|
|
835
|
-
return true;
|
|
836
|
-
}
|
|
837
|
-
async function exportPlanToFile(plan, requestedPath, cwd, signal, isCurrent = () => true, defaultPath = DEFAULT_PLAN_EXPORT_PATH) {
|
|
838
|
-
const path = resolvePlanExportPath(requestedPath, cwd, defaultPath);
|
|
839
|
-
await withFileMutationQueue(path, async () => {
|
|
840
|
-
throwIfCancelled(signal, isCurrent);
|
|
841
|
-
await mkdir2(dirname2(path), { recursive: true });
|
|
842
|
-
throwIfCancelled(signal, isCurrent);
|
|
843
|
-
try {
|
|
844
|
-
await writeFile2(path, `${plan}
|
|
845
|
-
`, { encoding: "utf8", flag: "wx" });
|
|
846
|
-
} catch (error) {
|
|
847
|
-
if (isNodeError2(error) && error.code === "EEXIST") {
|
|
848
|
-
throw new Error(`Plan export target already exists: ${path}. Choose another path or remove it first.`);
|
|
849
|
-
}
|
|
850
|
-
throw error;
|
|
851
|
-
}
|
|
852
|
-
});
|
|
853
|
-
return { path };
|
|
854
|
-
}
|
|
855
|
-
function planExportDestination(defaultPath, cwd) {
|
|
856
|
-
return {
|
|
857
|
-
configuredPath: safeNotification(defaultPath),
|
|
858
|
-
resolvedPath: safeNotification(resolvePlanExportPath(void 0, cwd, defaultPath))
|
|
859
|
-
};
|
|
860
|
-
}
|
|
861
|
-
function resolvePlanExportPath(requestedPath, cwd, defaultPath = DEFAULT_PLAN_EXPORT_PATH) {
|
|
862
|
-
const rawPath = requestedPath?.trim() || defaultPath;
|
|
863
|
-
const normalizedPath = rawPath.startsWith("@") ? rawPath.slice(1) : rawPath;
|
|
864
|
-
if (!normalizedPath.trim()) throw new Error("Plan export path must not be empty.");
|
|
865
|
-
if (normalizedPath.includes("\0")) {
|
|
866
|
-
throw new Error("Plan export path must not contain NUL bytes.");
|
|
867
|
-
}
|
|
868
|
-
return resolve(cwd, normalizedPath);
|
|
869
|
-
}
|
|
870
|
-
function safeNotification(value) {
|
|
871
|
-
let sanitized = "";
|
|
872
|
-
for (const character of stripVTControlCharacters(value)) {
|
|
873
|
-
const codePoint = character.codePointAt(0);
|
|
874
|
-
sanitized += codePoint !== void 0 && codePoint > 31 && !(codePoint >= 127 && codePoint <= 159) ? character : " ";
|
|
875
|
-
}
|
|
876
|
-
return sanitized;
|
|
877
|
-
}
|
|
878
|
-
function throwIfCancelled(signal, isCurrent) {
|
|
879
|
-
if (!signal?.aborted && isCurrent()) return;
|
|
880
|
-
throw signal?.reason instanceof Error ? signal.reason : new DOMException("Plan export cancelled", "AbortError");
|
|
881
|
-
}
|
|
882
|
-
function isNodeError2(error) {
|
|
883
|
-
return error instanceof Error && "code" in error;
|
|
884
|
-
}
|
|
885
|
-
|
|
886
806
|
// src/question-tool.ts
|
|
887
807
|
var PLAN_MODE_QUESTION_TOOL_NAME = "plan_mode_question";
|
|
888
808
|
var MAX_PLAN_MODE_RESPONSE_LENGTH = 4e3;
|
|
@@ -989,7 +909,12 @@ function normalizePlanModeQuestionParams(input) {
|
|
|
989
909
|
return { ok: true, questions };
|
|
990
910
|
}
|
|
991
911
|
async function answerPlanModeQuestions(questions, ctx, lifecycle) {
|
|
992
|
-
const answers = await askPlanModeQuestions(
|
|
912
|
+
const answers = await askPlanModeQuestions(
|
|
913
|
+
questions,
|
|
914
|
+
ctx,
|
|
915
|
+
() => lifecycle.isCurrent() && lifecycle.isEnabled(),
|
|
916
|
+
lifecycle.signal
|
|
917
|
+
);
|
|
993
918
|
if (!lifecycle.isCurrent()) {
|
|
994
919
|
return planModeQuestionCancelled(
|
|
995
920
|
questions,
|
|
@@ -1004,12 +929,22 @@ async function answerPlanModeQuestions(questions, ctx, lifecycle) {
|
|
|
1004
929
|
"Plan-mode question cancelled because Plan mode is no longer active."
|
|
1005
930
|
);
|
|
1006
931
|
}
|
|
932
|
+
if (lifecycle.discussionRequested?.()) {
|
|
933
|
+
return {
|
|
934
|
+
...planModeQuestionCancelled(
|
|
935
|
+
questions,
|
|
936
|
+
"discussion_requested",
|
|
937
|
+
"The user switched to free discussion without submitting answers. Wait for the user to speak; do not reopen the questionnaire."
|
|
938
|
+
),
|
|
939
|
+
terminate: true
|
|
940
|
+
};
|
|
941
|
+
}
|
|
1007
942
|
if (!answers) {
|
|
1008
943
|
return planModeQuestionCancelled(questions, "cancelled", "User cancelled the Plan-mode question prompt.");
|
|
1009
944
|
}
|
|
1010
945
|
return planModeQuestionAnswered(questions, answers);
|
|
1011
946
|
}
|
|
1012
|
-
async function askPlanModeQuestions(questions, ctx, shouldContinue = () => true) {
|
|
947
|
+
async function askPlanModeQuestions(questions, ctx, shouldContinue = () => true, signal = ctx.signal) {
|
|
1013
948
|
const { runQuestionnaire, sanitizeTerminalText } = await import("@narumitw/pi-tui-kit");
|
|
1014
949
|
if (!shouldContinue()) return void 0;
|
|
1015
950
|
const runnerQuestions = questions.map((question, index) => ({
|
|
@@ -1022,10 +957,11 @@ async function askPlanModeQuestions(questions, ctx, shouldContinue = () => true)
|
|
|
1022
957
|
}))
|
|
1023
958
|
}));
|
|
1024
959
|
const result = await runQuestionnaire(ctx, {
|
|
960
|
+
blocked: { kind: "question", message: "Answer Plan mode questions" },
|
|
1025
961
|
questions: runnerQuestions,
|
|
1026
962
|
allowNotes: true,
|
|
1027
963
|
maxTextLength: MAX_PLAN_MODE_RESPONSE_LENGTH,
|
|
1028
|
-
signal
|
|
964
|
+
signal,
|
|
1029
965
|
isCurrent: shouldContinue
|
|
1030
966
|
});
|
|
1031
967
|
if (!shouldContinue()) return void 0;
|
|
@@ -1107,6 +1043,86 @@ function stringField(value) {
|
|
|
1107
1043
|
return typeof value === "string" ? value.trim() : void 0;
|
|
1108
1044
|
}
|
|
1109
1045
|
|
|
1046
|
+
// src/plan-export.ts
|
|
1047
|
+
import { mkdir as mkdir2, writeFile as writeFile2 } from "node:fs/promises";
|
|
1048
|
+
import { dirname as dirname2, resolve } from "node:path";
|
|
1049
|
+
import { stripVTControlCharacters } from "node:util";
|
|
1050
|
+
import { withFileMutationQueue } from "@earendil-works/pi-coding-agent";
|
|
1051
|
+
async function exportStoredPlan(state, requestedPath, ctx, lifecycle, defaultPath = DEFAULT_PLAN_EXPORT_PATH) {
|
|
1052
|
+
const plan = (state.enabled ? state.latestPlan : void 0)?.trim() ?? state.savedPlan?.plan.trim() ?? state.activeImplementation?.plan.trim();
|
|
1053
|
+
if (!plan) {
|
|
1054
|
+
const error = new Error("No completed plan is available to export. Use /plan finalize when planning is complete.");
|
|
1055
|
+
if (!ctx.hasUI) throw error;
|
|
1056
|
+
ctx.ui.notify(error.message, "warning");
|
|
1057
|
+
return false;
|
|
1058
|
+
}
|
|
1059
|
+
const isCurrent = () => !lifecycle || lifecycle.isCurrent() && (!lifecycle.getState || lifecycle.getState() === state);
|
|
1060
|
+
let result;
|
|
1061
|
+
try {
|
|
1062
|
+
result = await exportPlanToFile(plan, requestedPath, ctx.cwd, lifecycle?.signal, isCurrent, defaultPath);
|
|
1063
|
+
} catch (error) {
|
|
1064
|
+
if (lifecycle?.signal.aborted || !isCurrent()) return false;
|
|
1065
|
+
if (!ctx.hasUI) throw error;
|
|
1066
|
+
const detail2 = error instanceof Error ? error.message : String(error);
|
|
1067
|
+
ctx.ui.notify(safeNotification(`Unable to export plan: ${detail2}`), "error");
|
|
1068
|
+
return false;
|
|
1069
|
+
}
|
|
1070
|
+
if (!isCurrent()) return false;
|
|
1071
|
+
const finishedReady = state.enabled && Boolean(state.latestPlan?.trim()) && lifecycle?.finishReady !== void 0;
|
|
1072
|
+
if (finishedReady) lifecycle.finishReady?.();
|
|
1073
|
+
const detail = finishedReady ? " Plan mode disabled." : "";
|
|
1074
|
+
ctx.ui.notify(safeNotification(`Plan exported to ${result.path}.${detail}`), "info");
|
|
1075
|
+
return true;
|
|
1076
|
+
}
|
|
1077
|
+
async function exportPlanToFile(plan, requestedPath, cwd, signal, isCurrent = () => true, defaultPath = DEFAULT_PLAN_EXPORT_PATH) {
|
|
1078
|
+
const path = resolvePlanExportPath(requestedPath, cwd, defaultPath);
|
|
1079
|
+
await withFileMutationQueue(path, async () => {
|
|
1080
|
+
throwIfCancelled(signal, isCurrent);
|
|
1081
|
+
await mkdir2(dirname2(path), { recursive: true });
|
|
1082
|
+
throwIfCancelled(signal, isCurrent);
|
|
1083
|
+
try {
|
|
1084
|
+
await writeFile2(path, `${plan}
|
|
1085
|
+
`, { encoding: "utf8", flag: "wx" });
|
|
1086
|
+
} catch (error) {
|
|
1087
|
+
if (isNodeError2(error) && error.code === "EEXIST") {
|
|
1088
|
+
throw new Error(`Plan export target already exists: ${path}. Choose another path or remove it first.`);
|
|
1089
|
+
}
|
|
1090
|
+
throw error;
|
|
1091
|
+
}
|
|
1092
|
+
});
|
|
1093
|
+
return { path };
|
|
1094
|
+
}
|
|
1095
|
+
function planExportDestination(defaultPath, cwd) {
|
|
1096
|
+
return {
|
|
1097
|
+
configuredPath: safeNotification(defaultPath),
|
|
1098
|
+
resolvedPath: safeNotification(resolvePlanExportPath(void 0, cwd, defaultPath))
|
|
1099
|
+
};
|
|
1100
|
+
}
|
|
1101
|
+
function resolvePlanExportPath(requestedPath, cwd, defaultPath = DEFAULT_PLAN_EXPORT_PATH) {
|
|
1102
|
+
const rawPath = requestedPath?.trim() || defaultPath;
|
|
1103
|
+
const normalizedPath = rawPath.startsWith("@") ? rawPath.slice(1) : rawPath;
|
|
1104
|
+
if (!normalizedPath.trim()) throw new Error("Plan export path must not be empty.");
|
|
1105
|
+
if (normalizedPath.includes("\0")) {
|
|
1106
|
+
throw new Error("Plan export path must not contain NUL bytes.");
|
|
1107
|
+
}
|
|
1108
|
+
return resolve(cwd, normalizedPath);
|
|
1109
|
+
}
|
|
1110
|
+
function safeNotification(value) {
|
|
1111
|
+
let sanitized = "";
|
|
1112
|
+
for (const character of stripVTControlCharacters(value)) {
|
|
1113
|
+
const codePoint = character.codePointAt(0);
|
|
1114
|
+
sanitized += codePoint !== void 0 && codePoint > 31 && !(codePoint >= 127 && codePoint <= 159) ? character : " ";
|
|
1115
|
+
}
|
|
1116
|
+
return sanitized;
|
|
1117
|
+
}
|
|
1118
|
+
function throwIfCancelled(signal, isCurrent) {
|
|
1119
|
+
if (!signal?.aborted && isCurrent()) return;
|
|
1120
|
+
throw signal?.reason instanceof Error ? signal.reason : new DOMException("Plan export cancelled", "AbortError");
|
|
1121
|
+
}
|
|
1122
|
+
function isNodeError2(error) {
|
|
1123
|
+
return error instanceof Error && "code" in error;
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1110
1126
|
// src/tool-availability.ts
|
|
1111
1127
|
function planModeToolAvailability(tool, activeNames, route = "selection") {
|
|
1112
1128
|
switch (tool.exposure) {
|
|
@@ -1857,13 +1873,13 @@ export {
|
|
|
1857
1873
|
retentionLabel,
|
|
1858
1874
|
implementationRetentionPreview,
|
|
1859
1875
|
createImplementationRetentionCoordinator,
|
|
1860
|
-
exportStoredPlan,
|
|
1861
|
-
planExportDestination,
|
|
1862
1876
|
PLAN_MODE_QUESTION_TOOL_NAME,
|
|
1863
1877
|
PLAN_MODE_QUESTION_PARAMS,
|
|
1864
1878
|
normalizePlanModeQuestionParams,
|
|
1865
1879
|
answerPlanModeQuestions,
|
|
1866
1880
|
planModeQuestionCancelled,
|
|
1881
|
+
exportStoredPlan,
|
|
1882
|
+
planExportDestination,
|
|
1867
1883
|
planModeToolAvailability,
|
|
1868
1884
|
classifyPlanModeTool,
|
|
1869
1885
|
canSelectToolInPlanMode,
|
|
@@ -1876,4 +1892,4 @@ export {
|
|
|
1876
1892
|
defaultPlanModeToolNames,
|
|
1877
1893
|
snapshotPlanModeSelectedNames
|
|
1878
1894
|
};
|
|
1879
|
-
//# sourceMappingURL=chunk-
|
|
1895
|
+
//# sourceMappingURL=chunk-UJ6TV2YV.ts.map
|