mirror of
https://github.com/egoist/tsup.git
synced 2025-12-08 20:35:58 +00:00
73 lines
2.0 KiB
Markdown
73 lines
2.0 KiB
Markdown
# tsup
|
|
|
|
[](https://npm.im/tsup) [](https://npm.im/tsup)
|
|
|
|
Bundle your TypeScript library with no config, powered by [esbuild](https://github.com/evanw/esbuild).
|
|
|
|
## 👀 What can it bundle?
|
|
|
|
Anything that's supported by Node.js natively, namely `.js`, `.json`, `.mjs`. And TypeScript `.ts`, `.tsx`. [CSS support is experimental](https://tsup.egoist.dev/#css-support).
|
|
|
|
## ⚙️ Install
|
|
|
|
Install it locally in your project folder:
|
|
|
|
```bash
|
|
npm i tsup -D
|
|
# Or Yarn
|
|
yarn add tsup --dev
|
|
# Or pnpm
|
|
pnpm add tsup -D
|
|
```
|
|
|
|
You can also install it globally but it's not recommended.
|
|
|
|
## 📖 Usage
|
|
|
|
### Bundle files
|
|
|
|
```bash
|
|
tsup [...files]
|
|
```
|
|
|
|
Files are written into `./dist`.
|
|
|
|
You can bundle multiple files in one go:
|
|
|
|
```bash
|
|
tsup src/index.ts src/cli.ts
|
|
```
|
|
|
|
This will output `dist/index.js` and `dist/cli.js`.
|
|
|
|
## 📚 Documentation
|
|
|
|
For complete usages, please dive into the [docs](https://tsup.egoist.dev).
|
|
|
|
For all configuration options, please see [the API docs](https://jsdocs.io/package/tsup).
|
|
|
|
## 💬 Discussions
|
|
|
|
Head over to the [discussions](https://github.com/egoist/tsup/discussions) to share your ideas.
|
|
|
|
## Sponsors
|
|
|
|
<p align="center">
|
|
<a href="https://chromatic.com" target="_blank"><picture>
|
|
<source media="(prefers-color-scheme: dark)" width="500" srcset="https://fastly.jsdelivr.net/gh/egoist-bot/images@main/uPic/Group 2 (2).png">
|
|
<img alt="Ship UIs faster with automated workflows for Storybook" width="500" src="https://fastly.jsdelivr.net/gh/egoist-bot/images@main/uPic/Group%202%20(1).png">
|
|
</picture></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/sponsors/egoist" target="_blank"><img src="https://sponsors-images.egoist.dev/sponsors.svg" alt="sponsors"></a>
|
|
</p>
|
|
|
|
## Project Stats
|
|
|
|
|
|
|
|
## License
|
|
|
|
MIT © [EGOIST](https://github.com/sponsors/egoist)
|