etk

Extract translation keys from handlebars, javascript or typescript into key:value pairs, po, or py gettext. Can extract from: .js .jsx .ts. .tsx .handlebars .hbs, .njk, .nunjukcs

output types can be: .json .py .po

output type is determined by the extension of the output file, if i have no parser for the extension, it will be json.

can output multiple files, pass multiple -o arguments. -o output-file.json -o output-file.po

Installation

add this repo to package.json

{
    "devDependencies": {
        "etk": "github:Tnifey/etk#main",  // latest (not stable)
        "etk": "github:Tnifey/etk#v0.1.4" // tag version (production ready)
    }
}

and run yarn to install this dependency

checkout tags for versions

Usage

run as command:

npx etk -o output.json "path-as-glob/**/*.(handlebars|hbs|js|ts|nunjucks|njk)"

# multiple outputs
npx etk -o output.py -o output.po "path-as-glob/**/*.(handlebars|js|ts)"

# with config file (see example.etkrc file)
npx etk -c example.etkrc

in package.json as script:

{
    "scripts": {
        "trans": "npx etk -o .translations.json \"src/**/*.(handlebars|hbs|js|ts|nunjucks|njk)\"",
        "trans:py": "npx etk -o .translations.py \"src/**/*.(js|ts|handlebars)\"",
        "trans:po": "npx etk -o .translations.po \"src/**/*.(js|ts|handlebars)\"",
        "trans:ext": "npx etk -o .translations.po -o .translations.json \"src/**/*.(js|ts|handlebars)\"",
    }
}

Defaults

It search for this:

gettext("translation key") // <- gettext function with string parameter

{{_ "translation key" }}  <!-- _ helper with string parameter >

{{ _("translation key") }} {# <- function with string parameter  #}

Internally using:

• https://www.npmjs.com/package/gettext-parser
• https://www.npmjs.com/package/xgettext-template
• https://www.npmjs.com/package/i18next-scanner

License

MIT