feat!: clean output dir by default

Author: sxzz

pnpm-lock.yaml

@@ -39,7 +39,7 @@ catalogs:
     hookable: ^5.5.3
     lightningcss: ^1.29.3
     rolldown: 1.0.0-beta.8-commit.151352b
-    rolldown-plugin-dts: ^0.9.4
+    rolldown-plugin-dts: ^0.9.5
     tinyexec: ^1.0.1
     tinyglobby: ^0.2.13
     unconfig: ^7.3.2

pnpm-workspace.yaml

@@ -1,29 +1,29 @@
-import { readdir } from 'node:fs/promises'
-import path from 'node:path'
 import Debug from 'debug'
 import { glob } from 'tinyglobby'
-import { fsExists, fsRemove } from '../utils/fs'
+import { fsRemove } from '../utils/fs'
 import { logger } from '../utils/logger'
+import type { ResolvedOptions } from '../options'
 
 const debug = Debug('tsdown:clean')
 
-// clean cwd dir + patterns
-export async function cleanOutDir(
-  cwd: string,
-  patterns: string[],
-): Promise<void> {
-  const files = []
+export async function cleanOutDir(configs: ResolvedOptions[]): Promise<void> {
+  const removes = new Set<string>()
 
-  if (await fsExists(cwd))
-    files.push(...(await readdir(cwd)).map((file) => path.resolve(cwd, file)))
-
-  if (patterns.length) {
-    files.push(...(await glob(patterns, { cwd, absolute: true })))
+  for (const config of configs) {
+    if (!config.clean.length) continue
+    const files = await glob(config.clean, { cwd: config.cwd, absolute: true })
+    for (const file of files) {
+      removes.add(file)
+    }
   }
+  if (!removes.size) return
 
-  logger.info('Cleaning output folder')
-  for (const file of files) {
-    debug('Removing', file)
-    await fsRemove(file)
-  }
+  logger.info('Cleaning %d files', removes.size)
+  await Promise.all(
+    [...removes].map(async (file) => {
+      debug('Removing', file)
+      await fsRemove(file)
+    }),
+  )
+  debug('Removed %d files', removes.size)
 }

src/features/clean.ts

@@ -55,7 +55,15 @@ export async function build(userOptions: Options = {}): Promise<void> {
     debug('No config file found')
   }
 
-  const rebuilds = await Promise.all(configs.map(buildSingle))
+  let cleanPromise: Promise<void> | undefined
+  const clean = () => {
+    if (cleanPromise) return cleanPromise
+    return (cleanPromise = cleanOutDir(configs))
+  }
+
+  const rebuilds = await Promise.all(
+    configs.map((options) => buildSingle(options, clean)),
+  )
   const cleanCbs: (() => Promise<void>)[] = []
 
   for (const [i, config] of configs.entries()) {
@@ -84,12 +92,16 @@ export const pkgRoot: string = path.resolve(dirname, '..')
 /**
  * Build a single configuration, without watch and shortcuts features.
  *
+ * Internal API, not for public use
+ *
+ * @private
  * @param config Resolved options
  */
 export async function buildSingle(
   config: ResolvedOptions,
+  clean: () => Promise<void>,
 ): Promise<(() => Promise<void>) | undefined> {
-  const { outDir, format: formats, clean, dts, watch, onSuccess } = config
+  const { format: formats, dts, watch, onSuccess } = config
   let onSuccessCleanup: (() => any) | undefined
 
   const pkg = await readPackageJson(process.cwd())
@@ -104,9 +116,9 @@ export async function buildSingle(
     const startTime = performance.now()
 
     await hooks.callHook('build:prepare', context)
-
     onSuccessCleanup?.()
-    if (clean) await cleanOutDir(outDir, clean)
+
+    await clean()
 
     let hasErrors = false
     await Promise.all(

src/index.ts

@@ -73,6 +73,11 @@ export interface Options {
   /** @default 'dist' */
   outDir?: string
   sourcemap?: Sourcemap
+  /**
+   * Clean directories before build.
+   *
+   * Default to output directory.
+   */
   clean?: boolean | string[]
   /** @default false */
   minify?: boolean | 'dce-only' | MinifyOptions
@@ -196,7 +201,7 @@ export type ResolvedOptions = Omit<
     {
       format: NormalizedFormat[]
       target?: string[]
-      clean: string[] | false
+      clean: string[]
       dts: false | DtsOptions
       report: false | ReportOptions
       tsconfig: string | false
@@ -223,7 +228,7 @@ export async function resolveOptions(options: Options): Promise<{
         entry,
         format = ['es'],
         plugins = [],
-        clean = false,
+        clean = true,
         silent = false,
         treeshake = true,
         platform = 'node',
@@ -243,8 +248,15 @@ export async function resolveOptions(options: Options): Promise<{
         env = {},
       } = subOptions
 
+      outDir = path.resolve(outDir)
       entry = await resolveEntry(entry, cwd)
-      if (clean === true) clean = []
+
+      if (clean === true) {
+        clean = [outDir]
+      } else if (!clean) {
+        clean = []
+      }
+
       if (publint === true) publint = {}
 
       if (tsconfig !== false) {
@@ -309,7 +321,7 @@ export async function resolveOptions(options: Options): Promise<{
         plugins,
         format: normalizeFormat(format),
         target: target ? resolveComma(toArray(target)) : undefined,
-        outDir: path.resolve(outDir),
+        outDir,
         clean,
         silent,
         treeshake,

src/options.ts

@@ -3,7 +3,6 @@ import { defineConfig } from './src/config.ts'
 export default defineConfig({
   entry: ['./src/{index,run,plugins,config}.ts'],
   target: 'node18',
-  clean: true,
   platform: 'node',
   skipNodeModulesBundle: true,
   shims: true,