ng-extract-i18n-merge

v2.13.1

Extract and merge i18n xliff translation files for angular projects. For more information about how to use this package see README

Latest version published 25 days ago

License: MIT

NPM

GitHub

Package Health Score

78 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.13.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.12.0	\|	05/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.0	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.3.0	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.3	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (16,338)

GitHub Stars: 180
Forks: 19
Contributors: 6

Direct Usage Popularity

The npm package ng-extract-i18n-merge receives a total of 16,338 downloads a week. As such, we scored ng-extract-i18n-merge popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package ng-extract-i18n-merge, we found that it has been starred 180 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like ng-extract-i18n-merge is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 12
Open PR: 0
Last Release: 25 days ago
Last Commit: 25 days ago

Further analysis of the maintenance status of ng-extract-i18n-merge based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that ng-extract-i18n-merge demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=14.0.0

Age: 3 years
Dependencies: 5 Direct
Versions: 64
Install Size: 77.5 kB
Dist-tags: 2
# of Files: 34
Maintainers: 1
TS Typings: No

ng-extract-i18n-merge has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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 and translation states are managed. Additionally, translation files are normalized (whitespace, stable sort) so that diffs are easy to read (and translations in PRs might actually get reviewed 😉 ).

> [!TIP] > If you'd like to keep your translation process simple and rather validate translations, than waiting for actual translations, I'd like you to check out doloc.io. > > Created by the maintainer of ng-extract-i18n-merge (@daniel-sc), > it integrates seamlessly with this library (see here) and provides instant translations on extraction! > > Expect great translations!

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`	Deprecated: Use `buildTarget`. A browser builder target to extract i18n messages in the format of `project:target[:configuration]`. See https://angular.io/cli/extract-i18n#options
`buildTarget`	Inferred from current setup by `ng add`	A build 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"`). This file can be used to manage changes to the source texts: when a translator updates the target, this tool will hint the developer to update the code occurrences.
`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. Cannot be used in combination with `includeIdsWithPrefix`.
`includeIdsWithPrefix`	`[]`	List of prefix strings. When non-empty, only translations units with matching `id` are included. Useful for extracting translations of a single library in a multi-library project. Cannot be used in combination with `removeIdsWithPrefix`.
`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.
`prettyNestedTags`	`true` (will change to `false` with v3.0.0)	If source/target only contains xml nodes (interpolations, nested html), `true` formats these with line breaks and indentation. `false` keeps the original angular single line format. Note: while `true` was the historic implementation, it is not recommended, as it adds whitespace between tags that had no whitespace in between and increases bundle sizes.
`sortNestedTagAttributess`	`false`	Attributes of xml nodes (interpolations, nested html) in source/target/meaning/description can be sorted for normalization.
`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. When `sourceFileOnly`, the context is retained only in the `sourceFile`.
`includeMeaningAndDescription`	`true`	Whether to include the meaning and description information in the translation files.
`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"` (will change to `stableAlphabetNew` with v3.0.0)	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), `"stableAlphabetNew"` (keep existing sorting, sort new translations next to alphabetical close IDs).
`builderI18n`	`"@angular-devkit/build-angular:extract-i18n"`	The builder to use for i18n extraction. Any custom builder should handle the same options as the default angular builder (buildTarget, outputPath, outFile, format, progress).
`verbose`	`false`	Extended/debug output - it is recommended to use this only for manual debugging.

Contribute

Feedback and PRs always welcome 😃

Before developing complex changes, I'd recommend opening an issue to discuss whether the indented goals match the scope of this package.

ng-extract-i18n-merge dependencies

@angular-devkit/architect @angular-devkit/core @angular-devkit/schematics @schematics/angular xmldoc

ng-extract-i18n-merge development dependencies

@types/jest @types/xmldoc jest ts-jest ts-node typescript

FAQs

What is ng-extract-i18n-merge?

Extract and merge i18n xliff translation files for angular projects. Visit Snyk Advisor to see a full health score report for ng-extract-i18n-merge, including popularity, security, maintenance & community analysis.

Is ng-extract-i18n-merge popular?

The npm package ng-extract-i18n-merge receives a total of 16,338 weekly downloads. As such, ng-extract-i18n-merge popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is ng-extract-i18n-merge well maintained?

We found that ng-extract-i18n-merge demonstrated a healthy version release cadence and project activity. It has a community of 6 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is ng-extract-i18n-merge safe to use?

The npm package ng-extract-i18n-merge was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 01:24 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP