ci: add e2e tests to CI

This change adds a new end-to-end test capability.  There are two new jobs in the main CI workflow.  One job to build the package (which also good to have outside of the need to run e2e tests), executed with the latest LTS node.  The build artifact is uploaded for the downstream `e2e` job to use.  The `e2e` job, downloads the artifact, run `npm install` and then `npm run e2e`, which executes a custom node script to loop through subdirectories of `/e2e`, which each contain a project fixture with different setups.  Both projects have the same simple plugin source code, and each has this plugin (referenced from the root of the repo (aka the result of the build)) and `eslint` installed as `devDependencies`.  Each also has a `lint` package.json script that runs `eslint` on the simple plugin.

## `/e2e/all`

This fixture has a regular js config and runs our `all` config on the project.

## `/e2e/all-typed-config`

This fixture has `typescript` installed and uses a ts-based config and runs our `all` config on the project.  It also executes `tsc` as part of the `lint` command, to ensure everything's typed property.

Author: michaelfaith

.github/workflows/main.yml

@@ -67,3 +67,45 @@ jobs:
           node-version: 'lts/*'
       - run: npm install
       - run: npm run typecheck
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - run: npm install
+      - run: npm run build
+      - name: Upload build results
+        uses: actions/upload-artifact@v4
+        with:
+          name: build_dist
+          path: dist
+  e2e:
+    name: Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version:
+          - '24.0.0' # minimum supported v24
+          - 24
+          - '22.13.1' # minimum supported v22
+          - 22
+          - '20.19.0' #minimum supported v20
+          - 20
+        os:
+          - ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Download build results
+        uses: actions/download-artifact@v4
+        with:
+          name: build_dist
+      - run: npm install
+      - run: npm run e2e

e2e/all-typed-config/.npmrc

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

e2e/all-typed-config/eslint.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'eslint/config';
+
+import eslintPlugin from 'eslint-plugin-eslint-plugin';
+
+export default defineConfig([
+  {
+    extends: [eslintPlugin.configs.all],
+    files: ['./index.js', './rule.js'],
+  },
+]);

e2e/all-typed-config/index.js

@@ -0,0 +1,25 @@
+import rule from './rule.js';
+
+/** @type {import('eslint').ESLint.Plugin} */
+const plugin = {
+  meta: {
+    name: '@e2e/all-typed-config',
+    version: '1.0.0',
+  },
+  rules: { 'e2e-test': rule },
+  configs: {
+    recommended: {
+      name: '@e2e/all-typed-config/recommended',
+      plugins: {
+        get ['@e2e/all-typed-config']() {
+          return plugin;
+        },
+      },
+      rules: {
+        '@e2e/all-typed-config/e2e-test': 'error',
+      },
+    },
+  },
+};
+
+export default plugin;

e2e/all-typed-config/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@e2e/all-typed-config",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "lint": "tsc && eslint"
+  },
+  "main": "./index.js",
+  "devDependencies": {
+    "eslint": "^9.33.0",
+    "eslint-plugin-eslint-plugin": "file:../..",
+    "jiti": "^2.5.1",
+    "typescript": "^5.9.2"
+  }
+}

e2e/all-typed-config/rule.js

@@ -0,0 +1,32 @@
+/** @type {import('eslint').Rule.RuleModule} */
+const rule = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'enforce a test',
+      recommended: false,
+      url: 'https://test.org',
+    },
+    fixable: undefined, // or "code" or "whitespace"
+    schema: [],
+    messages: {
+      missingOutput: 'This is a test',
+    },
+  },
+
+  create(context) {
+    return {
+      Program(ast) {
+        const sourceCode = context.sourceCode;
+        if (false) {
+          context.report({
+            node: ast,
+            messageId: 'missingOutput',
+          });
+        }
+      },
+    };
+  },
+};
+
+export default rule;

e2e/all-typed-config/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "rootDir": ".",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ES2024",
+    "verbatimModuleSyntax": true,
+    "erasableSyntaxOnly": true,
+    "types": []
+  },
+  "include": ["eslint.config.ts"]
+}

e2e/all/.npmrc

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

e2e/all/eslint.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from 'eslint/config';
+
+import eslintPlugin from 'eslint-plugin-eslint-plugin';
+
+export default defineConfig([
+  {
+    extends: [eslintPlugin.configs.all],
+    files: ['./index.js', './rule.js'],
+  },
+]);

e2e/all/index.js

@@ -0,0 +1,25 @@
+import rule from './rule.js';
+
+/** @type {import('eslint').ESLint.Plugin} */
+const plugin = {
+  meta: {
+    name: '@e2e/all',
+    version: '1.0.0',
+  },
+  rules: { 'e2e-test': rule },
+  configs: {
+    recommended: {
+      name: '@e2e/all/recommended',
+      plugins: {
+        get ['@e2e/all']() {
+          return plugin;
+        },
+      },
+      rules: {
+        '@e2e/all/e2e-test': 'error',
+      },
+    },
+  },
+};
+
+export default plugin;