@esgettext/tools 1.1.0 → 1.3.0

package/dist/commands/xgettext.js

@@ -33,9 +33,14 @@ 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 optspec_1 = require("../optspec");
 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,21 +54,22 @@ 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;
         return {
             'files-from': {
+                multi: true,
                 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: {
+                multi: true,
                 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': {
@@ -84,7 +90,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:'),
@@ -107,18 +113,18 @@ class XGettext {
                 describe: gtx._('join messages with existing file'),
             },
             'exclude-file': {
+                multi: true,
                 group: gtx._('Operation mode:'),
                 alias: 'x',
                 type: 'string',
                 describe: gtx._('entries from FILE.po are not extracted'),
-                array: true,
             },
             'add-comments': {
+                multi: true,
                 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:'),
@@ -132,22 +138,22 @@ class XGettext {
                 describe: gtx._('extract all strings'),
             },
             keyword: {
+                multi: true,
                 group: gtx._('Language specific options:'),
                 type: 'string',
                 describe: gtx._('look for WORD as an additional keyword'),
-                array: true,
             },
             flag: {
+                multi: true,
                 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: {
+                multi: true,
                 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:'),
@@ -188,7 +194,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 +205,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,7 +238,13 @@ class XGettext {
             },
         };
     }
-    additional(_) { }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    additional(argv) {
+        argv.positional(gtx._('INPUTFILE'), {
+            type: 'string',
+            describe: gtx._('input files'),
+        });
+    }
     init(argv) {
         var _a, _b, _c, _d, _e;
         const options = argv;
@@ -312,12 +324,14 @@ class XGettext {
         }
         let fileCollector;
         try {
-            fileCollector = new files_collector_1.FilesCollector(this.options.filesFrom, this.options._);
+            fileCollector = new files_collector_1.FilesCollector(this.options.filesFrom, this.options[gtx._('INPUTFILE')]);
         }
         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)) {
@@ -347,8 +361,11 @@ class XGettext {
         return exitCode;
     }
     run(argv) {
-        this.init(argv);
         return new Promise(resolve => {
+            if (!(0, optspec_1.coerceOptions)(argv, this.args())) {
+                return resolve(1);
+            }
+            this.init(argv);
             try {
                 resolve(this.doRun());
             }
@@ -374,6 +391,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 +406,7 @@ class XGettext {
                 return (0, fs_1.readFileSync)(fullName);
             }
             catch (e) {
+                /* ignore */
             }
         }
         return (0, fs_1.readFileSync)(resolve(directories[directories.length - 1], filename));
@@ -402,6 +421,8 @@ class XGettext {
                 break;
             case '.js':
             case '.jsx':
+            case '.mjs':
+            case '.cjs':
                 parser = new javascript_1.JavaScriptParser(this.catalog, parserOptions);
                 break;
             case '.po':
@@ -522,4 +543,3 @@ class XGettext {
     }
 }
 exports.XGettext = XGettext;
-//# sourceMappingURL=xgettext.js.map

package/dist/configuration.js

@@ -22,9 +22,23 @@ 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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationFactory = exports.ConfigurationSchema = void 0;
 const runtime_1 = require("@esgettext/runtime");
+const package_json_1 = __importDefault(require("@npmcli/package-json"));
+const normalize_package_data_1 = __importDefault(require("normalize-package-data"));
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const v = __importStar(require("valibot"));
@@ -37,10 +51,10 @@ const bugsAddressSchema = v.union([
 ]);
 const programSchema = (program) => {
     return v.strictObject({
-        path: v.pipe(v.string(), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
+        path: v.optional(v.pipe(v.string(), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
             field: `programs.${program}.path`,
-        }))),
-        options: v.array(v.pipe(v.string(), v.regex(new RegExp('^(?:[A-Z]|[-a-z]{2,})')), v.nonEmpty())),
+        })))),
+        options: v.optional(v.array(v.pipe(v.string(), v.regex(new RegExp('^(?:[A-Z]|[-a-z]{2,})')), v.nonEmpty()))),
     });
 };
 exports.ConfigurationSchema = v.strictObject({
@@ -66,11 +80,18 @@ exports.ConfigurationSchema = v.strictObject({
         })), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
             field: 'package.copyright-holder',
         })))),
+        'files-from': v.optional(v.pipe(v.string(gtx._x("The field '{field}' must be a string!", {
+            field: 'package.files-from',
+        })), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
+            field: 'package.files-from',
+        })))),
     })),
     po: v.optional(v.strictObject({
-        directory: v.optional(v.string(gtx._x("The field '{field}' must be a string!", {
+        directory: v.optional(v.pipe(v.string(gtx._x("The field '{field}' must be a string!", {
             field: 'po.directory',
-        }))),
+        })), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
+            field: 'po.directory',
+        })))),
         locales: v.optional(v.array(v.pipe(v.string(gtx._("The entries in 'po.locales' must be strings!")), v.nonEmpty(gtx._("The entries in 'po.locales' must not be empty!"))))),
     })),
     install: v.optional(v.strictObject({
@@ -80,67 +101,62 @@ exports.ConfigurationSchema = v.strictObject({
         msgmerge: v.optional(programSchema('msgmerge')),
         msgfmt: v.optional(programSchema('msgfmt')),
     })),
-    files: v.array(v.string()),
+    files: v.optional(v.array(v.string())),
 });
 class ConfigurationFactory {
     constructor() { }
-    static async create(lang) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
-        if (ConfigurationFactory.instance) {
-            return ConfigurationFactory.instance;
-        }
-        if (lang && !lang.match(/^zh-/)) {
-            lang = lang.replace(/-.*/, '');
-        }
-        const jsConfigFiles = [
-            'esgettext.config.mjs',
-            'esgettext.config.cjs',
-            'esgettext.config.js',
-            'esgettext.config.json',
-        ];
-        let jsConfigFilePath;
-        let msgidBugsAddressFilePath;
-        let nameFilePath;
-        let copyrightHolderFilePath;
-        let versionFilePath;
-        const rootPath = process.cwd();
-        let configuration = null;
-        for (const file of jsConfigFiles) {
-            const filePath = path.join(rootPath, file);
-            if (fs.existsSync(filePath)) {
-                const data = await this.loadFile(filePath);
-                if (data) {
-                    configuration = data;
-                    configuration.files = [file];
-                    jsConfigFilePath = file;
-                    if ((_a = configuration.package) === null || _a === void 0 ? void 0 : _a['msgid-bugs-address']) {
-                        msgidBugsAddressFilePath = filePath;
-                    }
-                    if ((_b = configuration.package) === null || _b === void 0 ? void 0 : _b.name) {
-                        nameFilePath = filePath;
-                    }
-                    if ((_c = configuration.package) === null || _c === void 0 ? void 0 : _c['copyright-holder']) {
-                        copyrightHolderFilePath = filePath;
+    static create(jsConfigFiles, pkgJsonFile, lang) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+            if (ConfigurationFactory.instance) {
+                return ConfigurationFactory.instance;
+            }
+            if (lang && !lang.match(/^zh-/)) {
+                lang = lang.replace(/-.*/, '');
+            }
+            let jsConfigFile;
+            let msgidBugsAddressFile;
+            let nameFile;
+            let copyrightHolderFile;
+            let versionFile;
+            const rootPath = process.cwd();
+            let configuration = null;
+            for (const file of jsConfigFiles) {
+                const filePath = path.join(rootPath, file);
+                if (fs.existsSync(filePath)) {
+                    const data = yield this.loadFile(filePath);
+                    if (data) {
+                        configuration = data;
+                        configuration.files = [file];
+                        jsConfigFile = file;
+                        if ((_a = configuration.package) === null || _a === void 0 ? void 0 : _a['msgid-bugs-address']) {
+                            msgidBugsAddressFile = filePath;
+                        }
+                        if ((_b = configuration.package) === null || _b === void 0 ? void 0 : _b.name) {
+                            nameFile = filePath;
+                        }
+                        if ((_c = configuration.package) === null || _c === void 0 ? void 0 : _c['copyright-holder']) {
+                            copyrightHolderFile = filePath;
+                        }
+                        if ((_d = configuration.package) === null || _d === void 0 ? void 0 : _d.version) {
+                            versionFile = filePath;
+                        }
+                        break;
                     }
-                    if ((_d = configuration.package) === null || _d === void 0 ? void 0 : _d.version) {
-                        versionFilePath = filePath;
+                    else {
+                        return null;
                     }
-                    break;
-                }
-                else {
-                    return null;
                 }
             }
-        }
-        if (!configuration ||
-            !configuration.package ||
-            !configuration.package['msgid-bugs-address'] ||
-            !configuration.package['name'] ||
-            !configuration.package['copyright-holder'] ||
-            !configuration.package['version']) {
-            const packageJsonPath = path.join(rootPath, 'package.json');
-            if (fs.existsSync(packageJsonPath)) {
-                const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+            // Fallback to `package.json` configuration.  We also try to read
+            // msgid-bugs-address from package.json if not set.
+            if (!configuration ||
+                !configuration.package ||
+                !configuration.package['msgid-bugs-address'] ||
+                !configuration.package['name'] ||
+                !configuration.package['copyright-holder'] ||
+                !configuration.package['version']) {
+                const packageJson = yield ConfigurationFactory.getPackageJson();
                 let fileUsed = false;
                 if (!configuration && packageJson.esgettext) {
                     configuration = packageJson.esgettext;
@@ -150,52 +166,78 @@ class ConfigurationFactory {
                 if (!configuration)
                     configuration = { files: [] };
                 if (!((_e = configuration.package) === null || _e === void 0 ? void 0 : _e['msgid-bugs-address'])) {
-                    if ((_f = packageJson.bugs) === null || _f === void 0 ? void 0 : _f.email) {
+                    if ((_f = packageJson.bugs) === null || _f === void 0 ? void 0 : _f.url) {
                         (_g = configuration.package) !== null && _g !== void 0 ? _g : (configuration.package = {});
-                        configuration.package['msgid-bugs-address'] =
-                            packageJson.bugs.email;
-                        msgidBugsAddressFilePath = 'package.json';
+                        configuration.package['msgid-bugs-address'] = packageJson.bugs.url;
+                        msgidBugsAddressFile = 'package.json: bugs.url';
                         fileUsed = true;
                     }
-                    else if ((_h = packageJson.bugs) === null || _h === void 0 ? void 0 : _h.url) {
+                    else if ((_h = packageJson.bugs) === null || _h === void 0 ? void 0 : _h.email) {
                         (_j = configuration.package) !== null && _j !== void 0 ? _j : (configuration.package = {});
-                        configuration.package['msgid-bugs-address'] = packageJson.bugs.url;
-                        msgidBugsAddressFilePath = 'package.json';
+                        configuration.package['msgid-bugs-address'] = packageJson.bugs.email;
+                        msgidBugsAddressFile = 'package.json: bugs.email';
+                        fileUsed = true;
+                    }
+                    else if ((_l = (_k = packageJson.people) === null || _k === void 0 ? void 0 : _k.author) === null || _l === void 0 ? void 0 : _l.email) {
+                        (_m = configuration.package) !== null && _m !== void 0 ? _m : (configuration.package = {});
+                        configuration.package['msgid-bugs-address'] =
+                            packageJson.people.author.email;
+                        msgidBugsAddressFile = 'package.json: people.author';
                         fileUsed = true;
                     }
                 }
-                if (!((_k = configuration.package) === null || _k === void 0 ? void 0 : _k.name)) {
+                if (!((_o = configuration.package) === null || _o === void 0 ? void 0 : _o.name)) {
                     if (packageJson.name) {
-                        (_l = configuration.package) !== null && _l !== void 0 ? _l : (configuration.package = {});
+                        (_p = configuration.package) !== null && _p !== void 0 ? _p : (configuration.package = {});
                         configuration.package.name = packageJson.name;
-                        nameFilePath = 'package.json';
+                        nameFile = 'package.json';
                         fileUsed = true;
                     }
                 }
-                if (!((_m = configuration.package) === null || _m === void 0 ? void 0 : _m['copyright-holder'])) {
-                    if ((_o = packageJson.people) === null || _o === void 0 ? void 0 : _o.author) {
-                        (_p = configuration.package) !== null && _p !== void 0 ? _p : (configuration.package = {});
+                if (!((_q = configuration.package) === null || _q === void 0 ? void 0 : _q['copyright-holder'])) {
+                    if ((_r = packageJson.people) === null || _r === void 0 ? void 0 : _r.author) {
+                        (_s = configuration.package) !== null && _s !== void 0 ? _s : (configuration.package = {});
                         configuration.package['copyright-holder'] =
-                            packageJson.people.author;
-                        copyrightHolderFilePath = 'package.json';
+                            packageJson.people.author.name;
+                        if (packageJson.people.author.email) {
+                            configuration.package['copyright-holder'] +=
+                                ` <${packageJson.people.author.email}>`;
+                        }
+                        if (packageJson.people.author.url) {
+                            configuration.package['copyright-holder'] +=
+                                ` <${packageJson.people.author.url}>`;
+                        }
+                        copyrightHolderFile = 'package.json';
                         fileUsed = true;
                     }
                 }
-                if (!((_q = configuration.package) === null || _q === void 0 ? void 0 : _q.version)) {
+                if (!((_t = configuration.package) === null || _t === void 0 ? void 0 : _t.version)) {
                     if (packageJson.version) {
-                        (_r = configuration.package) !== null && _r !== void 0 ? _r : (configuration.package = {});
+                        (_u = configuration.package) !== null && _u !== void 0 ? _u : (configuration.package = {});
                         configuration.package.version = packageJson.version;
-                        nameFilePath = 'package.json';
+                        nameFile = 'package.json';
                         fileUsed = true;
                     }
                 }
                 if (fileUsed) {
-                    configuration.files.push('package.json');
+                    (_v = configuration.files) === null || _v === void 0 ? void 0 : _v.push('package.json');
                 }
             }
-        }
-        if (!configuration)
-            configuration = { files: [] };
+            if (!configuration)
+                configuration = {};
+            if (!this.validate(configuration, {
+                msgidBugsAddressFile: msgidBugsAddressFile,
+                nameFile: nameFile,
+                copyrightHolderFile: copyrightHolderFile,
+                versionFile: versionFile,
+                jsConfigFile: jsConfigFile,
+            }, lang)) {
+                return null;
+            }
+            return configuration;
+        });
+    }
+    static validate(configuration, files, lang) {
         const result = v.safeParse(exports.ConfigurationSchema, configuration, { lang });
         if (!result.success) {
             const issues = result.issues;
@@ -206,56 +248,73 @@ class ConfigurationFactory {
                 let filename;
                 switch (path) {
                     case 'package.msgid-bugs-address':
-                        filename = msgidBugsAddressFilePath;
+                        filename = files.msgidBugsAddressFile;
                         break;
                     case 'name':
-                        filename = nameFilePath;
+                        filename = files.nameFile;
                         break;
                     case 'copyright-holder':
-                        filename = copyrightHolderFilePath;
+                        filename = files.copyrightHolderFile;
                         break;
                     case 'version':
-                        filename = versionFilePath;
+                        filename = files.versionFile;
                         break;
                     default:
-                        filename = jsConfigFilePath;
+                        filename = files.jsConfigFile;
                         break;
                 }
-                console.error('  ' +
-                    gtx._x('{programName}: error: {filename}: {variable}: {message}.', {
-                        variable: path,
-                        programName: 'esgettext',
-                        filename,
-                        message,
-                    }));
+                console.error('\t', gtx._x('{programName}: Error: {filename}: {variable}: {message}.', {
+                    variable: path,
+                    programName: 'esgettext',
+                    filename,
+                    message,
+                }));
             }
-            return null;
+            return false;
         }
-        return configuration;
+        return true;
     }
-    static async loadFile(filePath) {
-        const extension = path.extname(filePath);
-        if (extension === '.mjs' || extension === '.cjs' || extension === '.js') {
-            return Promise.resolve(`${filePath}`).then(s => __importStar(require(s))).then(module => module.default)
-                .catch(error => {
-                console.error(gtx._x('{programName}: {filename}: error reading configuration: {error}', {
-                    programName: package_1.Package.getName(),
-                    filename: path.basename(filePath),
-                    error,
-                }));
-                return null;
-            });
-        }
-        else if (extension === '.json') {
+    static getPackageJson() {
+        return __awaiter(this, void 0, void 0, function* () {
             try {
-                return JSON.parse(fs.readFileSync(filePath, 'utf-8'));
+                const data = yield package_json_1.default.load(process.cwd());
+                (0, normalize_package_data_1.default)(data.content);
+                return data.content;
             }
-            catch (_a) {
-                return null;
+            catch (error) {
+                return {};
             }
-        }
-        return null;
+        });
+    }
+    static loadFile(filePath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const extension = path.extname(filePath);
+            if (extension === '.mjs' || extension === '.cjs' || extension === '.js') {
+                return Promise.resolve(`${filePath}`).then(s => __importStar(require(s))).then(module => module.default)
+                    .catch(error => {
+                    console.error(gtx._x('{programName}: {filename}: error reading configuration: {error}', {
+                        programName: package_1.Package.getName(),
+                        filename: path.basename(filePath),
+                        error,
+                    }));
+                    return null;
+                });
+            }
+            else if (extension === '.json') {
+                try {
+                    return JSON.parse(fs.readFileSync(filePath, 'utf-8'));
+                }
+                catch (_a) {
+                    return null;
+                }
+            }
+            else {
+                throw new Error(gtx._x("{programName}: Error: {filename}: Configuration file name must end in '.mjs', '.cjs', '.js', or '.json'!", {
+                    programName: package_1.Package.getName(),
+                    filename: filePath,
+                }));
+            }
+        });
     }
 }
 exports.ConfigurationFactory = ConfigurationFactory;
-//# sourceMappingURL=configuration.js.map

package/dist/esgettext-package-json.js

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