Vite中怎么手写一个符合Rollup规范的自定义插件以在打包时自动将代码中的特定中文字符串提取为国际化Json

落晨大大_2677

落晨大大_2677

2026-07-23

569人浏览

原创

vite 中可通过 rollup 插件实现中文字符串自动提取:利用 transform 钩子结合 ast 解析识别 $t() 或 i18n 前缀字符串,buildend 时合并去重并生成 locales/zh-cn.json,支持开发热更与生产构建,需 enforce: 'pre' 且兼容 vue sfc 和 esm/cjs。

vite中怎么手写一个符合rollup规范的自定义插件以在打包时自动将代码中的特定中文字符串提取为国际化json

在 Vite 中手写一个符合 Rollup 规范的自定义插件,用于在构建时自动提取代码中的中文字符串生成国际化 JSON 文件,核心是利用 Rollup 的 transform 钩子扫描源码、匹配中文(或带标记的字符串),再通过 buildEnd 或 generateBundle 写出 JSON。关键在于:精准识别目标字符串、避免误提、支持多文件合并、保证路径和格式正确。

识别中文字符串并标记提取点

不建议简单用正则匹配所有中文(易误伤注释、HTML、变量名等),推荐约定提取方式,比如统一用特定函数包裹:$t('按钮文字')、i18n('提交成功'),或使用带前缀的模板字面量:`i18n:确认删除?`。插件在 transform 阶段对每个 .ts/.js/.vue 文件做 AST 解析(可用 @babel/parser 或轻量 acorn),只提取符合约定的字符串字面量,并记录其来源文件路径、行号(可选)、原始内容。

  • Vue 单文件组件需额外处理 <template></template> 中的文本(可用 @vue/compiler-sfc 提取 template AST)
  • 跳过 node_modules 和非源码目录(如 dist、public)
  • 对重复字符串去重,但保留首次出现位置(便于后期定位)

收集结果并在构建结束时生成 JSON

用插件闭包或 this.meta(Rollup 插件上下文)维护一个全局 map,key 为字符串原文,value 包含文件列表、是否已翻译标记等。在 buildEnd 钩子中汇总所有提取项,按需整理成扁平结构或嵌套结构(如按模块分组),然后调用 fs.writeFileSync 输出到指定路径(例如 locales/zh-CN.json)。注意确保输出目录存在,可借助 fs.mkdirSync(..., { recursive: true })。

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
  • JSON 内容推荐保留原始字符串作为 key,value 初始设为空字符串或占位符(如 "TODO"),方便后续人工补译
  • 可选添加头部注释说明生成时间、来源文件数等信息
  • 避免覆盖已有翻译——可先读取旧 JSON,仅更新新增 key,保留已有翻译值

兼容 Vite 开发与生产构建流程

Vite 默认开发服务器(vite dev)不触发 buildEnd,所以提取逻辑应同时响应 handleHotUpdate(热更时重新扫描单个文件)和 buildEnd(全量构建时汇总)。开发阶段可将提取结果暂存内存或临时 JSON,供 HMR 调试;生产构建(vite build)才真正落盘。另外,插件需声明 enforce: 'pre',确保在其他插件(如 TypeScript 编译)之前运行,避免代码已被转译而丢失原始字符串。

  • Vue SFC 的 script setup 语法需兼容 defineProps、defineEmits 等宏,提取时不破坏语法结构
  • 支持 ESM / CJS 混合项目,插件本身导出为 ESM 格式,且不依赖 Node.js 特有 API(如需跨平台,避免 __dirname)
  • 可通过插件选项控制是否启用提取(disabled: true)、输出路径、匹配模式等

简单示例插件骨架

以下是一个最小可行插件结构(省略 AST 解析细节,聚焦流程):

export function i18nExtractPlugin(options = {}) {
  const { outDir = 'locales', lang = 'zh-CN', disabled = false } = options;
  const messages = new Map();

  return {
    name: 'i18n-extract',
    enforce: 'pre',
    transform(code, id) {
      if (disabled || /node_modules|\.d\.ts$/.test(id)) return;
      // 此处用正则或 AST 提取 $t('xxx') 中的 'xxx'
      const matches = code.match(/\$t\(['"`]([^'"`]+)['"`]\)/g);
      if (matches) {
        matches.forEach(match => {
          const str = match.match(/\$t\(['"`]([^'"`]+)['"`]\)/)?.[1];
          if (str && /^[\u4e00-\u9fa5\s,。!?;:“”‘’()【】《》、]+$/.test(str)) {
            messages.set(str, messages.get(str) || []);
            messages.get(str).push({ file: id });
          }
        });
      }
    },
    buildEnd() {
      const json = Object.fromEntries(messages.entries());
      const fullPath = `${outDir}/${lang}.json`;
      fs.writeFileSync(fullPath, JSON.stringify(json, null, 2), 'utf-8');
      console.log(`[i18n] Extracted ${messages.size} strings to ${fullPath}`);
    }
  };
}

实际项目中建议用 @babel/parser + @babel/traverse 替代正则,提升健壮性。插件挂载到 vite.config.ts 的 plugins 数组即可生效。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4966

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1229

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4884

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

960

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1876

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3505

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4553

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3000

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

948

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 81.2万人学习

Symfony教程(入门篇+基础篇)
Symfony教程(入门篇+基础篇)

共18课时 | 1.8万人学习

Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习