@eslint/json 0.7.0 → 0.8.0

package/README.md

@@ -155,6 +155,7 @@ export default [
 -   `no-duplicate-keys` - warns when there are two keys in an object with the same text.
 -   `no-empty-keys` - warns when there is a key in an object that is an empty string or contains only whitespace (note: `package-lock.json` uses empty keys intentionally)
 -   `no-unsafe-values` - warns on values that are unsafe for interchange, such as numbers outside safe range or lone surrogates.
+-   `no-unnormalized-keys` - warns on keys containing [unnormalized characters](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize#description). You can optionally specify the normalization form via `{ form: "form_name" }`, where `form_name` can be any of `"NFC"`, `"NFD"`, `"NFKC"`, or `"NFKD"`.
 
 ## Configuration Comments
 

package/dist/cjs/index.cjs

@@ -455,7 +455,7 @@ class JSONLanguage {
 
 var noDuplicateKeys = {
 	meta: {
-		type: "problem",
+		type: /** @type {const} */ ("problem"),
 
 		docs: {
 			description: "Disallow duplicate keys in JSON objects",
@@ -508,7 +508,7 @@ var noDuplicateKeys = {
 
 var noEmptyKeys = {
 	meta: {
-		type: "problem",
+		type: /** @type {const} */ ("problem"),
 
 		docs: {
 			description: "Disallow empty keys in JSON objects",
@@ -545,7 +545,7 @@ var noEmptyKeys = {
 
 var noUnsafeValues = {
 	meta: {
-		type: "problem",
+		type: /** @type {const} */ ("problem"),
 
 		docs: {
 			description: "Disallow JSON values that are unsafe for interchange",
@@ -599,6 +599,61 @@ var noUnsafeValues = {
 	},
 };
 
+/**
+ * @fileoverview Rule to detect unnormalized keys in JSON.
+ * @author Bradley Meck Farias
+ */
+
+var noUnnormalizedKeys = {
+	meta: {
+		type: /** @type {const} */ ("problem"),
+
+		docs: {
+			description: "Disallow JSON keys that are not normalized",
+		},
+
+		messages: {
+			unnormalizedKey: "Unnormalized key '{{key}}' found.",
+		},
+
+		schema: [
+			{
+				type: "object",
+				properties: {
+					form: {
+						enum: ["NFC", "NFD", "NFKC", "NFKD"],
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+	},
+
+	create(context) {
+		const normalization = context.options.length
+			? text => text.normalize(context.options[0].form)
+			: text => text.normalize();
+		return {
+			Member(node) {
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
+
+				if (normalization(key) !== key) {
+					context.report({
+						loc: node.name.loc,
+						messageId: "unnormalizedKey",
+						data: {
+							key,
+						},
+					});
+				}
+			},
+		};
+	},
+};
+
 /**
  * @fileoverview JSON plugin.
  * @author Nicholas C. Zakas
@@ -612,7 +667,7 @@ var noUnsafeValues = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.7.0", // x-release-please-version
+		version: "0.8.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -623,20 +678,25 @@ const plugin = {
 		"no-duplicate-keys": noDuplicateKeys,
 		"no-empty-keys": noEmptyKeys,
 		"no-unsafe-values": noUnsafeValues,
+		"no-unnormalized-keys": noUnnormalizedKeys,
 	},
-	configs: {},
-};
-
-Object.assign(plugin.configs, {
-	recommended: {
-		plugins: { json: plugin },
-		rules: {
-			"json/no-duplicate-keys": "error",
-			"json/no-empty-keys": "error",
-			"json/no-unsafe-values": "error",
+	configs: {
+		recommended: {
+			plugins: {},
+			rules: /** @type {const} */ ({
+				"json/no-duplicate-keys": "error",
+				"json/no-empty-keys": "error",
+				"json/no-unsafe-values": "error",
+				"json/no-unnormalized-keys": "error",
+			}),
 		},
 	},
-});
+};
+
+// eslint-disable-next-line no-lone-blocks -- The block syntax { ... } ensures that TypeScript does not get confused about the type of `plugin`.
+{
+	plugin.configs.recommended.plugins.json = plugin;
+}
 
 exports.JSONLanguage = JSONLanguage;
 exports.JSONSourceCode = JSONSourceCode;

package/dist/cjs/index.d.cts

@@ -174,7 +174,7 @@ declare namespace plugin {
     let rules: {
         "no-duplicate-keys": {
             meta: {
-                type: string;
+                type: "problem";
                 docs: {
                     description: string;
                 };
@@ -190,7 +190,7 @@ declare namespace plugin {
         };
         "no-empty-keys": {
             meta: {
-                type: string;
+                type: "problem";
                 docs: {
                     description: string;
                 };
@@ -204,7 +204,7 @@ declare namespace plugin {
         };
         "no-unsafe-values": {
             meta: {
-                type: string;
+                type: "problem";
                 docs: {
                     description: string;
                 };
@@ -218,8 +218,42 @@ declare namespace plugin {
                 String(node: any): void;
             };
         };
+        "no-unnormalized-keys": {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    unnormalizedKey: string;
+                };
+                schema: {
+                    type: string;
+                    properties: {
+                        form: {
+                            enum: string[];
+                        };
+                    };
+                    additionalProperties: boolean;
+                }[];
+            };
+            create(context: any): {
+                Member(node: any): void;
+            };
+        };
     };
-    let configs: {};
+    namespace configs {
+        namespace recommended {
+            export let plugins: {};
+            let rules_1: {
+                readonly "json/no-duplicate-keys": "error";
+                readonly "json/no-empty-keys": "error";
+                readonly "json/no-unsafe-values": "error";
+                readonly "json/no-unnormalized-keys": "error";
+            };
+            export { rules_1 as rules };
+        }
+    }
 }
 import { TextSourceCodeBase } from '@eslint/plugin-kit';
 import { Directive } from '@eslint/plugin-kit';

package/dist/esm/index.d.ts

@@ -174,7 +174,7 @@ declare namespace plugin {
     let rules: {
         "no-duplicate-keys": {
             meta: {
-                type: string;
+                type: "problem";
                 docs: {
                     description: string;
                 };
@@ -190,7 +190,7 @@ declare namespace plugin {
         };
         "no-empty-keys": {
             meta: {
-                type: string;
+                type: "problem";
                 docs: {
                     description: string;
                 };
@@ -204,7 +204,7 @@ declare namespace plugin {
         };
         "no-unsafe-values": {
             meta: {
-                type: string;
+                type: "problem";
                 docs: {
                     description: string;
                 };
@@ -218,8 +218,42 @@ declare namespace plugin {
                 String(node: any): void;
             };
         };
+        "no-unnormalized-keys": {
+            meta: {
+                type: "problem";
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    unnormalizedKey: string;
+                };
+                schema: {
+                    type: string;
+                    properties: {
+                        form: {
+                            enum: string[];
+                        };
+                    };
+                    additionalProperties: boolean;
+                }[];
+            };
+            create(context: any): {
+                Member(node: any): void;
+            };
+        };
     };
-    let configs: {};
+    namespace configs {
+        namespace recommended {
+            export let plugins: {};
+            let rules_1: {
+                readonly "json/no-duplicate-keys": "error";
+                readonly "json/no-empty-keys": "error";
+                readonly "json/no-unsafe-values": "error";
+                readonly "json/no-unnormalized-keys": "error";
+            };
+            export { rules_1 as rules };
+        }
+    }
 }
 import { TextSourceCodeBase } from '@eslint/plugin-kit';
 import { Directive } from '@eslint/plugin-kit';

package/dist/esm/index.js

@@ -452,7 +452,7 @@ class JSONLanguage {
 
 var noDuplicateKeys = {
 	meta: {
-		type: "problem",
+		type: /** @type {const} */ ("problem"),
 
 		docs: {
 			description: "Disallow duplicate keys in JSON objects",
@@ -505,7 +505,7 @@ var noDuplicateKeys = {
 
 var noEmptyKeys = {
 	meta: {
-		type: "problem",
+		type: /** @type {const} */ ("problem"),
 
 		docs: {
 			description: "Disallow empty keys in JSON objects",
@@ -542,7 +542,7 @@ var noEmptyKeys = {
 
 var noUnsafeValues = {
 	meta: {
-		type: "problem",
+		type: /** @type {const} */ ("problem"),
 
 		docs: {
 			description: "Disallow JSON values that are unsafe for interchange",
@@ -596,6 +596,61 @@ var noUnsafeValues = {
 	},
 };
 
+/**
+ * @fileoverview Rule to detect unnormalized keys in JSON.
+ * @author Bradley Meck Farias
+ */
+
+var noUnnormalizedKeys = {
+	meta: {
+		type: /** @type {const} */ ("problem"),
+
+		docs: {
+			description: "Disallow JSON keys that are not normalized",
+		},
+
+		messages: {
+			unnormalizedKey: "Unnormalized key '{{key}}' found.",
+		},
+
+		schema: [
+			{
+				type: "object",
+				properties: {
+					form: {
+						enum: ["NFC", "NFD", "NFKC", "NFKD"],
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+	},
+
+	create(context) {
+		const normalization = context.options.length
+			? text => text.normalize(context.options[0].form)
+			: text => text.normalize();
+		return {
+			Member(node) {
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
+
+				if (normalization(key) !== key) {
+					context.report({
+						loc: node.name.loc,
+						messageId: "unnormalizedKey",
+						data: {
+							key,
+						},
+					});
+				}
+			},
+		};
+	},
+};
+
 /**
  * @fileoverview JSON plugin.
  * @author Nicholas C. Zakas
@@ -609,7 +664,7 @@ var noUnsafeValues = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.7.0", // x-release-please-version
+		version: "0.8.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -620,19 +675,24 @@ const plugin = {
 		"no-duplicate-keys": noDuplicateKeys,
 		"no-empty-keys": noEmptyKeys,
 		"no-unsafe-values": noUnsafeValues,
+		"no-unnormalized-keys": noUnnormalizedKeys,
 	},
-	configs: {},
-};
-
-Object.assign(plugin.configs, {
-	recommended: {
-		plugins: { json: plugin },
-		rules: {
-			"json/no-duplicate-keys": "error",
-			"json/no-empty-keys": "error",
-			"json/no-unsafe-values": "error",
+	configs: {
+		recommended: {
+			plugins: {},
+			rules: /** @type {const} */ ({
+				"json/no-duplicate-keys": "error",
+				"json/no-empty-keys": "error",
+				"json/no-unsafe-values": "error",
+				"json/no-unnormalized-keys": "error",
+			}),
 		},
 	},
-});
+};
+
+// eslint-disable-next-line no-lone-blocks -- The block syntax { ... } ensures that TypeScript does not get confused about the type of `plugin`.
+{
+	plugin.configs.recommended.plugins.json = plugin;
+}
 
 export { JSONLanguage, JSONSourceCode, plugin as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -51,7 +51,8 @@
     "fmt": "prettier --write .",
     "fmt:check": "prettier --check .",
     "test": "mocha tests/**/*.js",
-    "test:coverage": "c8 npm test"
+    "test:coverage": "c8 npm test",
+    "test:types": "tsc -p tests/types/tsconfig.json"
   },
   "keywords": [
     "eslint",
@@ -72,6 +73,7 @@
     "dedent": "^1.5.3",
     "eslint": "^9.11.1",
     "eslint-config-eslint": "^11.0.0",
+    "eslint-plugin-eslint-plugin": "^6.3.2",
     "got": "^14.4.2",
     "lint-staged": "^15.2.7",
     "mocha": "^10.4.0",