eslint-plugin-formatjs 6.1.4 → 6.2.0

package/index.js

@@ -18,6 +18,7 @@ import { rule as noUselessMessage, name as noUselessMessageName } from "./rules/
 import { rule as preferFormattedMessage, name as preferFormattedMessageName } from "./rules/prefer-formatted-message.js";
 import { rule as preferPoundInPlural, name as preferPoundInPluralName } from "./rules/prefer-pound-in-plural.js";
 import { rule as noLiteralStringInObject, name as noLiteralStringInObjectName } from "./rules/no-literal-string-in-object.js";
+import { rule as preferFullSentence, name as preferFullSentenceName } from "./rules/prefer-full-sentence.js";
 import * as packageJsonNs from "./package.json" with { type: "json" };
 const packageJson = packageJsonNs.default ?? packageJsonNs;
 const { name, version } = packageJson;
@@ -42,7 +43,8 @@ const rules = {
 	[preferFormattedMessageName]: preferFormattedMessage,
 	[preferPoundInPluralName]: preferPoundInPlural,
 	[noMissingIcuPluralOnePlaceholdersName]: noMissingIcuPluralOnePlaceholders,
-	[noLiteralStringInObjectName]: noLiteralStringInObject
+	[noLiteralStringInObjectName]: noLiteralStringInObject,
+	[preferFullSentenceName]: preferFullSentence
 };
 // Base plugin
 const plugin = {
@@ -76,7 +78,8 @@ const 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"]],
+			"formatjs/prefer-full-sentence": "error"
 		}
 	},
 	recommended: {
@@ -99,7 +102,8 @@ const 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"]],
+			"formatjs/prefer-full-sentence": "error"
 		}
 	}
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-formatjs",
   "description": "ESLint plugin for formatjs",
-  "version": "6.1.4",
+  "version": "6.2.0",
   "license": "MIT",
   "author": "Long Ho <holevietlong@gmail.com>",
   "type": "module",

package/rules/prefer-full-sentence.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from "eslint";
+export declare const name = "prefer-full-sentence";
+export declare const rule: Rule.RuleModule;

package/rules/prefer-full-sentence.js

@@ -0,0 +1,111 @@
+import { parse, TYPE } from "@formatjs/icu-messageformat-parser";
+import { extractMessages, getSettings } from "../util.js";
+import { CORE_MESSAGES } from "../messages.js";
+/**
+* Get the first boundary element, recursing into tags since
+* <b>hello</b> starts with the literal "hello".
+*/
+function getFirstBoundaryElement(ast) {
+	if (ast.length === 0) return null;
+	const first = ast[0];
+	if (first.type === TYPE.tag) {
+		return getFirstBoundaryElement(first.children);
+	}
+	return first;
+}
+/**
+* Get the last boundary element, recursing into tags.
+*/
+function getLastBoundaryElement(ast) {
+	if (ast.length === 0) return null;
+	const last = ast[ast.length - 1];
+	if (last.type === TYPE.tag) {
+		return getLastBoundaryElement(last.children);
+	}
+	return last;
+}
+function findWhitespaceIssues(ast) {
+	const issues = [];
+	const first = getFirstBoundaryElement(ast);
+	const last = getLastBoundaryElement(ast);
+	// Ignore messages that are only whitespace (edge case)
+	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");
+	}
+	// Check each plural/select option branch independently
+	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));
+				}
+				break;
+			}
+		}
+	}
+	return issues;
+}
+function checkNode(context, node) {
+	const msgs = extractMessages(node, getSettings(context));
+	for (const [{ message: { defaultMessage }, messageNode }] of msgs) {
+		if (!defaultMessage || !messageNode) {
+			continue;
+		}
+		let ast;
+		try {
+			ast = parse(defaultMessage);
+		} catch (e) {
+			context.report({
+				node: messageNode,
+				messageId: "parseError",
+				data: { error: e instanceof Error ? e.message : String(e) }
+			});
+			return;
+		}
+		const issues = findWhitespaceIssues(ast);
+		// Deduplicate
+		const seen = new Set();
+		for (const issue of issues) {
+			if (seen.has(issue)) continue;
+			seen.add(issue);
+			context.report({
+				node: messageNode,
+				messageId: issue
+			});
+		}
+	}
+}
+export const name = "prefer-full-sentence";
+export const rule = {
+	meta: {
+		type: "suggestion",
+		docs: {
+			description: "Detects messages with leading/trailing whitespace, which suggests string concatenation instead of full sentences",
+			url: "https://formatjs.github.io/docs/tooling/linter#prefer-full-sentence"
+		},
+		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"
+		},
+		schema: []
+	},
+	create(context) {
+		const callExpressionVisitor = (node) => checkNode(context, node);
+		const parserServices = context.sourceCode.parserServices;
+		if (parserServices?.defineTemplateBodyVisitor) {
+			return parserServices.defineTemplateBodyVisitor({ CallExpression: callExpressionVisitor }, { CallExpression: callExpressionVisitor });
+		}
+		return {
+			JSXOpeningElement: (node) => checkNode(context, node),
+			CallExpression: callExpressionVisitor
+		};
+	}
+};