chore: add regression testing against old TS and ESLint versions

bradzacher · bradzacher · commit f0461a96efa4 · 2022-10-09T18:16:56.000+10:30
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -26,6 +26,7 @@ module.exports = {
       './tsconfig.eslint.json',
       './packages/*/tsconfig.json',
       './tests/integration/tsconfig.json',
+      './tools/tsconfig.json',
       /**
        * We are currently in the process of transitioning to nx's out of the box structure and
        * so need to manually specify converted packages' tsconfig.build.json and tsconfig.spec.json
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,7 +9,9 @@ on:
       - '**'
 
 env:
+  PRIMARY_ESLINT_VERSION: '^8.0.0'
   PRIMARY_NODE_VERSION: 18
+  PRIMARY_TYPESCRIPT_VERSION: '~4.8.0'
 
 defaults:
   run:
@@ -117,6 +119,7 @@ jobs:
     strategy:
       matrix:
         # just run on the oldest and latest supported versions and assume the intermediate versions are good
+        # unfortunately you can't reference environment variables in an array :(
         node-version: [14, 18]
         package:
           [
@@ -172,6 +175,102 @@ jobs:
           # Sadly 1 day is the minimum
           retention-days: 1
 
+  unit_tests_ts_regression:
+    name: Run Unit Tests (TypeScript Version Regression Checks)
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package:
+          # note that we don't regression test all packages here on purpose because most don't depend on TS directly.
+          ['eslint-plugin', 'scope-manager', 'type-utils', 'typescript-estree']
+
+        ts-version:
+          # unfortunately you can't reference environment variables in an array :(
+          [
+            # lowest possible version
+            '3.3.1',
+            # somewhere in the middle for sanity check
+            '~4.0.8',
+            # highest possible version
+            '~4.8.2',
+          ]
+    env:
+      # Added the - at the end to function as a separator to improve readability in the PR comment from the Nx cloud app
+      NX_CLOUD_ENV_NAME: 'Node ${{ matrix.node-version }} -'
+      COLLECT_COVERAGE: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      - name: Install
+        uses: ./.github/actions/prepare-install
+        with:
+          node-version: ${{ env.PRIMARY_NODE_VERSION }}
+      - name: Build
+        uses: ./.github/actions/prepare-build
+
+      - name: Install Specific TS Version
+        run: |
+          yarn ts-node ./tools/change-ts-version.ts ${{ matrix.ts-version }}
+          yarn --ignore-engines --ignore-scripts
+
+      - name: Patch Packages
+        if: matrix.ts-version == env.PRIMARY_TYPESCRIPT_VERSION
+        run: |
+          yarn patch-package
+
+      # we don't collect coverage for these tests on purpose
+      - name: Run unit tests for ${{ matrix.package }}
+        run: npx nx test @typescript-eslint/${{ matrix.package }} --coverage=false
+        env:
+          CI: true
+
+  unit_tests_eslint_regression:
+    name: Run Unit Tests (ESLint Version Regression Checks)
+    needs: [build]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package:
+          # note that we don't regression test all packages here on purpose because most don't depend on ESLint directly.
+          ['eslint-plugin', 'utils']
+        eslint-version:
+          # unfortunately you can't reference environment variables in an array :(
+          [
+            # lowest possible version
+            '6.0.0',
+            # somewhere in the middle for sanity check
+            '~7.32.0',
+            # highest possible version
+            '^8.0.0',
+          ]
+    env:
+      # Added the - at the end to function as a separator to improve readability in the PR comment from the Nx cloud app
+      NX_CLOUD_ENV_NAME: 'Node ${{ matrix.node-version }} -'
+      COLLECT_COVERAGE: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+      - name: Install
+        uses: ./.github/actions/prepare-install
+        with:
+          node-version: ${{ env.PRIMARY_NODE_VERSION }}
+      - name: Build
+        uses: ./.github/actions/prepare-build
+
+      - name: Install Specific ESLint Version
+        run: yarn add -DW --ignore-engines --ignore-scripts eslint@${{ matrix.eslint-version }}
+
+      # we don't collect coverage for these tests on purpose
+      - name: Run unit tests for ${{ matrix.package }}
+        run: npx nx test @typescript-eslint/${{ matrix.package }} --coverage=false
+        env:
+          CI: true
+
   website_tests:
     permissions:
       contents: read # to fetch code (actions/checkout)
diff --git a/packages/website-eslint/package.json b/packages/website-eslint/package.json
@@ -32,6 +32,6 @@
     "eslint": "*",
     "rollup": "^2.75.4",
     "rollup-plugin-terser": "^7.0.2",
-    "semver": "^7.3.7"
+    "semver": "*"
   }
 }
diff --git a/tools/change-ts-version.ts b/tools/change-ts-version.ts
@@ -0,0 +1,21 @@
+import fs from 'fs';
+import path from 'path';
+import semver from 'semver';
+
+const packageJson = require('../package.json') as {
+  resolutions: Record<string, unknown>;
+  devDependencies: Record<string, unknown>;
+};
+
+const newVersion = semver.valid(semver.coerce(process.argv[2]));
+if (newVersion == null) {
+  throw new Error('The first argument passed must be a valid semver');
+}
+
+packageJson.resolutions.typescript = newVersion;
+packageJson.devDependencies.typescript = newVersion;
+
+fs.writeFileSync(
+  path.resolve(__dirname, '../package.json'),
+  JSON.stringify(packageJson, null, 2),
+);
diff --git a/tools/generate-contributors.ts b/tools/generate-contributors.ts
@@ -21,7 +21,7 @@ interface Contributor {
   contributions: number;
   type: string;
   login?: string;
-  url?: string;
+  url: string;
   avatar_url?: string;
   html_url?: string;
 }
diff --git a/tools/tsconfig.json b/tools/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "rootDir": ".."
+  },
+  "include": ["./*.ts"],
+  "references": []
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,6 @@`
`32`	`32`	`"eslint": "*",`
`33`	`33`	`"rollup": "^2.75.4",`
`34`	`34`	`"rollup-plugin-terser": "^7.0.2",`
`35`		`- "semver": "^7.3.7"`
	`35`	`+ "semver": "*"`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ interface Contributor {`
`21`	`21`	`contributions: number;`
`22`	`22`	`type: string;`
`23`	`23`	`login?: string;`
`24`		`- url?: string;`
	`24`	`+ url: string;`
`25`	`25`	`avatar_url?: string;`
`26`	`26`	`html_url?: string;`
`27`	`27`	`}`