check_arb 使用说明

check_arb 是一个用于多语言检查的工具库,可以对比各语言配置文件与目标语言文件之间的差异,并输出结果,帮助开发者维护多语言文件的一致性。

使用步骤

1. 添加依赖

通过以下命令全局安装 check_arb

flutter pub global activate check_arb

2. 确保文件夹结构

进入包含多语言文件的项目文件夹,check_arb 会默认扫描 l10n 文件夹。请确保 l10n 文件夹中存在 intl_*.arb 文件,其中 * 表示语言标识(如 zh, en 等)。工具会以 mainLocale 指定的语言文件为目标文件,输出与其差异。

默认情况下,mainLocalezh,您也可以通过指令自行设置目标语言。

3. 运行指令

使用默认目标语言(zh

运行以下命令:

flutter pub global run check_arb

指定目标语言

如果需要以其他语言文件作为目标文件(例如 en),可以运行:

flutter pub global run check_arb en

4. 查看输出结果

工具会对比目标语言文件与其他语言文件,并打印差异信息,例如缺失的键或多余的键。

示例输出

假设目标文件是 intl_zh.arb,其他语言文件是 intl_en.arbintl_es.arb,以下是可能的输出格式:

以intl_zh.arb 为基准, 开始检查...

文件: intl_en.arb
- 缺少键值对: 
  - "app_title"
  - "welcome_message"
- 多出键值对:
  - "unused_key"

文件: intl_de.arb
- 缺少键值对: 
  - "test"

注意事项

  • 请确保 intl_*.arb 文件的格式合法,且 l10n 文件夹中没有其他与多语言无关的文件。
  • 若目标文件未指定,默认选择 intl_zh.arb 作为基准文件。

通过 check_arb,您可以轻松维护多语言文件的一致性,有效提升多语言开发的效率!

Libraries

check_arb