Add messageArgs to declaration-property-value-no-unknown, `font-f…

…amily-name-quotes`, `font-family-no-duplicate-names`, `function-calc-no-unspaced-operator`, `import-notation` and `selector-attribute-quotes` (#8285)
stylelint · Jan 7, 2025 · a80cdf6 · a80cdf6
1 parent 8ddbe17
commit a80cdf6
Show file tree

Hide file tree

Showing 22 changed files with 77 additions and 54 deletions.
diff --git a/.changeset/pink-carpets-hope.md b/.changeset/pink-carpets-hope.md
@@ -0,0 +1,5 @@
+---
+"stylelint": minor
+---
+
+Added: `messageArgs` to `declaration-property-value-no-unknown`, `font-family-name-quotes`, `font-family-no-duplicate-names`, `function-calc-no-unspaced-operator`, `import-notation` and `selector-attribute-quotes`
diff --git a/lib/rules/declaration-property-value-keyword-no-deprecated/README.md b/lib/rules/declaration-property-value-keyword-no-deprecated/README.md
@@ -19,8 +19,6 @@ This rule flags keywords that were removed or deprecated after being in the CSS
 
 The [`fix` option](../../../docs/user-guide/options.md#fix) can automatically fix some of the problems reported by this rule.
 
-The [`message` secondary option](../../../docs/user-guide/configure.md#message) accept arguments.
-
 Prior art:
 
 - [@isnotdefined/no-obsolete](https://www.npmjs.com/package/@isnotdefined/stylelint-plugin)

diff --git a/lib/rules/declaration-property-value-keyword-no-deprecated/index.cjs b/lib/rules/declaration-property-value-keyword-no-deprecated/index.cjs
diff --git a/lib/rules/declaration-property-value-keyword-no-deprecated/index.mjs b/lib/rules/declaration-property-value-keyword-no-deprecated/index.mjs
@@ -136,20 +136,17 @@ const rule = (primary, secondaryOptions) => {
 				const lowercasedValue = node.value.toLowerCase();
 				let fix;
 				let message;
-				let messageArgs;
 
 				if (Array.isArray(keywords)) {
 					if (!keywords.includes(lowercasedValue)) return;
 
-					message = messages.rejected;
-					messageArgs = [prop, value];
+					message = messages.rejected(prop, value);
 				} else {
 					const expectedKeyword = keywords[lowercasedValue];
 
 					if (!expectedKeyword) return;
 
-					message = messages.expected;
-					messageArgs = [value, expectedKeyword];
+					message = messages.expected(value, expectedKeyword);
 					fix = () => {
 						node.value = expectedKeyword;
 						setDeclarationValue(decl, parsedValue.toString());
@@ -161,7 +158,6 @@ const rule = (primary, secondaryOptions) => {
 
 				report({
 					message,
-					messageArgs,
 					node: decl,
 					result,
 					ruleName,

diff --git a/lib/rules/declaration-property-value-no-unknown/README.md b/lib/rules/declaration-property-value-no-unknown/README.md
@@ -27,6 +27,8 @@ This rule overlaps with:
 
 You can either turn off the rules or configure them to ignore the overlaps.
 
+The [`message` secondary option](../../../docs/user-guide/configure.md#message) can accept arguments.
+
 Prior art:
 
 - [stylelint-csstree-validator](https://www.npmjs.com/package/stylelint-csstree-validator)

diff --git a/lib/rules/declaration-property-value-no-unknown/index.cjs b/lib/rules/declaration-property-value-no-unknown/index.cjs
diff --git a/lib/rules/declaration-property-value-no-unknown/index.mjs b/lib/rules/declaration-property-value-no-unknown/index.mjs
@@ -155,7 +155,8 @@ const rule = (primary, secondaryOptions) => {
 				const endIndex = index + value.length;
 
 				report({
-					message: messages.rejectedParseError(prop, value),
+					message: messages.rejectedParseError,
+					messageArgs: [prop, value],
 					node: decl,
 					index,
 					endIndex,
@@ -185,7 +186,8 @@ const rule = (primary, secondaryOptions) => {
 			const mismatchValue = value.slice(loc.start.offset, loc.end.offset);
 
 			report({
-				message: messages.rejected(prop, mismatchValue),
+				message: messages.rejected,
+				messageArgs: [prop, mismatchValue],
 				node: decl,
 				index: valueIndex + loc.start.offset,
 				endIndex: valueIndex + loc.end.offset,

diff --git a/lib/rules/font-family-name-quotes/README.md b/lib/rules/font-family-name-quotes/README.md
@@ -15,6 +15,8 @@ This rule ignores `$sass`, `@less`, and `var(--custom-property)` variable syntax
 
 The [`fix` option](../../../docs/user-guide/options.md#fix) can automatically fix most of the problems reported by this rule.
 
+The [`message` secondary option](../../../docs/user-guide/configure.md#message) can accept arguments.
+
 ## Options
 
 `string`: `"always-where-required"|"always-where-recommended"|"always-unless-keyword"`

diff --git a/lib/rules/font-family-name-quotes/index.cjs b/lib/rules/font-family-name-quotes/index.cjs
diff --git a/lib/rules/font-family-name-quotes/index.mjs b/lib/rules/font-family-name-quotes/index.mjs
@@ -223,7 +223,8 @@ const rule = (primary) => {
 			report({
 				result,
 				ruleName,
-				message: messages[messageType](name),
+				message: messages[messageType],
+				messageArgs: [name],
 				node: decl,
 				word: rawName,
 				fix,

diff --git a/lib/rules/font-family-no-duplicate-names/README.md b/lib/rules/font-family-no-duplicate-names/README.md
@@ -16,6 +16,8 @@ This rule ignores `$sass`, `@less`, and `var(--custom-property)` variable syntax
 > [!WARNING]
 > This rule will stumble on _unquoted_ multi-word font names and _unquoted_ font names containing escape sequences. Wrap these font names in quotation marks, and everything should be fine.
 
+The [`message` secondary option](../../../docs/user-guide/configure.md#message) can accept arguments.
+
 ## Options
 
 ### `true`

diff --git a/lib/rules/font-family-no-duplicate-names/index.cjs b/lib/rules/font-family-no-duplicate-names/index.cjs
diff --git a/lib/rules/font-family-no-duplicate-names/index.mjs b/lib/rules/font-family-no-duplicate-names/index.mjs
@@ -10,7 +10,7 @@ import validateOptions from '../../utils/validateOptions.mjs';
 const ruleName = 'font-family-no-duplicate-names';
 
 const messages = ruleMessages(ruleName, {
-	rejected: (name) => `Unexpected duplicate name ${name}`,
+	rejected: (name) => `Unexpected duplicate font-family name ${name}`,
 });
 
 const meta = {
@@ -66,7 +66,7 @@ const rule = (primary, secondaryOptions) => {
 				if (isFamilyNameKeyword(fontFamilyNode)) {
 					if (keywords.has(family.toLowerCase())) {
 						complain(
-							messages.rejected(family),
+							family,
 							declarationValueIndex(decl) + fontFamilyNode.sourceIndex,
 							rawFamily.length,
 							decl,
@@ -82,7 +82,7 @@ const rule = (primary, secondaryOptions) => {
 
 				if (familyNames.has(family)) {
 					complain(
-						messages.rejected(family),
+						family,
 						declarationValueIndex(decl) + fontFamilyNode.sourceIndex,
 						rawFamily.length,
 						decl,
@@ -96,16 +96,17 @@ const rule = (primary, secondaryOptions) => {
 		});
 
 		/**
-		 * @param {string} message
+		 * @param {string} name
 		 * @param {number} index
 		 * @param {number} length
 		 * @param {import('postcss').Declaration} decl
 		 */
-		function complain(message, index, length, decl) {
+		function complain(name, index, length, decl) {
 			report({
 				result,
 				ruleName,
-				message,
+				message: messages.rejected,
+				messageArgs: [name],
 				node: decl,
 				index,
 				endIndex: index + length,

diff --git a/lib/rules/function-calc-no-unspaced-operator/README.md b/lib/rules/function-calc-no-unspaced-operator/README.md
@@ -13,6 +13,8 @@ This rule checks that there is a single whitespace or a newline plus indentation
 
 The [`fix` option](../../../docs/user-guide/options.md#fix) can automatically fix all of the problems reported by this rule.
 
+The [`message` secondary option](../../../docs/user-guide/configure.md#message) can accept arguments.
+
 ## Options
 
 ### `true`

diff --git a/lib/rules/function-calc-no-unspaced-operator/index.cjs b/lib/rules/function-calc-no-unspaced-operator/index.cjs
diff --git a/lib/rules/function-calc-no-unspaced-operator/index.mjs b/lib/rules/function-calc-no-unspaced-operator/index.mjs
@@ -66,16 +66,17 @@ const rule = (primary) => {
 		if (!validOptions) return;
 
 		/**
-		 * @param {string} message
+		 * @param {messages[keyof messages]} message
 		 * @param {import('postcss').Node} node
 		 * @param {number} index
 		 * @param {string} operator
 		 * @param {() => void} fix
 		 */
 		function complain(message, node, index, operator, fix) {
 			const endIndex = index + operator.length;
+			const messageArgs = [operator];
 
-			report({ message, node, index, endIndex, result, ruleName, fix });
+			report({ message, messageArgs, node, index, endIndex, result, ruleName, fix });
 		}
 
 		root.walkDecls((decl) => {
@@ -103,7 +104,7 @@ const rule = (primary) => {
 				const messageKey = position === 'before' ? 'expectedBefore' : 'expectedAfter';
 
 				complain(
-					messages[messageKey](operation.operatorChar),
+					messages[messageKey],
 					decl,
 					valueIndex + operation.operatorCharPosition,
 					operation.operatorChar,
@@ -135,7 +136,7 @@ const rule = (primary) => {
 						operation.completeMissingOperator(operatorChar, endPos, 'append');
 
 						complain(
-							messages.expectedBefore(operation.operatorChar),
+							messages.expectedBefore,
 							decl,
 							valueIndex + operation.operatorCharPosition,
 							operation.operatorChar,
@@ -180,7 +181,7 @@ const rule = (primary) => {
 						operation.completeMissingOperator(operatorChar, startPos, 'prepend');
 
 						complain(
-							messages.expectedAfter(operation.operatorChar),
+							messages.expectedAfter,
 							decl,
 							valueIndex + operation.operatorCharPosition,
 							operation.operatorChar,
@@ -217,7 +218,7 @@ const rule = (primary) => {
 					const message = position === 'before' ? messages.expectedBefore : messages.expectedAfter;
 
 					complain(
-						message(operation.operatorChar),
+						message,
 						decl,
 						valueIndex + operation.operatorCharPosition,
 						operation.operatorChar,

diff --git a/lib/rules/import-notation/README.md b/lib/rules/import-notation/README.md
@@ -11,6 +11,8 @@ Specify string or URL notation for `@import` rules.
 
 The [`fix` option](../../../docs/user-guide/options.md#fix) can automatically fix all of the problems reported by this rule.
 
+The [`message` secondary option](../../../docs/user-guide/configure.md#message) can accept arguments.
+
 ## Options
 
 `string`: `"string"|"url"`