No description, website, or topics provided.
TypeScript JavaScript
Clone or download
Latest commit 7d5d38e Mar 3, 2018
haakondr and biesbjerg docs: fixes path for extract npm script example (#89)
The example script gives the following error on windows:

Saving: <project dir>\src\assets\i18n\*.json
- sorted strings
fs.js:652
  return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
                 ^

Error: ENOENT: no such file or directory, open '<project dir>\src\assets\i18n\*.json'

README.md

If you like this project please show your support with a GitHub star. Much appreciated!

ngx-translate-extract

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

Usage

Install the package in your project:

npm install @biesbjerg/ngx-translate-extract --save-dev

Add an extract script to your project's package.json:

"scripts": {
  "extract": "ngx-translate-extract --input ./src --output ./src/assets/i18n/ --clean --sort --format namespaced-json"
}

You can now run npm run extract to extract strings.

Extract examples

Extract from dir and save to file

ngx-translate-extract -i ./src -o ./src/i18n/strings.json

Extract from multiple dirs

ngx-translate-extract -i ./src/folder-a ./src/folder-b -o ./src/i18n/strings.json

Extract and save to multiple files

ngx-translate-extract -i ./src -o ./src/i18n/{da,en,fr}.json

or

ngx-translate-extract -i ./src -o ./src/i18n/da.json ./src/i18n/en.json ./src/i18n/fr.json

or (update only)

ngx-translate-extract -i ./src -o ./src/i18n/*.json

or (update only)

Custom indentation

By default, tabs are used for indentation when writing extracted strings to json formats:

ngx-translate-extract -i ./src -o ./src/i18n/en.json --format-indentation $'\t'

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

ngx-translate-extract -i ./src -o ./src/i18n/en.json --format-indentation ' '

Mark strings for extraction using a marker function

If, for some reason, you want to extract strings not passed directly to TranslateService, you can wrap them in a custom marker function.

import { _ } from '@biesbjerg/ngx-translate-extract';

_('Extract me');

Add the marker argument when running the extract script:

ngx-translate-extract ... -m _

Modify the scripts arguments as required.

Commandline arguments

Usage:
ngx-translate-extract [options]

Options:
  --version, -v               Show version number                      [boolean]
  --help, -h                  Show help                                [boolean]
  --input, -i                 Paths you would like to extract strings from. You
                              can use path expansion, glob patterns and multiple
                              paths
                     [array] [default: current working path]
  --patterns, -p              Extract strings from the following file patterns
                                    [array] [default: ["/**/*.html","/**/*.ts"]]
  --output, -o                Paths where you would like to save extracted
                              strings. You can use path expansion, glob patterns
                              and multiple paths              [array] [required]
  --marker, -m                Extract strings passed to a marker function
                                                       [string] [default: false]
  --format, -f                Output format
          [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
  --format-indentation, --fi  Output format indentation [string] [default: "\t"]
  --replace, -r               Replace the contents of output file if it exists
                              (Merges by default)     [boolean] [default: false]
  --sort, -s                  Sort strings in alphabetical order when saving
                                                      [boolean] [default: false]
  --clean, -c                 Remove obsolete strings when merging
                                                      [boolean] [default: false]
  --verbose, -vb              If true, prints all processed file paths to console
                                                      [boolean] [default: true]