feat(jest-config):Support loading TS config files via docblock loader

CHANGELOG.md

@@ -12,6 +12,7 @@
 - `[jest-config]` Loads config file from provided path in `package.json` ([#14044](https://github.com/facebook/jest/pull/14044))
 - `[jest-config]` Allow loading `jest.config.cts` files ([#14070](https://github.com/facebook/jest/pull/14070))
 - `[jest-config]` Added an option to disable `ts-node` typechecking ([#15161](https://github.com/jestjs/jest/pull/15161))
+- `[jest-config]` Support loading TS config files using `esbuild-register` via docblock loader ([#15190](https://github.com/jestjs/jest/pull/15190))
 - `[@jest/core]` Group together open handles with the same stack trace ([#13417](https://github.com/jestjs/jest/pull/13417), & [#14789](https://github.com/jestjs/jest/pull/14789))
 - `[@jest/core]` Add `perfStats` to surface test setup overhead ([#14622](https://github.com/jestjs/jest/pull/14622))
 - `[@jest/core]` [**BREAKING**] Changed `--filter` to accept an object with shape `{ filtered: Array<string> }` to match [documentation](https://jestjs.io/docs/cli#--filterfile) ([#13319](https://github.com/jestjs/jest/pull/13319))

docs/Configuration.md

@@ -57,9 +57,21 @@ export default async (): Promise<Config> => {
 
 :::tip
 
-To read TypeScript configuration files Jest requires [`ts-node`](https://npmjs.com/package/ts-node). Make sure it is installed in your project.
+To read TypeScript configuration files Jest by default requires [`ts-node`](https://npmjs.com/package/ts-node). You can override this behavior by adding a `@jest-config-loader` docblock at the top of the file. Currently, [`ts-node`](https://npmjs.com/package/ts-node) and [`esbuild-register`](https://npmjs.com/package/esbuild-register) is supported. Make sure `ts-node` or the loader you specify is installed.
 
-To read configuration files without typechecking, You can set `JEST_CONFIG_TRANSPILE_ONLY` environment variable to `true` (case insensitive).
+```ts title="jest.config.ts"
+/**@jest-config-loader ts-node(or esbuild-register)*/
+
+import type {Config} from 'jest';
+
+const config: Config = {
+  verbose: true,
+};
+
+export default config;
+```
+
+If you are using `ts-node`, you can set `JEST_CONFIG_TRANSPILE_ONLY` environment variable to `true` (case insensitive) to read configuration files without typechecking.
 
 :::
 

e2e/__tests__/readInitialOptions.test.ts

@@ -46,58 +46,21 @@ describe('readInitialOptions', () => {
     expect(config).toEqual({jestConfig: 'jest.config.js', rootDir});
     expect(configPath).toEqual(configFile);
   });
-  test('should read a jest.config.js file', async () => {
-    const configFile = resolveFixture('js-config', 'jest.config.js');
-    const rootDir = resolveFixture('js-config');
-    const {config, configPath} = await proxyReadInitialOptions(undefined, {
-      cwd: rootDir,
-    });
-    expect(config).toEqual({jestConfig: 'jest.config.js', rootDir});
-    expect(configPath).toEqual(configFile);
-  });
-  test('should read a package.json file', async () => {
-    const configFile = resolveFixture('pkg-config', 'package.json');
-    const rootDir = resolveFixture('pkg-config');
-    const {config, configPath} = await proxyReadInitialOptions(undefined, {
-      cwd: rootDir,
-    });
-    expect(config).toEqual({jestConfig: 'package.json', rootDir});
-    expect(configPath).toEqual(configFile);
-  });
-  test('should read a jest.config.ts file', async () => {
-    const configFile = resolveFixture('ts-config', 'jest.config.ts');
-    const rootDir = resolveFixture('ts-config');
-    const {config, configPath} = await proxyReadInitialOptions(undefined, {
-      cwd: rootDir,
-    });
-    expect(config).toEqual({jestConfig: 'jest.config.ts', rootDir});
-    expect(configPath).toEqual(configFile);
-  });
-  test('should read a jest.config.mjs file', async () => {
-    const configFile = resolveFixture('mjs-config', 'jest.config.mjs');
-    const rootDir = resolveFixture('mjs-config');
-    const {config, configPath} = await proxyReadInitialOptions(undefined, {
-      cwd: rootDir,
-    });
-    expect(config).toEqual({jestConfig: 'jest.config.mjs', rootDir});
-    expect(configPath).toEqual(configFile);
-  });
-  test('should read a jest.config.json file', async () => {
-    const configFile = resolveFixture('json-config', 'jest.config.json');
-    const rootDir = resolveFixture('json-config');
-    const {config, configPath} = await proxyReadInitialOptions(undefined, {
-      cwd: rootDir,
-    });
-    expect(config).toEqual({jestConfig: 'jest.config.json', rootDir});
-    expect(configPath).toEqual(configFile);
-  });
-  test('should read a jest config exporting an async function', async () => {
-    const configFile = resolveFixture('async-config', 'jest.config.js');
-    const rootDir = resolveFixture('async-config');
+  test.each([
+    ['js-config', 'jest.config.js'],
+    ['pkg-config', 'package.json'],
+    ['ts-node-config', 'jest.config.ts'],
+    ['ts-esbuild-register-config', 'jest.config.ts'],
+    ['mjs-config', 'jest.config.mjs'],
+    ['json-config', 'jest.config.json'],
+    ['async-config', 'jest.config.js'],
+  ])('should read %s/%s file', async (directory: string, filename: string) => {
+    const configFile = resolveFixture(directory, filename);
+    const rootDir = resolveFixture(directory);
     const {config, configPath} = await proxyReadInitialOptions(undefined, {
       cwd: rootDir,
     });
-    expect(config).toEqual({jestConfig: 'async-config', rootDir});
+    expect(config).toEqual({jestConfig: filename, rootDir});
     expect(configPath).toEqual(configFile);
   });
 

e2e/read-initial-options/async-config/jest.config.js

@@ -6,6 +6,6 @@
  */
 module.exports = async function () {
   return {
-    jestConfig: 'async-config',
+    jestConfig: 'jest.config.js',
   };
 };

e2e/read-initial-options/ts-esbuild-register-config/jest.config.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**@jest-config-loader esbuild-register */
+interface Config {
+  jestConfig: string;
+}
+
+export default {
+  jestConfig: 'jest.config.ts',
+} as Config;

e2e/read-initial-options/ts-config/jest.config.ts → e2e/read-initial-options/ts-node-config/jest.config.ts

@@ -4,6 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/**@jest-config-loader ts-node */
+interface Config {
+  jestConfig: string;
+}
+
 export default {
   jestConfig: 'jest.config.ts',
-};
+} as Config;

e2e/typescript-config/modern-module-resolution/jest.config.ts

@@ -3,6 +3,8 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
+ *
+ * @jest-config-loader esbuild-register
  */
 
 const config = {

packages/jest-config/package.json

@@ -20,12 +20,16 @@
   },
   "peerDependencies": {
     "@types/node": "*",
+    "esbuild-register": ">=3.4.0",
     "ts-node": ">=9.0.0"
   },
   "peerDependenciesMeta": {
     "@types/node": {
       "optional": true
     },
+    "esbuild-register": {
+      "optional": true
+    },
     "ts-node": {
       "optional": true
     }
@@ -42,6 +46,7 @@
     "glob": "^10.3.10",
     "graceful-fs": "^4.2.9",
     "jest-circus": "workspace:*",
+    "jest-docblock": "workspace:*",
     "jest-environment-node": "workspace:*",
     "jest-get-type": "workspace:*",
     "jest-regex-util": "workspace:*",
@@ -59,6 +64,8 @@
     "@types/graceful-fs": "^4.1.3",
     "@types/micromatch": "^4.0.7",
     "@types/parse-json": "^4.0.0",
+    "esbuild": "^0.15.0",
+    "esbuild-register": "^3.4.0",
     "semver": "^7.5.3",
     "ts-node": "^10.5.0",
     "typescript": "^5.0.4"

packages/jest-config/src/readConfigFileAndSetRootDir.ts

@@ -10,8 +10,8 @@ import {isNativeError} from 'util/types';
 import * as fs from 'graceful-fs';
 import parseJson = require('parse-json');
 import stripJsonComments = require('strip-json-comments');
-import type {Service} from 'ts-node';
 import type {Config} from '@jest/types';
+import {extract, parse} from 'jest-docblock';
 import {interopRequireDefault, requireOrImportModule} from 'jest-util';
 import {
   JEST_CONFIG_EXT_CTS,
@@ -20,6 +20,10 @@ import {
   PACKAGE_JSON,
 } from './constants';
 
+interface TsLoader {
+  enabled: (bool: boolean) => void;
+}
+type TsLoaderModule = 'ts-node' | 'esbuild-register';
 // Read the configuration and set its `rootDir`
 // 1. If it's a `package.json` file, we look into its "jest" property
 // 2. If it's a `jest.config.ts` file, we use `ts-node` to transpile & require it
@@ -89,8 +93,20 @@ const loadTSConfigFile = async (
   configPath: string,
 ): Promise<Config.InitialOptions> => {
   // Get registered TypeScript compiler instance
-  const registeredCompiler = await getRegisteredCompiler();
+  const docblockPragmas = parse(extract(fs.readFileSync(configPath, 'utf8')));
+  const tsLoader = docblockPragmas['jest-config-loader'] || 'ts-node';
+
+  if (Array.isArray(tsLoader)) {
+    throw new TypeError(
+      `Jest: You can only define a single loader through docblocks, got "${tsLoader.join(
+        ', ',
+      )}"`,
+    );
+  }
 
+  const registeredCompiler = await getRegisteredCompiler(
+    tsLoader as TsLoaderModule,
+  );
   registeredCompiler.enabled(true);
 
   let configObject = interopRequireDefault(require(configPath)).default;
@@ -105,36 +121,57 @@ const loadTSConfigFile = async (
   return configObject;
 };
 
-let registeredCompilerPromise: Promise<Service>;
+let registeredCompilerPromise: Promise<TsLoader>;
 
-function getRegisteredCompiler() {
+function getRegisteredCompiler(loader: TsLoaderModule) {
   // Cache the promise to avoid multiple registrations
-  registeredCompilerPromise = registeredCompilerPromise ?? registerTsNode();
+  registeredCompilerPromise =
+    registeredCompilerPromise ?? registerTsLoader(loader);
   return registeredCompilerPromise;
 }
 
-async function registerTsNode(): Promise<Service> {
+async function registerTsLoader(loader: TsLoaderModule): Promise<TsLoader> {
   try {
     // Register TypeScript compiler instance
-    const tsNode = await import(/* webpackIgnore: true */ 'ts-node');
-    return tsNode.register({
-      compilerOptions: {
-        module: 'CommonJS',
-        moduleResolution: 'Node10',
-      },
-      moduleTypes: {
-        '**': 'cjs',
-      },
-      transpileOnly:
-        process.env.JEST_CONFIG_TRANSPILE_ONLY?.toLowerCase() === 'true',
-    });
+    if (loader === 'ts-node') {
+      const tsLoader = await import(/* webpackIgnore: true */ 'ts-node');
+      return tsLoader.register({
+        compilerOptions: {
+          module: 'CommonJS',
+        },
+        moduleTypes: {
+          '**': 'cjs',
+        },
+        transpileOnly:
+          process.env.JEST_CONFIG_TRANSPILE_ONLY?.toLowerCase() === 'true',
+      });
+    } else if (loader === 'esbuild-register') {
+      const tsLoader = await import(
+        /* webpackIgnore: true */ 'esbuild-register/dist/node'
+      );
+      let instance: {unregister: () => void} | undefined;
+      return {
+        enabled: (bool: boolean) => {
+          if (bool) {
+            instance = tsLoader.register({
+              target: `node${process.version.slice(1)}`,
+            });
+          } else {
+            instance?.unregister();
+          }
+        },
+      };
+    }
+    throw new Error(
+      `Jest: '${loader}' is not a valid TypeScript configuration loader.`,
+    );
   } catch (error) {
     if (
       isNativeError(error) &&
       (error as NodeJS.ErrnoException).code === 'ERR_MODULE_NOT_FOUND'
     ) {
       throw new Error(
-        `Jest: 'ts-node' is required for the TypeScript configuration files. Make sure it is installed\nError: ${error.message}`,
+        `Jest: '${loader}' is required for the TypeScript configuration files. Make sure it is installed\nError: ${error.message}`,
       );
     }
 

packages/jest-config/tsconfig.json

@@ -10,6 +10,7 @@
   // jest-test-sequencer, but that is just `require.resolve`d, so no real use
   // for their types
   "references": [
+    {"path": "../jest-docblock"},
     {"path": "../jest-environment-node"},
     {"path": "../jest-get-type"},
     {"path": "../jest-pattern"},