ARB Excel

For reading, creating and updating ARB files from XLSX files.

Install

pub global activate arb_excel

Usage

pub global run arb_excel

USAGE:
  arb_sheet [OPTIONS] path_or_filename[s]

Options

Flag	Description
-o, --output	Name of output file to create
-a, --[no-]arb	Convert Excel Sheet to ARB files
-e, --[no-]excel	Convert ARB files to Excel Sheet. Specify director(ies) or name(s) of ARB files to convert as additional arguments.
-m, --[no-]merge	Merge data from Excel Sheet into ARB file. Specify name of Excel Sheet and ARB file to import.
-l, --leadLocale	Name of the primary (aka lead) locale.
-t, --targetLocales	A comma separated list of locale names to be included in the Excel file created.
-i, --[no-]includeLeadLocale	Whether the ARB file for the lead locale should be extracted from the Excel as well.
-r, --review-marker	Filter ARB resources to export depending on a review marker. Example: -m x-reviewed:false. Maybe also used with merge option to update the review markers in merged ARB files.
--singleSheet	Whether all languages are exported to a single Excel sheet.

Examples

Generates ARB files from an XLSX file.

Creates an Excel file (-e) named example/example.xlsx (-o ...) from ARB files from directory example, lead locale is en (-l en).

dart pub global run arb_excel -l en -e -o example/example.xlsx example

Merge (-m) the contents of file exmample/example.xlsx back into the ARB files located in directory example. Lead locale is en (-l en). Also extract the entries from the lead locale (-i).

dart pub global run arb_excel -l en -i -m example/example.xlsx

Create an ARB file (-a) named test_vi.arb (-o test.arb) from the contents of file exmample/example.xlsx.

dart pub global run arb_excel -a example/example.xlsx -o test.arb

Incremental Translation Process

ARB Excel supports an incremental translation process maintaining review-markers on ARB file entries. Here is an example for an ARB entry with a review-marker in this case named x-reviewed.

{
  "cashDrawerCheckSuccessful": "Cash Drawer Check successful",
  "@cashDrawerCheckSuccessful": {
    "x-reviewed": false,
    "description": "Message displayed as an information to the cashier, after a cash drawer check had been performed."
  }
}

By specifying the usage of a review-marker when exporting the ARB resources to an Excel file -m x-reviewed:false one can instruct ARB Excel to only export entries, with the given marker. One would then also specify this marker when merging Excel file input with existing ARB files. ARB Excel will then remove the review marker from all entries, which were changed due to the Excel input.