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

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
• Credits

✨ Features

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

📦 Installation

To install Arietta i18n, run the following command:

npm install -g @arietta-studio/arietta-i18n

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

🤯 Usage

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

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

[!IMPORTANT]
To use AI auto-generation, you need to fill in the OpenAI Token in the settings.

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

# Translate Markdown files
$ arietta-i18n md

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

# Specify the configuration file
$ arietta-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 @arietta-studio/arietta-i18n

[!TIP]

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

Environment Variable

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

| Environment Variable | Required | Description | Example | | -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | OPENAI_API_KEY | Yes | This is the API key you apply on the OpenAI account page | sk-xxxxxx...xxxxxx | | OPENAI_PROXY_URL | No | If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL | https://api.chatanywhere.cn/v1The default value ishttps://api.openai.com/v1 |

🌏 Locale Configuration

| Property Name | Required | Type | Default Value | Description | | ------------- | -------- | -------------- | --------------- | ---------------------------------------------------------------------------- | | entry | * | string | - | Entry file or folder | | entryLocale | * | string | - | Language to use as translation reference | | modelName | | string | gpt-3.5-turbo | Model to use | | output | * | string | - | Location to store localized files | | outputLocales | * | string[] | [] | All the languages to be translated | | reference | | string | - | Provide some context for more accurate translations | | splitToken | | number | - | Split the localized JSON file by tokens, automatically calculated by default | | temperature | | number | 0 | Sampling temperature to use | | concurrency | | number | 5 | Number of concurrently pending promises returned | | experimental | | experimental | {} | Experimental features, see below | | markdown | | markdown | {} | See markdown configuration below |

experimental

| Property Name | Required | Type | Default Value | Description | | ------------- | -------- | --------- | ------------- | --------------------------------------------------------------------------------------------- | | jsonMode | | boolean | false | Enable gpt force JSON output for stability (only supported by new models after November 2023) |

Example 1 .i18nrc.js

const { defineConfig } = require('@arietta-studio/arietta-i18n');

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

Example 2 .i18nrc.json

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

Example 3 package.json

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

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
  - lt_LT.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": ["lt_LT"]
}

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
      - ...
  - lt_LT
    - 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": ["lt_LT"]
}

Running

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

$ arietta-i18n

📝 Markdown Configuration

| Property Name | Required | Type | Default | Description | | ---------------- | -------- | --------------------------- | ---------------------------- | ----------------------------------------------------------------------- | | entry | * | string[] | [] | Entry file or folder, supports glob | | entryLocale | | string | Inherit parent locale | Reference language for translation | | entryExtension | | string | .md | Entry file extension | | exclude | | string[] | [] | Files to be filtered, supports glob | | outputLocales | | string[] | Inherit parent locale | All languages to be translated | | outputExtensions | | function | (locale) => '.{locale}.md' | Output file extension generation | | mode | | string,mdast,function | string | Translation mode selection, explained below | | translateCode | | boolean | false | Whether to translate code blocks under mdast, other modes are invalid |

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 .md, but we want the output file extension for the lt-LT translation to be .md, while other languages keep the default extensions.

module.exports = {
  markdown: {
    entry: ['./README.md', './docs/**/*.md'],
    entryLocale: 'en-US',
    entryExtension: '.md',
    outputLocales: ['lt-LT'],
    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.lt-LT.md
	- docs
		- usage.md
		- usage.lt-LT.md
		- subfolder
            - ...

[!TIP]

Example

Running

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

$ arietta-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/arietta-studio/arietta-tools.git
$ cd arietta-tools
$ bun install
$ cd packages/arietta-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.

Credits

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

📝 License

Copyright © 2024 Arietta Studio. This project is licensed under the MIT license.