Upgrading @nuxt/devtools 0.2 to 0.3
Breaking0.2.5 → 0.3.2Breaking2New25Changed5Fixed13Other1
BreakingUpgrade verdict
2 breaking changes.
In plain terms
- The import path @nuxt/devtools/kit has moved to a new package, @nuxt/devtools-kit.
- The iframe client import path has moved to the new kit package.
Must act 2 items need code or config changes
Adds @nuxt/devtools-kit 0.3.2, @nuxt/devtools-wizard 0.3.2, fast-glob ^3.2.12, get-port-please ^3.0.1, global-dirs ^3.0.1, image-meta ^0.1.1, local-pkg ^0.4.3, nypm ^0.1.0, picocolors ^1.0.0, semver ^7.3.8, sirv ^2.0.2, tinyws ^0.1.0, wait-on ^7.0.1, which ^3.0.0, ws ^8.13.0.
Drops @antfu/install-pkg.
Installs 467 packages in all (was 414).
What you must change
Breaking2
Moves @nuxt/devtools/kit to @nuxt/devtools-kit.
@nuxt/devtools/kit@nuxt/devtools-kitMoves @nuxt/devtools/iframe-client to @nuxt/devtools-kit/iframe-client.
@nuxt/devtools/iframe-client@nuxt/devtools-kit/iframe-clientAPI changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
interface NuxtHooks - removed:
property NuxtHooks.'devtools:before': () => void - removed:
property NuxtHooks.'devtools:customTabs': (tabs: ModuleCustomTab[]) => void - removed:
property NuxtHooks.'devtools:customTabs:refresh': () => void - removed:
property NuxtHooks.'devtools:initialized': () => void
- removed:
function useDevtoolsClient(): Ref<NuxtDevtoolsIframeClient | undefined>
- removed:
declare module '@nuxt/schema' - removed:
export { ModuleOptions } - added:
export { ModuleOptions } from '@nuxt/devtools-kit/types'
- removed:
interface AutoImportsWithMetadata - removed:
interface BasicModuleInfo - removed:
interface ClientFunctions - removed:
interface ComponentRelationship - removed:
interface GitHubContributor - removed:
interface HookInfo - removed:
interface MaintainerInfo - removed:
interface ModuleBuiltinTab - removed:
interface ModuleCompatibility - removed:
interface ModuleCustomTab - removed:
interface ModuleGlobalOptions - removed:
interface ModuleIframeTabLazyOptions - removed:
interface ModuleIframeView - removed:
interface ModuleLaunchAction - removed:
interface ModuleLaunchView - removed:
interface ModuleMetric - removed:
interface ModuleOptions - removed:
interface ModuleVNodeView - removed:
interface NuxtDevtoolsClient - removed:
interface NuxtDevtoolsClientHooks - removed:
interface NuxtDevtoolsGlobal - removed:
interface NuxtDevtoolsHostClient - removed:
interface NuxtDevtoolsIframeClient - removed:
interface Payload - removed:
interface RouteInfo extends Pick<RouteRecordNormalized, 'name' | 'path' | 'meta' | 'props' | 'children'> - removed:
interface ServerFunctions - removed:
interface UpdateInfo - removed:
interface VSCodeIntegrationOptions - removed:
interface VSCodeTunnelOptions - removed:
method ClientFunctions.callHook(hook: string, ...args: any[]): Promise<void> - removed:
method ClientFunctions.refresh(event: ClientUpdateEvent): void - removed:
method NuxtDevtoolsGlobal.setClient(client: NuxtDevtoolsHostClient): void - removed:
method NuxtDevtoolsHostClient.closeDevTools(): void - removed:
method NuxtDevtoolsHostClient.getClientHooksMetrics(): HookInfo[] - removed:
method ServerFunctions.customTabAction(name: string, action: number): Promise<boolean> - removed:
method ServerFunctions.getAutoImports(): AutoImportsWithMetadata - removed:
method ServerFunctions.getComponents(): Component[] - removed:
method ServerFunctions.getComponentsRelationships(): Promise<ComponentRelationship[]> - removed:
method ServerFunctions.getCustomTabs(): ModuleCustomTab[] - removed:
method ServerFunctions.getServerConfig(): NuxtOptions - removed:
method ServerFunctions.getServerHooks(): HookInfo[] - removed:
method ServerFunctions.getServerLayouts(): NuxtLayout[] - removed:
method ServerFunctions.getServerPages(): NuxtPage[] - removed:
method ServerFunctions.getStorageItem(key: string): Promise<StorageValue> - removed:
method ServerFunctions.getStorageKeys(base?: string): Promise<string[]> - removed:
method ServerFunctions.getStorageMounts(): Promise<StorageMounts> - removed:
method ServerFunctions.openInEditor(filepath: string): void - removed:
method ServerFunctions.removeStorageItem(key: string): Promise<void> - removed:
method ServerFunctions.runWizard<T extends WizardActions>(name: T, ...args: WizardArgs<T>): Promise<void> - removed:
method ServerFunctions.setStorageItem(key: string, value: StorageValue): Promise<void> - removed:
method ServerFunctions.usePackageVersions(): UpdateInfo[] - removed:
property AutoImportsWithMetadata.imports: Import[] - removed:
property AutoImportsWithMetadata.metadata?: UnimportMeta - removed:
property BasicModuleInfo.entryPath?: string - removed:
property BasicModuleInfo.meta?: { name?: string } - removed:
property ComponentRelationship.deps: string[] - removed:
property ComponentRelationship.id: string - removed:
property GitHubContributor.avatar_url?: string - removed:
property GitHubContributor.login: string - removed:
property GitHubContributor.name?: string - removed:
property HookInfo.duration?: number - removed:
property HookInfo.end?: number - removed:
property HookInfo.executions: number[] - removed:
property HookInfo.listeners: number - removed:
property HookInfo.name: string - removed:
property HookInfo.start: number - removed:
property MaintainerInfo.github: string - removed:
property MaintainerInfo.name: string - removed:
property MaintainerInfo.twitter?: string - removed:
property ModuleBuiltinTab.icon?: string - removed:
property ModuleBuiltinTab.name: string - removed:
property ModuleBuiltinTab.path?: string - removed:
property ModuleBuiltinTab.requireClient?: boolean - removed:
property ModuleBuiltinTab.title?: string - removed:
property ModuleCompatibility.nuxt: string - removed:
property ModuleCompatibility.requires: { bridge?: boolean | 'optional' } - removed:
property ModuleCustomTab.extraTabVNode?: VNode - removed:
property ModuleCustomTab.icon?: string - removed:
property ModuleCustomTab.name: string - removed:
property ModuleCustomTab.title: string - removed:
property ModuleCustomTab.view: ModuleView - removed:
property ModuleGlobalOptions.projects?: string[] - removed:
property ModuleIframeTabLazyOptions.description?: string - removed:
property ModuleIframeTabLazyOptions.onLoad?: () => Promise<void> - removed:
property ModuleIframeView.persistent?: boolean - removed:
property ModuleIframeView.src: string - removed:
property ModuleIframeView.type: 'iframe' - removed:
property ModuleLaunchAction.attrs?: Record<string, string> - removed:
property ModuleLaunchAction.handle?: () => void | Promise<void> - removed:
property ModuleLaunchAction.label: string - removed:
property ModuleLaunchAction.pending?: boolean - removed:
property ModuleLaunchAction.src?: string - removed:
property ModuleLaunchView.actions: ModuleLaunchAction[] - removed:
property ModuleLaunchView.description: string - removed:
property ModuleLaunchView.icon?: string - removed:
property ModuleLaunchView.title?: string - removed:
property ModuleLaunchView.type: 'launch' - removed:
property ModuleMetric.category: string - removed:
property ModuleMetric.compatibility: ModuleCompatibility - removed:
property ModuleMetric.contributors: GitHubContributor[] - removed:
property ModuleMetric.description: string - removed:
property ModuleMetric.github: string - removed:
property ModuleMetric.icon?: string - removed:
property ModuleMetric.learn_more: string - removed:
property ModuleMetric.maintainers: MaintainerInfo[] - removed:
property ModuleMetric.name: string - removed:
property ModuleMetric.npm: string - removed:
property ModuleMetric.repo: string - removed:
property ModuleMetric.type: ModuleType - removed:
property ModuleMetric.website: string - removed:
property ModuleOptions.componentInspector?: boolean - removed:
property ModuleOptions.enabled?: boolean - removed:
property ModuleOptions.viteInspect?: boolean - removed:
property ModuleOptions.vscode?: VSCodeIntegrationOptions - removed:
property ModuleVNodeView.type: 'vnode' - removed:
property ModuleVNodeView.vnode: VNode - removed:
property NuxtDevtoolsClient.colorMode: string - removed:
property NuxtDevtoolsClient.renderCodeHighlight: (code: string, lang: string, theme?: string) => string - removed:
property NuxtDevtoolsClient.renderMarkdown: (markdown: string) => string - removed:
property NuxtDevtoolsClient.rpc: BirpcReturn<ServerFunctions> - removed:
property NuxtDevtoolsClientHooks.'devtools:navigate': (path: string) => void - removed:
property NuxtDevtoolsClientHooks.'host:inspector:click': (baseUrl: string, file: string, line: number, column: number) => void - removed:
property NuxtDevtoolsClientHooks.'host:inspector:close': () => void - removed:
property NuxtDevtoolsClientHooks.'host:inspector:update': (data: VueInspectorData) => void - removed:
property NuxtDevtoolsClientHooks.'host:update:reactivity': () => void - removed:
property NuxtDevtoolsHostClient.appConfig: AppConfig - removed:
property NuxtDevtoolsHostClient.hooks: Hookable<NuxtDevtoolsClientHooks> - removed:
property NuxtDevtoolsHostClient.inspector?: { instance?: VueInspectorClient; enable: () => void; disable: () => void } - removed:
property NuxtDevtoolsHostClient.nuxt: NuxtApp - removed:
property NuxtDevtoolsIframeClient.devtools: NuxtDevtoolsClient - removed:
property NuxtDevtoolsIframeClient.host: NuxtDevtoolsHostClient - removed:
property Payload.data?: Record<string, any> - removed:
property Payload.functions?: Record<string, any> - removed:
property Payload.state?: Record<string, any> - removed:
property Payload.time: number - removed:
property Payload.url: string - removed:
property RouteInfo.file?: string - removed:
property UpdateInfo.current: string - removed:
property UpdateInfo.latest?: string - removed:
property UpdateInfo.name: string - removed:
property UpdateInfo.needsUpdate?: boolean - removed:
property VSCodeIntegrationOptions.enabled?: boolean - removed:
property VSCodeIntegrationOptions.mode?: 'local-serve' | 'tunnel' - removed:
property VSCodeIntegrationOptions.port?: number - removed:
property VSCodeIntegrationOptions.reuseExistingServer?: boolean - removed:
property VSCodeIntegrationOptions.startOnBoot?: boolean - removed:
property VSCodeIntegrationOptions.tunnel?: VSCodeTunnelOptions - removed:
property VSCodeTunnelOptions.name?: string - removed:
type ClientUpdateEvent = keyof ServerFunctions - removed:
type CompatibilityStatus = 'working' | 'wip' | 'unknown' | 'not-working' - removed:
type ModuleTabInfo = ModuleCustomTab | ModuleBuiltinTab - removed:
type ModuleType = 'community' | 'official' | '3rd-party' - removed:
type ModuleView = ModuleIframeView | ModuleLaunchView | ModuleVNodeView - removed:
type VueInspectorData = VueInspectorClient['linkParams'] & VueInspectorClient['position'] - added:
export * from '@nuxt/devtools-kit/types' - added:
property DevToolsUISettings.hiddenTabs: string[] - added:
property DevToolsUISettings.scale: number
- removed:
export * from './dist/iframe-client'