xref: /aosp_15_r20/external/cldr/common/testData/messageFormat/README.md (revision 912701f9769bb47905792267661f0baf2b85bed5)

# Test Data for CLDR MessageFormat 2.0 Tech Preview

For information about MessageFormat 2.0, see [Unicode Locale Data Markup Language (LDML): Part 9: Message Format](../../../docs/ldml/tr35-messageFormat.md)

The files in this directory were originally copied from the [messageformat project](https://github.com/messageformat/messageformat/tree/11c95dab2b25db8454e49ff4daadb817e1d5b770/packages/mf2-messageformat/src/__fixtures)
and are here relicensed by their original author (Eemeli Aro) under the Unicode License.

These test files are intended to be useful for testing multiple different message processors in different ways:

- `syntax-errors.json` — An array of strings that should produce a Syntax Error when parsed.

- `data-model-errors.json` - An object with string keys and arrays of strings as values,
     where each key is the name of an error and its value is an array of strings that
     should produce `error` when processed.
     Error names are defined in ["MessageFormat 2.0 Errors"](../../../docs/ldml/tr35-messageFormat.md#errors) in the spec.

- `test-core.json` — An array of test cases that do not depend on any registry definitions.
  Each test may include some of the following fields:
  - `src: string` (required) — The MF2 syntax source.
  - `exp: string` (required) — The expected result of formatting the message to a string.
  - `locale: string` — The locale to use for formatting. Defaults to 'en-US'.
  - `params: Record<string, string | number | null | undefined>` — Parameters to pass in to the formatter for resolving external variables.
  - `parts: object[]` — The expected result of formatting the message to parts.
  - `cleanSrc: string` — A normalixed form of `src`, for testing stringifiers.
  - `errors: { type: string }[]` — The runtime errors expected to be emitted when formatting the message.
     If `errors` is either absent or empty, the message must be formatted without errors.
  - `only: boolean` — Normally not set. A flag to use during development to only run one or more specific tests.

- `test-function.json` — An object with string keys and arrays of test cases as values,
  using the same definition as for `test-core.json`.
  The keys each correspond to a function that is used in the tests.
  Since the behavior of built-in formatters is implementation-specific,
  the `exp` field should generally be omitted,
  except for error cases.

TypeScript `.d.ts` files are included for `test-core.json` and `test-function.json` with the above definition.

Some examples of test harnesses using these tests, from the source repository:
- [CST parse/stringify tests](https://github.com/messageformat/messageformat/blob/11c95dab2b25db8454e49ff4daadb817e1d5b770/packages/mf2-messageformat/src/cst/cst.test.ts)
- [Data model stringify tests](https://github.com/messageformat/messageformat/blob/11c95dab2b25db8454e49ff4daadb817e1d5b770/packages/mf2-messageformat/src/data-model/stringify.test.ts)
- [Formatting tests](https://github.com/messageformat/messageformat/blob/11c95dab2b25db8454e49ff4daadb817e1d5b770/packages/mf2-messageformat/src/messageformat.test.ts)