@formatjs/cli-lib 8.0.8 → 8.1.1

package/index.d.ts

@@ -1,7 +1,7 @@
-export { default as extractAndWrite, extract } from './src/extract.js';
-export type { ExtractCLIOptions, ExtractOpts } from './src/extract.js';
-export type { MessageDescriptor } from '@formatjs/ts-transformer';
-export type { FormatFn, CompileFn } from './src/formatters/default.js';
-export type { Comparator } from 'json-stable-stringify';
-export { default as compileAndWrite, compile } from './src/compile.js';
-export type { CompileCLIOpts, Opts as CompileOpts } from './src/compile.js';
+export { default as extractAndWrite, extract } from "./src/extract.js";
+export type { ExtractCLIOptions, ExtractOpts } from "./src/extract.js";
+export type { MessageDescriptor } from "@formatjs/ts-transformer";
+export type { FormatFn, CompileFn } from "./src/formatters/default.js";
+export type { Comparator } from "json-stable-stringify";
+export { default as compileAndWrite, compile } from "./src/compile.js";
+export type { CompileCLIOpts, Opts as CompileOpts } from "./src/compile.js";

package/index.js

@@ -1,2 +1,2 @@
-export { default as extractAndWrite, extract } from './src/extract.js';
-export { default as compileAndWrite, compile } from './src/compile.js';
+export { default as extractAndWrite, extract } from "./src/extract.js";
+export { default as compileAndWrite, compile } from "./src/compile.js";

package/main.d.ts

@@ -1,2 +1 @@
-#!/usr/bin/env node
 export {};

package/main.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
-import cli from './src/cli.js';
+import cli from "./src/cli.js";
 cli(process.argv);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formatjs/cli-lib",
   "description": "Lib for CLI for formatjs.",
-  "version": "8.0.8",
+  "version": "8.1.1",
   "license": "MIT",
   "author": "Linjie Ding <linjie@airtable.com>",
   "type": "module",
@@ -13,16 +13,16 @@
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.0.0",
     "chalk": "^4.1.2",
-    "commander": "^13",
+    "commander": "^14.0.0",
     "fast-glob": "^3.3.2",
     "fs-extra": "^11.2.0",
     "json-stable-stringify": "^1.3.0",
     "loud-rejection": "^2",
     "tslib": "^2.8.0",
     "typescript": "^5.6.0",
-    "@formatjs/icu-skeleton-parser": "2.0.6",
-    "@formatjs/icu-messageformat-parser": "3.2.0",
-    "@formatjs/ts-transformer": "4.0.7"
+    "@formatjs/icu-messageformat-parser": "3.3.0",
+    "@formatjs/icu-skeleton-parser": "2.0.8",
+    "@formatjs/ts-transformer": "4.2.0"
   },
   "peerDependencies": {
     "@glimmer/syntax": "^0.95.0",

package/src/cli.js

@@ -1,36 +1,26 @@
-import { program } from 'commander';
-import { sync as globSync } from 'fast-glob';
-import loudRejection from 'loud-rejection';
-import compile from './compile.js';
-import compileFolder from './compile_folder.js';
-import { debug } from './console_utils.js';
-import extract from './extract.js';
-import { verify } from './verify/index.js';
-import { resolve } from 'path';
-import { readFileSync } from 'fs';
-const KNOWN_COMMANDS = ['extract'];
+import { program } from "commander";
+import { sync as globSync } from "fast-glob";
+import loudRejection from "loud-rejection";
+import compile from "./compile.js";
+import compileFolder from "./compile_folder.js";
+import { debug } from "./console_utils.js";
+import extract from "./extract.js";
+import { verify } from "./verify/index.js";
+import { resolve } from "path";
+import { readFileSync } from "fs";
+const KNOWN_COMMANDS = ["extract"];
 async function main(argv) {
-    loudRejection();
-    program
-        // TODO: fix this
-        .version('5.0.6', '-v, --version')
-        .usage('<command> [flags]')
-        .action(command => {
-        if (!KNOWN_COMMANDS.includes(command)) {
-            program.help();
-        }
-    });
-    program
-        .command('help', { isDefault: true })
-        .description('Show this help message.')
-        .action(() => program.help());
-    // Long text wrapping to available terminal columns: https://github.com/tj/commander.js/pull/956
-    // NOTE: please keep the help text in sync with babel-plugin-formatjs documentation.
-    program
-        .command('extract [files...]')
-        .description(`Extract string messages from React components that use react-intl.
-The input language is expected to be TypeScript or ES2017 with JSX.`)
-        .option('--format <path>', `Path to a formatter file that controls the shape of JSON file from \`--out-file\`.
+	loudRejection();
+	program.version("5.0.6", "-v, --version").usage("<command> [flags]").action((command) => {
+		if (!KNOWN_COMMANDS.includes(command)) {
+			program.help();
+		}
+	});
+	program.command("help", { isDefault: true }).description("Show this help message.").action(() => program.help());
+	// Long text wrapping to available terminal columns: https://github.com/tj/commander.js/pull/956
+	// NOTE: please keep the help text in sync with babel-plugin-formatjs documentation.
+	program.command("extract [files...]").description(`Extract string messages from React components that use react-intl.
+The input language is expected to be TypeScript or ES2017 with JSX.`).option("--format <path>", `Path to a formatter file that controls the shape of JSON file from \`--out-file\`.
 The formatter file must export a function called \`format\` with the signature
 \`\`\`
 type FormatFn = <T = Record<string, MessageDescriptor>>(
@@ -38,26 +28,17 @@ type FormatFn = <T = Record<string, MessageDescriptor>>(
 ) => T
 \`\`\` 
 This is especially useful to convert from our extracted format to a TMS-specific format.
-`)
-        .option('--in-file <path>', `The file containing list of files to extract from, separated by newlines. This is mainly
-      to deal with the case where you have a large number of files to extract from and bash chokes.`)
-        .option('--out-file <path>', `The target file path where the plugin will output an aggregated 
-\`.json\` file of all the translations from the \`files\` supplied.`)
-        .option('--id-interpolation-pattern <pattern>', `If certain message descriptors don't have id, this \`pattern\` will be used to automatically
+`).option("--in-file <path>", `The file containing list of files to extract from, separated by newlines. This is mainly
+      to deal with the case where you have a large number of files to extract from and bash chokes.`).option("--out-file <path>", `The target file path where the plugin will output an aggregated 
+\`.json\` file of all the translations from the \`files\` supplied.`).option("--id-interpolation-pattern <pattern>", `If certain message descriptors don't have id, this \`pattern\` will be used to automatically
 generate IDs for them. Default to \`[sha512:contenthash:base64:6]\` where \`contenthash\` is the hash of
 \`defaultMessage\` and \`description\`.
-See https://github.com/webpack/loader-utils#interpolatename for sample patterns`, '[sha512:contenthash:base64:6]')
-        .option('--extract-source-location', `Whether the metadata about the location of the message in the source file should be 
+See https://github.com/webpack/loader-utils#interpolatename for sample patterns`, "[sha512:contenthash:base64:6]").option("--extract-source-location", `Whether the metadata about the location of the message in the source file should be 
 extracted. If \`true\`, then \`file\`, \`start\`, and \`end\` fields will exist for each 
-extracted message descriptors.`, false)
-        .option('--additional-component-names <comma-separated-names>', `Additional component names to extract messages from, e.g: \`'FormattedFooBarMessage'\`. 
+extracted message descriptors.`, false).option("--additional-component-names <comma-separated-names>", `Additional component names to extract messages from, e.g: \`'FormattedFooBarMessage'\`. 
 **NOTE**: By default we check for the fact that \`FormattedMessage\` 
 is imported from \`moduleSourceName\` to make sure variable alias 
-works. This option does not do that so it's less safe.`, (val) => val.split(','))
-        .option('--additional-function-names <comma-separated-names>', `Additional function names to extract messages from, e.g: \`'$t'\`.`, (val) => val.split(','))
-        .option('--ignore <files...>', 'List of glob paths to **not** extract translations from.')
-        .option('--throws', 'Whether to throw an exception when we fail to process any file in the batch.')
-        .option('--pragma <pragma>', `parse specific additional custom pragma. This allows you to tag certain file with metadata such as \`project\`. For example with this file:
+works. This option does not do that so it's less safe.`, (val) => val.split(",")).option("--additional-function-names <comma-separated-names>", `Additional function names to extract messages from, e.g: \`'$t'\`.`, (val) => val.split(",")).option("--ignore <files...>", "List of glob paths to **not** extract translations from.").option("--throws", "Whether to throw an exception when we fail to process any file in the batch.").option("--pragma <pragma>", `parse specific additional custom pragma. This allows you to tag certain file with metadata such as \`project\`. For example with this file:
 
       \`\`\`
       // @intl-meta project:my-custom-project
@@ -66,127 +47,92 @@ works. This option does not do that so it's less safe.`, (val) => val.split(',')
       <FormattedMessage defaultMessage="foo" id="bar" />;
       \`\`\`
 
-      and with option \`{pragma: "intl-meta"}\`, we'll parse out \`// @intl-meta project:my-custom-project\` into \`{project: 'my-custom-project'}\` in the result file.`)
-        .option('--preserve-whitespace', 'Whether to preserve whitespace and newlines.')
-        .option('--flatten', `Whether to hoist selectors & flatten sentences as much as possible. E.g:
+      and with option \`{pragma: "intl-meta"}\`, we'll parse out \`// @intl-meta project:my-custom-project\` into \`{project: 'my-custom-project'}\` in the result file.`).option("--preserve-whitespace", "Whether to preserve whitespace and newlines.").option("--flatten", `Whether to hoist selectors & flatten sentences as much as possible. E.g:
 "I have {count, plural, one{a dog} other{many dogs}}"
 becomes "{count, plural, one{I have a dog} other{I have many dogs}}".
 The goal is to provide as many full sentences as possible since fragmented
-sentences are not translator-friendly.`)
-        .action(async (filePatterns, cmdObj) => {
-        debug('File pattern:', filePatterns);
-        debug('Options:', cmdObj);
-        const files = [];
-        if (filePatterns.length) {
-            files.push(...globSync(filePatterns, {
-                ignore: cmdObj.ignore,
-            }));
-        }
-        if (cmdObj.inFile) {
-            debug('Reading inFile:', cmdObj.inFile);
-            const inFile = readFileSync(cmdObj.inFile, 'utf8');
-            files.push(...inFile
-                .split(/\n|\s+/)
-                .filter(Boolean)
-                .map(f => resolve(f)));
-        }
-        debug('Files to extract:', files);
-        await extract(files, {
-            outFile: cmdObj.outFile,
-            idInterpolationPattern: cmdObj.idInterpolationPattern || '[sha1:contenthash:base64:6]',
-            extractSourceLocation: cmdObj.extractSourceLocation,
-            removeDefaultMessage: cmdObj.removeDefaultMessage,
-            additionalComponentNames: cmdObj.additionalComponentNames,
-            additionalFunctionNames: cmdObj.additionalFunctionNames,
-            throws: cmdObj.throws,
-            pragma: cmdObj.pragma,
-            format: cmdObj.format,
-            // It is possible that the glob pattern does NOT match anything.
-            // But so long as the glob pattern is provided, don't read from stdin.
-            readFromStdin: files.length === 0,
-            preserveWhitespace: cmdObj.preserveWhitespace,
-            flatten: cmdObj.flatten,
-        });
-        process.exit(0);
-    });
-    program
-        .command('compile [translation_files...]')
-        .description(`Compile extracted translation file into react-intl consumable JSON We also verify that the messages are valid ICU and not malformed. <translation_files> can be a glob like "foo/**/en.json"`)
-        .option('--format <path>', `Path to a formatter file that converts \`<translation_file>\` to \`Record<string, string>\` so we can compile. The file must export a function named \`compile\` with the signature:
+sentences are not translator-friendly.`).action(async (filePatterns, cmdObj) => {
+		debug("File pattern:", filePatterns);
+		debug("Options:", cmdObj);
+		const files = [];
+		if (filePatterns.length) {
+			files.push(...globSync(filePatterns, { ignore: cmdObj.ignore }));
+		}
+		if (cmdObj.inFile) {
+			debug("Reading inFile:", cmdObj.inFile);
+			const inFile = readFileSync(cmdObj.inFile, "utf8");
+			files.push(...inFile.split(/\n|\s+/).filter(Boolean).map((f) => resolve(f)));
+		}
+		debug("Files to extract:", files);
+		await extract(files, {
+			outFile: cmdObj.outFile,
+			idInterpolationPattern: cmdObj.idInterpolationPattern || "[sha1:contenthash:base64:6]",
+			extractSourceLocation: cmdObj.extractSourceLocation,
+			removeDefaultMessage: cmdObj.removeDefaultMessage,
+			additionalComponentNames: cmdObj.additionalComponentNames,
+			additionalFunctionNames: cmdObj.additionalFunctionNames,
+			throws: cmdObj.throws,
+			pragma: cmdObj.pragma,
+			format: cmdObj.format,
+			readFromStdin: files.length === 0,
+			preserveWhitespace: cmdObj.preserveWhitespace,
+			flatten: cmdObj.flatten
+		});
+		process.exit(0);
+	});
+	program.command("compile [translation_files...]").description(`Compile extracted translation file into react-intl consumable JSON We also verify that the messages are valid ICU and not malformed. <translation_files> can be a glob like "foo/**/en.json"`).option("--format <path>", `Path to a formatter file that converts \`<translation_file>\` to \`Record<string, string>\` so we can compile. The file must export a function named \`compile\` with the signature:
 \`\`\`
 type CompileFn = <T = Record<string, MessageDescriptor>>(
   msgs: T
 ) => Record<string, string>;
 \`\`\`
 This is especially useful to convert from a TMS-specific format back to react-intl format
-`)
-        .option('--out-file <path>', `Compiled translation output file. If this is not provided, result will be printed to stdout`)
-        .option('--ast', `Whether to compile to AST. See https://formatjs.github.io/docs/guides/advanced-usage#pre-parsing-messages for more information`)
-        .option('--skip-errors', `Whether to continue compiling messages after encountering an error. Any keys with errors will not be included in the output file.`)
-        .option('--pseudo-locale <pseudoLocale>', `Whether to generate pseudo-locale files. See https://formatjs.github.io/docs/tooling/cli#--pseudo-locale-pseudolocale for possible values. "--ast" is required for this to work.`)
-        .option('--ignore-tag', `Whether the parser to treat HTML/XML tags as string literal instead of parsing them as tag token. When this is false we only allow simple tags without any attributes.`)
-        .action(async (filePatterns, opts) => {
-        debug('File pattern:', filePatterns);
-        debug('Options:', opts);
-        const files = globSync(filePatterns);
-        if (!files.length) {
-            throw new Error(`No input file found with pattern ${filePatterns}`);
-        }
-        debug('Files to compile:', files);
-        await compile(files, opts);
-    });
-    program
-        .command('compile-folder <folder> <outFolder>')
-        .description(`Batch compile all extracted translation JSON files in <folder> to <outFolder> containing react-intl consumable JSON. We also verify that the messages are valid ICU and not malformed.`)
-        .option('--format <path>', `Path to a formatter file that converts JSON files in \`<folder>\` to \`Record<string, string>\` so we can compile. The file must export a function named \`compile\` with the signature:
+`).option("--out-file <path>", `Compiled translation output file. If this is not provided, result will be printed to stdout`).option("--ast", `Whether to compile to AST. See https://formatjs.github.io/docs/guides/advanced-usage#pre-parsing-messages for more information`).option("--skip-errors", `Whether to continue compiling messages after encountering an error. Any keys with errors will not be included in the output file.`).option("--pseudo-locale <pseudoLocale>", `Whether to generate pseudo-locale files. See https://formatjs.github.io/docs/tooling/cli#--pseudo-locale-pseudolocale for possible values. "--ast" is required for this to work.`).option("--ignore-tag", `Whether the parser to treat HTML/XML tags as string literal instead of parsing them as tag token. When this is false we only allow simple tags without any attributes.`).action(async (filePatterns, opts) => {
+		debug("File pattern:", filePatterns);
+		debug("Options:", opts);
+		const files = globSync(filePatterns);
+		if (!files.length) {
+			throw new Error(`No input file found with pattern ${filePatterns}`);
+		}
+		debug("Files to compile:", files);
+		await compile(files, opts);
+	});
+	program.command("compile-folder <folder> <outFolder>").description(`Batch compile all extracted translation JSON files in <folder> to <outFolder> containing react-intl consumable JSON. We also verify that the messages are valid ICU and not malformed.`).option("--format <path>", `Path to a formatter file that converts JSON files in \`<folder>\` to \`Record<string, string>\` so we can compile. The file must export a function named \`compile\` with the signature:
 \`\`\`
 type CompileFn = <T = Record<string, MessageDescriptor>>(
   msgs: T
 ) => Record<string, string>;
 \`\`\`
 This is especially useful to convert from a TMS-specific format back to react-intl format
-`)
-        .option('--ast', `Whether to compile to AST. See https://formatjs.github.io/docs/guides/advanced-usage#pre-parsing-messages for more information`)
-        .action(async (folder, outFolder, opts) => {
-        debug('Folder:', folder);
-        debug('Options:', opts);
-        // fast-glob expect `/` in Windows as well
-        const files = globSync(`${folder}/*.json`);
-        if (!files.length) {
-            throw new Error(`No JSON file found in ${folder}`);
-        }
-        debug('Files to compile:', files);
-        await compileFolder(files, outFolder, opts);
-    });
-    program
-        .command('verify [translation_files...]')
-        .description(`Run a series of checks on a list of translation files. <translation_files> can be a glob like "foo/**/en.json"`)
-        .option('--source-locale <sourceLocale>', `The source locale of the translation files.
+`).option("--ast", `Whether to compile to AST. See https://formatjs.github.io/docs/guides/advanced-usage#pre-parsing-messages for more information`).action(async (folder, outFolder, opts) => {
+		debug("Folder:", folder);
+		debug("Options:", opts);
+		// fast-glob expect `/` in Windows as well
+		const files = globSync(`${folder}/*.json`);
+		if (!files.length) {
+			throw new Error(`No JSON file found in ${folder}`);
+		}
+		debug("Files to compile:", files);
+		await compileFolder(files, outFolder, opts);
+	});
+	program.command("verify [translation_files...]").description(`Run a series of checks on a list of translation files. <translation_files> can be a glob like "foo/**/en.json"`).option("--source-locale <sourceLocale>", `The source locale of the translation files.
       There must be a file named <sourceLocale>.json in the list of translation files.
-      This is used as source to verify other translations against.`)
-        .option('--ignore <files...>', 'List of glob paths to ignore')
-        .option('--missing-keys', `Whether to check for missing keys in target locale compared to source locale. 
-      This basically guarantees that no messages are untranslated.`)
-        .option('--extra-keys', `Whether to check that target locales don't have extra keys not present in the source locale.`)
-        .option('--structural-equality', `Whether to check for structural equality of messages between source and target locale. 
-      This makes sure translations are formattable and are not missing any tokens.`)
-        .action(async (filePatterns, opts) => {
-        debug('File pattern:', filePatterns);
-        debug('Options:', opts);
-        const files = globSync(filePatterns, {
-            ignore: opts.ignore,
-        });
-        if (!files.length) {
-            throw new Error(`No input file found with pattern ${filePatterns}`);
-        }
-        debug('Files to verify:', files);
-        await verify(files, opts);
-    });
-    if (argv.length < 3) {
-        program.help();
-    }
-    else {
-        program.parse(argv);
-    }
+      This is used as source to verify other translations against.`).option("--ignore <files...>", "List of glob paths to ignore").option("--missing-keys", `Whether to check for missing keys in target locale compared to source locale. 
+      This basically guarantees that no messages are untranslated.`).option("--extra-keys", `Whether to check that target locales don't have extra keys not present in the source locale.`).option("--structural-equality", `Whether to check for structural equality of messages between source and target locale. 
+      This makes sure translations are formattable and are not missing any tokens.`).action(async (filePatterns, opts) => {
+		debug("File pattern:", filePatterns);
+		debug("Options:", opts);
+		const files = globSync(filePatterns, { ignore: opts.ignore });
+		if (!files.length) {
+			throw new Error(`No input file found with pattern ${filePatterns}`);
+		}
+		debug("Files to verify:", files);
+		await verify(files, opts);
+	});
+	if (argv.length < 3) {
+		program.help();
+	} else {
+		program.parse(argv);
+	}
 }
 export default main;

package/src/compile.d.ts

@@ -1,54 +1,54 @@
-import { Formatter } from './formatters/index.js';
+import { type Formatter } from "./formatters/index.js";
 export type CompileFn = (msgs: any) => Record<string, string>;
-export type PseudoLocale = 'xx-LS' | 'xx-AC' | 'xx-HA' | 'en-XA' | 'en-XB';
+export type PseudoLocale = "xx-LS" | "xx-AC" | "xx-HA" | "en-XA" | "en-XB";
 export interface CompileCLIOpts extends Opts {
-    /**
-     * The target file that contains compiled messages.
-     */
-    outFile?: string;
+	/**
+	* The target file that contains compiled messages.
+	*/
+	outFile?: string;
 }
 export interface Opts {
-    /**
-     * Whether to compile message into AST instead of just string
-     */
-    ast?: boolean;
-    /**
-     * Whether to continue compiling messages after encountering an error.
-     * Any keys with errors will not be included in the output file.
-     */
-    skipErrors?: boolean;
-    /**
-     * Path to a formatter file that converts <translation_files> to
-     * `Record<string, string>` so we can compile.
-     */
-    format?: string | Formatter<unknown>;
-    /**
-     * Whether to compile to pseudo locale
-     */
-    pseudoLocale?: PseudoLocale;
-    /**
-     * Whether the parser to treat HTML/XML tags as string literal
-     * instead of parsing them as tag token.
-     * When this is false we only allow simple tags without
-     * any attributes
-     */
-    ignoreTag?: boolean;
+	/**
+	* Whether to compile message into AST instead of just string
+	*/
+	ast?: boolean;
+	/**
+	* Whether to continue compiling messages after encountering an error.
+	* Any keys with errors will not be included in the output file.
+	*/
+	skipErrors?: boolean;
+	/**
+	* Path to a formatter file that converts <translation_files> to
+	* `Record<string, string>` so we can compile.
+	*/
+	format?: string | Formatter<unknown>;
+	/**
+	* Whether to compile to pseudo locale
+	*/
+	pseudoLocale?: PseudoLocale;
+	/**
+	* Whether the parser to treat HTML/XML tags as string literal
+	* instead of parsing them as tag token.
+	* When this is false we only allow simple tags without
+	* any attributes
+	*/
+	ignoreTag?: boolean;
 }
 /**
- * Aggregate `inputFiles` into a single JSON blob and compile.
- * Also checks for conflicting IDs.
- * Then returns the serialized result as a `string` since key order
- * makes a difference in some vendor.
- * @param inputFiles Input files
- * @param opts Options
- * @returns serialized result in string format
- */
+* Aggregate `inputFiles` into a single JSON blob and compile.
+* Also checks for conflicting IDs.
+* Then returns the serialized result as a `string` since key order
+* makes a difference in some vendor.
+* @param inputFiles Input files
+* @param opts Options
+* @returns serialized result in string format
+*/
 export declare function compile(inputFiles: string[], opts?: Opts): Promise<string>;
 /**
- * Aggregate `inputFiles` into a single JSON blob and compile.
- * Also checks for conflicting IDs and write output to `outFile`.
- * @param inputFiles Input files
- * @param compileOpts options
- * @returns A `Promise` that resolves if file was written successfully
- */
+* Aggregate `inputFiles` into a single JSON blob and compile.
+* Also checks for conflicting IDs and write output to `outFile`.
+* @param inputFiles Input files
+* @param compileOpts options
+* @returns A `Promise` that resolves if file was written successfully
+*/
 export default function compileAndWrite(inputFiles: string[], compileOpts?: CompileCLIOpts): Promise<void>;