@aurthle/i18n-cli v1.0.0

Lobe i18n is a CLI workflow tool that uses ChatGPT for automated i18n.

English ・ 简体中文 ・ Changelog · Report Bug · Request Feature

TOC

• ✨ Features
• 📦 Installation
• 🤯 Usage
  • Configuration
  • Environment Variable
• 🌏 Locale Configuration
  • File Structure Selection
  • Running
• 📝 Markdown Configuration
  • File Structure
  • Running
• ⌨️ Local Development
• 🤝 Contributing
• 🔗 Links
  • More Products
  • Credits

✨ Features

• 🤖 Utilize ChatGPT for automated i18n translation
• ✂️ Support automatic splitting of large files without worrying about ChatGPT token limits.
• ♻️ Support incremental i18n updates, automatically extract new content based on entry files.
• 🗂️ Support single file mode en_US.json and folder mode en_US/common.json to work perfectly with i18next.
• 🌲 Support flat and tree structure for locale files.
• 🛠️ Support customizing OpenAI models, API proxies, temperature and topP.
• 📝 Support automated i18n translation of Markdown files.

📦 Installation

To install Lobe i18n, run the following command:

npm install -g @lobehub/i18n-cli

[!IMPORTANT]\ Please make sure you have Node.js version >= 18.

🤯 Usage

Step 1: Initialize Configuration

To initialize the Lobe i18n configuration, run the following command:

$ lobe-i18n -o # or use the full flag --option

Step 2: Run Translation Commands

This command will guide you through creating a configuration file step by step.

Alternatively, you can manually create a configuration file in one of the formats supported by cosmiconfig (see Configuration below).

Here's an example of a configuration file (.i18nrc.js):
This example demonstrates how to generate locales/zh_CN.json and locales/ja_JP.json automatically based on locales/en_US.json.

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]\ To use AI auto-generation, you need to fill in the OpenAI Token in the settings.

# Translate Locale files
$ lobe-i18n # or $ lobe-i18n locale

# Translate Markdown files
$ lobe-i18n md

# Run i18n translation and markdown translation simultaneously
$ lobe-i18n --with-md

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

Configuration

You can choose any configuration method in cosmiconfig format

• i18n property in package.json
• .i18nrc file in JSON or YAML format
• .i18nrc.json, .i18nrc.yaml, .i18nrc.yml, .i18nrc.js, .i18nrc.cjs
• defineConfig provides a secure definition method that can be imported from @lobehub/i18n-cli

[!TIP]

This project provides a secure definition method defineConfig that can be imported from @lobehub/i18n-cli

Environment Variable

This project provides some additional configuration items set with environment variables:

🌏 Locale Configuration

experimental

Example 1 .i18nrc.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'],
});

Example 2 .i18nrc.json

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

Example 3 package.json

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

File Structure Selection

There are two types of file structures supported: flat and tree.

Flat Structure

A flat structure means that all translations for different languages are stored in a single file, as shown below:

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

[!TIP]

The flat structure requires configuring the entry property in the configuration file to the corresponding JSON file Example

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

Tree Structure

A tree structure means that the translations for each language are stored in separate language folders, as shown below:

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

[!TIP]

The tree structure requires configuring the entry property in the configuration file to the corresponding folder Example

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

Running

Use the lobe-i18n command to generate i18n files automatically:

$ lobe-i18n

📝 Markdown Configuration

outputExtensions

By default, the translated file names are generated as .{locale}.md. You can customize the output file extensions with outputExtensions.

[!NOTE]

In the example below, the entry file extension is .zh-CN.md, but we want the output file extension for the en-US translation to be .md, while other languages keep the default extensions.

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 supports the following props:

interface OutputExtensionsProps {
  /**
   * @description The locale of the translated file to output
   */
  locale: string;
  config: {
    /**
     * @description The content of the translated file to input
     */
    fileContent: string;
    /**
     * @description The path of the translated file to input
     */
    filePath: string;
    /**
     * @description The default method for generating extensions
     */
    getDefaultExtension: (locale: string) => string;
  };
}

mode

mode is used to specify the translation mode, which supports two modes and custom generation modes.

• string - Translates the complete markdown content.
• mdast - Parses the text with mdast structure and translates the text value content. To translate code blocks, you need to enable translateCode.

[!WARNING]

In mdast mode, the content to be translated will be reduced to a minimum, removing most markdown syntax structures and links. This mode can greatly reduce token consumption, but it may result in inaccurate translation results.

File Structure

The translated files will be generated in the same directory as the entry file, with the corresponding language suffix added to the extension:

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

[!TIP]

Example

Running

Use the lobe-i18n md command to automate the generation of i18n files:

$ lobe-i18n md

⌨️ Local Development

You can use Github Codespaces for online development:

Alternatively, you can clone the repository and run the following command for local development:

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

🤝 Contributing

We welcome contributions in all forms. If you're interested in contributing code, you can check our GitHub Issues, show off your skills, and demonstrate your ideas.

🔗 Links

More Products

• 🤖 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 - The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.

Credits

• langchainjs - https://github.com/hwchase17/langchainjs
• ink - https://github.com/vadimdemedes/ink
• transmart - https://github.com/Quilljou/transmart

📝 License

Copyright © 2023 LobeHub. This project is licensed under the MIT license.