close
logologo
指南
配置
插件
API
社区
版本
更新日志
Rsbuild 0.x 文档
English
简体中文
指南
配置
插件
API
社区
更新日志
Rsbuild 0.x 文档
English
简体中文
logologo

开始

介绍
快速上手
功能导航
名词解释

框架

React
Vue
Preact
Svelte
Solid

基础

命令行工具
开发服务器
构建产物
静态资源
HTML
JSON
Wasm
TypeScript
Web Workers
部署静态站点
升级 Rsbuild

配置

配置 Rspack
配置 Rsbuild
配置 SWC

样式

CSS
CSS Modules
CSS-in-JS
Tailwind CSS v4
Tailwind CSS v3
UnoCSS

进阶

路径别名
环境变量
模块热更新
浏览器范围
浏览器兼容性
模块联邦
多环境构建
服务端渲染(SSR)
测试

优化

代码拆分
产物体积优化
提升构建性能
静态资源内联

迁移

从 Rsbuild 0.x 迁移
webpack
Create React App
Vue CLI
Vite
Vite 插件
Modern.js Builder

调试

开启调试模式
构建性能分析
使用 Rsdoctor

常见问题

通用类问题
功能类问题
异常类问题
热更新问题
📝 在 GitHub 上编辑此页
上一页React
下一页Preact

#Vue

在这篇文档中,你可以了解到如何基于 Rsbuild 来构建一个 Vue 3 或 Vue 2 应用。

#创建 Vue 应用

使用 create-rsbuild 来创建一个基于 Rsbuild 的 Vue 应用,运行以下命令:

npm
yarn
pnpm
bun
npm create rsbuild@latest

然后在 Select framework 时选择 Vue 3 或 Vue 2 即可。

#Vue 3

#在已有项目中使用 Vue 3

为了能够编译 Vue 的 SFC(单文件组件),你需要注册 Rsbuild 的 Vue 插件,插件会自动添加 Vue 构建所需的配置。

例如,在 rsbuild.config.ts 中注册:

rsbuild.config.ts
import { defineConfig } from '@rsbuild/core';
import { pluginVue } from '@rsbuild/plugin-vue';

export default defineConfig({
  plugins: [pluginVue()],
});
TIP

对于使用 Vue CLI 的项目,可以参考 Vue CLI 迁移指南。

#使用 Vue JSX 语法

如果你需要使用 Vue 的 JSX 语法,还需要注册 Rsbuild 的 Vue 3 JSX 插件。

#TypeScript 支持

Rsbuild 默认支持编译 TypeScript。

请参考 Vue 官方文档的 TypeScript - IDE 支持 小节,了解如何在 IDE 中设置 Vue TypeScript 支持。

#Vue 2

#在已有项目中使用 Vue 2

为了能够编译 Vue 的 SFC(单文件组件),你需要注册 Rsbuild 的 Vue 2 插件,插件会自动添加 Vue 构建所需的配置。

例如,在 rsbuild.config.ts 中注册:

rsbuild.config.ts
import { defineConfig } from '@rsbuild/core';
import { pluginVue2 } from '@rsbuild/plugin-vue2';

export default defineConfig({
  plugins: [pluginVue2()],
});
TIP
  • Vue 2 插件仅支持 Vue >= 2.7.0 版本。
  • 对于使用 Vue CLI 的项目,可以参考 Vue CLI 迁移指南。

#使用 Vue JSX 语法

如果你需要使用 Vue 的 JSX 语法,还需要注册 Rsbuild 的 Vue 2 JSX 插件。

#类型声明

在 TypeScript 项目中,你需要为 *.vue 文件添加类型定义,使 TypeScript 能够正确识别它。

请在 src 目录下创建 env.d.ts,并添加以下内容:

src/env.d.ts
declare module '*.vue' {
  import Vue from 'vue';

  export default Vue;
}