npm install --save gettext-to-messageformat
yarn add gettext-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.
const parsePo parseMo =const headers pluralFunction translations =const MessageFormat =const mf = headerslanguage: pluralFunctionconst messages = mfmessages'Time: %1 second'1// 'Czas: 1 sekunda'messages'%s took %d ms to complete.''TASK' 42// 'Trebalo je 42 ms da se TASK završi.'messages'No star named %(starname)s found.' starname: 'Chi Draconis'// 'Nema zvezde po imenu Chi Draconis.'
For more examples, gettext-parser includes a selection of
in its test fixtures.
parseMo(input, options) and
The two functions differ only in their expectation of the input's format.
may be a string or a Buffer;
options is an optional set of configuration for
the parser, including the following fields:
null) – For Buffer input only, sets the default charset -- otherwise UTF-8 is assumed
false) – If any of the gettext messages define a
msgctxt, that is used as a top-level key in the output, and all messages without a context are included under the
''empty string context. If no context is set, by default this top-level key is not included unless
forceContextis set to
pluralFunction(function) – If your input file does not include a Plural-Forms header, or if for whatever reason you'd prefer to use your own, set this to be a stringifiable function that takes in a single variable, and returns the appropriate pluralisation category. Following the model used internally in messageformat, the function variable should also include
cardinalas a member array of its possible categories, in the order corresponding to the gettext pluralisation categories. This is relevant if you'd like to avoid the
new Functionconstructor otherwise used to generate
pluralFunction, or to allow for more fine-tuned categories than gettext allows, e.g. differentiating between the categories of
false) – If set to
true, missing translations will cause warnings.
For more options, take a look at the source.
Both functions return an object containing the following fields:
headers(object) – The raw contents of the input file's headers, with keys lower-cased
pluralFunction(function) – An appropriate pluralisation function to use for the output translations, suitable to be used directly by messageformat. May be
nullif none was set in
optionsand if the input did not include a Plural-Forms header.
translations(object) – An object containing the MessageFormat strings keyed by their
msgidand if used,