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

* feat: use eslint-compat-utils

* Create rich-goats-notice.md

* fix

Author: ota-meshi

.changeset/rich-goats-notice.md

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

.eslintrc.js

@@ -23,6 +23,55 @@ module.exports = {
     "@typescript-eslint/ban-ts-ignore": "off",
     "eslint-comments/no-unused-disable": "error",
     "@typescript-eslint/no-non-null-assertion": "off",
+    // Repo rule
+    "@typescript-eslint/no-restricted-imports": [
+      "error",
+      {
+        patterns: [
+          {
+            group: ["/regexpp", "/regexpp/*"],
+            message: "Please use `@eslint-community/regexpp` instead.",
+          },
+          {
+            group: ["/eslint-utils", "/eslint-utils/*"],
+            message: "Please use `@eslint-community/eslint-utils` instead.",
+          },
+        ],
+      },
+    ],
+    "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: [
     {

.github/workflows/format.yml

@@ -0,0 +1,31 @@
+name: 👔 Format
+
+on:
+  workflow_dispatch: null
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Setup node
+        uses: actions/setup-node@v4
+      - name: Install deps
+        run: npm install
+      - name: Format
+        run: npm run eslint-fix
+      - name: Commit
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+          git add .
+          if [ -z "$(git status --porcelain)" ]; then
+            echo "no formatting changed"
+            exit 0
+          fi
+          git commit -m "chore: format"
+          git push
+          echo "pushed formatting changes https://github.com/$GITHUB_REPOSITORY/commit/$(git rev-parse HEAD)"

docs/.vuepress/components/demo/stylelint.config.js

@@ -2,7 +2,6 @@ module.exports = {
     extends: ["stylelint-config-standard"],
     rules: {
         "no-descending-specificity": null,
-        indentation: null,
         "selector-max-empty-lines": null,
         "selector-type-no-unknown": null,
         "block-no-empty": null,

docs/.vuepress/components/stylelint.config.js

@@ -2,6 +2,5 @@ module.exports = {
   extends: ["stylelint-config-standard", "stylelint-config-recommended-vue"],
   rules: {
     "no-descending-specificity": null,
-    indentation: null,
   },
 };

lib/rules/enforce-style-type.ts

@@ -11,6 +11,7 @@ import {
   isValidStyleContext,
   getCommentDirectivesReporter,
 } from "../styles/context";
+import { getSourceCode } from "../utils/compat";
 
 const styleTypesAttrs = ["scoped", "module"] as const;
 type StyleTypes = "plain" | (typeof styleTypesAttrs)[number];
@@ -64,8 +65,9 @@ export = {
     }
 
     const reporter = getCommentDirectivesReporter(context);
+    const sourceCode = getSourceCode(context);
     const tokenStore =
-      context.parserServices.getTemplateBodyTokenStore?.() as TokenStore;
+      sourceCode.parserServices.getTemplateBodyTokenStore?.() as TokenStore;
     const { options } = context;
 
     const allows: AllowsOption = options[0]?.allows ?? ["scoped"];

lib/rules/no-deprecated-deep-combinator.ts

@@ -7,6 +7,7 @@ import {
 import type { VCSSSelectorCombinator } from "../styles/ast";
 import type { RuleContext, Range, RuleListener } from "../types";
 import { isDeepCombinator } from "../styles/utils/selectors";
+import { getSourceCode } from "../utils/compat";
 
 export = {
   meta: {
@@ -45,7 +46,7 @@ export = {
           value: node.value.trim(),
         },
         fix(fixer) {
-          const sourceCodeText = context.getSourceCode().text;
+          const sourceCodeText = getSourceCode(context).text;
           const range = [...node.range] as Range;
           let newText = "::v-deep";
           if (sourceCodeText[range[0] - 1]?.trim()) {

lib/rules/no-unused-keyframes.ts

@@ -7,6 +7,7 @@ import {
   getCommentDirectivesReporter,
 } from "../styles/context";
 import { isValidStyleContext } from "../styles/context/style";
+import { getSourceCode } from "../utils/compat";
 
 export = {
   meta: {
@@ -42,7 +43,7 @@ export = {
       return {};
     }
     const reporter = getCommentDirectivesReporter(context);
-    const sourceCode = context.getSourceCode();
+    const sourceCode = getSourceCode(context);
 
     /**
      * Reports the given node

lib/rules/require-scoped.ts

@@ -10,6 +10,7 @@ import {
   isValidStyleContext,
   getCommentDirectivesReporter,
 } from "../styles/context";
+import { getSourceCode } from "../utils/compat";
 
 export = {
   meta: {
@@ -40,8 +41,9 @@ export = {
       return {};
     }
     const reporter = getCommentDirectivesReporter(context);
+    const sourceCode = getSourceCode(context);
     const tokenStore =
-      context.parserServices.getTemplateBodyTokenStore?.() as TokenStore;
+      sourceCode.parserServices.getTemplateBodyTokenStore?.() as TokenStore;
 
     /**
      * Reports the given node.

lib/rules/require-v-deep-argument.ts

@@ -22,6 +22,7 @@ import {
   isVCSSDeclarationProperty,
   isVCSSComment,
 } from "../styles/utils/css-nodes";
+import { getSourceCode } from "../utils/compat";
 
 export = {
   meta: {
@@ -90,8 +91,7 @@ export = {
             nextNode.range[0],
           ];
           if (
-            context
-              .getSourceCode()
+            getSourceCode(context)
               .text.slice(...betweenRange)
               .trim()
           ) {