Skip to content

feat: add rsbuild adapter #608

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

Merged
sxzz merged 6 commits into from
Jun 29, 2026
+860 −219
Merged

feat: add rsbuild adapter #608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3100900
feat: add rsbuild adapter
yslpn Jun 14, 2026
2188e42
fix(rsbuild): ensure plugins array is initialized before modification
yslpn Jun 21, 2026
baef83d
refactor(rspack): extract getRspackVersion function for version retri…
yslpn Jun 21, 2026
5046ccf
refactor(rspack): remove applyRspackHook option and simplify plugin a…
yslpn Jun 21, 2026
f543312
Merge branch 'main' into feat/rsbuild-adapter
yslpn Jun 21, 2026
7f9028b
Merge branch 'main' into feat/rsbuild-adapter
sxzz Jun 29, 2026
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Currently supports:
- [Webpack](https://webpack.js.org/)
- [esbuild](https://esbuild.github.io/)
- [Rspack](https://www.rspack.dev/)
- [Rsbuild](https://rsbuild.rs/)
- [Rolldown](https://rolldown.rs/)
- [Farm](https://www.farmfe.org/)
- [Bun](https://bun.com/)
Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/assets/rsbuild.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/.vitepress/assets/rspack.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 0 additions & 4 deletions docs/.vitepress/theme/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,6 @@ img[src*="features"] {
width: 48px;
}

img[src*="/features/rspack"] {
margin-bottom: 28px!important;
}

details > summary:hover {
cursor: pointer;
user-select: none;
Expand Down
87 changes: 59 additions & 28 deletions docs/guide/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ lastUpdated: false
- [webpack](https://webpack.js.org/)
- [esbuild](https://esbuild.github.io/)
- [Rspack](https://www.rspack.dev/)
- [Rsbuild](https://rsbuild.rs/)
- [Rolldown](https://rolldown.rs/)
- [Farm](https://www.farmfe.org/)
- [Bun](https://bun.com/)
Expand Down Expand Up @@ -131,6 +132,20 @@ module.exports = {
}
```

```ts [Rsbuild]
// rsbuild.config.ts
import { defineConfig } from '@rsbuild/core'
import Starter from 'unplugin-starter/rsbuild'

export default defineConfig({
plugins: [
Starter({
/* options */
}),
],
})
```

```js [esbuild]
// esbuild.config.js
import { build } from 'esbuild'
Expand Down Expand Up @@ -209,18 +224,18 @@ export default defineConfig({

## Supported Hooks

| Hook | Rollup | Vite | webpack | esbuild | Rspack | Farm | Rolldown | Bun |
| --------------------------------------------------------------------------------- | :-------------: | :--: | :-----: | :-------------: | :-------------: | :--: | :------: | :-------------: |
| [`enforce`](https://vite.dev/guide/api-plugin.html#plugin-ordering) | ❌ <sup>1</sup> | ✅ | ✅ | ❌ <sup>1</sup> | ✅ | ✅ | ✅ | ❌ |
| [`buildStart`](https://rollupjs.org/plugin-development/#buildstart) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`resolveId`](https://rollupjs.org/plugin-development/#resolveid) | ✅ | ✅ | ✅ | ✅ | ✅ <sup>5</sup> | ✅ | ✅ | ✅ |
| ~~`loadInclude`~~<sup>2</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`load`](https://rollupjs.org/plugin-development/#load) | ✅ | ✅ | ✅ | ✅ <sup>3</sup> | ✅ | ✅ | ✅ | ✅ |
| ~~`transformInclude`~~<sup>2</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`transform`](https://rollupjs.org/plugin-development/#transform) | ✅ | ✅ | ✅ | ✅ <sup>3</sup> | ✅ | ✅ | ✅ | ✅ |
| [`watchChange`](https://rollupjs.org/plugin-development/#watchchange) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ |
| [`buildEnd`](https://rollupjs.org/plugin-development/#buildend) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ <sup>6</sup> |
| [`writeBundle`](https://rollupjs.org/plugin-development/#writebundle)<sup>4</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ <sup>6</sup> |
| Hook | Rollup | Vite | webpack | esbuild | Rspack | Rsbuild | Farm | Rolldown | Bun |
| --------------------------------------------------------------------------------- | :-------------: | :--: | :-----: | :-------------: | :-------------: | :-------------: | :--: | :------: | :-------------: |
| [`enforce`](https://vite.dev/guide/api-plugin.html#plugin-ordering) | ❌ <sup>1</sup> | ✅ | ✅ | ❌ <sup>1</sup> | ✅ | ✅ | ✅ | ✅ | ❌ |
| [`buildStart`](https://rollupjs.org/plugin-development/#buildstart) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`resolveId`](https://rollupjs.org/plugin-development/#resolveid) | ✅ | ✅ | ✅ | ✅ | ✅ <sup>5</sup> | ✅ <sup>5</sup> | ✅ | ✅ | ✅ |
| ~~`loadInclude`~~<sup>2</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`load`](https://rollupjs.org/plugin-development/#load) | ✅ | ✅ | ✅ | ✅ <sup>3</sup> | ✅ | ✅ | ✅ | ✅ | ✅ |
| ~~`transformInclude`~~<sup>2</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`transform`](https://rollupjs.org/plugin-development/#transform) | ✅ | ✅ | ✅ | ✅ <sup>3</sup> | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`watchChange`](https://rollupjs.org/plugin-development/#watchchange) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ❌ |
| [`buildEnd`](https://rollupjs.org/plugin-development/#buildend) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ <sup>6</sup> |
| [`writeBundle`](https://rollupjs.org/plugin-development/#writebundle)<sup>4</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ <sup>6</sup> |

::: details Notice

Expand All @@ -230,7 +245,7 @@ export default defineConfig({
In Rollup, this hook has been polyfilled to match the behaviors. See the following usage examples for reference.
3. Although esbuild can handle both JavaScript and CSS and many other file formats, you can only return JavaScript in `load` and `transform` results.
4. Currently, `writeBundle` is only serves as a hook for the timing. It doesn't pass any arguments.
5. Rspack supports `resolveId` with a minimum required version of v1.0.0-alpha.1.
5. Rspack and Rsbuild support `resolveId` with a minimum required Rspack version of v1.0.0-alpha.1.
6. Bun supports `buildEnd` and `writeBundle` with a minimum required version of v1.3.0.

:::
Expand Down Expand Up @@ -268,6 +283,7 @@ export const rollupPlugin = unplugin.rollup
export const rolldownPlugin = unplugin.rolldown
export const webpackPlugin = unplugin.webpack
export const rspackPlugin = unplugin.rspack
export const rsbuildPlugin = unplugin.rsbuild
export const esbuildPlugin = unplugin.esbuild
export const farmPlugin = unplugin.farm
export const bunPlugin = unplugin.bun
Expand Down Expand Up @@ -307,14 +323,14 @@ More details can be found in the [Rolldown's documentation](https://rolldown.rs/

## Supported Context

| Context | Rollup | Vite | webpack | esbuild | Rspack | Farm | Rolldown | Bun |
| ------------------------------------------------------------------------------------- | :----: | :--: | :-----: | :-----: | :----: | :--: | :------: | :-: |
| [`this.parse`](https://rollupjs.org/plugin-development/#this-parse)<sup>1</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.addWatchFile`](https://rollupjs.org/plugin-development/#this-addwatchfile) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| [`this.emitFile`](https://rollupjs.org/plugin-development/#this-emitfile)<sup>2</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.getWatchFiles`](https://rollupjs.org/plugin-development/#this-getwatchfiles) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
| [`this.warn`](https://rollupjs.org/plugin-development/#this-warn) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.error`](https://rollupjs.org/plugin-development/#this-error) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Context | Rollup | Vite | webpack | esbuild | Rspack | Rsbuild | Farm | Rolldown | Bun |
| ------------------------------------------------------------------------------------- | :----: | :--: | :-----: | :-----: | :----: | :-----: | :--: | :------: | :-: |
| [`this.parse`](https://rollupjs.org/plugin-development/#this-parse)<sup>1</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.addWatchFile`](https://rollupjs.org/plugin-development/#this-addwatchfile) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.emitFile`](https://rollupjs.org/plugin-development/#this-emitfile)<sup>2</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.getWatchFiles`](https://rollupjs.org/plugin-development/#this-getwatchfiles) | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.warn`](https://rollupjs.org/plugin-development/#this-warn) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [`this.error`](https://rollupjs.org/plugin-development/#this-error) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |

::: info Notice

Expand All @@ -329,9 +345,9 @@ More details can be found in the [Rolldown's documentation](https://rolldown.rs/

### Bundler Supported

| Rollup | Vite | webpack | Rspack | esbuild | Farm | Rolldown | Bun |
| :--------------------: | :--: | :-----: | :----: | :-----: | :--: | :------: | :-: |
| ✅ `>=3.1`<sup>1</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Rollup | Vite | webpack | Rspack | Rsbuild | esbuild | Farm | Rolldown | Bun |
| :--------------------: | :--: | :-----: | :----: | :-----: | :-----: | :--: | :------: | :-: |
| ✅ `>=3.1`<sup>1</sup> | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |

::: details Notice

Expand Down Expand Up @@ -386,7 +402,7 @@ export const unpluginFactory: UnpluginFactory<Options | undefined> = (
options,
meta,
) => {
console.log(meta.framework) // vite | rollup | webpack | esbuild | rspack | farm | bun
console.log(meta.framework) // vite | rollup | webpack | esbuild | rspack | rsbuild | farm | bun

return {
name: 'unplugin-starter',
Expand Down Expand Up @@ -417,6 +433,12 @@ export const unpluginFactory: UnpluginFactory<Options | undefined> = (
rspack(compiler) {
// Configure Rspack compiler
},
rsbuild: {
// Rsbuild plugin
setup(api) {
// Configure Rsbuild
},
},
esbuild: {
// Change the filter of onResolve and onLoad
// onResolveFilter?: RegExp,
Expand Down Expand Up @@ -464,19 +486,26 @@ export const unpluginFactory = defineUnplugin((options, meta) => {
const bundlerVersion = meta.versions.rollup ?? meta.versions.rolldown
console.log(`Vite is using bundler version: ${bundlerVersion}`)
}

// For Rsbuild, you can also access the underlying Rspack version
if (meta.framework === 'rsbuild') {
const rspackVersion = meta.versions.rspack
console.log(`Rsbuild is using Rspack version: ${rspackVersion}`)
}
}
}
})
```

| Rollup | Vite | webpack | Rspack | esbuild | Farm | Rolldown | Unloader | Bun |
| :------------: | :--------------: | :-----: | :----: | :-----: | :--: | :------------: | :------------: | :-: |
| ✅<sup>1</sup> | ✅<sup>1,2</sup> | ✅ | ✅ | ❌ | ❌ | ✅<sup>1</sup> | ✅<sup>1</sup> | ✅ |
| Rollup | Vite | webpack | Rspack | Rsbuild | esbuild | Farm | Rolldown | Unloader | Bun |
| :------------: | :--------------: | :-----: | :----: | :------------: | :-----: | :--: | :------------: | :------------: | :-: |
| ✅<sup>1</sup> | ✅<sup>1,2</sup> | ✅ | ✅ | ✅<sup>3</sup> | ❌ | ❌ | ✅<sup>1</sup> | ✅<sup>1</sup> | ✅ |

::: details Notice

1. For Rollup-compatible hosts (`vite`, `rollup`, `rolldown`, `unloader`), framework versions are only available after the `buildStart` hook. The `unplugin` version is always available.
2. Vite requires **v7.0.0 or later** to provide `viteVersion` ([vitejs/vite#20088](https://github.com/vitejs/vite/pull/20088)). On earlier versions, `meta.versions.vite` will be `undefined`. Vite also provides the underlying bundler version (`rollup` or `rolldown`).
3. Rsbuild also provides the underlying Rspack version via `meta.versions.rspack`.

:::

Expand All @@ -492,6 +521,7 @@ import {
createFarmPlugin,
createRolldownPlugin,
createRollupPlugin,
createRsbuildPlugin,
createRspackPlugin,
createVitePlugin,
createWebpackPlugin,
Expand All @@ -503,6 +533,7 @@ const rolldownPlugin = createRolldownPlugin(/* factory */)
const esbuildPlugin = createEsbuildPlugin(/* factory */)
const webpackPlugin = createWebpackPlugin(/* factory */)
const rspackPlugin = createRspackPlugin(/* factory */)
const rsbuildPlugin = createRsbuildPlugin(/* factory */)
const farmPlugin = createFarmPlugin(/* factory */)
const bunPlugin = createBunPlugin(/* factory */)
```
10 changes: 8 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar: false
hero:
name: Unplugin
text: The Unified<br>Plugin System
tagline: Supports Vite, Rollup, webpack, esbuild, Bun, and every framework built on top of them.
tagline: Supports Vite, Rollup, webpack, Rspack, Rsbuild, esbuild, Bun, and every framework built on top of them.
image:
light: /logo_light.svg
dark: /logo_dark.svg
Expand Down Expand Up @@ -50,7 +50,13 @@ features:
details: A fast Rust-based web bundler.
link: https://www.rspack.dev/
icon:
src: /features/rspack.png
src: /features/rspack.svg

- title: Rsbuild
details: A Rspack-based build tool.
link: https://rsbuild.rs/
icon:
src: /features/rsbuild.svg

- title: Farm
details: Extremely fast web build tool written in Rust
Expand Down
1 change: 1 addition & 0 deletions docs/public/features/rsbuild.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/public/features/rspack.png
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions docs/public/features/rspack.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export default defineConfig({
customIcon: {
farm: localIconLoader(import.meta.url, '.vitepress/assets/farm.svg'),
rolldown: localIconLoader(import.meta.url, '.vitepress/assets/rolldown.svg'),
rsbuild: localIconLoader(import.meta.url, '.vitepress/assets/rsbuild.svg'),
rspack: localIconLoader(import.meta.url, '.vitepress/assets/rspack.svg'),
},
}),
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
"@arethetypeswrong/core": "catalog:dev",
"@farmfe/cli": "catalog:test",
"@farmfe/core": "catalog:peer",
"@rsbuild/core": "catalog:peer",
"@rspack/cli": "catalog:test",
"@rspack/core": "catalog:peer",
"@types/node": "catalog:dev",
Expand Down
Loading
Loading