配置

概述

gt.config.json 文件用于配置项目的 GT 设置。它应该放置在项目的根目录中。

CLI 命令 npx gtx-cli init 将在您的项目中创建一个 gt.config.json 文件。

配置

gt.config.json 文件包含以下设置：

defaultLocale：项目的默认语言环境。这是您的源内容所使用的语言环境。这也是您项目的后备语言环境（如果使用 gt-next 或 gt-react）。
locales：项目的语言环境数组。这些是您想要将项目翻译成的语言环境。有关更多信息，请参阅支持的语言环境。如果您使用的是 gt-next 或 gt-react，这些也是您的应用程序支持的语言环境。
files：这是一个包含您想要翻译的内容信息的对象。

以下是 gt.config.json 文件的基本框架：

gt.config.json

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "..."
    },
    "json": {
      "include": [...]
    },
    "mdx": {
      "include": [...]
    },
    "md": {
      "include": [...]
    }
  }
}

示例配置

让我们分解一个 gt.config.json 文件示例：

gt.config.json

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "public/i18n/[locale].json"
    },
    "mdx": {
      "include": ["content/docs/[locale]/**/*.mdx"],
      "transform": "*.[locale].mdx"
    },
    "json": {
      "include": ["resources/[locale]/**/*.json"],
      "exclude": ["resources/[locale]/exclude/**/*.json"]
    }
  }
}

在这个示例中，我们通过一次调用 gtx-cli translate 来翻译以下文件：

content/docs/en 目录中的所有 MDX 文件。
resources/en 目录中的所有 JSON 文件（不包括 resources/en/exclude 目录中的任何文件）。
您的 React 或 Next.js 项目中所有内联的 <T> 组件。
您的 dictionary.[json|js|ts] 文件。

GT：翻译将保存到 public/i18n/es.json 和 public/i18n/fr.json。这些文件可以使用 loadTranslations() 加载。

MDX：翻译将保存到 content/docs/fr 和 content/docs/es 目录。文件扩展名将从 .mdx 分别更改为 .fr.mdx 和 .es.mdx。

JSON：翻译将保存到 resources/fr 和 resources/es 目录。

支持的文件类型

files 应包含您想要翻译的每种文件类型的键。您可以配置您的项目混合搭配不同的文件类型，并将它们全部翻译。我们目前支持以下文件类型：

gt：通用翻译文件。
json：JSON文件。
mdx：Markdown组件（MDX）文件。
md：Markdown（MD）文件。

每种文件类型应对应一个包含以下一个或多个键的对象：

include
exclude
transform
output

`include`

如果使用，include 键的值应该是一个匹配您想要翻译的文件的glob模式数组。

您应该在glob模式中使用 [locale] 占位符，以确保使用正确的语言环境。 CLI工具在搜索可翻译文件时，会将 [locale] 占位符替换为 defaultLocale 值。

CLI工具将把翻译后的文件保存到相应的路径，其中 [locale] 占位符被替换为语言代码。

{
  "include": ["docs/[locale]/**/*.json"]
}

`exclude`

如果使用，exclude 键的值应该是一个匹配您想要排除在翻译之外的文件的glob模式数组。

模式与 include 模式相同。

{
  "exclude": ["docs/[locale]/exclude/**/*.json"]
}

`transform`

如果使用，transform 键的值应该是一个定义文件名重映射的字符串。它应该包含一个通配符 *，该通配符将被替换为原始文件名（第一个 . 之前的任何内容）。

例如，如果您希望所有翻译文件的扩展名为 .[locale].json 而不是 .json，您可以使用以下配置：

{
  "transform": "*.[locale].json"
}

如果您的文档或i18n框架需要特定的文件扩展名用于翻译文件，而不是基于子目录的语言环境路由，这将非常有用。

`output`

此键专门用于通用翻译文件，特别是用于本地保存翻译。如果您使用的是GT CDN，则不需要此键。

该值应该是一个包含 [locale] 占位符的字符串，指示翻译将被保存的位置。

例如，如果您想将西班牙语翻译保存到 public/i18n 目录中名为 ui.es.json 的文件中，您应该使用以下字符串：

{
  "output": "public/i18n/[locale].json"
}

此选项仅在您使用 gt-next 或 gt-react，并希望本地保存翻译而不是使用GT CDN时使用。

目前，每个语言环境只能生成一个文件。

文件类型：`gt`

支持的键

output（必需）

示例

gt.config.json

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "public/i18n/[locale].json"
    },
  }
}

此配置将使CLI工具将您的法语和西班牙语翻译保存到public/i18n/[locale].json目录中。

默认情况下，CLI工具不会使用此配置将您的翻译发布到GT CDN。

文件类型：`json`

支持的键

include（必需）
exclude（可选）
transform（可选）

示例

gt.config.json

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "json": {
      "include": ["json_files/[locale]/**/*.json"],
      "exclude": ["json_files/[locale]/exclude/**/*.json"]
    }
  }
}

假设您项目的默认语言是en，您想将项目翻译成fr和es。

使用此配置，CLI将搜索json_files/en/子目录下的所有JSON文件，并将翻译后的文件保存到json_files/fr/和json_files/es/。

它将忽略json_files/en/exclude/子目录中的任何文件。

文件类型：`mdx`

支持的键

include（必需）
exclude（可选）
transform（可选）

示例

gt.config.json

{
  "defaultLocale": "en",
  "locales": ["ja"],
  "files": {
    "mdx": {
      "include": ["content/docs/[locale]/**/*.mdx"],
      "transform": "*.[locale].mdx"
    }
  }
}

此配置将告诉CLI工具搜索content/docs/en目录下的所有MDX文件，并将翻译后的文件保存到content/docs/ja目录。

transform键会使翻译文件的扩展名更改为.ja.mdx。

文件类型：`md`

支持的键

include（必需）
exclude（可选）
transform（可选）

示例

gt.config.json

{
  "defaultLocale": "en",
  "locales": ["ja"],
  "files": {
    "md": {
      "include": ["content/docs/[locale]/**/*.md"],
      "exclude": ["content/docs/[locale]/exclude/**/*.md"],
      "transform": "*.[locale].md"
    }
  }
}

此配置将告诉CLI工具搜索content/docs/en目录下的所有MD文件，并将翻译后的文件保存到content/docs/ja目录。

transform键会使翻译文件的扩展名更改为.ja.md。

content/docs/en/exclude目录中的所有文件将被忽略。

下一步

了解如何使用 init 命令生成此配置文件。

配置

在本页面