@eslint/json 0.4.0 → 0.5.0

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,64 @@ 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)
 
+## Configuration Comments
+
+In JSONC and JSON5 files, you can also use [rule configurations comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments) and [disable directives](https://eslint.org/docs/latest/use/configure/rules#disabling-rules).
+
+```jsonc
+/* eslint json/no-empty-keys: "error" */
+
+{
+	"foo": {
+		"": 1, // eslint-disable-line json/no-empty-keys -- We want an empty key here
+	},
+	"bar": {
+		// eslint-disable-next-line json/no-empty-keys -- We want an empty key here too
+		"": 2,
+	},
+	/* eslint-disable json/no-empty-keys -- Empty keys are allowed in the following code as well */
+	"baz": [
+		{
+			"": 3,
+		},
+		{
+			"": 4,
+		},
+	],
+	/* eslint-enable json/no-empty-keys -- re-enable now */
+}
+```
+
+Both line and block comments can be used for all kinds of configuration comments.
+
+## 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

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var momoa = require('@humanwhocodes/momoa');
+var pluginKit = require('@eslint/plugin-kit');
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -23,48 +24,28 @@ var momoa = require('@humanwhocodes/momoa');
 /** @typedef {import("@eslint/core").TraversalStep} TraversalStep */
 /** @typedef {import("@eslint/core").TextSourceCode} TextSourceCode */
 /** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
+/** @typedef {import("@eslint/core").FileProblem} FileProblem */
+/** @typedef {import("@eslint/core").DirectiveType} DirectiveType */
+/** @typedef {import("@eslint/core").RulesConfig} RulesConfig */
 
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
 
+const commentParser = new pluginKit.ConfigCommentParser();
+
+const INLINE_CONFIG =
+	/^\s*(?:eslint(?:-enable|-disable(?:(?:-next)?-line)?)?)(?:\s|$)/u;
+
 /**
  * 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.
@@ -74,9 +55,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;
 	}
 }
 
@@ -86,9 +67,8 @@ class JSONTraversalStep {
 
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-class JSONSourceCode {
+class JSONSourceCode extends pluginKit.TextSourceCodeBase {
 	/**
 	 * Cached traversal steps.
 	 * @type {Array<JSONTraversalStep>|undefined}
@@ -102,22 +82,16 @@ class JSONSourceCode {
 	#parents = new WeakMap();
 
 	/**
-	 * The lines of text in the source code.
-	 * @type {Array<string>}
+	 * Collection of inline configuration comments.
+	 * @type {Array<JSONToken>}
 	 */
-	#lines;
+	#inlineConfigComments;
 
 	/**
 	 * 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.
@@ -132,97 +106,150 @@ 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"),
-		);
+		this.comments = ast.tokens
+			? 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.
+	 * Returns the value of the given comment.
+	 * @param {JSONToken} comment The comment to get the value of.
+	 * @returns {string} The value of the comment.
+	 * @throws {Error} When an unexpected comment type is passed.
 	 */
-	getLoc(nodeOrToken) {
-		return nodeOrToken.loc;
-	}
+	#getCommentValue(comment) {
+		if (comment.type === "LineComment") {
+			return this.getText(comment).slice(2); // strip leading `//`
+		}
 
-	/**
-	 * 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;
-	}
+		if (comment.type === "BlockComment") {
+			return this.getText(comment).slice(2, -2); // strip leading `/*` and trailing `*/`
+		}
 
-	/* eslint-enable class-methods-use-this -- Required to complete interface. */
+		throw new Error(`Unexpected comment type '${comment.type}'`);
+	}
 
 	/**
-	 * 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.
+	 * Returns an array of all inline configuration nodes found in the
+	 * source code.
+	 * @returns {Array<JSONToken>} An array of all inline configuration nodes.
 	 */
-	getParent(node) {
-		return this.#parents.get(node);
+	getInlineConfigNodes() {
+		if (!this.#inlineConfigComments) {
+			this.#inlineConfigComments = this.comments.filter(comment =>
+				INLINE_CONFIG.test(this.#getCommentValue(comment)),
+			);
+		}
+
+		return this.#inlineConfigComments;
 	}
 
 	/**
-	 * 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.
+	 * Returns directives that enable or disable rules along with any problems
+	 * encountered while parsing the directives.
+	 * @returns {{problems:Array<FileProblem>,directives:Array<Directive>}} Information
+	 *      that ESLint needs to further process the directives.
 	 */
-	getAncestors(node) {
-		if (!node) {
-			throw new TypeError("Missing required argument: node.");
-		}
-
-		const ancestorsStartingAtParent = [];
+	getDisableDirectives() {
+		const problems = [];
+		const directives = [];
+
+		this.getInlineConfigNodes().forEach(comment => {
+			const { label, value, justification } =
+				commentParser.parseDirective(this.#getCommentValue(comment));
+
+			// `eslint-disable-line` directives are not allowed to span multiple lines as it would be confusing to which lines they apply
+			if (
+				label === "eslint-disable-line" &&
+				comment.loc.start.line !== comment.loc.end.line
+			) {
+				const message = `${label} comment should not span multiple lines.`;
+
+				problems.push({
+					ruleId: null,
+					message,
+					loc: comment.loc,
+				});
+				return;
+			}
+
+			switch (label) {
+				case "eslint-disable":
+				case "eslint-enable":
+				case "eslint-disable-next-line":
+				case "eslint-disable-line": {
+					const directiveType = label.slice("eslint-".length);
+
+					directives.push(
+						new pluginKit.Directive({
+							type: /** @type {DirectiveType} */ (directiveType),
+							node: comment,
+							value,
+							justification,
+						}),
+					);
+				}
 
-		for (
-			let ancestor = this.#parents.get(node);
-			ancestor;
-			ancestor = this.#parents.get(ancestor)
-		) {
-			ancestorsStartingAtParent.push(ancestor);
-		}
+				// no default
+			}
+		});
 
-		return ancestorsStartingAtParent.reverse();
+		return { problems, directives };
 	}
 
 	/**
-	 * 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
+	 * Returns inline rule configurations along with any problems
+	 * encountered while parsing the configurations.
+	 * @returns {{problems:Array<FileProblem>,configs:Array<{config:{rules:RulesConfig},loc:SourceLocation}>}} Information
+	 *      that ESLint needs to further process the rule configurations.
 	 */
-	getText(node, beforeCount, afterCount) {
-		if (node) {
-			return this.text.slice(
-				Math.max(node.range[0] - (beforeCount || 0), 0),
-				node.range[1] + (afterCount || 0),
+	applyInlineConfig() {
+		const problems = [];
+		const configs = [];
+
+		this.getInlineConfigNodes().forEach(comment => {
+			const { label, value } = commentParser.parseDirective(
+				this.#getCommentValue(comment),
 			);
-		}
-		return this.text;
+
+			if (label === "eslint") {
+				const parseResult = commentParser.parseJSONLikeConfig(value);
+
+				if (parseResult.ok) {
+					configs.push({
+						config: {
+							rules: parseResult.config,
+						},
+						loc: comment.loc,
+					});
+				} else {
+					problems.push({
+						ruleId: null,
+						message:
+							/** @type {{ok: false, error: { message: string }}} */ (
+								parseResult
+							).error.message,
+						loc: comment.loc,
+					});
+				}
+			}
+		});
+
+		return {
+			configs,
+			problems,
+		};
 	}
 
 	/**
-	 * Gets the entire source text split into an array of lines.
-	 * @returns {Array} The source text as an array of lines.
-	 * @public
+	 * 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.
 	 */
-	get lines() {
-		if (!this.#lines) {
-			this.#lines = this.text.split(/\r?\n/gu);
-		}
-		return this.#lines;
+	getParent(node) {
+		return this.#parents.get(node);
 	}
 
 	/**
@@ -239,7 +266,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,
@@ -500,7 +530,7 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.4.0", // x-release-please-version
+		version: "0.5.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),

package/dist/cjs/index.d.cts

@@ -7,6 +7,9 @@ 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 Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
@@ -79,9 +82,8 @@ export class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-export class JSONSourceCode implements TextSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -97,57 +99,48 @@ export 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.
+     * Returns an array of all inline configuration nodes found in the
+     * source code.
+     * @returns {Array<JSONToken>} An array of all inline configuration nodes.
      */
-    getLoc(nodeOrToken: JSONNode | JSONToken): SourceLocation;
+    getInlineConfigNodes(): Array<JSONToken>;
     /**
-     * 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.
+     * Returns directives that enable or disable rules along with any problems
+     * encountered while parsing the directives.
+     * @returns {{problems:Array<FileProblem>,directives:Array<Directive>}} Information
+     *      that ESLint needs to further process the directives.
      */
-    getRange(nodeOrToken: JSONNode | JSONToken): SourceRange;
+    getDisableDirectives(): {
+        problems: Array<FileProblem>;
+        directives: Array<Directive>;
+    };
+    /**
+     * Returns inline rule configurations along with any problems
+     * encountered while parsing the configurations.
+     * @returns {{problems:Array<FileProblem>,configs:Array<{config:{rules:RulesConfig},loc:SourceLocation}>}} Information
+     *      that ESLint needs to further process the rule configurations.
+     */
+    applyInlineConfig(): {
+        problems: Array<FileProblem>;
+        configs: Array<{
+            config: {
+                rules: RulesConfig;
+            };
+            loc: SourceLocation;
+        }>;
+    };
     /**
      * 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.
@@ -199,24 +192,12 @@ declare namespace plugin {
     };
     let configs: {};
 }
-/**
- * @fileoverview The JSONSourceCode class.
- * @author Nicholas C. Zakas
- */
-/** @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").TextSourceCode} TextSourceCode */
-/** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
+import { TextSourceCodeBase } from '@eslint/plugin-kit';
+import { Directive } from '@eslint/plugin-kit';
 /**
  * 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.
@@ -229,33 +210,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

@@ -7,6 +7,9 @@ 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 Language = import("@eslint/core").Language;
 export type OkParseResult = import("@eslint/core").OkParseResult<DocumentNode>;
 export type ParseResult = import("@eslint/core").ParseResult<DocumentNode>;
@@ -79,9 +82,8 @@ export class JSONLanguage implements Language {
 }
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-export class JSONSourceCode implements TextSourceCode {
+export class JSONSourceCode extends TextSourceCodeBase {
     /**
      * Creates a new instance.
      * @param {Object} options The options for the instance.
@@ -97,57 +99,48 @@ export 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.
+     * Returns an array of all inline configuration nodes found in the
+     * source code.
+     * @returns {Array<JSONToken>} An array of all inline configuration nodes.
      */
-    getLoc(nodeOrToken: JSONNode | JSONToken): SourceLocation;
+    getInlineConfigNodes(): Array<JSONToken>;
     /**
-     * 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.
+     * Returns directives that enable or disable rules along with any problems
+     * encountered while parsing the directives.
+     * @returns {{problems:Array<FileProblem>,directives:Array<Directive>}} Information
+     *      that ESLint needs to further process the directives.
      */
-    getRange(nodeOrToken: JSONNode | JSONToken): SourceRange;
+    getDisableDirectives(): {
+        problems: Array<FileProblem>;
+        directives: Array<Directive>;
+    };
+    /**
+     * Returns inline rule configurations along with any problems
+     * encountered while parsing the configurations.
+     * @returns {{problems:Array<FileProblem>,configs:Array<{config:{rules:RulesConfig},loc:SourceLocation}>}} Information
+     *      that ESLint needs to further process the rule configurations.
+     */
+    applyInlineConfig(): {
+        problems: Array<FileProblem>;
+        configs: Array<{
+            config: {
+                rules: RulesConfig;
+            };
+            loc: SourceLocation;
+        }>;
+    };
     /**
      * 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.
@@ -199,24 +192,12 @@ declare namespace plugin {
     };
     let configs: {};
 }
-/**
- * @fileoverview The JSONSourceCode class.
- * @author Nicholas C. Zakas
- */
-/** @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").TextSourceCode} TextSourceCode */
-/** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
+import { TextSourceCodeBase } from '@eslint/plugin-kit';
+import { Directive } from '@eslint/plugin-kit';
 /**
  * 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.
@@ -229,33 +210,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 { ConfigCommentParser, TextSourceCodeBase, Directive, VisitNodeStep } from '@eslint/plugin-kit';
 
 /**
  * @fileoverview The JSONSourceCode class.
@@ -20,48 +21,28 @@ import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
 /** @typedef {import("@eslint/core").TraversalStep} TraversalStep */
 /** @typedef {import("@eslint/core").TextSourceCode} TextSourceCode */
 /** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
+/** @typedef {import("@eslint/core").FileProblem} FileProblem */
+/** @typedef {import("@eslint/core").DirectiveType} DirectiveType */
+/** @typedef {import("@eslint/core").RulesConfig} RulesConfig */
 
 //-----------------------------------------------------------------------------
 // Helpers
 //-----------------------------------------------------------------------------
 
+const commentParser = new ConfigCommentParser();
+
+const INLINE_CONFIG =
+	/^\s*(?:eslint(?:-enable|-disable(?:(?:-next)?-line)?)?)(?:\s|$)/u;
+
 /**
  * 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 +52,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 +64,8 @@ class JSONTraversalStep {
 
 /**
  * JSON Source Code Object
- * @implements {TextSourceCode}
  */
-class JSONSourceCode {
+class JSONSourceCode extends TextSourceCodeBase {
 	/**
 	 * Cached traversal steps.
 	 * @type {Array<JSONTraversalStep>|undefined}
@@ -99,22 +79,16 @@ class JSONSourceCode {
 	#parents = new WeakMap();
 
 	/**
-	 * The lines of text in the source code.
-	 * @type {Array<string>}
+	 * Collection of inline configuration comments.
+	 * @type {Array<JSONToken>}
 	 */
-	#lines;
+	#inlineConfigComments;
 
 	/**
 	 * 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,97 +103,150 @@ 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"),
-		);
+		this.comments = ast.tokens
+			? 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.
+	 * Returns the value of the given comment.
+	 * @param {JSONToken} comment The comment to get the value of.
+	 * @returns {string} The value of the comment.
+	 * @throws {Error} When an unexpected comment type is passed.
 	 */
-	getLoc(nodeOrToken) {
-		return nodeOrToken.loc;
-	}
+	#getCommentValue(comment) {
+		if (comment.type === "LineComment") {
+			return this.getText(comment).slice(2); // strip leading `//`
+		}
 
-	/**
-	 * 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;
-	}
+		if (comment.type === "BlockComment") {
+			return this.getText(comment).slice(2, -2); // strip leading `/*` and trailing `*/`
+		}
 
-	/* eslint-enable class-methods-use-this -- Required to complete interface. */
+		throw new Error(`Unexpected comment type '${comment.type}'`);
+	}
 
 	/**
-	 * 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.
+	 * Returns an array of all inline configuration nodes found in the
+	 * source code.
+	 * @returns {Array<JSONToken>} An array of all inline configuration nodes.
 	 */
-	getParent(node) {
-		return this.#parents.get(node);
+	getInlineConfigNodes() {
+		if (!this.#inlineConfigComments) {
+			this.#inlineConfigComments = this.comments.filter(comment =>
+				INLINE_CONFIG.test(this.#getCommentValue(comment)),
+			);
+		}
+
+		return this.#inlineConfigComments;
 	}
 
 	/**
-	 * 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.
+	 * Returns directives that enable or disable rules along with any problems
+	 * encountered while parsing the directives.
+	 * @returns {{problems:Array<FileProblem>,directives:Array<Directive>}} Information
+	 *      that ESLint needs to further process the directives.
 	 */
-	getAncestors(node) {
-		if (!node) {
-			throw new TypeError("Missing required argument: node.");
-		}
-
-		const ancestorsStartingAtParent = [];
+	getDisableDirectives() {
+		const problems = [];
+		const directives = [];
+
+		this.getInlineConfigNodes().forEach(comment => {
+			const { label, value, justification } =
+				commentParser.parseDirective(this.#getCommentValue(comment));
+
+			// `eslint-disable-line` directives are not allowed to span multiple lines as it would be confusing to which lines they apply
+			if (
+				label === "eslint-disable-line" &&
+				comment.loc.start.line !== comment.loc.end.line
+			) {
+				const message = `${label} comment should not span multiple lines.`;
+
+				problems.push({
+					ruleId: null,
+					message,
+					loc: comment.loc,
+				});
+				return;
+			}
+
+			switch (label) {
+				case "eslint-disable":
+				case "eslint-enable":
+				case "eslint-disable-next-line":
+				case "eslint-disable-line": {
+					const directiveType = label.slice("eslint-".length);
+
+					directives.push(
+						new Directive({
+							type: /** @type {DirectiveType} */ (directiveType),
+							node: comment,
+							value,
+							justification,
+						}),
+					);
+				}
 
-		for (
-			let ancestor = this.#parents.get(node);
-			ancestor;
-			ancestor = this.#parents.get(ancestor)
-		) {
-			ancestorsStartingAtParent.push(ancestor);
-		}
+				// no default
+			}
+		});
 
-		return ancestorsStartingAtParent.reverse();
+		return { problems, directives };
 	}
 
 	/**
-	 * 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
+	 * Returns inline rule configurations along with any problems
+	 * encountered while parsing the configurations.
+	 * @returns {{problems:Array<FileProblem>,configs:Array<{config:{rules:RulesConfig},loc:SourceLocation}>}} Information
+	 *      that ESLint needs to further process the rule configurations.
 	 */
-	getText(node, beforeCount, afterCount) {
-		if (node) {
-			return this.text.slice(
-				Math.max(node.range[0] - (beforeCount || 0), 0),
-				node.range[1] + (afterCount || 0),
+	applyInlineConfig() {
+		const problems = [];
+		const configs = [];
+
+		this.getInlineConfigNodes().forEach(comment => {
+			const { label, value } = commentParser.parseDirective(
+				this.#getCommentValue(comment),
 			);
-		}
-		return this.text;
+
+			if (label === "eslint") {
+				const parseResult = commentParser.parseJSONLikeConfig(value);
+
+				if (parseResult.ok) {
+					configs.push({
+						config: {
+							rules: parseResult.config,
+						},
+						loc: comment.loc,
+					});
+				} else {
+					problems.push({
+						ruleId: null,
+						message:
+							/** @type {{ok: false, error: { message: string }}} */ (
+								parseResult
+							).error.message,
+						loc: comment.loc,
+					});
+				}
+			}
+		});
+
+		return {
+			configs,
+			problems,
+		};
 	}
 
 	/**
-	 * Gets the entire source text split into an array of lines.
-	 * @returns {Array} The source text as an array of lines.
-	 * @public
+	 * 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.
 	 */
-	get lines() {
-		if (!this.#lines) {
-			this.#lines = this.text.split(/\r?\n/gu);
-		}
-		return this.#lines;
+	getParent(node) {
+		return this.#parents.get(node);
 	}
 
 	/**
@@ -236,7 +263,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 +527,7 @@ var noEmptyKeys = {
 const plugin = {
 	meta: {
 		name: "@eslint/json",
-		version: "0.4.0", // x-release-please-version
+		version: "0.5.0", // x-release-please-version
 	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -61,13 +61,15 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@humanwhocodes/momoa": "^3.2.0"
+    "@eslint/plugin-kit": "^0.2.0",
+    "@humanwhocodes/momoa": "^3.2.1"
   },
   "devDependencies": {
-    "@eslint/core": "^0.3.0",
+    "@eslint/core": "^0.6.0",
     "@types/eslint": "^8.56.10",
     "c8": "^9.1.0",
-    "eslint": "^9.6.0",
+    "dedent": "^1.5.3",
+    "eslint": "^9.11.1",
     "eslint-config-eslint": "^11.0.0",
     "lint-staged": "^15.2.7",
     "mocha": "^10.4.0",
@@ -79,8 +81,5 @@
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
-  },
-  "peerDependencies": {
-    "eslint": "^9.6.0"
   }
 }