ngx-translate-extract

Angular translations extractor (plugin for @ngx-translate)

✓ Compatible with server-side rendering (SSR/SSG)

Extract translatable (ngx-translate) strings and save as a JSON or Gettext pot file. Merges with existing strings if the output file already exists.

History

This project was originally created by Kim Biesbjerg. Unfortunately he was unable to continue to maintain it so the Vendure team agreed to take over maintenance of this fork.

Install

Install the package in your project:

1npm install @vendure/ngx-translate-extract --save-dev
2# or
3yarn add @vendure/ngx-translate-extract --dev

Choose the version corresponding to your Angular version:

Angular	ngx-translate-extract
>= 20	10.x
17 - 19	9.x
13 – 16	8.x
8 – 12	@biesbjerg/ngx-translate-extract 7.x

Add a script to your project's package.json:

1"scripts": {
2  "i18n:init": "ngx-translate-extract --input ./src --output ./src/assets/i18n/template.json --key-as-default-value --replace --format json",
3  "i18n:extract": "ngx-translate-extract --input ./src --output ./src/assets/i18n/{en,da,de,fi,nb,nl,sv}.json --clean --format json"
4}

You can now run npm run i18n:extract and it will extract strings from your project.

Usage

Extract from dir and save to file

1ngx-translate-extract --input ./src --output ./src/assets/i18n/strings.json

Extract from multiple dirs

1ngx-translate-extract --input ./src-a ./src-b --output ./src/assets/i18n/strings.json

Extract and save to multiple files using path expansion

1ngx-translate-extract --input ./src --output ./src/i18n/{da,en}.json

Strip prefix from the generated json keys

Useful when loading multiple translation files in the same application and prefixing them automatically

1ngx-translate-extract --input ./src --output ./src/i18n/{da,en}.json --strip-prefix 'PREFIX.'

Cache for consecutive runs

If your project grows rather large, runs can take seconds. With this cache, unchanged files don't need to be parsed again, keeping consecutive runs under .5 seconds.

1ngx-translate-extract --cache-file node_modules/.i18n-cache/my-cache-file --input ./src --output ./src/i18n/{da,en}.json

JSON indentation

Tabs are used by default for indentation when saving extracted strings in json formats:

If you want to use spaces instead, you can do the following:

1ngx-translate-extract --input ./src --output ./src/i18n/en.json --format-indentation ' '

Sorting

Extracted keys are by default not sorted. You can enable sorting by using the --sort or -s flag.

If sorting is enabled, the keys will be sorted using the default variant sort sensitivity. Other sort sensitivity options are also available using the --sort-sensitivity or -ss flag:

• base: Strings that differ in base letters are unequal. For example a !== b, a === á, a === A
• accent: Strings that differ in base letters and accents are unequal. For example a !== b, a !== á, a === A
• case: Strings that differ in base letters or casing are unequal. For example a !== b, a === á, a !== A
• variant: Strings that differ in base letters, accents, or casing are unequal. For example a !== b, a !== á, a !== A

Marker function

If you want to extract strings that are not passed directly to NgxTranslate.TranslateService's get()/instant()/stream() methods, or its translate pipe or directive, you can wrap them in the marker function from @ngx-translate/core to let ngx-translate-extract know you want to extract them.

Example: Using the marker function

1// your-component.ts
2import { Component, inject } from '@angular/core';
3import { TranslateService, _ } from '@ngx-translate/core';
4
5const welcomeMessage = _('app.your-component.welcome');
6
7@Component({
8  selector: 'your-component',
9  template: `<p>{{ message }}</p>`,
10})
11export class YourComponent {
12  private readonly translate = inject(TranslateService);
13  
14  readonly message = this.translate.instant(welcomeMessage);
15}

For more advanced use cases where a marker pipe or directive is required, or if you are using a version of ngx-translate prior to v16, you can use the following library:

1npm install @colsen1991/ngx-translate-extract-marker

See @colsen1991/ngx-translate-extract-marker documentation for more information.

Commandline arguments

1Usage:
2ngx-translate-extract [options]
3
4Output
5  --format, -f                Format        [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
6  --format-indentation, --fi  Format indentation (JSON/Namedspaced JSON)                  [string] [default: "\t"]
7  --sort, -s                  Sort strings in alphabetical order                                         [boolean]
8  --sort-sensitivity, -ss     Sensitivity when sorting strings (only when sort is enabled)               [string]
9  --clean, -c                 Remove obsolete strings after merge                                        [boolean]
10  --replace, -r               Replace the contents of output file if it exists (Merges by default)       [boolean]
11  --strip-prefix, -sp         Strip prefix from key                                                       [string]
12  --po-source-locations       Include file location comments in .po files                [boolean] [default: true]
13
14Extracted key value (defaults to empty string)
15  --key-as-default-value, -k           Use key as default value                                          [boolean]
16  --key-as-initial-default-value, -ki  Use key as initial default value                                  [boolean]
17  --null-as-default-value, -n          Use null as default value                                         [boolean]
18  --string-as-default-value, -d        Use string as default value                                        [string]
19
20Options:
21  --version, -v  Show version number                                                                     [boolean]
22  --help, -h     Show help                                                                               [boolean]
23  --input, -i    Paths you would like to extract strings from. You can use path expansion, glob patterns and
24                 multiple paths                                               [array] [required] [default: ["./"]]
25  --output, -o   Paths where you would like to save extracted strings. You can use path expansion, glob
26                 patterns and multiple paths                                                    [array] [required]
27  --cache-file   Cache parse results to speed up consecutive runs                                         [string]
28  --marker, -m   Custom marker function name                                                              [string]
29
30Examples:
31  ngx-translate-extract -i ./src-a/ -i ./src-b/ -o strings.json             Extract (ts, html) from multiple paths
32  ngx-translate-extract -i './{src-a,src-b}/' -o strings.json               Extract (ts, html) from multiple paths using brace expansion
33  ngx-translate-extract -i ./src/ -o ./i18n/da.json -o ./i18n/en.json       Extract (ts, html) and save to da.json and en.json
34  ngx-translate-extract -i ./src/ -o './i18n/{en,da}.json'                  Extract (ts, html) and save to da.json and en.json using brace expansion
35  ngx-translate-extract -i './src/**/*.{ts,tsx,html}' -o strings.json       Extract from ts, tsx and html
36  ngx-translate-extract -i './src/**/!(*.spec).{ts,html}' -o strings.json   Extract from ts, html, excluding files with ".spec"
37  ngx-translate-extract -i './src/' -o strings.json -sp 'PREFIX.'           Strip the prefix "PREFIX." from the json keys

Note for GetText users

Please pay attention of which version of gettext-parser you actually use in your project. For instance, gettext-parser:1.2.2 does not support HTML tags in translation keys.

Credits

• Original library, idea and code: Kim Biesbjerg ❤️
• Further updates and improvements by bartholomej ❤️
• Further updates and improvements by P4 ❤️
• Further updates and improvements by colsen1991 ❤️
• Further updates and improvements by tmijieux ❤️