日常前端 web 项目开发中，对于支持多国语言的业务系统，需要进行前端文案的国际化，此过程需要前端开发人员进行项目文案收集和整理，供翻译人员进行翻译后，再导入到项目代码中。该流程往往非常重复繁琐，存在工作效率低，又容易出错的问题。
由此我结合一些代码解析工具，针对该工作流程开发了此系统。通过该系统，无需手工提取、收集、整理、录入国际化文案，只需部署好系统，输入系统 Github/GitLab 地址等配置，即可自动化处理以上流程。
更多说明请参考掘金文章：前端国际化自动工具-国际化文案配置系统
系统架构如图所示：
其中，文案解析器结构为
其系统运行流程是：
- 翻译人员打开 自动国际化文案配置系统 前端页面
- 每当前端页面进行
刷新，页面会调用接口,通知系统后台进行业务项目源代码的拉取和更新 - 对应地，系统后台执行更新业务项目源代码，并使用
文案解析器对源代码进行解析，自动化读取和收集业务代码的中文文案 key，再经过系统整理、去重后，同步进数据库 - 系统后台将收集到的中文文案 key 回传到系统前端页面
- 翻译人员进行文案的翻译、修改、更新、删除等操作
- 翻译人员完成翻译工作后，通知到前端开发人员
- 前端开发人员手动下载已经翻译好的文案json，导入到业务代码里；或者可使用辅助插件 @mango-scripts/i18n-scripts 进行一键下载导入
可以看到，这个过程，作为前端开发，无需参与其中文案的提取工作，从繁杂无聊的文案 key 的提取中解放出来，而最后的文案录入工作，也有辅助插件一键完成
那么，作为前端开发，只需要在业务项目的初期，部署接入该自动国际化文案配置系统，然后，在需求代码编写中，就像国内的中文项目一样，文案 key 使用中文，每次业务代码完成时，通知翻译人员进行文案翻译，待翻译工作结束后，执行项目辅助脚本，一键更新到本地项目里面
以下是系统部分预览图
登录页面
管理员账号注册页面
系统注册默认邀请码：
mango-i18n-system-invitation-code,可用于管理员账户的注册，可在项目部署前，手动修改该环境变量来变更（文件地址：mango- i18n-system/packages/server/.env）
文案配置页面
添加翻译词条
操作记录页面
人员配置
解析配置
账户设置
- 自动拉取业务项目源代码
- 自动提取业务项目代码
中文文案 key到系统中 - 支持使用辅助插件 @mango-scripts/i18n-scripts 进行一键下载、导入语言包到业务项目
本地代码中 - 支持
用户管理、操作记录等常规后台管理系统功能，方便对文案变更作全流程跟踪 - 支持
正则表达式、AST两种解析方式 - 支持
vue、js、jsx、mjs、ts、tsx、mts、svelte等多种格式文件 - 支持
配置文案模块标识，配置无需提取的文案等功能 - 支持文案的
excel、json等格式的上传以及下载 - 系统使用文件 hash 进行
缓存，未修改过的业务代码文件不作解析，提高解析速度 - 部署方便，使用 docker 一键部署
- 系统前后端全栈 采用
TypeScript进行编写 - 文案解析器：@mango-scripts/i18n-utils：基于 babel、vue-template-compiler、hyntax、pug、svelte/compiler 等 对目标源码进行 AST 解析与提取
- 辅助插件：@mango-scripts/i18n-scripts：基于 commander、fs-extra、glob、inquirer、undici 等
- 系统前端基于 react@18、react-router@6、zustand、antd@5、echarts、react-json-view、nginx、rsbuild 等
- 系统后台主要采用 nestjs 全家桶 以及 typeorm、execa、exceljs、glob、jsonwebtoken，tsup 等
- 数据库方案采用轻量级数据库 splite3
- 项目部署基于 docker，使用 docker-compose 一键部署
只需要简单几步即可部署好系统
-
准备一台公司内部空闲的服务器，下载
docker以及docker-compose，以及谷歌 zx 插件 zx -
在服务器上找一个空目录，例如：
/home/app/i18n/，进入该目录，克隆该项目源码到目录里面
git clone https://github.com/AlbertLin0923/mango-i18n-system.git- 切换到该
项目根目录上
cd /home/app/i18n/mango-i18n-system/-
在
项目根目录执行zx ./scripts/adapt.mjs，该命令会帮助你修改项目配置文件，以适配你的 系统部署端口 -
执行
docker-compose up -d进行 docker-compose 一键部署
这时候打开服务器对应的项目端口，例如：http://host:port/user/login （ host 为该内网服务器 IP 地址，port 为我们刚才设置的端口） 就可以看到项目已经启动
此时,进入项目地址, 应该能看到项目已经部署好了
-
登录 http://host:port/user/login 进行账户的注册或者登录
系统注册默认邀请码：
mango-i18n-system-invitation-code,可用于管理员账户的注册，可在项目部署前，手动修改该环境变量来变更（文件地址：mango- i18n-system/packages/server/.env） -
登录后 进入
系统配置-人员配置系统配置-界面配置系统配置-解析配置进行项目配置
- 如上文提到，编码过程需要以
中文作为文案，具体使用可参考该项目mango-i18n-system/packages/client代码 - 业务项目 下载脚本插件
pnpm add @mango-scripts/i18n-scripts -D， - 业务项目
package.json里添加更新指令：
"scripts": {
"updateLocale": "i18n-scripts updateLocale --address http://xxx:5003/api/locale/get_locale_map --output ./src/locales/common/ --localeList zh-CN en-US id-ID"
}其中
--address 部署的服务器的地址和端口，例如：http://xxx:5003/api/locale/get_locale_map
--output 在业务项目里存储语言包的目录地址，例如：./src/locales/common/
--localeList 需要下载的语言包列表，例如：zh-CN en-US id-ID
- 当需要更新语言包的时候，只需要执行
pnpm run updateLocale即可
系统支持文案添加模块标识，便于翻译人员进行筛选，前端开发人员可通过如下注释对业务源代码进行标识：
例如：在目标 src/views/xxx/index.vue文件最上面加注释：
<!-- translateModules:["需求2022009","需求2020102"] -->或者，在 src/utils/request.ts文件最上面添加注释：
// translateModules:["需求2022009","需求2020102"]系统会自动读取模块标识，该文件下的所有提取到的中文 key 文案，都将带有属性 modules:'需求2022009,需求2020102'，方便在系统前端上进行区分和筛选
系统会默认忽视业务代码里面的注释。但有些时候，我们一些未被注释的特殊的中文文案 key 并不想被自动文案配置系统提取，这时候，我们可以在 AST 解析模式下，使用类似eslint-disable的注释效果，以注释不需要提取的中文文案 key
// 这种注释引擎会忽略整个文件中文文案key的提取，优先级最高
// translate-disable-entire-file
const getFilterStatusMap = (statusMap, type) => {
if (type === 'pendingCase') {
return statusMap.filter((i) => {
return (
// 这种注释引擎会忽略提取中间包裹的代码段中的中文文案key
// translate-disable
i.text === '待处理' ||
i.text === '处理中'
// translate-disable
)
})
} else if (type === 'allCase') {
return statusMap.filter((i) => {
return (
// 下面注释引擎会忽略提取 下一行 代码的中文文案key
// translate-disable-next-line
i.text === '已处理'
)
})
} else if (type === 'myCase') {
return statusMap.filter((i) => {
return (
// 下面注释引擎会忽略提取 当前行 代码的中文文案key
i.text === '无需处理' || // translate-disable-line
)
})
} else {
return statusMap
}
}项目源码地址
- 改善部署体验
- 文案解析器支持小程序等更多格式的文件