# @configurajs/vite-plus 中文文档

规范地址：https://npmcn.com/package/%40configurajs/vite-plus/

版本：0\.2\.6
npm 元数据更新时间：2026-04-21T14:37:06.291Z
中文译文更新时间：2026-11-10T15:31:01.365Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40configurajs/vite-plus
原文对照：https://npmcn.com/package/%40configurajs/vite-plus/?lang=original
项目主页：https://github.com/configurajs/vite-plus#readme
源码仓库：https://github.com/configurajs/vite-plus

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.3 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12\.0
- 运行依赖：0 个
- peer 依赖：oxfmt \>=0\.44\.0，oxlint \>=1\.59\.0，vite-plus \>=0\.1\.16
- 首次发布：2026-04-08T07:14:28.456Z
- 最新版本发布：2026-04-21T14:37:06.136Z
- 近 30 天下载量：6586（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

Oxlint + Oxfmt 配置预设 Vite+ 项目

## 安装

```sh
npm install @configurajs/vite-plus
```

也可以使用：`pnpm add @configurajs/vite-plus`、`yarn add @configurajs/vite-plus`、`bun add @configurajs/vite-plus`

## README

# @configurajs/vite-plus

[English](https://npmcn.com/package/%40configurajs/vite-plus/README.md)

为 [Vite+](https://viteplus.dev/) 项目提供的开箱即用 [Oxlint](https://oxc.rs/docs/guide/usage/linter) + [Oxfmt](https://oxc.rs/docs/guide/usage/formatter) 配置预设。

## 特性

-   TypeScript（默认开启）
-   Vue 3（默认开启）
-   React（按需开启）
-   Vitest（默认开启）
-   Oxfmt 格式化，支持 import 排序和 Tailwind CSS class 排序
-   开箱即用的 lint-staged 预设

## 安装

```bash
pnpm add -D @configurajs/vite-plus
```

## 使用

### Oxc 配置文件

在项目根目录创建 `oxlint.config.ts`：

```ts
// oxlint.config.ts
import { lint } from '@configurajs/vite-plus'

export default lint()
```

在项目根目录创建 `oxfmt.config.ts`：

```ts
// oxfmt.config.ts
import { fmt } from '@configurajs/vite-plus'

export default fmt()
```

### Vite+ 配置文件

如果你使用的是 [Vite+](https://viteplus.dev/)，可以直接在 `vite.config.ts` 中配置 lint、fmt 和 staged：

```ts
// vite.config.ts
import { defineConfig } from 'vite-plus'
import { lint, fmt, staged } from '@configurajs/vite-plus'

export default defineConfig({
  lint: lint(),
  fmt: fmt(),
  staged: staged(),
})
```

### Lint 选项

```ts
lint({
  // 启用 TypeScript 支持（默认：true）
  ts: true,
  // 启用 Vue 支持，默认 Vue 3（默认：true）
  vue: true, // 或 { version: 2 }
  // 启用 React 支持（默认：false）
  react: false,
  // 启用 Vitest 支持（默认：true）
  vitest: true,
  // 自定义规则
  rules: {
    'no-console': 'error',
  },
  // 忽略文件模式
  ignores: ['**/generated/**'],
  // 额外的 overrides
  overrides: [
    {
      files: ['scripts/**'],
      rules: { 'no-console': 'off' },
    },
  ],
})
```

### Fmt 选项

```ts
fmt({
  // 忽略文件模式
  ignores: ['**/generated/**'],
})
```

### Staged

`staged()` 返回一个预设的 lint-staged 配置：

```ts
staged()
// 等同于：
// {
//   '*.{js,jsx,ts,tsx,vue}': ['vp fmt --no-error-on-unmatched-pattern', 'vp lint --fix'],
//   '*.{md,json,yaml,yml,html,css,scss,less}': 'vp fmt --no-error-on-unmatched-pattern',
// }
```

-   `js / jsx / ts / tsx / vue` — 格式化 + lint 修复
-   `md / json / yaml / yml / html / css / scss / less` — 仅格式化

### VSCode 工作区配置

在 `.vscode/settings.json` 中添加：

```jsonc
{
  "prettier.enable": false,
  "eslint.enable": false,
  "editor.defaultFormatter": "oxc.oxc-vscode",
}
```

## License

MIT

## 常见问题

### @configurajs/vite-plus 是什么？

Oxlint \+ Oxfmt 配置预设 Vite\+ 项目

### 如何安装 @configurajs/vite-plus？

在项目目录运行 npm install @configurajs/vite-plus，或使用 pnpm add / yarn add / bun add。

### @configurajs/vite-plus 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @configurajs/vite-plus 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @configurajs/vite-plus 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @configurajs/vite-plus 可以商用吗？

@configurajs/vite-plus 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @configurajs/vite-plus 的下载量有多少？

根据 npm 官方下载统计，@configurajs/vite-plus 在 2026/10/11 – 2026/11/09 这 30 天内被下载 6,586 次，日均约 220 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @configurajs/vite-plus 还在维护吗？

最新版本 0\.2\.6 发布于 2026/04/21（6 个月前）；至今共发布 18 个版本，其中过去 12 个月发布了 18 个；首次发布于 2026/04/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。