@ngx-runtime-i18n/cli

CLI for @ngx-runtime-i18n that scans your source for translation key usage and validates your catalogs against it. Ships as the ngx-i18n binary.

Install

npm i -D @ngx-runtime-i18n/cli

Commands

ngx-i18n extract

Scans source files for all i18n key usages and writes a manifest.

ngx-i18n extract --src src --output translation-manifest.json

| Option | Default | Description | | ---------- | ----------------------------- | ------------------------------------- | | --src | src | Source directory to scan. | | --output | translation-manifest.json | Output manifest JSON file. |

ngx-i18n check

Validates one or more language catalogs against actual key usage: reports missing keys (used in code but absent from a catalog) and unused keys (present in a catalog but never referenced).

ngx-i18n check --catalog public/i18n --langs en,hi,de --src src --fail-on-missing

| Option | Default | Description | | -------------------- | -------------- | -------------------------------------------------------------- | | --catalog | public/i18n | Catalog directory containing <lang>.json files. | | --langs | en | Comma-separated language codes to validate. | | --src | - | Source directory to scan for key usage (skip if using --manifest). | | --manifest | - | Use a pre-computed manifest JSON (from extract) instead of re-scanning. | | --fail-on-missing | false | Exit with code 1 if any catalog is missing keys. | | --fail-on-unused | false | Exit with code 1 if any catalog has unused keys. |

--src or --manifest is required — check refuses to run with neither, rather than silently reporting a clean pass on zero used keys.

Unused keys are always computed against the catalog for the first --langs entry (e.g. --langs de,fr uses de as the reference) and printed as an informational listing even without --fail-on-unused; that flag only controls whether their presence fails the run.

A call whose key argument isn't a string literal (a template literal, a variable, ...) can't be statically resolved by either command. Instead of silently vanishing from both "used" and "unused" reporting, it's printed as a ⚠ N i18n call(s) use a dynamic/computed key warning with the exact file:line.

Typical CI usage: run extract once, then check --manifest translation-manifest.json --fail-on-missing per language to catch drift between code and catalogs before merge.

License

MIT