@eslint/json 0.9.1 → 0.11.0

package/dist/cjs/index.d.cts

@@ -5,20 +5,41 @@ export type SourceRange = import("@eslint/core").SourceRange;
 export type SourceLocation = import("@eslint/core").SourceLocation;
 export type File = import("@eslint/core").File;
 export type TraversalStep = import("@eslint/core").TraversalStep;
-export type TextSourceCode = import("@eslint/core").TextSourceCode;
 export type VisitTraversalStep = import("@eslint/core").VisitTraversalStep;
 export type FileProblem = import("@eslint/core").FileProblem;
 export type DirectiveType = import("@eslint/core").DirectiveType;
 export type RulesConfig = import("@eslint/core").RulesConfig;
+export type IJSONSourceCode = import("./types.cts").IJSONSourceCode;
+export type JSONSyntaxElement = import("./types.cts").JSONSyntaxElement;
 export type Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
-export type JSONLanguageOptions = {
-    /**
-     * Whether to allow trailing commas.
-     */
-    allowTrailingCommas?: boolean;
+export type IJSONLanguage = import("./types.cts").IJSONLanguage;
+export type JSONLanguageOptions = import("./types.cts").JSONLanguageOptions;
+export type NoDuplicateKeysMessageIds = "duplicateKey";
+export type NoDuplicateKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>;
+export type MemberNode = import("@humanwhocodes/momoa").MemberNode;
+export type NoEmptyKeysMessageIds = "emptyKey";
+export type NoEmptyKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>;
+export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
+export type NoUnsafeValuesRuleDefinition = import("./types.cts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>;
+export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
+export type NoUnnormalizedKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<[{
+    form: string;
+}], NoUnnormalizedKeysMessageIds>;
+export type SortKeysMessageIds = "sortKeys";
+export type SortOptions = {
+    caseSensitive: boolean;
+    natural: boolean;
+    minKeys: number;
+    allowLineSeparatedGroups: boolean;
 };
+export type SortDirection = "asc" | "desc";
+export type SortKeysRuleOptions = [SortDirection, SortOptions];
+export type SortKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>;
+export type Comparator = (a: string, b: string) => boolean;
+export type TopLevelInteropMessageIds = "topLevel";
+export type TopLevelInteropRuleDefinition = import("./types.cts").JSONRuleDefinition<[], TopLevelInteropMessageIds>;
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
@@ -26,15 +47,13 @@ export type JSONLanguageOptions = {
 /** @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.cts").IJSONLanguage} IJSONLanguage */
+/** @typedef {import("./types.cts").JSONLanguageOptions} JSONLanguageOptions */
 /**
  * JSON Language Object
- * @implements {Language}
+ * @implements {IJSONLanguage}
  */
-export class JSONLanguage implements Language {
+export class JSONLanguage implements IJSONLanguage {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -95,8 +114,9 @@ export class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
+ * @implements {IJSONSourceCode}
  */
-export class JSONSourceCode extends TextSourceCodeBase {
+export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCode {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -172,92 +192,12 @@ declare namespace plugin {
         let json5: JSONLanguage;
     }
     let rules: {
-        "no-duplicate-keys": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    duplicateKey: string;
-                };
-            };
-            create(context: any): {
-                Object(): void;
-                Member(node: any): void;
-                "Object:exit"(): void;
-            };
-        };
-        "no-empty-keys": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    emptyKey: string;
-                };
-            };
-            create(context: any): {
-                Member(node: any): void;
-            };
-        };
-        "no-unsafe-values": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    unsafeNumber: string;
-                    unsafeInteger: string;
-                    unsafeZero: string;
-                    subnormal: string;
-                    loneSurrogate: string;
-                };
-            };
-            create(context: any): {
-                Number(node: any): void;
-                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;
-            };
-        };
-        "top-level-interop": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    topLevel: string;
-                };
-            };
-            create(context: any): {
-                Document(node: any): void;
-            };
-        };
+        "no-duplicate-keys": NoDuplicateKeysRuleDefinition;
+        "no-empty-keys": NoEmptyKeysRuleDefinition;
+        "no-unsafe-values": NoUnsafeValuesRuleDefinition;
+        "no-unnormalized-keys": NoUnnormalizedKeysRuleDefinition;
+        "sort-keys": SortKeysRuleDefinition;
+        "top-level-interop": TopLevelInteropRuleDefinition;
     };
     namespace configs {
         namespace recommended {

package/dist/cjs/types.cts

@@ -0,0 +1,138 @@
+/**
+ * @fileoverview Additional types for this package.
+ * @author Nicholas C. Zakas
+ */
+
+//------------------------------------------------------------------------------
+// Imports
+//------------------------------------------------------------------------------
+
+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";
+
+//------------------------------------------------------------------------------
+// Types
+//------------------------------------------------------------------------------
+
+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: {};
+}>;

package/dist/esm/index.d.ts

@@ -5,20 +5,41 @@ export type SourceRange = import("@eslint/core").SourceRange;
 export type SourceLocation = import("@eslint/core").SourceLocation;
 export type File = import("@eslint/core").File;
 export type TraversalStep = import("@eslint/core").TraversalStep;
-export type TextSourceCode = import("@eslint/core").TextSourceCode;
 export type VisitTraversalStep = import("@eslint/core").VisitTraversalStep;
 export type FileProblem = import("@eslint/core").FileProblem;
 export type DirectiveType = import("@eslint/core").DirectiveType;
 export type RulesConfig = import("@eslint/core").RulesConfig;
+export type IJSONSourceCode = import("./types.ts").IJSONSourceCode;
+export type JSONSyntaxElement = import("./types.ts").JSONSyntaxElement;
 export type Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
-export type JSONLanguageOptions = {
-    /**
-     * Whether to allow trailing commas.
-     */
-    allowTrailingCommas?: boolean;
+export type IJSONLanguage = import("./types.ts").IJSONLanguage;
+export type JSONLanguageOptions = import("./types.ts").JSONLanguageOptions;
+export type NoDuplicateKeysMessageIds = "duplicateKey";
+export type NoDuplicateKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>;
+export type MemberNode = import("@humanwhocodes/momoa").MemberNode;
+export type NoEmptyKeysMessageIds = "emptyKey";
+export type NoEmptyKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>;
+export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
+export type NoUnsafeValuesRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>;
+export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
+export type NoUnnormalizedKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[{
+    form: string;
+}], NoUnnormalizedKeysMessageIds>;
+export type SortKeysMessageIds = "sortKeys";
+export type SortOptions = {
+    caseSensitive: boolean;
+    natural: boolean;
+    minKeys: number;
+    allowLineSeparatedGroups: boolean;
 };
+export type SortDirection = "asc" | "desc";
+export type SortKeysRuleOptions = [SortDirection, SortOptions];
+export type SortKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>;
+export type Comparator = (a: string, b: string) => boolean;
+export type TopLevelInteropMessageIds = "topLevel";
+export type TopLevelInteropRuleDefinition = import("./types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>;
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
@@ -26,15 +47,13 @@ export type JSONLanguageOptions = {
 /** @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 */
 /**
  * JSON Language Object
- * @implements {Language}
+ * @implements {IJSONLanguage}
  */
-export class JSONLanguage implements Language {
+export class JSONLanguage implements IJSONLanguage {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -95,8 +114,9 @@ export class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
+ * @implements {IJSONSourceCode}
  */
-export class JSONSourceCode extends TextSourceCodeBase {
+export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCode {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -172,92 +192,12 @@ declare namespace plugin {
         let json5: JSONLanguage;
     }
     let rules: {
-        "no-duplicate-keys": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    duplicateKey: string;
-                };
-            };
-            create(context: any): {
-                Object(): void;
-                Member(node: any): void;
-                "Object:exit"(): void;
-            };
-        };
-        "no-empty-keys": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    emptyKey: string;
-                };
-            };
-            create(context: any): {
-                Member(node: any): void;
-            };
-        };
-        "no-unsafe-values": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    unsafeNumber: string;
-                    unsafeInteger: string;
-                    unsafeZero: string;
-                    subnormal: string;
-                    loneSurrogate: string;
-                };
-            };
-            create(context: any): {
-                Number(node: any): void;
-                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;
-            };
-        };
-        "top-level-interop": {
-            meta: {
-                type: "problem";
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    topLevel: string;
-                };
-            };
-            create(context: any): {
-                Document(node: any): void;
-            };
-        };
+        "no-duplicate-keys": NoDuplicateKeysRuleDefinition;
+        "no-empty-keys": NoEmptyKeysRuleDefinition;
+        "no-unsafe-values": NoUnsafeValuesRuleDefinition;
+        "no-unnormalized-keys": NoUnnormalizedKeysRuleDefinition;
+        "sort-keys": SortKeysRuleDefinition;
+        "top-level-interop": TopLevelInteropRuleDefinition;
     };
     namespace configs {
         namespace recommended {