tsup

Bundle your TypeScript library with no config, powered by esbuild.

What can it bundle?

Anything that's supported by Node.js natively, namely .js, .json, .mjs. And TypeScript .ts, .tsx.

This project is designed for bundling Node.js libraries.

Install

Install it locally in your project folder:

npm i tsup -D
# Or Yarn
yarn add tsup --dev

You can also install it globally but it's not recommended.

Usage

Bundle files

tsup [...files]

Files are written into ./dist.

You can bundle multiple files in one go:

tsup src/index.ts src/cli.ts

Code splitting is enabled by default and supported in cjs and esm format.

Excluding packages

By default tsup bundles all import-ed modules but dependencies in your packages.json are always excluded, you can also use --external <module> flag to mark other packages as external.

Generate declaration file

tsup index.ts --dts

This will emit ./dist/index.js and ./dist/index.d.ts.

If you want to bundle types from node_modules as well, use the --dts-bundle flag instead, which implicitly set --dts flag as well. (Note that this is experimental.)

Bundle formats

Supported format: esm, cjs, (default) and iife.

You can bundle in multiple format in one go:

tsup src/index.ts --format esm,cjs,iife

That will output files in following folder structure:

dist
├── esm
│   └── index.js
├── iife
│   └── index.js
└── index.js

Watch mode

tsup src/index.ts --watch

What about type checking?

esbuild is fast because it doesn't perform any type checking, you already get type checking from your IDE like VS Code or WebStorm.

Additionally, if you want type checking at build time, you can enable --dts, which will run a real TypeScript compiler to generate declaration file so you get type checking as well.

---

For more details:

tsup --help

License

MIT © EGOIST (Kevin Titor)