@esgettext/tools 1.1.0 → 1.3.0

package/dist/index.js

@@ -1,56 +1,91 @@
 #! /usr/bin/env node
 "use strict";
+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());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const yargs_1 = __importDefault(require("yargs"));
-const package_1 = require("./package");
+const package_js_1 = require("./package.js");
 const runtime_1 = require("@esgettext/runtime");
-const configuration_1 = require("./configuration");
-const xgettext_1 = require("./commands/xgettext");
-const msgmerge_all_1 = require("./commands/msgmerge-all");
-const install_1 = require("./commands/install");
-const convert_1 = require("./commands/convert");
-const msgfmt_all_1 = require("./commands/msgfmt-all");
+const configuration_js_1 = require("./configuration.js");
+const xgettext_js_1 = require("./commands/xgettext.js");
+const msgmerge_all_js_1 = require("./commands/msgmerge-all.js");
+const install_js_1 = require("./commands/install.js");
+const convert_js_1 = require("./commands/convert.js");
+const msgfmt_all_js_1 = require("./commands/msgfmt-all.js");
+const init_js_1 = require("./commands/init.js");
+const potfiles_js_1 = require("./commands/potfiles.js");
+const add_language_js_1 = require("./commands/add-language.js");
 const commandNames = [
-    'xgettext',
-    'msgmerge-all',
-    'msgfmt-all',
-    'install',
+    'add-language',
     'convert',
+    'install',
+    'init',
+    'msgfmt-all',
+    'msgmerge-all',
+    'potfiles',
+    'xgettext',
 ];
+const configFiles = locateConfigFiles();
+const pkgJsonFile = locatePkgJsonFile();
 const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
 gtx
     .resolve()
-    .then(async () => {
+    .then(() => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
     const locale = runtime_1.Textdomain.selectLocale(['en-US', 'en-GB', 'de']);
     const ulocale = locale.replace('-', '_');
-    const configuration = await configuration_1.ConfigurationFactory.create(locale);
+    const configuration = yield configuration_js_1.ConfigurationFactory.create(configFiles, pkgJsonFile, locale);
     if (!configuration)
         process.exit(1);
     const commands = {
-        xgettext: new xgettext_1.XGettext(configuration),
-        'msgmerge-all': new msgmerge_all_1.MsgmergeAll(configuration),
-        'msgfmt-all': new msgfmt_all_1.MsgfmtAll(configuration),
-        install: new install_1.Install(configuration),
-        convert: new convert_1.Convert(configuration),
+        xgettext: new xgettext_js_1.XGettext(configuration),
+        'msgmerge-all': new msgmerge_all_js_1.MsgmergeAll(configuration),
+        'msgfmt-all': new msgfmt_all_js_1.MsgfmtAll(configuration),
+        install: new install_js_1.Install(configuration),
+        convert: new convert_js_1.Convert(configuration),
+        init: new init_js_1.Init(configuration),
+        potfiles: new potfiles_js_1.Potfiles(configuration),
+        'add-language': new add_language_js_1.AddLanguage(configuration),
     };
     const program = (0, yargs_1.default)(process.argv.slice(2))
         .locale(ulocale)
         .strict()
+        .options({
+        configuration: {
+            alias: ['config-file'],
+            type: 'string',
+            describe: gtx._('Path to configuration file'),
+            default: 'esgettext.config.{mjs,cjs,js,json}',
+        },
+        package: {
+            alias: ['package-json'],
+            type: 'string',
+            describe: gtx._("Path to 'package.json'"),
+            default: 'package.json',
+        },
+    })
         .showHelpOnFail(false, gtx._x("Try {programName} '--help' for more information!", {
-        programName: package_1.Package.getName(),
+        programName: package_js_1.Package.getName(),
     }))
         .demandCommand(1, gtx._('Error: No command given.'))
-        .scriptName(package_1.Package.getName());
-    let epilogue = configuration.files.length
+        .scriptName(package_js_1.Package.getName());
+    let epilogue = ((_a = configuration.files) === null || _a === void 0 ? void 0 : _a.length)
         ? gtx._x('Additional defaults read from: {files}.', {
             files: configuration.files.join(', '),
         }) + '\n\n'
         : '';
     epilogue += gtx._x('Report bugs in the bugtracker at {url}!', {
-        url: package_1.Package.getBugTrackerUrl(),
+        url: package_js_1.Package.getBugTrackerUrl(),
     });
     for (const name of commandNames) {
         const command = commands[name];
@@ -66,19 +101,52 @@ gtx
                 command.additional(argv);
                 return argv.options(command.args());
             },
-            handler: async (argv) => {
-                argv._.shift();
-                const exitCode = await command.run(argv);
+            handler: (argv) => __awaiter(void 0, void 0, void 0, function* () {
+                argv._.shift(); // Remove the command name.
+                const exitCode = yield command.run(argv);
                 process.exit(exitCode);
-            },
+            }),
         });
     }
     program.help().epilogue(epilogue).parse();
-})
+}))
     .catch((exception) => {
     console.error(gtx._x('{programName}: unhandled exception: {exception}'), {
-        programName: package_1.Package.getName(),
+        programName: package_js_1.Package.getName(),
         exception,
     });
 });
-//# sourceMappingURL=index.js.map
+function getArgument(option) {
+    const longOption = '--' + option;
+    const longOptionRe = new RegExp(`^${longOption}=.+`);
+    const args = process.argv.slice(2);
+    for (const [index, arg] of args.entries()) {
+        if (arg == longOption && index < args.length) {
+            return args[index + 1];
+        }
+        else if (arg.match(longOptionRe)) {
+            return arg.substring(longOption.length + 1);
+        }
+        else if (arg[0] !== '-') {
+            break;
+        }
+    }
+    return null;
+}
+function locateConfigFiles() {
+    var _a;
+    const configFile = (_a = getArgument('config-file')) !== null && _a !== void 0 ? _a : getArgument('configuration');
+    return configFile !== null
+        ? [configFile]
+        : [
+            'esgettext.config.mjs',
+            'esgettext.config.cjs',
+            'esgettext.config.js',
+            'esgettext.config.json',
+        ];
+}
+function locatePkgJsonFile() {
+    var _a;
+    const configFile = (_a = getArgument('package')) !== null && _a !== void 0 ? _a : getArgument('package-json');
+    return configFile !== null ? configFile : 'package.json';
+}

package/dist/optspec.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.coerceOptions = void 0;
+const runtime_1 = require("@esgettext/runtime");
+const package_1 = require("./package");
+const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
+function coerceOptions(args, optspecs) {
+    for (const optname in optspecs) {
+        const optspec = optspecs[optname];
+        const optkey = optname.replace(/-(.)/g, (_, group1) => group1.toUpperCase());
+        const arg = args[optkey];
+        const isArray = typeof arg === 'object' && Array.isArray(arg);
+        if (optspec.multi) {
+            if (typeof arg !== 'undefined' && !isArray) {
+                args[optkey] = [args[optkey]];
+            }
+        }
+        else {
+            if (isArray) {
+                console.error(gtx._x('{programName}: Error: The option' +
+                    ' {optname} cannot be specified more than once!', { programName: package_1.Package.getName(), optname }));
+                return false;
+            }
+        }
+    }
+    return true;
+}
+exports.coerceOptions = coerceOptions;

package/dist/package.js

@@ -9,8 +9,10 @@ class Package {
         return 'https://github.com/gflohr/esgettext/issues';
     }
     static getVersion() {
-        return '1.1.0';
+        return '1.3.0';
+    }
+    static getNpmRunAllVersion() {
+        return '^4.1.5';
     }
 }
 exports.Package = Package;
-//# sourceMappingURL=package.js.map

package/dist/parser/javascript.js

@@ -11,6 +11,8 @@ class JavaScriptParser extends parser_2.Parser {
             allowReturnOutsideFunction: true,
             allowSuperOutsideMethod: true,
             allowUndeclaredExports: true,
+            // Documented but not supported. FIXME! Maybe only missing in types.
+            // errorRecovery: true,
             sourceFilename: filename,
             plugins: [
                 'flow',
@@ -24,4 +26,3 @@ class JavaScriptParser extends parser_2.Parser {
     }
 }
 exports.JavaScriptParser = JavaScriptParser;
-//# sourceMappingURL=javascript.js.map

package/dist/parser/parser.js

@@ -38,6 +38,9 @@ class Parser {
     constructor(catalog, options = {}) {
         this.catalog = catalog;
         this.options = options;
+        this.filename = '';
+        this.errors = 0;
+        this.comments = [];
         this.keywords = {};
         (options.keyword || Parser.cookedDefaultKeywords()).forEach(keyword => {
             this.keywords[keyword.method] = keyword;
@@ -81,6 +84,7 @@ class Parser {
                     filename,
                     identifierName: null,
                 };
+                // Find the offending character.
                 for (let i = 0; i < pos; ++i) {
                     if (buf[i] === 10) {
                         ++loc.start.line;
@@ -105,6 +109,7 @@ class Parser {
             input = buf.toString();
         }
         else {
+            // Convert.
             try {
                 input = (0, iconv_lite_1.decode)(buf, this.options.fromCode);
             }
@@ -136,11 +141,15 @@ class Parser {
         });
     }
     extractAllStrings(ast) {
+        // Step 1: Transform string concatenations into one string.
         (0, traverse_1.default)(ast, {
             StringLiteral: path => {
                 this.concatStrings(path);
             },
         });
+        // Step 2: Extract the remaining strings. Those that are part of a
+        // binary expression have not been recognized in step 1 and must be
+        // ignored.
         (0, traverse_1.default)(ast, {
             StringLiteral: path => {
                 if (!t.isBinaryExpression(path.parentPath.node)) {
@@ -165,7 +174,7 @@ class Parser {
         return true;
     }
     checkInstance(instance) {
-        if (!this.options.instance) {
+        if (!this.instances) {
             return true;
         }
         for (let i = 0; i < this.instances.length; ++i) {
@@ -197,6 +206,7 @@ class Parser {
         if (!Object.prototype.hasOwnProperty.call(this.keywords, method)) {
             return;
         }
+        // Enough arguments?
         const keywordSpec = this.keywords[method];
         if (keywordSpec.totalArgs &&
             path.node.arguments.length !== keywordSpec.totalArgs) {
@@ -347,12 +357,14 @@ class Parser {
         else if (t.isMemberExpression(me.object) &&
             t.isIdentifier(me.property) &&
             !me.computed) {
+            // Recurse.
             instance.push(me.property.name);
             return this.methodFromMemberExpression(me.object, instance);
         }
         else if (t.isMemberExpression(me.object) &&
             t.isLiteral(me.property) &&
             me.computed) {
+            // Recurse.
             instance.push(this.literalValue(me.property));
             return this.methodFromMemberExpression(me.object, instance);
         }
@@ -376,6 +388,8 @@ class Parser {
     }
     findPrecedingComments(loc) {
         let last;
+        // Find the last relevant comment, which is the first one that
+        // immediately precedes the location.
         for (last = 0; last < this.comments.length; ++last) {
             const commentLocation = this.comments[last].loc;
             if (commentLocation.end.line === loc.start.line ||
@@ -391,6 +405,7 @@ class Parser {
             this.comments.splice(0, this.comments.length);
             return [];
         }
+        // Now go back and find all adjacent comments.
         let ptr = this.comments[last].loc;
         const preceding = this.comments.splice(0, last + 1);
         if (!last) {
@@ -476,6 +491,7 @@ class Parser {
         console.error(gtx._x('{location}: Error: {msg}', { location, msg }));
     }
     canonicalizeEncoding(encoding) {
+        // This is taken from iconv-lite.
         const canonical = ('' + encoding)
             .toLowerCase()
             .replace(/:[0-9]{4}$|[^0-9a-z]/g, '');
@@ -592,4 +608,3 @@ class Parser {
     }
 }
 exports.Parser = Parser;
-//# sourceMappingURL=parser.js.map

package/dist/parser/po.js

@@ -7,6 +7,26 @@ const entry_1 = require("../pot/entry");
 const parser_1 = require("./parser");
 const gtx = runtime_1.Textdomain.getInstance('tools');
 class PoParser extends parser_1.Parser {
+    constructor() {
+        super(...arguments);
+        // All those get reset on each call to parse().
+        this.entry = undefined;
+        this.loc = undefined;
+        this.entryLoc = undefined;
+        this.msgType = undefined;
+        this.seen = {};
+    }
+    /**
+     * Parse a po file into a catalog. This parser is very forgiving and
+     * accepts input that actually does not follow the standard in certain
+     * areas.
+     *
+     * The encoding will always be read from the PO header if present.
+     *
+     * @param input - the content of the po file
+     * @param filename - the filename
+     * @param encoding - an optional encoding
+     */
     parse(buf, filename, encoding) {
         if (typeof encoding !== 'undefined') {
             if (!(0, iconv_lite_1.encodingExists)(encoding)) {
@@ -15,6 +35,7 @@ class PoParser extends parser_1.Parser {
             }
         }
         const input = typeof encoding === 'undefined' ? buf.toString() : (0, iconv_lite_1.decode)(buf, encoding);
+        // Reset parser.
         this.entry = undefined;
         this.filename = filename;
         this.loc = {
@@ -34,6 +55,8 @@ class PoParser extends parser_1.Parser {
         this.msgType = undefined;
         this.seen = {};
         this.errors = 0;
+        // We cannot use forEach here because we may have to return from
+        // inside the loop.
         const lines = input.split('\n');
         for (let i = 0; i < lines.length; ++i) {
             const line = lines[i];
@@ -48,6 +71,9 @@ class PoParser extends parser_1.Parser {
                     if (charset &&
                         (typeof encoding === 'undefined' ||
                             charset.toLowerCase() !== encoding.toLowerCase())) {
+                        // FIXME! This must only happen, if the header is the first
+                        // entry that has been added. Otherwise, we'll add the entries
+                        // before this, twice.
                         return this.parse(buf, filename, charset);
                     }
                 }
@@ -99,6 +125,9 @@ class PoParser extends parser_1.Parser {
             if (charset &&
                 (typeof encoding === 'undefined' ||
                     charset.toLowerCase() !== encoding.toLowerCase())) {
+                // FIXME! This must only happen, if the header is the first
+                // entry that has been added. Otherwise, we'll add the entries
+                // before this, twice.
                 return this.parse(buf, filename, charset);
             }
         }
@@ -106,9 +135,11 @@ class PoParser extends parser_1.Parser {
         if (this.errors) {
             return false;
         }
+        // FIXME! This must go into the caller!
         this.catalog.makePOT();
         return true;
     }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     doParse(_input, _filename) {
         throw new Error('not implemented');
     }
@@ -150,6 +181,7 @@ class PoParser extends parser_1.Parser {
             const msgctxt = this.entry.properties.msgctxt;
             const msgid = this.entry.properties.msgid;
             if (typeof msgid === 'undefined') {
+                // TRANSLATORS: Do not translate "msgid".
                 this.error(gtx._('missing "msgid" section'), this.loc);
                 return;
             }
@@ -275,6 +307,7 @@ class PoParser extends parser_1.Parser {
                     retval = '\r';
                     break;
                 default:
+                    // We have to take the leading quote into account.
                     this.loc.start.column += offset + 1;
                     this.error(gtx._('invalid control sequence'), this.loc);
                     retval = '';
@@ -298,6 +331,7 @@ class PoParser extends parser_1.Parser {
                 this.entry.addToMsgctxt(msg);
                 break;
             default:
+                // Ignore plural translations.
                 break;
         }
     }
@@ -374,4 +408,3 @@ class PoParser extends parser_1.Parser {
     }
 }
 exports.PoParser = PoParser;
-//# sourceMappingURL=po.js.map

package/dist/parser/typescript.js

@@ -11,6 +11,8 @@ class TypeScriptParser extends parser_2.Parser {
             allowReturnOutsideFunction: true,
             allowSuperOutsideMethod: true,
             allowUndeclaredExports: true,
+            // Documented but not supported. FIXME! Maybe only missing in types.
+            // errorRecovery: true,
             sourceFilename: filename,
             plugins: [
                 'typescript',
@@ -25,4 +27,3 @@ class TypeScriptParser extends parser_2.Parser {
     }
 }
 exports.TypeScriptParser = TypeScriptParser;
-//# sourceMappingURL=typescript.js.map

package/dist/pot/catalog.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Catalog = void 0;
 const entry_1 = require("./entry");
+/**
+ * An entire message catalog that is subsequently filled.
+ */
 class Catalog {
     constructor(properties = {}) {
         this.properties = properties;
@@ -26,6 +29,7 @@ class Catalog {
         }
         if (typeof properties.date === 'undefined') {
             const now = new Date();
+            // Avoid if/else, so we do not spoil our test coverage. :)
             let year = now.getFullYear().toString();
             year = '0'.repeat(4 - year.length) + year;
             let month = (1 + now.getMonth()).toString();
@@ -36,6 +40,7 @@ class Catalog {
             hour = '0'.repeat(2 - hour.length) + hour;
             let minutes = now.getMinutes().toString();
             minutes = '0'.repeat(2 - minutes.length) + minutes;
+            // Do not depend on the timezone for test coverage.
             let offset = now.getTimezoneOffset();
             const sign = ['+', '-'][Math.sign(offset) + 1];
             offset = Math.abs(offset);
@@ -85,6 +90,17 @@ FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
         });
         this.addEntry(headerEntry);
     }
+    /**
+     * Render the entire catalog.
+     *
+     * @param renderOptions - options for rendering
+     *
+     * The following options are supported:
+     *
+     * width: wrap lines to that page width (default: 76)
+     *
+     * @returns the catalog rendered as a po(t) file
+     */
     toString(options = {}) {
         const width = options && typeof options.width !== 'undefined' ? options.width : 76;
         const isNotHeader = (entry) => {
@@ -111,6 +127,9 @@ FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
                 }
                 const actx = a.properties.msgctxt;
                 const bctx = b.properties.msgctxt;
+                // It is impossible that both msgctxts are undefined
+                // because that would mean that the msgids are identical
+                // which is prevented.
                 if (typeof bctx === 'undefined') {
                     return +1;
                 }
@@ -130,6 +149,7 @@ FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
                 const filename = parts.join(':');
                 return { filename, lineno };
             };
+            // First order all references
             copy.entries.forEach(entry => {
                 if (entry.properties.references) {
                     entry.properties.references = entry.properties.references
@@ -183,6 +203,13 @@ FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
             return header || body || '';
         }
     }
+    /**
+     * Add an entry to the catalog. If an entry with the same msgid
+     * and msgctxt already exists, the entry is merged into
+     * the existing one instead.
+     *
+     * @param entry - the `POTEntry` to add
+     */
     addEntry(entry) {
         const msgid = entry.properties.msgid;
         const msgctxt = entry.properties.msgctxt;
@@ -208,11 +235,20 @@ FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
         delete this.cache[msgid][msgctxt];
         this.entries = this.entries.filter(other => other !== entry);
     }
+    /**
+     * Copy a catalog with other options. This is for testing only.
+     *
+     * @returns a deep copy of the catalog.
+     */
     copy(properties) {
         const other = new Catalog(properties);
         this.entries.forEach(entry => other.addEntry(entry));
         return other;
     }
+    /**
+     * Removes all translations from a catalog, so that it can be used as
+     * a .pot file.
+     */
     makePOT() {
         this.entries.forEach(entry => {
             if (!(entry.properties.msgid === '' &&
@@ -223,4 +259,3 @@ FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
     }
 }
 exports.Catalog = Catalog;
-//# sourceMappingURL=catalog.js.map