refactor(devframe): rename Devtool* identifiers to Devframe*#328
Merged
Conversation
Renames the singular `devtool` terminology throughout the devframe package to `devframe`, matching the package name and positioning. Canonical names: `defineDevframe`, `DevframeDefinition`, `DevframeRuntime`, `DevframeDeploymentKind`, `DevframeCliOptions`, `DevframeSpaOptions`, `DevframeBrowserContext`, `DevframeSetupInfo`, `connectDevframe`. The old names (`defineDevtool`, `DevtoolDefinition`, `connectDevtool`, etc.) continue to work as deprecated aliases — types carry `@deprecated` JSDoc, and `defineDevtool` / `connectDevtool` emit a one-time `console.warn` on first call before delegating to the new name. Updated source, kit bridge, Nuxt package, docs, examples, skill templates, READMEs, and CLAUDE.md/AGENTS.md. The `Vite DevTools` product name and `DevTools*` (PascalCase plural) identifiers stay unchanged.
✅ Deploy Preview for devfra ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
commit: |
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
1 participant
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.
Description
Renames the singular
devtoolterminology throughout thedevframepackage todevframe, aligning identifiers with the package name. Canonical names are nowdefineDevframe,DevframeDefinition,DevframeRuntime,DevframeDeploymentKind,DevframeCliOptions,DevframeSpaOptions,DevframeBrowserContext,DevframeSetupInfo, andconnectDevframe. Old names (defineDevtool,DevtoolDefinition,connectDevtool, …) keep working as deprecated aliases — types carry@deprecatedJSDoc;defineDevtool/connectDevtoolemit a one-timeconsole.warnon first call and delegate to the new function. Includes updates to source, the kit bridge, the Nuxt package, all docs, examples, skill templates, READMEs, and CLAUDE.md/AGENTS.md; theVite DevToolsproduct name andDevTools*(PascalCase plural) identifiers are intentionally left unchanged.Linked Issues
Additional context
Reviewers may want to focus on the deprecation strategy in
devframe/packages/devframe/src/types/devframe.ts(type aliases + one-shot wrapper fordefineDevtool) andsrc/client/index.ts(where the previous export-renamegetDevToolsRpcClient as connectDevtoolis promoted to a real wrapper so it can host the runtime warning). tsnapi snapshots now list bothDevframe*(canonical) andDevtool*(deprecated) exports — expected. Verified withpnpm typecheck,pnpm test(450/450),pnpm lint, andpnpm build.