refactored group name logic as suggested in #73

hudochenkov · Nov 14, 2018 · f8a8307 · f8a8307
1 parent 6ba7e43
commit f8a8307
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 24 deletions.
diff --git a/rules/properties-order/checkNode.js b/rules/properties-order/checkNode.js
@@ -20,17 +20,6 @@ module.exports = function checkNode(node, sharedInfo) {
 	const allPropData = allNodesData.filter(item => item.name);
 	let shouldFixOrder = false;
 
-	// for grouped properties, create a map to their group names (used for error messages)
-	const groupNamesByProperty = {};
-
-	for (const group of sharedInfo.expectation.filter(e => typeof e === 'object')) {
-		for (const prop of group.properties) {
-			if (group.name) {
-				groupNamesByProperty[prop] = group.name;
-			}
-		}
-	}
-
 	// First, check order
 	allPropData.forEach(function checkEveryPropForOrder(propData, index) {
 		// return early if we know there is a violation and auto fix should be applied
@@ -58,13 +47,11 @@ module.exports = function checkNode(node, sharedInfo) {
 				if (sharedInfo.isFixEnabled) {
 					shouldFixOrder = true;
 				} else {
-					const groupName = groupNamesByProperty[checkedOrder.secondNode.name];
-
 					stylelint.utils.report({
 						message: sharedInfo.messages.expected(
 							checkedOrder.secondNode.name,
 							checkedOrder.firstNode.name,
-							groupName
+							checkedOrder.secondNode.orderData.groupName
 						),
 						node: checkedOrder.secondNode.node,
 						result: sharedInfo.result,

diff --git a/rules/properties-order/createExpectedOrder.js b/rules/properties-order/createExpectedOrder.js
@@ -5,13 +5,13 @@ module.exports = function createExpectedOrder(input) {
 	let expectedPosition = 0;
 	let separatedGroup = 1;
 
-	appendGroup(input);
+	appendGroup({ properties: input });
 
-	function appendGroup(items) {
-		items.forEach(item => appendItem(item, false));
+	function appendGroup(group) {
+		group.properties.forEach(item => appendItem(item, false, group));
 	}
 
-	function appendItem(item, inFlexibleGroup) {
+	function appendItem(item, inFlexibleGroup, group) {
 		if (_.isString(item)) {
 			// In flexible groups, the expectedPosition does not ascend
 			// to make that flexibility work;
@@ -20,7 +20,7 @@ module.exports = function createExpectedOrder(input) {
 				expectedPosition += 1;
 			}
 
-			order[item] = { separatedGroup, expectedPosition };
+			order[item] = { separatedGroup, expectedPosition, groupName: group.groupName };
 
 			return;
 		}
@@ -34,10 +34,10 @@ module.exports = function createExpectedOrder(input) {
 			expectedPosition += 1;
 
 			item.properties.forEach(property => {
-				appendItem(property, true);
+				appendItem(property, true, item);
 			});
 		} else {
-			appendGroup(item.properties);
+			appendGroup(item);
 		}
 	}
 

diff --git a/rules/properties-order/index.js b/rules/properties-order/index.js
@@ -9,9 +9,7 @@ const ruleName = utils.namespace('properties-order');
 
 const messages = stylelint.utils.ruleMessages(ruleName, {
 	expected: (first, second, groupName) => `
-		Expected "${first}"${
-		groupName ? ` to be grouped with other "${groupName}" properties and` : ''
-	} to come before "${second}"`,
+	  Expected "${first}" to come before "${second}"${groupName ? ` in group "${groupName}"` : ''}`,
 	expectedEmptyLineBefore: property => `Expected an empty line before property "${property}"`,
 	rejectedEmptyLineBefore: property => `Unexpected an empty line before property "${property}"`,
 });