JSPM

tsup

1.5.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2469675
  • Score
    100M100P100Q192478F
  • License MIT

Package Exports

  • tsup

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tsup) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tsup

Rollup + esbuild.

This library is intentionally kept simple, if you want customizations please use Rollup directly.

Why Rollup?

Rollup is at least an order of magnitude slower than esbuild, why not use esbuild directly?

Because esbuild isn't mature enough, here we use Rollup to bundle .d.ts files, add code splitting support, import non-js assets etc. tsup uses esbuild to compile TypeScript/ESNext code to ES2015.

What can it bundle?

Anything that's supported by Node.js natively, namely .js, .json, .mjs. Plus .ts, .vue (soon), .css (soon).

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.

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 files and node modules

tsup [...files] --bundle

dependencies in your packages.json are always excluded, you can also use --external <module> flag to mark specific package as external.

When you're bundling a lot files, this can be 10x~200x slower than esbuild.

Run a program

tsup run main.ts

For more details:

tsup --help

License

MIT © EGOIST (Kevin Titor)