Flutter资源合并插件arb_merge的使用

Flutter资源合并插件arb_merge的使用

ARB Merge

ARB Merge 合并来自多个文件夹（任意结构和深度）中的翻译文件。此包的独特之处在于它根据 @[@locale](/user/locale) 语言代码来合并文件内容，而不是依赖于强制性的文件或文件夹命名约定或强制性结构。它还可以通过使用逗号分隔的路径字符串来接受任意数量的源文件夹，并且每个文件夹将被递归处理，因此文件可以嵌套到任意深度。

背景

我创建了这个包，因为我找不到一个支持多个输入文件夹（具有不同路径）的包。我有一个包含由Google自动更新和翻译的小翻译文件的文件夹，另一个包含不自动翻译的大翻译文件的文件夹。因此，这是一个经济激励措施，因为Google已经开始对那些大型单一文件收取翻译费用。

致谢与版权

这个包基于 Shueh Chou Lu 的优秀项目 arb_glue，但为了满足一些其他需求，我对他的代码进行了修改，添加了一些功能，从而创造了这个包。

特性：

• 支持 [JSON] 和 ARB 源文件。
• 支持无限嵌套，任意的文件和文件夹命名约定。
• 支持无限的源文件夹。
• 合并后的文件的翻译键可以根据需要按字母顺序排序。
• 支持可选的详细输出以供调试用途。

安装

在终端运行以下命令：

flutter pub add dev:arb_merge

或者在 pubspec.yaml 文件中添加依赖项：

dev_dependencies:
  arb_merge: *

使用

命令行选项：

• <code>--sources</code>：一个逗号分隔的字符串，包含所有要从中合并文件的文件夹路径。

示例：

dart run arb_merge --sources intl_autoTranslated,intl_static,assets/manual_translations --destination lib/intl

• <code>--destination</code>：合并文件的目标文件夹路径。

• <code>--pattern</code>：用于命名生成文件的字符串，其中 {lang} 将被替换为语言代码。默认值为 intl_{lang}.arb，这将生成名为 intl_en.arb 的英文文件。

• <code>--verbose</code>：设置详细模式会输出处理的文件详情，默认值为 false。

• <code>--sort</code>：将每个输出文件中的键按字母顺序排序，默认值为 false。

dart run arb_glue --
# 或者
flutter pub run arb_glue

你也可以在 pubspec.yaml 文件中设置所有选项的值，然后只需运行 dart run arb_merge 来使用 pubspec 中的值运行 arb_merge。请注意，任何在命令行上设置的选项将覆盖这些值。

arb_merge:
  sources: example/primarySource,example/secondarySource
  destination: example/merged
  sort: false
  pattern: 'intl_{lang}.arb'
  verbose: false

支持的格式

arb_merge 支持 JSON 和 ARB 文件。

示例代码

使用arb_merge

如何使用 arb_merge 将多个语言文件合并成一个 ARB 格式的文件。

输入文件

假设我们有以下目录结构，其中包含语言文件：

.
└── example/
    ├── merged/
    ├── primarySource/
    │   ├── en.arb
    │   └── intl_french.arb
    |   ├── nestedFolder/
    |   |    └── more_translations_english.json
    └── secondarySource/
        ├── intl_en.arb
        └── intl_fr.arb

example/primarySource/en.arb 的内容

{
  "@[@locale](/user/locale)": "en",
  "hello": "Hello"
}

example/primarySource/nestedFolder/more_translations_english.json 的内容

{
   "@[@locale](/user/locale)": "en",
   "howDoYouDo": "How do you do?"
 }

example/secondarySource/intl_en.arb 的内容

{
  "@[@locale](/user/locale)": "en",
  "one": "one",
  "two": "two",
  "three": "three"
}

使用arb_merge

要使用 arb_merge 合并这些文件，请按照以下步骤操作：

1. 执行 arb_merge：

dart run arb_merge --sources example/primarySource,example/secondarySource --destination example/merged --pattern intl_{lang}.arb --sort

1. 验证输出： 执行 arb_merge 后，目录结构将更新如下：

 .
 └── example/
     ├── merged/
     |   ├── intl_en.arb
     │   └── intl_fr.arb
     ├── primarySource/
     │   ├── en.arb
     │   └── intl_french.arb
     |   ├── nestedFolder/
     |   |    └── more_translations_english.json
     └── secondarySource/
         ├── intl_en.arb
         └── intl_fr.arb

输出 ARB 文件

intl_en.arb 的内容：

{
  "@[@locale](/user/locale)": "en",
  "hello": "Hello {name}!",
  "[@hello](/user/hello)": {
    "placeholders": {
      "name": {
        "type": "String"
      }
    }
  },
  "howDoYouDo": "How do you do?",
  "one": "one",
  "three": "three",
  "two": "two"
}

intl_fr.arb 的内容：

{
  "@[@locale](/user/locale)": "fr",
  "hello": "Salut {name}!",
  "[@hello](/user/hello)": {
    "placeholders": {
      "name": {
        "type": "String"
      }
    }
  },
  "howDoYouDo": "Comment ça va?",
  "one": "un",
  "three": "trois",
  "two": "deux"
}