@6sigmadc/ngx-translate-extract 中文文档教程

Question

如果此工具可以节省您的时间，请考虑为持续维护和开发捐款：https://donate.biesbjerg.com

ngx-translate-extract

提取可翻译 (ngx-translate) 字符串并保存为 JSON 或 Gettext pot 文件。 如果输出文件已存在，则与现有字符串合并。

Install

在项目中安装包：

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

将脚本添加到项目的 package.json：

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

您现在可以运行npm run i18n:extract 它将从您的项目中提取字符串。

Usage

从目录中提取并保存到文件

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

提取来自多个目录

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

Extract并使用路径扩展保存到多个文件

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

JSON indentation

标签由以 json 格式保存提取的字符串时的默认缩进：

如果你想使用空格代替，你可以执行以下操作：

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

Marker function

如果要提取没有直接传递给TranslateService的get()/instant( )/stream() 方法，您可以将它们包装在标记函数中，让 ngx-translate-extract 知道您想要提取它们。

安装标记功能： npm install @biesbjerg/ngx-translate-extract-marker

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

marker('Extract me');

如果需要，您可以为标记函数添加别名：

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

_('Extract me');

注意：ngx-translate-extract 将自动检测导入name

Commandline arguments

Usage:
ngx-translate-extract [options]

Output
  --format, -f                Format    [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
  --format-indentation, --fi  Format indentation (JSON/Namedspaced JSON)                [string] [default: "    "]
  --sort, -s                  Sort strings in alphabetical order                                     [boolean]
  --clean, -c                 Remove obsolete strings after merge                                    [boolean]
  --replace, -r               Replace the contents of output file if it exists (Merges by default)   [boolean]

Extracted key value (defaults to empty string)
  --key-as-default-value, -k     Use key as default value                                            [boolean]
  --null-as-default-value, -n    Use null as default value                                           [boolean]
  --string-as-default-value, -d  Use string as default value                                          [string]

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] [required] [default: ["/Users/kim/apps/ngx-translate-extract"]]
  --output, -o   Paths where you would like to save extracted strings. You can use path expansion, glob
                 patterns and multiple paths                                                [array] [required]

Examples:
  ngx-translate-extract -i ./src-a/ -i ./src-b/ -o strings.json           Extract (ts, html) from multiple paths
  ngx-translate-extract -i './{src-a,src-b}/' -o strings.json             Extract (ts, html) from multiple paths using brace
                                                           expansion
  ngx-translate-extract -i ./src/ -o ./i18n/da.json -o ./i18n/en.json     Extract (ts, html) and save to da.json and en.json
  ngx-translate-extract -i ./src/ -o './i18n/{en,da}.json'                Extract (ts, html) and save to da.json and en.json
                                                           using brace expansion
  ngx-translate-extract -i './src/**/*.{ts,tsx,html}' -o strings.json     Extract from ts, tsx and html
  ngx-translate-extract -i './src/**/!(*.spec).{ts,html}' -o              Extract from ts, html, excluding files with ".spec"
  strings.json

Note for GetText users

请注意您在项目中实际使用的是哪个版本的gettext-parser。 例如，gettext-parser:1.2.2 不支持翻译键中的 HTML 标签。