TS Gettext Extractor

一个命令行工具，用于从 Javascript/Typescript 代码生成 Gettext 模板文件（.pot）。

使用 SWC 解析 JS 文件。

用法

查看帮助以获取更多详细信息

$ ts-gettext-extractor --help
Generate Gettext template files from Javascript/Typescript code

Usage: ts-gettext-extractor [OPTIONS] --output-folder <OUTPUT_FOLDER>

Options:
      --exclude [<EXCLUDE>...]
          A list of patterns to exclude [default: /.git/ /node_modules/ /__tests__/ .test. /__mocks__/ .mock. .story. .cy.]
      --path <PATH>
          The path to the file to read. Defaults to current folder
      --output-folder <OUTPUT_FOLDER>
          The folder where pot files will be written. Each domain will have its own file
      --references-relative-to <REFERENCES_RELATIVE_TO>
          Which folder the references are relative to. Defaults to the output folder
      --default-domain <DEFAULT_DOMAIN>
          The default domain to use for strings that don't have a domain specified [default: default]
  -h, --help
          Print help

支持的功能

• gettext 或 __ — 例如 __('String')
• ngettext 或 __n — 例如 __n('1 item', '%n items', count)
• pgettext 或 __p — 例如 __p('context', 'String')
• npgettext 或 __np — 例如 __np('context', '1 item', '%n items', count)
• dgettext 或 __d — 例如 __d('domain', 'String')
• dngettext 或 __dn — 例如 __dn('domain', '1 item', '%n items', count)
• dpgettext 或 __dp — 例如：__dp('domain', 'context', 'String', ')
• dnpgettext 或 __dnp — 例如：__dnp('domain', 'context', '1 item', '%n items', count)

支持一个标记的模板字面量，即没有变量的 __。例如：__`My string`

元数据

此库在以下POT文件中生成一些元数据。

参考

代码的引用按照 po文件规范 生成。每个引用都提到了源文件名和行号。引用相对于 --references-relative-to 参数（或 --output-folder）。

注释

在 gettext 函数调用前后注释也被提取。这仅适用于直接在函数调用之前的注释，不适用于上一行的注释。

例如，这将被提取

const myText = /* ✅ A comment that will be extracted */ __('My text');

这不会被提取

/* ❌ A comment that won't be extracted */
const myText = __('My text');