i18n-js 项目技术文档

1. 安装指南

1.1 使用 RubyGems 安装

你可以通过以下命令使用 RubyGems 安装 i18n-js：

gem install i18n-js

1.2 在 Gemfile 中添加

如果你使用的是 Ruby 项目，可以在项目的 Gemfile 中添加以下行：

gem "i18n-js"

然后运行 bundle install 来安装依赖。

1.3 初始化配置文件

安装完成后，创建默认的配置文件 ./config/i18n.yml：

i18n init

2. 项目的使用说明

2.1 配置文件

i18n-js 使用 config/i18n.yml 文件来配置翻译的导出规则。以下是一个示例配置文件：

---
translations:
  - file: app/frontend/locales/en.json
    patterns:
      - "*"
      - "!*.activerecord"
      - "!*.errors"
      - "!*.number.nth"

  - file: app/frontend/locales/:locale.:digest.json
    patterns:
      - "*"

2.2 导出翻译

你可以使用以下命令将翻译导出为 JSON 文件：

i18n export

2.3 动态内容

配置文件支持使用 ERB 模板，因此你可以在配置文件中使用动态内容。例如：

---
<% group = "{en,pt}" %>

translations:
  - file: app/frontend/translations.json
    patterns:
      - "<%= group %>.*"
      - "!<%= group %>.activerecord"
      - "!<%= group %>.errors"
      - "!<%= group %>.number.nth"

3. 项目API使用文档

3.1 Ruby API

你可以使用 Ruby API 来导出翻译文件。以下是一个示例：

require "i18n-js"

# 使用配置文件导出翻译
I18nJS.call(config_file: "config/i18n.yml")

# 直接提供配置
config = {
  "translations"=>[
    {"file"=>"app/javascript/locales/:locale.json", "patterns"=>["*"]}
  ]
}

I18nJS.call(config: config)
#=> ["app/javascript/locales/de.json", "app/javascript/locales/en.json"]

3.2 CLI API

i18n-js 提供了命令行工具来执行各种操作。以下是一些常用命令：

$ i18n --help
Usage: i18n COMMAND FLAGS

Commands:

- init: 初始化项目
- export: 导出翻译为 JSON 文件
- version: 显示版本号
- plugins: 列出激活的插件
- lint:translations: 检查缺失的翻译
- lint:scripts: 使用 TypeScript 检查文件

Run `i18n COMMAND --help` for more information on specific commands.

4. 项目安装方式

4.1 使用 RubyGems 安装

gem install i18n-js

4.2 在 Gemfile 中添加

gem "i18n-js"

4.3 初始化配置文件

i18n init

通过以上步骤，你可以成功安装并使用 i18n-js 项目来导出翻译文件。