@l10nmonster/helpers v1.0.0

L10n Monster Basic Helpers

Sources

FS Source Adapter

this.source = new adapters.FsSource({
    globs: [ '**/values/strings.xml' ],
    filter: (resourceId) => (resourceId.indexOf('dont_translate.properties') === -1),
    targetLangs: [ 'it', 'ja' ],
    resDecorator: (resMeta) => (resMeta.resourceId.indexOf('DNT') === -1 ? resMeta : { ...resMeta, targetLangs: [] }),
});

An adapter that reads sources from the filesystem.

• The globs array (mandatory) can specify wildcard patterns relative to the base directory where the l10nmonster.cjs is placed.
• The optional filter function can further filter out what's returned by the glob patterns.
• targetLangs is an array of languages to translate to
• The optional resDecorator function can modify the resource metadata

Resource Filters

Filters are used to convert raw strings returned by sources into segments that are suitable for translation (ideally not too small that they can't be translated, and not too long that prevent translation reuse). They can be configured in content types as a single resourceFilter property.

Decoders

Decoders are used to convert strings with specific formats into either pure strings or placeholders. They can be configured in content types as a chain of decoders via the decoders property.

Encoders

Encoders are used to convert pure strings and placeholders back to their original format. They can be configured in content types as a chain of encoders via the textEncoders and codeEncoders properties.

Targets

FS Target Adapter

this.target = new adapters.FsTarget({
    targetPath: (lang, resourceId) => resourceId.replace('values', `values-${lang}`),
});

An adapter that writes translated resources to the filesystem. It takes in the object constructor a targetPath function that given a language and the resource id of the source, it produces the target resource id.

Translation Providers

Translation providers are used to interface with the translation process.

Other