Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: plugin migration guide #4609

Merged
merged 1 commit into from
Feb 20, 2025
Merged

docs: plugin migration guide #4609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions website/docs/en/guide/migration/vite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,23 @@ for (const path of context.keys()) {
}
```

## Migrating Vite plugins

Rsbuild's plugin API covers most of the Vite and Rollup plugin hooks, for example:

| Vite plugin hooks | Rsbuild plugin API |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `resolveId` | [resolve](/plugins/dev/core#apiresolve) |
| `transform` | [transform](/plugins/dev/core#apitransform) |
| `config` | [modifyRsbuildConfig](/plugins/dev/hooks#modifyrsbuildconfig) |
| `configResolved` | [getNormalizedConfig](/plugins/dev/core#apigetnormalizedconfig) |
| `configureServer` | [onBeforeStartDevServer](/plugins/dev/hooks#onbeforestartdevserver) |
| `buildStart` | [onBeforeBuild](/plugins/dev/hooks#onbeforebuild), [onBeforeStartDevServer](/plugins/dev/hooks#onbeforestartdevserver) |
| `buildEnd` | [onAfterBuild](/plugins/dev/hooks#onafterbuild), [onCloseDevServer](/plugins/dev/hooks#onclosedevserver) |
| `closeBundle` | [onCloseBuild](/plugins/dev/hooks#onclosebuild), [onCloseDevServer](/plugins/dev/hooks#onclosedevserver) |

See [Plugin system](/plugins/dev/index) for more details.

## Validating results

After completing the above steps, you have completed the basic migration from Vite to Rsbuild. You can now run the `npm run dev` command to try starting the dev server.
Expand Down
17 changes: 17 additions & 0 deletions website/docs/zh/guide/migration/vite.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,23 @@ for (const path of context.keys()) {
}
```

## 迁移 Vite 插件

Rsbuild 的插件 API 覆盖了大部分的 Vite 和 Rollup 插件 hooks，例如：

| Vite 插件 hooks | Rsbuild 插件 API |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `resolveId` | [resolve](/plugins/dev/core#apiresolve) |
| `transform` | [transform](/plugins/dev/core#apitransform) |
| `config` | [modifyRsbuildConfig](/plugins/dev/hooks#modifyrsbuildconfig) |
| `configResolved` | [getNormalizedConfig](/plugins/dev/core#apigetnormalizedconfig) |
| `configureServer` | [onBeforeStartDevServer](/plugins/dev/hooks#onbeforestartdevserver) |
| `buildStart` | [onBeforeBuild](/plugins/dev/hooks#onbeforebuild), [onBeforeStartDevServer](/plugins/dev/hooks#onbeforestartdevserver) |
| `buildEnd` | [onAfterBuild](/plugins/dev/hooks#onafterbuild), [onCloseDevServer](/plugins/dev/hooks#onclosedevserver) |
| `closeBundle` | [onCloseBuild](/plugins/dev/hooks#onclosebuild), [onCloseDevServer](/plugins/dev/hooks#onclosedevserver) |

请参考 [插件系统](/plugins/dev/index) 文档来了解更多。

## 验证结果

完成以上步骤后，你已经完成了从 Vite 到 Rsbuild 的基本迁移，此时可以执行 `npm run dev` 命令来尝试启动开发服务器。
Expand Down
Loading