eslint-plugin-formatjs 6.7.0-rc.0 → 7.0.0-rc.0

package/index.js

@@ -61,7 +61,7 @@ function messageTypes(ast, module, ignoreList = []) {
 		else if (types.has("date")) type = "number | Date";
 		else if (types.has("select")) type = "string";
 		else type = `import(${JSON.stringify(module)}).MessageTag`;
-		return `${JSON.stringify(name)}${ignored.has(name) ? "?" : ""}: ${type}`;
+		return `readonly ${JSON.stringify(name)}${ignored.has(name) ? "?" : ""}: ${type}`;
 	});
 	return fields.length ? `{ ${fields.join("; ")} }` : "{}";
 }
@@ -455,7 +455,13 @@ function renderType(node) {
 		TSStringKeyword: "string"
 	};
 	if (keywords[node.type]) return keywords[node.type];
-	if (node.type === "TSTypeReference" && node.typeName?.type === "Identifier") return node.typeName.name;
+	if (node.type === "TSTypeReference" && node.typeName?.type === "Identifier") {
+		const parameters = (node.typeArguments ?? node.typeParameters)?.params;
+		if (!parameters) return node.typeName.name;
+		const types = parameters.map(renderType);
+		if (types.every((type) => type !== void 0)) return node.typeName.name + "<" + types.join(", ") + ">";
+		return;
+	}
 	if (node.type === "TSUnionType") {
 		const types = node.types?.map(renderType);
 		if (types?.every((type) => type !== void 0)) return types.join(" | ");
@@ -467,11 +473,11 @@ function renderType(node) {
 	if (node.type === "TSTypeLiteral" && node.members) {
 		const fields = [];
 		for (const member of node.members) {
-			if (member.type !== "TSPropertySignature" || member.readonly || member.computed) return;
+			if (member.type !== "TSPropertySignature" || member.computed) return;
 			const key = member.key?.type === "Identifier" ? member.key.name : member.key?.value;
 			const type = renderType(member.typeAnnotation?.typeAnnotation);
 			if (key === void 0 || type === void 0) return;
-			fields.push(`${JSON.stringify(String(key))}${member.optional ? "?" : ""}: ${type}`);
+			fields.push(`${member.readonly ? "readonly " : ""}${JSON.stringify(String(key))}${member.optional ? "?" : ""}: ${type}`);
 		}
 		return fields.length ? `{ ${fields.join("; ")} }` : "{}";
 	}
@@ -482,7 +488,7 @@ function hoistTypes(context, node, contract) {
 	const occupied = new Set(source.scopeManager?.scopes.flatMap((scope) => scope.variables.map((variable) => variable.name)));
 	const resolved = /* @__PURE__ */ new Map();
 	return {
-		text: contract.replace(/import\(("(?:[^"\\]|\\.)*")\)\.(MessageTag|MessageValue)/g, (reference, quotedModule, imported) => {
+		text: contract.replace(/import\(("(?:[^"\\]|\\.)*")\)\.(MessageTag|MessageValue|TypedMessageDescriptor)/g, (reference, quotedModule, imported) => {
 			if (resolved.has(reference)) return resolved.get(reference);
 			const module = JSON.parse(quotedModule);
 			for (const declaration of source.ast.body) {
@@ -519,6 +525,54 @@ function hoistTypes(context, node, contract) {
 		}
 	};
 }
+function catalogAnnotation(context, node) {
+	const parent = node.parent;
+	if (parent?.type !== "VariableDeclarator" || parent.init !== node) return;
+	const annotation = parent.id.typeAnnotation?.typeAnnotation;
+	if (!annotation) return;
+	function imported(type, name) {
+		if (type.type !== "TSTypeReference" || type.typeName?.type !== "Identifier") return false;
+		let scope = context.sourceCode.getScope(node);
+		while (scope) {
+			const binding = scope.set.get(type.typeName.name);
+			if (binding) {
+				const definition = binding.defs[0];
+				return definition?.type === "ImportBinding" && descriptorModules.has(String(definition.parent.source.value)) && definition.node.type === "ImportSpecifier" && (definition.node.imported.type === "Identifier" ? definition.node.imported.name : definition.node.imported.value) === name;
+			}
+			scope = scope.upper;
+		}
+		return false;
+	}
+	function broad(type) {
+		if (type.type === "TSTypeLiteral") return !!type.members?.every((member) => member.type === "TSPropertySignature" && !!member.typeAnnotation && imported(member.typeAnnotation.typeAnnotation, "MessageDescriptor"));
+		let scope = context.sourceCode.getScope(node);
+		while (scope) {
+			if (scope.set.get(type.typeName?.name ?? "")?.defs.length) return false;
+			scope = scope.upper;
+		}
+		const parameters = (type.typeArguments ?? type.typeParameters)?.params;
+		if (type.typeName?.name === "Readonly" && parameters?.length === 1) return broad(parameters[0]);
+		return type.typeName?.name === "Record" && parameters?.length === 2 && imported(parameters[1], "MessageDescriptor");
+	}
+	function typedMap(type) {
+		return type.type === "TSTypeLiteral" && !!type.members?.every((member) => member.type === "TSPropertySignature" && !member.computed && !!member.typeAnnotation && imported(member.typeAnnotation.typeAnnotation, "TypedMessageDescriptor"));
+	}
+	let base = annotation;
+	let generated = typedMap(annotation) ? annotation : void 0;
+	if (annotation.type === "TSIntersectionType" && annotation.types?.length === 2) {
+		const [left, right] = annotation.types;
+		if (right.type === "TSTypeLiteral" && right.members?.every((member) => member.type === "TSPropertySignature" && !!member.typeAnnotation && imported(member.typeAnnotation.typeAnnotation, "TypedMessageDescriptor"))) {
+			base = left;
+			generated = right;
+		}
+	}
+	return {
+		annotation,
+		base,
+		generated,
+		supported: broad(base) || typedMap(base)
+	};
+}
 const descriptorModules = /* @__PURE__ */ new Set([
 	"@formatjs/intl",
 	"react-intl",
@@ -623,6 +677,7 @@ const rule$20 = {
 			contract: "Generate or refresh the ICU argument contract.",
 			invalid: "Cannot generate message types: {{error}}.",
 			manual: "Unsupported number of generic arguments; update the call manually.",
+			annotation: "Catalog annotation may erase ICU contracts; use per-message TypedMessageDescriptor types.",
 			dynamic: "Typed messages require static message strings and parser options for contract verification."
 		}
 	},
@@ -742,14 +797,32 @@ const rule$20 = {
 					});
 					return;
 				}
+				const annotation = imported.helper === "defineMessages" ? catalogAnnotation(context, node) : void 0;
+				if (annotation && !annotation.supported) {
+					context.report({
+						node: annotation.annotation,
+						messageId: "annotation"
+					});
+					return;
+				}
 				let contract;
+				let catalogType;
 				try {
 					const types = messages.map(([message]) => messageTypes(parse(message.message.defaultMessage, { ignoreTag: getSettings(context).ignoreTag }), imported.module, context.options[0]?.ignoreList));
+					if (annotation) {
+						catalogType = "{ " + descriptor.properties.map((property, index) => {
+							if (property.type !== "Property") throw new Error("Unexpected spread");
+							const key = property.key.type === "Identifier" ? property.key.name : property.key.type === "Literal" ? String(property.key.value) : void 0;
+							if (key === void 0) throw new Error("Unsupported catalog key");
+							return "readonly " + JSON.stringify(key) + ": import(" + JSON.stringify(imported.module) + ").TypedMessageDescriptor<" + types[index] + ">";
+						}).join("; ") + " }";
+						if (!descriptor.properties.length) catalogType = "{}";
+					}
 					contract = imported.helper === "defineMessage" ? types[0] : descriptor.properties.length === 0 ? "{}" : `{ ${descriptor.properties.map((p, i) => {
 						if (p.type !== "Property") throw new Error("Unexpected spread");
 						const key = p.key.type === "Identifier" ? p.key.name : p.key.type === "Literal" ? String(p.key.value) : void 0;
 						if (key === void 0) throw new Error("Unsupported catalog key");
-						return `${JSON.stringify(key)}: ${types[i]}`;
+						return `readonly ${JSON.stringify(key)}: ${types[i]}`;
 					}).join("; ")} }`;
 				} catch (error) {
 					context.report({
@@ -759,12 +832,13 @@ const rule$20 = {
 					});
 					return;
 				}
-				const imports = hoistTypes(context, node, contract);
-				contract = imports.text;
+				const imports = hoistTypes(context, node, contract + (catalogType ? "\n" + catalogType : ""));
+				[contract, catalogType] = imports.text.split("\n");
+				const annotationMatches = !annotation || annotation.annotation === annotation.generated && renderType(annotation.generated) === catalogType;
 				const expected = `<${contract}>`;
 				const parameters = generic?.params;
-				if (parameters?.length === 1 && renderType(parameters[0]) === contract && typed && !generated) return;
-				if (generic && parameters?.length !== 1) {
+				if (parameters && parameters.length >= 1 && parameters.length <= 2 && renderType(parameters[0]) === contract && typed && !generated && annotationMatches) return;
+				if (generic && (!parameters || parameters.length < 1 || parameters.length > 2)) {
 					context.report({
 						node: generic,
 						messageId: "manual"
@@ -775,7 +849,8 @@ const rule$20 = {
 					node,
 					messageId: "contract",
 					fix(fixer) {
-						const edits = [...imports.fix(fixer), generic ? fixer.replaceText(generic, expected) : fixer.insertTextAfter(node.optional ? source.getTokenAfter(node.callee) : node.callee, expected)];
+						const edits = [...imports.fix(fixer), generic && parameters?.[0] ? fixer.replaceTextRange([generic.range[0] + 1, parameters[0].range[1]], contract) : fixer.insertTextAfter(node.optional ? source.getTokenAfter(node.callee) : node.callee, expected)];
+						if (annotation && !annotationMatches) edits.push(fixer.replaceText(annotation.annotation, catalogType));
 						if (!typed) {
 							const close = source.getLastToken(node);
 							const previous = source.getTokenBefore(close);
@@ -5049,7 +5124,7 @@ var package_exports = /* @__PURE__ */ __exportAll({
 	version: () => version$1
 });
 var name$1 = "eslint-plugin-formatjs";
-var version$1 = "6.7.0-rc.0";
+var version$1 = "7.0.0-rc.0";
 var description = "ESLint plugin for formatjs";
 var keywords = [
 	"eslint",