chore: update all test scripts to remove coverage flag (#10582)

* chore: add test-coverage script

Adds a `test-coverage` script to each package.

With this change, each package has these two scripts:

- `test` - run tests with coverage disabled
- `test-coverage` - run tests with coverage enabled (_if_ the package
  wants to support coverage)

Before this change, `test` behaved like `test-coverage` (i.e. packages
had coverage enabled in it). In CI, we then forced coverage off in some
situations by passing a flag: `npm run test -- --coverage=false`.

This resulted in commands like `jest --coverage --coverage=false`.

While jest is happy with this, vitest is not. Given we are likely to
move to vitest, it is worth fixing this ahead of time.

* chore(ast-spec): enable test coverage

* chore(scope-manager): add jest as dependency

* chore: drop coverage script

* chore: disable coverage in jest base config

* review changes

---------

Co-authored-by: Kirk Waiblinger <[email protected]>

Author: 43081j

.github/workflows/ci.yml

@@ -196,17 +196,14 @@ jobs:
 
       # collect coverage on the primary node version
       # we don't collect coverage on other node versions so they run faster
-      # note that we don't do this as a single `run` with a flag because some
-      # packages don't collect coverage on purpose, so forcing `--coverage=true`
-      # would override the config
       - name: Run unit tests with coverage for ${{ matrix.package }}
         if: env.PRIMARY_NODE_VERSION == matrix.node-version && matrix.os == 'ubuntu-latest'
-        run: npx nx test ${{ matrix.package }}
+        run: npx nx run ${{ matrix.package }}:test -- --coverage
         env:
           CI: true
       - name: Run unit tests for ${{ matrix.package }}
         if: env.PRIMARY_NODE_VERSION != matrix.node-version || matrix.os != 'ubuntu-latest'
-        run: npx nx test ${{ matrix.package }} --coverage=false
+        run: npx nx test ${{ matrix.package }}
         env:
           CI: true
 

jest.config.base.js

@@ -6,7 +6,6 @@ const path = require('node:path');
 // @ts-check
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
-  collectCoverage: true,
   collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}'],
   coverageReporters: ['lcov'],
   moduleFileExtensions: [

packages/ast-spec/jest.config.js

@@ -7,9 +7,9 @@ const baseConfig = require('../../jest.config.base.js');
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
   ...baseConfig,
-  collectCoverage: false,
   setupFilesAfterEnv: [
     ...baseConfig.setupFilesAfterEnv,
     './tests/util/setupJest.ts',
   ],
+  coveragePathIgnorePatterns: ['/fixtures/', '/node_modules/'],
 };

packages/eslint-plugin-internal/package.json

@@ -19,7 +19,7 @@
     "postclean": "rimraf dist && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "npx nx lint",
-    "test": "jest --coverage",
+    "test": "jest",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {

packages/eslint-plugin/package.json

@@ -56,7 +56,7 @@
     "generate:breaking-changes": "tsx tools/generate-breaking-changes.mts",
     "generate:configs": "npx nx generate-configs repo",
     "lint": "npx nx lint",
-    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --coverage --logHeapUsage",
+    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --logHeapUsage",
     "test-single": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --no-coverage",
     "check-types": "npx nx typecheck"
   },

packages/integration-tests/jest.config.js

@@ -8,7 +8,6 @@ const { tseslintPackages } = require('./tools/pack-packages');
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
   ...require('../../jest.config.base.js'),
-  collectCoverage: false,
   globals: {
     tseslintPackages,
   },

packages/parser/package.json

@@ -46,7 +46,7 @@
     "postclean": "rimraf dist && rimraf _ts4.3 && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "npx nx lint",
-    "test": "jest --coverage",
+    "test": "jest",
     "check-types": "npx nx typecheck"
   },
   "peerDependencies": {

packages/rule-tester/package.json

@@ -44,7 +44,7 @@
     "lint": "npx nx lint",
     "pretest-eslint-base": "tsc -b tsconfig.build.json",
     "test-eslint-base": "mocha --require source-map-support/register ./tests/eslint-base/eslint-base.test.js",
-    "test": "npx jest --coverage",
+    "test": "npx jest",
     "check-types": "npx nx typecheck"
   },
   "//": "NOTE - AJV is out-of-date, but it's intentionally synced with ESLint - https://github.com/eslint/eslint/blob/ad9dd6a933fd098a0d99c6a9aa059850535c23ee/package.json#L70",

packages/scope-manager/package.json

@@ -43,7 +43,7 @@
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "generate-lib": "npx nx generate-lib repo",
     "lint": "npx nx lint",
-    "test": "npx nx test --code-coverage",
+    "test": "jest",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {
@@ -55,6 +55,7 @@
     "@types/glob": "*",
     "@typescript-eslint/typescript-estree": "8.25.0",
     "glob": "*",
+    "jest": "29.7.0",
     "jest-specific-snapshot": "*",
     "make-dir": "*",
     "prettier": "^3.2.5",

packages/type-utils/package.json

@@ -43,7 +43,7 @@
     "postclean": "rimraf dist && rimraf _ts3.4 && rimraf _ts4.3 && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "npx nx lint",
-    "test": "jest --coverage",
+    "test": "jest",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {

packages/typescript-eslint/package.json

@@ -49,7 +49,7 @@
     "postclean": "rimraf dist && rimraf _ts4.3 && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "nx lint",
-    "test": "jest --coverage --passWithNoTests",
+    "test": "jest --passWithNoTests",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {

packages/typescript-estree/package.json

@@ -51,7 +51,7 @@
     "postclean": "rimraf dist && rimraf _ts4.3 && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "npx nx lint",
-    "test": "jest --coverage --runInBand --verbose",
+    "test": "jest --runInBand --verbose",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {

packages/utils/package.json

@@ -60,7 +60,7 @@
     "postclean": "rimraf dist && rimraf _ts3.4 && rimraf _ts4.3 && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "npx nx lint",
-    "test": "jest --coverage",
+    "test": "jest",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {

packages/visitor-keys/package.json

@@ -44,7 +44,7 @@
     "postclean": "rimraf dist && rimraf _ts3.4 && rimraf _ts4.3 && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "lint": "npx nx lint",
-    "test": "jest --coverage",
+    "test": "jest",
     "check-types": "npx nx typecheck"
   },
   "dependencies": {

yarn.lock

@@ -5812,6 +5812,7 @@ __metadata:
     "@typescript-eslint/typescript-estree": 8.25.0
     "@typescript-eslint/visitor-keys": 8.25.0
     glob: "*"
+    jest: 29.7.0
     jest-specific-snapshot: "*"
     make-dir: "*"
     prettier: ^3.2.5