eslint-plugin-formatjs 6.4.20 → 6.6.0

package/index.js

@@ -119,7 +119,6 @@ function extractMessageDescriptor(node) {
 				result.message.id = value;
 				result.idValueNode = valueNode;
 				result.idPropNode = prop;
-				break;
 		}
 	}
 	return result;
@@ -166,9 +165,7 @@ function extractMessageDescriptorFromJSXElement(node) {
 				result.idPropNode = prop;
 				if (value) result.message.id = value;
 				break;
-			case "values":
-				if (valueNode?.type === "JSXExpressionContainer" && valueNode.expression.type === "ObjectExpression") values = valueNode.expression;
-				break;
+			case "values": if (valueNode?.type === "JSXExpressionContainer" && valueNode.expression.type === "ObjectExpression") values = valueNode.expression;
 		}
 	}
 	if (!result.messagePropNode && !result.descriptionNode && !result.idPropNode && hasSpreadAttribute) return;
@@ -237,23 +234,36 @@ let Element = /* @__PURE__ */ function(Element) {
 	Element["tag"] = "tag";
 	return Element;
 }({});
+function isBlocklisted(blocklist, type, element) {
+	return blocklist.some((entry) => {
+		if (typeof entry === "string") return entry === type;
+		if (entry.type !== type) return false;
+		if (!("value" in element) || element.value !== entry.allow.variable) return true;
+		const allowedOptions = entry.allow.options;
+		if (!allowedOptions) return false;
+		if (!isSelectElement(element) && !isPluralElement(element)) return true;
+		const options = Object.keys(element.options);
+		return options.length !== allowedOptions.length || options.some((option) => !allowedOptions.includes(option));
+	});
+}
 function verifyAst$7(blocklist, ast) {
 	const errors = [];
 	for (const el of ast) {
-		if (isLiteralElement(el) && blocklist.includes("literal")) errors.push(getMessage("literal"));
-		if (isArgumentElement(el) && blocklist.includes("argument")) errors.push(getMessage("argument"));
-		if (isNumberElement(el) && blocklist.includes("number")) errors.push(getMessage("number"));
-		if (isDateElement(el) && blocklist.includes("date")) errors.push(getMessage("date"));
-		if (isTimeElement(el) && blocklist.includes("time")) errors.push(getMessage("time"));
-		if (isSelectElement(el) && blocklist.includes("select")) errors.push(getMessage("select"));
-		if (isTagElement(el) && blocklist.includes("tag")) errors.push(getMessage("tag"));
+		if (isLiteralElement(el) && isBlocklisted(blocklist, "literal", el)) errors.push(getMessage("literal"));
+		if (isArgumentElement(el) && isBlocklisted(blocklist, "argument", el)) errors.push(getMessage("argument"));
+		if (isNumberElement(el) && isBlocklisted(blocklist, "number", el)) errors.push(getMessage("number"));
+		if (isDateElement(el) && isBlocklisted(blocklist, "date", el)) errors.push(getMessage("date"));
+		if (isTimeElement(el) && isBlocklisted(blocklist, "time", el)) errors.push(getMessage("time"));
+		if (isSelectElement(el) && isBlocklisted(blocklist, "select", el)) errors.push(getMessage("select"));
+		if (isTagElement(el) && isBlocklisted(blocklist, "tag", el)) errors.push(getMessage("tag"));
+		if (isTagElement(el)) errors.push(...verifyAst$7(blocklist, el.children));
 		if (isPluralElement(el)) {
-			if (blocklist.includes("plural")) errors.push(getMessage("argument"));
-			if (el.pluralType === "ordinal" && blocklist.includes("selectordinal")) errors.push(getMessage("selectordinal"));
+			if (isBlocklisted(blocklist, "plural", el)) errors.push(getMessage("argument"));
+			if (el.pluralType === "ordinal" && isBlocklisted(blocklist, "selectordinal", el)) errors.push(getMessage("selectordinal"));
 		}
 		if (isSelectElement(el) || isPluralElement(el)) {
 			const { options } = el;
-			for (const selector of Object.keys(options)) verifyAst$7(blocklist, options[selector].value);
+			for (const selector of Object.keys(options)) errors.push(...verifyAst$7(blocklist, options[selector].value));
 		}
 	}
 	return errors;
@@ -294,10 +304,33 @@ const rule$20 = {
 		fixable: "code",
 		schema: [{
 			type: "array",
-			items: {
+			items: { oneOf: [{
 				type: "string",
 				enum: Object.keys(Element)
-			}
+			}, {
+				type: "object",
+				additionalProperties: false,
+				required: ["type", "allow"],
+				properties: {
+					type: {
+						type: "string",
+						enum: Object.keys(Element)
+					},
+					allow: {
+						type: "object",
+						additionalProperties: false,
+						required: ["variable"],
+						properties: {
+							variable: { type: "string" },
+							options: {
+								type: "array",
+								uniqueItems: true,
+								items: { type: "string" }
+							}
+						}
+					}
+				}
+			}] }
 		}],
 		messages: {
 			...CORE_MESSAGES,
@@ -462,48 +495,50 @@ function checkNode$14(context, node, { idInterpolationPattern, idWhitelistRegexp
 			});
 			return;
 		}
-		if (idInterpolationPattern) if (!defaultMessage) context.report({
-			node: messageDescriptorNode ?? node,
-			messageId: "enforceIdDefaultMessage"
-		});
-		else if (!description && descriptionNode) context.report({
-			node: messageDescriptorNode ?? node,
-			messageId: "enforceIdDescription"
-		});
-		else {
-			if (idWhitelistRegexps && id && idWhitelistRegexps.some((r) => r.test(id))) continue;
-			const correctId = interpolateName({ resourcePath: context.filename }, idInterpolationPattern, { content: description ? `${defaultMessage}#${description}` : defaultMessage });
-			if (id !== correctId) {
-				let messageId = "enforceIdMatching";
-				let messageData = {
-					idInterpolationPattern,
-					expected: correctId,
-					actual: id
-				};
-				if (idWhitelistRegexps) {
-					messageId = "enforceIdMatchingAllowlisted";
-					messageData = {
-						...messageData,
-						idWhitelist: idWhitelistRegexps.map((r) => `"${r.toString()}"`).join(", ")
+		if (idInterpolationPattern) {
+			if (!defaultMessage) context.report({
+				node: messageDescriptorNode ?? node,
+				messageId: "enforceIdDefaultMessage"
+			});
+			else if (!description && descriptionNode) context.report({
+				node: messageDescriptorNode ?? node,
+				messageId: "enforceIdDescription"
+			});
+			else {
+				if (idWhitelistRegexps && id && idWhitelistRegexps.some((r) => r.test(id))) continue;
+				const correctId = interpolateName({ resourcePath: context.filename }, idInterpolationPattern, { content: description ? `${defaultMessage}#${description}` : defaultMessage });
+				if (id !== correctId) {
+					let messageId = "enforceIdMatching";
+					let messageData = {
+						idInterpolationPattern,
+						expected: correctId,
+						actual: id
 					};
-				}
-				const quote = quoteStyle === "double" ? "\"" : "'";
-				context.report({
-					node: idPropNode ?? messageDescriptorNode ?? node,
-					messageId,
-					data: messageData,
-					fix(fixer) {
-						if (idPropNode) {
-							if (idPropNode.type === "JSXAttribute") return fixer.replaceText(idPropNode, `id="${correctId}"`);
-							return fixer.replaceText(idPropNode, `id: ${quote}${correctId}${quote}`);
-						}
-						if (messagePropNode) {
-							if (messagePropNode.type === "JSXAttribute") return fixer.insertTextAfter(messagePropNode, ` id="${correctId}"`);
-							return fixer.insertTextAfter(messagePropNode, `, id: ${quote}${correctId}${quote}`);
-						}
-						return null;
+					if (idWhitelistRegexps) {
+						messageId = "enforceIdMatchingAllowlisted";
+						messageData = {
+							...messageData,
+							idWhitelist: idWhitelistRegexps.map((r) => `"${r.toString()}"`).join(", ")
+						};
 					}
-				});
+					const quote = quoteStyle === "double" ? "\"" : "'";
+					context.report({
+						node: idPropNode ?? messageDescriptorNode ?? node,
+						messageId,
+						data: messageData,
+						fix(fixer) {
+							if (idPropNode) {
+								if (idPropNode.type === "JSXAttribute") return fixer.replaceText(idPropNode, `id="${correctId}"`);
+								return fixer.replaceText(idPropNode, `id: ${quote}${correctId}${quote}`);
+							}
+							if (messagePropNode) {
+								if (messagePropNode.type === "JSXAttribute") return fixer.insertTextAfter(messagePropNode, ` id="${correctId}"`);
+								return fixer.insertTextAfter(messagePropNode, `, id: ${quote}${correctId}${quote}`);
+							}
+							return null;
+						}
+					});
+				}
 			}
 		}
 	}
@@ -588,9 +623,7 @@ function collectPlaceholderNames(ast) {
 				placeholderNames.add(element.value);
 				for (const { value } of Object.values(element.options)) _traverse(value);
 				break;
-			default:
-				placeholderNames.add(element.value);
-				break;
+			default: placeholderNames.add(element.value);
 		}
 	}
 }
@@ -857,9 +890,7 @@ function calculateComplexity(ast) {
 			case TYPE.tag:
 				complexity = _calculate(element.children, 0) * _calculate(ast, index + 1);
 				break;
-			default:
-				complexity = _calculate(ast, index + 1);
-				break;
+			default: complexity = _calculate(ast, index + 1);
 		}
 		complexityByNode.set(element, complexity);
 		return complexity;
@@ -3578,20 +3609,22 @@ function checkNode$9(context, node) {
 	if (emojiConfig?.versionAbove && isValidEmojiVersion(emojiConfig.versionAbove)) versionAbove = emojiConfig.versionAbove;
 	for (const [{ message: { defaultMessage }, messageNode }] of msgs) {
 		if (!defaultMessage || !messageNode) continue;
-		if (hasEmoji(defaultMessage)) if (versionAbove) {
-			const filter = filterEmojis(versionAbove);
-			for (const emoji of extractEmojis(defaultMessage)) if (!filter(emoji)) context.report({
+		if (hasEmoji(defaultMessage)) {
+			if (versionAbove) {
+				const filter = filterEmojis(versionAbove);
+				for (const emoji of extractEmojis(defaultMessage)) if (!filter(emoji)) context.report({
+					node: messageNode,
+					messageId: "notAllowedAboveVersion",
+					data: {
+						versionAbove,
+						emoji
+					}
+				});
+			} else context.report({
 				node: messageNode,
-				messageId: "notAllowedAboveVersion",
-				data: {
-					versionAbove,
-					emoji
-				}
+				messageId: "notAllowed"
 			});
-		} else context.report({
-			node: messageNode,
-			messageId: "notAllowed"
-		});
+		}
 	}
 }
 const rule$12 = {
@@ -4030,9 +4063,7 @@ function trimMultiWhitespaces(message, ast) {
 			case TYPE.select:
 				for (const option of Object.values(element.options)) collectLiteralElements(option.value);
 				break;
-			case TYPE.tag:
-				collectLiteralElements(element.children);
-				break;
+			case TYPE.tag: collectLiteralElements(element.children);
 		}
 	};
 	collectLiteralElements(ast);
@@ -4290,10 +4321,7 @@ function verifyAst(context, messageNode, ast) {
 				case TYPE.select:
 					for (const { value } of Object.values(current.options)) _verifyAst(value);
 					break;
-				case TYPE.tag:
-					_verifyAst(current.children);
-					break;
-				default: break;
+				case TYPE.tag: _verifyAst(current.children);
 			}
 		}
 	}
@@ -4311,10 +4339,7 @@ function verifyAst(context, messageNode, ast) {
 			case TYPE.tag:
 				_replacementArgumentWithPound(name, element.children);
 				break;
-			case TYPE.select:
-				for (const { value } of Object.values(element.options)) _replacementArgumentWithPound(name, value);
-				break;
-			default: break;
+			case TYPE.select: for (const { value } of Object.values(element.options)) _replacementArgumentWithPound(name, value);
 		}
 	}
 	function _removeRangeAndPrependPluralClauses(rangeToRemoveStart, rangeToRemoveEnd, pluralElement, prependText) {
@@ -4450,18 +4475,27 @@ function getLastBoundaryElement(ast) {
 	if (last.type === TYPE.tag) return getLastBoundaryElement(last.children);
 	return last;
 }
-function findWhitespaceIssues(ast) {
+function isPlaceholder(element) {
+	return element.type !== TYPE.literal && element.type !== TYPE.tag;
+}
+function findMessageIssues(ast) {
 	const issues = [];
 	const first = getFirstBoundaryElement(ast);
 	const last = getLastBoundaryElement(ast);
 	if (first === last && first?.type === TYPE.literal && ast.length === 1 && first.value.trim() === "") return issues;
 	if (first?.type === TYPE.literal && /^\s/.test(first.value)) issues.push("leadingWhitespace");
 	if (last?.type === TYPE.literal && /\s$/.test(last.value)) issues.push("trailingWhitespace");
+	for (let index = 0; index < ast.length - 1; index++) {
+		const current = ast[index];
+		const next = ast[index + 1];
+		if (current.type === TYPE.literal && /\p{L}$/u.test(current.value) && isPlaceholder(next) || isPlaceholder(current) && next.type === TYPE.literal && /^\p{L}/u.test(next.value)) issues.push("placeholderAdjacentToWord");
+	}
 	for (const element of ast) switch (element.type) {
 		case TYPE.plural:
 		case TYPE.select:
-			for (const option of Object.values(element.options)) issues.push(...findWhitespaceIssues(option.value));
+			for (const option of Object.values(element.options)) issues.push(...findMessageIssues(option.value));
 			break;
+		case TYPE.tag: issues.push(...findMessageIssues(element.children));
 	}
 	return issues;
 }
@@ -4480,7 +4514,7 @@ function checkNode(context, node) {
 			});
 			return;
 		}
-		const issues = findWhitespaceIssues(ast);
+		const issues = findMessageIssues(ast);
 		const seen = /* @__PURE__ */ new Set();
 		for (const issue of issues) {
 			if (seen.has(issue)) continue;
@@ -4503,7 +4537,8 @@ const rule = {
 		messages: {
 			...CORE_MESSAGES,
 			leadingWhitespace: "Messages should be full sentences — leading whitespace suggests string concatenation",
-			trailingWhitespace: "Messages should be full sentences — trailing whitespace suggests string concatenation"
+			trailingWhitespace: "Messages should be full sentences — trailing whitespace suggests string concatenation",
+			placeholderAdjacentToWord: "Placeholders should not be joined directly to words or units — use ICU syntax or an Intl formatter"
 		},
 		schema: []
 	},
@@ -4538,7 +4573,7 @@ var package_exports = /* @__PURE__ */ __exportAll({
 	version: () => version$1
 });
 var name$1 = "eslint-plugin-formatjs";
-var version$1 = "6.4.20";
+var version$1 = "6.6.0";
 var description = "ESLint plugin for formatjs";
 var keywords = [
 	"eslint",
@@ -4564,7 +4599,7 @@ var dependencies = {
 	"@types/estree-jsx": "1",
 	"@types/picomatch": "4",
 	"@unicode/unicode-17.0.0": "1",
-	"magic-string": "0",
+	"magic-string": "1",
 	"picomatch": "2 || 3 || 4"
 };
 var peerDependencies = { "eslint": "9 || 10" };
@@ -4640,7 +4675,17 @@ plugin.configs = {
 				other: true
 			}],
 			"formatjs/no-literal-string-in-jsx": ["error", { props: { include: [["*", "{label,placeholder,title}"]] } }],
-			"formatjs/blocklist-elements": ["error", ["selectordinal"]],
+			"formatjs/blocklist-elements": ["error", ["selectordinal", {
+				type: "select",
+				allow: {
+					variable: "gender",
+					options: [
+						"male",
+						"female",
+						"other"
+					]
+				}
+			}]],
 			"formatjs/prefer-full-sentence": "error"
 		}
 	},
@@ -4664,7 +4709,17 @@ plugin.configs = {
 				other: true
 			}],
 			"formatjs/no-literal-string-in-jsx": ["warn", { props: { include: [["*", "{label,placeholder,title}"]] } }],
-			"formatjs/blocklist-elements": ["error", ["selectordinal"]],
+			"formatjs/blocklist-elements": ["error", ["selectordinal", {
+				type: "select",
+				allow: {
+					variable: "gender",
+					options: [
+						"male",
+						"female",
+						"other"
+					]
+				}
+			}]],
 			"formatjs/prefer-full-sentence": "error"
 		}
 	}