Tsdown
JetBrainsOfficialCreated by Anthony FuDistributed by JetBrains
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
tsdown is a library bundler designed for TypeScript and JavaScript projects. It leverages Rolldown and Oxc to handle bundling tasks, including generating type declarations, supporting multiple output formats, and managing dependencies. It provides a configuration-driven approach to library development, supporting various frameworks and runtime environments, and includes a migration path for users moving from tsup.
What it does
- Bundles TypeScript and JavaScript libraries into multiple formats like ESM, CJS, IIFE, and UMD.
- Generates TypeScript declaration files (.d.ts) automatically.
- Supports dependency management, including externalization and bundling options.
- Provides hooks for custom build logic and supports plugins from the Rolldown and Rollup ecosystems.
- Offers specialized configurations for component libraries using React, Vue, Solid, or Svelte.
- Includes a migration tool to assist with transitioning from tsup.
When to use it
- When building TypeScript or JavaScript libraries for distribution via npm.
- When you need to generate type declarations alongside your bundled code.
- When your project requires bundling for multiple module formats.
- When migrating an existing library project from tsup.
- When developing component libraries for frameworks like React, Vue, or Svelte.
Advantages
- Simplifies the bundling process for library authors with a clear configuration API.
- Provides built-in support for common library tasks like package exports and ESM/CJS shims.
- Offers CI-aware configuration options to validate packages before publishing.
- Supports advanced features like standalone executable bundling and CSS processing.
- Allows for flexible build configurations including monorepo and workspace support.
Usage examples
- “How do I bundle my TypeScript library for both ESM and CJS formats?”
- You can use a tsdown.config.ts file with the format option set to ['esm', 'cjs'] and dts set to true to generate declarations.
- “How can I migrate my existing tsup project to tsdown?”
- You can run the npx tsdown-migrate command to assist with the transition.
- “How do I configure tsdown to exclude React from my bundle?”
- In your configuration file, use the deps.neverBundle option to specify ['react', 'react-dom'].
- “How do I enable watch mode for development?”
- Run the command npx tsdown --watch to enable watch mode for your build process.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/jetbrains/tsdown/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip tsdown.zip -d .agents/skills
Documentation by Anthony Fu
tsdown - The Elegant Library Bundler
Blazing-fast bundler for TypeScript/JavaScript libraries powered by Rolldown and Oxc.
When to Use
Building TypeScript/JavaScript libraries for npm
Generating TypeScript declaration files (.d.ts)
Bundling for multiple formats (ESM, CJS, IIFE, UMD)
Optimizing bundles with tree shaking and minification
Migrating from tsup with minimal changes
Building React, Vue, Solid, or Svelte component libraries
Quick Start
# Install
pnpm add -D tsdown
# Basic usage
npx tsdown
# With config file
npx tsdown --config tsdown.config.ts
# Watch mode
npx tsdown --watch
# Migrate from tsup
npx tsdown-migrateBasic Configuration
import { defineConfig } from 'tsdown'
export default defineConfig({
entry: ['./src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
clean: true,
})Core References
| Topic | Description | Reference |
|---|---|---|
| Getting Started | Installation, first bundle, CLI basics | guide-getting-started |
| Configuration File | Config file formats, multiple configs, workspace | option-config-file |
| CLI Reference | All CLI commands and options | reference-cli |
| Migrate from tsup | Migration guide and compatibility notes | guide-migrate-from-tsup |
| Plugins | Rolldown, Rollup, Unplugin support | advanced-plugins |
| Hooks | Lifecycle hooks for custom logic | advanced-hooks |
| Programmatic API | Build from Node.js scripts | advanced-programmatic |
| Rolldown Options | Pass options directly to Rolldown | advanced-rolldown-options |
| CI Environment | CI detection, 'ci-only' / 'local-only' values | advanced-ci |
Build Options
| Option | Usage | Reference |
|---|---|---|
| Entry points | entry: ['src/*.ts', '!**/*.test.ts'] | option-entry |
| Output formats | format: ['esm', 'cjs', 'iife', 'umd'] | option-output-format |
| Output directory | outDir: 'dist', outExtensions | option-output-directory |
| Type declarations | dts: true, dts: { sourcemap, compilerOptions, vue } | option-dts |
| Target environment | target: 'es2020', target: 'esnext' | option-target |
| Platform | platform: 'node', platform: 'browser' | option-platform |
| Tree shaking | treeshake: true, custom options | option-tree-shaking |
| Minification | minify: true, minify: 'dce-only' | option-minification |
| Source maps | sourcemap: true, 'inline', 'hidden' | option-sourcemap |
| Watch mode | watch: true, watch options | option-watch-mode |
| Cleaning | clean: true, clean patterns | option-cleaning |
| Log level | logLevel: 'silent', failOnWarn: false | option-log-level |
Dependency Handling
| Feature | Usage | Reference |
|---|---|---|
| Never bundle | deps: { neverBundle: ['react', /^@myorg\//] } | option-dependencies |
| Always bundle | deps: { alwaysBundle: ['dep-to-bundle'] } | option-dependencies |
| Only bundle | deps: { onlyBundle: ['cac', 'bumpp'] } - Whitelist | option-dependencies |
| Skip node_modules | deps: { skipNodeModulesBundle: true } | option-dependencies |
| Auto external | Automatic peer/dependency externalization | option-dependencies |
Output Enhancement
| Feature | Usage | Reference |
|---|---|---|
| Shims | shims: true - Add ESM/CJS compatibility | option-shims |
| CJS default | cjsDefault: true (default) / false | option-cjs-default |
| Package exports | exports: true - Auto-generate exports field | option-package-exports |
| CSS handling | [experimental] css: { ... } — full pipeline with preprocessors, Lightning CSS, PostCSS, code splitting; requires @tsdown/css | option-css |
| CSS inject | css: { inject: true } — preserve CSS imports in JS output | option-css |
| Unbundle mode | unbundle: true - Preserve directory structure | option-unbundle |
| Root directory | root: 'src' - Control output directory mapping | option-root |
| Executable | [experimental] exe: true - Bundle as standalone executable, cross-platform via @tsdown/exe | option-exe |
| Package validation | publint: true, attw: true - Validate package | option-lint |
Framework & Runtime Support
| Framework | Guide | Reference |
|---|---|---|
| React | JSX transform, React Compiler | recipe-react |
| Vue | SFC support, JSX | recipe-vue |
| Solid | SolidJS JSX transform | recipe-solid |
| Svelte | Svelte component libraries (source distribution recommended) | recipe-svelte |
| WASM | WebAssembly modules via rolldown-plugin-wasm | recipe-wasm |
Common Patterns
Basic Library Bundle
export default defineConfig({
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
clean: true,
})Multiple Entry Points
export default defineConfig({
entry: {
index: 'src/index.ts',
utils: 'src/utils.ts',
cli: 'src/cli.ts',
},
format: ['esm', 'cjs'],
dts: true,
})Browser Library (IIFE/UMD)
export default defineConfig({
entry: ['src/index.ts'],
format: ['iife'],
globalName: 'MyLib',
platform: 'browser',
minify: true,
})React Component Library
export default defineConfig({
entry: ['src/index.tsx'],
format: ['esm', 'cjs'],
dts: true,
deps: {
neverBundle: ['react', 'react-dom'],
},
inputOptions: {
jsx: { runtime: 'automatic' },
},
})Preserve Directory Structure
export default defineConfig({
entry: ['src/**/*.ts', '!**/*.test.ts'],
unbundle: true, // Preserve file structure
format: ['esm'],
dts: true,
})CI-Aware Configuration
export default defineConfig({
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
failOnWarn: 'ci-only', // opt-in: fail on warnings in CI
publint: 'ci-only',
attw: 'ci-only',
})WASM Support
import { wasm } from 'rolldown-plugin-wasm'
import { defineConfig } from 'tsdown'
export default defineConfig({
entry: ['src/index.ts'],
plugins: [wasm()],
})Library with CSS and Sass
export default defineConfig({
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
target: 'chrome100',
css: {
preprocessorOptions: {
scss: {
additionalData: `@use "src/styles/variables" as *;`,
},
},
},
})Standalone Executable
export default defineConfig({
entry: ['src/cli.ts'],
exe: true,
})Cross-Platform Executable (requires @tsdown/exe)
export default defineConfig({
entry: ['src/cli.ts'],
exe: {
targets: [
{ platform: 'linux', arch: 'x64', nodeVersion: '25.7.0' },
{ platform: 'darwin', arch: 'arm64', nodeVersion: '25.7.0' },
{ platform: 'win', arch: 'x64', nodeVersion: '25.7.0' },
],
},
})Advanced with Hooks
export default defineConfig({
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
hooks: {
'build:before': async (context) => {
console.log('Building...')
},
'build:done': async (context) => {
console.log('Build complete!')
},
},
})Configuration Features
Multiple Configs
Export an array for multiple build configurations:
export default defineConfig([
{
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
},
{
entry: ['src/cli.ts'],
format: ['esm'],
platform: 'node',
},
])Conditional Config
Use functions for dynamic configuration:
export default defineConfig((options) => {
const isDev = options.watch
return {
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
minify: !isDev,
sourcemap: isDev,
}
})Workspace/Monorepo
Use glob patterns to build multiple packages:
export default defineConfig({
workspace: 'packages/*',
entry: ['src/index.ts'],
format: ['esm', 'cjs'],
dts: true,
})CLI Quick Reference
# Basic commands
tsdown # Build once
tsdown --watch # Watch mode
tsdown --config custom.ts # Custom config
npx tsdown-migrate # Migrate from tsup
# Output options
tsdown --format esm,cjs # Multiple formats
tsdown -d lib # Custom output directory (--out-dir)
tsdown --minify # Enable minification
tsdown --dts # Generate declarations
tsdown --exe # Bundle as standalone executable
tsdown --unbundle # Bundleless mode
# Entry options
tsdown src/index.ts # Single entry
tsdown src/*.ts # Glob patterns
tsdown src/a.ts src/b.ts # Multiple entries
# Workspace / Monorepo
tsdown -W # Enable workspace mode
tsdown -W -F my-package # Filter specific package
tsdown --filter /^pkg-/ # Filter by regex
# Development
tsdown --watch # Watch mode
tsdown --sourcemap # Generate source maps
tsdown --clean # Clean output directory
tsdown --from-vite # Reuse Vite config
tsdown --tsconfig tsconfig.build.json # Custom tsconfigBest Practices
Always generate type declarations for TypeScript libraries:
{ dts: true }Externalize dependencies to avoid bundling unnecessary code:
{ deps: { neverBundle: [/^react/, /^@myorg\//] } }Use tree shaking for optimal bundle size:
{ treeshake: true }Enable minification for production builds:
{ minify: true }Add shims for better ESM/CJS compatibility:
{ shims: true } // Adds __dirname, __filename, etc.Auto-generate package.json exports:
{ exports: true } // Creates proper exports fieldUse watch mode during development:
tsdown --watchPreserve structure for utilities with many files:
{ unbundle: true } // Keep directory structureValidate packages in CI before publishing:
{ publint: 'ci-only', attw: 'ci-only' }
Resources
Documentation: https://tsdown.dev
Rolldown: https://rolldown.rs
Migration Guide: https://tsdown.dev/guide/migrate-from-tsup
Files
- ATTRIBUTION.mdAdded by AutoGineer870 B
- LICENSE.md1.1 KiB
- README.md1.9 KiB
- SKILL.md11.7 KiB
- SYNC.md140 B
- references/README.md4.7 KiB
- references/advanced-benchmark.md265 B
- references/advanced-ci.md2.0 KiB
- references/advanced-hooks.md6.9 KiB
- references/advanced-plugins.md6.6 KiB
- references/advanced-programmatic.md5.9 KiB
- references/advanced-rolldown-options.md2.3 KiB
- references/guide-getting-started.md2.6 KiB
- references/guide-introduction.md1.5 KiB
- references/guide-migrate-from-tsup.md4.2 KiB
- references/option-cjs-default.md1.9 KiB
- references/option-cleaning.md4.8 KiB
- references/option-config-file.md5.1 KiB
- references/option-css.md5.5 KiB
- references/option-dependencies.md7.3 KiB
- references/option-dts.md4.5 KiB
- references/option-entry.md3.6 KiB
- references/option-exe.md3.3 KiB
- references/option-lint.md2.9 KiB
- references/option-log-level.md1.8 KiB
- references/option-minification.md3.5 KiB
- references/option-output-directory.md4.4 KiB
- references/option-output-format.md3.4 KiB
- references/option-package-exports.md5.2 KiB
- references/option-platform.md5.1 KiB
- references/option-root.md1.8 KiB
- references/option-shims.md5.5 KiB
- references/option-sourcemap.md5.4 KiB
- references/option-target.md4.0 KiB
- references/option-tree-shaking.md5.1 KiB
- references/option-unbundle.md5.5 KiB
- references/option-watch-mode.md4.6 KiB
- references/recipe-react.md5.9 KiB
- references/recipe-solid.md929 B
- references/recipe-svelte.md1.4 KiB
- references/recipe-vue.md6.4 KiB
- references/recipe-wasm.md2.6 KiB
- references/reference-cli.md7.3 KiB
references/recipe-solid.md
Solid Support
Build Solid component libraries with tsdown using rolldown-plugin-solid or unplugin-solid.
Quick Start
npx create-tsdown@latest -t solidConfiguration
import solid from 'rolldown-plugin-solid' // or 'unplugin-solid/rolldown'
import { defineConfig } from 'tsdown'
export default defineConfig({
entry: ['./src/index.ts'],
platform: 'neutral',
dts: true,
plugins: [solid()],
})Dependencies
Install one of:
# Option 1: rolldown-plugin-solid
npm install -D rolldown-plugin-solid
# Option 2: unplugin-solid
npm install -D unplugin-solidKey Points
Use
platform: 'neutral'for framework-agnostic outputdts: truegenerates TypeScript declarationsThe Solid plugin handles JSX compilation for Solid's reactive system
Related
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- Anthony Fu
- Publisher
- JetBrains (Official)
- Distributed by
- JetBrains
- Source
- JetBrains/skills · tsdown · commit 3f53782
- Licence
- MIT License (redistribution allowed)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Anthony Fu or JetBrains.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download tsdown.zip