gettext-extractor

A flexible and powerful Gettext message extractor with support for JavaScript, TypeScript, JSX and HTML, and others via regular expressions.

This program works by running your files through a parser and then uses the AST (Abstract Syntax Tree) to find and extract translatable strings from your source code. All extracted strings can then be saved as .pot file to act as template for translation files.

Unlike many of the alternatives, this library is highly configurable and is designed to work with most existing setups.

For the full documentation check out the Github Wiki of the original project.

Notes

This is a fork of the original program written by Lukas Geiter. As per some posts in the issues of the original repository, Lukas was in the middle of a full rewrite of the program, which has not materialized yet. However, a useful patch to use regex was contributed but it was never merged. Hence the fork.

Installation

Note: This package requires Node.js version 6 or higher.

Yarn

yarn add @rgglez/gettext-extractor

NPM

npm install @rgglez/gettext-extractor

Getting Started

In order to execute the extraction, you should write and run a simple script. Some a example on how to use the different extractors follow:

const { GettextExtractor, JsExtractors, HtmlExtractors, RegexExtractors } = require('@rgglez/gettext-extractor');

let extractor = new GettextExtractor();

extractor
    .createJsParser([
        JsExtractors.callExpression('getText', {
            arguments: {
                text: 0,
                context: 1
            }
        }),
        JsExtractors.callExpression('getPlural', {
            arguments: {
                text: 1,
                textPlural: 2,
                context: 3
            }
        })
    ])
    .parseFilesGlob('./src/**/*.@(ts|js|tsx|jsx)');

extractor
    .createHtmlParser([
        HtmlExtractors.elementContent('translate, [translate]')
    ])
    .parseFilesGlob('./src/**/*.html');

extractor
    .createRegexParser([
        RegexExtractors.addCondition({
            regex: /\_translate\((.*)\)/i,
            text: 1
        })
    ])
    .parseFilesGlob('./src/**/*.tmpl');

extractor.savePotFile('./messages.pot');

extractor.printStats();

License

Copyright (c) 2017 Lukas Geiter. Copyright (c) 2024 Rodolfo González González.

MIT license. Please read the LICENSE file.