Lobe i18n

Lobe i18n 是一款使用 ChatGPT 自动化 i18n 的 CLI 流程工具

English ・简体中文・ Changelog · [Report Bug][issues-url] · [Request Feature][issues-url]

[![][npm-release-shield]][npm-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]

[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]

![](https://gw.alipayobjects.com/zos/kitchen/AH7rvv06qn/preview-i18n.webp)

文档目录

#### TOC

- ✨ 特性
- 📦 安装
- 🤯 使用
- 第一步：初始化配置
- 第二步：运行翻译命令
- 配置
- 环境变量
- 🌏 Locale 配置
- 文件结构选择
- 运行
- 📝 Markdown 配置
- 文件结构
- 运行
- ⌨️ 本地开发
- 🤝 参与贡献
- 🔗 链接
- More Products
- Credits

####

✨ 特性

- [x] 🤖 利用 ChatGPT 实现 i18n 翻译自动化
- [x] ✂️ 支持大型文件自动分割，不必担心 ChatGPT token 限制
- [x] ♻️ 支持 i18n 增量更新，按照 entry 文件自动提取新增内容
- [x] 🗂️ 支持单文件模式 en_US.json 和文件夹 en_US/common.json 模式，完美配合 i18next 使用
- [x] 🌲 支持 扁平 和 树状 locale 文件
- [x] 🛠️ 支持自定义 OpenAI 模型、API 代理、temperature、topP
- [x] 📝 支持 Markdown i18n 翻译自动化

[![][back-to-top]](#readme-top)

📦 安装

要安装 Lobe i18n，请运行以下命令：

``bash npm install -g @lobehub/i18n-cli`

> \[!IMPORTANT]\ > 请确保环境中Node.js 版本 >= 18

[![][back-to-top]](#readme-top)

`🤯 使用`

`$3`

要初始化配置 Lobe i8n，请运行以下命令：

`shell $ lobe-i18n -o # 或使用完整标志 --option`

`$3`

此命令将引导您逐步创建配置文件。

或者，您可以手动创建配置文件，支持的格式请参考 cosmiconfig （详见 Configuration）。

以下是一个配置文件示例（.i18nrc.js）：\ 此示例展示了如何基于locales/en_US.json 自动生成 locales/zh_CN.json 和 locales/ja_JP.json。

`javascript const { defineConfig } = require('@lobehub/i18n-cli');

module.exports = defineConfig({ entry: 'locales/en_US.json', entryLocale: 'en_US', output: 'locales', outputLocales: ['zh_CN', 'ja_JP'], });`

> \[!IMPORTANT]\ > 要使用 AI 自动生成，需要在设置中填写 OpenAI 令牌

`shell

`翻译 Locale 文件`


$ lobe-i18n
or

$ lobe-i18n locale
翻译 Markdown 文件

$ lobe-i18n md
Lint 校验翻译文件语言正确性

$ lobe-i18n lint
同时运行 i18n 翻译和 markdown 翻译

$ lobe-i18n --with-md
指定配置文件

$ lobe-i18n -c './custom-config.js' # or use the full flag --config



$3
可以按照 cosmiconfig 格式任选配置方式

- package.json 中的 i18n属性 - 以 JSON 或 YAML 格式的.i18nrc文件 -.i18nrc.json、.i18nrc.yaml、.i18nrc.yml、.i18nrc.js、.i18nrc.cjs 文件

> \[!TIP] > > 本项目提供了defineConfig 安全定义方法可以从 @lobehub/i18n-cli 中导入

`$3`

本项目提供了一些额外的配置项，使用环境变量进行设置：

| 环境变量 | 类型 | 描述 | 示例 | | ------------------ | ---- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | |OPENAI_API_KEY | 必选 | 这是你在 OpenAI 账户页面申请的 API 密钥 | sk-xxxxxx...xxxxxx| |OPENAI_PROXY_URL | 可选 | 如果你手动配置了 OpenAI 接口代理，可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL | https://api.chatanywhere.cn/v1默认值:https://api.openai.com/v1 |

[![][back-to-top]](#readme-top)

`🌏 Locale 配置`

| 属性名称 | 必填 | 类型 | 默认值 | 描述 | | --------------- | ---- | -------------- | --------------- | ------------------------------------------------------------ | | entry |* | string| - | 入口文件或文件夹 | | entryLocale |* | string| - | 作为翻译参考的语言 | | modelName | |string | gpt-3.5-turbo| 使用的模型 | | output |* | string| - | 存储本地化文件的位置 | | outputLocales |* | string[] | []| 需要进行翻译的所有语言 | | keyStyle | |string | nested | 处理点分隔键的方式：nested、flat 或 auto（按入口文件） | | reference | |string| - | 提供一些上下文以获得更准确的翻译 | | saveImmediately | |boolean | false| 在每个翻译块完成后立即保存翻译结果 | | splitToken | |number| - | 按令牌分割本地化 JSON 文件，默认自动计算 | | temperature | |number | 0| 使用的采样温度 | | topP | |number | 1| 生成过程中的核采样方法概率阈值，取值越大生成的随机性越高 | | concurrency | |number | 5| 同时并发的队列请求数量 | | experimental | |experimental | {}| 实验性功能，见下文 | | markdown | |markdown | {} | 见 markdown 配置说明 |

#### experimental

| 属性名称 | 必填 | 类型 | 默认值 | 描述 | | -------- | ---- | --------- | ------- | -------------------------------------------------------------- | | jsonMode | |boolean | false | 开启 gpt 强制 json 输出提升稳定性 (只支持 23 年 11 月后新模型) |

#### 示例一 .i18nrc.js

`js const { defineConfig } = require('@lobehub/i18n-cli');

module.exports = defineConfig({ entry: 'locales/en_US.json', entryLocale: 'en_US', output: 'locales', outputLocales: ['zh_CN', 'ja_JP'], });`

#### 示例二 .i18nrc.json

`json { "entry": "locales/en_US.json", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] }`

#### 示例三 package.json

`json { "...": "...", "i18n": { "entry": "locales/en_US.json", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] } }`

#### 示例四 - 启用立即保存

`js const { defineConfig } = require('@lobehub/i18n-cli');

module.exports = defineConfig({ entry: 'locales/en_US.json', entryLocale: 'en_US', output: 'locales', outputLocales: ['zh_CN', 'ja_JP'], saveImmediately: true, // 每个翻译块完成后立即保存结果 concurrency: 5, temperature: 0.3, });`

> \[!TIP] > > 启用saveImmediately 可以让你实时看到翻译进度，并提供更好的容错性。如果翻译过程中断，已完成的翻译块不会丢失。

[![][back-to-top]](#readme-top)

`$3`

支持两种文件结构，分别为 单文件 和 文件夹 结构

#### 单文件结构

单文件结构指的是所有语言的翻译都存储在一个文件中，如下所示：

`- locales - en_US.json - ja_JP.json - zh_CN.json - ...`

> \[!TIP] > >单文件结构 需要在配置文件中将 entry 配置为对应的 JSON 文件示例

`json { "entry": "locales/en.json", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] }`

文件夹结构

文件夹结构指的是每个语言的翻译都存储在对应的语种文件夹中，如下所示：

`- locales - en_US - common.json - header.json - subfolder - ... - ja_JP - common.json - header.json - subfolder - ... - zh_CN - common.json - header.json - subfolder - ...`

> \[!TIP] > >文件夹结构 需要在配置文件中将 entry 配置为对应的文件夹示例

`json { "entry": "locales/en_US", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] }`

`$3`

使用 lobe-i18n 命令自动化生成 i18n 文件：

`shell $ lobe-i18n`

[![][back-to-top]](#readme-top)

`📝 Markdown 配置`

| 属性名称 | 必填 | 类型 | 默认值 | 描述 | | ---------------- | ---- | --------------------------- | ---------------------------- | ----------------------------------------- | | entry |* | string[] | [] | 入口文件或文件夹，支持 glob| | entryLocale | |string| _继承同父级_ | 作为翻译参考的语言 | | entryExtension | |string | .md| 入口文件扩展名 | | exclude | |string[] | [] | 需要过滤的文件，支持 glob| | outputLocales | |string[]| _继承同父级_ | 需要进行翻译的所有语言 | | outputExtensions | |function | (locale) => '.{locale}.md'| 输出文件的扩展名生成 | | mode | |string,mdast,function | string| 翻译的模式选择，解释见下文 | | translateCode | |boolean | false | 在 mdast下是否翻译代码块，其他模式无效 | | includeMatter | |boolean | false | 是否翻译 front matter |

#### outputExtensions

默认生成的翻译后文件名为 .{locale}.md，可以通过 outputExtensions 自定义输出文件扩展名

> \[!NOTE] > > 在下方的示意中，入口文件扩展名为.zh-CN.md，但我们希望输出的 en-US 翻译文件扩展名为 .md, 其他语言保持默认

`js module.exports = { markdown: { entry: ['./README.zh-CN.md', './docs/*/.zh-CN.md'], entryLocale: 'zh-CN', entryExtension: '.zh-CN.md', outputLocales: ['en-US', 'ja-JP'], outputExtensions: (locale, { getDefaultExtension }) => { if (locale === 'en-US') return '.md'; return getDefaultExtension(locale); }, }, };`

> outputExtensions 完整支持的 props 如下：

`ts interface OutputExtensionsProps { /** * @description 输出的翻译文件的语种 */ locale: string; config: { /** * @description 输入的翻译文件的内容 */ fileContent: string; /** * @description 输入的翻译文件的路径 */ filePath: string; /** * @description 默认的扩展名生成方法 */ getDefaultExtension: (locale: string) => string; }; }`

#### mode

mode 用于指定翻译的模式，支持二种模式和自定义生成模式

- string - 使用完整的 markdown内容进行翻译 -mdast - 使用 mdast 结构化解析文本，指翻译 text value 文本内容，如需翻译代码块，需要开启 translateCode

> \[!WARNING] > >mdast模式下，将会把需要翻译的内容缩减到最低限度，移除大部分 markdown 语法结构和链接， > 此模式可大大减少 token 消耗，但是可能会导致翻译结果不准确。

[![][back-to-top]](#readme-top)

`$3`

翻译后的文件将生成在和入口文件同级的目录下，在扩展名上会添加对应的语种后缀：

`- README.md - README.zh-CN.md - docs - usage.md - usage.zh-CN.md - subfolder - ...`

> \[!TIP] > > 示例

`$3`

使用 lobe-i18n md 命令自动化生成 i18n 文件：

`shell $ lobe-i18n md`

[![][back-to-top]](#readme-top)

`⌨️ 本地开发`

可以使用 Github Codespaces 进行在线开发：

[![][github-codespace-shield]][github-codespace-link]

或者，可以克隆存储库并运行以下命令进行本地开发：

[![][bun-shield]][bun-link]

`bash $ git clone https://github.com/lobehub/lobe-cli-toolbox.git $ cd lobe-cli-toolbox $ bun install $ cd packages/lobe-i18n $ bun dev``

[![][back-to-top]](#readme-top)

🤝 参与贡献

我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues][github-issues-link]，大展身手，向我们展示你的奇思妙想。

[![][pr-welcome-shield]][pr-welcome-link]

[![][github-contrib-shield]][github-contrib-link]

[![][back-to-top]](#readme-top)

🔗 链接

$3

- [🤖 Lobe Chat][lobe-chat] - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.
- [🤯 Lobe Theme][lobe-theme] - The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.

$3

- OpenAI -
- ink -
- transmart -

[![][back-to-top]](#readme-top)

---

#### 📝 License

[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[bun-link]: https://bun.sh
[bun-shield]: https://img.shields.io/badge/-speedup%20with%20bun-black?logo=bun&style=for-the-badge
[github-action-release-link]: https://github.com/lobehub/lobe-cli-toolbox/actions/workflows/release.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-cli-toolbox/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/lobehub/lobe-cli-toolbox/actions/workflows/test.yml
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/lobehub/lobe-cli-toolbox/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-codespace-link]: https://codespaces.new/lobehub/lobe-cli-toolbox
[github-codespace-shield]: https://github.com/codespaces/badge.svg
[github-contrib-link]: https://github.com/lobehub/lobe-cli-toolbox/graphs/contributors
[github-contrib-shield]: https://contrib.rocks/image?repo=lobehub%2Flobe-cli-toolbox
[github-contributors-link]: https://github.com/lobehub/lobe-cli-toolbox/graphs/contributors
[github-contributors-shield]: https://img.shields.io/github/contributors/lobehub/lobe-cli-toolbox?color=c4f042&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/lobehub/lobe-cli-toolbox/network/members
[github-forks-shield]: https://img.shields.io/github/forks/lobehub/lobe-cli-toolbox?color=8ae8ff&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/lobehub/lobe-cli-toolbox/issues
[github-issues-shield]: https://img.shields.io/github/issues/lobehub/lobe-cli-toolbox?color=ff80eb&labelColor=black&style=flat-square
[github-license-link]: https://github.com/lobehub/lobe-cli-toolbox/blob/master/LICENSE
[github-license-shield]: https://img.shields.io/github/license/lobehub/lobe-cli-toolbox?color=white&labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/lobehub/lobe-cli-toolbox/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/lobehub/lobe-cli-toolbox?labelColor=black&style=flat-square
[github-stars-link]: https://github.com/lobehub/lobe-cli-toolbox/network/stargazers
[github-stars-shield]: https://img.shields.io/github/stars/lobehub/lobe-cli-toolbox?color=ffcb47&labelColor=black&style=flat-square
[issues-url]: https://github.com/canisminor1990/lobe-commit/issues/new/choose
[lobe-chat]: https://github.com/lobehub/lobe-chat
[lobe-theme]: https://github.com/lobehub/sd-webui-lobe-theme
[npm-release-link]: https://www.npmjs.com/package/@lobehub/i18n-cli
[npm-release-shield]: https://img.shields.io/npm/v/@lobehub/i18n-cli?color=369eff&labelColor=black&logo=npm&logoColor=white&style=flat-square
[pr-welcome-link]: https://github.com/lobehub/lobe-cli-toolbox/pulls
[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[profile-link]: https://github.com/lobehub

Lobe i18n

Lobe i18n 是一款使用 ChatGPT 自动化 i18n 的 CLI 流程工具

English ・简体中文・ Changelog · [Report Bug][issues-url] · [Request Feature][issues-url]

![](https://gw.alipayobjects.com/zos/kitchen/AH7rvv06qn/preview-i18n.webp)

文档目录

#### TOC

####

✨ 特性

[![][back-to-top]](#readme-top)

📦 安装

要安装 Lobe i18n，请运行以下命令：

``bash npm install -g @lobehub/i18n-cli`

> \[!IMPORTANT]\ > 请确保环境中Node.js 版本 >= 18

[![][back-to-top]](#readme-top)

`🤯 使用`

`$3`

要初始化配置 Lobe i8n，请运行以下命令：

`shell $ lobe-i18n -o # 或使用完整标志 --option`

`$3`

此命令将引导您逐步创建配置文件。

或者，您可以手动创建配置文件，支持的格式请参考 cosmiconfig （详见 Configuration）。

以下是一个配置文件示例（.i18nrc.js）：\ 此示例展示了如何基于locales/en_US.json 自动生成 locales/zh_CN.json 和 locales/ja_JP.json。

`javascript const { defineConfig } = require('@lobehub/i18n-cli');

module.exports = defineConfig({ entry: 'locales/en_US.json', entryLocale: 'en_US', output: 'locales', outputLocales: ['zh_CN', 'ja_JP'], });`

> \[!IMPORTANT]\ > 要使用 AI 自动生成，需要在设置中填写 OpenAI 令牌

`shell

`翻译 Locale 文件`


$ lobe-i18n
or

$ lobe-i18n locale
翻译 Markdown 文件

$ lobe-i18n md
Lint 校验翻译文件语言正确性

$ lobe-i18n lint
同时运行 i18n 翻译和 markdown 翻译

$ lobe-i18n --with-md
指定配置文件

$ lobe-i18n -c './custom-config.js' # or use the full flag --config



$3
可以按照 cosmiconfig 格式任选配置方式

- package.json 中的 i18n属性 - 以 JSON 或 YAML 格式的.i18nrc文件 -.i18nrc.json、.i18nrc.yaml、.i18nrc.yml、.i18nrc.js、.i18nrc.cjs 文件

> \[!TIP] > > 本项目提供了defineConfig 安全定义方法可以从 @lobehub/i18n-cli 中导入

`$3`

本项目提供了一些额外的配置项，使用环境变量进行设置：

[![][back-to-top]](#readme-top)

`🌏 Locale 配置`

#### experimental

#### 示例一 .i18nrc.js

`js const { defineConfig } = require('@lobehub/i18n-cli');

module.exports = defineConfig({ entry: 'locales/en_US.json', entryLocale: 'en_US', output: 'locales', outputLocales: ['zh_CN', 'ja_JP'], });`

#### 示例二 .i18nrc.json

`json { "entry": "locales/en_US.json", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] }`

#### 示例三 package.json

`json { "...": "...", "i18n": { "entry": "locales/en_US.json", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] } }`

#### 示例四 - 启用立即保存

`js const { defineConfig } = require('@lobehub/i18n-cli');

> \[!TIP] > > 启用saveImmediately 可以让你实时看到翻译进度，并提供更好的容错性。如果翻译过程中断，已完成的翻译块不会丢失。

[![][back-to-top]](#readme-top)

`$3`

支持两种文件结构，分别为 单文件 和 文件夹 结构

#### 单文件结构

单文件结构指的是所有语言的翻译都存储在一个文件中，如下所示：

`- locales - en_US.json - ja_JP.json - zh_CN.json - ...`

> \[!TIP] > >单文件结构 需要在配置文件中将 entry 配置为对应的 JSON 文件示例

`json { "entry": "locales/en.json", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] }`

文件夹结构

文件夹结构指的是每个语言的翻译都存储在对应的语种文件夹中，如下所示：

`- locales - en_US - common.json - header.json - subfolder - ... - ja_JP - common.json - header.json - subfolder - ... - zh_CN - common.json - header.json - subfolder - ...`

> \[!TIP] > >文件夹结构 需要在配置文件中将 entry 配置为对应的文件夹示例

`json { "entry": "locales/en_US", "entryLocale": "en_US", "output": "locales", "outputLocales": ["zh_CN", "ja_JP"] }`

`$3`

使用 lobe-i18n 命令自动化生成 i18n 文件：

`shell $ lobe-i18n`

[![][back-to-top]](#readme-top)

`📝 Markdown 配置`

#### outputExtensions

默认生成的翻译后文件名为 .{locale}.md，可以通过 outputExtensions 自定义输出文件扩展名

> \[!NOTE] > > 在下方的示意中，入口文件扩展名为.zh-CN.md，但我们希望输出的 en-US 翻译文件扩展名为 .md, 其他语言保持默认

> outputExtensions 完整支持的 props 如下：

#### mode

mode 用于指定翻译的模式，支持二种模式和自定义生成模式

- string - 使用完整的 markdown内容进行翻译 -mdast - 使用 mdast 结构化解析文本，指翻译 text value 文本内容，如需翻译代码块，需要开启 translateCode

[![][back-to-top]](#readme-top)

`$3`

翻译后的文件将生成在和入口文件同级的目录下，在扩展名上会添加对应的语种后缀：

`- README.md - README.zh-CN.md - docs - usage.md - usage.zh-CN.md - subfolder - ...`

> \[!TIP] > > 示例

`$3`

使用 lobe-i18n md 命令自动化生成 i18n 文件：

`shell $ lobe-i18n md`

[![][back-to-top]](#readme-top)

`⌨️ 本地开发`

可以使用 Github Codespaces 进行在线开发：

[![][github-codespace-shield]][github-codespace-link]

或者，可以克隆存储库并运行以下命令进行本地开发：

[![][bun-shield]][bun-link]

`bash $ git clone https://github.com/lobehub/lobe-cli-toolbox.git $ cd lobe-cli-toolbox $ bun install $ cd packages/lobe-i18n $ bun dev``

[![][back-to-top]](#readme-top)

🤝 参与贡献

我们非常欢迎各种形式的贡献。如果你对贡献代码感兴趣，可以查看我们的 GitHub [Issues][github-issues-link]，大展身手，向我们展示你的奇思妙想。

[![][pr-welcome-shield]][pr-welcome-link]

[![][github-contrib-shield]][github-contrib-link]

[![][back-to-top]](#readme-top)

🔗 链接

$3

- OpenAI -
- ink -
- transmart -

[![][back-to-top]](#readme-top)

---

#### 📝 License