Transmart 开源项目教程

Transmart 开源项目教程

1. 项目介绍

Transmart 是一个开源的开发者工具，利用 ChatGPT 自动化进行国际化（i18n）翻译。给定一个基础语言并指定所有需要输出的语言，运行后将生成所有 i18n 语言文件。Transmart 由两部分组成：Cli 和 Core。Core 是 Transmart 的 NodeJS 核心实现，而 Cli 是一个封装了 Core 的命令行工具。在大多数情况下，只需要使用 Cli。

主要功能

• 支持大尺寸文件，无需担心 4096 个 token 的限制。
• 支持所有可以通过 Intl.DisplayNames 显示并能被 ChatGPT 处理的语言。
• 支持覆盖 AI 翻译的值。
• 支持 i18next、vue-i18n、Chrome i18n 等。
• 支持 Glob 命名空间匹配。
• 支持自定义 OpenAI 模型和 API 端点。
• 支持自定义语言文件结构。
• 支持 iOS 和 Android。

2. 项目快速启动

安装

首先，确保你的 Node 版本为 13 或更高。然后，通过以下命令安装 Transmart：

npm install @transmart/cli -D
# 或者
yarn add @transmart/cli

项目设置

在项目的根目录下创建一个 transmart.config.js 文件，或者使用 cosmiconfig 可以搜索到的任何文件格式。以下是一个示例配置：

module.exports = {
  baseLocale: 'en',
  locales: ['fr', 'jp', 'de'],
  localePath: 'public/locales',
  openAIApiKey: 'your-own-openai-api-key',
  overrides: {
    'zh-CN': {
      common: {
        create_app: '创建我的应用程序'
      }
    }
  }
};

翻译

将 transmart 命令添加到你的 npm 脚本中：

{
  "scripts": {
    "translate": "transmart"
  }
}

然后执行以下命令进行翻译：

npm run translate

或者直接使用 npx 命令：

npx transmart

如果你对 AI 翻译的结果不满意，可以使用 overrides 选项部分覆盖生成的 JSON 文件。

3. 应用案例和最佳实践

应用案例

Transmart 可以广泛应用于需要多语言支持的项目中，例如：

• 国际化网站
• 多语言移动应用
• 跨语言的桌面应用程序

最佳实践

• 配置文件优化：根据项目需求，合理配置 transmart.config.js 文件，确保覆盖所有需要的语言和路径。
• 自定义翻译：使用 overrides 选项对 AI 翻译的结果进行微调，确保翻译的准确性和一致性。
• 定期更新：随着项目的迭代，定期运行 Transmart 以更新语言文件，确保所有语言版本的一致性。

4. 典型生态项目

i18next

i18next 是一个流行的国际化框架，广泛用于前端项目中。Transmart 支持 i18next 的格式，可以直接生成 i18next 所需的语言文件。

vue-i18n

vue-i18n 是 Vue.js 的国际化插件，Transmart 也支持生成 vue-i18n 所需的语言文件，方便 Vue 开发者进行国际化开发。

Chrome i18n

Chrome 扩展程序的国际化也可以通过 Transmart 来实现，生成 Chrome 扩展所需的语言文件。

通过以上模块的介绍，你可以快速上手并使用 Transmart 进行国际化翻译，提升项目的多语言支持能力。