feat(scripts/test): upgrade Jest to 29.x

BREAKING CHANGE: upgrades Jest a major version (28 to 29)
BREAKING CHANGE: Node 12 is no longer supported

Author: jrolfs

.github/workflows/build.yml

@@ -29,7 +29,7 @@ jobs:
     if: ${{ needs.deduplicate.outputs.should_skip != 'true' }}
     strategy:
       matrix:
-        node: ['12', '14', '16']
+        node: ['14', '16', '18']
 
     steps:
       - name: Get Yarn cache path

jest.config.js

@@ -1,5 +1,6 @@
 const {
   globals,
+  transform,
   transformIgnorePatterns,
   ...config
 } = require('./src/config/jest.config')
@@ -10,14 +11,13 @@ module.exports = {
   roots: ['<rootDir>/src'],
   coverageThreshold: null,
   transformIgnorePatterns: [...transformIgnorePatterns, '.prettierrc.js'],
-  globals: {
-    'ts-jest': {
-      ...globals['ts-jest'],
-      tsconfig: './src/tsconfig.json',
-      diagnostics: {
-        warnOnly: true,
-        exclude: ['**/*'],
-      },
-    },
-  },
+  // Specifying ts-jest options via `global` in Jest configuration has been
+  // deprecated so we have to do this in order to add the `exclude` option to
+  // the transform in our Jest configuration that already has `transform` ☹
+  transform: Object.fromEntries(
+    Object.entries(transform).map(([glob, [transformer, options]]) => [
+      glob,
+      [transformer, {...options, exclude: '**/*'}],
+    ]),
+  ),
 }

package.json

@@ -53,7 +53,7 @@
     "@commitlint/cli": "^16.1.0",
     "@commitlint/config-conventional": "^16.2.1",
     "@commitlint/prompt": "^16.1.0",
-    "@types/jest": "^28.1.4",
+    "@types/jest": "^29.0.0",
     "@types/lodash.has": "^4.5.6",
     "@types/mkdirp": "^1.0.2",
     "@types/node": ">=17.x",
@@ -80,16 +80,16 @@
     "eslint-plugin-react-hooks": "^4.3.0",
     "glob": "^8.0.3",
     "is-ci": "^3.0.1",
-    "jest": "^28.1.2",
+    "jest": "^29.0.2",
     "jest-github-actions-reporter": "^1.0.3",
-    "jest-watch-typeahead": "^1.1.0",
+    "jest-watch-typeahead": "^2.1.1",
     "lint-staged": "^12.3.4",
     "lodash.has": "^4.5.2",
     "mkdirp": "^1.0.3",
     "prettier": "^2.5.1",
     "read-pkg-up": "^7.0.1",
     "rimraf": "^3.0.2",
-    "ts-jest": "^28.0.5",
+    "ts-jest": "^29.0.0-next.1",
     "tslib": "^2.4.0",
     "typescript": "^4",
     "which": "^2.0.2",

src/config/jest.config.js

@@ -22,6 +22,10 @@ const ignores = [
 /** @type JestConfig */
 const jestConfig = {
   roots: [fromRoot('.')],
+  // Here we're preserving Jest <= 28 snapshot format to prevent the need
+  // to update snapshots when upgrading Jest via @hover/javascript, see:
+  // https://jestjs.io/docs/upgrading-to-jest29#snapshot-format
+  snapshotFormat: {escapeString: true, printBasicPrototype: true},
   testEnvironment: ifAnyDep(['webpack', 'rollup', 'react'], 'jsdom', 'node'),
   testEnvironmentOptions: {url: 'http://localhost'},
   moduleFileExtensions: testMatchExtensions.concat('json'),
@@ -32,9 +36,9 @@ const jestConfig = {
   transform: Object.fromEntries(
     // Ensure we can resolve the preset even when
     // it's in a nested `node_modules` installation
-    Object.entries(preset.transform).map(([key, value]) => [
-      key,
-      require.resolve(value),
+    Object.entries(preset.transform).map(([glob, transformer]) => [
+      glob,
+      [require.resolve(transformer), {diagnostics: {warnOnly: true}}],
     ]),
   ),
   coveragePathIgnorePatterns: [
@@ -59,13 +63,6 @@ const jestConfig = {
     require.resolve('jest-watch-typeahead/filename'),
     require.resolve('jest-watch-typeahead/testname'),
   ],
-  globals: {
-    'ts-jest': {
-      diagnostics: {
-        warnOnly: true,
-      },
-    },
-  },
 }
 
 if (hasFile('tests/setup-env.js')) {