@esgettext/tools 1.1.0 → 1.2.0

package/LICENSE

@@ -1,4 +1,4 @@
-This software is Copyright (C) 2020 by Guido Flohr.
+This software is Copyright (C) 2020-2024 by Guido Flohr.
 
 This is free software, licensed under:
 

package/README.md

@@ -294,7 +294,7 @@ for example `['verbose']` or `['v']`, and not `['--verbose']` or `['-v']`.
 
 ## Copyright
 
-Copyright (C) 2020 Guido Flohr <guido.flohr@cantanea.com>, all
+Copyright (C) 2020-2024 Guido Flohr <guido.flohr@cantanea.com>, all
 rights reserved.
 
 This software is available under the terms and conditions of the

package/dist/command.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=command.js.map

package/dist/commands/convert.js

@@ -29,8 +29,9 @@ const runtime_1 = require("@esgettext/runtime");
 const package_1 = require("../package");
 const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
 class Convert {
-    constructor(configuration) {
-        this.configuration = configuration;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    constructor(_) {
+        this.options = undefined;
     }
     synopsis() {
         return `[${gtx._('INPUTFILE')}] [${gtx._('OUTPUTFILE')}]`;
@@ -195,6 +196,7 @@ class Convert {
             if (typeof filename !== 'undefined') {
                 return fs.readFileSync(filename);
             }
+            // Must read from standard input.
             const stdinFd = 0;
             const chunks = [];
             let bytesRead;
@@ -238,16 +240,16 @@ class Convert {
     }
     shortenAndEscapeString(input, maxLength) {
         const controlCharMap = {
-            '\0': '\\0',
-            '\b': '\\b',
-            '\t': '\\t',
-            '\n': '\\n',
-            '\v': '\\v',
-            '\f': '\\f',
-            '\r': '\\r',
-            '"': '\\"',
-            "'": "\\'",
-            '\\': '\\\\',
+            '\0': '\\0', // Null character
+            '\b': '\\b', // Backspace
+            '\t': '\\t', // Horizontal Tab
+            '\n': '\\n', // New Line
+            '\v': '\\v', // Vertical Tab
+            '\f': '\\f', // Form Feed
+            '\r': '\\r', // Carriage Return
+            '"': '\\"', // Double quote
+            "'": "\\'", // Single quote
+            '\\': '\\\\', // Backslash
         };
         const escapeControlChar = (char) => {
             if (controlCharMap[char]) {
@@ -257,8 +259,9 @@ class Convert {
             if (code < 32) {
                 return `\\x${code.toString(16).padStart(2, '0')}`;
             }
-            return char;
+            return char; // This line is technically redundant with the current regex.
         };
+        // Escape all control characters
         const escapedInput = input.replace(/[\x00-\x1F"'\\]/g, escapeControlChar);
         let truncatedString = escapedInput;
         if (escapedInput.length > maxLength) {
@@ -281,4 +284,3 @@ class Convert {
     }
 }
 exports.Convert = Convert;
-//# sourceMappingURL=convert.js.map

package/dist/commands/install.js

@@ -30,6 +30,8 @@ const mkdirp = __importStar(require("mkdirp"));
 const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
 class Install {
     constructor(configuration) {
+        this.locales = undefined;
+        this.options = undefined;
         this.configuration = configuration;
     }
     synopsis() {
@@ -42,7 +44,7 @@ class Install {
         return [];
     }
     args() {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         return {
             locales: {
                 alias: 'l',
@@ -66,10 +68,16 @@ class Install {
                 choices: ['gmo', 'mo'],
                 group: gtx._('Input file options:'),
             },
+            'default-domain': {
+                type: 'string',
+                describe: gtx._('The textdomain to use'),
+                default: (_d = this.configuration.package) === null || _d === void 0 ? void 0 : _d.textdomain,
+                group: gtx._('Output file options'),
+            },
             'output-directory': {
                 type: 'string',
                 describe: gtx._('Output directory'),
-                default: (_e = (_d = this.configuration.install) === null || _d === void 0 ? void 0 : _d.directory) !== null && _e !== void 0 ? _e : 'src/locale',
+                default: (_f = (_e = this.configuration.install) === null || _e === void 0 ? void 0 : _e.directory) !== null && _f !== void 0 ? _f : 'src/locale',
                 group: gtx._('Output file options:'),
             },
             'output-format': {
@@ -86,6 +94,7 @@ class Install {
             },
         };
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     additional(_) { }
     init(argv) {
         var _a, _b, _c, _d;
@@ -224,7 +233,7 @@ class Install {
     installLocale(locale) {
         try {
             const directory = this.options.outputDirectory + '/' + locale + '/LC_MESSAGES';
-            const outFile = directory + '/' + 'domain' + '.' + this.options.outputFormat;
+            const outFile = directory + '/' + this.options.defaultDomain + '.' + this.options.outputFormat;
             const inFile = this.options.directory + '/' + locale + '.' + this.options.inputFormat;
             if (!(0, fs_1.existsSync)(directory)) {
                 mkdirp.sync(directory);
@@ -246,4 +255,3 @@ class Install {
     }
 }
 exports.Install = Install;
-//# sourceMappingURL=install.js.map

package/dist/commands/msgfmt-all.js

@@ -22,6 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MsgfmtAll = void 0;
 const fs = __importStar(require("fs"));
@@ -31,6 +40,8 @@ const package_1 = require("../package");
 const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
 class MsgfmtAll {
     constructor(configuration) {
+        this.locales = undefined;
+        this.options = undefined;
         this.configuration = configuration;
     }
     synopsis() {
@@ -96,6 +107,7 @@ class MsgfmtAll {
         }
         return options;
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     additional(_) { }
     init(argv) {
         var _a, _b;
@@ -119,9 +131,15 @@ class MsgfmtAll {
     run(argv) {
         this.init(argv);
         return new Promise(resolve => {
-            this.locales
-                .reduce((promise, locale) => promise.then(() => this.msgfmtLocale(locale)), Promise.resolve())
-                .then(() => resolve(0), () => resolve(1));
+            const promises = this.locales.map(locale => this.msgfmtLocale(locale));
+            Promise.all(promises)
+                .then(results => {
+                const hasOne = results.some(result => result === 1);
+                resolve(hasOne ? 1 : 0);
+            })
+                .catch(() => {
+                resolve(1);
+            });
         });
     }
     convertOptions(options) {
@@ -147,54 +165,55 @@ class MsgfmtAll {
         }
         return errors ? null : msgmergeOptions;
     }
-    async msgfmtLocale(locale) {
-        return new Promise(resolve => {
-            const args = this.convertOptions(this.options.options);
-            if (!args)
-                return resolve(1);
-            const poFile = this.options.directory + '/' + locale + '.po';
-            const moFile = this.options.directory + '/' + locale + '.' + this.options.format;
-            args.push('-o', moFile, poFile);
-            if (this.options.verbose) {
-                console.log(gtx._x("Compiling '{po}' into '{mo}'.", {
-                    po: poFile,
-                    mo: moFile,
-                }));
-            }
-            try {
-                const msgfmt = childProcess.spawn(this.options.msgfmt, args, {
-                    windowsHide: true,
-                });
-                msgfmt.stdout.on('data', (data) => process.stdout.write(data.toString()));
-                msgfmt.stderr.on('data', (data) => process.stderr.write(data.toString()));
-                msgfmt.on('close', code => {
-                    if (code) {
-                        fs.unlinkSync(moFile);
-                        resolve(1);
-                    }
-                    else {
-                        resolve(0);
-                    }
-                });
-                msgfmt.on('error', err => {
-                    throw new Error(gtx._x("Failed to run '{prg}': {err}", {
-                        prg: this.options.msgfmt,
-                        err,
+    msgfmtLocale(locale) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise(resolve => {
+                const args = this.convertOptions(this.options.options);
+                if (!args)
+                    return resolve(1);
+                const poFile = this.options.directory + '/' + locale + '.po';
+                const moFile = this.options.directory + '/' + locale + '.' + this.options.format;
+                args.push('-o', moFile, poFile);
+                if (this.options.verbose) {
+                    console.log(gtx._x("Compiling '{po}' into '{mo}'.", {
+                        po: poFile,
+                        mo: moFile,
                     }));
-                });
-            }
-            catch (err) {
+                }
                 try {
-                    fs.unlinkSync(moFile);
+                    const msgfmt = childProcess.spawn(this.options.msgfmt, args, {
+                        windowsHide: true,
+                    });
+                    msgfmt.stdout.on('data', (data) => process.stdout.write(data.toString()));
+                    msgfmt.stderr.on('data', (data) => process.stderr.write(data.toString()));
+                    msgfmt.on('close', code => {
+                        if (code) {
+                            fs.unlinkSync(moFile);
+                            resolve(1);
+                        }
+                        else {
+                            resolve(0);
+                        }
+                    });
+                    msgfmt.on('error', err => {
+                        throw new Error(gtx._x("Failed to run '{prg}': {err}", {
+                            prg: this.options.msgfmt,
+                            err,
+                        }));
+                    });
                 }
-                catch (err1) {
-                    console.error(err1);
+                catch (err) {
+                    try {
+                        fs.unlinkSync(moFile);
+                    }
+                    catch (err1) {
+                        console.error(err1);
+                    }
+                    console.error(err);
+                    resolve(1);
                 }
-                console.error(err);
-                resolve(1);
-            }
+            });
         });
     }
 }
 exports.MsgfmtAll = MsgfmtAll;
-//# sourceMappingURL=msgfmt-all.js.map

package/dist/commands/msgmerge-all.js

@@ -22,6 +22,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MsgmergeAll = void 0;
 const path = __importStar(require("path"));
@@ -33,6 +42,8 @@ const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
 class MsgmergeAll {
     constructor(configuration) {
         var _a, _b;
+        this.locales = [];
+        this.options = {};
         this.configuration = configuration;
         if (((_a = configuration.package) === null || _a === void 0 ? void 0 : _a.textdomain) &&
             typeof ((_b = configuration.po) === null || _b === void 0 ? void 0 : _b.directory) !== 'undefined') {
@@ -131,9 +142,15 @@ class MsgmergeAll {
     run(argv) {
         this.init(argv);
         return new Promise(resolve => {
-            this.locales
-                .reduce((promise, locale) => promise.then(() => this.msgmergeLocale(locale)), Promise.resolve())
-                .then(() => resolve(0), () => resolve(1));
+            const promises = this.locales.map(locale => this.msgmergeLocale(locale));
+            Promise.all(promises)
+                .then(results => {
+                const hasOne = results.some(result => result === 1);
+                resolve(hasOne ? 1 : 0);
+            })
+                .catch(() => {
+                resolve(1);
+            });
         });
     }
     convertOptions(options) {
@@ -159,54 +176,55 @@ class MsgmergeAll {
         }
         return errors ? null : msgmergeOptions;
     }
-    async msgmergeLocale(locale) {
-        return new Promise(resolve => {
-            const args = this.convertOptions(this.options.options);
-            if (!args)
-                return resolve(1);
-            const poFile = this.options.directory + '/' + locale + '.po';
-            const oldPoFile = this.options.directory + '/' + locale + '.old.po';
-            args.push(oldPoFile, this.potfile, '-o', poFile);
-            console.log(gtx._x("Merging '{pot}' into '{po}'.", {
-                pot: this.potfile,
-                po: poFile,
-            }));
-            try {
-                fs.renameSync(poFile, oldPoFile);
-                const msgmerge = childProcess.spawn(this.options.msgmerge, args, {
-                    windowsHide: true,
-                });
-                msgmerge.on('error', err => {
-                    throw new Error(gtx._x("Failed to run '{prg}': {err}", {
-                        prg: this.options.msgmerge,
-                        err,
-                    }));
-                });
-                msgmerge.stdout.on('data', (data) => process.stdout.write(data.toString()));
-                msgmerge.stderr.on('data', (data) => process.stderr.write(data.toString()));
-                msgmerge.on('close', code => {
-                    if (code) {
+    msgmergeLocale(locale) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise(resolve => {
+                const args = this.convertOptions(this.options.options);
+                if (!args)
+                    return resolve(1);
+                const poFile = this.options.directory + '/' + locale + '.po';
+                const oldPoFile = this.options.directory + '/' + locale + '.old.po';
+                args.push(oldPoFile, this.potfile, '-o', poFile);
+                console.log(gtx._x("Merging '{pot}' into '{po}'.", {
+                    pot: this.potfile,
+                    po: poFile,
+                }));
+                try {
+                    fs.renameSync(poFile, oldPoFile);
+                    const msgmerge = childProcess.spawn(this.options.msgmerge, args, {
+                        windowsHide: true,
+                    });
+                    msgmerge.on('error', err => {
+                        throw new Error(gtx._x("Failed to run '{prg}': {err}", {
+                            prg: this.options.msgmerge,
+                            err,
+                        }));
+                    });
+                    msgmerge.stdout.on('data', (data) => process.stdout.write(data.toString()));
+                    msgmerge.stderr.on('data', (data) => process.stderr.write(data.toString()));
+                    msgmerge.on('close', code => {
+                        if (code) {
+                            fs.renameSync(oldPoFile, poFile);
+                            resolve(1);
+                        }
+                        else {
+                            fs.unlinkSync(oldPoFile);
+                            resolve(0);
+                        }
+                    });
+                }
+                catch (err) {
+                    try {
                         fs.renameSync(oldPoFile, poFile);
-                        resolve(1);
                     }
-                    else {
-                        fs.unlinkSync(oldPoFile);
-                        resolve(0);
+                    catch (err1) {
+                        console.error(err1);
                     }
-                });
-            }
-            catch (err) {
-                try {
-                    fs.renameSync(oldPoFile, poFile);
-                }
-                catch (err1) {
-                    console.error(err1);
+                    console.error(err);
+                    resolve(1);
                 }
-                console.error(err);
-                resolve(1);
-            }
+            });
         });
     }
 }
 exports.MsgmergeAll = MsgmergeAll;
-//# sourceMappingURL=msgmerge-all.js.map

package/dist/commands/xgettext/file-resolver.js

@@ -18,4 +18,3 @@ class FileResolver {
     }
 }
 exports.FileResolver = FileResolver;
-//# sourceMappingURL=file-resolver.js.map

package/dist/commands/xgettext/files-collector.js

@@ -18,6 +18,7 @@ class FilesCollector {
             });
         }
         args.forEach(filename => filenames.push(filename));
+        // Make filenames unique.
         this.filenames = Array.from(new Set(filenames));
     }
     getFilesFromFile(filename) {
@@ -36,4 +37,3 @@ class FilesCollector {
     }
 }
 exports.FilesCollector = FilesCollector;
-//# sourceMappingURL=files-collector.js.map

package/dist/commands/xgettext.js

@@ -35,7 +35,11 @@ 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;
     }
@@ -49,7 +53,7 @@ class XGettext {
         return ['extract'];
     }
     args() {
-        var _a, _b, _c, _d, _e, _f, _g;
+        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;
@@ -59,6 +63,7 @@ class XGettext {
                 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:'),
@@ -84,7 +89,7 @@ class XGettext {
                 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: (_c = (_b = this.configuration.po) === null || _b === void 0 ? void 0 : _b.directory) !== null && _c !== void 0 ? _c : '.',
+                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:'),
@@ -188,7 +193,7 @@ class XGettext {
                 group: gtx._('Output details:'),
                 type: 'string',
                 describe: gtx._('set copyright holder in output'),
-                default: (_d = this.configuration.package) === null || _d === void 0 ? void 0 : _d['copyright-holder'],
+                default: (_e = this.configuration.package) === null || _e === void 0 ? void 0 : _e['copyright-holder'],
             },
             'foreign-user': {
                 group: gtx._('Output details:'),
@@ -199,19 +204,19 @@ class XGettext {
                 group: gtx._('Output details:'),
                 type: 'string',
                 describe: gtx._('set package name in output'),
-                default: (_e = this.configuration.package) === null || _e === void 0 ? void 0 : _e.name,
+                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: (_f = this.configuration.package) === null || _f === void 0 ? void 0 : _f.version,
+                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: (_g = this.configuration.package) === null || _g === void 0 ? void 0 : _g['msgid-bugs-address'],
+                default: (_h = this.configuration.package) === null || _h === void 0 ? void 0 : _h['msgid-bugs-address'],
             },
             'msgstr-prefix': {
                 group: gtx._('Output details:'),
@@ -232,6 +237,7 @@ class XGettext {
             },
         };
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     additional(_) { }
     init(argv) {
         var _a, _b, _c, _d, _e;
@@ -318,6 +324,8 @@ class XGettext {
             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)) {
@@ -374,6 +382,7 @@ class XGettext {
             return process.stdin.read();
         }
         const directories = this.options.directory || [''];
+        // Avoid ugly absolute paths.
         const resolve = (dir, file) => {
             if (dir === '') {
                 return file;
@@ -388,6 +397,7 @@ class XGettext {
                 return (0, fs_1.readFileSync)(fullName);
             }
             catch (e) {
+                /* ignore */
             }
         }
         return (0, fs_1.readFileSync)(resolve(directories[directories.length - 1], filename));
@@ -522,4 +532,3 @@ class XGettext {
     }
 }
 exports.XGettext = XGettext;
-//# sourceMappingURL=xgettext.js.map