Skip to content

Extract and merge i18n xliff translation files for angular projects.

License

Notifications You must be signed in to change notification settings

strout/ng-extract-i18n-merge

 
 

Repository files navigation

npm Coverage Status Language grade: JavaScript

Angular extract i18n and merge

This extends Angular CLI to improve the i18n extraction and merge workflow. New/removed translations are added/removed from the target translation files. Additionally, translation files are normalized (pretty print, sorted by id) so that diffs are easy to read (and translations in PRs might actually get reviewed ;-) ).

Install

Prerequisites: i18n setup with defined target locales in angular.json - as documented here.

ng add ng-extract-i18n-merge

Upgrade from 1.x.x to 2.0.0

To upgrade use ng update ng-extract-i18n-merge - this will perform all necessary migrations.

Breaking changes:

  • Now this plugin uses the default angular "extract-i18n" target - so you can (must) simply run ng extract-i18n! (#30)
  • Default sort is now "stableAppendNew" (was: "idAsc") (#26).
  • Leading/trailing whitespaces are normalized (i.e. collapsed to one space) but not completely trimmed (#28).
  • Npm run script is removed (you can create a manual npm run script of course).

Usage

ng extract-i18n # yes, same as before - this replaces the original builder

Configuration

In your angular.json the target extract-i18n that can be configured with the following options:

Name Default Description
browserTarget Inferred from current setup by ng add A browser builder target to extract i18n messages in the format of project:target[:configuration]. See https://angular.io/cli/extract-i18n#options
format Inferred from current setup by ng add Any of xlf, xlif, xliff, xlf2, xliff2
outputPath Inferred from current setup by ng add Path to folder containing all (source and target) translation files.
targetFiles Inferred from current setup by ng add Filenames (relative to outputPath of all target translation files (e.g. ["messages.fr.xlf", "messages.de.xlf"]).
sourceLanguageTargetFile Unused If this is set (to one of the targetFiles), new translations in that target file will be set to state="final" (instead of default state="new").
sourceFile messages.xlf. ng add tries to infer non default setups. Filename (relative to outputPath of source translation file (e.g. "translations-source.xlf").
removeIdsWithPrefix [] List of prefix strings. All translation units with matching id attribute are removed. Useful for excluding duplicate library translations.
fuzzyMatch true Whether translation units without matching IDs are fuzzy matched by source text.
resetTranslationState true Reset the translation state to new/initial for new/changed units.
collapseWhitespace true Collapsing of multiple whitespaces/line breaks in translation sources and targets.
trim false Trim translation sources and targets.
includeContext false Whether to include the context information (like notes) in the translation files. This is useful for sending the target translation files to translation agencies/services.
newTranslationTargetsBlank false When false (default) the "target" of new translation units is set to the "source" value. When true, an empty string is used. When 'omit', no target element is created.
sort "stableAppendNew" Sorting of all translation units in source and target translation files. Supported: "idAsc" (sort by translation IDs), "stableAppendNew" (keep existing sorting, append new translations at the end)

Contribute

Feedback and PRs always welcome :-)

About

Extract and merge i18n xliff translation files for angular projects.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%