@eslint/json 0.3.0 → 0.4.1

package/README.md

@@ -75,6 +75,47 @@ export default [
 ];
 ```
 
+In CommonJS format:
+
+```js
+const json = require("@eslint/json").default;
+
+module.exports = [
+	{
+		plugins: {
+			json,
+		},
+	},
+
+	// lint JSON files
+	{
+		files: ["**/*.json"],
+		language: "json/json",
+		rules: {
+			"json/no-duplicate-keys": "error",
+		},
+	},
+
+	// lint JSONC files
+	{
+		files: ["**/*.jsonc", ".vscode/*.json"],
+		language: "json/jsonc",
+		rules: {
+			"json/no-duplicate-keys": "error",
+		},
+	},
+
+	// lint JSON5 files
+	{
+		files: ["**/*.json5"],
+		language: "json/json5",
+		rules: {
+			"json/no-duplicate-keys": "error",
+		},
+	},
+];
+```
+
 ## Recommended Configuration
 
 To use the recommended configuration for this plugin, specify your matching `files` and then use the `json.configs.recommended` object, like this:
@@ -114,6 +155,34 @@ export default [
 -   `no-duplicate-keys` - warns when there are two keys in an object with the same text.
 -   `no-empty-keys` - warns when there is a key in an object that is an empty string or contains only whitespace (note: `package-lock.json` uses empty keys intentionally)
 
+## Frequently Asked Questions
+
+### How does this relate to `eslint-plugin-json` and `eslint-plugin-jsonc`?
+
+This plugin implements JSON parsing for ESLint using the language plugins API, which is the official way of supporting non-JavaScript languages in ESLint. This differs from the other plugins:
+
+-   `eslint-plugin-json` uses a processor to parse the JSON, meaning it doesn't create an AST and you can't write custom rules for it.
+-   `eslint-plugin-jsonc` uses a parser that still goes through the JavaScript linting functionality and requires several rules to disallow valid JavaScript syntax that is invalid in JSON.
+
+As such, this plugin is more robust and faster than the others. You can write your own custom rules when using the languages in this plugin, too.
+
+### What about missing rules that are available in `eslint-plugin-json` and `eslint-plugin-jsonc`?
+
+Most of the rules in `eslint-plugin-json` are actually syntax errors that are caught automatically by the parser used in this plugin.
+
+Similarly, many of the rules in `eslint-plugin-jsonc` specifically disallow valid JavaScript syntax that is invalid in the context of JSON. These are also automatically caught by the parser in this plugin.
+
+Any other rules that catch potential problems in JSON are welcome to be implemented. You can [open an issue](https://github.com/eslint/json/issues/new/choose) to propose a new rule.
+
 ## License
 
 Apache 2.0
+
+## Sponsors
+
+<!-- NOTE: This section is autogenerated. Do not manually edit.-->
+<!--sponsorsstart-->
+<!--sponsorsend-->
+
+<!--techsponsorsstart-->
+<!--techsponsorsend-->

package/dist/cjs/index.cjs

@@ -1,6 +1,9 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var momoa = require('@humanwhocodes/momoa');
+var pluginKit = require('@eslint/plugin-kit');
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -28,41 +31,13 @@ var momoa = require('@humanwhocodes/momoa');
 
 /**
  * A class to represent a step in the traversal process.
- * @implements {VisitTraversalStep}
  */
-class JSONTraversalStep {
-	/**
-	 * The type of the step.
-	 * @type {"visit"}
-	 * @readonly
-	 */
-	type = "visit";
-
-	/**
-	 * The kind of the step. Represents the same data as the `type` property
-	 * but it's a number for performance.
-	 * @type {1}
-	 * @readonly
-	 */
-	kind = 1;
-
+class JSONTraversalStep extends pluginKit.VisitNodeStep {
 	/**
 	 * The target of the step.
 	 * @type {JSONNode}
 	 */
-	target;
-
-	/**
-	 * The phase of the step.
-	 * @type {1|2}
-	 */
-	phase;
-
-	/**
-	 * The arguments of the step.
-	 * @type {Array<any>}
-	 */
-	args;
+	target = undefined;
 
 	/**
 	 * Creates a new instance.
@@ -72,9 +47,9 @@ class JSONTraversalStep {
 	 * @param {Array<any>} options.args The arguments of the step.
 	 */
 	constructor({ target, phase, args }) {
+		super({ target, phase, args });
+
 		this.target = target;
-		this.phase = phase;
-		this.args = args;
 	}
 }
 
@@ -84,9 +59,8 @@ class JSONTraversalStep {
 
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-class JSONSourceCode {
+class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 	/**
 	 * Cached traversal steps.
 	 * @type {Array<JSONTraversalStep>|undefined}
@@ -99,23 +73,11 @@ class JSONSourceCode {
 	 */
 	#parents = new WeakMap();
 
-	/**
-	 * The lines of text in the source code.
-	 * @type {Array<string>}
-	 */
-	#lines;
-
 	/**
 	 * The AST of the source code.
 	 * @type {DocumentNode}
 	 */
-	ast;
-
-	/**
-	 * The text of the source code.
-	 * @type {string}
-	 */
-	text;
+	ast = undefined;
 
 	/**
 	 * The comment node in the source code.
@@ -130,35 +92,13 @@ class JSONSourceCode {
 	 * @param {DocumentNode} options.ast The root AST node.
 	 */
 	constructor({ text, ast }) {
+		super({ text, ast });
 		this.ast = ast;
-		this.text = text;
-		this.comments = ast.tokens.filter(token =>
-			token.type.endsWith("Comment"),
-		);
-	}
-
-	/* eslint-disable class-methods-use-this -- Required to complete interface. */
-
-	/**
-	 * Returns the loc information for the given node or token.
-	 * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the loc information for.
-	 * @returns {SourceLocation} The loc information for the node or token.
-	 */
-	getLoc(nodeOrToken) {
-		return nodeOrToken.loc;
+		this.comments = ast.tokens
+			? ast.tokens.filter(token => token.type.endsWith("Comment"))
+			: [];
 	}
 
-	/**
-	 * Returns the range information for the given node or token.
-	 * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the range information for.
-	 * @returns {SourceRange} The range information for the node or token.
-	 */
-	getRange(nodeOrToken) {
-		return nodeOrToken.range;
-	}
-
-	/* eslint-enable class-methods-use-this -- Required to complete interface. */
-
 	/**
 	 * Returns the parent of the given node.
 	 * @param {JSONNode} node The node to get the parent of.
@@ -168,61 +108,6 @@ class JSONSourceCode {
 		return this.#parents.get(node);
 	}
 
-	/**
-	 * Gets all the ancestors of a given node
-	 * @param {JSONNode} node The node
-	 * @returns {Array<JSONNode>} All the ancestor nodes in the AST, not including the provided node, starting
-	 * from the root node at index 0 and going inwards to the parent node.
-	 * @throws {TypeError} When `node` is missing.
-	 */
-	getAncestors(node) {
-		if (!node) {
-			throw new TypeError("Missing required argument: node.");
-		}
-
-		const ancestorsStartingAtParent = [];
-
-		for (
-			let ancestor = this.#parents.get(node);
-			ancestor;
-			ancestor = this.#parents.get(ancestor)
-		) {
-			ancestorsStartingAtParent.push(ancestor);
-		}
-
-		return ancestorsStartingAtParent.reverse();
-	}
-
-	/**
-	 * Gets the source code for the given node.
-	 * @param {JSONNode} [node] The AST node to get the text for.
-	 * @param {number} [beforeCount] The number of characters before the node to retrieve.
-	 * @param {number} [afterCount] The number of characters after the node to retrieve.
-	 * @returns {string} The text representing the AST node.
-	 * @public
-	 */
-	getText(node, beforeCount, afterCount) {
-		if (node) {
-			return this.text.slice(
-				Math.max(node.range[0] - (beforeCount || 0), 0),
-				node.range[1] + (afterCount || 0),
-			);
-		}
-		return this.text;
-	}
-
-	/**
-	 * Gets the entire source text split into an array of lines.
-	 * @returns {Array} The source text as an array of lines.
-	 * @public
-	 */
-	get lines() {
-		if (!this.#lines) {
-			this.#lines = this.text.split(/\r?\n/gu);
-		}
-		return this.#lines;
-	}
-
 	/**
 	 * Traverse the source code and return the steps that were taken.
 	 * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
@@ -237,7 +122,10 @@ class JSONSourceCode {
 		const steps = (this.#steps = []);
 
 		for (const { node, parent, phase } of momoa.iterator(this.ast)) {
-			this.#parents.set(node, parent);
+			if (parent) {
+				this.#parents.set(node, parent);
+			}
+
 			steps.push(
 				new JSONTraversalStep({
 					target: node,
@@ -498,7 +386,7 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.3.0", // x-release-please-version
+		version: "0.4.1", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -522,4 +410,6 @@ Object.assign(plugin.configs, {
 	},
 });
 
-module.exports = plugin;
+exports.JSONLanguage = JSONLanguage;
+exports.JSONSourceCode = JSONSourceCode;
+exports.default = plugin;

package/dist/cjs/index.d.cts

@@ -1,4 +1,3 @@
-export { plugin as default };
 export type DocumentNode = import("@humanwhocodes/momoa").DocumentNode;
 export type JSONNode = import("@humanwhocodes/momoa").Node;
 export type JSONToken = import("@humanwhocodes/momoa").Token;
@@ -11,50 +10,6 @@ export type VisitTraversalStep = import("@eslint/core").VisitTraversalStep;
 export type Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
-declare namespace plugin {
-    namespace meta {
-        let name: string;
-        let version: string;
-    }
-    namespace languages {
-        let json: JSONLanguage;
-        let jsonc: JSONLanguage;
-        let json5: JSONLanguage;
-    }
-    let rules: {
-        "no-duplicate-keys": {
-            meta: {
-                type: string;
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    duplicateKey: string;
-                };
-            };
-            create(context: any): {
-                Object(): void;
-                Member(node: any): void;
-                "Object:exit"(): void;
-            };
-        };
-        "no-empty-keys": {
-            meta: {
-                type: string;
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    emptyKey: string;
-                };
-            };
-            create(context: any): {
-                Member(node: any): void;
-            };
-        };
-    };
-    let configs: {};
-}
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
@@ -66,7 +21,7 @@ declare namespace plugin {
  * JSON Language Object
  * @implements {Language}
  */
-declare class JSONLanguage implements Language {
+export class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -124,9 +79,8 @@ declare class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-declare class JSONSourceCode implements TextSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -142,57 +96,17 @@ declare class JSONSourceCode implements TextSourceCode {
      * @type {DocumentNode}
      */
     ast: DocumentNode;
-    /**
-     * The text of the source code.
-     * @type {string}
-     */
-    text: string;
     /**
      * The comment node in the source code.
      * @type {Array<JSONToken>|undefined}
      */
     comments: Array<JSONToken> | undefined;
-    /**
-     * Returns the loc information for the given node or token.
-     * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the loc information for.
-     * @returns {SourceLocation} The loc information for the node or token.
-     */
-    getLoc(nodeOrToken: JSONNode | JSONToken): SourceLocation;
-    /**
-     * Returns the range information for the given node or token.
-     * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the range information for.
-     * @returns {SourceRange} The range information for the node or token.
-     */
-    getRange(nodeOrToken: JSONNode | JSONToken): SourceRange;
     /**
      * 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.
      */
     getParent(node: JSONNode): JSONNode | undefined;
-    /**
-     * Gets all the ancestors of a given node
-     * @param {JSONNode} node The node
-     * @returns {Array<JSONNode>} All the ancestor nodes in the AST, not including the provided node, starting
-     * from the root node at index 0 and going inwards to the parent node.
-     * @throws {TypeError} When `node` is missing.
-     */
-    getAncestors(node: JSONNode): Array<JSONNode>;
-    /**
-     * Gets the source code for the given node.
-     * @param {JSONNode} [node] The AST node to get the text for.
-     * @param {number} [beforeCount] The number of characters before the node to retrieve.
-     * @param {number} [afterCount] The number of characters after the node to retrieve.
-     * @returns {string} The text representing the AST node.
-     * @public
-     */
-    public getText(node?: JSONNode, beforeCount?: number, afterCount?: number): string;
-    /**
-     * Gets the entire source text split into an array of lines.
-     * @returns {Array} The source text as an array of lines.
-     * @public
-     */
-    public get lines(): any[];
     /**
      * Traverse the source code and return the steps that were taken.
      * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
@@ -200,6 +114,51 @@ declare class JSONSourceCode implements TextSourceCode {
     traverse(): Iterable<JSONTraversalStep>;
     #private;
 }
+declare namespace plugin {
+    namespace meta {
+        let name: string;
+        let version: string;
+    }
+    namespace languages {
+        let json: JSONLanguage;
+        let jsonc: JSONLanguage;
+        let json5: JSONLanguage;
+    }
+    let rules: {
+        "no-duplicate-keys": {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    duplicateKey: string;
+                };
+            };
+            create(context: any): {
+                Object(): void;
+                Member(node: any): void;
+                "Object:exit"(): void;
+            };
+        };
+        "no-empty-keys": {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    emptyKey: string;
+                };
+            };
+            create(context: any): {
+                Member(node: any): void;
+            };
+        };
+    };
+    let configs: {};
+}
+import { TextSourceCodeBase } from '@eslint/plugin-kit';
 /**
  * @fileoverview The JSONSourceCode class.
  * @author Nicholas C. Zakas
@@ -215,9 +174,8 @@ declare class JSONSourceCode implements TextSourceCode {
 /** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
 /**
  * A class to represent a step in the traversal process.
- * @implements {VisitTraversalStep}
  */
-declare class JSONTraversalStep implements VisitTraversalStep {
+declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
@@ -230,32 +188,11 @@ declare class JSONTraversalStep implements VisitTraversalStep {
         phase: 1 | 2;
         args: Array<any>;
     });
-    /**
-     * The type of the step.
-     * @type {"visit"}
-     * @readonly
-     */
-    readonly type: "visit";
-    /**
-     * The kind of the step. Represents the same data as the `type` property
-     * but it's a number for performance.
-     * @type {1}
-     * @readonly
-     */
-    readonly kind: 1;
     /**
      * The target of the step.
      * @type {JSONNode}
      */
     target: JSONNode;
-    /**
-     * The phase of the step.
-     * @type {1|2}
-     */
-    phase: 1 | 2;
-    /**
-     * The arguments of the step.
-     * @type {Array<any>}
-     */
-    args: Array<any>;
 }
+import { VisitNodeStep } from '@eslint/plugin-kit';
+export { plugin as default };

package/dist/esm/index.d.ts

@@ -1,4 +1,3 @@
-export { plugin as default };
 export type DocumentNode = import("@humanwhocodes/momoa").DocumentNode;
 export type JSONNode = import("@humanwhocodes/momoa").Node;
 export type JSONToken = import("@humanwhocodes/momoa").Token;
@@ -11,50 +10,6 @@ export type VisitTraversalStep = import("@eslint/core").VisitTraversalStep;
 export type Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
-declare namespace plugin {
-    namespace meta {
-        let name: string;
-        let version: string;
-    }
-    namespace languages {
-        let json: JSONLanguage;
-        let jsonc: JSONLanguage;
-        let json5: JSONLanguage;
-    }
-    let rules: {
-        "no-duplicate-keys": {
-            meta: {
-                type: string;
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    duplicateKey: string;
-                };
-            };
-            create(context: any): {
-                Object(): void;
-                Member(node: any): void;
-                "Object:exit"(): void;
-            };
-        };
-        "no-empty-keys": {
-            meta: {
-                type: string;
-                docs: {
-                    description: string;
-                };
-                messages: {
-                    emptyKey: string;
-                };
-            };
-            create(context: any): {
-                Member(node: any): void;
-            };
-        };
-    };
-    let configs: {};
-}
 /**
  * @filedescription Functions to fix up rules to provide missing methods on the `context` object.
  * @author Nicholas C. Zakas
@@ -66,7 +21,7 @@ declare namespace plugin {
  * JSON Language Object
  * @implements {Language}
  */
-declare class JSONLanguage implements Language {
+export class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
@@ -124,9 +79,8 @@ declare class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-declare class JSONSourceCode implements TextSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -142,57 +96,17 @@ declare class JSONSourceCode implements TextSourceCode {
      * @type {DocumentNode}
      */
     ast: DocumentNode;
-    /**
-     * The text of the source code.
-     * @type {string}
-     */
-    text: string;
     /**
      * The comment node in the source code.
      * @type {Array<JSONToken>|undefined}
      */
     comments: Array<JSONToken> | undefined;
-    /**
-     * Returns the loc information for the given node or token.
-     * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the loc information for.
-     * @returns {SourceLocation} The loc information for the node or token.
-     */
-    getLoc(nodeOrToken: JSONNode | JSONToken): SourceLocation;
-    /**
-     * Returns the range information for the given node or token.
-     * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the range information for.
-     * @returns {SourceRange} The range information for the node or token.
-     */
-    getRange(nodeOrToken: JSONNode | JSONToken): SourceRange;
     /**
      * 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.
      */
     getParent(node: JSONNode): JSONNode | undefined;
-    /**
-     * Gets all the ancestors of a given node
-     * @param {JSONNode} node The node
-     * @returns {Array<JSONNode>} All the ancestor nodes in the AST, not including the provided node, starting
-     * from the root node at index 0 and going inwards to the parent node.
-     * @throws {TypeError} When `node` is missing.
-     */
-    getAncestors(node: JSONNode): Array<JSONNode>;
-    /**
-     * Gets the source code for the given node.
-     * @param {JSONNode} [node] The AST node to get the text for.
-     * @param {number} [beforeCount] The number of characters before the node to retrieve.
-     * @param {number} [afterCount] The number of characters after the node to retrieve.
-     * @returns {string} The text representing the AST node.
-     * @public
-     */
-    public getText(node?: JSONNode, beforeCount?: number, afterCount?: number): string;
-    /**
-     * Gets the entire source text split into an array of lines.
-     * @returns {Array} The source text as an array of lines.
-     * @public
-     */
-    public get lines(): any[];
     /**
      * Traverse the source code and return the steps that were taken.
      * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
@@ -200,6 +114,51 @@ declare class JSONSourceCode implements TextSourceCode {
     traverse(): Iterable<JSONTraversalStep>;
     #private;
 }
+declare namespace plugin {
+    namespace meta {
+        let name: string;
+        let version: string;
+    }
+    namespace languages {
+        let json: JSONLanguage;
+        let jsonc: JSONLanguage;
+        let json5: JSONLanguage;
+    }
+    let rules: {
+        "no-duplicate-keys": {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    duplicateKey: string;
+                };
+            };
+            create(context: any): {
+                Object(): void;
+                Member(node: any): void;
+                "Object:exit"(): void;
+            };
+        };
+        "no-empty-keys": {
+            meta: {
+                type: string;
+                docs: {
+                    description: string;
+                };
+                messages: {
+                    emptyKey: string;
+                };
+            };
+            create(context: any): {
+                Member(node: any): void;
+            };
+        };
+    };
+    let configs: {};
+}
+import { TextSourceCodeBase } from '@eslint/plugin-kit';
 /**
  * @fileoverview The JSONSourceCode class.
  * @author Nicholas C. Zakas
@@ -215,9 +174,8 @@ declare class JSONSourceCode implements TextSourceCode {
 /** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
 /**
  * A class to represent a step in the traversal process.
- * @implements {VisitTraversalStep}
  */
-declare class JSONTraversalStep implements VisitTraversalStep {
+declare class JSONTraversalStep extends VisitNodeStep {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the step.
@@ -230,32 +188,11 @@ declare class JSONTraversalStep implements VisitTraversalStep {
         phase: 1 | 2;
         args: Array<any>;
     });
-    /**
-     * The type of the step.
-     * @type {"visit"}
-     * @readonly
-     */
-    readonly type: "visit";
-    /**
-     * The kind of the step. Represents the same data as the `type` property
-     * but it's a number for performance.
-     * @type {1}
-     * @readonly
-     */
-    readonly kind: 1;
     /**
      * The target of the step.
      * @type {JSONNode}
      */
     target: JSONNode;
-    /**
-     * The phase of the step.
-     * @type {1|2}
-     */
-    phase: 1 | 2;
-    /**
-     * The arguments of the step.
-     * @type {Array<any>}
-     */
-    args: Array<any>;
 }
+import { VisitNodeStep } from '@eslint/plugin-kit';
+export { plugin as default };

package/dist/esm/index.js

@@ -1,5 +1,6 @@
 // @ts-self-types="./index.d.ts"
 import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
+import { TextSourceCodeBase, VisitNodeStep } from '@eslint/plugin-kit';
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -27,41 +28,13 @@ import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
 
 /**
  * A class to represent a step in the traversal process.
- * @implements {VisitTraversalStep}
  */
-class JSONTraversalStep {
-	/**
-	 * The type of the step.
-	 * @type {"visit"}
-	 * @readonly
-	 */
-	type = "visit";
-
-	/**
-	 * The kind of the step. Represents the same data as the `type` property
-	 * but it's a number for performance.
-	 * @type {1}
-	 * @readonly
-	 */
-	kind = 1;
-
+class JSONTraversalStep extends VisitNodeStep {
 	/**
 	 * The target of the step.
 	 * @type {JSONNode}
 	 */
-	target;
-
-	/**
-	 * The phase of the step.
-	 * @type {1|2}
-	 */
-	phase;
-
-	/**
-	 * The arguments of the step.
-	 * @type {Array<any>}
-	 */
-	args;
+	target = undefined;
 
 	/**
 	 * Creates a new instance.
@@ -71,9 +44,9 @@ class JSONTraversalStep {
 	 * @param {Array<any>} options.args The arguments of the step.
 	 */
 	constructor({ target, phase, args }) {
+		super({ target, phase, args });
+
 		this.target = target;
-		this.phase = phase;
-		this.args = args;
 	}
 }
 
@@ -83,9 +56,8 @@ class JSONTraversalStep {
 
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-class JSONSourceCode {
+class JSONSourceCode extends TextSourceCodeBase {
 	/**
 	 * Cached traversal steps.
 	 * @type {Array<JSONTraversalStep>|undefined}
@@ -98,23 +70,11 @@ class JSONSourceCode {
 	 */
 	#parents = new WeakMap();
 
-	/**
-	 * The lines of text in the source code.
-	 * @type {Array<string>}
-	 */
-	#lines;
-
 	/**
 	 * The AST of the source code.
 	 * @type {DocumentNode}
 	 */
-	ast;
-
-	/**
-	 * The text of the source code.
-	 * @type {string}
-	 */
-	text;
+	ast = undefined;
 
 	/**
 	 * The comment node in the source code.
@@ -129,35 +89,13 @@ class JSONSourceCode {
 	 * @param {DocumentNode} options.ast The root AST node.
 	 */
 	constructor({ text, ast }) {
+		super({ text, ast });
 		this.ast = ast;
-		this.text = text;
-		this.comments = ast.tokens.filter(token =>
-			token.type.endsWith("Comment"),
-		);
-	}
-
-	/* eslint-disable class-methods-use-this -- Required to complete interface. */
-
-	/**
-	 * Returns the loc information for the given node or token.
-	 * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the loc information for.
-	 * @returns {SourceLocation} The loc information for the node or token.
-	 */
-	getLoc(nodeOrToken) {
-		return nodeOrToken.loc;
+		this.comments = ast.tokens
+			? ast.tokens.filter(token => token.type.endsWith("Comment"))
+			: [];
 	}
 
-	/**
-	 * Returns the range information for the given node or token.
-	 * @param {JSONNode|JSONToken} nodeOrToken The node or token to get the range information for.
-	 * @returns {SourceRange} The range information for the node or token.
-	 */
-	getRange(nodeOrToken) {
-		return nodeOrToken.range;
-	}
-
-	/* eslint-enable class-methods-use-this -- Required to complete interface. */
-
 	/**
 	 * Returns the parent of the given node.
 	 * @param {JSONNode} node The node to get the parent of.
@@ -167,61 +105,6 @@ class JSONSourceCode {
 		return this.#parents.get(node);
 	}
 
-	/**
-	 * Gets all the ancestors of a given node
-	 * @param {JSONNode} node The node
-	 * @returns {Array<JSONNode>} All the ancestor nodes in the AST, not including the provided node, starting
-	 * from the root node at index 0 and going inwards to the parent node.
-	 * @throws {TypeError} When `node` is missing.
-	 */
-	getAncestors(node) {
-		if (!node) {
-			throw new TypeError("Missing required argument: node.");
-		}
-
-		const ancestorsStartingAtParent = [];
-
-		for (
-			let ancestor = this.#parents.get(node);
-			ancestor;
-			ancestor = this.#parents.get(ancestor)
-		) {
-			ancestorsStartingAtParent.push(ancestor);
-		}
-
-		return ancestorsStartingAtParent.reverse();
-	}
-
-	/**
-	 * Gets the source code for the given node.
-	 * @param {JSONNode} [node] The AST node to get the text for.
-	 * @param {number} [beforeCount] The number of characters before the node to retrieve.
-	 * @param {number} [afterCount] The number of characters after the node to retrieve.
-	 * @returns {string} The text representing the AST node.
-	 * @public
-	 */
-	getText(node, beforeCount, afterCount) {
-		if (node) {
-			return this.text.slice(
-				Math.max(node.range[0] - (beforeCount || 0), 0),
-				node.range[1] + (afterCount || 0),
-			);
-		}
-		return this.text;
-	}
-
-	/**
-	 * Gets the entire source text split into an array of lines.
-	 * @returns {Array} The source text as an array of lines.
-	 * @public
-	 */
-	get lines() {
-		if (!this.#lines) {
-			this.#lines = this.text.split(/\r?\n/gu);
-		}
-		return this.#lines;
-	}
-
 	/**
 	 * Traverse the source code and return the steps that were taken.
 	 * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
@@ -236,7 +119,10 @@ class JSONSourceCode {
 		const steps = (this.#steps = []);
 
 		for (const { node, parent, phase } of iterator(this.ast)) {
-			this.#parents.set(node, parent);
+			if (parent) {
+				this.#parents.set(node, parent);
+			}
+
 			steps.push(
 				new JSONTraversalStep({
 					target: node,
@@ -497,7 +383,7 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.3.0", // x-release-please-version
+		version: "0.4.1", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
@@ -521,4 +407,4 @@ Object.assign(plugin.configs, {
 	},
 });
 
-export { plugin as default };
+export { JSONLanguage, JSONSourceCode, plugin as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -61,6 +61,7 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
+    "@eslint/plugin-kit": "^0.1.0",
     "@humanwhocodes/momoa": "^3.2.0"
   },
   "devDependencies": {
@@ -79,8 +80,5 @@
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
-  },
-  "peerDependencies": {
-    "eslint": "^9.6.0"
   }
 }