example/README.md

Using ARB Glue #

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

Input Files #

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"
cancelButton:
- Cancel
- Cancel the process
counter:
- =0: No items
  =1: One item
  other: '{count} items'
- {count: {type: int, mode: plural}}
transportation:
- car: Car
  bicycle: Bicycle
  scooter: Scooter
  other: UNKNOWN
- {tool: {}}
dialog:
  $prefix: dialog
  title: "Dialog"

Contents of feature-1.yaml (English) #

$prefix: feature1
title: "Feature 1"
subtitle: "This feature is enabled at {date}"
"@subtitle":
  description: Placing below title
  placeholders:
    date:
      type: DateTime
      description: When is the feature enabled
      example: 1995/01/23
price:
- "You have {money}"
- money: {type: num, format: compactCurrency, symbol: '$'}

Contents of global.yaml (Chinese) #

okButton: "確定"
cancelButton: "取消"

Contents of feature-1.yaml (Chinese) #

$prefix: "feature1"
title: "功能 1"
subtitle: "這功能啟動於 {date}"

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": "en",
  "@@last_modified": "2024-04-08T01:13:10.592126Z",
  "okButton": "OK",
  "@okButton": {
    "description": "Finish the process"
  },
  "cancelButton": "Cancel",
  "@cancelButton": {
    "description": "Cancel the process"
  },
  "counter": "{count, plural, =0{No items} =1{One item} other{{count} items}}",
  "@counter": {
    "placeholders": {
      "count": {
        "type": "int"
      }
    }
  },
  "transportation": "{tool, select, car{Car} bicycle{Bicycle} scooter{Scooter} other{UNKNOWN}}",
  "@transportation": {
    "placeholders": {
      "tool": {
        "type": "String"
      }
    }
  },
  "dialogTitle": "Dialog",
  "feature1Title": "Feature 1",
  "feature1Subtitle": "This feature is enabled at {date}",
  "@feature1Subtitle": {
    "description": "Placing below title",
    "placeholders": {
      "date": {
        "type": "DateTime",
        "description": "When is the feature enabled",
        "example": "1995/01/23"
      }
    }
  },
  "feature1Price": "You have {money}",
  "@feature1Price": {
    "placeholders": {
      "money": {
        "type": "num",
        "format": "compactCurrency",
        "optionalParameters": {
          "symbol": "$"
        }
      }
    }
  }
}

Contents of zh.arb:

{
  "@@locale": "zh",
  "@@last_modified": "2024-04-08T01:13:10.604411Z",
  "okButton": "確定",
  "@okButton": {
    "description": "Finish the process"
  },
  "cancelButton": "取消",
  "@cancelButton": {
    "description": "Cancel the process"
  },
  "transportation": "{tool, select, car{汽車} bicycle{腳踏車} scooter{摩托車} other{UNKNOWN}}",
  "@transportation": {
    "placeholders": {
      "tool": {
        "type": "String"
      }
    }
  },
  "feature1Title": "功能 1",
  "feature1Subtitle": "這功能啟動於 {date}",
  "@feature1Subtitle": {
    "description": "Placing below title",
    "placeholders": {
      "date": {
        "type": "DateTime",
        "description": "When is the feature enabled",
        "example": "1995/01/23"
      }
    }
  }
}

Conclusion #

ARB Glue simplifies the process of merging multiple language files into ARB format, making it easier to manage internationalization resources in Flutter projects.