暂存
如何暂存您的翻译以供审核
概述
gtx-cli stage 是一个为您的项目生成翻译并将其暂存以供审查的命令。
此命令仅在您的项目启用了人工审查时才有用。
目前，此命令仅支持使用 gt-next 或 gt-react 的应用程序。
使用方法
在为生产环境构建应用程序之前，请在您的 CI 流水线中运行此命令。
npx gtx-cli stage注意： 此命令需要生产环境 API 密钥！请在平台上获取一个。
gtx-cli stage 命令的工作方式与 translate 命令相同，但它不会下载已完成的翻译或将其发布到 CDN，而是简单地将它们暂存以供审查。
运行 gtx-cli stage 后，您应该运行 gtx-cli translate 来完成流程并下载翻译（如果配置为这样做）。
仅用于生产环境！
此命令适用于生产构建，不应在开发环境中使用。
在运行此命令之前，请确保您在将用于生产的分支上。
还要记住在环境变量中指定您的生产环境 API 密钥（GT_API_KEY）和项目 ID（GT_PROJECT_ID）。
Flags
| 参数 | 描述 | 类型 | 可选 | 默认值 |
|---|---|---|---|---|
--api-key | 指定生产环境 API 密钥 | string | true | |
--project-id | 指定项目 ID | string | true | |
--version-id | 指定版本 ID（默认为内容的哈希值） | string | true | |
--config <path> | 指定 GT 配置文件的路径 | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | 指定 TS 或 JS 配置文件的路径 | string | true | |
--src <paths> | 指定要扫描的源目录 | [string] | true | ./src && ./app && ./pages && ./components |
--dictionary <path> | 指定字典文件的路径 | string | true | |
--inline | 除了字典之外，还包含内联 <T> 标签 | boolean | true | true |
--timeout | 翻译请求的超时时间（秒） | number | true | 600 |
--new, --locales <locales> | 要将项目翻译成的语言环境 | [string] | true | |
--default-locale <locale> | 项目的源语言环境 | string | true | en |
--ignore-errors | 忽略错误并强制翻译有效内容 | flag | true | false |
--dry-run | 干运行命令 | flag | true | false |
所有这些参数都是可选的。
不要将您的 API 密钥添加到 gt.config.json 文件中！
您应该将其设置为环境变量。如果设置了 GT_API_KEY，CLI 将自动读取它。
有几个关键参数：
| 参数 | 描述 |
|---|---|
--dry-run | 此标志将使 CLI 解析和验证您的项目，但不会与 GT API 通信。这对于验证您的代码库很有用。 |
--api-key | 除非您使用 --dry-run，否则必须提供生产环境 API 密钥。 |
--project-id | 同样，除非您使用 --dry-run，否则必须提供项目 ID。 |
--new, --locales <locales> | 要将项目翻译成的语言环境。这些将附加到您的 gt.config.json 文件中指定的语言环境。 |
配置文件
运行 gtx-cli stage 时，CLI 将自动向您的 gt.config.json 文件添加 stageTranslations : true 属性。
此属性确保如果在特定部署版本中运行 translate 之前没有先运行 stage，
CLI 工具将报错并退出。
此外，此属性确保 translate 命令不会重复 stage 命令完成的翻译。
这份指南怎么样？