docs: adapt Vite DevTools integration plans to landed foundation#1024
Merged
Conversation
The compat/deprecation foundation shipped in nuxt#1021 (server) and nuxt#1023 (client), so realign the remaining plans with what actually landed: - Remove 00-compat-foundation.md (implemented) and fold the landed facts into the README: the devtools:ready / onDevtoolsReady mechanism (not the connect-safe accessors originally drafted), the shipped nostics catalog and NDT_DEP codes, and disableAuthorization now being a supported option. - Re-anchor plans 01/02/03 onto onDevtoolsReady((ctx) => ...), dropping the never-shipped connect-safe hosts and pre-connect queue machinery. - 01: re-point the client toast path onto the client onDevtoolsReady / client.devtools.devtoolsKit from nuxt#1023. - 02: note the startSubprocess/getProcess deprecations already ship while the shim still routes through the old @xterm system this plan replaces. - 03: keep the dock:true convenience flag but flag the tension that addCustomTab is now soft-deprecated toward ctx.docks.register. - Remove 04-ecosystem-playgrounds.md (handled in nuxt#1022). Created with the help of an agent.
Contributor
📝 WalkthroughWalkthroughThe integration roadmap now treats the compatibility and deprecation foundation as landed and limits the documented workstreams to Messages, Terminals, and dock groups. The Messages and Terminals plans adopt Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@plans/vite-devtools-integration/README.md`:
- Around line 73-76: Separate readiness-safe context access from domain-event
buffering across all referenced sections: in
plans/vite-devtools-integration/README.md lines 73-76 clarify that only context
access is safe after the ready hook; in
plans/vite-devtools-integration/01-messages-unification.md lines 19-26 remove
absolute “no queue” wording and lines 118-122 describe intentional buffering;
align terminal buffering guidance in
plans/vite-devtools-integration/02-terminals-reuse.md lines 32-35, 139-144, and
225-227; and align dock guidance in
plans/vite-devtools-integration/03-dock-groups-presentation.md lines 23-26 and
234-235, retaining explicit pre-ready buffering for notifications, terminal
events, and custom tabs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f236de33-3210-4b4a-a727-c2b0de64d735
📒 Files selected for processing (6)
plans/vite-devtools-integration/00-compat-foundation.mdplans/vite-devtools-integration/01-messages-unification.mdplans/vite-devtools-integration/02-terminals-reuse.mdplans/vite-devtools-integration/03-dock-groups-presentation.mdplans/vite-devtools-integration/04-ecosystem-playgrounds.mdplans/vite-devtools-integration/README.md
💤 Files with no reviewable changes (2)
- plans/vite-devtools-integration/00-compat-foundation.md
- plans/vite-devtools-integration/04-ecosystem-playgrounds.md
Comment on lines
+73
to
+76
| This is the **recommended entry point** — the kit is guaranteed available, so | ||
| there is **no pre-connect timing problem and no queue to manage**. (Earlier | ||
| drafts proposed "connect-safe host accessors" on `nuxt.devtools` with an internal | ||
| queue; those were **not** built and the ready hook supersedes them.) The raw |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Separate readiness from domain-event buffering.
The ready hook removes the need to guard access to an undefined context, but it does not eliminate buffering when notifications, terminal events, or custom tabs can be emitted before readiness. Rewrite these statements to distinguish “no context-access queue” from the optional local buffering required to preserve early events.
plans/vite-devtools-integration/README.md#L73-L76: clarify that only context access is readiness-safe.plans/vite-devtools-integration/01-messages-unification.md#L19-L26: remove the absolute “no queue” wording.plans/vite-devtools-integration/01-messages-unification.md#L118-L122: describe the buffer as intentional domain-event buffering.plans/vite-devtools-integration/02-terminals-reuse.md#L32-L35: align the foundation guidance with terminal buffering.plans/vite-devtools-integration/02-terminals-reuse.md#L139-L144: preserve the distinction in the implementation steps.plans/vite-devtools-integration/02-terminals-reuse.md#L225-L227: keep the risk guidance consistent.plans/vite-devtools-integration/03-dock-groups-presentation.md#L23-L26: align the dock guidance.plans/vite-devtools-integration/03-dock-groups-presentation.md#L234-L235: retain the explicit pre-ready buffering requirement.
📍 Affects 4 files
plans/vite-devtools-integration/README.md#L73-L76(this comment)plans/vite-devtools-integration/01-messages-unification.md#L19-L26plans/vite-devtools-integration/01-messages-unification.md#L118-L122plans/vite-devtools-integration/02-terminals-reuse.md#L32-L35plans/vite-devtools-integration/02-terminals-reuse.md#L139-L144plans/vite-devtools-integration/02-terminals-reuse.md#L225-L227plans/vite-devtools-integration/03-dock-groups-presentation.md#L23-L26plans/vite-devtools-integration/03-dock-groups-presentation.md#L234-L235
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@plans/vite-devtools-integration/README.md` around lines 73 - 76, Separate
readiness-safe context access from domain-event buffering across all referenced
sections: in plans/vite-devtools-integration/README.md lines 73-76 clarify that
only context access is safe after the ready hook; in
plans/vite-devtools-integration/01-messages-unification.md lines 19-26 remove
absolute “no queue” wording and lines 118-122 describe intentional buffering;
align terminal buffering guidance in
plans/vite-devtools-integration/02-terminals-reuse.md lines 32-35, 139-144, and
225-227; and align dock guidance in
plans/vite-devtools-integration/03-dock-groups-presentation.md lines 23-26 and
234-235, retaining explicit pre-ready buffering for notifications, terminal
events, and custom tabs.
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
2 participants
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.
What & why
The compat/deprecation foundation for the Vite DevTools / devframe integration has already landed — #1021 (server-side
devtools:readyhook + nostics-driven deprecations) and #1023 (client-sideonDevtoolsReady+ exposed client). The plans underplans/vite-devtools-integration/still described a proposed foundation (connect-safe host accessors onnuxt.devtools, a pre-connect queue, adisableAuthorizationhard-break) that was never built. This realigns the remaining plans with reality.Changes
00-compat-foundation.md(implemented) and fold the landed facts into the README: thedevtools:ready/onDevtoolsReady((ctx) => …)mechanism that hands you the already-connected context, the shipped nostics catalog andNDT_DEP_*codes, anddisableAuthorizationnow being a supported first-class option (not a hard-break).onDevtoolsReady, dropping the never-shipped connect-safe hosts and the pre-connect queue/flush machinery.onDevtoolsReady/client.devtools.devtoolsKitfrom feat(devtools): client-side onDevtoolsReady + expose Vite DevTools client; fix client RPC registration #1023.startSubprocess/getProcessdeprecation warnings already ship while the shim still routes through the old@xtermsystem this plan replaces.dock:trueconvenience flag but flag the tension thataddCustomTabis now soft-deprecated towardctx.docks.register.04-ecosystem-playgrounds.md— handled in feat(playgrounds): add ecosystem dogfooding playground for plan 04 #1022.Docs-only; no code touched.
This PR was created with the help of an agent.