fix: display raw key in the message

src/rules/no-duplicate-keys.js

@@ -3,6 +3,12 @@
  * @author Nicholas C. Zakas
  */
 
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+
+import { getKey, getRawKey } from "../util.js";
+
 //-----------------------------------------------------------------------------
 // Type Definitions
 //-----------------------------------------------------------------------------
@@ -49,23 +55,22 @@ const rule = {
 			},
 
 			Member(node) {
-				const key =
-					node.name.type === "String"
-						? node.name.value
-						: node.name.name;
+				const key = getKey(node);
+				const rawKey = getRawKey(node, context.sourceCode);
 
 				if (keys.has(key)) {
 					context.report({
 						loc: node.name.loc,
 						messageId: "duplicateKey",
 						data: {
-							key,
+							key: rawKey,
 						},
 					});
 				} else {
 					keys.set(key, node);
 				}
 			},
+
 			"Object:exit"() {
 				keys = objectKeys.pop();
 			},

src/rules/no-empty-keys.js

@@ -3,6 +3,12 @@
  * @author Nicholas C. Zakas
  */
 
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+
+import { getKey } from "../util.js";
+
 //-----------------------------------------------------------------------------
 // Type Definitions
 //-----------------------------------------------------------------------------
@@ -37,10 +43,7 @@ const rule = {
 	create(context) {
 		return {
 			Member(node) {
-				const key =
-					node.name.type === "String"
-						? node.name.value
-						: node.name.name;
+				const key = getKey(node);
 
 				if (key.trim() === "") {
 					context.report({

src/rules/no-unnormalized-keys.js

@@ -2,6 +2,11 @@
  * @fileoverview Rule to detect unnormalized keys in JSON.
  * @author Bradley Meck Farias
  */
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+
+import { getKey } from "../util.js";
 
 //-----------------------------------------------------------------------------
 // Type Definitions
@@ -58,10 +63,7 @@ const rule = {
 
 		return {
 			Member(node) {
-				const key =
-					node.name.type === "String"
-						? node.name.value
-						: node.name.name;
+				const key = getKey(node);
 
 				if (key.normalize(form) !== key) {
 					context.report({

src/rules/sort-keys.js

@@ -9,6 +9,7 @@
 //-----------------------------------------------------------------------------
 
 import naturalCompare from "natural-compare";
+import { getKey } from "../util.js";
 
 //-----------------------------------------------------------------------------
 // Type Definitions
@@ -76,17 +77,6 @@ const comparators = {
 	},
 };
 
-/**
- * Gets the MemberNode's string key value.
- * @param {MemberNode} member
- * @return {string}
- */
-function getKey(member) {
-	return member.name.type === "Identifier"
-		? member.name.name
-		: member.name.value;
-}
-
 //-----------------------------------------------------------------------------
 // Rule Definition
 //-----------------------------------------------------------------------------
@@ -114,7 +104,7 @@ const rule = {
 
 		messages: {
 			sortKeys:
-				"Expected object keys to be in {{sortName}} case-{{sensitivity}} {{direction}} order. '{{thisName}}' should be before '{{prevName}}'.",
+				"Expected object keys to be in {{sortName}} case-{{sensitivity}} {{direction}} order. '{{thisName}}' should be before '{{prevName}}'.", // TODO
 		},
 
 		schema: [

src/util.js

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Utility Library
+ * @author 루밀LuMir(lumirlumir)
+ */
+
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/**
+ * @import { MemberNode } from "@humanwhocodes/momoa";
+ * @import { JSONSourceCode } from "./languages/json-source-code.js";
+ */
+
+//-----------------------------------------------------------------------------
+// Helpers
+//-----------------------------------------------------------------------------
+
+/**
+ * Gets the `MemberNode`'s key value.
+ * @param {MemberNode} node The node to get the key from.
+ * @returns {string} The key value.
+ */
+export function getKey(node) {
+	return node.name.type === "String" ? node.name.value : node.name.name;
+}
+
+/**
+ * Gets the `MemberNode`'s raw key value.
+ * @param {MemberNode} node The node to get the raw key from.
+ * @param {JSONSourceCode} sourceCode The JSON source code object.
+ * @returns {string} The raw key value.
+ */
+export function getRawKey(node, sourceCode) {
+	return node.name.type === "String"
+		? sourceCode.getText(node.name, -1, -1)
+		: sourceCode.getText(node.name);
+}

tests/rules/no-duplicate-keys.test.js

@@ -151,12 +151,67 @@ ruleTester.run("no-duplicate-keys", rule, {
 				},
 			],
 		},
+		{
+			code: '{"foot": 1, "fo\\u006ft": 2}',
+			errors: [
+				{
+					messageId: "duplicateKey",
+					data: { key: "fo\\u006ft" },
+					line: 1,
+					column: 13,
+					endLine: 1,
+					endColumn: 24,
+				},
+			],
+		},
+		{
+			code: '{"foot": 1, "fo\\u006ft": 2}',
+			language: "json/jsonc",
+			errors: [
+				{
+					messageId: "duplicateKey",
+					data: { key: "fo\\u006ft" },
+					line: 1,
+					column: 13,
+					endLine: 1,
+					endColumn: 24,
+				},
+			],
+		},
+		{
+			code: '{"foot": 1, "fo\\u006ft": 2}',
+			language: "json/json5",
+			errors: [
+				{
+					messageId: "duplicateKey",
+					data: { key: "fo\\u006ft" },
+					line: 1,
+					column: 13,
+					endLine: 1,
+					endColumn: 24,
+				},
+			],
+		},
+		{
+			code: "{foot: 1, fo\\u006ft: 2}",
+			language: "json/json5",
+			errors: [
+				{
+					messageId: "duplicateKey",
+					data: { key: "fo\\u006ft" },
+					line: 1,
+					column: 11,
+					endLine: 1,
+					endColumn: 20,
+				},
+			],
+		},
 		{
 			code: '{"f\\u006fot": 1, "fo\\u006ft": 2}',
 			errors: [
 				{
 					messageId: "duplicateKey",
-					data: { key: "foot" },
+					data: { key: "fo\\u006ft" },
 					line: 1,
 					column: 18,
 					endLine: 1,
@@ -170,7 +225,7 @@ ruleTester.run("no-duplicate-keys", rule, {
 			errors: [
 				{
 					messageId: "duplicateKey",
-					data: { key: "foot" },
+					data: { key: "fo\\u006ft" },
 					line: 1,
 					column: 18,
 					endLine: 1,
@@ -184,7 +239,7 @@ ruleTester.run("no-duplicate-keys", rule, {
 			errors: [
 				{
 					messageId: "duplicateKey",
-					data: { key: "foot" },
+					data: { key: "fo\\u006ft" },
 					line: 1,
 					column: 18,
 					endLine: 1,
@@ -198,7 +253,7 @@ ruleTester.run("no-duplicate-keys", rule, {
 			errors: [
 				{
 					messageId: "duplicateKey",
-					data: { key: "foot" },
+					data: { key: "fo\\u006ft" },
 					line: 1,
 					column: 16,
 					endLine: 1,

tests/util.test.js

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview Tests for util.js
+ * @author 루밀LuMir(lumirlumir)
+ */
+
+//------------------------------------------------------------------------------
+// Imports
+//------------------------------------------------------------------------------
+
+import assert from "node:assert";
+// import { JSONLanguage } from "../../src/languages/json-language.js";
+// import { JSONSourceCode } from "../../src/languages/json-source-code.js";
+import {
+	getKey,
+	// getRawKey
+} from "../src/util.js";
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+describe("util", () => {
+	describe("getKey()", () => {
+		it("should return the correct key for `String` nodes", () => {
+			const node = {
+				name: { type: "String", value: "value" },
+			};
+
+			assert.strictEqual(getKey(node), "value");
+		});
+
+		it("should return the correct key for `Identifier` nodes", () => {
+			const node = {
+				name: { type: "Identifier", name: "name" },
+			};
+
+			assert.strictEqual(getKey(node), "name");
+		});
+	});
+
+	/*
+	describe("getRawKey()", () => {
+		const file = { body: `{"foo": 1, 'bar': 2, baz: 3}` };
+		const language = new JSONLanguage({ mode: "jsonc" });
+		const parseResult = language.parse(file);
+		const sourceCode = new JSONSourceCode({
+			text: file.body,
+			ast: parseResult.ast,
+		});
+
+		it("TODO", () => {
+			// TODO
+		});
+	});
+    */
+});