feat(devtools)!: rename debug to devtools, rename debug.devtools to devtools.ui

Author: sxzz

dts.snapshot.json

@@ -26,7 +26,7 @@
     "CopyOptions": "type CopyOptions = Arrayable<string | CopyEntry>",
     "CopyOptionsFn": "type CopyOptionsFn = (_: ResolvedConfig) => Awaitable<CopyOptions>",
     "CssOptions": "interface CssOptions {\n splitting?: boolean\n fileName?: string\n}",
-    "DebugOptions": "interface DebugOptions extends NonNullable<InputOptions['debug']> {\n devtools?: boolean | Partial<StartOptions>\n clean?: boolean\n}",
+    "DevtoolsOptions": "interface DevtoolsOptions extends NonNullable<InputOptions['devtools']> {\n ui?: boolean | Partial<StartOptions>\n clean?: boolean\n}",
     "ExportsOptions": "interface ExportsOptions {\n devExports?: boolean | string\n packageJson?: boolean\n all?: boolean\n exclude?: (RegExp | string)[]\n customExports?: (_: Record<string, any>, _: { pkg: PackageJson; chunks: ChunksByFormat; isPublish: boolean }) => Awaitable<Record<string, any>>\n}",
     "Format": "type Format = ModuleFormat",
     "globalLogger": "Logger",
@@ -58,14 +58,14 @@
     "PublintOptions": "interface PublintOptions extends Options {}",
     "ReportOptions": "interface ReportOptions {\n gzip?: boolean\n brotli?: boolean\n maxCompressSize?: number\n}",
     "ReportPlugin": "declare function ReportPlugin(_: ReportOptions, _: Logger, _: string, _: boolean, _: string, _: boolean): Plugin",
-    "ResolvedConfig": "type ResolvedConfig = Overwrite<MarkPartial<Omit<UserConfig, 'workspace' | 'fromVite' | 'publicDir' | 'silent' | 'bundle' | 'removeNodeProtocol' | 'logLevel' | 'failOnWarn' | 'customLogger' | 'envFile' | 'envPrefix'>, 'globalName' | 'inputOptions' | 'outputOptions' | 'minify' | 'define' | 'alias' | 'external' | 'onSuccess' | 'outExtensions' | 'hooks' | 'copy' | 'loader' | 'name' | 'banner' | 'footer'>, { entry: Record<string, string>; nameLabel: string | undefined; format: NormalizedFormat; target?: string[]; clean: string[]; pkg?: PackageJsonWithPath; nodeProtocol: 'strip' | boolean; logger: Logger; ignoreWatch: Array<string | RegExp>; noExternal?: NoExternalFn; inlineOnly?: Array<string | RegExp>; css: Required<CssOptions>; dts: false | DtsOptions; report: false | ReportOptions; tsconfig: false | string; exports: false | ExportsOptions; debug: false | DebugOptions; publint: false | PublintOptions; attw: false | AttwOptions; unused: false | UnusedOptions }>",
+    "ResolvedConfig": "type ResolvedConfig = Overwrite<MarkPartial<Omit<UserConfig, 'workspace' | 'fromVite' | 'publicDir' | 'silent' | 'bundle' | 'removeNodeProtocol' | 'logLevel' | 'failOnWarn' | 'customLogger' | 'envFile' | 'envPrefix'>, 'globalName' | 'inputOptions' | 'outputOptions' | 'minify' | 'define' | 'alias' | 'external' | 'onSuccess' | 'outExtensions' | 'hooks' | 'copy' | 'loader' | 'name' | 'banner' | 'footer'>, { entry: Record<string, string>; nameLabel: string | undefined; format: NormalizedFormat; target?: string[]; clean: string[]; pkg?: PackageJsonWithPath; nodeProtocol: 'strip' | boolean; logger: Logger; ignoreWatch: Array<string | RegExp>; noExternal?: NoExternalFn; inlineOnly?: Array<string | RegExp>; css: Required<CssOptions>; dts: false | DtsOptions; report: false | ReportOptions; tsconfig: false | string; exports: false | ExportsOptions; devtools: false | DevtoolsOptions; publint: false | PublintOptions; attw: false | AttwOptions; unused: false | UnusedOptions }>",
     "RolldownChunk": "type RolldownChunk = (OutputChunk | OutputAsset) & { outDir: string }",
     "RolldownContext": "interface RolldownContext {\n buildOptions: BuildOptions\n}",
     "Sourcemap": "type Sourcemap = boolean | 'inline' | 'hidden'",
     "TsdownBundle": "interface TsdownBundle extends AsyncDisposable {\n chunks: RolldownChunk[]\n config: ResolvedConfig\n}",
     "TsdownHooks": "interface TsdownHooks {\n 'build:prepare': (_: BuildContext) => void | Promise<void>\n 'build:before': (_: BuildContext & RolldownContext) => void | Promise<void>\n 'build:done': (_: BuildContext & { chunks: RolldownChunk[] }) => void | Promise<void>\n}",
     "TsdownInputOption": "type TsdownInputOption = string | string[] | Record<string, string | string[]>",
-    "UserConfig": "interface UserConfig {\n entry?: TsdownInputOption\n external?: ExternalOption\n noExternal?: Arrayable<string | RegExp> | NoExternalFn\n inlineOnly?: Arrayable<string | RegExp>\n skipNodeModulesBundle?: boolean\n alias?: Record<string, string>\n tsconfig?: string | boolean\n platform?: 'node' | 'neutral' | 'browser'\n target?: string | string[] | false\n env?: Record<string, any>\n envFile?: string\n envPrefix?: string | string[]\n define?: Record<string, string>\n shims?: boolean\n treeshake?: boolean | TreeshakingOptions\n loader?: ModuleTypes\n removeNodeProtocol?: boolean\n nodeProtocol?: 'strip' | boolean\n plugins?: InputOptions['plugins']\n inputOptions?: InputOptions | ((_: InputOptions, _: NormalizedFormat, _: { cjsDts: boolean }) => Awaitable<InputOptions | void | null>)\n format?: Format | Format[] | Partial<Record<Format, Partial<ResolvedConfig>>>\n globalName?: string\n outDir?: string\n write?: boolean\n sourcemap?: Sourcemap\n clean?: boolean | string[]\n minify?: boolean | 'dce-only' | MinifyOptions\n footer?: ChunkAddon\n banner?: ChunkAddon\n unbundle?: boolean\n bundle?: boolean\n fixedExtension?: boolean\n outExtensions?: OutExtensionFactory\n hash?: boolean\n cjsDefault?: boolean\n outputOptions?: OutputOptions | ((_: OutputOptions, _: NormalizedFormat, _: { cjsDts: boolean }) => Awaitable<OutputOptions | void | null>)\n cwd?: string\n name?: string\n silent?: boolean\n logLevel?: LogLevel\n failOnWarn?: boolean | CIOption\n customLogger?: Logger\n fromVite?: boolean | 'vitest'\n watch?: boolean | Arrayable<string>\n ignoreWatch?: Arrayable<string | RegExp>\n debug?: WithEnabled<DebugOptions>\n onSuccess?: string | ((_: ResolvedConfig, _: AbortSignal) => void | Promise<void>)\n dts?: WithEnabled<DtsOptions>\n unused?: WithEnabled<UnusedOptions>\n publint?: WithEnabled<PublintOptions>\n attw?: WithEnabled<AttwOptions>\n report?: WithEnabled<ReportOptions>\n globImport?: boolean\n exports?: WithEnabled<ExportsOptions>\n css?: CssOptions\n publicDir?: CopyOptions | CopyOptionsFn\n copy?: CopyOptions | CopyOptionsFn\n hooks?: Partial<TsdownHooks> | ((_: Hookable<TsdownHooks>) => Awaitable<void>)\n workspace?: Workspace | Arrayable<string> | true\n}",
+    "UserConfig": "interface UserConfig {\n entry?: TsdownInputOption\n external?: ExternalOption\n noExternal?: Arrayable<string | RegExp> | NoExternalFn\n inlineOnly?: Arrayable<string | RegExp>\n skipNodeModulesBundle?: boolean\n alias?: Record<string, string>\n tsconfig?: string | boolean\n platform?: 'node' | 'neutral' | 'browser'\n target?: string | string[] | false\n env?: Record<string, any>\n envFile?: string\n envPrefix?: string | string[]\n define?: Record<string, string>\n shims?: boolean\n treeshake?: boolean | TreeshakingOptions\n loader?: ModuleTypes\n removeNodeProtocol?: boolean\n nodeProtocol?: 'strip' | boolean\n plugins?: InputOptions['plugins']\n inputOptions?: InputOptions | ((_: InputOptions, _: NormalizedFormat, _: { cjsDts: boolean }) => Awaitable<InputOptions | void | null>)\n format?: Format | Format[] | Partial<Record<Format, Partial<ResolvedConfig>>>\n globalName?: string\n outDir?: string\n write?: boolean\n sourcemap?: Sourcemap\n clean?: boolean | string[]\n minify?: boolean | 'dce-only' | MinifyOptions\n footer?: ChunkAddon\n banner?: ChunkAddon\n unbundle?: boolean\n bundle?: boolean\n fixedExtension?: boolean\n outExtensions?: OutExtensionFactory\n hash?: boolean\n cjsDefault?: boolean\n outputOptions?: OutputOptions | ((_: OutputOptions, _: NormalizedFormat, _: { cjsDts: boolean }) => Awaitable<OutputOptions | void | null>)\n cwd?: string\n name?: string\n silent?: boolean\n logLevel?: LogLevel\n failOnWarn?: boolean | CIOption\n customLogger?: Logger\n fromVite?: boolean | 'vitest'\n watch?: boolean | Arrayable<string>\n ignoreWatch?: Arrayable<string | RegExp>\n devtools?: WithEnabled<DevtoolsOptions>\n onSuccess?: string | ((_: ResolvedConfig, _: AbortSignal) => void | Promise<void>)\n dts?: WithEnabled<DtsOptions>\n unused?: WithEnabled<UnusedOptions>\n publint?: WithEnabled<PublintOptions>\n attw?: WithEnabled<AttwOptions>\n report?: WithEnabled<ReportOptions>\n globImport?: boolean\n exports?: WithEnabled<ExportsOptions>\n css?: CssOptions\n publicDir?: CopyOptions | CopyOptionsFn\n copy?: CopyOptions | CopyOptionsFn\n hooks?: Partial<TsdownHooks> | ((_: Hookable<TsdownHooks>) => Awaitable<void>)\n workspace?: Workspace | Arrayable<string> | true\n}",
     "UserConfigExport": "type UserConfigExport = Awaitable<Arrayable<UserConfig> | UserConfigFn>",
     "UserConfigFn": "type UserConfigFn = (_: InlineConfig, _: { ci: boolean }) => Awaitable<Arrayable<UserConfig>>",
     "WithEnabled": "type WithEnabled<T> = boolean | undefined | CIOption | (T & { enabled?: boolean | CIOption })",
@@ -84,7 +84,7 @@
       "CopyOptions",
       "CopyOptionsFn",
       "CssOptions",
-      "DebugOptions",
+      "DevtoolsOptions",
       "DtsOptions",
       "ExportsOptions",
       "Format",

src/cli.ts

@@ -29,7 +29,7 @@ cli
   .option('--clean', 'Clean output directory, --no-clean to disable')
   .option('--external <module>', 'Mark dependencies as external')
   .option('--minify', 'Minify output')
-  .option('--debug', 'Enable debug mode')
+  .option('--devtools', 'Enable devtools integration')
   .option('--debug-logs [feat]', 'Show debug logs')
   .option('--target <target>', 'Bundle target, e.g "es2015", "esnext"')
   .option('-l, --logLevel <level>', 'Set log level: info, warn, error, silent')

src/config/options.ts

@@ -85,7 +85,7 @@ export async function resolveUserConfig(
     inlineOnly,
     css,
     fixedExtension = platform === 'node',
-    debug = false,
+    devtools = false,
     write = true,
   } = userConfig
 
@@ -236,15 +236,15 @@ export async function resolveUserConfig(
     inlineOnly = toArray(inlineOnly)
   }
 
-  debug = resolveFeatureOption(debug, {})
-  if (debug) {
+  devtools = resolveFeatureOption(devtools, {})
+  if (devtools) {
     if (watch) {
-      if (debug.devtools) {
-        logger.warn('Devtools is not supported in watch mode, disabling it.')
+      if (devtools.ui) {
+        logger.warn('Devtools UI is not supported in watch mode, disabling it.')
       }
-      debug.devtools = false
+      devtools.ui = false
     } else {
-      debug.devtools ??= !!pkgExists('@vitejs/devtools/cli')
+      devtools.ui ??= !!pkgExists('@vitejs/devtools/cli')
     }
   }
 
@@ -258,7 +258,7 @@ export async function resolveUserConfig(
     copy: publicDir || copy,
     css: resolveCssOptions(css),
     cwd,
-    debug,
+    devtools,
     dts,
     entry: resolvedEntry,
     env,

src/config/types.ts

@@ -1,6 +1,6 @@
 import type { CopyEntry, CopyOptions, CopyOptionsFn } from '../features/copy.ts'
 import type { CssOptions } from '../features/css.ts'
-import type { DebugOptions } from '../features/debug.ts'
+import type { DevtoolsOptions } from '../features/devtools.ts'
 import type {
   BuildContext,
   RolldownContext,
@@ -77,7 +77,7 @@ export type {
   CopyOptions,
   CopyOptionsFn,
   CssOptions,
-  DebugOptions,
+  DevtoolsOptions,
   DtsOptions,
   ExportsOptions,
   OutExtensionContext,
@@ -437,15 +437,15 @@ export interface UserConfig {
   ignoreWatch?: Arrayable<string | RegExp>
 
   /**
-   * **[experimental]** Enable debug mode.
+   * **[experimental]** Enable devtools.
    *
-   * Both debug mode and Vite DevTools are still under development, and this is for early testers only.
+   *DevTools is still under development, and this is for early testers only.
    *
    * This may slow down the build process significantly.
    *
    * @default false
    */
-  debug?: WithEnabled<DebugOptions>
+  devtools?: WithEnabled<DevtoolsOptions>
 
   //#region Addons
 
@@ -621,7 +621,7 @@ export type ResolvedConfig = Overwrite<
     report: false | ReportOptions
     tsconfig: false | string
     exports: false | ExportsOptions
-    debug: false | DebugOptions
+    devtools: false | DevtoolsOptions
     publint: false | PublintOptions
     attw: false | AttwOptions
     unused: false | UnusedOptions

src/features/clean.ts

@@ -15,8 +15,8 @@ export async function cleanOutDir(configs: ResolvedConfig[]): Promise<void> {
   const removes = new Set<string>()
 
   for (const config of configs) {
-    if (config.debug && (config.debug.clean ?? true)) {
-      config.clean.push('.rolldown')
+    if (config.devtools && (config.devtools.clean ?? true)) {
+      config.clean.push('node_modules/.rolldown')
     }
 
     if (!config.clean.length) continue

src/features/debug.ts

@@ -1,26 +1,8 @@
 import { createDebug, enable, namespaces } from 'obug'
 import { resolveComma, toArray } from '../utils/general.ts'
-import type { StartOptions } from '@vitejs/devtools/cli-commands'
-import type { InputOptions } from 'rolldown'
 
 const debug = createDebug('tsdown:debug')
 
-export interface DebugOptions extends NonNullable<InputOptions['debug']> {
-  /**
-   * **[experimental]** Enable devtools integration. `@vitejs/devtools` must be installed as a dependency.
-   *
-   * Defaults to true, if `@vitejs/devtools` is installed.
-   */
-  devtools?: boolean | Partial<StartOptions>
-
-  /**
-   * Clean devtools stale sessions.
-   *
-   * @default true
-   */
-  clean?: boolean
-}
-
 export function enableDebugLog(cliOptions: Record<string, any>): void {
   const { debugLogs } = cliOptions
   if (!debugLogs) return

src/features/devtools.ts

@@ -0,0 +1,30 @@
+import { importWithError } from '../utils/general.ts'
+import type { StartOptions } from '@vitejs/devtools/cli-commands'
+import type { InputOptions } from 'rolldown'
+
+export interface DevtoolsOptions extends NonNullable<InputOptions['devtools']> {
+  /**
+   * **[experimental]** Enable devtools integration. `@vitejs/devtools` must be installed as a dependency.
+   *
+   * Defaults to true, if `@vitejs/devtools` is installed.
+   */
+  ui?: boolean | Partial<StartOptions>
+
+  /**
+   * Clean devtools stale sessions.
+   *
+   * @default true
+   */
+  clean?: boolean
+}
+
+export async function startDevtoolsUI(config: DevtoolsOptions): Promise<void> {
+  const { start } = await importWithError<
+    typeof import('@vitejs/devtools/cli-commands')
+  >('@vitejs/devtools/cli-commands')
+  await start({
+    host: '127.0.0.1',
+    open: true,
+    ...(typeof config.ui === 'object' ? config.ui : {}),
+  })
+}

src/features/rolldown.ts

@@ -85,7 +85,7 @@ async function resolveInputOptions(
     alias,
     cjsDefault,
     cwd,
-    debug,
+    devtools,
     dts,
     entry,
     env,
@@ -217,7 +217,7 @@ async function resolveInputOptions(
             defaultHandler(level, log)
           }
         : undefined,
-      debug: debug || undefined,
+      devtools: devtools || undefined,
       checks: {
         pluginTimings: false,
       },

src/index.ts

@@ -10,13 +10,13 @@ import {
 } from 'rolldown'
 import {
   resolveConfig,
-  type DebugOptions,
   type InlineConfig,
   type ResolvedConfig,
 } from './config/index.ts'
 import { warnLegacyCJS } from './features/cjs.ts'
 import { cleanChunks, cleanOutDir } from './features/clean.ts'
 import { copy } from './features/copy.ts'
+import { startDevtoolsUI } from './features/devtools.ts'
 import { createHooks, executeOnSuccess } from './features/hooks.ts'
 import { bundleDone, initBundleByPkg } from './features/pkg/index.ts'
 import {
@@ -31,7 +31,7 @@ import {
   type RolldownChunk,
   type TsdownBundle,
 } from './utils/chunks.ts'
-import { importWithError } from './utils/general.ts'
+import { typeAssert } from './utils/general.ts'
 import { globalLogger } from './utils/logger.ts'
 
 const asyncDispose: typeof Symbol.asyncDispose =
@@ -88,7 +88,7 @@ export async function build(
   )
 
   const firstDevtoolsConfig = configs.find(
-    (config) => config.debug && config.debug.devtools,
+    (config) => config.devtools && config.devtools.ui,
   )
 
   const hasWatchConfig = configs.some((config) => config.watch)
@@ -99,17 +99,9 @@ export async function build(
       disposeCbs.push(bundle[asyncDispose])
     }
   } else if (firstDevtoolsConfig) {
+    typeAssert(firstDevtoolsConfig.devtools)
     // build done, start devtools
-    const { start } = await importWithError<
-      typeof import('@vitejs/devtools/cli-commands')
-    >('@vitejs/devtools/cli-commands')
-
-    const devtoolsOptions = (firstDevtoolsConfig.debug as DebugOptions).devtools
-    await start({
-      host: '127.0.0.1',
-      open: true,
-      ...(typeof devtoolsOptions === 'object' ? devtoolsOptions : {}),
-    })
+    startDevtoolsUI(firstDevtoolsConfig.devtools)
   }
 
   return bundles

src/utils/general.ts

@@ -1,5 +1,5 @@
-import picomatch from 'picomatch'
 import { pathToFileURL } from 'node:url'
+import picomatch from 'picomatch'
 
 export function toArray<T>(
   val: T | T[] | null | undefined,