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

Author: ota-meshi

.changeset/proud-cameras-pull.md

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

.eslintrc.js

@@ -38,6 +38,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: [
     {

lib/rules/auto.ts

@@ -1,3 +1,4 @@
+import { getFilename, getSourceCode } from "eslint-compat-utils";
 import type { RuleListener, RuleModule } from "../types";
 import { createRule } from "../utils";
 import { getAutoConfig } from "../utils/get-auto-jsonc-rules-config";
@@ -17,10 +18,11 @@ export default createRule("auto", {
     type: "suggestion",
   },
   create(context, params) {
-    if (!context.parserServices.isJSON) {
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
       return {};
     }
-    const autoConfig = getAutoConfig(context.getFilename());
+    const autoConfig = getAutoConfig(getFilename(context));
 
     const visitor: RuleListener = {};
     for (const ruleId of Object.keys(autoConfig)) {

lib/rules/key-name-casing.ts

@@ -1,8 +1,8 @@
 import type { AST } from "jsonc-eslint-parser";
-import type { RuleListener } from "../types";
 import { createRule } from "../utils";
 import type { CasingKind } from "../utils/casing";
 import { getChecker, allowedCaseOptions } from "../utils/casing";
+import { getSourceCode } from "eslint-compat-utils";
 
 type Option = {
   [key in CasingKind]?: boolean;
@@ -61,10 +61,10 @@ export default createRule("key-name-casing", {
     type: "suggestion",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
-      return {} as RuleListener;
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
+      return {};
     }
-    const sourceCode = context.getSourceCode();
     const option: Option = { ...context.options[0] };
     if (option.camelCase !== false) {
       option.camelCase = true;

lib/rules/no-bigint-literals.ts

@@ -1,5 +1,6 @@
 import type { AST } from "jsonc-eslint-parser";
 import { createRule } from "../utils";
+import { getSourceCode } from "eslint-compat-utils";
 
 export default createRule("no-bigint-literals", {
   meta: {
@@ -16,7 +17,8 @@ export default createRule("no-bigint-literals", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
       return {};
     }
     return {

lib/rules/no-binary-expression.ts

@@ -1,6 +1,7 @@
 import type { AST } from "jsonc-eslint-parser";
 import { getStaticJSONValue } from "jsonc-eslint-parser";
 import { createRule } from "../utils";
+import { getSourceCode } from "eslint-compat-utils";
 
 export default createRule("no-binary-expression", {
   meta: {
@@ -19,7 +20,8 @@ export default createRule("no-binary-expression", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
       return {};
     }
 

lib/rules/no-binary-numeric-literals.ts

@@ -1,5 +1,6 @@
 import type { AST } from "jsonc-eslint-parser";
 import { createRule } from "../utils";
+import { getSourceCode } from "eslint-compat-utils";
 
 const binaryNumericLiteralPattern = /^0[Bb]/u;
 
@@ -19,7 +20,8 @@ export default createRule("no-binary-numeric-literals", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
       return {};
     }
     return {

lib/rules/no-comments.ts

@@ -1,4 +1,4 @@
-import type { RuleListener } from "../types";
+import { getSourceCode } from "eslint-compat-utils";
 import { createRule } from "../utils";
 
 export default createRule("no-comments", {
@@ -16,10 +16,10 @@ export default createRule("no-comments", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
-      return {} as RuleListener;
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
+      return {};
     }
-    const sourceCode = context.getSourceCode();
     return {
       Program() {
         for (const comment of sourceCode.getAllComments()) {

lib/rules/no-escape-sequence-in-identifier.ts

@@ -1,6 +1,7 @@
 import type { AST } from "jsonc-eslint-parser";
 import { createRule } from "../utils";
 import { PatternMatcher } from "@eslint-community/eslint-utils";
+import { getSourceCode } from "eslint-compat-utils";
 
 export default createRule("no-escape-sequence-in-identifier", {
   meta: {
@@ -18,10 +19,10 @@ export default createRule("no-escape-sequence-in-identifier", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
       return {};
     }
-    const sourceCode = context.getSourceCode();
     return {
       JSONIdentifier(node: AST.JSONIdentifier) {
         verify(node);

lib/rules/no-hexadecimal-numeric-literals.ts

@@ -1,5 +1,6 @@
 import type { AST } from "jsonc-eslint-parser";
 import { createRule } from "../utils";
+import { getSourceCode } from "eslint-compat-utils";
 
 const hexadecimalNumericLiteralPattern = /^0[Xx]/u;
 
@@ -19,7 +20,8 @@ export default createRule("no-hexadecimal-numeric-literals", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isJSON) {
+    const sourceCode = getSourceCode(context);
+    if (!sourceCode.parserServices.isJSON) {
       return {};
     }
     return {