JSON 字典

使用 Lingo.dev CLI 进行 JSON 字典文件的 AI 翻译

什么是 JSON Dictionary?

JSON Dictionary 是一种本地化格式,它将多个语言环境的所有翻译存储在一个 JSON 文件中。每个键包含一个对象,该对象以语言环境代码为键,以翻译后的字符串为值,从而便于在一个地方维护所有翻译。

例如:

{
  "navigation": {
    "en": "Home"
  },
  "buttons": {
    "submit": {
      "en": "Submit"
    },
    "cancel": {
      "en": "Cancel"
    }
  },
  "forms": {
    "login": {
      "username": {
        "en": "Username"
      }
    }
  }
}

什么是 Lingo.dev CLI?

Lingo.dev CLI 是一个免费的开源命令行工具,用于使用 AI 翻译应用程序和内容。它旨在取代传统的翻译管理软件,同时与现有的管道集成。

要了解更多信息,请参阅 概述

关于本指南

本指南解释了如何使用 Lingo.dev CLI 翻译 JSON 字典文件。

您将学习如何:

  • 从头开始创建项目
  • 配置翻译管道
  • 使用 AI 生成翻译

先决条件

要使用 Lingo.dev CLI,请确保已安装 Node.js v18+:

❯ node -v
v22.17.0

第 1 步:设置项目

在项目目录中,创建一个 i18n.json 文件:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

此文件定义了翻译管道的行为,包括要翻译的语言以及文件系统中可本地化内容的位置。

要了解更多可用属性,请参阅 i18n.json

第 2 步:配置源语言环境

源语言环境 是您的内容所使用的原始语言和地区。要配置源语言环境,请在 i18n.json 文件中设置 locale.source 属性:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

源语言环境必须以 BCP 47 语言标签 的形式提供。

有关 Lingo.dev CLI 支持的语言环境代码的完整列表,请参阅 支持的语言环境代码

第 3 步:配置目标语言环境

目标语言环境 是指您希望将内容翻译成的语言和地区。要配置目标语言环境,请在 i18n.json 文件中设置 locale.targets 属性:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

第 4 步:创建源内容

如果尚未创建,请创建一个包含待翻译内容的 JSON 字典文件。

注意: 在翻译过程中,源内容文件将被覆盖,以包括翻译后的内容(以及源内容)。

第 5 步:创建存储桶

  1. i18n.json 文件中,向 buckets 对象添加一个 "json-dictionary" 对象:

    {
      "$schema": "https://lingo.dev/schema/i18n.json",
      "version": "1.10",
      "locale": {
        "source": "en",
        "targets": ["es"]
      },
      "buckets": {
        "json-dictionary": {}
      }
    }
    
  2. "json-dictionary" 对象中,定义一个或多个 include 模式的数组:

    {
      "$schema": "https://lingo.dev/schema/i18n.json",
      "version": "1.10",
      "locale": {
        "source": "en",
        "targets": ["es"]
      },
      "buckets": {
        "json-dictionary": {
          "include": ["./example.json"]
        }
      }
    }
    

    这些模式定义了需要翻译的文件,可以是:

    • 指定的文件路径(例如:"some/dir/file.json"
    • 使用星号作为通配符的路径(例如:"some/dir/*.json"

    不支持递归的 glob 模式(例如:**/*.json)。

第 6 步:配置 LLM

Lingo.dev CLI 使用大型语言模型(LLM)通过 AI 翻译内容。要使用这些模型之一,您需要从支持的提供商处获取 API 密钥。

为了尽快开始,我们推荐使用 Lingo.dev Engine —— 我们自己的托管平台,提供每月 10,000 个免费令牌的使用额度:

  1. 注册一个 Lingo.dev 账户

  2. 运行以下命令:

    npx lingo.dev@latest login
    

    这将打开您的默认浏览器并要求您进行身份验证。

  3. 按照提示操作。

第 7 步:生成翻译

在包含 i18n.json 文件的目录中,运行以下命令:

npx lingo.dev@latest run

此命令将执行以下操作:

  1. 读取 i18n.json 文件。
  2. 查找需要翻译的文件。
  3. 从文件中提取可翻译内容。
  4. 使用配置的 LLM 翻译提取的内容。
  5. 将翻译后的内容写回文件系统。

首次生成翻译时,会创建一个 i18n.lock 文件。此文件会跟踪已翻译的内容,防止后续运行时不必要的重复翻译。

示例

example.json(翻译前)

{
  "navigation": {
    "en": "Home"
  },
  "buttons": {
    "submit": {
      "en": "Submit"
    },
    "cancel": {
      "en": "Cancel"
    }
  },
  "messages": {
    "welcome": {
      "en": "Welcome to our application"
    },
    "error": {
      "en": "An error occurred"
    }
  },
  "forms": {
    "login": {
      "title": {
        "en": "Login"
      },
      "fields": {
        "username": {
          "en": "Username"
        },
        "password": {
          "en": "Password"
        }
      }
    }
  }
}

example.json(翻译后)

{
  "navigation": {
    "en": "Home",
    "zh": "首页"
  },
  "buttons": {
    "submit": {
      "en": "Submit",
      "zh": "提交"
    },
    "cancel": {
      "en": "Cancel",
      "zh": "取消"
    }
  },
  "messages": {
    "welcome": {
      "en": "Welcome to our application",
      "zh": "欢迎使用我们的应用程序"
    },
    "error": {
      "en": "An error occurred",
      "zh": "发生了一个错误"
    }
  },
  "forms": {
    "login": {
      "title": {
        "en": "Login",
        "zh": "登录"
      },
      "fields": {
        "username": {
          "en": "Username",
          "zh": "用户名"
        },
        "password": {
          "en": "Password",
          "zh": "密码"
        }
      }
    }
  }
}

i18n.json

{
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "json-dictionary": {
      "include": ["./example.json"]
    }
  },
  "$schema": "https://lingo.dev/schema/i18n.json"
}

i18n.lock

version: 1
checksums:
  455da9346f4e772000927cd2ff5bb898:
    navigation: 104a3db3b671c04e167eafbe21e57881
    buttons/submit: 7c91ef5f747eea9f77a9c4f23e19fb2e
    buttons/cancel: 2e2a849c2223911717de8caa2c71bade
    messages/welcome: 1308168cca4fa5d8d7a0cf24e55e93fc
    messages/error: 53a2b5f5e7d83c737c8e02fe18fb4bdb
    forms/login/title: f4f219abeb5a465ecb1c7efaf50246de
    forms/login/fields/username: 2ee65bc2dd2f12cf2672f95b2a054bf8
    forms/login/fields/password: 223a61cf906ab9c40d22612c588dff48
  a8f80a1a4e0e0aa2750e514a8a6abacf:
    navigation: 104a3db3b671c04e167eafbe21e57881
    buttons/submit: 7c91ef5f747eea9f77a9c4f23e19fb2e
    buttons/cancel: 2e2a849c2223911717de8caa2c71bade
    messages/welcome: 1308168cca4fa5d8d7a0cf24e55e93fc
    messages/error: 53a2b5f5e7d83c737c8e02fe18fb4bdb
    forms/login/title: f4f219abeb5a465ecb1c7efaf50246de
    forms/login/fields/username: 2ee65bc2dd2f12cf2672f95b2a054bf8
    forms/login/fields/password: 223a61cf906ab9c40d22612c588dff48