fix: Update types from @eslint/core

Author: nzakas

package.json

@@ -67,7 +67,7 @@
     "@humanwhocodes/momoa": "^3.3.3"
   },
   "devDependencies": {
-    "@eslint/core": "^0.6.0",
+    "@eslint/core": "^0.9.0",
     "@types/eslint": "^8.56.10",
     "c8": "^9.1.0",
     "dedent": "^1.5.3",

src/languages/json-language.js

@@ -21,11 +21,8 @@ import { visitorKeys } from "@humanwhocodes/momoa";
 /** @typedef {import("@eslint/core").OkParseResult<DocumentNode>} OkParseResult */
 /** @typedef {import("@eslint/core").ParseResult<DocumentNode>} ParseResult */
 /** @typedef {import("@eslint/core").File} File */
-/**
- * @typedef {Object} JSONLanguageOptions
- * @property {boolean} [allowTrailingCommas] Whether to allow trailing commas.
- */
 /** @typedef {import("../types.ts").IJSONLanguage} IJSONLanguage */
+/** @typedef {import("../types.ts").JSONLanguageOptions} JSONLanguageOptions */
 
 //-----------------------------------------------------------------------------
 // Exports

src/languages/json-source-code.js

@@ -119,26 +119,6 @@ export class JSONSourceCode extends TextSourceCodeBase {
 			: [];
 	}
 
-	/* eslint-disable class-methods-use-this -- Required to complete interface. */
-
-	/**
-	 * Returns the loc information for the given node or token.
-	 * @param {JSONSyntaxElement} 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 {JSONSyntaxElement} 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;
-	}
-
 	/**
 	 * Returns the value of the given comment.
 	 * @param {JSONToken} comment The comment to get the value of.
@@ -169,7 +149,7 @@ export class JSONSourceCode extends TextSourceCodeBase {
 			);
 		}
 
-		return this.#inlineConfigComments;
+		return this.#inlineConfigComments ?? [];
 	}
 
 	/**

src/rules/no-duplicate-keys.js

@@ -7,17 +7,17 @@
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("../types.ts").JSONRuleVisitor} JSONRuleVisitor */
-/** @typedef {import("../../../rewrite/packages/core/src/types.ts").RuleDefinition<JSONRuleVisitor>} RuleDefinition */
+/** @typedef {"duplicateKey"} NoDuplicateKeysMessageIds */
+/** @typedef {import("../types.ts").JSONRuleDefinition<[], NoDuplicateKeysMessageIds>} NoDuplicateKeysRuleDefinition */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
 //-----------------------------------------------------------------------------
 
-/** @type {RuleDefinition} */
+/** @type {NoDuplicateKeysRuleDefinition} */
 export default {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow duplicate keys in JSON objects",

src/rules/no-empty-keys.js

@@ -7,17 +7,17 @@
 // Type Definitions
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("../types.ts").JSONRuleVisitor} JSONRuleVisitor */
-/** @typedef {import("../../../rewrite/packages/core/src/types.ts").RuleDefinition<JSONRuleVisitor>} RuleDefinition */
+/** @typedef {"emptyKey"} NoEmptyKeysMessageIds */
+/** @typedef {import("../types.ts").JSONRuleDefinition<[], NoEmptyKeysMessageIds>} NoEmptyKeysRuleDefinition */
 
 //-----------------------------------------------------------------------------
 // Rule Definition
 //-----------------------------------------------------------------------------
 
-/** @type {RuleDefinition} */
+/** @type {NoEmptyKeysRuleDefinition} */
 export default {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow empty keys in JSON objects",

src/rules/no-unsafe-values.js

@@ -3,9 +3,21 @@
  * @author Bradley Meck Farias
  */
 
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {"unsafeNumber"|"loneSurrogate"} NoUnsafeValuesMessageIds */
+/** @typedef {import("../types.ts").JSONRuleDefinition<[], NoUnsafeValuesMessageIds>} NoUnsafeValuesRuleDefinition */
+
+//-----------------------------------------------------------------------------
+// Rule Definition
+//-----------------------------------------------------------------------------
+
+/** @type {NoUnsafeValuesRuleDefinition} */
 export default {
 	meta: {
-		type: /** @type {const} */ ("problem"),
+		type: "problem",
 
 		docs: {
 			description: "Disallow JSON values that are unsafe for interchange",

src/types.ts

@@ -11,7 +11,9 @@ import type {
 	RuleVisitor,
 	TextSourceCode,
 	Language,
-} from "../../rewrite/packages/core/src/types.ts";
+	LanguageOptions,
+	RuleDefinition,
+} from "@eslint/core";
 import {
 	DocumentNode,
 	MemberNode,
@@ -43,7 +45,12 @@ export type JSONSyntaxElement = Token | AnyNode;
 /**
  * Language options provided for JSON files.
  */
-export type JSONLanguageOptions = Record<string, unknown>;
+export interface JSONLanguageOptions extends LanguageOptions {
+	/**
+	 * Whether to allow trailing commas. Only valid in JSONC.
+	 */
+	allowTrailingCommas?: boolean;
+}
 
 /**
  * The visitor format returned from rules in this package.
@@ -82,9 +89,8 @@ export interface JSONRuleVisitor extends RuleVisitor {
 export type IJSONSourceCode = TextSourceCode<{
 	LangOptions: JSONLanguageOptions;
 	RootNode: DocumentNode;
-	Node: JSONSyntaxElement;
 	SyntaxElementWithLoc: JSONSyntaxElement;
-	ConfigNode: null;
+	ConfigNode: Token;
 }>;
 
 export type IJSONLanguage = Language<{
@@ -93,3 +99,16 @@ export type IJSONLanguage = Language<{
 	RootNode: DocumentNode;
 	Node: AnyNode;
 }>;
+
+export type JSONRuleDefinition<
+	JSONRuleOptions extends unknown[],
+	JSONRuleMessageIds extends string = "",
+> = RuleDefinition<{
+	LangOptions: JSONLanguageOptions;
+	Code: IJSONSourceCode;
+	RuleOptions: JSONRuleOptions;
+	Visitor: JSONRuleVisitor;
+	Node: AnyNode;
+	MessageIds: JSONRuleMessageIds;
+	ExtRuleDocs: {};
+}>;

tests/types/types.test.ts

@@ -1,7 +1,7 @@
 import json from "@eslint/json";
-import { ESLint } from "eslint";
+// import { ESLint } from "eslint";
 
-json satisfies ESLint.Plugin;
+// json satisfies ESLint.Plugin;
 json.meta.name satisfies string;
 json.meta.version satisfies string;
 

tools/dedupe-types.js

@@ -42,7 +42,7 @@ files.forEach(filePath => {
 	// replace references to ../types.ts with types.ts
 	const text = remainingLines
 		.join("\n")
-		.replace(/\.\.\/types\.ts/gu, "types.ts");
+		.replace(/\.\.\/types\.ts/gu, "./types.ts");
 
 	fs.writeFileSync(filePath, text, "utf8");
 });

tsconfig.json

@@ -6,7 +6,7 @@
     "allowJs": true,
     "checkJs": true,
     "outDir": "dist/esm",
-    "target": "ES2022",
+    "target": "ESNext",
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "allowImportingTsExtensions": true