@gjsify/cli 0.44.0 → 0.45.0

package/lib/commands/gettext.d.ts

@@ -1,10 +1,11 @@
 import type { Command } from '../types/index.js';
-type GettextFormat = 'mo' | 'xml' | 'desktop' | 'json';
+type GettextFormat = 'mo' | 'xml' | 'desktop';
 interface GettextOptions {
     poDir: string;
     outDir: string;
     domain: string;
     format?: GettextFormat;
+    template?: string;
     metainfo?: string;
     filename?: string;
     removeXmlComments?: boolean;

package/lib/commands/gettext.js

@@ -1,7 +1,9 @@
 import { execFile } from 'node:child_process';
-import { mkdir, readFile, readdir, stat, writeFile } from 'node:fs/promises';
+import { mkdir, mkdtemp, readFile, readdir, rm, stat, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
 import { basename, join, resolve } from 'node:path';
 import { promisify } from 'node:util';
+import { mergeCatalogues } from '../utils/msgfmt-merge.js';
 const execFileAsync = promisify(execFile);
 async function listLanguages(poDir) {
     const entries = await readdir(poDir);
@@ -25,40 +27,79 @@ async function fileExists(path) {
         return false;
     }
 }
-async function compileBulkXml(opts) {
+/**
+ * Fold every catalogue into ONE template.
+ *
+ * The chain, and the four measured msgfmt constraints that shape it, live in
+ * `utils/msgfmt-merge.ts` — `gjsify ship` folds the catalogues it stages into the
+ * metadata it generates through the same function, and a second copy of those
+ * constraints here would be the copy that drifts.
+ *
+ * What is local to this command: the output keeps the CALLER's `--filename`,
+ * while every INTERMEDIATE is named after the TEMPLATE. Those have to be two
+ * different names, because msgfmt finds its ITS rules by filename pattern
+ * (constraint 4 over there) and from the second catalogue on the intermediates
+ * ARE templates. Named after `--filename` instead, the command's answer depended
+ * on how many catalogues there were: measured, `--format xml --template
+ * app.metainfo.xml.in --filename out.xml` wrote a translated file for a one-language
+ * `po/` and died on a two-language one with `cannot locate ITS rules for
+ * <tmpdir>/0-out.xml` — naming an internal path over a rule the user could act on.
+ * The template's suffix is what msgfmt validated for call 1, so it is the one
+ * suffix known to work for calls 2..n.
+ */
+async function compileMerged(opts) {
+    const languages = await listLanguages(opts.poDir);
+    if (languages.length === 0) {
+        console.warn(`[gjsify gettext] no .po files found in ${opts.poDir}`);
+        return;
+    }
     const outputFile = join(opts.outDir, opts.filename);
     await ensureDir(opts.outDir);
-    const args = [`--output-file=${outputFile}`, '--xml', `--template=${opts.template}`, '-d', opts.poDir];
-    if (opts.verbose) {
-        console.log(`[gjsify gettext] msgfmt ${args.join(' ')}`);
+    const workDir = await mkdtemp(join(tmpdir(), 'gjsify-gettext-'));
+    try {
+        const merged = await readFile(mergeCatalogues({
+            mode: `--${opts.format}`,
+            template: opts.template,
+            // The TEMPLATE's name, minus the `.in` convention — see the header.
+            // `basename`, so an intermediate stays inside `workDir` rather than
+            // following the directory part of the path the user passed.
+            extension: `-${basename(opts.template).replace(/\.in$/, '')}`,
+            catalogues: languages.map((lang) => ({ locale: lang, po: join(opts.poDir, `${lang}.po`) })),
+            workDir,
+            onCall: opts.verbose ? (args) => console.log(`[gjsify gettext] msgfmt ${args.join(' ')}`) : undefined,
+        }), 'utf-8');
+        await writeFile(outputFile, opts.removeXmlComments && opts.format === 'xml' ? stripXmlComments(merged) : merged);
     }
-    await execFileAsync('msgfmt', args);
-    if (opts.removeXmlComments) {
-        const content = await readFile(outputFile, 'utf-8');
-        await writeFile(outputFile, stripXmlComments(content));
+    finally {
+        await rm(workDir, { recursive: true, force: true });
     }
     if (opts.verbose) {
-        console.log(`[gjsify gettext] wrote ${outputFile}`);
+        console.log(`[gjsify gettext] merged ${languages.length} language(s) into ${outputFile}`);
     }
 }
-async function compilePerLanguage(opts) {
+/**
+ * Compile each `<lang>.po` into `<outDir>/<lang>/LC_MESSAGES/<filename>`.
+ *
+ * `mo` only. The other two formats SUBSTITUTE a template rather than producing a
+ * catalogue, and there is no per-language file for them to write — which is the
+ * defect this signature now makes unrepresentable: the old shared loop passed
+ * `--desktop`/`--xml` with no `--template`, and msgfmt refuses that outright
+ * (`--desktop requires a "--template template" specification`, exit 1). Every
+ * `gjsify gettext --format=desktop` invocation had therefore always failed; the
+ * only e2e coverage passes `--format mo`, so nothing ever ran the other branch.
+ */
+async function compileCatalogues(opts) {
     const languages = await listLanguages(opts.poDir);
     if (languages.length === 0) {
         console.warn(`[gjsify gettext] no .po files found in ${opts.poDir}`);
         return;
     }
     for (const lang of languages) {
-        const poFile = join(opts.poDir, `${lang}.po`);
-        const langDir = opts.format === 'mo' ? join(opts.outDir, lang, 'LC_MESSAGES') : join(opts.outDir, lang);
+        const langDir = join(opts.outDir, lang, 'LC_MESSAGES');
         await ensureDir(langDir);
-        const outputFile = join(langDir, opts.filename);
-        // msgfmt produces the binary .mo format by default — there is no
-        // `--mo` flag (only --xml, --desktop, --properties-output, ...).
-        const args = [`--output-file=${outputFile}`];
-        if (opts.format !== 'mo') {
-            args.push(`--${opts.format}`);
-        }
-        args.push(poFile);
+        // msgfmt produces the binary .mo format by default — there is no `--mo`
+        // flag (only --xml, --desktop, --properties-output, ...).
+        const args = [`--output-file=${join(langDir, opts.filename)}`, join(opts.poDir, `${lang}.po`)];
         if (opts.verbose) {
             console.log(`[gjsify gettext] msgfmt ${args.join(' ')}`);
         }
@@ -68,24 +109,22 @@ async function compilePerLanguage(opts) {
         console.log(`[gjsify gettext] compiled ${languages.length} language(s) into ${opts.outDir}`);
     }
 }
-function defaultFilename(domain, format, metainfoTemplate) {
+function defaultFilename(domain, format, template) {
     switch (format) {
         case 'mo':
             return `${domain}.mo`;
-        case 'json':
-            return `${domain}.json`;
         case 'desktop':
             return `${domain}.desktop`;
         case 'xml': {
             // Mirror the template filename but without the trailing `.in` (convention for
             // pre-processed metainfo templates: `org.foo.Bar.metainfo.xml.in`).
-            if (metainfoTemplate) {
+            if (template) {
                 // `basename`, not a hand-rolled `lastIndexOf('/')`: this is a path the USER
                 // passed, and on win32 it separates with `\`, which the slice read as part
                 // of the name (#1143). `node:path` is the right owner for host tooling —
                 // though it only answers correctly under Node until #1146 makes
                 // `@gjsify/path` select win32 per host.
-                return basename(metainfoTemplate.replace(/\.in$/, ''));
+                return basename(template.replace(/\.in$/, ''));
             }
             return `${domain}.xml`;
         }
@@ -93,7 +132,8 @@ function defaultFilename(domain, format, metainfoTemplate) {
 }
 export const gettextCommand = {
     command: 'gettext <poDir> <outDir>',
-    description: 'Compile gettext .po files to .mo (per-language locale tree) or substitute a metainfo template via msgfmt --xml.',
+    description: 'Compile gettext .po files to .mo (per-language locale tree), or merge every catalogue into a ' +
+        '.desktop / AppStream template via msgfmt --desktop / --xml.',
     builder: (yargs) => {
         return yargs
             .positional('poDir', {
@@ -103,7 +143,7 @@ export const gettextCommand = {
             demandOption: true,
         })
             .positional('outDir', {
-            description: 'Output directory (locale tree for --format=mo, plain dir for xml/desktop/json)',
+            description: 'Output directory (locale tree for --format=mo, plain dir for xml/desktop)',
             type: 'string',
             normalize: true,
             demandOption: true,
@@ -117,13 +157,21 @@ export const gettextCommand = {
             .option('format', {
             description: 'Output format',
             type: 'string',
-            choices: ['mo', 'xml', 'desktop', 'json'],
+            choices: ['mo', 'xml', 'desktop'],
             default: 'mo',
+        })
+            .option('template', {
+            description: 'Required for --format=xml|desktop: the file msgfmt substitutes into. Its SUFFIX matters — ' +
+                'msgfmt --xml finds its ITS rules by filename pattern, so an AppStream template must be ' +
+                'named `*.metainfo.xml[.in]`.',
+            type: 'string',
+            normalize: true,
         })
             .option('metainfo', {
-            description: 'For --format=xml: path to the template (`.metainfo.xml.in`) used as msgfmt --template',
+            description: 'Deprecated alias for --template.',
             type: 'string',
             normalize: true,
+            hidden: true,
         })
             .option('filename', {
             description: 'Override the output filename (defaults to <domain>.<ext>)',
@@ -146,8 +194,12 @@ export const gettextCommand = {
         const outDir = resolve(args.outDir);
         const domain = args.domain;
         const format = args.format ?? 'mo';
-        const metainfo = args.metainfo ? resolve(args.metainfo) : undefined;
-        const filename = args.filename ?? defaultFilename(domain, format, metainfo);
+        // `--metainfo` predates the option being useful for `.desktop` too. Kept as a
+        // hidden alias rather than removed: it is the spelling `cli-reference.md`
+        // documented, so removing it would break the invocation the docs taught.
+        const templateArg = args.template ?? args.metainfo;
+        const template = templateArg ? resolve(templateArg) : undefined;
+        const filename = args.filename ?? defaultFilename(domain, format, template);
         const verbose = !!args.verbose;
         const removeXmlComments = !!args['remove-xml-comments'];
         if (!(await fileExists(poDir))) {
@@ -155,28 +207,34 @@ export const gettextCommand = {
             process.exitCode = 1;
             return;
         }
+        // REFUSED, not worked around. `--xml` and `--desktop` substitute into a
+        // template, and msgfmt rejects both without one (`--desktop requires a
+        // "--template template" specification`, exit 1). The old code fell back to a
+        // per-language loop that passed no template at all, so the fallback could only
+        // ever reproduce that same error one layer further down — with the user's
+        // `--format` reported as the thing that failed rather than the missing template.
+        if (format !== 'mo' && template === undefined) {
+            console.error(`[gjsify gettext] --format=${format} needs a template to substitute into: pass ` +
+                '`--template <file>`. msgfmt has no way to produce this format from .po files alone.' +
+                (format === 'xml'
+                    ? ' Name it `*.metainfo.xml[.in]` — msgfmt --xml finds its ITS rules by filename pattern.'
+                    : ''));
+            process.exitCode = 1;
+            return;
+        }
         try {
-            if (format === 'xml' && metainfo) {
-                await compileBulkXml({
-                    poDir,
-                    outDir,
-                    domain,
-                    template: metainfo,
-                    filename,
-                    removeXmlComments,
-                    verbose,
-                });
+            if (format === 'mo') {
+                await compileCatalogues({ poDir, outDir, filename, verbose });
             }
             else {
-                if (format === 'xml') {
-                    console.warn('[gjsify gettext] --format=xml without --metainfo: falling back to per-language XML files');
-                }
-                await compilePerLanguage({
+                await compileMerged({
                     poDir,
                     outDir,
-                    domain,
                     format,
+                    // Narrowed by the refusal above.
+                    template: template,
                     filename,
+                    removeXmlComments,
                     verbose,
                 });
             }

package/lib/commands/onboard.d.ts

@@ -6,6 +6,13 @@ interface OnboardOptions {
     registry?: string;
     otp?: string;
     concurrency: number;
+    'write-concurrency': number;
+    packages?: string[];
+    include?: string[];
+    exclude?: string[];
+    access: string;
+    build: boolean;
+    verbose?: boolean;
     'dry-run'?: boolean;
     json?: boolean;
     yes?: boolean;