Handle when object members are joined by a comment

eslint · Jan 9, 2025 · 67968b5 · 67968b5
1 parent 049194b
commit 67968b5
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 32 deletions.
diff --git a/src/rules/sort-keys.js b/src/rules/sort-keys.js
@@ -90,10 +90,16 @@ export default {
 		const sensitivity = caseSensitive ? "sensitive" : "insensitive";
 		const isValidOrder = comparators[direction][sortName][sensitivity];
 
+		const commentLineRanges = new Set();
+		for (const comment of context.sourceCode.comments) {
+			commentLineRanges.add(
+				`${comment.loc.start.line}:${comment.loc.end.line}`,
+			);
+		}
+
 		return {
 			Object(node) {
 				let prevMember;
-				let prevName;
 
 				if (node.members.length < minKeys) {
 					return;
@@ -102,11 +108,28 @@ export default {
 				for (const member of node.members) {
 					const thisName = member.name.value;
 
-					if (
-						prevMember &&
-						member.loc.start.line - prevMember.loc.end.line < 2
-					) {
-						if (isValidOrder(prevName, thisName) === false) {
+					if (prevMember) {
+						const prevName = prevMember?.name.value;
+						const prevLine = prevMember?.loc.end.line;
+						const thisLine = member.loc.start.line;
+
+						const membersAreJoinedByComment =
+							commentLineRanges.has(`${prevLine}:${thisLine}`) ||
+							commentLineRanges.has(
+								`${prevLine + 1}:${thisLine}`,
+							) ||
+							commentLineRanges.has(
+								`${prevLine}:${thisLine - 1}`,
+							) ||
+							commentLineRanges.has(
+								`${prevLine + 1}:${thisLine - 1}`,
+							);
+
+						if (
+							(thisLine - prevLine < 2 ||
+								membersAreJoinedByComment) &&
+							isValidOrder(prevName, thisName) === false
+						) {
 							context.report({
 								node,
 								loc: member.name.loc,
@@ -123,7 +146,6 @@ export default {
 					}
 
 					prevMember = member;
-					prevName = thisName;
 				}
 			},
 		};

diff --git a/tests/rules/sort-keys.test.js b/tests/rules/sort-keys.test.js
@@ -1753,30 +1753,29 @@ ruleTester.run("sort-keys", rule, {
 				},
 			],
 		},
-		// TODO: This reports in eslint/sort-keys but does not here. Would need to check whether each member is preceded by a comment, which would require mapping members to specific tokens in the AST tree, and there isn't much support for that in the JSON language service right now
-		// {
-		// 	code: `
-		// 				{
-		// 						"b": 1
-		// 						// comment before comma
-		// 						, "a": 2
-		// 				}
-		// 		`,
-		// 	language: "json/jsonc",
-		// 	options: ["asc", { allowLineSeparatedGroups: true }],
-		// 	languageOptions: { ecmaVersion: 6 },
-		// 	errors: [
-		// 		{
-		// 			messageId: "sortKeys",
-		// 			data: {
-		// 				sortName: "alphanumeric",
-		// 				sensitivity: "sensitive",
-		// 				direction: "ascending",
-		// 				thisName: "a",
-		// 				prevName: "b",
-		// 			},
-		// 		},
-		// 	],
-		// },
+		{
+			code: `
+						{
+								"b": 1
+								// comment before comma
+								, "a": 2
+						}
+				`,
+			language: "json/jsonc",
+			options: ["asc", { allowLineSeparatedGroups: true }],
+			languageOptions: { ecmaVersion: 6 },
+			errors: [
+				{
+					messageId: "sortKeys",
+					data: {
+						sortName: "alphanumeric",
+						sensitivity: "sensitive",
+						direction: "ascending",
+						thisName: "a",
+						prevName: "b",
+					},
+				},
+			],
+		},
 	],
 });