@formatjs/cli-lib 8.4.1 → 8.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formatjs/cli-lib",
   "description": "Lib for CLI for formatjs.",
-  "version": "8.4.1",
+  "version": "8.5.0",
   "license": "MIT",
   "author": "Linjie Ding <linjie@airtable.com>",
   "type": "module",
@@ -22,9 +22,9 @@
     "json-stable-stringify": "^1.3.0",
     "loud-rejection": "^2",
     "typescript": "^5.6.0",
-    "@formatjs/icu-skeleton-parser": "2.1.3",
+    "@formatjs/icu-messageformat-parser": "3.5.3",
     "@formatjs/ts-transformer": "4.4.2",
-    "@formatjs/icu-messageformat-parser": "3.5.3"
+    "@formatjs/icu-skeleton-parser": "2.1.3"
   },
   "peerDependencies": {
     "@glimmer/syntax": "^0.84.3 || ^0.95.0",

package/src/cli.js

@@ -52,12 +52,15 @@ works. This option does not do that so it's less safe.`, (val) => val.split(",")
 "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) => {
+sentences are not translator-friendly.`).option("--follow-links", `Whether to follow symbolic links when traversing directories. Defaults to true for compatibility with pnpm symlinked node_modules. Use --no-follow-links to disable.`, true).action(async (filePatterns, cmdObj) => {
 		debug("File pattern:", filePatterns);
 		debug("Options:", cmdObj);
 		const files = [];
 		if (filePatterns.length) {
-			files.push(...globSync(filePatterns, { ignore: cmdObj.ignore }));
+			files.push(...globSync(filePatterns, {
+				ignore: cmdObj.ignore,
+				followSymbolicLinks: cmdObj.followLinks ?? true
+			}));
 		}
 		if (cmdObj.inFile) {
 			debug("Reading inFile:", cmdObj.inFile);
@@ -88,10 +91,10 @@ type CompileFn = <T = Record<string, MessageDescriptor>>(
 ) => 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) => {
+`).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.`).option("--follow-links", `Whether to follow symbolic links when traversing directories. Defaults to true for compatibility with pnpm symlinked node_modules. Use --no-follow-links to disable.`, true).action(async (filePatterns, opts) => {
 		debug("File pattern:", filePatterns);
 		debug("Options:", opts);
-		const files = globSync(filePatterns);
+		const files = globSync(filePatterns, { followSymbolicLinks: opts.followLinks ?? true });
 		if (!files.length) {
 			throw new Error(`No input file found with pattern ${filePatterns}`);
 		}
@@ -119,11 +122,14 @@ This is especially useful to convert from a TMS-specific format back to react-in
 	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) => {
+      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.`).option("--follow-links", `Whether to follow symbolic links when traversing directories. Defaults to true for compatibility with pnpm symlinked node_modules. Use --no-follow-links to disable.`, true).action(async (filePatterns, opts) => {
 		debug("File pattern:", filePatterns);
 		debug("Options:", opts);
-		const files = globSync(filePatterns, { ignore: opts.ignore });
+		const files = globSync(filePatterns, {
+			ignore: opts.ignore,
+			followSymbolicLinks: opts.followLinks ?? true
+		});
 		if (!files.length) {
 			throw new Error(`No input file found with pattern ${filePatterns}`);
 		}

package/src/compile.d.ts

@@ -6,6 +6,11 @@ export interface CompileCLIOpts extends Opts {
 	* The target file that contains compiled messages.
 	*/
 	outFile?: string;
+	/**
+	* Whether to follow symbolic links when traversing directories.
+	* Defaults to true for compatibility with pnpm symlinked node_modules.
+	*/
+	followLinks?: boolean;
 }
 export interface Opts {
 	/**

package/src/extract.d.ts

@@ -37,6 +37,11 @@ export type ExtractCLIOptions = Omit<ExtractOpts, "overrideIdFn" | "onMsgExtract
 	* Ignore file glob pattern
 	*/
 	ignore?: string[];
+	/**
+	* Whether to follow symbolic links when traversing directories.
+	* Defaults to true for compatibility with pnpm symlinked node_modules.
+	*/
+	followLinks?: boolean;
 };
 export type ExtractOpts = Opts & {
 	/**

package/src/verify/index.d.ts

@@ -4,5 +4,10 @@ export interface VerifyOpts {
 	extraKeys: boolean;
 	structuralEquality: boolean;
 	ignore?: string[];
+	/**
+	* Whether to follow symbolic links when traversing directories.
+	* Defaults to true for compatibility with pnpm symlinked node_modules.
+	*/
+	followLinks?: boolean;
 }
 export declare function verify(files: string[], { sourceLocale, missingKeys, extraKeys, structuralEquality }: VerifyOpts): Promise<void>;