Skip to content

chore!: remove deprecated Devtool* APIs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
antfu merged 1 commit into from
May 12, 2026
Merged

chore!: remove deprecated Devtool* APIs #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions packages/devframe/src/client/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,3 @@ export * from './rpc'
export * from './rpc-streaming'

export const connectDevframe = getDevToolsRpcClient

let warnedConnectDevtool = false
/** @deprecated Use `connectDevframe`. */
export function connectDevtool(...args: Parameters<typeof getDevToolsRpcClient>): ReturnType<typeof getDevToolsRpcClient> {
if (!warnedConnectDevtool) {
warnedConnectDevtool = true
console.warn('[devframe] `connectDevtool` is deprecated; use `connectDevframe` instead.')
}
return getDevToolsRpcClient(...args)
}
27 changes: 0 additions & 27 deletions packages/devframe/src/types/devframe.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,30 +130,3 @@ export interface DevframeDefinition {
export function defineDevframe(d: DevframeDefinition): DevframeDefinition {
return d
}

// --- Deprecated aliases (backward compatibility) ---

/** @deprecated Use `DevframeRuntime`. */
export type DevtoolRuntime = DevframeRuntime
/** @deprecated Use `DevframeDeploymentKind`. */
export type DevtoolDeploymentKind = DevframeDeploymentKind
/** @deprecated Use `DevframeCliOptions`. */
export type DevtoolCliOptions = DevframeCliOptions
/** @deprecated Use `DevframeSpaOptions`. */
export type DevtoolSpaOptions = DevframeSpaOptions
/** @deprecated Use `DevframeBrowserContext`. */
export type DevtoolBrowserContext = DevframeBrowserContext
/** @deprecated Use `DevframeSetupInfo`. */
export type DevtoolSetupInfo = DevframeSetupInfo
/** @deprecated Use `DevframeDefinition`. */
export type DevtoolDefinition = DevframeDefinition

let warnedDefineDevtool = false
/** @deprecated Use `defineDevframe`. */
export function defineDevtool(d: DevframeDefinition): DevframeDefinition {
if (!warnedDefineDevtool) {
warnedDefineDevtool = true
console.warn('[devframe] `defineDevtool` is deprecated; use `defineDevframe` instead.')
}
return d
}
1 change: 0 additions & 1 deletion tests/__snapshots__/tsnapi/devframe/client.snapshot.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ export type DevToolsRpcClientCallOptional = BirpcReturn<DevToolsRpcServerFunctio
// #endregion

// #region Functions
export declare function connectDevtool(..._: Parameters<typeof getDevToolsRpcClient>): ReturnType<typeof getDevToolsRpcClient>;
export declare function createRpcStreamingClientHost(_: DevToolsRpcClient): RpcStreamingClientHost;
export declare function getDevToolsRpcClient(_?: DevToolsRpcClientOptions): Promise<DevToolsRpcClient>;
// #endregion
Expand Down
1 change: 0 additions & 1 deletion tests/__snapshots__/tsnapi/devframe/client.snapshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* Generated by tsnapi — public API snapshot of `devframe/client`
*/
// #region Functions
export function connectDevtool(..._) {}
export function createRpcStreamingClientHost(_) {}
export async function getDevToolsRpcClient(_) {}
// #endregion
Expand Down
8 changes: 0 additions & 8 deletions tests/__snapshots__/tsnapi/devframe/index.snapshot.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,31 +15,23 @@ export { AgentTool }
export { AgentToolInput }
export { ConnectionMeta }
export { defineDevframe }
export { defineDevtool }
export { DevframeBrowserContext }
export { DevframeCliOptions }
export { DevframeDefinition }
export { DevframeDeploymentKind }
export { DevframeRuntime }
export { DevframeSetupInfo }
export { DevframeSpaOptions }
export { DevtoolBrowserContext }
export { DevtoolCliOptions }
export { DevtoolDefinition }
export { DevtoolDeploymentKind }
export { DevtoolRuntime }
export { DevToolsAgentHost }
export { DevToolsAgentHostEvents }
export { DevToolsCapabilities }
export { DevToolsDiagnosticsDefinition }
export { DevToolsDiagnosticsHost }
export { DevToolsDiagnosticsLogger }
export { DevtoolSetupInfo }
export { DevToolsHost }
export { DevToolsNodeContext }
export { DevToolsNodeRpcSession }
export { DevToolsNodeRpcSessionMeta }
export { DevtoolSpaOptions }
export { DevToolsRpcClientFunctions }
export { DevToolsRpcServerFunctions }
export { DevToolsRpcSharedStates }
Expand Down
8 changes: 0 additions & 8 deletions tests/__snapshots__/tsnapi/devframe/types.snapshot.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,23 @@ export { AgentTool }
export { AgentToolInput }
export { ConnectionMeta }
export { defineDevframe }
export { defineDevtool }
export { DevframeBrowserContext }
export { DevframeCliOptions }
export { DevframeDefinition }
export { DevframeDeploymentKind }
export { DevframeRuntime }
export { DevframeSetupInfo }
export { DevframeSpaOptions }
export { DevtoolBrowserContext }
export { DevtoolCliOptions }
export { DevtoolDefinition }
export { DevtoolDeploymentKind }
export { DevtoolRuntime }
export { DevToolsAgentHost }
export { DevToolsAgentHostEvents }
export { DevToolsCapabilities }
export { DevToolsDiagnosticsDefinition }
export { DevToolsDiagnosticsHost }
export { DevToolsDiagnosticsLogger }
export { DevtoolSetupInfo }
export { DevToolsHost }
export { DevToolsNodeContext }
export { DevToolsNodeRpcSession }
export { DevToolsNodeRpcSessionMeta }
export { DevtoolSpaOptions }
export { DevToolsRpcClientFunctions }
export { DevToolsRpcServerFunctions }
export { DevToolsRpcSharedStates }
Expand Down
1 change: 0 additions & 1 deletion tests/__snapshots__/tsnapi/devframe/types.snapshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@
*/
// #region Functions
export function defineDevframe(_) {}
export function defineDevtool(_) {}
// #endregion
Loading