chore: minor refactor and add integration test (#371)

* chore: minor refactor and add integration test

* fix

* fix

.github/workflows/NodeCI.yml

@@ -61,6 +61,15 @@ jobs:
         run: npm install -f
       - name: Test
         run: npm test
+  test-integration:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - name: Install Packages
+        run: npm install -f
+      - name: Test
+        run: npm run test:integration
   test-and-coverage:
     runs-on: ubuntu-latest
     steps:

.github/workflows/Release.yml

@@ -22,9 +22,6 @@ jobs:
       - name: Install Dependencies
         run: npm install -f
 
-      - name: Build
-        run: npm run build:tsup
-
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1

.gitignore

@@ -108,3 +108,4 @@ dist
 /docs-build/shim/eslint.mjs
 /docs-build/shim/astro-eslint-parser.mjs
 /docs-build/shim/eslint-plugin-jsx-a11y.mjs
+/tests/fixtures/integration/**/actual.json

eslint.config.cjs

@@ -29,6 +29,8 @@ module.exports = [
       "tests/fixtures/rules/valid-compile/valid/babel/",
       "tests/fixtures/rules/valid-compile/valid/ts/",
       "tests/fixtures/rules/prefer-style-directive/",
+      "tests/fixtures/integration/**/actual.json",
+      "tests/fixtures/integration/*/src/",
       "build/",
     ],
   },

package.json

@@ -24,6 +24,8 @@
     "build:tsup": "tsup",
     "clean": "rimraf .nyc_output dist coverage",
     "test": "npm run mocha -- \"tests/src/**/*.ts\" --reporter dot --timeout 60000 && npm run test:type",
+    "test:integration": "npm run build && npm run test:integration-wo-build",
+    "test:integration-wo-build": "npm run mocha -- \"tests/integration/**/*.ts\" --reporter dot --timeout 60000",
     "test:type": "tsc --noEmit",
     "cover": "nyc --reporter=lcov npm run test",
     "debug": "npm run mocha -- \"tests/src/**/*.ts\" --reporter dot --timeout 60000",

src/plugin-config-builder.ts → src/cjs-config-builder.ts

@@ -7,56 +7,6 @@ import flatAll from "./configs/flat/all"
 import { buildA11yFlatConfigs, buildA11yLegacyConfigs } from "./a11y"
 import type { Linter } from "eslint"
 
-type ESMConfigs = {
-  base: Linter.FlatConfig[]
-  recommended: Linter.FlatConfig[]
-  all: Linter.FlatConfig[]
-  "jsx-a11y-strict": Linter.FlatConfig[]
-  "jsx-a11y-recommended": Linter.FlatConfig[]
-  // For backward compatibility
-  "flat/base": Linter.FlatConfig[]
-  "flat/recommended": Linter.FlatConfig[]
-  "flat/all": Linter.FlatConfig[]
-  "flat/jsx-a11y-strict": Linter.FlatConfig[]
-  "flat/jsx-a11y-recommended": Linter.FlatConfig[]
-}
-/**
- * Build configs for ESM Module
- */
-export function buildEsmConfigs(): ESMConfigs {
-  const esmConfigs: ESMConfigs = {
-    base: flatBase as Linter.FlatConfig[],
-    recommended: flatRecommended as Linter.FlatConfig[],
-    all: flatAll as Linter.FlatConfig[],
-    "jsx-a11y-strict": null as never,
-    "jsx-a11y-recommended": null as never,
-    // For backward compatibility
-    "flat/base": flatBase as Linter.FlatConfig[],
-    "flat/recommended": flatRecommended as Linter.FlatConfig[],
-    "flat/all": flatAll as Linter.FlatConfig[],
-    "flat/jsx-a11y-strict": null as never,
-    "flat/jsx-a11y-recommended": null as never,
-  }
-
-  const a11yFlatConfigs = buildA11yFlatConfigs()
-  for (const configName of Object.keys(a11yFlatConfigs)) {
-    Object.defineProperty(esmConfigs, configName, {
-      enumerable: true,
-      get() {
-        return a11yFlatConfigs[configName]
-      },
-    })
-    Object.defineProperty(esmConfigs, `flat/${configName}`, {
-      enumerable: true,
-      get() {
-        return a11yFlatConfigs[configName]
-      },
-    })
-  }
-
-  return esmConfigs
-}
-
 type CJSConfigs = {
   base: Linter.Config
   recommended: Linter.Config

src/configs/flat/base.ts

@@ -14,8 +14,8 @@ export default [
   {
     plugins: {
       get astro(): ESLint.Plugin {
-        // eslint-disable-next-line @typescript-eslint/no-require-imports -- ignore
-        return (plugin ??= require("../../plugin-without-config"))
+        // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -- ignore
+        return (plugin ??= require("../../plugin").plugin)
       },
     },
   },

src/esm-config-builder.ts

@@ -0,0 +1,55 @@
+import flatBase from "./configs/flat/base"
+import flatRecommended from "./configs/flat/recommended"
+import flatAll from "./configs/flat/all"
+import { buildA11yFlatConfigs } from "./a11y"
+import type { Linter } from "eslint"
+
+type ESMConfigs = {
+  base: Linter.FlatConfig[]
+  recommended: Linter.FlatConfig[]
+  all: Linter.FlatConfig[]
+  "jsx-a11y-strict": Linter.FlatConfig[]
+  "jsx-a11y-recommended": Linter.FlatConfig[]
+  // For backward compatibility
+  "flat/base": Linter.FlatConfig[]
+  "flat/recommended": Linter.FlatConfig[]
+  "flat/all": Linter.FlatConfig[]
+  "flat/jsx-a11y-strict": Linter.FlatConfig[]
+  "flat/jsx-a11y-recommended": Linter.FlatConfig[]
+}
+/**
+ * Build configs for ESM Module
+ */
+export function buildEsmConfigs(): ESMConfigs {
+  const esmConfigs: ESMConfigs = {
+    base: flatBase as Linter.FlatConfig[],
+    recommended: flatRecommended as Linter.FlatConfig[],
+    all: flatAll as Linter.FlatConfig[],
+    "jsx-a11y-strict": null as never,
+    "jsx-a11y-recommended": null as never,
+    // For backward compatibility
+    "flat/base": flatBase as Linter.FlatConfig[],
+    "flat/recommended": flatRecommended as Linter.FlatConfig[],
+    "flat/all": flatAll as Linter.FlatConfig[],
+    "flat/jsx-a11y-strict": null as never,
+    "flat/jsx-a11y-recommended": null as never,
+  }
+
+  const a11yFlatConfigs = buildA11yFlatConfigs()
+  for (const configName of Object.keys(a11yFlatConfigs)) {
+    Object.defineProperty(esmConfigs, configName, {
+      enumerable: true,
+      get() {
+        return a11yFlatConfigs[configName]
+      },
+    })
+    Object.defineProperty(esmConfigs, `flat/${configName}`, {
+      enumerable: true,
+      get() {
+        return a11yFlatConfigs[configName]
+      },
+    })
+  }
+
+  return esmConfigs
+}

src/index.cts

@@ -1,4 +1,4 @@
-import { buildCjsConfigs } from "./plugin-config-builder"
-import { meta, rules, processors, environments } from "./plugin-without-config"
+import { buildCjsConfigs } from "./cjs-config-builder"
+import { plugin } from "./plugin"
 const configs = buildCjsConfigs()
-export = { meta, configs, rules, processors, environments }
+export = Object.assign(plugin, { configs })

src/index.mts

@@ -1,5 +1,5 @@
-import { buildEsmConfigs } from "./plugin-config-builder"
-import { meta, rules, processors, environments } from "./plugin-without-config"
-const configs = buildEsmConfigs()
-export default { meta, configs, rules, processors, environments }
-export { meta, configs, rules, processors, environments }
+import { buildEsmConfigs } from "./esm-config-builder"
+import { plugin } from "./plugin"
+export const configs = buildEsmConfigs()
+export default Object.assign(plugin, { configs })
+export const { meta, rules, processors, environments } = plugin

src/plugin-without-config.ts → src/plugin.ts

@@ -1,20 +1,24 @@
 import { rules as ruleList } from "./utils/rules"
 import * as processorsDefines from "./processor"
 import type { Rule } from "eslint"
+import * as meta from "./meta"
+import { environments } from "./environments"
 
-export * as meta from "./meta"
-export { environments } from "./environments"
-
-export const rules = ruleList.reduce(
+const rules = ruleList.reduce(
   (obj, r) => {
     obj[r.meta.docs.ruleName] = r as never
     return obj
   },
   {} as { [key: string]: Rule.RuleModule },
 )
-
-export const processors = {
+const processors = {
   ".astro": processorsDefines.astroProcessor,
   astro: processorsDefines.astroProcessor,
   "client-side-ts": processorsDefines.clientSideTsProcessor,
 }
+export const plugin = {
+  meta,
+  environments,
+  rules,
+  processors,
+}

tests/fixtures/integration/config/.npmrc

@@ -0,0 +1 @@
+package-lock=false

tests/fixtures/integration/config/eslint.config.mjs

@@ -0,0 +1,6 @@
+import js from "@eslint/js"
+import eslintPluginAstro from "eslint-plugin-astro"
+export default [
+  js.configs.recommended,
+  ...eslintPluginAstro.configs.recommended,
+]

tests/fixtures/integration/config/expected.json

@@ -0,0 +1,26 @@
+[
+  {
+    "filePath": "src/index.astro",
+    "messages": [
+      {
+        "ruleId": "no-unused-vars",
+        "severity": 2,
+        "message": "'foo' is assigned a value but never used.",
+        "line": 2,
+        "column": 7,
+        "nodeType": "Identifier",
+        "messageId": "unusedVar",
+        "endLine": 2,
+        "endColumn": 10
+      }
+    ],
+    "suppressedMessages": [],
+    "errorCount": 1,
+    "fatalErrorCount": 0,
+    "warningCount": 0,
+    "fixableErrorCount": 0,
+    "fixableWarningCount": 0,
+    "source": "---\nconst foo = {}\n---\n\n<a></a>\n",
+    "usedDeprecatedRules": []
+  }
+]

tests/fixtures/integration/config/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "eslint-plugin-astro-integration-test-for-legacy-config",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "test": "eslint . --format json"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "latest",
+    "eslint": "^9.1.1",
+    "eslint-plugin-astro": "file:../../../.."
+  }
+}

tests/fixtures/integration/config/src/index.astro

@@ -0,0 +1,5 @@
+---
+const foo = {}
+---
+
+<a></a>

tests/fixtures/integration/legacy-config/.eslintrc.js

@@ -0,0 +1,6 @@
+"use strict"
+
+module.exports = {
+  root: true,
+  extends: ["eslint:recommended", "plugin:astro/recommended"],
+}

tests/fixtures/integration/legacy-config/.npmrc

@@ -0,0 +1 @@
+package-lock=false

tests/fixtures/integration/legacy-config/expected.json

@@ -0,0 +1,26 @@
+[
+  {
+    "filePath": "src/index.astro",
+    "messages": [
+      {
+        "ruleId": "no-unused-vars",
+        "severity": 2,
+        "message": "'foo' is assigned a value but never used.",
+        "line": 2,
+        "column": 7,
+        "nodeType": "Identifier",
+        "messageId": "unusedVar",
+        "endLine": 2,
+        "endColumn": 10
+      }
+    ],
+    "suppressedMessages": [],
+    "errorCount": 1,
+    "fatalErrorCount": 0,
+    "warningCount": 0,
+    "fixableErrorCount": 0,
+    "fixableWarningCount": 0,
+    "source": "---\nconst foo = {}\n---\n\n<a></a>\n",
+    "usedDeprecatedRules": []
+  }
+]

tests/fixtures/integration/legacy-config/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "eslint-plugin-astro-integration-test-for-legacy-config",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "test": "eslint . --format json"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "eslint": "^9.1.1",
+    "eslint-plugin-astro": "file:../../../.."
+  }
+}

tests/fixtures/integration/legacy-config/src/index.astro

@@ -0,0 +1,5 @@
+---
+const foo = {}
+---
+
+<a></a>

tests/fixtures/integration/legacy-config/test-env.json

@@ -0,0 +1,3 @@
+{
+  "ESLINT_USE_FLAT_CONFIG": false
+}