fix: Update types and apply to all rules

package.json

@@ -76,6 +76,7 @@
     "@eslint/core": "^0.12.0",
     "@eslint/plugin-kit": "^0.2.7",
     "@humanwhocodes/momoa": "^3.3.4",
+    "momoa": "^1.2.0",
     "natural-compare": "^1.4.0"
   },
   "devDependencies": {

src/rules/no-duplicate-keys.js

@@ -16,7 +16,7 @@
 //-----------------------------------------------------------------------------
 
 /** @type {NoDuplicateKeysRuleDefinition} */
-export default {
+const rule = {
 	meta: {
 		type: "problem",
 
@@ -66,3 +66,5 @@ export default {
 		};
 	},
 };
+
+export default rule;

src/rules/no-empty-keys.js

@@ -15,7 +15,7 @@
 //-----------------------------------------------------------------------------
 
 /** @type {NoEmptyKeysRuleDefinition} */
-export default {
+const rule = {
 	meta: {
 		type: "problem",
 
@@ -46,3 +46,5 @@ export default {
 		};
 	},
 };
+
+export default rule;

src/rules/no-unnormalized-keys.js

@@ -3,7 +3,19 @@
  * @author Bradley Meck Farias
  */
 
-export default {
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds */
+/** @typedef {import("../types.ts").JSONRuleDefinition<[], NoUnnormalizedKeysMessageIds>} NoUnnormalizedKeysRuleDefinition */
+
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {NoUnnormalizedKeysRuleDefinition} */
+const rule = {
 	meta: {
 		type: /** @type {const} */ ("problem"),
 
@@ -29,17 +41,17 @@ export default {
 	},
 
 	create(context) {
-		const normalization = context.options.length
-			? text => text.normalize(context.options[0].form)
-			: text => text.normalize();
+		const options = /** @type {{form:string}[]} */ (context.options);
+		const form = options.length ? options[0].form : undefined;
+
 		return {
 			Member(node) {
 				const key =
 					node.name.type === "String"
 						? node.name.value
 						: node.name.name;
 
-				if (normalization(key) !== key) {
+				if (key.normalize(form) !== key) {
 					context.report({
 						loc: node.name.loc,
 						messageId: "unnormalizedKey",
@@ -52,3 +64,5 @@ export default {
 		};
 	},
 };
+
+export default rule;

src/rules/no-unsafe-values.js

@@ -30,7 +30,7 @@ const NON_ZERO = /[1-9]/u;
 //-----------------------------------------------------------------------------
 
 /** @type {NoUnsafeValuesRuleDefinition} */
-export default {
+const rule = {
 	meta: {
 		type: "problem",
 
@@ -145,3 +145,5 @@ export default {
 		};
 	},
 };
+
+export default rule;

src/rules/sort-keys.js

@@ -1,48 +1,97 @@
 /**
- * @fileoverview Rule to require JSON object keys to be sorted. Copied largely from https://github.com/eslint/eslint/blob/main/lib/rules/sort-keys.js
+ * @fileoverview Rule to require JSON object keys to be sorted.
+ * Copied largely from https://github.com/eslint/eslint/blob/main/lib/rules/sort-keys.js
  * @author Robin Thomas
  */
 
+//-----------------------------------------------------------------------------
+// Imports
+//-----------------------------------------------------------------------------
+
 import naturalCompare from "natural-compare";
 
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"sortKeys"} SortKeysMessageIds */
+/** @typedef {import("../types.ts").JSONRuleDefinition<[], SortKeysMessageIds>} SortKeysRuleDefinition */
+/** @typedef {(a:string,b:string) => boolean} Comparator */
+/** @typedef {import("@humanwhocodes/momoa").MemberNode} MemberNode */
+/**
+ * @typedef {Object} SortOptions
+ * @property {boolean} caseSensitive
+ * @property {boolean} natural
+ * @property {number} minKeys
+ * @property {boolean} allowLineSeparatedGroups
+ */
+/** @typedef {"asc"|"desc"} SortDirection */
+/** @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions */
+
+//-----------------------------------------------------------------------------
+// Helpers
+//-----------------------------------------------------------------------------
+
 const hasNonWhitespace = /\S/u;
 
 const comparators = {
 	ascending: {
 		alphanumeric: {
+			/** @type {Comparator} */
 			sensitive: (a, b) => a <= b,
+
+			/** @type {Comparator} */
 			insensitive: (a, b) => a.toLowerCase() <= b.toLowerCase(),
 		},
 		natural: {
+			/** @type {Comparator} */
 			sensitive: (a, b) => naturalCompare(a, b) <= 0,
+
+			/** @type {Comparator} */
 			insensitive: (a, b) =>
 				naturalCompare(a.toLowerCase(), b.toLowerCase()) <= 0,
 		},
 	},
 	descending: {
 		alphanumeric: {
+			/** @type {Comparator} */
 			sensitive: (a, b) =>
 				comparators.ascending.alphanumeric.sensitive(b, a),
+
+			/** @type {Comparator} */
 			insensitive: (a, b) =>
 				comparators.ascending.alphanumeric.insensitive(b, a),
 		},
 		natural: {
+			/** @type {Comparator} */
 			sensitive: (a, b) => comparators.ascending.natural.sensitive(b, a),
+
+			/** @type {Comparator} */
 			insensitive: (a, b) =>
 				comparators.ascending.natural.insensitive(b, a),
 		},
 	},
 };
 
+/**
+ * Gets the MemberNode's string key value.
+ * @param {MemberNode} member
+ * @return {string}
+ */
 function getKey(member) {
-	return member.name.type === `Identifier`
+	return member.name.type === "Identifier"
 		? member.name.name
 		: member.name.value;
 }
 
-export default {
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {SortKeysRuleDefinition} */
+const rule = {
 	meta: {
-		type: /** @type {const} */ ("suggestion"),
+		type: "suggestion",
 
 		defaultOptions: [
 			"asc",
@@ -90,10 +139,11 @@ export default {
 	},
 
 	create(context) {
+		const options = /** @type {Array<string|Object>} */ (context.options);
 		const [
 			directionShort,
 			{ allowLineSeparatedGroups, caseSensitive, natural, minKeys },
-		] = context.options;
+		] = /** @type { SortKeysRuleOptions} */ (options);
 
 		const direction = directionShort === "asc" ? "ascending" : "descending";
 		const sortName = natural ? "natural" : "alphanumeric";
@@ -112,8 +162,14 @@ export default {
 			}
 		}
 
-		// Note that there can be comments *inside* members, e.g. `{"foo: /* comment *\/ "bar"}`, but these are ignored when calculating line-separated groups
+		/**
+		 * Checks if two members are line-separated.
+		 * @param {MemberNode} prevMember The previous member.
+		 * @param {MemberNode} member The current member.
+		 * @return {boolean}
+		 */
 		function isLineSeparated(prevMember, member) {
+			// Note that there can be comments *inside* members, e.g. `{"foo: /* comment *\/ "bar"}`, but these are ignored when calculating line-separated groups
 			const prevMemberEndLine = prevMember.loc.end.line;
 			const thisStartLine = member.loc.start.line;
 			if (thisStartLine - prevMemberEndLine < 2) {
@@ -176,3 +232,5 @@ export default {
 		};
 	},
 };
+
+export default rule;

src/rules/top-level-interop.js

@@ -3,9 +3,21 @@
  * @author Joe Hildebrand
  */
 
-export default {
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"topLevel"} TopLevelInteropMessageIds */
+/** @typedef {import("../types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>} TopLevelInteropRuleDefinition */
+
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {TopLevelInteropRuleDefinition} */
+const rule = {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description:
@@ -33,3 +45,5 @@ export default {
 		};
 	},
 };
+
+export default rule;

src/types.ts

@@ -105,6 +105,16 @@ export interface IJSONSourceCode
 		beforeCount?: number,
 		afterCount?: number,
 	): string;
+
+	/**
+	 * Any comments found in a JSONC or JSON5 file.
+	 */
+	comments: Array<Token> | undefined;
+
+	/**
+	 * The lines of text found in the file.
+	 */
+	lines: Array<string>;
 }
 
 export type IJSONLanguage = Language<{