@eslint/json 0.9.1 → 0.11.0

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 // @ts-self-types="./index.d.ts"
 import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
 import { ConfigCommentParser, TextSourceCodeBase, Directive, VisitNodeStep } from '@eslint/plugin-kit';
+import naturalCompare from 'natural-compare';
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -19,11 +20,12 @@ import { ConfigCommentParser, TextSourceCodeBase, Directive, VisitNodeStep } fro
 /** @typedef {import("@eslint/core").SourceLocation} SourceLocation */
 /** @typedef {import("@eslint/core").File} File */
 /** @typedef {import("@eslint/core").TraversalStep} TraversalStep */
-/** @typedef {import("@eslint/core").TextSourceCode} TextSourceCode */
 /** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
 /** @typedef {import("@eslint/core").FileProblem} FileProblem */
 /** @typedef {import("@eslint/core").DirectiveType} DirectiveType */
 /** @typedef {import("@eslint/core").RulesConfig} RulesConfig */
+/** @typedef {import("./types.ts").IJSONSourceCode} IJSONSourceCode */
+/** @typedef {import("./types.ts").JSONSyntaxElement} JSONSyntaxElement */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -64,6 +66,7 @@ class JSONTraversalStep extends VisitNodeStep {
 
 /**
  * JSON Source Code Object
+ * @implements {IJSONSourceCode}
  */
 class JSONSourceCode extends TextSourceCodeBase {
 	/**
@@ -140,7 +143,7 @@ class JSONSourceCode extends TextSourceCodeBase {
 			);
 		}
 
-		return this.#inlineConfigComments;
+		return this.#inlineConfigComments ?? [];
 	}
 
 	/**
@@ -293,10 +296,8 @@ class JSONSourceCode extends TextSourceCodeBase {
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
 /** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
-/**
- * @typedef {Object} JSONLanguageOptions
- * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas.
- */
+/** @typedef {import("./types.ts").IJSONLanguage} IJSONLanguage */
+/** @typedef {import("./types.ts").JSONLanguageOptions} JSONLanguageOptions */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -304,7 +305,7 @@ class JSONSourceCode extends TextSourceCodeBase {
 
 /**
  * JSON Language Object
- * @implements {Language}
+ * @implements {IJSONLanguage}
  */
 class JSONLanguage {
 	/**
@@ -446,13 +447,22 @@ class JSONLanguage {
  * @author Nicholas C. Zakas
  */
 
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"duplicateKey"} NoDuplicateKeysMessageIds */
+/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>} NoDuplicateKeysRuleDefinition */
+/** @typedef {import("@humanwhocodes/momoa").MemberNode} MemberNode */
+
 //-----------------------------------------------------------------------------
 // Rule Definition
 //-----------------------------------------------------------------------------
 
-var noDuplicateKeys = {
+/** @type {NoDuplicateKeysRuleDefinition} */
+const rule$5 = {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow duplicate keys in JSON objects",
@@ -464,7 +474,10 @@ var noDuplicateKeys = {
 	},
 
 	create(context) {
+		/** @type {Array<Map<string, MemberNode>|undefined>} */
 		const objectKeys = [];
+
+		/** @type {Map<string, MemberNode>|undefined} */
 		let keys;
 
 		return {
@@ -503,9 +516,21 @@ var noDuplicateKeys = {
  * @author Nicholas C. Zakas
  */
 
-var noEmptyKeys = {
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"emptyKey"} NoEmptyKeysMessageIds */
+/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>} NoEmptyKeysRuleDefinition */
+
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {NoEmptyKeysRuleDefinition} */
+const rule$4 = {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow empty keys in JSON objects",
@@ -540,15 +565,36 @@ var noEmptyKeys = {
  * @author Bradley Meck Farias
  */
 
-// RFC 8259's `number` production, as a regex.  Capture the integer part
-// and the fractional part.
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"unsafeNumber"|"unsafeInteger"|"unsafeZero"|"subnormal"|"loneSurrogate"} NoUnsafeValuesMessageIds */
+/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>} NoUnsafeValuesRuleDefinition */
+
+//-----------------------------------------------------------------------------
+// Helpers
+//-----------------------------------------------------------------------------
+
+/*
+ * This rule is based on the JSON grammar from RFC 8259, section 6.
+ * https://tools.ietf.org/html/rfc8259#section-6
+ *
+ * We separately capture the integer and fractional parts of a number, so that
+ * we can check for unsafe numbers that will evaluate to Infinity.
+ */
 const NUMBER =
 	/^-?(?<int>0|([1-9][0-9]*))(?:\.(?<frac>[0-9]+))?(?:[eE][+-]?[0-9]+)?$/u;
 const NON_ZERO = /[1-9]/u;
 
-var noUnsafeValues = {
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {NoUnsafeValuesRuleDefinition} */
+const rule$3 = {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow JSON values that are unsafe for interchange",
@@ -622,7 +668,9 @@ var noUnsafeValues = {
 								loc: node.loc,
 								messageId: "subnormal",
 								// Value included so that it's seen in scientific notation
-								data: node,
+								data: {
+									value,
+								},
 							});
 						}
 					}
@@ -665,9 +713,21 @@ var noUnsafeValues = {
  * @author Bradley Meck Farias
  */
 
-var noUnnormalizedKeys = {
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds */
+/** @typedef {import("./types.ts").JSONRuleDefinition<[{form:string}], NoUnnormalizedKeysMessageIds>} NoUnnormalizedKeysRuleDefinition */
+
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {NoUnnormalizedKeysRuleDefinition} */
+const rule$2 = {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow JSON keys that are not normalized",
@@ -691,9 +751,10 @@ var noUnnormalizedKeys = {
 	},
 
 	create(context) {
-		const normalization = context.options.length
-			? text => text.normalize(context.options[0].form)
-			: text => text.normalize();
+		const form = context.options.length
+			? context.options[0].form
+			: undefined;
+
 		return {
 			Member(node) {
 				const key =
@@ -701,7 +762,7 @@ var noUnnormalizedKeys = {
 						? node.name.value
 						: node.name.name;
 
-				if (normalization(key) !== key) {
+				if (key.normalize(form) !== key) {
 					context.report({
 						loc: node.name.loc,
 						messageId: "unnormalizedKey",
@@ -715,14 +776,256 @@ var noUnnormalizedKeys = {
 	},
 };
 
+/**
+ * @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
+ */
+
+
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"sortKeys"} SortKeysMessageIds */
+
+/**
+ * @typedef {Object} SortOptions
+ * @property {boolean} caseSensitive
+ * @property {boolean} natural
+ * @property {number} minKeys
+ * @property {boolean} allowLineSeparatedGroups
+ */
+
+/** @typedef {"asc"|"desc"} SortDirection */
+/** @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions */
+/** @typedef {import("./types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>} SortKeysRuleDefinition */
+/** @typedef {(a:string,b:string) => boolean} Comparator */
+
+//-----------------------------------------------------------------------------
+// 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"
+		? member.name.name
+		: member.name.value;
+}
+
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {SortKeysRuleDefinition} */
+const rule$1 = {
+	meta: {
+		type: "suggestion",
+
+		defaultOptions: [
+			"asc",
+			{
+				allowLineSeparatedGroups: false,
+				caseSensitive: true,
+				minKeys: 2,
+				natural: false,
+			},
+		],
+
+		docs: {
+			description: `Require JSON object keys to be sorted`,
+		},
+
+		messages: {
+			sortKeys:
+				"Expected object keys to be in {{sortName}} case-{{sensitivity}} {{direction}} order. '{{thisName}}' should be before '{{prevName}}'.",
+		},
+
+		schema: [
+			{
+				enum: ["asc", "desc"],
+			},
+			{
+				type: "object",
+				properties: {
+					caseSensitive: {
+						type: "boolean",
+					},
+					natural: {
+						type: "boolean",
+					},
+					minKeys: {
+						type: "integer",
+						minimum: 2,
+					},
+					allowLineSeparatedGroups: {
+						type: "boolean",
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+	},
+
+	create(context) {
+		const [
+			directionShort,
+			{ allowLineSeparatedGroups, caseSensitive, natural, minKeys },
+		] = context.options;
+
+		const direction = directionShort === "asc" ? "ascending" : "descending";
+		const sortName = natural ? "natural" : "alphanumeric";
+		const sensitivity = caseSensitive ? "sensitive" : "insensitive";
+		const isValidOrder = comparators[direction][sortName][sensitivity];
+
+		// Note that @humanwhocodes/momoa doesn't include comments in the object.members tree, so we can't just see if a member is preceded by a comment
+		const commentLineNums = new Set();
+		for (const comment of context.sourceCode.comments) {
+			for (
+				let lineNum = comment.loc.start.line;
+				lineNum <= comment.loc.end.line;
+				lineNum += 1
+			) {
+				commentLineNums.add(lineNum);
+			}
+		}
+
+		/**
+		 * 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) {
+				return false;
+			}
+
+			for (
+				let lineNum = prevMemberEndLine + 1;
+				lineNum < thisStartLine;
+				lineNum += 1
+			) {
+				if (
+					!commentLineNums.has(lineNum) &&
+					!hasNonWhitespace.test(
+						context.sourceCode.lines[lineNum - 1],
+					)
+				) {
+					return true;
+				}
+			}
+
+			return false;
+		}
+
+		return {
+			Object(node) {
+				let prevMember;
+				let prevName;
+
+				if (node.members.length < minKeys) {
+					return;
+				}
+
+				for (const member of node.members) {
+					const thisName = getKey(member);
+
+					if (
+						prevMember &&
+						!isValidOrder(prevName, thisName) &&
+						(!allowLineSeparatedGroups ||
+							!isLineSeparated(prevMember, member))
+					) {
+						context.report({
+							loc: member.name.loc,
+							messageId: "sortKeys",
+							data: {
+								thisName,
+								prevName,
+								direction,
+								sensitivity,
+								sortName,
+							},
+						});
+					}
+
+					prevMember = member;
+					prevName = thisName;
+				}
+			},
+		};
+	},
+};
+
 /**
  * @fileoverview Rule to ensure top-level items are either an array or ojbect.
  * @author Joe Hildebrand
  */
 
-var topLevelInterop = {
+//-----------------------------------------------------------------------------
+// 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:
@@ -764,7 +1067,7 @@ var topLevelInterop = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.9.1", // x-release-please-version
+		version: "0.11.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -772,11 +1075,12 @@ const plugin = {
 		json5: new JSONLanguage({ mode: "json5" }),
 	},
 	rules: {
-		"no-duplicate-keys": noDuplicateKeys,
-		"no-empty-keys": noEmptyKeys,
-		"no-unsafe-values": noUnsafeValues,
-		"no-unnormalized-keys": noUnnormalizedKeys,
-		"top-level-interop": topLevelInterop,
+		"no-duplicate-keys": rule$5,
+		"no-empty-keys": rule$4,
+		"no-unsafe-values": rule$3,
+		"no-unnormalized-keys": rule$2,
+		"sort-keys": rule$1,
+		"top-level-interop": rule,
 	},
 	configs: {
 		recommended: {

package/dist/esm/types.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @fileoverview Additional types for this package.
+ * @author Nicholas C. Zakas
+ */
+import type { RuleVisitor, TextSourceCode, Language, LanguageOptions, RuleDefinition } from "@eslint/core";
+import { DocumentNode, MemberNode, ElementNode, ObjectNode, ArrayNode, StringNode, NullNode, NumberNode, BooleanNode, NaNNode, InfinityNode, IdentifierNode, AnyNode, Token } from "@humanwhocodes/momoa";
+type ValueNodeParent = DocumentNode | MemberNode | ElementNode;
+/**
+ * A JSON syntax element, including nodes and tokens.
+ */
+export type JSONSyntaxElement = Token | AnyNode;
+/**
+ * Language options provided for JSON files.
+ */
+export interface JSONLanguageOptions extends LanguageOptions {
+    /**
+     * Whether to allow trailing commas. Only valid in JSONC.
+     */
+    allowTrailingCommas?: boolean;
+}
+/**
+ * The visitor format returned from rules in this package.
+ */
+export interface JSONRuleVisitor extends RuleVisitor {
+    Document?(node: DocumentNode): void;
+    Member?(node: MemberNode, parent?: ObjectNode): void;
+    Element?(node: ElementNode, parent?: ArrayNode): void;
+    Object?(node: ObjectNode, parent?: ValueNodeParent): void;
+    Array?(node: ArrayNode, parent?: ValueNodeParent): void;
+    String?(node: StringNode, parent?: ValueNodeParent): void;
+    Null?(node: NullNode, parent?: ValueNodeParent): void;
+    Number?(node: NumberNode, parent?: ValueNodeParent): void;
+    Boolean?(node: BooleanNode, parent?: ValueNodeParent): void;
+    NaN?(node: NaNNode, parent?: ValueNodeParent): void;
+    Infinity?(node: InfinityNode, parent?: ValueNodeParent): void;
+    Identifier?(node: IdentifierNode, parent?: ValueNodeParent): void;
+    "Document:exit"?(node: DocumentNode): void;
+    "Member:exit"?(node: MemberNode, parent?: ObjectNode): void;
+    "Element:exit"?(node: ElementNode, parent?: ArrayNode): void;
+    "Object:exit"?(node: ObjectNode, parent?: ValueNodeParent): void;
+    "Array:exit"?(node: ArrayNode, parent?: ValueNodeParent): void;
+    "String:exit"?(node: StringNode, parent?: ValueNodeParent): void;
+    "Null:exit"?(node: NullNode, parent?: ValueNodeParent): void;
+    "Number:exit"?(node: NumberNode, parent?: ValueNodeParent): void;
+    "Boolean:exit"?(node: BooleanNode, parent?: ValueNodeParent): void;
+    "NaN:exit"?(node: NaNNode, parent?: ValueNodeParent): void;
+    "Infinity:exit"?(node: InfinityNode, parent?: ValueNodeParent): void;
+    "Identifier:exit"?(node: IdentifierNode, parent?: ValueNodeParent): void;
+}
+/**
+ * The `SourceCode` implementation for JSON files.
+ */
+export interface IJSONSourceCode extends TextSourceCode<{
+    LangOptions: JSONLanguageOptions;
+    RootNode: DocumentNode;
+    SyntaxElementWithLoc: JSONSyntaxElement;
+    ConfigNode: Token;
+}> {
+    /**
+     * Get the text of a syntax element.
+     * @param syntaxElement The syntax element to get the text of.
+     * @param beforeCount The number of characters to include before the syntax element.
+     * @param afterCount The number of characters to include after the syntax element.
+     * @returns The text of the syntax element.
+     */
+    getText(syntaxElement: JSONSyntaxElement, 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<{
+    LangOptions: JSONLanguageOptions;
+    Code: IJSONSourceCode;
+    RootNode: DocumentNode;
+    Node: AnyNode;
+}>;
+export type JSONRuleDefinition<JSONRuleOptions extends unknown[], JSONRuleMessageIds extends string = ""> = RuleDefinition<{
+    LangOptions: JSONLanguageOptions;
+    Code: IJSONSourceCode;
+    RuleOptions: JSONRuleOptions;
+    Visitor: JSONRuleVisitor;
+    Node: AnyNode;
+    MessageIds: JSONRuleMessageIds;
+    ExtRuleDocs: {};
+}>;
+export {};