@esgettext/tools 1.3.1 → 1.3.2

package/README.md

@@ -2,9 +2,10 @@
 
 Supporting tools for https://github.com/gflohr/esgettext.
 
+The package also contains code for parsing po files and for writing them.
+
 ## Table of Contents <!-- omit in toc -->
 
-- [Status](#status)
 - [Prerequisites](#prerequisites)
 	- [Un\*x/Linux](#unxlinux)
 	- [Mac OS X](#mac-os-x)
@@ -39,10 +40,6 @@ Supporting tools for https://github.com/gflohr/esgettext.
 				- [`programs.msgfmt.options`](#programsmsgfmtoptions)
 - [Copyright](#copyright)
 
-## Status
-
-in development.
-
 ## Prerequisites
 
 Most of the esgettext tools depend at least indirectly on the GNU gettext

package/dist/commands/init.js

@@ -257,7 +257,7 @@ class Init {
             }
             const dependencies = Object.assign(Object.assign({}, pkg.content.dependencies), { '@esgettext/runtime': `^${package_1.Package.getVersion()}` });
             if (this.options.verbose) {
-                console.log(gtx._x("Adding package '{package}' version {version} as a development dependencyy.", { package: '@esgettext/tools', version: `^${package_1.Package.getVersion()}` }));
+                console.log(gtx._x("Adding package '{package}' version {version} as a development dependency.", { package: '@esgettext/tools', version: `^${package_1.Package.getVersion()}` }));
             }
             const devDependencies = Object.assign(Object.assign({}, pkg.content.devDependencies), { '@esgettext/tools': `^${package_1.Package.getVersion()}` });
             if (!((_a = pkg.content.devDependencies) === null || _a === void 0 ? void 0 : _a['npm-run-all']) &&
@@ -312,8 +312,11 @@ class Init {
             command: 'npm run esgettext:update-po',
             filename: `${setup.poDirectory}/${setup.textdomain}.pot`,
         }));
-        console.log(gtx._x("3) Create a translation file with '{command}' (replace 'xy' with a language code like 'de' or 'pt_BR').", {
+        console.log(gtx._x("3) Create a translation file with '{command}' (replace" +
+            " 'xy' with a language code like 'de' or 'pt_BR'). Get" +
+            " more information with '{command2}'", {
             command: `msginit -l xy -i ${setup.poDirectory}/${setup.textdomain}.pot -o po/xy.po`,
+            command2: 'npm run esgettext:add-language',
         }));
         console.log(gtx._x('4) Translate the message with a PO editor of your choice.', {
             command: `msginit -l xy -i ${setup.poDirectory}/${setup.textdomain}.pot -o po/xy.po`,
@@ -390,7 +393,7 @@ class Init {
             const parts = candidate.split('/');
             if (!hasTestDir && parts[0].match(/^tests?$/)) {
                 if (this.options.verbose) {
-                    console.log(gtx._x('Looks like you have test files under {directory}. We will not translate them.'));
+                    console.log(gtx._x("Looks like you have test files under '{directory}'. We will not translate them.", { directory: parts[0] }));
                 }
                 exclude.push(`${parts[0]}/*/**`);
                 hasTestDir = true;
@@ -429,8 +432,8 @@ class Init {
             options.push(`--exclude="${pattern}"`);
         }
         if (!topLevelDirectories.length) {
-            this.error(gtx._x("Warning! Could not find any source files.  Will use the pattern './src/**/*.{js,jsx,ts,tsx}."));
-            options.push('"./src/**/*.{js,jsx,ts,tsx}"');
+            this.error(gtx._x("Warning! Could not find any source files.  Will use the pattern '{pattern}'.", { pattern: './src/**/*.{js,cjs,mjs,jsx,ts,tsx}' }));
+            options.push('"./src/**/*.{js,cjs,mjs,jsx,ts,tsx}"');
         }
         else {
             for (const tld in extenders) {
@@ -447,7 +450,7 @@ class Init {
             }
         }
         if (this.options.verbose) {
-            console.log(gtx._x('Command-line options for extracting source files are: {options}', { options: options.join(' ') }));
+            console.log(gtx._x('Command-line options for extracting strings from source files are: {options}', { options: options.join(' ') }));
         }
         return options;
     }
@@ -505,7 +508,7 @@ class Init {
                 return resolve(true);
             }
             catch (error) {
-                return resolve(gtx._x('The command {command} did not work.' + ' Error: {error}.', {
+                return resolve(gtx._x("The command '{command}' did not work.  Error: {error}.", {
                     command,
                     error,
                 }));
@@ -550,7 +553,7 @@ class Init {
     nonEmpty(answer) {
         return new Promise(resolve => {
             if (answer.trim().length === 0) {
-                resolve(gtx._('Please enter a string with at least one character!'));
+                resolve(gtx._('Please enter at least one character!'));
             }
             else {
                 resolve(true);
@@ -584,7 +587,7 @@ class Init {
         return new Promise(resolve => {
             const directory = answer.trim();
             if (directory.length === 0) {
-                return resolve(gtx._('Please enter a string with at least one character!'));
+                return resolve(gtx._('Please enter at least one character!'));
             }
             if (!this.options.force) {
                 if (fs.existsSync(directory)) {
@@ -674,7 +677,9 @@ class Init {
                     validate: answer => this.checkTool(answer),
                 }),
                 msgfmtOptions: yield (0, prompts_1.input)({
-                    message: gtx._x("Options to invoke '{tool}' with", { tool: 'msgfmt' }),
+                    message: gtx._x("(Boolean) options to invoke '{tool}' with", {
+                        tool: 'msgfmt',
+                    }),
                     default: '--check --statistics --verbose',
                 }),
                 poDirectory: yield (0, prompts_1.input)({

package/dist/commands/install.js

@@ -36,7 +36,7 @@ class Install {
         this.configuration = configuration;
     }
     synopsis() {
-        return gtx._('[OPTIONS]');
+        return `[${gtx._('OPTIONS')}]`;
     }
     description() {
         return gtx._('Install translation catalogs.');

package/dist/commands/msgfmt-all.js

@@ -79,14 +79,16 @@ class MsgfmtAll {
             },
             msgfmt: {
                 type: 'string',
-                describe: gtx._('msgfmt program if not in PATH [string]'),
+                describe: gtx._x("'{program}' program if not in $PATH", {
+                    program: 'msgfmt',
+                }),
                 default: (_f = (_e = (_d = this.configuration.programs) === null || _d === void 0 ? void 0 : _d.msgfmt) === null || _e === void 0 ? void 0 : _e.path) !== null && _f !== void 0 ? _f : 'msgfmt',
                 group: gtx._('Mode of operation:'),
             },
             options: {
                 multi: true,
                 type: 'string',
-                describe: gtx._x("Options to pass to '{program}' program (without hyphens)", { program: 'msgfmt' }),
+                describe: gtx._x("Options to pass to '{program}' program (without leading hyphens)", { program: 'msgfmt' }),
                 default: ((_h = (_g = this.configuration.programs) === null || _g === void 0 ? void 0 : _g.msgfmt) === null || _h === void 0 ? void 0 : _h.options) || [
                     'check',
                     'statistics',
@@ -151,7 +153,7 @@ class MsgfmtAll {
         if (options) {
             options.forEach(name => {
                 if (name.substring(0, 1) === '-') {
-                    console.error(gtx._x("{programName}: option '{option}': Options passed to '{program}' must not start with a hyphen", {
+                    console.error(gtx._x("{programName}: option '{option}': Options passed to '{program}' must be given without leading hyphens", {
                         programName: package_1.Package.getName(),
                         program: 'msgfmt',
                         option: name,

package/dist/commands/msgmerge-all.js

@@ -89,14 +89,16 @@ class MsgmergeAll {
             },
             msgmerge: {
                 type: 'string',
-                describe: gtx._('msgmerge program if not in PATH [string]'),
+                describe: gtx._x("'{program}' program if not in $PATH", {
+                    program: 'msgmerge',
+                }),
                 default: (_f = (_e = (_d = this.configuration.programs) === null || _d === void 0 ? void 0 : _d.msgmerge) === null || _e === void 0 ? void 0 : _e.path) !== null && _f !== void 0 ? _f : 'msgmerge',
                 group: gtx._('Mode of operation:'),
             },
             options: {
                 multi: true,
                 type: 'string',
-                describe: gtx._x("Options to pass to '{program}' program (without hyphens)", { program: 'msgmerge' }),
+                describe: gtx._x("Options to pass to '{program}' program (without leading hyphens)", { program: 'msgmerge' }),
                 default: (_h = (_g = this.configuration.programs) === null || _g === void 0 ? void 0 : _g.msgmerge) === null || _h === void 0 ? void 0 : _h.options,
                 group: gtx._('Mode of operation:'),
             },
@@ -163,7 +165,7 @@ class MsgmergeAll {
         if (options) {
             options.forEach(name => {
                 if (name.substring(0, 1) === '-') {
-                    console.error(gtx._x("{programName}: option '{option}': Options passed to '{program}' must not start with a hyphen", {
+                    console.error(gtx._x("{programName}: option '{option}': Options passed to '{program}' must be given without leading hyphens", {
                         programName: package_1.Package.getName(),
                         program: 'msgfmt',
                         option: name,

package/dist/commands/xgettext.js

@@ -89,7 +89,7 @@ class XGettext {
                 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.'),
+                describe: gtx._('output files will be placed in the specified directory. 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: {
@@ -107,27 +107,27 @@ class XGettext {
                 default: 'ASCII',
             },
             'join-existing': {
-                group: gtx._('Operation mode:'),
+                group: gtx._('Mode of operation:'),
                 alias: 'j',
                 type: 'boolean',
                 describe: gtx._('join messages with existing file'),
             },
             'exclude-file': {
                 multi: true,
-                group: gtx._('Operation mode:'),
+                group: gtx._('Mode of operation:'),
                 alias: 'x',
                 type: 'string',
-                describe: gtx._('entries from FILE.po are not extracted'),
+                describe: gtx._('entries from this po file are not extracted'),
             },
             'add-comments': {
                 multi: true,
-                group: gtx._('Operation mode:'),
+                group: gtx._('Mode of operation:'),
                 alias: 'c',
                 type: 'string',
-                describe: gtx._('place comment blocks starting with TAG and preceding keyword lines in output file'),
+                describe: gtx._('place comment blocks starting with this string and preceding keyword lines in output file'),
             },
             'add-all-comments': {
-                group: gtx._('Operation mode:'),
+                group: gtx._('Mode of operation:'),
                 describe: gtx._('place all comment blocks preceding keyword lines in output file'),
                 type: 'boolean',
             },
@@ -141,7 +141,7 @@ class XGettext {
                 multi: true,
                 group: gtx._('Language specific options:'),
                 type: 'string',
-                describe: gtx._('look for WORD as an additional keyword'),
+                describe: gtx._('look for this word as an additional keyword'),
             },
             flag: {
                 multi: true,
@@ -153,7 +153,7 @@ class XGettext {
                 multi: true,
                 group: gtx._('Language specific options:'),
                 type: 'string',
-                describe: gtx._('only accept method calls of specified instance names'),
+                describe: gtx._('only search for method calls of specified instance names'),
             },
             'force-po': {
                 group: gtx._('Output details:'),
@@ -177,7 +177,7 @@ class XGettext {
                 group: gtx._('Output details:'),
                 alias: 's',
                 type: 'boolean',
-                describe: gtx._('generate sorted output'),
+                describe: gtx._('generate sorted output (deprecated)'),
             },
             'sort-by-file': {
                 group: gtx._('Output details:'),
@@ -223,13 +223,13 @@ class XGettext {
                 group: gtx._('Output details:'),
                 alias: 'm',
                 type: 'string',
-                describe: gtx._('use STRING or "" as prefix for msgstr values'),
+                describe: gtx._('use this 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'),
+                describe: gtx._('use this string or "" as suffix for msgstr values'),
             },
             verbose: {
                 alias: 'V',
@@ -303,7 +303,7 @@ class XGettext {
         }
         if (this.options.joinExisting) {
             if (this.options.output === '-') {
-                console.error(gtx._x('{programName}: Error: --join-existing' +
+                console.error(gtx._x("{programName}: Error: '--join-existing'" +
                     ' cannot be used, when output is written to stdout', {
                     programName: this.options.$0,
                 }));
@@ -432,16 +432,16 @@ class XGettext {
             default:
                 if ('-' === filename) {
                     this.warn(gtx._('language for standard input is unknown without' +
-                        ' option "--language"; will try JavaScript'));
+                        ' option "--language"; will try TypeScript'));
                 }
                 else {
                     this.warn(gtx._x('file "{filename}" extension "{extname}"' +
-                        ' is unknown; will try JavaScript instead', {
+                        ' is unknown; will try TypeScript instead', {
                         filename,
                         extname: ext,
                     }));
                 }
-                parser = new javascript_1.JavaScriptParser(this.catalog, parserOptions);
+                parser = new typescript_1.TypeScriptParser(this.catalog, parserOptions);
                 break;
         }
         return parser;

package/dist/configuration.js

@@ -46,8 +46,16 @@ require("@valibot/i18n/de");
 const package_1 = require("./package");
 const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
 const bugsAddressSchema = v.union([
-    v.pipe(v.string(), v.nonEmpty(gtx._("The field 'package.msgid-bugs-address' must not be empty!")), v.email(gtx._("The field 'package.msgid-bugs-address' must contain a valid email address or URL!"))),
-    v.pipe(v.string(), v.nonEmpty(gtx._("The field 'package.msgid-bugs-address' must not be empty!")), v.url(gtx._("The field 'package.msgid-bugs-address' must contain a valid email address or URL!"))),
+    v.pipe(v.string(), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
+        field: 'msgid-bugs-address',
+    })), v.email(gtx._x("The field '{field}' must contain a valid email address or URL!", {
+        field: 'msgid-bugs-address',
+    }))),
+    v.pipe(v.string(), v.nonEmpty(gtx._x("The field '{field}' must not be empty!", {
+        field: 'msgid-bugs-address',
+    })), v.url(gtx._x("The field '{field}' must contain a valid email address or URL!", {
+        field: 'msgid-bugs-address',
+    }))),
 ]);
 const programSchema = (program) => {
     return v.strictObject({

package/dist/index.js

@@ -1,5 +1,28 @@
 #! /usr/bin/env node
 "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;
+};
 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) {
@@ -14,6 +37,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const yargs_1 = __importDefault(require("yargs"));
+const path = __importStar(require("path"));
 const package_js_1 = require("./package.js");
 const runtime_1 = require("@esgettext/runtime");
 const configuration_js_1 = require("./configuration.js");
@@ -38,13 +62,21 @@ const commandNames = [
 const configFiles = locateConfigFiles();
 const pkgJsonFile = locatePkgJsonFile();
 const gtx = runtime_1.Textdomain.getInstance('com.cantanea.esgettext-tools');
+runtime_1.Textdomain.locale = runtime_1.Textdomain.selectLocale([
+    'en-AU',
+    'en-US',
+    'en-GB',
+    'en-NZ',
+    'de',
+]);
+const localePath = path.join(__dirname, 'locale');
+gtx.bindtextdomain(localePath);
 gtx
     .resolve()
     .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 = yield configuration_js_1.ConfigurationFactory.create(configFiles, pkgJsonFile, locale);
+    const ulocale = runtime_1.Textdomain.locale.replace('-', '_');
+    const configuration = yield configuration_js_1.ConfigurationFactory.create(configFiles, pkgJsonFile, runtime_1.Textdomain.locale);
     if (!configuration)
         process.exit(1);
     const commands = {
@@ -74,7 +106,7 @@ gtx
             default: 'package.json',
         },
     })
-        .showHelpOnFail(false, gtx._x("Try {programName} '--help' for more information!", {
+        .showHelpOnFail(false, gtx._x("Try '{programName} --help' for more information!", {
         programName: package_js_1.Package.getName(),
     }))
         .demandCommand(1, gtx._('Error: No command given.'))

package/dist/optspec.js

@@ -18,7 +18,7 @@ function coerceOptions(args, optspecs) {
         else {
             if (isArray) {
                 console.error(gtx._x('{programName}: Error: The option' +
-                    ' {optname} cannot be specified more than once!', { programName: package_1.Package.getName(), optname }));
+                    " '{optname}' cannot be specified more than once!", { programName: package_1.Package.getName(), optname }));
                 return false;
             }
         }

package/dist/package.js

@@ -9,7 +9,7 @@ class Package {
         return 'https://github.com/gflohr/esgettext/issues';
     }
     static getVersion() {
-        return '1.3.1';
+        return '1.3.2';
     }
     static getNpmRunAllVersion() {
         return '^4.1.5';

package/dist/pot/entry.js

@@ -21,19 +21,23 @@ class POTEntry {
     constructor(properties) {
         this.properties = properties;
         if (/[\u0000-\u0006\u000e-\u001f]/.exec(properties.msgid)) {
-            throw new Error(gtx._('msgid must not contain control characters.'));
+            throw new Error(gtx._x("Section '{section}' must not contain control characters.", {
+                section: 'msgid',
+            }));
         }
         if (typeof this.properties.msgidPlural !== 'undefined') {
             if (/[\u0000-\u0006\u000e-\u001f]/.exec(properties.msgidPlural)) {
-                throw new Error(gtx._('msgid_plural must not contain control characters.'));
+                throw new Error(gtx._x("Section '{section}' must not contain control characters.", {
+                    section: 'msgid_plural',
+                }));
             }
         }
         if (this.properties.msgid === '' &&
             (typeof this.properties.msgctxt === 'undefined' ||
                 this.properties.msgctxt === '')) {
             this.warning(gtx._('Empty msgid.  It is reserved by esgettext.\n' +
-                "Calling gettext('') returns the header " +
-                'entry with meta information, not the empty ' +
+                "Calling 'gettext()' with an empty msgid returns the " +
+                ' header entry with meta information, not the empty ' +
                 'string.\n' +
                 'Consider adding a message context, if this ' +
                 'is done intentionally.'));

package/package.json

@@ -1,7 +1,12 @@
 {
 	"name": "@esgettext/tools",
-	"version": "1.3.1",
+	"version": "1.3.2",
 	"description": "Gettext-like po creation and manipulation",
+	"keywords": [
+		"gettext",
+		"po parser",
+		"create po"
+	],
 	"publishConfig": {
 		"access": "public"
 	},
@@ -26,7 +31,7 @@
 		"prebuild": "node ./write-package.mjs >src/package.ts",
 		"prepublishOnly": "npm run build",
 		"check:clean": "../../check-clean",
-		"format": "prettier --write 'src/**/*.ts'",
+		"format": "prettier --write 'src/**/*.ts' *.mjs *.json",
 		"watch": "tsc --watch",
 		"prewatch": "node ./write-package.mjs >src/package.ts",
 		"clean": "rimraf ./dist",
@@ -39,7 +44,14 @@
 		"test:watch": "jest --watch",
 		"test:cov": "jest --coverage",
 		"test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-		"typedoc": "echo nothing to do"
+		"typedoc": "echo nothing to do",
+		"esgettext": "npm-run-all esgettext:potfiles esgettext:extract esgettext:update-po esgettext:update-mo esgettext:install",
+		"esgettext:potfiles": "node --import=tsx src/index.ts potfiles --directory=po --git --exclude=\"dist/**/*\" --exclude=\"node_modules/**/*\" --exclude=\"**/*.spec.*\"  \"./src/**/*.ts\" >po/POTFILES",
+		"esgettext:extract": "node --import=tsx src/index.ts extract --directory po --files-from=po/POTFILES --from-code='utf-8'",
+		"esgettext:update-po": "node --import=tsx src/index.ts msgmerge-all",
+		"esgettext:update-mo": "node --import=tsx src/index.ts msgfmt-all",
+		"esgettext:install": "node --import=tsx src/index.ts install",
+		"esgettext:addlang": "node --import=tsx src/index.ts msginit"
 	},
 	"author": "Guido Flohr <guido.flohr@cantanea.com> (http://www.guido.flohr.net/)",
 	"license": "WTFPL",
@@ -70,6 +82,7 @@
 	},
 	"devDependencies": {
 		"@babel/types": "^7.24.7",
+		"@esgettext/tools": "^1.3.1",
 		"@eslint/config-array": "^0.16.0",
 		"@humanwhocodes/retry": "^0.3.0",
 		"@tsconfig/recommended": "^1.0.6",
@@ -91,7 +104,7 @@
 	"dependencies": {
 		"@babel/parser": "^7.24.7",
 		"@babel/traverse": "^7.24.7",
-		"@esgettext/runtime": "^1.3.0",
+		"@esgettext/runtime": "^1.3.2",
 		"@inquirer/prompts": "^5.0.6",
 		"@npmcli/package-json": "^5.2.0",
 		"@valibot/i18n": "^0.15.0",
@@ -101,5 +114,5 @@
 		"valibot": "^0.31.1",
 		"yargs": "^17.7.2"
 	},
-	"gitHead": "cdc3f0b16ceb2692722109bbcc3078d156c3d2ec"
+	"gitHead": "b143ccc6342c751a27ebccfc345f23fa7cd6e318"
 }