# @formatjs/vite-plugin 中文文档

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

版本：1\.1\.0
npm 元数据更新时间：2026-03-16T03:04:50.932Z
中文译文更新时间：2026-11-15T08:32:28.425Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：3.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：vite \>=7
- 首次发布：2026-02-19T04:12:24.229Z
- 最新版本发布：2026-03-16T03:04:50.643Z
- 近 30 天下载量：12724（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

格式JS AST 转换的虚拟插件

## 安装

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

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

## README

# @ formjs/vite-plugin (中文(简体) )

格式JS AST 转换的 Vite 插件 。 复制 `babel-plugin-formatjs` 财务报告和审定财务报表 `@formatjs/ts-transformer` 使用 `oxc-parser` + 键 `magic-string` 对于快速,编译器-不可知性构建.

## 安装

```bash
npm install @formatjs/vite-plugin --save-dev
```

## 使用量

```ts
// vite.config.ts
import {defineConfig} from 'vite'
import formatjs from '@formatjs/vite-plugin'

export default defineConfig({
  plugins: [
    formatjs({
      idInterpolationPattern: '[sha512:contenthash:base64:6]',
      ast: true,
    }),
  ],
})
```

## 选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `idInterpolationPattern` | `string` | `[sha512:contenthash:base64:6]` | 生成消息ID的模式 |
| `overrideIdFn` | `function` | —— 说 | 自定义生成消息ID的功能 |
| `removeDefaultMessage` | `boolean` | `false` | 删除 `defaultMessage` 来自产出 |
| `additionalComponentNames` | `string[]` | `[]` | 要处理的额外 JSX 组件名称 |
| `additionalFunctionNames` | `string[]` | `[]` | 要处理的额外函数名称 |
| `ast` | `boolean` | `false` | 预览 `defaultMessage` 输入 AST |
| `preserveWhitespace` | `boolean` | `false` | 在信件中保留原空白 |

## 常见问题

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

格式JS AST 转换的虚拟插件

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

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

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

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

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

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

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

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

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

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

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

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