Skip to content

快速开始

本页演示如何在一个已有项目中使用 hias-cli 迁移源语言文案。源码可以是中文、英文,也可以是其它非英文语言。

安装

sh
npm i @ansstory/hias -g

要求 Node.js >= 18

安装后可以检查命令:

sh
hias -v
hias --help

初始化配置

进入需要翻译的业务项目目录,例如:

sh
# 初始化项目翻译设置
hias setting
# 将.hias放到忽略目录中防止appId与secretKey被提交
hias gitignore

命令会生成或打开项目级配置 .hias/setting.json

如果已经有翻译服务商密钥,可填写到配置中:

json
{
  "translationSetting": {
    "locales": ["zh-CN", "en-US"],
    "outDir": ".hias/lang",
    "replaceOriginalFile": false,
    "provider": "baidu",
    "appId": "your_app_id",
    "secretKey": "your_secret_key"
  }
}

如果没有密钥,也可以先迁移结构。工具会把源文案写入语言包,后续再补翻译。

如果源码本身是英文,调整 locales 顺序即可从英文翻译到其它语言:

json
{
  "translationSetting": {
    "locales": ["en-US", "zh-CN", "ja-JP"]
  }
}

翻译单文件

sh
hias tf src\views\demo\index.vue

默认 replaceOriginalFilefalse,会把翻译后的文件副本和语言包写到配置outDir指定的输出目录中。设置为 true 时才会直接替换原文件。

常见输出:

text
翻译结果已保存到: .hias\lang\demo

也可以批量翻译,翻译前建议先预览并保存报告:

sh
hias tfo src\views
# 你也可以预览
hias tfo src\views demo --dry-run --report .hias\reports\demo.json

需要交互确认时使用:

sh
hias tfo src\views demo --interactive

导入公司翻译表

如果公司已经提供中英文、日文等翻译表,建议先导入缓存:

sh
hias tci .\.hias\company.xlsx

推荐表格:

zh-CNen-USja-JP
登录Loginログイン
正常状态Normal Status正常状態

导入后再执行 hias tf,工具会优先读取 .hias/.translation-cache.json 中已有的翻译。

检查语言包

翻译后可以检查源码引用和语言包是否一致:

sh
hias tcheck src --report .hias\reports\tcheck.json

它会报告缺失 key、未使用 key、不同 locale JSON 之间不一致的 key,以及无法解析的 JSON 文件。

Released under the MIT License.