入门指南

通过 Vite+ 将 Vize 加入 Vue 3 应用。工具设置放在 vite.config.ts 中，TypeScript 项目设置保留在 tsconfig.json 中。Vize 仍在开发；采用前请查看支持状态。

1. 安装集成

在已安装 Vite+ 的现有 Vue 项目中运行：

vp install -D @vizejs/vite-plugin

集成使用项目的 Vite+ 版本（0.2.3 或更高）。普通 Vite 请参阅插件迁移，Nuxt 请参阅 Nuxt 集成。

2. 更新 `vite.config.ts`

该函数添加 Vize 编译器和原生检查任务。删除旧 Vue 插件的 import 以及 plugins 中的 vue()，保留 alias、server、test 和其他插件。迁移指南提供完整的修改前后示例。

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({});

3. 构建并检查应用

vp dev
vp build
vp run check

vp run check 将 Vue 类型检查、lint 和格式化与 Oxlint、Oxfmt 一起执行。开发时也可以运行单独的任务：

vp run typecheck
vp run lint
vp run fmt:check

使用 vp run check -- --fix 应用修复。生成的 Vize 任务应通过 vp run 执行：内置的 vp check、vp lint 和 vp fmt 运行 Vite+ 自身的工具。Vize 保留已有脚本，名称冲突时生成 vize:<名称>；请参阅任务名称和覆盖设置。

选择下一步

修改规则或编译器选项。
迁移现有工具，查看完整的修改前后示例。
理解 lint 诊断，对照 Vue 的问题示例和修正示例。
浏览组件，查看用法和 API。
使用 Musea 预览组件。
设置编辑器，共享原生工具配置。

尚未翻译的指南链接指向英文版。

Note

CLI、Vite 集成和编辑器共享 vite.config.* 的 vue: 设置，并使用 tsconfig.json 中的 TypeScript 项目与 vueCompilerOptions。专用 vize.config.* 和顶层 vize: 配置已移除；迁移方式见配置指南。

不使用 Vite+ 的场景

无需安装即可试用 CLI：

vpx vize lint src
vpx vize check
vpx vize fmt --check src

独立 CLI提供 vize lint、vize fmt 和 vize check。从目标包的根目录运行，并将 TypeScript 项目保留在 tsconfig.json 中。原生命令也可以共享 vite.config.* 中的 vue: 设置；搜索规则和当前限制请参阅 CLI 配置。

先用 vpx vize init --dry-run 预览交互式设置，再运行 vpx vize init 选择功能。项目设置介绍检测和编辑限制。init 使用项目设置和默认值，不会创建专用的 Vize 配置文件。