feat: use eslint-compat-utils (#251)

* feat: use eslint-compat-utils

* Create unlucky-spoons-sniff.md

* fix

Author: ota-meshi

.changeset/unlucky-spoons-sniff.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-json-schema-validator": minor
+---
+
+feat: use eslint-compat-utils

.eslintrc.js

@@ -46,6 +46,57 @@ module.exports = {
         ],
       },
     ],
+    "no-restricted-properties": [
+      "error",
+      {
+        object: "context",
+        property: "getSourceCode",
+        message:
+          "Please use `eslint-compat-utils` module's `getSourceCode(context).getScope()` instead.",
+      },
+      {
+        object: "context",
+        property: "sourceCode",
+        message:
+          "Please use `eslint-compat-utils` module's `getSourceCode(context).getScope()` instead.",
+      },
+      {
+        object: "context",
+        property: "getFilename",
+        message:
+          "Please use `eslint-compat-utils` module's `getFilename(context)` instead.",
+      },
+      {
+        object: "context",
+        property: "filename",
+        message:
+          "Please use `eslint-compat-utils` module's `getFilename(context)` instead.",
+      },
+      {
+        object: "context",
+        property: "getCwd",
+        message:
+          "Please use `eslint-compat-utils` module's `getCwd(context)` instead.",
+      },
+      {
+        object: "context",
+        property: "cwd",
+        message:
+          "Please use `eslint-compat-utils` module's `getCwd(context)` instead.",
+      },
+      {
+        object: "context",
+        property: "getScope",
+        message:
+          "Please use `eslint-compat-utils` module's `getSourceCode(context).getScope()` instead.",
+      },
+      {
+        object: "context",
+        property: "parserServices",
+        message:
+          "Please use `eslint-compat-utils` module's `getSourceCode(context).parserServices` instead.",
+      },
+    ],
   },
   overrides: [
     {

package.json

@@ -53,6 +53,7 @@
     "@eslint-community/eslint-utils": "^4.3.0",
     "ajv": "^8.0.0",
     "debug": "^4.3.1",
+    "eslint-compat-utils": "^0.1.2",
     "json-schema-migrate": "^2.0.0",
     "jsonc-eslint-parser": "^2.0.0",
     "minimatch": "^8.0.0",
@@ -83,7 +84,7 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-eslint-plugin": "^5.0.0",
-    "eslint-plugin-json-schema-validator": "^4.0.0",
+    "eslint-plugin-json-schema-validator": "^4.6.1",
     "eslint-plugin-jsonc": "^2.0.0",
     "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-n": "^16.0.0",

src/rules/no-invalid.ts

@@ -26,6 +26,7 @@ import type { ValidateError, Validator } from "../utils/validator-factory";
 import { compile } from "../utils/validator-factory";
 import type { SchemaObject } from "../utils/types";
 import fs from "fs";
+import { getCwd, getFilename, getSourceCode } from "../utils/compat";
 
 const CATALOG_URL = "https://www.schemastore.org/api/json/catalog.json";
 
@@ -161,6 +162,7 @@ export default createRule("no-invalid", {
     type: "suggestion",
   },
   create(context, { filename }) {
+    const sourceCode = getSourceCode(context);
     const cwd = getCwd(context);
     const relativeFilename = filename.startsWith(cwd)
       ? path.relative(cwd, filename)
@@ -172,7 +174,6 @@ export default createRule("no-invalid", {
     }
 
     let existsExports = false;
-    const sourceCode = context.getSourceCode();
 
     /**
      * Validate JSON Schema
@@ -254,17 +255,17 @@ export default createRule("no-invalid", {
 
     return {
       Program(node) {
-        if (context.parserServices.isJSON) {
+        if (sourceCode.parserServices.isJSON) {
           const program = node as JSONAST.JSONProgram;
           validateData(getStaticJSONValue(program), (error) => {
             return errorDataToLoc(getJSONNodeFromPath(program, error.path));
           });
-        } else if (context.parserServices.isYAML) {
+        } else if (sourceCode.parserServices.isYAML) {
           const program = node as YAML.YAMLProgram;
           validateData(getStaticYAMLValue(program), (error) => {
             return errorDataToLoc(getYAMLNodeFromPath(program, error.path));
           });
-        } else if (context.parserServices.isTOML) {
+        } else if (sourceCode.parserServices.isTOML) {
           const program = node as TOML.TOMLProgram;
           validateData(getStaticTOMLValue(program), (error) => {
             return errorDataToLoc(getTOMLNodeFromPath(program, error.path));
@@ -358,13 +359,13 @@ export default createRule("no-invalid", {
     /** Find schema path from program */
     function findSchemaPath(node: unknown) {
       let $schema = null;
-      if (context.parserServices.isJSON) {
+      if (sourceCode.parserServices.isJSON) {
         const program = node as JSONAST.JSONProgram;
         $schema = findSchemaPathFromJSON(program);
-      } else if (context.parserServices.isYAML) {
+      } else if (sourceCode.parserServices.isYAML) {
         const program = node as YAML.YAMLProgram;
         $schema = findSchemaPathFromYAML(program);
-      } else if (context.parserServices.isTOML) {
+      } else if (sourceCode.parserServices.isTOML) {
         const program = node as TOML.TOMLProgram;
         $schema = findSchemaPathFromTOML(program);
       }
@@ -374,7 +375,7 @@ export default createRule("no-invalid", {
               path.dirname(
                 typeof context.getPhysicalFilename === "function"
                   ? context.getPhysicalFilename()
-                  : getPhysicalFilename(context.getFilename()),
+                  : getPhysicalFilename(getFilename(context)),
               ),
               $schema,
             )
@@ -384,7 +385,7 @@ export default createRule("no-invalid", {
 
     /** Validator from $schema */
     function get$SchemaValidators(context: RuleContext): Validator[] | null {
-      const $schemaPath = findSchemaPath(context.getSourceCode().ast);
+      const $schemaPath = findSchemaPath(sourceCode.ast);
       if (!$schemaPath) return null;
 
       const validator = schemaPathToValidator($schemaPath, context);
@@ -560,16 +561,6 @@ export default createRule("no-invalid", {
   },
 });
 
-/**
- * Get cwd
- */
-function getCwd(context: RuleContext) {
-  if (context.getCwd) {
-    return context.getCwd();
-  }
-  return path.resolve("");
-}
-
 /**
  * ! copied from https://github.com/mdx-js/eslint-mdx/blob/b97db2e912a416d5d40ddb78ab6c9fa1ab150c17/packages/eslint-mdx/src/helpers.ts#L28-L50
  *

src/types.ts

@@ -4,7 +4,7 @@ import type { Rule } from "eslint";
 import type { AST as JSON } from "jsonc-eslint-parser";
 import type { AST as YAML } from "yaml-eslint-parser";
 import type { AST as TOML } from "toml-eslint-parser";
-import type { AST as ES } from "eslint";
+import type { AST as ES, Scope } from "eslint";
 import type { Comment as ESTreeComment } from "estree";
 import type { ESLintNode, VElement } from "vue-eslint-parser/ast";
 export interface RuleListener {
@@ -105,6 +105,7 @@ export interface SourceCode {
   visitorKeys: {
     [nodeType: string]: string[];
   };
+  scopeManager: Scope.ScopeManager;
 
   getText(
     node?: NodeOrToken,

src/utils/ast/js/utils.ts

@@ -13,6 +13,7 @@ import type { RuleContext } from "../../../types";
 // @ts-expect-error -- no type def
 import * as eslintUtils from "@eslint-community/eslint-utils";
 import type { Variable } from "eslint-scope";
+import { getSourceCode } from "../../compat";
 
 /**
  * Gets the property name of a given node.
@@ -145,7 +146,7 @@ export function findInitNode(
 function getScope(context: RuleContext, currentNode: ESLintNode) {
   // On Program node, get the outermost scope to avoid return Node.js special function scope or ES modules scope.
   const inner = currentNode.type !== "Program";
-  const scopeManager = (context.getSourceCode() as any).scopeManager;
+  const scopeManager = getSourceCode(context).scopeManager;
 
   let node: any = currentNode;
   for (; node; node = node.parent || null) {

src/utils/compat.ts

@@ -0,0 +1,34 @@
+import {
+  getSourceCode as getSourceCodeBase,
+  getFilename as getFilenameBase,
+  getCwd as getCwdBase,
+} from "eslint-compat-utils";
+import type { RuleContext, SourceCode } from "../types";
+import type { Rule, SourceCode as ESLintSourceCode } from "eslint";
+
+export function getSourceCode(context: RuleContext): SourceCode;
+export function getSourceCode(context: Rule.RuleContext): ESLintSourceCode;
+/**
+ * Returns an extended instance of `context.sourceCode` or the result of `context.getSourceCode()`.
+ * Extended instances can use new APIs such as `getScope(node)` even with old ESLint.
+ */
+export function getSourceCode(
+  context: RuleContext | Rule.RuleContext,
+): SourceCode | ESLintSourceCode {
+  return getSourceCodeBase(context as never) as never;
+}
+
+/**
+ * Gets the value of `context.filename`, but for older ESLint it returns the result of `context.getFilename()`.
+ */
+export function getFilename(context: RuleContext | Rule.RuleContext): string {
+  return getFilenameBase(context as never);
+}
+
+/**
+ * Gets the value of `context.cwd`, but for older ESLint it returns the result of `context.getCwd()`.
+ * Versions older than v6.6.0 return a value from the result of `process.cwd()`.
+ */
+export function getCwd(context: RuleContext | Rule.RuleContext): string {
+  return getCwdBase(context as never);
+}

src/utils/index.ts

@@ -11,6 +11,7 @@ import * as jsoncESLintParser from "jsonc-eslint-parser";
 import * as yamlESLintParser from "yaml-eslint-parser";
 import * as tomlESLintParser from "toml-eslint-parser";
 import path from "path";
+import { getFilename, getSourceCode } from "./compat";
 
 /**
  * Define the rule.
@@ -32,17 +33,18 @@ export function createRule(
       },
     },
     create(context: Rule.RuleContext): any {
-      const filename = context.getFilename();
+      const sourceCode = getSourceCode(context);
+      const filename = getFilename(context);
       const visitor = rule.create(context as any, {
         customBlock: false,
         filename,
       });
       if (
-        typeof context.parserServices.defineCustomBlocksVisitor ===
+        typeof sourceCode.parserServices.defineCustomBlocksVisitor ===
           "function" &&
         path.extname(filename) === ".vue"
       ) {
-        const jsonVisitor = context.parserServices.defineCustomBlocksVisitor(
+        const jsonVisitor = sourceCode.parserServices.defineCustomBlocksVisitor(
           context,
           jsoncESLintParser,
           {
@@ -63,7 +65,7 @@ export function createRule(
             },
           },
         );
-        const yamlVisitor = context.parserServices.defineCustomBlocksVisitor(
+        const yamlVisitor = sourceCode.parserServices.defineCustomBlocksVisitor(
           context,
           yamlESLintParser,
           {
@@ -79,7 +81,7 @@ export function createRule(
             },
           },
         );
-        const tomlVisitor = context.parserServices.defineCustomBlocksVisitor(
+        const tomlVisitor = sourceCode.parserServices.defineCustomBlocksVisitor(
           context,
           tomlESLintParser,
           {

src/utils/schema.ts

@@ -5,6 +5,7 @@ import { syncGet, get } from "./http-client";
 import debugBuilder from "debug";
 import type { SchemaObject } from "./types";
 import { draft7 as migrateToDraft7 } from "json-schema-migrate";
+import { getCwd } from "./compat";
 const debug = debugBuilder("eslint-plugin-json-schema-validator:utils-schema");
 
 const TTL = 1000 * 60 * 60 * 24;
@@ -248,13 +249,3 @@ function resolvePath(modulePath: string | void, context: RuleContext) {
   }
   return modulePath;
 }
-
-/**
- * Get cwd
- */
-function getCwd(context: RuleContext) {
-  if (context.getCwd) {
-    return context.getCwd();
-  }
-  return path.resolve("");
-}