eslint-plugin-formatjs 6.3.0 → 6.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-formatjs",
   "description": "ESLint plugin for formatjs",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "license": "MIT",
   "author": "Long Ho <holevietlong@gmail.com>",
   "type": "module",
@@ -12,8 +12,8 @@
     "magic-string": "^0.30.0",
     "picomatch": "2 || 3 || 4",
     "tslib": "^2.8.1",
-    "@formatjs/icu-messageformat-parser": "3.5.1",
-    "@formatjs/ts-transformer": "4.4.0"
+    "@formatjs/ts-transformer": "4.4.0",
+    "@formatjs/icu-messageformat-parser": "3.5.1"
   },
   "peerDependencies": {
     "eslint": "9 || 10"

package/rules/enforce-description.d.ts

@@ -3,5 +3,9 @@ export declare enum Option {
 	literal = "literal",
 	anything = "anything"
 }
+export type ObjectOption = {
+	mode?: Option;
+	minLength?: number;
+};
 export declare const name = "enforce-description";
 export declare const rule: Rule.RuleModule;

package/rules/enforce-description.js

@@ -4,9 +4,27 @@ export let Option = /* @__PURE__ */ function(Option) {
 	Option["anything"] = "anything";
 	return Option;
 }({});
+function normalizeOptions(raw) {
+	if (typeof raw === "string") {
+		return {
+			mode: raw,
+			minLength: undefined
+		};
+	}
+	if (typeof raw === "object" && raw !== null) {
+		return {
+			mode: raw.mode,
+			minLength: raw.minLength
+		};
+	}
+	return {
+		mode: undefined,
+		minLength: undefined
+	};
+}
 function checkNode(context, node) {
 	const msgs = extractMessages(node, getSettings(context));
-	const { options: [type] } = context;
+	const { mode: type, minLength } = normalizeOptions(context.options[0]);
 	for (const [{ message: { description }, descriptionNode, messageDescriptorNode }] of msgs) {
 		if (!description) {
 			if (type === "literal" && descriptionNode) {
@@ -20,6 +38,15 @@ function checkNode(context, node) {
 					messageId: "enforceDescription"
 				});
 			}
+		} else if (typeof minLength === "number" && typeof description === "string" && description.length < minLength) {
+			context.report({
+				node: descriptionNode ?? messageDescriptorNode,
+				messageId: "enforceDescriptionMinLength",
+				data: {
+					minLength: String(minLength),
+					length: String(description.length)
+				}
+			});
 		}
 	}
 }
@@ -32,13 +59,28 @@ export const rule = {
 			url: "https://formatjs.github.io/docs/tooling/linter#enforce-description"
 		},
 		fixable: "code",
-		schema: [{
+		schema: [{ oneOf: [{
 			type: "string",
 			enum: Object.keys(Option)
-		}],
+		}, {
+			type: "object",
+			properties: {
+				mode: {
+					type: "string",
+					enum: Object.keys(Option)
+				},
+				minLength: {
+					type: "integer",
+					minimum: 1
+				}
+			},
+			additionalProperties: false,
+			minProperties: 1
+		}] }],
 		messages: {
 			enforceDescription: "`description` has to be specified in message descriptor",
-			enforceDescriptionLiteral: "`description` has to be a string literal (not function call or variable)"
+			enforceDescriptionLiteral: "`description` has to be a string literal (not function call or variable)",
+			enforceDescriptionMinLength: "`description` must be at least {{minLength}} characters long (currently {{length}})"
 		}
 	},
 	create(context) {