mango-i18n-system 自动国际化文案配置系统

为什么写这个系统

日常前端 web 项目开发中，由于公司项目需要支持多国语言，项目的代码文案需要提取、收集、整理出来，供翻译人员进行翻译，添加多国语言，再经过校对、审核后，导入到项目代码中。此过程往往非常重复繁琐，存在工作效率低，又容易出错的问题。由此结合一些代码解析工具，针对该工作流程开发了此系统。通过该系统，无需手工提取、收集、整理、录入国际化文案，只需部署好系统，输入系统 Github/GitLab 地址等配置，即可自动化处理以上流程。

更多说明请参考掘金文章：前端国际化自动工具-国际化文案配置系统

架构

系统架构如图所示：

其中，文案解析器结构为

其系统运行流程是：

翻译人员打开自动国际化文案配置系统前端页面
每次系统前端页面进行刷新，页面会调用更新源代码接口,通知系统后台进行业务项目源代码的拉取和更新
对应地，系统后台执行更新业务项目源代码，使用文案解析器对源代码进行解析，读取文案 key 的词条，收集、整理、去重后，同步到数据库
系统后台回传到系统前端页面
翻译人员进行文案的翻译、修改、更新、删除等操作
翻译人员完成翻译工作后，通知到前端开发
前端开发使用辅助插件 @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，ts，tsx，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@17, react-router@6, redux，rematch, Antd, echarts, react-json-view 等
系统后台主要采用 nestjs 全家桶以及 typeorm，execa， exceljs，glob，jsonwebtoken 等
数据库方案采用轻量级数据库 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 一键部署

这时候打开服务器对应的项目端口，例如：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
  }
}