tsup README

The project's README from github.com/egoist/tsup. As one markdown file: README.md.

[!WARNING] This project is not actively maintained anymore. Please consider using tsdown instead. Read more in the migration guide.

tsup

npm version npm downloads

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. CSS support is experimental.

⚙️ Install

Install it locally in your project folder:

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

tsup [...files]

Files are written into ./dist.

You can bundle multiple files in one go:

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.

For all configuration options, please see the API docs.

💬 Discussions

Head over to the discussions to share your ideas.

Sponsors

Ship UIs faster with automated workflows for Storybook

sponsors

Project Stats

Alt

License

MIT © EGOIST

tsup (egoist/tsup)

Searching Database…

11.3K ·GitHub
Что это такое?tsup — это сборщик без настройки для TypeScript-библиотек, построенный на esbuild ради высокой скорости.
Это утилита командной строки или библиотека, которую я подключаю?Это утилита командной строки, которую вы запускаете в своём проекте; она собирает файлы .js, .json, .mjs, .ts и .tsx в папку dist.
Как это запустить?Установите tsup локально в папку проекта и запустите его для входных файлов; результат попадёт в ./dist. За одну команду можно собрать несколько входных файлов.
Что нужно для запуска?Требуется Node.js 18 или новее; под капотом tsup использует esbuild и rollup для сборки.
tsup всё ещё активно поддерживается?Нет. Мейнтейнер прекратил активную разработку и рекомендует перейти на tsdown.
Может ли tsup собирать CSS-файлы?Да, но в README прямо указано, что поддержка CSS является экспериментальной.
Что использовать теперь, когда tsup больше не поддерживается?В README рекомендуется перейти на tsdown как на преемника, и есть ссылка на руководство по миграции.
Можно ли установить tsup глобально, а не для каждого проекта?Можно, но в README этого не рекомендуют и советуют установку локально в проект.
Какую задачу решает tsup по сравнению с ручной настройкой esbuild?Он оборачивает esbuild разумными значениями по умолчанию, так что можно собрать TypeScript-библиотеку без конфигурационного файла.
What are similar projects?pkg, rollup, esbuild, vite-plus, tools, truffle, rolldown, nexe
Creator
egoist
Size
2.3 MB
Stars
11.3K
Age
6y
Commits · 90 Days