@formatjs/ts-transformer 4.3.1 → 4.3.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formatjs/ts-transformer",
   "description": "TS Compiler transformer for formatjs",
-  "version": "4.3.1",
+  "version": "4.3.3",
   "license": "MIT",
   "author": "Long Ho <holevietlong@gmail.com>",
   "type": "module",
@@ -12,7 +12,7 @@
     "json-stable-stringify": "^1.3.0",
     "tslib": "^2.8.1",
     "typescript": "^5.6.0",
-    "@formatjs/icu-messageformat-parser": "3.5.0"
+    "@formatjs/icu-messageformat-parser": "3.5.1"
   },
   "devDependencies": {
     "ts-jest": "^29"

package/src/transform.d.ts

@@ -75,6 +75,16 @@ export interface Opts {
 	* Whether to hoist selectors & flatten sentences
 	*/
 	flatten?: boolean;
+	/**
+	* Whether to throw on errors extracting messages.
+	* When false, invalid messages are skipped with a warning.
+	* Defaults to true.
+	*/
+	throws?: boolean;
+	/**
+	* Callback for reporting errors when throws is false.
+	*/
+	onMsgError?: (filePath: string, error: Error) => void;
 }
 export declare function transformWithTs(ts: TypeScript, opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;
 export declare function transform(opts: Opts): typescript.TransformerFactory<typescript.SourceFile>;

package/src/transform.js

@@ -99,7 +99,19 @@ function evaluateStringConcat(ts, node) {
 	}
 	return ["", false];
 }
-function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocation, preserveWhitespace, flatten }, sf) {
+function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocation, preserveWhitespace, flatten, throws = true, onMsgError }, sf) {
+	let extractionError = null;
+	// Helper to handle errors based on throws option
+	function handleError(errorMsg) {
+		const error = new Error(errorMsg);
+		if (throws) {
+			throw error;
+		}
+		extractionError = error;
+		if (onMsgError) {
+			onMsgError(sf.fileName, error);
+		}
+	}
 	let properties = undefined;
 	if (ts.isObjectLiteralExpression(node)) {
 		properties = node.properties;
@@ -147,7 +159,8 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
 				}
 				const { template } = initializer;
 				if (!ts.isNoSubstitutionTemplateLiteral(template)) {
-					throw new Error("Tagged template expression must be no substitution");
+					handleError("[FormatJS] Tagged template expression must be no substitution");
+					return;
 				}
 				switch (name.text) {
 					case "id":
@@ -197,7 +210,8 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
 					}
 					const { expression: { template } } = initializer;
 					if (!ts.isNoSubstitutionTemplateLiteral(template)) {
-						throw new Error("Tagged template expression must be no substitution");
+						handleError("[FormatJS] Tagged template expression must be no substitution");
+						return;
 					}
 					switch (name.text) {
 						case "id":
@@ -227,10 +241,12 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
 						}
 					} else if (MESSAGE_DESC_KEYS.includes(name.text) && name.text !== "description") {
 						// Non-static expression for defaultMessage or id
-						throw new Error(`[FormatJS] \`${name.text}\` must be a string literal or statically evaluable expression to be extracted.`);
+						handleError(`[FormatJS] \`${name.text}\` must be a string literal or statically evaluable expression to be extracted.`);
+						return;
 					}
 				} else if (MESSAGE_DESC_KEYS.includes(name.text) && name.text !== "description") {
-					throw new Error(`[FormatJS] \`${name.text}\` must be a string literal to be extracted.`);
+					handleError(`[FormatJS] \`${name.text}\` must be a string literal to be extracted.`);
+					return;
 				}
 			} else if (ts.isBinaryExpression(initializer)) {
 				const [result, isStatic] = evaluateStringConcat(ts, initializer);
@@ -248,15 +264,21 @@ function extractMessageDescriptor(ts, node, { overrideIdFn, extractSourceLocatio
 					}
 				} else if (MESSAGE_DESC_KEYS.includes(name.text) && name.text !== "description") {
 					// Non-static expression for defaultMessage or id
-					throw new Error(`[FormatJS] \`${name.text}\` must be a string literal or statically evaluable expression to be extracted.`);
+					handleError(`[FormatJS] \`${name.text}\` must be a string literal or statically evaluable expression to be extracted.`);
+					return;
 				}
 			} else if (ts.isObjectLiteralExpression(initializer) && name.text === "description") {
 				msg.description = objectLiteralExpressionToObj(ts, initializer);
 			} else if (MESSAGE_DESC_KEYS.includes(name.text) && name.text !== "description") {
-				throw new Error(`[FormatJS] \`${name.text}\` must be a string literal to be extracted.`);
+				handleError(`[FormatJS] \`${name.text}\` must be a string literal to be extracted.`);
+				return;
 			}
 		}
 	});
+	// If we had an extraction error (and throws is false), skip this message
+	if (extractionError) {
+		return;
+	}
 	// We extracted nothing
 	if (!msg.defaultMessage && !msg.id) {
 		return;