Interface: UserConfig

Defined in: src/config/types.ts:153

Options for tsdown.

Extended by

• InlineConfig

Properties

alias?

optional alias?: Record<string, string>;

Defined in: src/config/types.ts:175

---

attw?

optional attw?: WithEnabled<AttwOptions>;

Defined in: src/config/types.ts:573

Run arethetypeswrong after bundling. Requires @arethetypeswrong/core to be installed.

Default

false

See

https://github.com/arethetypeswrong/arethetypeswrong.github.io

---

banner?

optional banner?: ChunkAddon;

Defined in: src/config/types.ts:400

---

checks?

optional checks?: ChecksOptions & object;

Defined in: src/config/types.ts:329

Controls which warnings are emitted during the build process. Each option can be set to true (emit warning) or false (suppress warning).

Type Declaration

legacyCjs?

optional legacyCjs?: boolean;

If the config includes the cjs format and one of its targets is a Node.js version that supports require(esm) (^20.19.0 || >=22.12.0), warn the user about the deprecation of CommonJS.

Default

true

---

cjsDefault?

optional cjsDefault?: boolean;

Defined in: src/config/types.ts:450

Converts a single default export from an explicit CJS entry module to module.exports. It does not apply to non-entry chunks emitted in unbundle mode.

Default

true

---

clean?

optional clean?: boolean | string[];

Defined in: src/config/types.ts:394

Clean directories before build.

Default to output directory.

Default

true

---

copy?

optional copy?:
  | CopyOptions
  | CopyOptionsFn;

Defined in: src/config/types.ts:617

Copy files to another directory.

Example

;[
  'src/assets',
  'src/env.d.ts',
  'src/styles/**/*.css',
  { from: 'src/assets', to: 'dist/assets' },
  { from: 'src/styles/**/*.css', to: 'dist', flatten: true },
]

---

css?

optional css?: CssOptions;

Defined in: src/config/types.ts:602

[experimental] CSS options. Requires @tsdown/css to be installed.

---

customLogger?

optional customLogger?: Logger;

Defined in: src/config/types.ts:503

Custom logger.

---

cwd?

optional cwd?: string;

Defined in: src/config/types.ts:473

The working directory of the config file.

• Defaults to process.cwd | process.cwd() for root config.
• Defaults to the package directory for workspace config.

Default

process.cwd()

---

define?

optional define?: Record<string, string>;

Defined in: src/config/types.ts:250

---

deps?

optional deps?: DepsConfig;

Defined in: src/config/types.ts:173

Dependency handling options.

---

devtools?

optional devtools?: WithEnabled<DevtoolsOptions>;

Defined in: src/config/types.ts:532

[experimental] Enable devtools.

DevTools is still under development, and this is for early testers only.

This may slow down the build process significantly.

Default

false

---

dts?

optional dts?: WithEnabled<DtsOptions>;

Defined in: src/config/types.ts:550

Enables generation of TypeScript declaration files (.d.ts).

By default, this option is auto-detected:

• If exe is enabled, declaration file generation is disabled by default.
• If the types or typings field is present in package.json, or if its exports field contains a types entry, declaration file generation is enabled by default.
• Otherwise, if the resolved tsconfig.json has declaration: true, declaration file generation is enabled by default.
• Otherwise, declaration file generation is disabled by default.

---

entry?

optional entry?: TsdownInputOption;

Defined in: src/config/types.ts:168

Defaults to 'src/index.ts' if it exists.

Supports glob patterns with negation to exclude files:

Example

entry: {
  "hooks/*": ["./src/hooks/*.ts", "!./src/hooks/index.ts"],
}

Default

{
  index: 'src/index.ts'
}

---

env?

optional env?: Record<string, any>;

Defined in: src/config/types.ts:238

Compile-time env variables, which can be accessed via import.meta.env or process.env.

Example

{
  "DEBUG": true,
  "NODE_ENV": "production"
}

Default

{
}

---

envFile?

optional envFile?: string;

Defined in: src/config/types.ts:244

Path to env file providing compile-time env variables.

Example

`.env`, `.env.production`, etc.

---

envPrefix?

optional envPrefix?: string | string[];

Defined in: src/config/types.ts:249

When loading env variables from envFile, only include variables with these prefixes.

Default

'TSDOWN_'

---

exe?

optional exe?: WithEnabled<ExeOptions>;

Defined in: src/config/types.ts:630

[experimental] Bundle as executable using Node.js SEA (Single Executable Applications).

This will bundle the output into a single executable file using Node.js SEA. Note that this is only supported on Node.js 25.7.0 and later, and is not supported in Bun or Deno.

Default

false

---

exports?

optional exports?: WithEnabled<ExportsOptions>;

Defined in: src/config/types.ts:596

Generate package exports for package.json.

This will set the exports field in package.json to point to the generated files.

Default

false

---

external?

optional external?: string | RegExp | (string | RegExp)[] | ExternalOptionFunction;

Defined in: src/config/types.ts:646

Cannot be combined with deps.neverBundle; setting both throws an error.

Deprecated

Use deps.neverBundle instead.

---

failOnWarn?

optional failOnWarn?: boolean | CIOption;

Defined in: src/config/types.ts:491

If true, fails the build on warnings.

Default

false

---

fixedExtension?

optional fixedExtension?: boolean;

Defined in: src/config/types.ts:429

Use a fixed extension for output files. The extension will always be .cjs or .mjs. Otherwise, it will depend on the package type.

Defaults to true if platform is set to node, false otherwise.

Default

platform === 'node'

---

footer?

optional footer?: ChunkAddon;

Defined in: src/config/types.ts:399

---

format?

optional format?:
  | "es" | "cjs" | "iife" | "umd" | "commonjs" | "module" | "esm"
  | ("es" | "cjs" | "iife" | "umd" | "commonjs" | "module" | "esm")[]
| Partial<Record<"es" | "cjs" | "iife" | "umd" | "commonjs" | "module" | "esm", Partial<ResolvedConfig>>>;

Defined in: src/config/types.ts:366

Output format(s). Available formats are

• esm: ESM
• cjs: CommonJS
• iife: IIFE
• umd: UMD

Default

'esm'

---

fromVite?

optional fromVite?: boolean | "vitest";

Defined in: src/config/types.ts:512

Reuse config from Vite or Vitest (experimental)

Default

false

---

globalName?

optional globalName?: string;

Defined in: src/config/types.ts:367

---

globImport?

optional globImport?: boolean;

Defined in: src/config/types.ts:586

import.meta.glob support.

See

https://vite.dev/guide/features.html#glob-import

Default

true

---

hash?

optional hash?: boolean;

Defined in: src/config/types.ts:441

If enabled, appends hash to chunk filenames.

Default

true

---

hooks?

optional hooks?:
  | Partial<TsdownHooks>
  | ((hooks) => Awaitable<void>);

Defined in: src/config/types.ts:619

---

ignoreWatch?

optional ignoreWatch?: Arrayable<string | RegExp>;

Defined in: src/config/types.ts:521

Files or patterns to not watch while in watch mode.

---

inputOptions?

optional inputOptions?:
  | InputOptions
  | ((options, format, context) => Awaitable<void | InputOptions | null>);

Defined in: src/config/types.ts:346

Use with caution; ensure you understand the implications.

---

loader?

optional loader?: ModuleTypes;

Defined in: src/config/types.ts:280

Sets how input files are processed. For example, use 'js' to treat files as JavaScript or 'base64' for images. Lets you import or require files like images or fonts.

Example

{ ".jpg": "asset", ".png": "base64" }

---

logLevel?

optional logLevel?: LogLevel;

Defined in: src/config/types.ts:486

Log level.

Default

'info'

---

minify?

optional minify?: boolean | "dce-only" | MinifyOptions;

Defined in: src/config/types.ts:398

Default

false

---

name?

optional name?: string;

Defined in: src/config/types.ts:480

The name to show in CLI output. This is useful for monorepos or workspaces. When using workspace mode, this option defaults to the package name from package.json. In non-workspace mode, this option must be set explicitly for the name to show in the CLI output.

---

nodeProtocol?

optional nodeProtocol?: boolean | "strip";

Defined in: src/config/types.ts:324

Control whether built-in Node.js module imports use the node: protocol.

• true: Add the node: prefix to built-in module imports.
• 'strip': Remove the node: prefix from built-in module imports.
• false: Do not transform built-in module imports.

Default

false

Examples

`nodeProtocol: true` — add the `node:` prefix

// Input
import 'fs'

// Output
import 'node:fs'

`nodeProtocol: 'strip'` — remove the `node:` prefix

// Input
import 'node:fs'

// Output
import 'fs'

`nodeProtocol: false` — do not transform imports

// Input
import 'node:fs'

// Output
import 'node:fs'

---

noExternal?

optional noExternal?:
  | Arrayable<string | RegExp>
  | NoExternalFn;

Defined in: src/config/types.ts:651

Cannot be combined with deps.alwaysBundle; setting both throws an error.

Deprecated

Use deps.alwaysBundle instead.

---

onSuccess?

optional onSuccess?: string | ((config, signal) => void | Promise<void>);

Defined in: src/config/types.ts:537

You can specify command to be executed after a successful build, specially useful for Watch mode

---

outDir?

optional outDir?: string;

Defined in: src/config/types.ts:371

Default

'dist'

---

outExtensions?

optional outExtensions?: OutExtensionFactory;

Defined in: src/config/types.ts:435

Custom extensions for output files. fixedExtension will be overridden by this option.

---

outputOptions?

optional outputOptions?:
  | OutputOptions
  | ((options, format, context) => Awaitable<void | OutputOptions | null>);

Defined in: src/config/types.ts:455

Use with caution; ensure you understand the implications.

---

platform?

optional platform?: "node" | "neutral" | "browser";

Defined in: src/config/types.ts:193

Specifies the target runtime platform for the build.

• node: Node.js and compatible runtimes (e.g., Deno, Bun). For CJS format, this is always set to node and cannot be changed.
• neutral: A platform-agnostic target with no specific runtime assumptions.
• browser: Web browsers.

Default

'node'

See

https://tsdown.dev/options/platform

---

plugins?

optional plugins?: TsdownPluginOption;

Defined in: src/config/types.ts:341

---

publint?

optional publint?: WithEnabled<PublintOptions>;

Defined in: src/config/types.ts:564

Run publint after bundling. Requires publint to be installed.

Default

false

---

report?

optional report?: WithEnabled<ReportOptions>;

Defined in: src/config/types.ts:579

Enable size reporting after bundling.

Default

true

---

root?

optional root?: string;

Defined in: src/config/types.ts:417

Specifies the root directory of input files, similar to TypeScript's rootDir. This determines the output directory structure.

By default, the root is computed as the common base directory of all entry files.

See

https://www.typescriptlang.org/tsconfig/#rootDir

---

shims?

optional shims?: boolean;

Defined in: src/config/types.ts:262

Inject CJS __dirname and __filename shims into ESM output. Only applies when platform is set to node.

Note: import.meta.url, import.meta.dirname, and import.meta.filename are always shimmed in CJS output, regardless of this option.

See

https://tsdown.dev/options/shims

Default

false

---

sourcemap?

optional sourcemap?: Sourcemap;

Defined in: src/config/types.ts:387

Whether to generate source map files.

Note that this option will always be true if you have `declarationMap` option enabled in your tsconfig.json.

Default

false

---

suppressWarnings?

optional suppressWarnings?: Arrayable<string | RegExp> | ((msg) => boolean);

Defined in: src/config/types.ts:499

Suppress warnings whose message matches the given pattern(s).

Accepts a string (substring match), a RegExp, an array of either, or a predicate function. Matched warnings are dropped before failOnWarn is applied, so they won't fail the build.

---

target?

optional target?: string | false | string[];

Defined in: src/config/types.ts:224

Specifies the compilation target environment(s).

Determines the JavaScript version or runtime(s) for which the code should be compiled. If not set, defaults to the value of engines.node in your project's package.json. If no engines.node field exists, no syntax transformations are applied.

Accepts a single target (e.g., 'es2020', 'node18', 'baseline-widely-available'), an array of targets, or false to disable all transformations.

See

https://tsdown.dev/options/target#supported-targets for a list of valid targets and more details.

Examples

// Target a single environment
{ "target": "node18" }

// Target multiple environments
{ "target": ["node18", "es2020"] }

// Disable all syntax transformations
{ "target": false }

---

treeshake?

optional treeshake?: boolean | TreeshakingOptions;

Defined in: src/config/types.ts:269

Configure tree shaking options.

See

https://rolldown.rs/reference/InputOptions.treeshake for more details.

Default

true

---

tsconfig?

optional tsconfig?: string | boolean;

Defined in: src/config/types.ts:180

Default

true

---

unbundle?

optional unbundle?: boolean;

Defined in: src/config/types.ts:407

Determines whether unbundle is enabled. When set to true, the output files will mirror the input file structure.

Default

false

---

unused?

optional unused?: WithEnabled<Options>;

Defined in: src/config/types.ts:557

Enable unused dependencies check with unplugin-unused Requires unplugin-unused to be installed.

Default

false

---

watch?

optional watch?: boolean | Arrayable<string>;

Defined in: src/config/types.ts:517

Default

false

---

workspace?

optional workspace?: true | Arrayable<string> | Workspace;

Defined in: src/config/types.ts:636

[experimental] Enable workspace mode. This allows you to build multiple packages in a monorepo.

---

write?

optional write?: boolean;

Defined in: src/config/types.ts:377

Whether to write the files to disk. This option is incompatible with watch mode.

Default

true