# @contember/vite-plugin 中文文档

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

版本：2\.0\.12
npm 元数据更新时间：2026-11-09T13:36:55.376Z
中文译文更新时间：2026-11-10T16:25:52.398Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：77.3 kB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：vite ^4 \|\| ^5
- 首次发布：2023-04-03T15:55:28.929Z
- 最新版本发布：2026-11-09T13:36:54.856Z
- 近 30 天下载量：10841（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：190（近 12 个月 36 个）

## 中文简介

`@contember/vite-plugin` 是一个 Vite 插件,旨在增强 Contember 应用程序的 Vite 构建进程。 它提供配置选项和中间软件来简化开发并构建进程.

## 安装

```sh
npm install @contember/vite-plugin
```

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

## README

# @ contember/vite-plugin (英语)

## 概览

`@contember/vite-plugin` 是一个 Vite 插件,旨在增强 Contember 应用程序的 Vite 构建进程。 它提供配置选项和中间软件来简化开发并构建进程.

## 安装

```bash
yarn add @contember/vite-plugin
```

## 使用量

```javascript
import { defineConfig } from 'vite'
import { contember } from '@contember/vite-plugin'

export default defineConfig({
  plugins: [contember()]
})
```

## 选项

插件接受可选选项 `ContemberOptions` 对象 :

```typescript
type ContemberOptions = {
  buildVersion?: boolean
  disableMiddleware?: boolean
  appPath?: string
}
```

-   `buildVersion`: (可选) 当 `true` (默认),在 HTML 输出中添加构建版本元标记.
-   `disableMiddleware`: (可选) 当 `true`,禁用内置中间软件.
-   `appPath`: (可选)指定应用程序路径。 默认为 `/app`。 。 。 .

## 特征

### 1\. 项目名称注射

插件从命令行参数中自动检测到 Contember 项目名称,并将它作为环境变量注入应用程序 :

```javascript
import.meta.env.VITE_CONTEMBER_ADMIN_PROJECT_NAME
```

### 2\. 构建配置

-   设置基准 URL 为 `/`。 。 。 .
-   配置构建输入以包含root和app HTML文件.

### 3\. 开发服务器中间软件

除非已禁用,插件会添加中间软件来处理应用程序路径的路由,确保应用程序的请求得到妥善处理.

### 4\. 构建版本标签

启用( 默认) 时, 插件在 HTML 输出中添加一个元标记, 并带有独特的构建版本散列 :

```html
<meta name="contember-build-version" content="[MD5_HASH]">
```

此用于过时的应用程序检查 .

## 类型脚本支持

该插件包括了TypeScript定义,并被配置为与TypeScript项目合作.

## 兼容性

此插件与Vite版本4和5兼容.

## 常见问题

### @contember/vite-plugin 是什么？

@contember/vite-plugin 是一个 Vite 插件,旨在增强 Contember 应用程序的 Vite 构建进程。 它提供配置选项和中间软件来简化开发并构建进程\.

### 如何安装 @contember/vite-plugin？

在项目目录运行 npm install @contember/vite-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vite（^4 \|\| ^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @contember/vite-plugin 支持 TypeScript 吗？

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

### @contember/vite-plugin 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @contember/vite-plugin 可以商用吗？

@contember/vite-plugin 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @contember/vite-plugin 的下载量有多少？

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

### @contember/vite-plugin 还在维护吗？

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