快速上手

注意事项

Modern.js Builder 已升级为 Rsbuild 独立品牌,当前文档将不再继续迭代。

  • 如果你在使用 Modern.js 框架,请直接访问 Modern.js 框架文档
  • 如果你在使用 Modern.js Builder 的 CLI 或 Node API,可以轻松迁移到 Rsbuild,请访问 Rsbuild 仓库 了解更多。

环境准备

;

在开始使用前,你需要安装 Node.js,并保证 Node.js 版本不低于 14.17.6,我们推荐使用 Node.js 18 的 LTS 版本

你可以通过以下命令检查当前使用的 Node.js 版本:

node -v

如果你当前的环境中尚未安装 Node.js,或是安装的版本低于 14.17.6,可以通过 nvmfnm 安装需要的版本。

下面是通过 nvm 安装 Node.js 18 LTS 版本的例子:

# 安装 Node.js 18 的长期支持版本
nvm install 18 --lts

# 将刚安装的 Node.js 18 设置为默认版本
nvm alias default 18

# 切换到刚安装的 Node.js 18
nvm use 18
nvm 和 fnm

nvm 和 fnm 都是 Node.js 版本管理工具。相对来说,nvm 较为成熟和稳定,而 fnm 是使用 Rust 实现的,比 nvm 提供了更好的性能。

此外,在安装 nvm 或 fnm 后,然后只要仓库根目录下有内容为 lts/hydrogen.nvmrc 文件,进入这个仓库时就会自动安装或切换到正确的 Node.js 版本。

使用 Modern.js 框架

Modern.js 框架默认使用 Modern.js Builder 作为构建工具。因此,如果你是一名业务开发者,那么不需要手动接入 Builder,只需要创建一个 Modern.js 项目,就可以使用 Builder 提供的所有能力。

npx @modern-js/create@latest my-app

请阅读 Modern.js - 介绍Modern.js - 快速上手 来了解 Modern.js 框架的使用方法。

关于文档

Modern.js 框架文档和 Modern.js Builder 文档部署在两个独立的站点下。如果你在使用 Modern.js 框架的过程中遇到任何构建相关的问题,你可以随时查阅 Modern.js Builder 的文档来寻找相应的解决方案。

使用 Builder CLI 工具

Modern.js Builder 提供了一个轻量的 CLI 工具,包含 dev、build 等基础命令,它主要用于构建非 React 项目。

如果你的项目不是基于 React 的,比如开发一个 Vue 项目,那么你可以使用 Builder CLI 工具来构建你的项目。

请参考 使用 Builder CLI 来了解相关用法。

在前端框架中接入

如果你正在开发一个前端框架,可以通过下面的步骤来接入 Builder:

1. 安装 Builder

你需要安装两个包,其中:

  • @modern-js/builder 为 Builder 的核心包,导出了 Builder 的核心 API。
  • @modern-js/builder-rspack-provider,它提供基于 Rspack 的构建能力。
npm
yarn
pnpm
bun
npm add @modern-js/builder @modern-js/builder-rspack-provider -D

如果你想使用 webpack 而不是 Rspack,可以将 @modern-js/builder-rspack-provider 替换为 @modern-js/builder-webpack-provider

在进行版本升级时,请确保你安装的 builder 和 provider 为同一个版本。

2. 创建 Builder 实例

创建 Builder 实例的过程分两步:

首先你需要初始化 Builder Provider,并传入 builderConfig 配置对象。Builder 提供了丰富的配置项,允许你对构建行为进行灵活定制。此时你还不需要了解配置项的具体内容,传入一个空对象即可。你可以在 API - 配置 中找到所有可用的配置项。

  • 初始化 webpack Provider:
import { createBuilder } from '@modern-js/builder';
import { builderWebpackProvider } from '@modern-js/builder-webpack-provider';

const provider = builderWebpackProvider({
  builderConfig: {
    // some configs
  },
});
  • 初始化 Rspack Provider:
import { createBuilder } from '@modern-js/builder';
import { builderRspackProvider } from '@modern-js/builder-rspack-provider';

const provider = builderRspackProvider({
  builderConfig: {
    // some configs
  },
});

拿到 provider 实例后,你可以调用 createBuilder 方法来创建一个 Builder 实例对象:

const builder = await createBuilder(provider, {
  entry: {
    index: './src/index.ts',
  },
});

除了上述示例中的 entry 选项,createBuilder 方法也提供了一些其他的选项,你可以在 API - createBuilder 中进一步了解。

3. 调用 Builder 实例方法

Builder 实例提供了与构建相关的各个方法,你可以根据实际场景来进行使用。

在本地开发场景,建议使用 builder.startDevServer 方法,调用后会启动本地 Dev Server。

await builder.startDevServer();

成功启动 Dev Server 后,可以看到以下日志信息:

info    Starting dev server...

  > Local:    http://localhost:8081
  > Network:  http://192.168.0.1:8081

在生产环境部署场景,建议使用 builder.build 方法,调用后会构建出生产环境产物。

await builder.build();

关于 Builder 实例方法的更多介绍,请阅读 Builder Instance 章节。

通过以上三个步骤,你已经了解了 Builder 基本的使用方法。接下来你可以通过 Builder 插件和 Builder 配置来对构建流程进行定制。

下一步

你可能想要: