docs: define hook surface ownership and middleware guidance#41403
Draft
vincentkoc wants to merge 2 commits intomainfrom
Draft
docs: define hook surface ownership and middleware guidance#41403vincentkoc wants to merge 2 commits intomainfrom
vincentkoc wants to merge 2 commits intomainfrom
Conversation
3 tasks
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Describe the problem and fix in 2–5 bullets:
api.registerHook(...)look like the default API instead of the compatibility bridge.docs/automation/hooks.mdnow defines the operator-automation boundary for HOOK-style hooks, anddocs/tools/plugin.mdnow makesapi.on(...)the preferred runtime lifecycle/middleware surface while documentingapi.registerHook(...)as the legacy internal-hook bridge.Change Type (select all)
Scope (select all touched areas)
Linked Issue/PR
User-visible / Behavior Changes
api.on(...)instead ofapi.registerHook(...).Security Impact (required)
Yes, explain risk + mitigation:Repro + Verification
Environment
Steps
pnpm check.Expected
Actual
pnpm checkpasses.Evidence
Attach at least one:
Human Verification (required)
What you personally verified (not just CI), and how:
docs/automation/hooks.mdanddocs/tools/plugin.mdagainstsrc/hooks/internal-hooks.ts,src/plugins/hooks.ts,src/plugins/registry.ts, andsrc/plugins/types.ts.event.messagesreplies on lifecycle-only surfaces and do not claimapi.registerHook(...)has ordering/block semantics.Review Conversations
If a bot review conversation is addressed by this PR, resolve that conversation yourself. Do not leave bot review conversation cleanup for maintainers.
Compatibility / Migration
Failure Recovery (if this breaks)
docs/automation/hooks.md,docs/tools/plugin.mdRisks and Mitigations
List only real risks for this PR. Add/remove entries as needed. If none, write
None.api.registerHook(...)supported, but limits new middleware-style work toapi.on(...).