Skip to content

快速开始 ​

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

安装 ​

sh
npm install -g @ansstory/hitf

要求 Node.js >= 18。

安装后可以检查命令:

sh
hitf -v
hitf --help

初始化配置 ​

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

sh
# 初始化项目翻译设置
hitf setting
# 将 .hitf/services.json 添加到 .gitignore 防止 appId 与 secretKey 被提交
hitf gitignore

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

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

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 顺序即可从英文翻译到其它语言:

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

翻译单文件 ​

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

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

常见输出:

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

翻译文件夹 ​

批量翻译时建议先预览并保存报告:

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

-d / --dry-run 仅预览翻译计划:终端环境弹出只读树形界面(↑/↓ 移动、←/→ 展开/折叠、输入搜索、Enter 结束),非 TTY 环境自动回退为静态树形打印,不执行翻译、不写文件。

需要交互选择时使用:

sh
hitf tfo src\views demo -i

-i / --interactive 弹出树形多选框选择要翻译的文本(Space 勾选、Ctrl+A 全选、Ctrl+I 反选、Enter 确认),未选中的项会自动添加 @hitf-i18n-ignore-* 忽略注释,不参与翻译。

更多内容 ​

Released under the MIT License.