docs: fix hook names and prompt tags in documentation

- Fix outdated hook names: prompt:before → experimental.chat.system.transform
- Fix outdated hook names: tool.execute.before → (removed, file tracking is in tool.execute.after)
- Fix outdated hook names: compaction:before → experimental.session.compacting
- Add missing event hook documentation
- Fix README example to show correct <hot_session_state> tag instead of <workspace_memory_candidates>
This commit is contained in:
Ralph Chang
2026-04-26 13:36:49 +08:00
parent 802ef62636
commit 606dcfac12
3 changed files with 24 additions and 22 deletions
+8 -6
View File
@@ -261,24 +261,26 @@ export default {
## Plugin Hooks
### `prompt:before`
### `experimental.chat.system.transform`
Injects workspace memory and hot session state into system prompt.
### `tool.execute.before`
Tracks active files (read, grep, edit, write actions).
### `tool.execute.after`
- Tracks active files (read, grep, edit, write actions)
- Tracks open errors from failed commands
- Clears errors when commands succeed
- Ignores `exitCode === undefined`
### `compaction:before`
### `experimental.session.compacting`
Extracts workspace memory candidates from conversation, applies quality gate and deduplication.
### `event`
- `session.compacted`: Promote session decisions to workspace memory
- `session.deleted`: Clean up session state files
## Debugging & Testing
### Manual Testing Steps
+8 -10
View File
@@ -93,21 +93,19 @@ Automatically tracks current session context:
Injected into system prompt:
```
<workspace_memory>
- [decision] Use npm cache for plugin loading...
- [decision] Use npm cache for plugin loading, not npm link
- [project] This repo uses opencode-agenthub plugin system
- [reference] Storage: ~/.local/share/opencode-working-memory/workspaces/{hash}/
</workspace_memory>
---
<workspace_memory_candidates>
- [project] This repo uses opencode-agenthub plugin system
- [decision] Memory V2 uses three-layer architecture
</workspace_memory_candidates>
Active Files:
<hot_session_state>
active_files:
- src/plugin.ts (edit, 18x)
- tests/plugin.test.ts (edit, 5x)
- src/extractors.ts (grep, 3x)
Open Errors: (none)
open_errors:
- [typecheck] TS2345: Argument of type 'string' is not assignable...
</hot_session_state>
```
## Quality Guarantees
+8 -6
View File
@@ -207,25 +207,27 @@ Delegate task tracking to OpenCode's native features.
The plugin hooks into OpenCode lifecycle events:
### `prompt:before`
### `experimental.chat.system.transform`
Injects workspace memory and hot session state into system prompt.
### `tool.execute.before`
Tracks active files (read, grep, edit, write actions).
### `tool.execute.after`
- Tracks active files (read, grep, edit, write actions)
- Tracks open errors from failed commands
- Clears errors when commands succeed
- Ignores `exitCode === undefined` (successful commands without explicit exit codes)
### `compaction:before`
### `experimental.session.compacting`
Extracts workspace memory candidates from conversation.
Applies quality gate, deduplication, and source priority.
### `event` (session.compacted, session.deleted)
- `session.compacted`: Promote session decisions to workspace memory
- `session.deleted`: Clean up session state files
## Quality Guarantees
### No False Positive Errors