Tsdown 使用教程

Tsdown 使用教程

tsdown An even faster bundler powered by Rolldown. 项目地址: https://gitcode.com/gh_mirrors/ts/tsdown

1. 项目介绍

Tsdown 是一个由 Rolldown 驱动的极速打包工具，旨在提供快速的构建和生成 .d.ts 文件的能力。它支持 Rollup、Rolldown、Vite 以及 unplugin 插件，并且可以轻松地重用 Vite 或 Vitest 的配置。Tsdown 与 tsup 兼容，确保了从 tsup 迁移的平滑性。

2. 项目快速启动

在开始之前，确保您的系统中已经安装了 Node.js。

安装

使用 npm 安装 Tsdown：

npm i tsdown

配置

创建一个 tsdown.config.ts 文件，并配置入口文件：

// tsdown.config.ts
import { defineConfig } from 'tsdown';

export default defineConfig({
  entry: [
    './src'
  ],
  // 在这里添加更多配置...
});

运行

在项目目录中运行以下命令来启动打包过程：

npx tsdown

3. 应用案例和最佳实践

例子：使用 Tsdown 打包一个 TypeScript 库

假设你有一个 TypeScript 库项目，你可以在项目中创建一个 tsdown.config.ts 文件来定义打包配置。以下是一个简单的配置示例：

// tsdown.config.ts
import { defineConfig } from 'tsdown';

export default defineConfig({
  entry: './src/index.ts',
  outDir: './dist',
  format: ['es', 'cjs'],
  // 其他配置...
});

然后运行 Tsdown：

npx tsdown

这将会根据配置文件中的设置打包你的 TypeScript 库。

最佳实践

• 确保你的项目中的所有依赖都是最新的，以便充分利用 Tsdown 的最新功能。
• 使用 Tsdown 的配置文件来管理不同的打包目标，例如 ES 模块和 CommonJS 模块。
• 在持续集成（CI）流程中使用 Tsdown，确保自动化的构建和测试过程。

4. 典型生态项目

• Rollup: Tsdown 可以与 Rollup 插件无缝工作，提供强大的打包能力。
• Vite: Tsdown 支持重用 Vite 的配置，使得开发体验更加一致。
• unplugin: Tsdown 支持使用 unplugin 插件，为项目提供了更多的灵活性和扩展性。

通过上述教程，开发者可以快速上手 Tsdown，并利用其提供的强大功能来优化他们的项目打包流程。

tsdown An even faster bundler powered by Rolldown. 项目地址: https://gitcode.com/gh_mirrors/ts/tsdown