快速开始

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

安装

npm install -g @ansstory/hitf

要求 Node.js >= 18。

安装后可以检查命令：

hitf -v
hitf --help

初始化配置

进入需要翻译的业务项目目录，例如：

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

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

如果有翻译服务商密钥，可填写到配置中：

{
  "translationSetting": {
    "translationService": "tencent",
    "services": {
      "tencent": {
        "secretId": "your_secret_id",
        "secretKey": "your_secret_key"
      }
    },
    "locales": ["zh-CN", "en-US"],
    "outDir": ".hitf/lang",
    "replaceOriginalFile": false
  }
}

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

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

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

翻译单文件

hitf tf src\views\demo\index.vue

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

常见输出：

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

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

hitf tfo src\views
# 你也可以预览
hitf tfo src\views demo -d -r .hitf\reports\demo.json

需要交互确认时使用：

hitf tfo src\views demo -i

导入公司翻译表

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

hitf tci .\.hitf\company.xlsx

推荐表格：

zh-CN	en-US	ja-JP
登录	Login	ログイン
正常状态	Normal Status	正常状態

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

检查语言包

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

hitf tcheck src -r .hitf\reports\tcheck.json

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