@esgettext/tools 1.0.0 → 1.2.0

package/dist/commands/xgettext.js

@@ -0,0 +1,534 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XGettext = void 0;
+const fs_1 = require("fs");
+const path = __importStar(require("path"));
+const runtime_1 = require("@esgettext/runtime");
+const catalog_1 = require("../pot/catalog");
+const po_1 = require("../parser/po");
+const files_collector_1 = require("./xgettext/files-collector");
+const typescript_1 = require("../parser/typescript");
+const javascript_1 = require("../parser/javascript");
+const keyword_1 = require("../pot/keyword");
+const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
+class XGettext {
+    // The date is only passed for testing.
+    constructor(configuration, date) {
+        this.catalog = undefined;
+        this.exclude = undefined;
+        this.options = undefined;
+        this.date = date;
+        this.configuration = configuration;
+    }
+    synopsis() {
+        return `[${gtx._('INPUTFILE')}...]`;
+    }
+    description() {
+        return gtx._('Extract translatable strings from given input files.');
+    }
+    aliases() {
+        return ['extract'];
+    }
+    args() {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const outputFile = ((_a = this.configuration.package) === null || _a === void 0 ? void 0 : _a.textdomain)
+            ? `${this.configuration.package.textdomain}.pot`
+            : undefined;
+        return {
+            'files-from': {
+                group: gtx._('Input file location:'),
+                type: 'string',
+                array: true,
+                describe: gtx._('get list of input files from FILE'),
+                default: (_b = this.configuration.package) === null || _b === void 0 ? void 0 : _b['files-from'],
+            },
+            directory: {
+                group: gtx._('Input file location:'),
+                type: 'string',
+                array: true,
+                describe: gtx._('add directory to list for input files search\nIf input file is -, standard input is read.'),
+            },
+            'default-domain': {
+                group: gtx._('Output file location:'),
+                alias: 'd',
+                type: 'string',
+                describe: gtx._('use NAME.po for output (instead of messages.po)'),
+            },
+            output: {
+                group: gtx._('Output file location:'),
+                alias: 'o',
+                type: 'string',
+                describe: gtx._('write output to specified file'),
+                default: outputFile,
+            },
+            'output-dir': {
+                group: gtx._('Output file location:'),
+                alias: 'p',
+                type: 'string',
+                describe: gtx._('output files will be placed in directory DIR. If output file is -, output is written to standard output.'),
+                default: (_d = (_c = this.configuration.po) === null || _c === void 0 ? void 0 : _c.directory) !== null && _d !== void 0 ? _d : '.',
+            },
+            language: {
+                group: gtx._('Choice of input file language:'),
+                alias: 'L',
+                type: 'string',
+                choices: ['javascript', 'typescript'],
+                coerce: arg => arg.toLowerCase(),
+                describe: gtx._('recognise the specified language (JavaScript, TypeScript, HTML). Default is to auto-detect language based on filename extension.'),
+            },
+            'from-code': {
+                group: gtx._('Interpretation of input files:'),
+                type: 'string',
+                describe: gtx._('encoding of input files'),
+                default: 'ASCII',
+            },
+            'join-existing': {
+                group: gtx._('Operation mode:'),
+                alias: 'j',
+                type: 'boolean',
+                describe: gtx._('join messages with existing file'),
+            },
+            'exclude-file': {
+                group: gtx._('Operation mode:'),
+                alias: 'x',
+                type: 'string',
+                describe: gtx._('entries from FILE.po are not extracted'),
+                array: true,
+            },
+            'add-comments': {
+                group: gtx._('Operation mode:'),
+                alias: 'c',
+                type: 'string',
+                describe: gtx._('place comment blocks starting with TAG and preceding keyword lines in output file'),
+                array: true,
+            },
+            'add-all-comments': {
+                group: gtx._('Operation mode:'),
+                describe: gtx._('place all comment blocks preceding keyword lines in output file'),
+                type: 'boolean',
+            },
+            'extract-all': {
+                group: gtx._('Language specific options:'),
+                alias: 'a',
+                type: 'boolean',
+                describe: gtx._('extract all strings'),
+            },
+            keyword: {
+                group: gtx._('Language specific options:'),
+                type: 'string',
+                describe: gtx._('look for WORD as an additional keyword'),
+                array: true,
+            },
+            flag: {
+                group: gtx._('Language specific options:'),
+                type: 'string',
+                describe: gtx._('argument: WORD:ARG:FLAG, additional flag for strings inside the argument number ARG of keyword WORD'),
+                array: true,
+            },
+            instance: {
+                group: gtx._('Language specific options:'),
+                type: 'string',
+                describe: gtx._('only accept method calls of specified instance names'),
+                array: true,
+            },
+            'force-po': {
+                group: gtx._('Output details:'),
+                type: 'boolean',
+                describe: gtx._('write PO file even if empty'),
+            },
+            width: {
+                group: gtx._('Output details:'),
+                type: 'number',
+                describe: gtx._('set output page width'),
+            },
+            'no-wrap': {
+                group: gtx._('Output details:'),
+                type: 'boolean',
+                describe: gtx._('do not break long message lines,' +
+                    ' longer than' +
+                    ' the output page width, into' +
+                    ' several lines'),
+            },
+            'sort-output': {
+                group: gtx._('Output details:'),
+                alias: 's',
+                type: 'boolean',
+                describe: gtx._('generate sorted output'),
+            },
+            'sort-by-file': {
+                group: gtx._('Output details:'),
+                alias: 'F',
+                type: 'boolean',
+                describe: gtx._('sort output by file location'),
+            },
+            'omit-header': {
+                group: gtx._('Output details:'),
+                type: 'boolean',
+                describe: gtx._("don't write header with msgid '\"\"' entry"),
+            },
+            'copyright-holder': {
+                group: gtx._('Output details:'),
+                type: 'string',
+                describe: gtx._('set copyright holder in output'),
+                default: (_e = this.configuration.package) === null || _e === void 0 ? void 0 : _e['copyright-holder'],
+            },
+            'foreign-user': {
+                group: gtx._('Output details:'),
+                type: 'string',
+                describe: gtx._('omit FSF copyright in output for foreign user'),
+            },
+            'package-name': {
+                group: gtx._('Output details:'),
+                type: 'string',
+                describe: gtx._('set package name in output'),
+                default: (_f = this.configuration.package) === null || _f === void 0 ? void 0 : _f.name,
+            },
+            'package-version': {
+                group: gtx._('Output details:'),
+                type: 'string',
+                describe: gtx._('set package version in output'),
+                default: (_g = this.configuration.package) === null || _g === void 0 ? void 0 : _g.version,
+            },
+            'msgid-bugs-address': {
+                group: gtx._('Output details:'),
+                type: 'string',
+                describe: gtx._('set report address for msgid bugs'),
+                default: (_h = this.configuration.package) === null || _h === void 0 ? void 0 : _h['msgid-bugs-address'],
+            },
+            'msgstr-prefix': {
+                group: gtx._('Output details:'),
+                alias: 'm',
+                type: 'string',
+                describe: gtx._('use STRING or "" as prefix for msgstr values'),
+            },
+            'msgstr-suffix': {
+                group: gtx._('Output details:'),
+                alias: 'M',
+                type: 'string',
+                describe: gtx._('use STRING or "" as suffix for msgstr values'),
+            },
+            verbose: {
+                alias: 'V',
+                type: 'boolean',
+                describe: gtx._('Enable verbose output'),
+            },
+        };
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    additional(_) { }
+    init(argv) {
+        var _a, _b, _c, _d, _e;
+        const options = argv;
+        this.options = options;
+        const conf = this.configuration;
+        const catalogProperties = { date: this.date };
+        catalogProperties.package = (_a = conf.package) === null || _a === void 0 ? void 0 : _a.name;
+        catalogProperties.version = (_b = conf.package) === null || _b === void 0 ? void 0 : _b.version;
+        catalogProperties.msgidBugsAddress = (_c = conf.package) === null || _c === void 0 ? void 0 : _c['msgid-bugs-address'];
+        catalogProperties.copyrightHolder = (_d = conf.package) === null || _d === void 0 ? void 0 : _d['copyright-holder'];
+        if (typeof options.output === 'undefined' && ((_e = conf.package) === null || _e === void 0 ? void 0 : _e.textdomain)) {
+            if (typeof options.outputDir === 'undefined') {
+                options.output = conf.package.textdomain + '.pot';
+            }
+            else {
+                options.output = path.join(options.outputDir, conf.package.textdomain + '.pot');
+            }
+        }
+        if (typeof options.packageName !== 'undefined') {
+            catalogProperties.package = options.packageName;
+        }
+        if (typeof options.packageVersion !== 'undefined') {
+            catalogProperties.version = options.version;
+        }
+        if (typeof options.msgidBugsAddress !== 'undefined') {
+            catalogProperties.msgidBugsAddress = options.msgidBugsAddress;
+        }
+        this.catalog = new catalog_1.Catalog(catalogProperties);
+        if (typeof options.language !== 'undefined') {
+            const language = options.language.toLowerCase();
+            if (!['javascript', 'typescript'].includes(language)) {
+                throw new Error(gtx._x('language "{language}" unknown', {
+                    language: this.options.language,
+                }));
+            }
+            this.options.language = language;
+        }
+    }
+    doRun() {
+        let exitCode = 0;
+        this.exclude = {};
+        if (this.options.excludeFile) {
+            try {
+                if (!this.fillExclusionCatalog(this.options.excludeFile)) {
+                    return 1;
+                }
+            }
+            catch (e) {
+                const error = e;
+                console.error(gtx._x('{programName}: Error: {message}', {
+                    programName: this.options.$0,
+                    message: error.message,
+                }));
+                return 1;
+            }
+        }
+        if (this.options.joinExisting) {
+            if (this.options.output === '-') {
+                console.error(gtx._x('{programName}: Error: --join-existing' +
+                    ' cannot be used, when output is written to stdout', {
+                    programName: this.options.$0,
+                }));
+                return 1;
+            }
+            const parserOptions = this.getParserOptions();
+            const parser = new po_1.PoParser(this.catalog, parserOptions);
+            const filename = this.options.output;
+            try {
+                if (!parser.parse(this.readFile(filename), filename)) {
+                    exitCode = 1;
+                }
+            }
+            catch (msg) {
+                console.error(`${filename}: ${msg}`);
+                exitCode = 1;
+            }
+        }
+        let fileCollector;
+        try {
+            fileCollector = new files_collector_1.FilesCollector(this.options.filesFrom, this.options._);
+        }
+        catch (e) {
+            console.error(`${this.options.$0}: ${e}`);
+            return 1;
+        }
+        // FIXME! The file collector must interpret all filenames relative to
+        // the files-from file's director.
+        fileCollector.filenames.forEach(filename => {
+            try {
+                if (!this.parse(this.readFile(filename), filename)) {
+                    exitCode = 1;
+                }
+            }
+            catch (msg) {
+                if ('-' === filename) {
+                    filename = gtx._('[standard input]');
+                }
+                console.error(`${filename}: ${msg}`);
+                exitCode = 1;
+            }
+        });
+        if (!exitCode) {
+            try {
+                this.output();
+            }
+            catch (exception) {
+                console.error(gtx._x('{programName}: {exception}', {
+                    programName: this.options['$0'],
+                    exception: exception,
+                }));
+                exitCode = 1;
+            }
+        }
+        return exitCode;
+    }
+    run(argv) {
+        this.init(argv);
+        return new Promise(resolve => {
+            try {
+                resolve(this.doRun());
+            }
+            catch (e) {
+                console.error(e);
+                resolve(1);
+            }
+        });
+    }
+    parse(code, filename) {
+        let parser;
+        const parserOptions = this.getParserOptions();
+        if (typeof this.options.language !== 'undefined') {
+            parser = this.getParserByLanguage(this.options.language, parserOptions);
+        }
+        else {
+            parser = this.getParserByFilename(filename, parserOptions);
+        }
+        return parser.parse(code, filename);
+    }
+    readFile(filename) {
+        if ('-' === filename) {
+            return process.stdin.read();
+        }
+        const directories = this.options.directory || [''];
+        // Avoid ugly absolute paths.
+        const resolve = (dir, file) => {
+            if (dir === '') {
+                return file;
+            }
+            else {
+                return dir + path.sep + file;
+            }
+        };
+        for (let i = 0; i < directories.length - 1; ++i) {
+            try {
+                const fullName = resolve(directories[i], filename);
+                return (0, fs_1.readFileSync)(fullName);
+            }
+            catch (e) {
+                /* ignore */
+            }
+        }
+        return (0, fs_1.readFileSync)(resolve(directories[directories.length - 1], filename));
+    }
+    getParserByFilename(filename, parserOptions) {
+        let parser;
+        const ext = path.extname(filename);
+        switch (ext.toLocaleLowerCase()) {
+            case '.ts':
+            case '.tsx':
+                parser = new typescript_1.TypeScriptParser(this.catalog, parserOptions);
+                break;
+            case '.js':
+            case '.jsx':
+                parser = new javascript_1.JavaScriptParser(this.catalog, parserOptions);
+                break;
+            case '.po':
+            case '.pot':
+                parser = new po_1.PoParser(this.catalog, parserOptions);
+                break;
+            default:
+                if ('-' === filename) {
+                    this.warn(gtx._('language for standard input is unknown without' +
+                        ' option "--language"; will try JavaScript'));
+                }
+                else {
+                    this.warn(gtx._x('file "{filename}" extension "{extname}"' +
+                        ' is unknown; will try JavaScript instead', {
+                        filename,
+                        extname: ext,
+                    }));
+                }
+                parser = new javascript_1.JavaScriptParser(this.catalog, parserOptions);
+                break;
+        }
+        return parser;
+    }
+    getParserByLanguage(language, parserOptions) {
+        let parser;
+        switch (language.toLocaleLowerCase()) {
+            case 'typescript':
+                parser = new typescript_1.TypeScriptParser(this.catalog, parserOptions);
+                break;
+            case 'javascript':
+            default:
+                parser = new javascript_1.JavaScriptParser(this.catalog, parserOptions);
+                break;
+        }
+        return parser;
+    }
+    warn(msg) {
+        console.warn(gtx._x('{programName}: Warning: {msg}', {
+            msg,
+            programName: this.options.$0,
+        }));
+    }
+    output() {
+        Object.keys(this.exclude)
+            .filter(msgctxt => Object.prototype.hasOwnProperty.call(this.exclude, msgctxt))
+            .forEach(msgctxt => {
+            this.exclude[msgctxt].forEach(msgid => {
+                this.catalog.deleteEntry(msgid, msgctxt);
+            });
+        });
+        if (!this.options.forcePo) {
+            if (this.catalog.entries.length < 2) {
+                return;
+            }
+        }
+        const renderOptions = {};
+        if (typeof this.options.width !== 'undefined') {
+            renderOptions.width = this.options.width;
+        }
+        const po = this.catalog.toString(renderOptions);
+        if (this.options.output === '-') {
+            process.stdout.write(po);
+            return;
+        }
+        let filename;
+        if (typeof this.options.output === 'undefined') {
+            const domain = typeof this.options.defaultDomain === 'undefined'
+                ? 'messages'
+                : this.options.defaultDomain;
+            filename = `${domain}.po`;
+        }
+        else {
+            filename = this.options.output;
+        }
+        const outputDir = typeof this.options.outputDir === 'undefined'
+            ? ''
+            : this.options.outputDir;
+        (0, fs_1.writeFileSync)(path.join(outputDir, filename), po);
+    }
+    fillExclusionCatalog(catalogs) {
+        const catalog = new catalog_1.Catalog();
+        const parser = new po_1.PoParser(catalog);
+        let success = true;
+        catalogs.forEach(filename => {
+            if (!parser.parse(this.readFile(filename), filename)) {
+                success = false;
+            }
+        });
+        if (!success) {
+            return false;
+        }
+        catalog.deleteEntry('');
+        catalog.entries.forEach(entry => {
+            if (typeof this.exclude[entry.properties.msgctxt] === 'undefined') {
+                this.exclude[entry.properties.msgctxt] = [];
+            }
+            if (entry.properties.msgid) {
+                this.exclude[entry.properties.msgctxt].push(entry.properties.msgid);
+            }
+        });
+        return true;
+    }
+    getParserOptions() {
+        const parserOptions = (({ fromCode, addComments, addAllComments, extractAll, }) => ({
+            fromCode,
+            addComments,
+            addAllComments,
+            extractAll,
+        }))(this.options);
+        if (this.options.keyword) {
+            const cookedKeywords = new Array();
+            this.options.keyword.forEach(raw => {
+                cookedKeywords.push(keyword_1.Keyword.from(raw));
+            });
+            parserOptions.keyword = cookedKeywords;
+        }
+        return parserOptions;
+    }
+}
+exports.XGettext = XGettext;