Tsup

本章节介绍如何将使用 tsup 的项目迁移到 Rslib。

安装依赖

首先,你需要将 tsup 的 npm 依赖替换为 Rslib 的依赖。

  • 移除 tsup:
npm
yarn
pnpm
bun
npm remove tsup
  • 安装 Rslib:
npm
yarn
pnpm
bun
npm add @rslib/core -D

更新 npm 脚本

接下来,你需要更新 package.json 中的 npm 脚本,以使用 Rslib 的 CLI 命令。

package.json
{
  "scripts": {
-   "build": "tsup",
-   "build:watch": "tsup --watch",
+   "build": "rslib build",
+   "build:watch": "rslib build --watch"
  }
}

创建配置文件

package.json 所在的同一目录中创建一个 Rslib 配置文件 rslib.config.ts,并添加以下内容:

rslib.config.ts
import { defineConfig } from '@rslib/core';

export default defineConfig({});

配置迁移

以下是 tsup 配置对应的 Rslib 配置:

tsup Rslib
banner lib.banner
bundle lib.bundle
clean output.cleanDistPath
define source.define
dts lib.dts
entry source.entry
external output.externals / lib.autoExternal
format lib.format
footer lib.footer
minify output.minify
platform output.target
plugins plugins
sourcemap output.sourceMap
shims lib.shims
terserOptions output.minify
tsconfig source.tsconfigPath

内容补充

当前文档仅包含部分迁移过程。如果你发现合适的内容需要添加,请随时通过 pull request 贡献文档 🤝。

Rslib 的文档可以在 rslib/website 目录中找到。