@eslint/json 0.11.0 → 0.12.0

package/README.md

@@ -254,10 +254,11 @@ Apache 2.0
 The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://eslint.org/donate)
 to get your logo on our READMEs and [website](https://eslint.org/sponsors).
 
-<h3>Platinum Sponsors</h3>
+<h3>Diamond Sponsors</h3>
+<p><a href="https://www.ag-grid.com/"><img src="https://images.opencollective.com/ag-grid/2c8d545/logo.png" alt="AG Grid" height="128"></a></p><h3>Platinum Sponsors</h3>
 <p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="128"></a></p><h3>Gold Sponsors</h3>
 <p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://trunk.io/"><img src="https://images.opencollective.com/trunkio/fb92d60/avatar.png" alt="trunk.io" height="96"></a> <a href="https://shopify.engineering/"><img src="https://avatars.githubusercontent.com/u/8085" alt="Shopify" height="96"></a></p><h3>Silver Sponsors</h3>
-<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/e6d15e1/logo.png" alt="Vite" height="64"></a> <a href="https://www.jetbrains.com/"><img src="https://images.opencollective.com/jetbrains/fe76f99/logo.png" alt="JetBrains" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
+<p><a href="https://vite.dev/"><img src="https://images.opencollective.com/vite/e6d15e1/logo.png" alt="Vite" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301" alt="American Express" height="64"></a> <a href="https://stackblitz.com"><img src="https://avatars.githubusercontent.com/u/28635252" alt="StackBlitz" height="64"></a></p><h3>Bronze Sponsors</h3>
 <p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nolebase.ayaka.io"><img src="https://avatars.githubusercontent.com/u/11081491" alt="Neko" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://opensource.mercedes-benz.com/"><img src="https://avatars.githubusercontent.com/u/34240465" alt="Mercedes-Benz Group" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a> <a href="https://www.lambdatest.com"><img src="https://avatars.githubusercontent.com/u/171592363" alt="LambdaTest" height="32"></a></p>
 <h3>Technology Sponsors</h3>
 Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.

package/dist/cjs/index.cjs

@@ -1,3 +1,9 @@
+
+/**
+ * @import { DocumentNode, Node, Token, AnyNode, MemberNode } from "@humanwhocodes/momoa"
+ * @import { SourceLocation, FileProblem, DirectiveType, RulesConfig, TextSourceCode, Language, OkParseResult, ParseResult, File } from "@eslint/core"
+ * @import { JSONSyntaxElement, JSONRuleDefinition } from "./types.ts"
+ */
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -16,19 +22,8 @@ var naturalCompare = require('natural-compare');
 // Types
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("@humanwhocodes/momoa").DocumentNode} DocumentNode */
-/** @typedef {import("@humanwhocodes/momoa").Node} JSONNode */
-/** @typedef {import("@humanwhocodes/momoa").Token} JSONToken */
-/** @typedef {import("@eslint/core").SourceRange} SourceRange */
-/** @typedef {import("@eslint/core").SourceLocation} SourceLocation */
-/** @typedef {import("@eslint/core").File} File */
-/** @typedef {import("@eslint/core").TraversalStep} TraversalStep */
-/** @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
@@ -45,14 +40,14 @@ const INLINE_CONFIG =
 class JSONTraversalStep extends pluginKit.VisitNodeStep {
 	/**
 	 * The target of the step.
-	 * @type {JSONNode}
+	 * @type {Node}
 	 */
 	target = undefined;
 
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options for the step.
-	 * @param {JSONNode} options.target The target of the step.
+	 * @param {Node} options.target The target of the step.
 	 * @param {1|2} options.phase The phase of the step.
 	 * @param {Array<any>} options.args The arguments of the step.
 	 */
@@ -69,7 +64,7 @@ class JSONTraversalStep extends pluginKit.VisitNodeStep {
 
 /**
  * JSON Source Code Object
- * @implements {IJSONSourceCode}
+ * @implements {TextSourceCode<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
 class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 	/**
@@ -80,13 +75,13 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 
 	/**
 	 * Cache of parent nodes.
-	 * @type {WeakMap<JSONNode, JSONNode>}
+	 * @type {WeakMap<Node, Node>}
 	 */
 	#parents = new WeakMap();
 
 	/**
 	 * Collection of inline configuration comments.
-	 * @type {Array<JSONToken>}
+	 * @type {Array<Token>}
 	 */
 	#inlineConfigComments;
 
@@ -98,7 +93,7 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 
 	/**
 	 * The comment node in the source code.
-	 * @type {Array<JSONToken>|undefined}
+	 * @type {Array<Token>|undefined}
 	 */
 	comments;
 
@@ -118,7 +113,7 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 
 	/**
 	 * Returns the value of the given comment.
-	 * @param {JSONToken} comment The comment to get the value of.
+	 * @param {Token} comment The comment to get the value of.
 	 * @returns {string} The value of the comment.
 	 * @throws {Error} When an unexpected comment type is passed.
 	 */
@@ -137,7 +132,7 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 	/**
 	 * Returns an array of all inline configuration nodes found in the
 	 * source code.
-	 * @returns {Array<JSONToken>} An array of all inline configuration nodes.
+	 * @returns {Array<Token>} An array of all inline configuration nodes.
 	 */
 	getInlineConfigNodes() {
 		if (!this.#inlineConfigComments) {
@@ -248,8 +243,8 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 
 	/**
 	 * Returns the parent of the given node.
-	 * @param {JSONNode} node The node to get the parent of.
-	 * @returns {JSONNode|undefined} The parent of the node.
+	 * @param {Node} node The node to get the parent of.
+	 * @returns {Node|undefined} The parent of the node.
 	 */
 	getParent(node) {
 		return this.#parents.get(node);
@@ -296,11 +291,14 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 // Types
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("@eslint/core").Language} Language */
-/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
-/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
-/** @typedef {import("./types.ts").IJSONLanguage} IJSONLanguage */
-/** @typedef {import("./types.ts").JSONLanguageOptions} JSONLanguageOptions */
+/**
+ *
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ *
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -308,7 +306,7 @@ class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 
 /**
  * JSON Language Object
- * @implements {IJSONLanguage}
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
  */
 class JSONLanguage {
 	/**
@@ -385,7 +383,7 @@ class JSONLanguage {
 	 * Parses the given file into an AST.
 	 * @param {File} file The virtual file to parse.
 	 * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
-	 * @returns {ParseResult} The result of parsing.
+	 * @returns {JSONParseResult} The result of parsing.
 	 */
 	parse(file, context) {
 		// Note: BOM already removed
@@ -433,7 +431,7 @@ class JSONLanguage {
 	/**
 	 * Creates a new `JSONSourceCode` object from the given information.
 	 * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-	 * @param {OkParseResult} parseResult The result returned from `parse()`.
+	 * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
 	 * @returns {JSONSourceCode} The new `JSONSourceCode` object.
 	 */
 	createSourceCode(file, parseResult) {
@@ -454,9 +452,11 @@ class JSONLanguage {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"duplicateKey"} NoDuplicateKeysMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>} NoDuplicateKeysRuleDefinition */
-/** @typedef {import("@humanwhocodes/momoa").MemberNode} MemberNode */
+/**
+ *
+ * @typedef {"duplicateKey"} NoDuplicateKeysMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: NoDuplicateKeysMessageIds }>} NoDuplicateKeysRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -523,8 +523,11 @@ const rule$5 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"emptyKey"} NoEmptyKeysMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>} NoEmptyKeysRuleDefinition */
+/**
+ *
+ * @typedef {"emptyKey"} NoEmptyKeysMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: NoEmptyKeysMessageIds }>} NoEmptyKeysRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -572,8 +575,11 @@ const rule$4 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"unsafeNumber"|"unsafeInteger"|"unsafeZero"|"subnormal"|"loneSurrogate"} NoUnsafeValuesMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>} NoUnsafeValuesRuleDefinition */
+/**
+ *
+ * @typedef {"unsafeNumber"|"unsafeInteger"|"unsafeZero"|"subnormal"|"loneSurrogate"} NoUnsafeValuesMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: NoUnsafeValuesMessageIds }>} NoUnsafeValuesRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -720,8 +726,12 @@ const rule$3 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[{form:string}], NoUnnormalizedKeysMessageIds>} NoUnnormalizedKeysRuleDefinition */
+/**
+ *
+ * @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds
+ * @typedef {{ form: string }} NoUnnormalizedKeysOptions
+ * @typedef {JSONRuleDefinition<{ RuleOptions: [NoUnnormalizedKeysOptions], MessageIds: NoUnnormalizedKeysMessageIds }>} NoUnnormalizedKeysRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -790,21 +800,21 @@ const rule$2 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"sortKeys"} SortKeysMessageIds */
-
 /**
+ *
  * @typedef {Object} SortOptions
  * @property {boolean} caseSensitive
  * @property {boolean} natural
  * @property {number} minKeys
  * @property {boolean} allowLineSeparatedGroups
+ *
+ * @typedef {"sortKeys"} SortKeysMessageIds
+ * @typedef {"asc"|"desc"} SortDirection
+ * @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions
+ * @typedef {JSONRuleDefinition<{ RuleOptions: SortKeysRuleOptions, MessageIds: SortKeysMessageIds }>} SortKeysRuleDefinition
+ * @typedef {(a:string,b:string) => boolean} Comparator
  */
 
-/** @typedef {"asc"|"desc"} SortDirection */
-/** @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions */
-/** @typedef {import("./types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>} SortKeysRuleDefinition */
-/** @typedef {(a:string,b:string) => boolean} Comparator */
-
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
@@ -1018,8 +1028,11 @@ const rule$1 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"topLevel"} TopLevelInteropMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>} TopLevelInteropRuleDefinition */
+/**
+ *
+ * @typedef {"topLevel"} TopLevelInteropMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: TopLevelInteropMessageIds }>} TopLevelInteropRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -1070,7 +1083,7 @@ const rule = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.11.0", // x-release-please-version
+		version: "0.12.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),

package/dist/cjs/index.d.cts

@@ -1,59 +1,66 @@
-export type DocumentNode = import("@humanwhocodes/momoa").DocumentNode;
-export type JSONNode = import("@humanwhocodes/momoa").Node;
-export type JSONToken = import("@humanwhocodes/momoa").Token;
-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 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 IJSONLanguage = import("./types.cts").IJSONLanguage;
-export type JSONLanguageOptions = import("./types.cts").JSONLanguageOptions;
+export type JSONOkParseResult = OkParseResult<DocumentNode>;
+export type JSONParseResult = ParseResult<DocumentNode>;
+export type JSONLanguageOptions = {
+    /**
+     * Whether to allow trailing commas in JSONC mode.
+     */
+    allowTrailingCommas?: boolean;
+};
 export type NoDuplicateKeysMessageIds = "duplicateKey";
-export type NoDuplicateKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>;
-export type MemberNode = import("@humanwhocodes/momoa").MemberNode;
+export type NoDuplicateKeysRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoDuplicateKeysMessageIds;
+}>;
 export type NoEmptyKeysMessageIds = "emptyKey";
-export type NoEmptyKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>;
+export type NoEmptyKeysRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoEmptyKeysMessageIds;
+}>;
 export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
-export type NoUnsafeValuesRuleDefinition = import("./types.cts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>;
+export type NoUnsafeValuesRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoUnsafeValuesMessageIds;
+}>;
 export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
-export type NoUnnormalizedKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<[{
+export type NoUnnormalizedKeysOptions = {
     form: string;
-}], NoUnnormalizedKeysMessageIds>;
-export type SortKeysMessageIds = "sortKeys";
+};
+export type NoUnnormalizedKeysRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: [NoUnnormalizedKeysOptions];
+    MessageIds: NoUnnormalizedKeysMessageIds;
+}>;
 export type SortOptions = {
     caseSensitive: boolean;
     natural: boolean;
     minKeys: number;
     allowLineSeparatedGroups: boolean;
 };
+export type SortKeysMessageIds = "sortKeys";
 export type SortDirection = "asc" | "desc";
 export type SortKeysRuleOptions = [SortDirection, SortOptions];
-export type SortKeysRuleDefinition = import("./types.cts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>;
+export type SortKeysRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: SortKeysRuleOptions;
+    MessageIds: SortKeysMessageIds;
+}>;
 export type Comparator = (a: string, b: string) => boolean;
 export type TopLevelInteropMessageIds = "topLevel";
-export type TopLevelInteropRuleDefinition = import("./types.cts").JSONRuleDefinition<[], TopLevelInteropMessageIds>;
+export type TopLevelInteropRuleDefinition = JSONRuleDefinition<{
+    MessageIds: TopLevelInteropMessageIds;
+}>;
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
  */
-/** @typedef {import("@eslint/core").Language} Language */
-/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
-/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
-/** @typedef {import("./types.cts").IJSONLanguage} IJSONLanguage */
-/** @typedef {import("./types.cts").JSONLanguageOptions} JSONLanguageOptions */
+/**
+ *
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ *
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
 /**
  * JSON Language Object
- * @implements {IJSONLanguage}
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
  */
-export class JSONLanguage implements IJSONLanguage {
+export class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -98,25 +105,25 @@ export class JSONLanguage implements IJSONLanguage {
      * Parses the given file into an AST.
      * @param {File} file The virtual file to parse.
      * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
-     * @returns {ParseResult} The result of parsing.
+     * @returns {JSONParseResult} The result of parsing.
      */
     parse(file: File, context: {
         languageOptions: JSONLanguageOptions;
-    }): ParseResult;
+    }): JSONParseResult;
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-     * @param {OkParseResult} parseResult The result returned from `parse()`.
+     * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
      * @returns {JSONSourceCode} The new `JSONSourceCode` object.
      */
-    createSourceCode(file: File, parseResult: OkParseResult): JSONSourceCode;
+    createSourceCode(file: File, parseResult: JSONOkParseResult): JSONSourceCode;
     #private;
 }
 /**
  * JSON Source Code Object
- * @implements {IJSONSourceCode}
+ * @implements {TextSourceCode<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
-export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -134,15 +141,15 @@ export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCod
     ast: DocumentNode;
     /**
      * The comment node in the source code.
-     * @type {Array<JSONToken>|undefined}
+     * @type {Array<Token>|undefined}
      */
-    comments: Array<JSONToken> | undefined;
+    comments: Array<Token> | undefined;
     /**
      * Returns an array of all inline configuration nodes found in the
      * source code.
-     * @returns {Array<JSONToken>} An array of all inline configuration nodes.
+     * @returns {Array<Token>} An array of all inline configuration nodes.
      */
-    getInlineConfigNodes(): Array<JSONToken>;
+    getInlineConfigNodes(): Array<Token>;
     /**
      * Returns directives that enable or disable rules along with any problems
      * encountered while parsing the directives.
@@ -170,10 +177,10 @@ export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCod
     };
     /**
      * Returns the parent of the given node.
-     * @param {JSONNode} node The node to get the parent of.
-     * @returns {JSONNode|undefined} The parent of the node.
+     * @param {Node} node The node to get the parent of.
+     * @returns {Node|undefined} The parent of the node.
      */
-    getParent(node: JSONNode): JSONNode | undefined;
+    getParent(node: Node): Node | undefined;
     /**
      * Traverse the source code and return the steps that were taken.
      * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
@@ -212,8 +219,20 @@ declare namespace plugin {
         }
     }
 }
+import type { DocumentNode } from "@humanwhocodes/momoa";
+import type { OkParseResult } from "@eslint/core";
+import type { ParseResult } from "@eslint/core";
+import type { JSONRuleDefinition } from "./types.cts";
+import type { Language } from "@eslint/core";
+import type { File } from "@eslint/core";
+import type { TextSourceCode } from "@eslint/core";
 import { TextSourceCodeBase } from '@eslint/plugin-kit';
+import type { Token } from "@humanwhocodes/momoa";
+import type { FileProblem } from "@eslint/core";
 import { Directive } from '@eslint/plugin-kit';
+import type { RulesConfig } from "@eslint/core";
+import type { SourceLocation } from "@eslint/core";
+import type { Node } from "@humanwhocodes/momoa";
 /**
  * A class to represent a step in the traversal process.
  */
@@ -221,20 +240,20 @@ declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
-     * @param {JSONNode} options.target The target of the step.
+     * @param {Node} options.target The target of the step.
      * @param {1|2} options.phase The phase of the step.
      * @param {Array<any>} options.args The arguments of the step.
      */
     constructor({ target, phase, args }: {
-        target: JSONNode;
+        target: Node;
         phase: 1 | 2;
         args: Array<any>;
     });
     /**
      * The target of the step.
-     * @type {JSONNode}
+     * @type {Node}
      */
-    target: JSONNode;
+    target: Node;
 }
 import { VisitNodeStep } from '@eslint/plugin-kit';
 export { plugin as default };

package/dist/cjs/types.cts

@@ -7,14 +7,8 @@
 // Imports
 //------------------------------------------------------------------------------
 
+import type { RuleVisitor, RuleDefinition } from "@eslint/core";
 import type {
-	RuleVisitor,
-	TextSourceCode,
-	Language,
-	LanguageOptions,
-	RuleDefinition,
-} from "@eslint/core";
-import {
 	DocumentNode,
 	MemberNode,
 	ElementNode,
@@ -30,6 +24,7 @@ import {
 	AnyNode,
 	Token,
 } from "@humanwhocodes/momoa";
+import type { JSONLanguageOptions, JSONSourceCode } from "./index.cjs";
 
 //------------------------------------------------------------------------------
 // Types
@@ -42,16 +37,6 @@ type ValueNodeParent = DocumentNode | MemberNode | ElementNode;
  */
 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.
  */
@@ -83,56 +68,25 @@ export interface JSONRuleVisitor extends RuleVisitor {
 	"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 JSONRuleDefinitionTypeOptions = {
+	RuleOptions: unknown[];
+	MessageIds: string;
+	ExtRuleDocs: Record<string, unknown>;
+};
 
 export type JSONRuleDefinition<
-	JSONRuleOptions extends unknown[],
-	JSONRuleMessageIds extends string = "",
-> = RuleDefinition<{
-	LangOptions: JSONLanguageOptions;
-	Code: IJSONSourceCode;
-	RuleOptions: JSONRuleOptions;
-	Visitor: JSONRuleVisitor;
-	Node: AnyNode;
-	MessageIds: JSONRuleMessageIds;
-	ExtRuleDocs: {};
-}>;
+	Options extends Partial<JSONRuleDefinitionTypeOptions> = {},
+> = RuleDefinition<
+	// Language specific type options (non-configurable)
+	{
+		LangOptions: JSONLanguageOptions;
+		Code: JSONSourceCode;
+		Visitor: JSONRuleVisitor;
+		Node: AnyNode;
+	} & Required<
+		// Rule specific type options (custom)
+		Options &
+			// Rule specific type options (defaults)
+			Omit<JSONRuleDefinitionTypeOptions, keyof Options>
+	>
+>;

package/dist/esm/index.d.ts

@@ -1,59 +1,66 @@
-export type DocumentNode = import("@humanwhocodes/momoa").DocumentNode;
-export type JSONNode = import("@humanwhocodes/momoa").Node;
-export type JSONToken = import("@humanwhocodes/momoa").Token;
-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 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 IJSONLanguage = import("./types.ts").IJSONLanguage;
-export type JSONLanguageOptions = import("./types.ts").JSONLanguageOptions;
+export type JSONOkParseResult = OkParseResult<DocumentNode>;
+export type JSONParseResult = ParseResult<DocumentNode>;
+export type JSONLanguageOptions = {
+    /**
+     * Whether to allow trailing commas in JSONC mode.
+     */
+    allowTrailingCommas?: boolean;
+};
 export type NoDuplicateKeysMessageIds = "duplicateKey";
-export type NoDuplicateKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>;
-export type MemberNode = import("@humanwhocodes/momoa").MemberNode;
+export type NoDuplicateKeysRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoDuplicateKeysMessageIds;
+}>;
 export type NoEmptyKeysMessageIds = "emptyKey";
-export type NoEmptyKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>;
+export type NoEmptyKeysRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoEmptyKeysMessageIds;
+}>;
 export type NoUnsafeValuesMessageIds = "unsafeNumber" | "unsafeInteger" | "unsafeZero" | "subnormal" | "loneSurrogate";
-export type NoUnsafeValuesRuleDefinition = import("./types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>;
+export type NoUnsafeValuesRuleDefinition = JSONRuleDefinition<{
+    MessageIds: NoUnsafeValuesMessageIds;
+}>;
 export type NoUnnormalizedKeysMessageIds = "unnormalizedKey";
-export type NoUnnormalizedKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<[{
+export type NoUnnormalizedKeysOptions = {
     form: string;
-}], NoUnnormalizedKeysMessageIds>;
-export type SortKeysMessageIds = "sortKeys";
+};
+export type NoUnnormalizedKeysRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: [NoUnnormalizedKeysOptions];
+    MessageIds: NoUnnormalizedKeysMessageIds;
+}>;
 export type SortOptions = {
     caseSensitive: boolean;
     natural: boolean;
     minKeys: number;
     allowLineSeparatedGroups: boolean;
 };
+export type SortKeysMessageIds = "sortKeys";
 export type SortDirection = "asc" | "desc";
 export type SortKeysRuleOptions = [SortDirection, SortOptions];
-export type SortKeysRuleDefinition = import("./types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>;
+export type SortKeysRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: SortKeysRuleOptions;
+    MessageIds: SortKeysMessageIds;
+}>;
 export type Comparator = (a: string, b: string) => boolean;
 export type TopLevelInteropMessageIds = "topLevel";
-export type TopLevelInteropRuleDefinition = import("./types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>;
+export type TopLevelInteropRuleDefinition = JSONRuleDefinition<{
+    MessageIds: TopLevelInteropMessageIds;
+}>;
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
  */
-/** @typedef {import("@eslint/core").Language} Language */
-/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
-/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
-/** @typedef {import("./types.ts").IJSONLanguage} IJSONLanguage */
-/** @typedef {import("./types.ts").JSONLanguageOptions} JSONLanguageOptions */
+/**
+ *
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ *
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
 /**
  * JSON Language Object
- * @implements {IJSONLanguage}
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
  */
-export class JSONLanguage implements IJSONLanguage {
+export class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -98,25 +105,25 @@ export class JSONLanguage implements IJSONLanguage {
      * Parses the given file into an AST.
      * @param {File} file The virtual file to parse.
      * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
-     * @returns {ParseResult} The result of parsing.
+     * @returns {JSONParseResult} The result of parsing.
      */
     parse(file: File, context: {
         languageOptions: JSONLanguageOptions;
-    }): ParseResult;
+    }): JSONParseResult;
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-     * @param {OkParseResult} parseResult The result returned from `parse()`.
+     * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
      * @returns {JSONSourceCode} The new `JSONSourceCode` object.
      */
-    createSourceCode(file: File, parseResult: OkParseResult): JSONSourceCode;
+    createSourceCode(file: File, parseResult: JSONOkParseResult): JSONSourceCode;
     #private;
 }
 /**
  * JSON Source Code Object
- * @implements {IJSONSourceCode}
+ * @implements {TextSourceCode<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
-export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase implements TextSourceCode {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -134,15 +141,15 @@ export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCod
     ast: DocumentNode;
     /**
      * The comment node in the source code.
-     * @type {Array<JSONToken>|undefined}
+     * @type {Array<Token>|undefined}
      */
-    comments: Array<JSONToken> | undefined;
+    comments: Array<Token> | undefined;
     /**
      * Returns an array of all inline configuration nodes found in the
      * source code.
-     * @returns {Array<JSONToken>} An array of all inline configuration nodes.
+     * @returns {Array<Token>} An array of all inline configuration nodes.
      */
-    getInlineConfigNodes(): Array<JSONToken>;
+    getInlineConfigNodes(): Array<Token>;
     /**
      * Returns directives that enable or disable rules along with any problems
      * encountered while parsing the directives.
@@ -170,10 +177,10 @@ export class JSONSourceCode extends TextSourceCodeBase implements IJSONSourceCod
     };
     /**
      * Returns the parent of the given node.
-     * @param {JSONNode} node The node to get the parent of.
-     * @returns {JSONNode|undefined} The parent of the node.
+     * @param {Node} node The node to get the parent of.
+     * @returns {Node|undefined} The parent of the node.
      */
-    getParent(node: JSONNode): JSONNode | undefined;
+    getParent(node: Node): Node | undefined;
     /**
      * Traverse the source code and return the steps that were taken.
      * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
@@ -212,8 +219,20 @@ declare namespace plugin {
         }
     }
 }
+import type { DocumentNode } from "@humanwhocodes/momoa";
+import type { OkParseResult } from "@eslint/core";
+import type { ParseResult } from "@eslint/core";
+import type { JSONRuleDefinition } from "./types.ts";
+import type { Language } from "@eslint/core";
+import type { File } from "@eslint/core";
+import type { TextSourceCode } from "@eslint/core";
 import { TextSourceCodeBase } from '@eslint/plugin-kit';
+import type { Token } from "@humanwhocodes/momoa";
+import type { FileProblem } from "@eslint/core";
 import { Directive } from '@eslint/plugin-kit';
+import type { RulesConfig } from "@eslint/core";
+import type { SourceLocation } from "@eslint/core";
+import type { Node } from "@humanwhocodes/momoa";
 /**
  * A class to represent a step in the traversal process.
  */
@@ -221,20 +240,20 @@ declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
-     * @param {JSONNode} options.target The target of the step.
+     * @param {Node} options.target The target of the step.
      * @param {1|2} options.phase The phase of the step.
      * @param {Array<any>} options.args The arguments of the step.
      */
     constructor({ target, phase, args }: {
-        target: JSONNode;
+        target: Node;
         phase: 1 | 2;
         args: Array<any>;
     });
     /**
      * The target of the step.
-     * @type {JSONNode}
+     * @type {Node}
      */
-    target: JSONNode;
+    target: Node;
 }
 import { VisitNodeStep } from '@eslint/plugin-kit';
 export { plugin as default };

package/dist/esm/index.js

@@ -1,3 +1,9 @@
+
+/**
+ * @import { DocumentNode, Node, Token, AnyNode, MemberNode } from "@humanwhocodes/momoa"
+ * @import { SourceLocation, FileProblem, DirectiveType, RulesConfig, TextSourceCode, Language, OkParseResult, ParseResult, File } from "@eslint/core"
+ * @import { JSONSyntaxElement, JSONRuleDefinition } from "./types.ts"
+ */
 // @ts-self-types="./index.d.ts"
 import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
 import { ConfigCommentParser, TextSourceCodeBase, Directive, VisitNodeStep } from '@eslint/plugin-kit';
@@ -13,19 +19,8 @@ import naturalCompare from 'natural-compare';
 // Types
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("@humanwhocodes/momoa").DocumentNode} DocumentNode */
-/** @typedef {import("@humanwhocodes/momoa").Node} JSONNode */
-/** @typedef {import("@humanwhocodes/momoa").Token} JSONToken */
-/** @typedef {import("@eslint/core").SourceRange} SourceRange */
-/** @typedef {import("@eslint/core").SourceLocation} SourceLocation */
-/** @typedef {import("@eslint/core").File} File */
-/** @typedef {import("@eslint/core").TraversalStep} TraversalStep */
-/** @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
@@ -42,14 +37,14 @@ const INLINE_CONFIG =
 class JSONTraversalStep extends VisitNodeStep {
 	/**
 	 * The target of the step.
-	 * @type {JSONNode}
+	 * @type {Node}
 	 */
 	target = undefined;
 
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options for the step.
-	 * @param {JSONNode} options.target The target of the step.
+	 * @param {Node} options.target The target of the step.
 	 * @param {1|2} options.phase The phase of the step.
 	 * @param {Array<any>} options.args The arguments of the step.
 	 */
@@ -66,7 +61,7 @@ class JSONTraversalStep extends VisitNodeStep {
 
 /**
  * JSON Source Code Object
- * @implements {IJSONSourceCode}
+ * @implements {TextSourceCode<{LangOptions: JSONLanguageOptions, RootNode: DocumentNode, SyntaxElementWithLoc: JSONSyntaxElement, ConfigNode: Token}>}
  */
 class JSONSourceCode extends TextSourceCodeBase {
 	/**
@@ -77,13 +72,13 @@ class JSONSourceCode extends TextSourceCodeBase {
 
 	/**
 	 * Cache of parent nodes.
-	 * @type {WeakMap<JSONNode, JSONNode>}
+	 * @type {WeakMap<Node, Node>}
 	 */
 	#parents = new WeakMap();
 
 	/**
 	 * Collection of inline configuration comments.
-	 * @type {Array<JSONToken>}
+	 * @type {Array<Token>}
 	 */
 	#inlineConfigComments;
 
@@ -95,7 +90,7 @@ class JSONSourceCode extends TextSourceCodeBase {
 
 	/**
 	 * The comment node in the source code.
-	 * @type {Array<JSONToken>|undefined}
+	 * @type {Array<Token>|undefined}
 	 */
 	comments;
 
@@ -115,7 +110,7 @@ class JSONSourceCode extends TextSourceCodeBase {
 
 	/**
 	 * Returns the value of the given comment.
-	 * @param {JSONToken} comment The comment to get the value of.
+	 * @param {Token} comment The comment to get the value of.
 	 * @returns {string} The value of the comment.
 	 * @throws {Error} When an unexpected comment type is passed.
 	 */
@@ -134,7 +129,7 @@ class JSONSourceCode extends TextSourceCodeBase {
 	/**
 	 * Returns an array of all inline configuration nodes found in the
 	 * source code.
-	 * @returns {Array<JSONToken>} An array of all inline configuration nodes.
+	 * @returns {Array<Token>} An array of all inline configuration nodes.
 	 */
 	getInlineConfigNodes() {
 		if (!this.#inlineConfigComments) {
@@ -245,8 +240,8 @@ class JSONSourceCode extends TextSourceCodeBase {
 
 	/**
 	 * Returns the parent of the given node.
-	 * @param {JSONNode} node The node to get the parent of.
-	 * @returns {JSONNode|undefined} The parent of the node.
+	 * @param {Node} node The node to get the parent of.
+	 * @returns {Node|undefined} The parent of the node.
 	 */
 	getParent(node) {
 		return this.#parents.get(node);
@@ -293,11 +288,14 @@ class JSONSourceCode extends TextSourceCodeBase {
 // Types
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("@eslint/core").Language} Language */
-/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
-/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
-/** @typedef {import("./types.ts").IJSONLanguage} IJSONLanguage */
-/** @typedef {import("./types.ts").JSONLanguageOptions} JSONLanguageOptions */
+/**
+ *
+ * @typedef {OkParseResult<DocumentNode>} JSONOkParseResult
+ * @typedef {ParseResult<DocumentNode>} JSONParseResult
+ *
+ * @typedef {Object} JSONLanguageOptions
+ * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas in JSONC mode.
+ */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -305,7 +303,7 @@ class JSONSourceCode extends TextSourceCodeBase {
 
 /**
  * JSON Language Object
- * @implements {IJSONLanguage}
+ * @implements {Language<{ LangOptions: JSONLanguageOptions; Code: JSONSourceCode; RootNode: DocumentNode; Node: AnyNode }>}
  */
 class JSONLanguage {
 	/**
@@ -382,7 +380,7 @@ class JSONLanguage {
 	 * Parses the given file into an AST.
 	 * @param {File} file The virtual file to parse.
 	 * @param {{languageOptions: JSONLanguageOptions}} context The options to use for parsing.
-	 * @returns {ParseResult} The result of parsing.
+	 * @returns {JSONParseResult} The result of parsing.
 	 */
 	parse(file, context) {
 		// Note: BOM already removed
@@ -430,7 +428,7 @@ class JSONLanguage {
 	/**
 	 * Creates a new `JSONSourceCode` object from the given information.
 	 * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-	 * @param {OkParseResult} parseResult The result returned from `parse()`.
+	 * @param {JSONOkParseResult} parseResult The result returned from `parse()`.
 	 * @returns {JSONSourceCode} The new `JSONSourceCode` object.
 	 */
 	createSourceCode(file, parseResult) {
@@ -451,9 +449,11 @@ class JSONLanguage {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"duplicateKey"} NoDuplicateKeysMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>} NoDuplicateKeysRuleDefinition */
-/** @typedef {import("@humanwhocodes/momoa").MemberNode} MemberNode */
+/**
+ *
+ * @typedef {"duplicateKey"} NoDuplicateKeysMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: NoDuplicateKeysMessageIds }>} NoDuplicateKeysRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -520,8 +520,11 @@ const rule$5 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"emptyKey"} NoEmptyKeysMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>} NoEmptyKeysRuleDefinition */
+/**
+ *
+ * @typedef {"emptyKey"} NoEmptyKeysMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: NoEmptyKeysMessageIds }>} NoEmptyKeysRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -569,8 +572,11 @@ const rule$4 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"unsafeNumber"|"unsafeInteger"|"unsafeZero"|"subnormal"|"loneSurrogate"} NoUnsafeValuesMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>} NoUnsafeValuesRuleDefinition */
+/**
+ *
+ * @typedef {"unsafeNumber"|"unsafeInteger"|"unsafeZero"|"subnormal"|"loneSurrogate"} NoUnsafeValuesMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: NoUnsafeValuesMessageIds }>} NoUnsafeValuesRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -717,8 +723,12 @@ const rule$3 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[{form:string}], NoUnnormalizedKeysMessageIds>} NoUnnormalizedKeysRuleDefinition */
+/**
+ *
+ * @typedef {"unnormalizedKey"} NoUnnormalizedKeysMessageIds
+ * @typedef {{ form: string }} NoUnnormalizedKeysOptions
+ * @typedef {JSONRuleDefinition<{ RuleOptions: [NoUnnormalizedKeysOptions], MessageIds: NoUnnormalizedKeysMessageIds }>} NoUnnormalizedKeysRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -787,21 +797,21 @@ const rule$2 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"sortKeys"} SortKeysMessageIds */
-
 /**
+ *
  * @typedef {Object} SortOptions
  * @property {boolean} caseSensitive
  * @property {boolean} natural
  * @property {number} minKeys
  * @property {boolean} allowLineSeparatedGroups
+ *
+ * @typedef {"sortKeys"} SortKeysMessageIds
+ * @typedef {"asc"|"desc"} SortDirection
+ * @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions
+ * @typedef {JSONRuleDefinition<{ RuleOptions: SortKeysRuleOptions, MessageIds: SortKeysMessageIds }>} SortKeysRuleDefinition
+ * @typedef {(a:string,b:string) => boolean} Comparator
  */
 
-/** @typedef {"asc"|"desc"} SortDirection */
-/** @typedef {[SortDirection, SortOptions]} SortKeysRuleOptions */
-/** @typedef {import("./types.ts").JSONRuleDefinition<SortKeysRuleOptions, SortKeysMessageIds>} SortKeysRuleDefinition */
-/** @typedef {(a:string,b:string) => boolean} Comparator */
-
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
@@ -1015,8 +1025,11 @@ const rule$1 = {
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {"topLevel"} TopLevelInteropMessageIds */
-/** @typedef {import("./types.ts").JSONRuleDefinition<[], TopLevelInteropMessageIds>} TopLevelInteropRuleDefinition */
+/**
+ *
+ * @typedef {"topLevel"} TopLevelInteropMessageIds
+ * @typedef {JSONRuleDefinition<{ MessageIds: TopLevelInteropMessageIds }>} TopLevelInteropRuleDefinition
+ */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
@@ -1067,7 +1080,7 @@ const rule = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.11.0", // x-release-please-version
+		version: "0.12.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),

package/dist/esm/types.d.ts

@@ -2,22 +2,14 @@
  * @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";
+import type { RuleVisitor, RuleDefinition } from "@eslint/core";
+import type { DocumentNode, MemberNode, ElementNode, ObjectNode, ArrayNode, StringNode, NullNode, NumberNode, BooleanNode, NaNNode, InfinityNode, IdentifierNode, AnyNode, Token } from "@humanwhocodes/momoa";
+import type { JSONLanguageOptions, JSONSourceCode } from "./index.js";
 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.
  */
@@ -47,45 +39,15 @@ export interface JSONRuleVisitor extends RuleVisitor {
     "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<{
+export type JSONRuleDefinitionTypeOptions = {
+    RuleOptions: unknown[];
+    MessageIds: string;
+    ExtRuleDocs: Record<string, unknown>;
+};
+export type JSONRuleDefinition<Options extends Partial<JSONRuleDefinitionTypeOptions> = {}> = RuleDefinition<{
     LangOptions: JSONLanguageOptions;
-    Code: IJSONSourceCode;
-    RuleOptions: JSONRuleOptions;
+    Code: JSONSourceCode;
     Visitor: JSONRuleVisitor;
     Node: AnyNode;
-    MessageIds: JSONRuleMessageIds;
-    ExtRuleDocs: {};
-}>;
+} & Required<Options & Omit<JSONRuleDefinitionTypeOptions, keyof Options>>>;
 export {};

package/dist/esm/types.ts

@@ -7,14 +7,8 @@
 // Imports
 //------------------------------------------------------------------------------
 
+import type { RuleVisitor, RuleDefinition } from "@eslint/core";
 import type {
-	RuleVisitor,
-	TextSourceCode,
-	Language,
-	LanguageOptions,
-	RuleDefinition,
-} from "@eslint/core";
-import {
 	DocumentNode,
 	MemberNode,
 	ElementNode,
@@ -30,6 +24,7 @@ import {
 	AnyNode,
 	Token,
 } from "@humanwhocodes/momoa";
+import type { JSONLanguageOptions, JSONSourceCode } from "./index.js";
 
 //------------------------------------------------------------------------------
 // Types
@@ -42,16 +37,6 @@ type ValueNodeParent = DocumentNode | MemberNode | ElementNode;
  */
 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.
  */
@@ -83,56 +68,25 @@ export interface JSONRuleVisitor extends RuleVisitor {
 	"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 JSONRuleDefinitionTypeOptions = {
+	RuleOptions: unknown[];
+	MessageIds: string;
+	ExtRuleDocs: Record<string, unknown>;
+};
 
 export type JSONRuleDefinition<
-	JSONRuleOptions extends unknown[],
-	JSONRuleMessageIds extends string = "",
-> = RuleDefinition<{
-	LangOptions: JSONLanguageOptions;
-	Code: IJSONSourceCode;
-	RuleOptions: JSONRuleOptions;
-	Visitor: JSONRuleVisitor;
-	Node: AnyNode;
-	MessageIds: JSONRuleMessageIds;
-	ExtRuleDocs: {};
-}>;
+	Options extends Partial<JSONRuleDefinitionTypeOptions> = {},
+> = RuleDefinition<
+	// Language specific type options (non-configurable)
+	{
+		LangOptions: JSONLanguageOptions;
+		Code: JSONSourceCode;
+		Visitor: JSONRuleVisitor;
+		Node: AnyNode;
+	} & Required<
+		// Rule specific type options (custom)
+		Options &
+			// Rule specific type options (defaults)
+			Omit<JSONRuleDefinitionTypeOptions, keyof Options>
+	>
+>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -81,7 +81,7 @@
   "devDependencies": {
     "c8": "^9.1.0",
     "dedent": "^1.5.3",
-    "eslint": "^9.11.1",
+    "eslint": "^9.23.0",
     "eslint-config-eslint": "^11.0.0",
     "eslint-plugin-eslint-plugin": "^6.3.2",
     "got": "^14.4.2",
@@ -90,6 +90,7 @@
     "prettier": "^3.4.1",
     "rollup": "^4.16.2",
     "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-delete": "^3.0.1",
     "typescript": "^5.4.5",
     "yorkie": "^2.0.0"
   },