Flutter插件功能介绍插件arb_glue的使用

Flutter插件功能介绍插件arb_glue的使用

ARB Glue 功能介绍

ARB Glue 是是一个工具，用于将多个文件合并成一个单一的 ARB 格式文件，方便管理国际化资源。它支持 YAML 格式，允许注释和多行字符串，并且可以将多个文件合并为一个文件。

安装示例

使用 pub.dev 管理插件：

flutter pub add dev:arb_glue

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

dev_dependencies:
  arb_glue: *

使用示例

原始结构：

.
└── lib/
    └── l10n/
        ├── en/
        │   ├── global.yaml
        │   └── feature-1.yaml
        └── zh/
            ├── global.yaml
            └── feature-1.yaml

执行命令：

dart run arb_glue
# 或者
flutter pub run arb_glue

结果结构：

.
└── lib/
    └── l10n/
        ├── en/
        │   ├── global.yaml
        │   └── feature-1.yaml
        ├── zh/
        │   ├── global.yaml
        │   └── feature-1.yaml
        ├── en.arb
        └── zh.arb

支持的格式

目前，ARB Glue 支持 JSON 和 YAML 编码的文件。

配置示例

通过 pubspec.yaml 配置：

# pubspec.yaml
name: MyApp
arb_glue:
  source: lib/l10n

通过命令行配置：

dart run arb_glue --source lib/l10n

完整的配置选项：

arb_glue:
  # 源文件夹包含的文件。
  #
  # 类型：字符串
  source: lib/l10n

  # 目标文件夹，文件将在其中生成。
  #
  # 类型：字符串
  destination: lib/l10n

  # 源文件夹中的黑名单文件夹。
  #
  # 类型：列表（字符串）
  exclude:

  # 文件作者信息。
  #
  # 在本地化 ARB 文件中，它可以包含翻译者的姓名/详情。
  # 参见：https://github.com/google/app-resource-bundle/wiki/ApplicationResourceBundleSpecification#global-attributes
  # 类型：字符串
  author:

  # 描述所有这些资源的应用背景。
  #
  # 参见：https://github.com/google/app-resource-bundle/wiki/ApplicationResourceBundleSpecification#global-attributes
  # 类型：字符串
  context:

  # 是否添加文件的最后修改时间。
  #
  # 类型：布尔值
  lastModified: true

  # ARB 文件的默认值。
  #
  # 如果未提供，则第一个找到的本地语言作为基本地语言。
  # 基本地语言提供其他本地语言的默认占位符。
  #
  # 类型：字符串
  base:

  # select/plural 模式的默认值。
  #
  # 参见示例以获取更多详细信息。
  #
  # 类型：字符串
  defaultOtherValue: UNKNOWN

  # 输出 ARB 文件的模板。
  #
  # 类型：字符串
  fileTemplate: '{lang}.arb'

  # 是否打印详细的输出。
  #
  # 类型：布尔值
  verbose: false

示例代码

# example/README.md
In this example, we'll demonstrate how to use ARB Glue to merge multiple language files into a single ARB format file.

Suppose we have the following directory structure containing language files:

.
└── example/
    ├── en/
    │   ├── global.yaml
    │   └── feature-1.yaml
    └── zh/
        ├── global.yaml
        └── feature-1.yaml

Contents of global.yaml (English):

okButton:
  text: "OK"
  description: "Finish the process"
...

Contents of feature-1.yaml (English):

$prefix: feature1
title: "Feature 1"
...

Contents of global.yaml (Chinese):

okButton: "確定"
...

Contents of feature-1.yaml (Chinese):

$prefix: "feature1"
title: "功能 1"
...

Using ARB Glue:

To merge these files using ARB Glue, follow these steps:

1. Execute ARB Glue:

dart run arb_glue --source example --destination example --base en

2. Verify Output:
After executing ARB Glue, the directory structure will be updated as follows:

.
└── example/
    ├── en/
    │   ├── global.yaml
    │   └── feature-1.yaml
    ├── zh/
    │   ├── global.yaml
    │   └── feature-1.yaml
    ├── en.arb
    └── zh.arb

Output ARB Files:

Contents of en.arb:

{
  "[@locale](/user/locale)": "en",
  "okButton": "OK",
  "[@okButton](/user/okButton)": {
    "description": "Finish the process"
  },
  "feature1Title": "Feature 1",
  "...": "..."
}

Contents of zh.arb:

{
  "[@locale](/user/locale)": "zh",
  "okButton": "確定",
  "[@okButton](/user/okButton)": {
    "description": "Finish the process"
  },
  "feature1Title": "功能 1",
  "...": "..."
}