快速上手

🚧 测试版软件

Rolldown 当前处于测试阶段。虽然它已经可以满足大多数生产环境的使用需求，但仍可能存在一些 bug 或不完善之处。

安装

有多种方式可以开始使用 robuild：

• 手动安装：将其作为开发依赖添加到您的项目中
• 使用 项目脚手架：快速创建新项目
• 直接通过 npx 运行：无需安装即可体验

手动安装

使用您喜欢的包管理器将 robuild 安装为开发依赖：

npm

npm install -D robuild

pnpm

pnpm add -D robuild

yarn

yarn add -D robuild

bun

bun add -D robuild

可选地，如果您未启用 isolatedDeclarations，还应将 TypeScript 作为开发依赖进行安装：

npm

npm install -D typescript

pnpm

pnpm add -D typescript

yarn

yarn add -D typescript

bun

bun add -D typescript

兼容性说明

robuild 需要 Node.js 18 或更高版本。请确保您的开发环境满足此要求后再进行安装。

项目脚手架

为了更快速地开始，您可以使用 create-robuild CLI，它提供了一系列用于构建纯 TypeScript 库的模板。

npm

npm create robuild@latest

pnpm

pnpm create robuild@latest

yarn

yarn create robuild@latest

bun

bun create robuild@latest

这些模板包含了开箱即用的配置和最佳实践，用于构建、测试和代码检查 TypeScript 项目。

可用模板：

模板	描述
default	标准 TypeScript 库
minimal	最小化设置
cli	命令行工具
monorepo	多包工作区

使用 npx

如果您只想快速试用，可以直接使用 npx 运行：

npx robuild ./src/index.ts

使用 CLI

要验证 robuild 是否正确安装，请在项目目录中运行以下命令：

./node_modules/.bin/robuild --version

您还可以通过以下命令查看可用的 CLI 选项和示例：

./node_modules/.bin/robuild --help

创建您的第一个打包

首先，创建两个源 TypeScript 文件：

src/index.ts

import { hello } from './hello'

hello()

src/hello.ts

export function hello(): void {
  console.log('Hello robuild!')
}

接下来，初始化 robuild 配置文件：

build.config.ts

import { defineConfig } from 'robuild'

export default defineConfig({
  entries: [
    {
      type: 'bundle',
      input: './src/index.ts',
    },
  ],
})

现在，运行以下命令来打包您的代码：

./node_modules/.bin/robuild

您应该会看到打包后的输出文件写入到 dist/index.mjs。为了验证它是否正常工作，运行输出文件：

node dist/index.mjs

您应该会在控制台中看到消息 Hello robuild!。

在 npm 脚本中使用 CLI

为了简化命令，您可以将其添加到 package.json 的脚本中：

package.json

{
  "name": "my-robuild-project",
  "type": "module",
  "main": "./dist/index.mjs",
  "scripts": {
    "build": "robuild"
  },
  "devDependencies": {
    "robuild": "^0.1.0"
  }
}

现在，您可以通过以下命令构建项目：

npm run build

使用配置文件

虽然可以直接使用 CLI，但对于更复杂的项目，推荐使用配置文件。这可以让您以集中且可复用的方式定义和管理构建设置。

robuild 支持以下配置文件：

• build.config.ts (推荐)
• build.config.mjs
• build.config.js

build.config.ts

import { defineConfig } from 'robuild'

export default defineConfig({
  entries: [
    {
      type: 'bundle',
      input: './src/index.ts',
      format: ['esm', 'cjs'],
      dts: true,
    },
  ],
})

有关更多详细信息，请参阅 配置 文档。

使用插件

robuild 支持通过插件扩展其功能。您可以无缝使用 Rolldown 插件、Unplugin 插件以及大多数 Rollup 插件。要使用插件，请将它们添加到配置文件的 plugins 数组中。例如：

build.config.ts

import SomePlugin from 'some-plugin'
import { defineConfig } from 'robuild'

export default defineConfig({
  entries: [
    {
      type: 'bundle',
      input: './src/index.ts',
      plugins: [SomePlugin()],
    },
  ],
})

有关更多详细信息，请参阅 插件 文档。

使用监听模式

您可以启用监听模式，在文件更改时自动重新构建项目。这在开发过程中非常有用，可以简化您的工作流程。使用 --watch（或 -w）选项：

robuild --watch

有关更多详细信息，请参阅 监听模式 文档。

下一步

• CLI 命令行 - 完整的命令行选项
• 配置 - 配置文件详解
• 构建模式 - Bundle 与 Transform 模式