yaml-to-messageformat
Converts yaml input (e.g. as used by Rails i18n) into messageformat-compatible JSON.
Installation
npm install yaml-to-messageformat
or
yarn add yaml-to-messageformat
If using in an environment that does not natively support ES6 features such as object destructuring and arrow functions, you'll want to use a transpiler for this.
Usage
const convert = const locales translations = const MessageFormat = const mf = localesconst messages = mf messagesenerrors// 'must be accepted' messagesen// 'Problem doesn\'t match your style' messagesenerrors// 'is the wrong length (should be 42 characters)'
convert(input, options)
API: input
should be a string; options
is an optional set of configuration:
-
defaultLocale
(string, default'en'
) – Sets the initial locale. -
includeLocales
(array of strings, defaultnull
) – By default any key in the input data that matches the two-letter code of a CLDR pluralisation language switches the language used for determining the pluralisation rules. Set this to some limited set of languages (or even an empty array) to limit that. -
merge
(boolean, defaultfalse
) – Enables YAML merge keys; see the yaml documentation for details -
verbose
(boolean, defaultfalse
) – If set totrue
, some logging and warnings will be printed to the console.
For more options, take a look at the source.
The object returned by the function contains the following fields:
-
locales
(array of strings) – The actual locales encountered in the data -
translations
(object) – An object containing the MessageFormat strings, matching the shape of the input data