@eslint/json 0.1.0 → 0.3.0

package/README.md

@@ -28,12 +28,13 @@ deno add @eslint/json
 
 ## Usage
 
-This package exports two different languages:
+This package exports these languages:
 
 -   `"json/json"` is for regular JSON files
--   `"json/jsonc"` is for JSON files that support comments (JSON-C)
+-   `"json/jsonc"` is for JSON files that support comments ([JSONC](https://github.com/microsoft/node-jsonc-parser)) such as those used for Visual Studio Code configuration files
+-   `"json/json5"` is for [JSON5](https://json5.org) files
 
-Depending on which types of JSON files you'd like to lint, you can set up your `eslint.config.js` file to include just the files you'd like. Here's an example that lints both JSON and JSON-C files:
+Depending on which types of JSON files you'd like to lint, you can set up your `eslint.config.js` file to include just the files you'd like. Here's an example that lints JSON, JSONC, and JSON5 files:
 
 ```js
 import json from "@eslint/json";
@@ -54,14 +55,23 @@ export default [
 		},
 	},
 
-	// lint JSON-C files
+	// lint JSONC files
 	{
-		files: ["**/*.jsonc"],
+		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",
+		},
+	},
 ];
 ```
 
@@ -76,23 +86,33 @@ export default [
 	// lint JSON files
 	{
 		files: ["**/*.json"],
+		ignores: ["package-lock.json"],
 		language: "json/json",
 		...json.configs.recommended,
 	},
 
-	// lint JSON-C files
+	// lint JSONC files
 	{
 		files: ["**/*.jsonc"],
 		language: "json/jsonc",
 		...json.configs.recommended,
 	},
+
+	// lint JSON5 files
+	{
+		files: ["**/*.json5"],
+		language: "json/json5",
+		...json.configs.recommended,
+	},
 ];
 ```
 
+**Note:** You generally want to ignore `package-lock.json` because it is auto-generated and you typically will not want to manually make changes to it.
+
 ## Rules
 
 -   `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
+-   `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)
 
 ## License
 

package/dist/cjs/index.cjs

@@ -15,13 +15,12 @@ var momoa = require('@humanwhocodes/momoa');
 /** @typedef {import("@humanwhocodes/momoa").DocumentNode} DocumentNode */
 /** @typedef {import("@humanwhocodes/momoa").Node} JSONNode */
 /** @typedef {import("@humanwhocodes/momoa").Token} JSONToken */
-/** @typedef {import("@eslint/core").SyntaxElement} SyntaxElement */
-/** @typedef {import("@eslint/core").Language} Language */
+/** @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").TextSourceCode} TextSourceCode */
-/** @typedef {import("@eslint/core").ParseResult} ParseResult */
+/** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -49,7 +48,7 @@ class JSONTraversalStep {
 
 	/**
 	 * The target of the step.
-	 * @type {JSONNode & SyntaxElement}
+	 * @type {JSONNode}
 	 */
 	target;
 
@@ -68,7 +67,7 @@ class JSONTraversalStep {
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options for the step.
-	 * @param {JSONNode & SyntaxElement} options.target The target of the step.
+	 * @param {JSONNode} 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.
 	 */
@@ -108,7 +107,7 @@ class JSONSourceCode {
 
 	/**
 	 * The AST of the source code.
-	 * @type {DocumentNode & SyntaxElement}
+	 * @type {DocumentNode}
 	 */
 	ast;
 
@@ -128,7 +127,7 @@ class JSONSourceCode {
 	 * Creates a new instance.
 	 * @param {Object} options The options for the instance.
 	 * @param {string} options.text The source code text.
-	 * @param {DocumentNode & SyntaxElement} options.ast The root AST node.
+	 * @param {DocumentNode} options.ast The root AST node.
 	 */
 	constructor({ text, ast }) {
 		this.ast = ast;
@@ -138,6 +137,28 @@ class JSONSourceCode {
 		);
 	}
 
+	/* 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;
+	}
+
+	/**
+	 * 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.
@@ -204,7 +225,7 @@ class JSONSourceCode {
 
 	/**
 	 * Traverse the source code and return the steps that were taken.
-	 * @returns {Iterable<TraversalStep>} The steps that were taken while traversing the source code.
+	 * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
 	 */
 	traverse() {
 		// Because the AST doesn't mutate, we can cache the steps
@@ -212,15 +233,14 @@ class JSONSourceCode {
 			return this.#steps.values();
 		}
 
+		/** @type {Array<JSONTraversalStep>} */
 		const steps = (this.#steps = []);
 
-		for (const { node, parent, phase } of momoa.iterator(
-			/** @type {DocumentNode} */ (this.ast),
-		)) {
+		for (const { node, parent, phase } of momoa.iterator(this.ast)) {
 			this.#parents.set(node, parent);
 			steps.push(
 				new JSONTraversalStep({
-					target: /** @type {JSONNode & SyntaxElement} */ (node),
+					target: node,
 					phase: phase === "enter" ? 1 : 2,
 					args: [node, parent],
 				}),
@@ -241,6 +261,9 @@ class JSONSourceCode {
 // Types
 //-----------------------------------------------------------------------------
 
+/** @typedef {import("@eslint/core").Language} Language */
+/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
+/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -277,7 +300,7 @@ class JSONLanguage {
 
 	/**
 	 * The parser mode.
-	 * @type {"json"|"jsonc"}
+	 * @type {"json"|"jsonc"|"json5"}
 	 */
 	#mode = "json";
 
@@ -290,7 +313,7 @@ class JSONLanguage {
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options to use for this instance.
-	 * @param {"json"|"jsonc"} options.mode The parser mode to use.
+	 * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
 	 */
 	constructor({ mode }) {
 		this.#mode = mode;
@@ -332,7 +355,7 @@ class JSONLanguage {
 
 			return {
 				ok: true,
-				ast: /** @type {DocumentNode & SyntaxElement} */ (root),
+				ast: root,
 			};
 		} catch (ex) {
 			// error messages end with (line:column) so we strip that off for ESLint
@@ -356,7 +379,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 {ParseResult} parseResult The result returned from `parse()`.
+	 * @param {OkParseResult} parseResult The result returned from `parse()`.
 	 * @returns {JSONSourceCode} The new `JSONSourceCode` object.
 	 */
 	createSourceCode(file, parseResult) {
@@ -374,7 +397,7 @@ class JSONLanguage {
  */
 
 //-----------------------------------------------------------------------------
-// Type Definitions
+// Rule Definition
 //-----------------------------------------------------------------------------
 
 var noDuplicateKeys = {
@@ -401,7 +424,10 @@ var noDuplicateKeys = {
 			},
 
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (keys.has(key)) {
 					context.report({
@@ -443,7 +469,10 @@ var noEmptyKeys = {
 	create(context) {
 		return {
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (key.trim() === "") {
 					context.report({
@@ -467,9 +496,14 @@ var noEmptyKeys = {
 //-----------------------------------------------------------------------------
 
 const plugin = {
+	meta: {
+		name: "@eslint/json",
+		version: "0.3.0", // x-release-please-version
+	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
 		jsonc: new JSONLanguage({ mode: "jsonc" }),
+		json5: new JSONLanguage({ mode: "json5" }),
 	},
 	rules: {
 		"no-duplicate-keys": noDuplicateKeys,

package/dist/cjs/index.d.cts

@@ -2,17 +2,24 @@ 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;
-export type SyntaxElement = import("@eslint/core").SyntaxElement;
-export type Language = import("@eslint/core").Language;
+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 TextSourceCode = import("@eslint/core").TextSourceCode;
-export type ParseResult = import("@eslint/core").ParseResult;
+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": {
@@ -52,6 +59,9 @@ declare namespace plugin {
  * @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 */
 /**
  * JSON Language Object
  * @implements {Language}
@@ -60,10 +70,10 @@ declare class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
-     * @param {"json"|"jsonc"} options.mode The parser mode to use.
+     * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
      */
     constructor({ mode }: {
-        mode: "json" | "jsonc";
+        mode: "json" | "jsonc" | "json5";
     });
     /**
      * The type of file to read.
@@ -106,10 +116,10 @@ declare class JSONLanguage implements Language {
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-     * @param {ParseResult} parseResult The result returned from `parse()`.
+     * @param {OkParseResult} parseResult The result returned from `parse()`.
      * @returns {JSONSourceCode} The new `JSONSourceCode` object.
      */
-    createSourceCode(file: File, parseResult: ParseResult): JSONSourceCode;
+    createSourceCode(file: File, parseResult: OkParseResult): JSONSourceCode;
     #private;
 }
 /**
@@ -121,17 +131,17 @@ declare class JSONSourceCode implements TextSourceCode {
      * Creates a new instance.
      * @param {Object} options The options for the instance.
      * @param {string} options.text The source code text.
-     * @param {DocumentNode & SyntaxElement} options.ast The root AST node.
+     * @param {DocumentNode} options.ast The root AST node.
      */
     constructor({ text, ast }: {
         text: string;
-        ast: DocumentNode & SyntaxElement;
+        ast: DocumentNode;
     });
     /**
      * The AST of the source code.
-     * @type {DocumentNode & SyntaxElement}
+     * @type {DocumentNode}
      */
-    ast: DocumentNode & SyntaxElement;
+    ast: DocumentNode;
     /**
      * The text of the source code.
      * @type {string}
@@ -142,6 +152,18 @@ declare class JSONSourceCode implements TextSourceCode {
      * @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.
@@ -173,8 +195,67 @@ declare class JSONSourceCode implements TextSourceCode {
     public get lines(): any[];
     /**
      * Traverse the source code and return the steps that were taken.
-     * @returns {Iterable<TraversalStep>} The steps that were taken while traversing the source code.
+     * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
      */
-    traverse(): Iterable<TraversalStep>;
+    traverse(): Iterable<JSONTraversalStep>;
     #private;
 }
+/**
+ * @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 */
+/**
+ * A class to represent a step in the traversal process.
+ * @implements {VisitTraversalStep}
+ */
+declare class JSONTraversalStep implements VisitTraversalStep {
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options for the step.
+     * @param {JSONNode} 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;
+        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>;
+}

package/dist/esm/index.d.ts

@@ -2,17 +2,24 @@ 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;
-export type SyntaxElement = import("@eslint/core").SyntaxElement;
-export type Language = import("@eslint/core").Language;
+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 TextSourceCode = import("@eslint/core").TextSourceCode;
-export type ParseResult = import("@eslint/core").ParseResult;
+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": {
@@ -52,6 +59,9 @@ declare namespace plugin {
  * @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 */
 /**
  * JSON Language Object
  * @implements {Language}
@@ -60,10 +70,10 @@ declare class JSONLanguage implements Language {
     /**
      * Creates a new instance.
      * @param {Object} options The options to use for this instance.
-     * @param {"json"|"jsonc"} options.mode The parser mode to use.
+     * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
      */
     constructor({ mode }: {
-        mode: "json" | "jsonc";
+        mode: "json" | "jsonc" | "json5";
     });
     /**
      * The type of file to read.
@@ -106,10 +116,10 @@ declare class JSONLanguage implements Language {
     /**
      * Creates a new `JSONSourceCode` object from the given information.
      * @param {File} file The virtual file to create a `JSONSourceCode` object from.
-     * @param {ParseResult} parseResult The result returned from `parse()`.
+     * @param {OkParseResult} parseResult The result returned from `parse()`.
      * @returns {JSONSourceCode} The new `JSONSourceCode` object.
      */
-    createSourceCode(file: File, parseResult: ParseResult): JSONSourceCode;
+    createSourceCode(file: File, parseResult: OkParseResult): JSONSourceCode;
     #private;
 }
 /**
@@ -121,17 +131,17 @@ declare class JSONSourceCode implements TextSourceCode {
      * Creates a new instance.
      * @param {Object} options The options for the instance.
      * @param {string} options.text The source code text.
-     * @param {DocumentNode & SyntaxElement} options.ast The root AST node.
+     * @param {DocumentNode} options.ast The root AST node.
      */
     constructor({ text, ast }: {
         text: string;
-        ast: DocumentNode & SyntaxElement;
+        ast: DocumentNode;
     });
     /**
      * The AST of the source code.
-     * @type {DocumentNode & SyntaxElement}
+     * @type {DocumentNode}
      */
-    ast: DocumentNode & SyntaxElement;
+    ast: DocumentNode;
     /**
      * The text of the source code.
      * @type {string}
@@ -142,6 +152,18 @@ declare class JSONSourceCode implements TextSourceCode {
      * @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.
@@ -173,8 +195,67 @@ declare class JSONSourceCode implements TextSourceCode {
     public get lines(): any[];
     /**
      * Traverse the source code and return the steps that were taken.
-     * @returns {Iterable<TraversalStep>} The steps that were taken while traversing the source code.
+     * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
      */
-    traverse(): Iterable<TraversalStep>;
+    traverse(): Iterable<JSONTraversalStep>;
     #private;
 }
+/**
+ * @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 */
+/**
+ * A class to represent a step in the traversal process.
+ * @implements {VisitTraversalStep}
+ */
+declare class JSONTraversalStep implements VisitTraversalStep {
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options for the step.
+     * @param {JSONNode} 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;
+        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>;
+}

package/dist/esm/index.js

@@ -14,13 +14,12 @@ import { iterator, visitorKeys, parse } from '@humanwhocodes/momoa';
 /** @typedef {import("@humanwhocodes/momoa").DocumentNode} DocumentNode */
 /** @typedef {import("@humanwhocodes/momoa").Node} JSONNode */
 /** @typedef {import("@humanwhocodes/momoa").Token} JSONToken */
-/** @typedef {import("@eslint/core").SyntaxElement} SyntaxElement */
-/** @typedef {import("@eslint/core").Language} Language */
+/** @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").TextSourceCode} TextSourceCode */
-/** @typedef {import("@eslint/core").ParseResult} ParseResult */
+/** @typedef {import("@eslint/core").VisitTraversalStep} VisitTraversalStep */
 
 //-----------------------------------------------------------------------------
 // Helpers
@@ -48,7 +47,7 @@ class JSONTraversalStep {
 
 	/**
 	 * The target of the step.
-	 * @type {JSONNode & SyntaxElement}
+	 * @type {JSONNode}
 	 */
 	target;
 
@@ -67,7 +66,7 @@ class JSONTraversalStep {
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options for the step.
-	 * @param {JSONNode & SyntaxElement} options.target The target of the step.
+	 * @param {JSONNode} 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.
 	 */
@@ -107,7 +106,7 @@ class JSONSourceCode {
 
 	/**
 	 * The AST of the source code.
-	 * @type {DocumentNode & SyntaxElement}
+	 * @type {DocumentNode}
 	 */
 	ast;
 
@@ -127,7 +126,7 @@ class JSONSourceCode {
 	 * Creates a new instance.
 	 * @param {Object} options The options for the instance.
 	 * @param {string} options.text The source code text.
-	 * @param {DocumentNode & SyntaxElement} options.ast The root AST node.
+	 * @param {DocumentNode} options.ast The root AST node.
 	 */
 	constructor({ text, ast }) {
 		this.ast = ast;
@@ -137,6 +136,28 @@ class JSONSourceCode {
 		);
 	}
 
+	/* 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;
+	}
+
+	/**
+	 * 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.
@@ -203,7 +224,7 @@ class JSONSourceCode {
 
 	/**
 	 * Traverse the source code and return the steps that were taken.
-	 * @returns {Iterable<TraversalStep>} The steps that were taken while traversing the source code.
+	 * @returns {Iterable<JSONTraversalStep>} The steps that were taken while traversing the source code.
 	 */
 	traverse() {
 		// Because the AST doesn't mutate, we can cache the steps
@@ -211,15 +232,14 @@ class JSONSourceCode {
 			return this.#steps.values();
 		}
 
+		/** @type {Array<JSONTraversalStep>} */
 		const steps = (this.#steps = []);
 
-		for (const { node, parent, phase } of iterator(
-			/** @type {DocumentNode} */ (this.ast),
-		)) {
+		for (const { node, parent, phase } of iterator(this.ast)) {
 			this.#parents.set(node, parent);
 			steps.push(
 				new JSONTraversalStep({
-					target: /** @type {JSONNode & SyntaxElement} */ (node),
+					target: node,
 					phase: phase === "enter" ? 1 : 2,
 					args: [node, parent],
 				}),
@@ -240,6 +260,9 @@ class JSONSourceCode {
 // Types
 //-----------------------------------------------------------------------------
 
+/** @typedef {import("@eslint/core").Language} Language */
+/** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
+/** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
 
 //-----------------------------------------------------------------------------
 // Exports
@@ -276,7 +299,7 @@ class JSONLanguage {
 
 	/**
 	 * The parser mode.
-	 * @type {"json"|"jsonc"}
+	 * @type {"json"|"jsonc"|"json5"}
 	 */
 	#mode = "json";
 
@@ -289,7 +312,7 @@ class JSONLanguage {
 	/**
 	 * Creates a new instance.
 	 * @param {Object} options The options to use for this instance.
-	 * @param {"json"|"jsonc"} options.mode The parser mode to use.
+	 * @param {"json"|"jsonc"|"json5"} options.mode The parser mode to use.
 	 */
 	constructor({ mode }) {
 		this.#mode = mode;
@@ -331,7 +354,7 @@ class JSONLanguage {
 
 			return {
 				ok: true,
-				ast: /** @type {DocumentNode & SyntaxElement} */ (root),
+				ast: root,
 			};
 		} catch (ex) {
 			// error messages end with (line:column) so we strip that off for ESLint
@@ -355,7 +378,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 {ParseResult} parseResult The result returned from `parse()`.
+	 * @param {OkParseResult} parseResult The result returned from `parse()`.
 	 * @returns {JSONSourceCode} The new `JSONSourceCode` object.
 	 */
 	createSourceCode(file, parseResult) {
@@ -373,7 +396,7 @@ class JSONLanguage {
  */
 
 //-----------------------------------------------------------------------------
-// Type Definitions
+// Rule Definition
 //-----------------------------------------------------------------------------
 
 var noDuplicateKeys = {
@@ -400,7 +423,10 @@ var noDuplicateKeys = {
 			},
 
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (keys.has(key)) {
 					context.report({
@@ -442,7 +468,10 @@ var noEmptyKeys = {
 	create(context) {
 		return {
 			Member(node) {
-				const key = node.name.value;
+				const key =
+					node.name.type === "String"
+						? node.name.value
+						: node.name.name;
 
 				if (key.trim() === "") {
 					context.report({
@@ -466,9 +495,14 @@ var noEmptyKeys = {
 //-----------------------------------------------------------------------------
 
 const plugin = {
+	meta: {
+		name: "@eslint/json",
+		version: "0.3.0", // x-release-please-version
+	},
 	languages: {
 		json: new JSONLanguage({ mode: "json" }),
 		jsonc: new JSONLanguage({ mode: "jsonc" }),
+		json5: new JSONLanguage({ mode: "json5" }),
 	},
 	rules: {
 		"no-duplicate-keys": noDuplicateKeys,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint/json",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "JSON linting plugin for ESLint",
   "author": "Nicholas C. Zakas",
   "type": "module",
@@ -61,10 +61,10 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@humanwhocodes/momoa": "^3.1.1"
+    "@humanwhocodes/momoa": "^3.2.0"
   },
   "devDependencies": {
-    "@eslint/core": "^0.1.0",
+    "@eslint/core": "^0.3.0",
     "@types/eslint": "^8.56.10",
     "c8": "^9.1.0",
     "eslint": "^9.6.0",