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

* feat: use eslint-compat-utils

* Create chilled-nails-mix.md

* fix

* fix

* fix

.changeset/chilled-nails-mix.md

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

.eslintrc.js

@@ -51,6 +51,39 @@ module.exports = {
         ],
       },
     ],
+    "no-restricted-properties": [
+      "error",
+      {
+        object: "context",
+        property: "getSourceCode",
+        message: "Use src/utils/compat.ts",
+      },
+      {
+        object: "context",
+        property: "getFilename",
+        message: "Use src/utils/compat.ts",
+      },
+      {
+        object: "context",
+        property: "getPhysicalFilename",
+        message: "Use src/utils/compat.ts",
+      },
+      {
+        object: "context",
+        property: "getCwd",
+        message: "Use src/utils/compat.ts",
+      },
+      {
+        object: "context",
+        property: "getScope",
+        message: "Use src/utils/compat.ts",
+      },
+      {
+        object: "context",
+        property: "parserServices",
+        message: "Use src/utils/compat.ts",
+      },
+    ],
   },
   overrides: [
     {

docs-build/shim/fs.mjs

@@ -1,4 +1,5 @@
 /* eslint require-jsdoc:0 -- shim */
-
-export {}
-export default {}
+export function existsSync() {
+  return true
+}
+export default { existsSync }

docs-build/shim/path.mjs

@@ -1,16 +1,24 @@
 /* eslint require-jsdoc:0 -- shim */
 
-function extname(p) {
+export function extname(p) {
   return /\.[\w$-]+$/iu.exec(p)[0]
 }
 
-function join(...args) {
+export function join(...args) {
   return args.join("/")
 }
 
-function isAbsolute() {
+export function isAbsolute() {
   return false
 }
 
-export { extname, join, isAbsolute }
-export default { extname, join, isAbsolute }
+export function basename(p, ext) {
+  const base = p.split("/").pop() || p
+  return base.endsWith(ext) ? base.slice(0, -ext.length) : base
+}
+
+export function dirname(p) {
+  return p.split("/").slice(0, -1).join("/") || p
+}
+
+export default { extname, join, isAbsolute, basename, dirname }

package.json

@@ -57,6 +57,7 @@
     "@jridgewell/sourcemap-codec": "^1.4.14",
     "@typescript-eslint/types": "^5.25.0",
     "astro-eslint-parser": "^0.16.0",
+    "eslint-compat-utils": "^0.1.2",
     "postcss": "^8.4.14",
     "postcss-selector-parser": "^6.0.10"
   },

src/a11y/rules.ts

@@ -5,6 +5,7 @@ import type { ASTNode } from "../types-for-node"
 import { createRule } from "../utils"
 import { a11yRuleKeys } from "./keys"
 import { getAttributeName } from "../utils/ast-utils"
+import { getSourceCode } from "../utils/compat"
 
 const TYPE_MAP: Partial<Record<ASTNode["type"], ASTNode["type"]>> = {
   AstroRawText: "JSXText",
@@ -94,7 +95,8 @@ function defineWrapperListener(
   coreRule: PluginRuleModule,
   context: RuleContext,
 ): RuleListener {
-  if (!context.parserServices.isAstro) {
+  const sourceCode = getSourceCode(context)
+  if (!sourceCode.parserServices.isAstro) {
     return {}
   }
   const listener = coreRule.create(context)

src/rules/no-conflict-set-directives.ts

@@ -1,6 +1,7 @@
 import type { AST } from "astro-eslint-parser"
 import { createRule } from "../utils"
 import { getAttributeName } from "../utils/ast-utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-conflict-set-directives", {
   meta: {
@@ -16,10 +17,10 @@ export default createRule("no-conflict-set-directives", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
-    const sourceCode = context.getSourceCode()
 
     return {
       JSXElement(node) {

src/rules/no-deprecated-astro-canonicalurl.ts

@@ -1,5 +1,6 @@
 import { READ, ReferenceTracker } from "@eslint-community/eslint-utils"
 import { createRule } from "../utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-deprecated-astro-canonicalurl", {
   meta: {
@@ -16,13 +17,14 @@ export default createRule("no-deprecated-astro-canonicalurl", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 
     return {
-      "Program:exit"() {
-        const tracker = new ReferenceTracker(context.getScope())
+      "Program:exit"(node) {
+        const tracker = new ReferenceTracker(sourceCode.getScope(node))
         for (const { node, path } of tracker.iterateGlobalReferences({
           Astro: {
             canonicalURL: { [READ]: true },

src/rules/no-deprecated-astro-fetchcontent.ts

@@ -1,5 +1,6 @@
 import { READ, ReferenceTracker } from "@eslint-community/eslint-utils"
 import { createRule } from "../utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-deprecated-astro-fetchcontent", {
   meta: {
@@ -17,13 +18,14 @@ export default createRule("no-deprecated-astro-fetchcontent", {
     fixable: "code",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 
     return {
-      "Program:exit"() {
-        const tracker = new ReferenceTracker(context.getScope())
+      "Program:exit"(node) {
+        const tracker = new ReferenceTracker(sourceCode.getScope(node))
         for (const { node, path } of tracker.iterateGlobalReferences({
           Astro: {
             fetchContent: { [READ]: true },

src/rules/no-deprecated-astro-resolve.ts

@@ -1,5 +1,6 @@
 import { READ, ReferenceTracker } from "@eslint-community/eslint-utils"
 import { createRule } from "../utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-deprecated-astro-resolve", {
   meta: {
@@ -15,13 +16,14 @@ export default createRule("no-deprecated-astro-resolve", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 
     return {
-      "Program:exit"() {
-        const tracker = new ReferenceTracker(context.getScope())
+      "Program:exit"(node) {
+        const tracker = new ReferenceTracker(sourceCode.getScope(node))
         for (const { node, path } of tracker.iterateGlobalReferences({
           Astro: {
             resolve: { [READ]: true },

src/rules/no-deprecated-getentrybyslug.ts

@@ -1,5 +1,6 @@
 import { createRule } from "../utils"
 import type { TSESTree } from "@typescript-eslint/types"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-deprecated-getentrybyslug", {
   meta: {
@@ -15,7 +16,8 @@ export default createRule("no-deprecated-getentrybyslug", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 

src/rules/no-set-html-directive.ts

@@ -1,6 +1,7 @@
 import type { AST } from "astro-eslint-parser"
 import { createRule } from "../utils"
 import { getAttributeName } from "../utils/ast-utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-set-html-directive", {
   meta: {
@@ -16,7 +17,8 @@ export default createRule("no-set-html-directive", {
     type: "suggestion",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 

src/rules/no-set-text-directive.ts

@@ -1,6 +1,7 @@
 import type { AST } from "astro-eslint-parser"
 import { createRule } from "../utils"
 import { getAttributeName } from "../utils/ast-utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-set-text-directive", {
   meta: {
@@ -17,7 +18,8 @@ export default createRule("no-set-text-directive", {
     fixable: "code",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 
@@ -43,7 +45,6 @@ export default createRule("no-set-text-directive", {
           ) {
             return
           }
-          const sourceCode = context.getSourceCode()
 
           const valueText =
             attr.type === "AstroTemplateLiteralAttribute"

src/rules/no-unused-css-selector.ts

@@ -15,6 +15,7 @@ import {
 } from "../utils/ast-utils"
 import type { StyleContentCSS } from "../utils/transform"
 import { getStyleContentCSS } from "../utils/transform"
+import { getSourceCode } from "../utils/compat"
 
 type JSXElementTreeNode = {
   parent: JSXElementTreeNode | RootJSXElementTreeNode
@@ -43,7 +44,8 @@ export default createRule("no-unused-css-selector", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
     const styles: AST.JSXElement[] = []
@@ -100,7 +102,6 @@ export default createRule("no-unused-css-selector", {
       function reportSelector(start: number, selector: string) {
         const remapStart = css.remap(start)
         const remapEnd = css.remap(start + selector.length)
-        const sourceCode = context.getSourceCode()
         context.report({
           loc: {
             start: sourceCode.getLocFromIndex(remapStart),
@@ -982,9 +983,10 @@ function* extractClassListFromExpression(
     }
     return
   }
+  const sourceCode = getSourceCode(context)
   const staticValue = getStaticValue(
     node as never,
-    context.getSourceCode().scopeManager.globalScope!,
+    sourceCode.scopeManager.globalScope!,
   )
   if (staticValue) {
     yield* extractClassListFromUnknown(staticValue.value)

src/rules/no-unused-define-vars-in-style.ts

@@ -5,6 +5,7 @@ import { getPropertyName } from "@eslint-community/eslint-utils"
 import { createRule } from "../utils"
 import { getAttributeName } from "../utils/ast-utils"
 import { iterateCSSVars } from "../utils/style"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("no-unused-define-vars-in-style", {
   meta: {
@@ -20,7 +21,8 @@ export default createRule("no-unused-define-vars-in-style", {
     type: "problem",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 
@@ -63,7 +65,7 @@ export default createRule("no-unused-define-vars-in-style", {
           )
           .map((prop) => ({
             prop,
-            name: getPropertyName(prop, context.getScope()),
+            name: getPropertyName(prop, sourceCode.getScope(node)),
           }))
           .filter((data): data is typeof data & { name: string } =>
             Boolean(data.name),

src/rules/prefer-class-list-directive.ts

@@ -1,6 +1,7 @@
 import type { AST } from "astro-eslint-parser"
 import { createRule } from "../utils"
 import { getAttributeName } from "../utils/ast-utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("prefer-class-list-directive", {
   meta: {
@@ -19,7 +20,8 @@ export default createRule("prefer-class-list-directive", {
     type: "suggestion",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
 

src/rules/prefer-object-class-list.ts

@@ -15,6 +15,7 @@ import {
   isStringLiteral,
   needParentheses,
 } from "../utils/ast-utils"
+import { getSourceCode } from "../utils/compat"
 
 export default createRule("prefer-object-class-list", {
   meta: {
@@ -32,10 +33,10 @@ export default createRule("prefer-object-class-list", {
     type: "suggestion",
   },
   create(context) {
-    if (!context.parserServices.isAstro) {
+    const sourceCode = getSourceCode(context)
+    if (!sourceCode.parserServices.isAstro) {
       return {}
     }
-    const sourceCode = context.getSourceCode()
 
     type Expr = {
       not?: true