History

Brodin d6d85f2ffe adding local files for running this....locally		2024-09-23 19:05:38 -04:00
..
dist	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
lib	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
src	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
build.js	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
CHANGELOG.md	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
LICENSE	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
package.json	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
README.md	adding local files for running this....locally	2024-09-23 19:05:38 -04:00

README.md

Intl MessageFormat Parser

Parses ICU Message strings into an AST via JavaScript.

Overview

This package implements a parser in JavaScript that parses the industry standard ICU Message strings — used for internationalization — into an AST. The produced AST can then be used by a compiler, like intl-messageformat, to produce localized formatted strings for display to users.

This parser is written in PEG.js, a parser generator for JavaScript.

Usage

import { parse } from 'intl-messageformat-parser';
const ast = parse('this is {count, plural, one{# dog} other{# dogs}}');

Example

Given an ICU Message string like this:

On {takenDate, date, short} {name} took {numPhotos, plural,
    =0 {no photos.}
    =1 {one photo.}
    other {# photos.}
}

// Assume `msg` is the string above.
parse(msg);

This parser will produce this AST:

[
  {
    "type": 0,
    "value": "On "
  },
  {
    "type": 3,
    "style": "short",
    "value": "takenDate"
  },
  {
    "type": 0,
    "value": " "
  },
  {
    "type": 1,
    "value": "name"
  },
  {
    "type": 0,
    "value": " took "
  },
  {
    "type": 6,
    "pluralType": "cardinal",
    "value": "numPhotos",
    "offset": 0,
    "options": [
      {
        "id": "=0",
        "value": [
          {
            "type": 0,
            "value": "no photos."
          }
        ]
      },
      {
        "id": "=1",
        "value": [
          {
            "type": 0,
            "value": "one photo."
          }
        ]
      },
      {
        "id": "other",
        "value": [
          {
            "type": 0,
            "value": "# photos."
          }
        ]
      }
    ]
  }
]

Benchmarks

complex_msg AST length 2053
normal_msg AST length 410
simple_msg AST length 79
string_msg AST length 36
complex_msg x 3,926 ops/sec ±2.37% (90 runs sampled)
normal_msg x 27,641 ops/sec ±3.93% (86 runs sampled)
simple_msg x 100,764 ops/sec ±5.35% (79 runs sampled)
string_msg x 120,362 ops/sec ±7.11% (74 runs sampled)

License

This software is free to use under the Yahoo! Inc. BSD license. See the LICENSE file for license text and copyright information.