feat!: enable dts based on typings field in package.json

Author: sxzz

src/cli.ts

@@ -33,7 +33,7 @@ cli
   .option('--platform <platform>', 'Target platform', {
     default: 'node',
   })
-  .option('--dts', 'Generate dts files', { default: false })
+  .option('--dts', 'Generate dts files')
   .option('--publint', 'Enable publint', { default: false })
   .option('--unused', 'Enable unused dependencies check', { default: false })
   .option('-w, --watch [path]', 'Watch mode')

src/features/clean.ts

@@ -2,7 +2,7 @@ import Debug from 'debug'
 import { glob } from 'tinyglobby'
 import { fsRemove } from '../utils/fs'
 import { logger } from '../utils/logger'
-import type { ResolvedOptions } from '../options'
+import type { Options, ResolvedOptions } from '../options'
 
 const debug = Debug('tsdown:clean')
 
@@ -27,3 +27,15 @@ export async function cleanOutDir(configs: ResolvedOptions[]): Promise<void> {
   )
   debug('Removed %d files', removes.size)
 }
+
+export function resolveClean(
+  clean: Options['clean'],
+  outDir: string,
+): string[] {
+  if (clean === true) {
+    clean = [outDir]
+  } else if (!clean) {
+    clean = []
+  }
+  return clean
+}

src/features/tsconfig.ts

@@ -0,0 +1,47 @@
+import path from 'node:path'
+import { underline } from 'ansis'
+import { up as findUp } from 'empathic/find'
+import { fsExists } from '../utils/fs'
+import { logger } from '../utils/logger'
+import type { Options } from '../options'
+
+export function findTsconfig(
+  cwd?: string,
+  name: string = 'tsconfig.json',
+): string | false {
+  return findUp(name, { cwd }) || false
+}
+
+export async function resolveTsconfig(
+  tsconfig: Options['tsconfig'],
+  cwd: string,
+): Promise<string | false> {
+  if (tsconfig !== false) {
+    if (tsconfig === true || tsconfig == null) {
+      const isSet = tsconfig
+      tsconfig = findTsconfig(cwd)
+      if (isSet && !tsconfig) {
+        logger.warn(`No tsconfig found in \`${cwd}\``)
+      }
+    } else {
+      const tsconfigPath = path.resolve(cwd, tsconfig)
+      if (await fsExists(tsconfigPath)) {
+        tsconfig = tsconfigPath
+      } else if (tsconfig.includes('\\') || tsconfig.includes('/')) {
+        logger.warn(`tsconfig \`${tsconfig}\` doesn't exist`)
+        tsconfig = false
+      } else {
+        tsconfig = findTsconfig(cwd, tsconfig)
+        if (!tsconfig) {
+          logger.warn(`No \`${tsconfig}\` found in \`${cwd}\``)
+        }
+      }
+    }
+
+    if (tsconfig) {
+      logger.info(`Using tsconfig: ${underline(path.relative(cwd, tsconfig))}`)
+    }
+  }
+
+  return tsconfig
+}

src/options.ts

@@ -5,12 +5,12 @@ import { pathToFileURL } from 'node:url'
 import { underline } from 'ansis'
 import Debug from 'debug'
 import { loadConfig } from 'unconfig'
+import { resolveClean } from './features/clean'
 import { resolveEntry } from './features/entry'
-import { fsExists } from './utils/fs'
+import { resolveTsconfig } from './features/tsconfig'
 import { resolveComma, toArray } from './utils/general'
 import { logger } from './utils/logger'
 import { normalizeFormat, readPackageJson } from './utils/package'
-import { findTsconfig } from './utils/tsconfig'
 import type { TsdownHooks } from './features/hooks'
 import type { OutExtensionFactory } from './features/output'
 import type { ReportOptions } from './features/report'
@@ -139,7 +139,11 @@ export interface Options {
 
   /// addons
   /**
-   * Emit declaration files
+   * Emit TypeScript declaration files (.d.ts).
+   *
+   * By default, this feature is auto-detected based on the presence of the `types` field in the `package.json` file.
+   * - If the `types` field is present in `package.json`, declaration file emission is enabled.
+   * - If the `types` field is absent, declaration file emission is disabled by default.
    */
   dts?: boolean | DtsOptions
 
@@ -242,7 +246,7 @@ export async function resolveOptions(options: Options): Promise<{
         platform = 'node',
         outDir = 'dist',
         sourcemap = false,
-        dts = false,
+        dts,
         unused = false,
         watch = false,
         shims = false,
@@ -258,44 +262,17 @@ export async function resolveOptions(options: Options): Promise<{
 
       outDir = path.resolve(outDir)
       entry = await resolveEntry(entry, cwd)
+      clean = resolveClean(clean, outDir)
+
+      const pkg = await readPackageJson(cwd)
 
-      if (clean === true) {
-        clean = [outDir]
-      } else if (!clean) {
-        clean = []
+      if (dts == null) {
+        dts = !!(pkg?.types || pkg?.typings)
       }
 
+      tsconfig = await resolveTsconfig(tsconfig, cwd)
       if (publint === true) publint = {}
 
-      if (tsconfig !== false) {
-        if (tsconfig === true || tsconfig == null) {
-          const isSet = tsconfig
-          tsconfig = findTsconfig(cwd)
-          if (isSet && !tsconfig) {
-            logger.warn(`No tsconfig found in \`${cwd}\``)
-          }
-        } else {
-          const tsconfigPath = path.resolve(cwd, tsconfig)
-          if (await fsExists(tsconfigPath)) {
-            tsconfig = tsconfigPath
-          } else if (tsconfig.includes('\\') || tsconfig.includes('/')) {
-            logger.warn(`tsconfig \`${tsconfig}\` doesn't exist`)
-            tsconfig = false
-          } else {
-            tsconfig = findTsconfig(cwd, tsconfig)
-            if (!tsconfig) {
-              logger.warn(`No \`${tsconfig}\` found in \`${cwd}\``)
-            }
-          }
-        }
-
-        if (tsconfig) {
-          logger.info(
-            `Using tsconfig: ${underline(path.relative(cwd, tsconfig))}`,
-          )
-        }
-      }
-
       if (fromVite) {
         const viteUserConfig = await loadViteConfig(
           fromVite === true ? 'vite' : fromVite,
@@ -323,8 +300,6 @@ export async function resolveOptions(options: Options): Promise<{
         }
       }
 
-      const pkg = await readPackageJson(cwd)
-
       const config: ResolvedOptions = {
         ...subOptions,
         entry,

src/utils/tsconfig.ts

@@ -56,6 +56,7 @@ export async function testBuild(
     entry: 'index.ts',
     config: false,
     outDir: 'dist',
+    dts: false,
     ...options,
   }
   await build(resolvedOptions)

tests/utils.ts

@@ -6,7 +6,6 @@ export default defineConfig({
   platform: 'node',
   skipNodeModulesBundle: true,
   shims: true,
-  dts: { isolatedDeclarations: true, resolve: [] },
   unused: { level: 'error' },
   publint: true,
   onSuccess() {