chore: convert jest-runtime to ESM

jestjs · Jul 28, 2020 · 99e36c0 · 99e36c0
1 parent 76f356e
commit 99e36c0
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,6 +20,7 @@
 - `[jest-jasmine2]` Refine typings of `queueRunner` ([#10215](https://github.com/facebook/jest/pull/10215))
 - `[jest-jasmine2]` Remove usage of `Function` type ([#10216](https://github.com/facebook/jest/pull/10216))
 - `[jest-resolve]` Improve types ([#10239](https://github.com/facebook/jest/pull/10239))
+- `[jest-runtime]` [**BREAKING**] Convert to ESM ([#10325](https://github.com/facebook/jest/pull/10325))
 - `[docs]` Clarify the [`jest.requireActual(moduleName)`](https://jestjs.io/docs/en/jest-object#jestrequireactualmodulename) example
 
 ### Performance

diff --git a/packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapter.ts b/packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapter.ts
@@ -9,7 +9,7 @@ import * as path from 'path';
 import type {Config} from '@jest/types';
 import type {JestEnvironment} from '@jest/environment';
 import type {TestResult} from '@jest/test-result';
-import type {RuntimeType as Runtime} from 'jest-runtime';
+import type Runtime from 'jest-runtime';
 import type {SnapshotStateType} from 'jest-snapshot';
 import {deepCyclicCopy} from 'jest-util';
 

diff --git a/packages/jest-core/src/__tests__/SearchSource.test.ts b/packages/jest-core/src/__tests__/SearchSource.test.ts
@@ -7,7 +7,7 @@
  */
 
 import * as path from 'path';
-import Runtime = require('jest-runtime');
+import Runtime from 'jest-runtime';
 import {normalize} from 'jest-config';
 import {Test} from 'jest-runner';
 import type {Config} from '@jest/types';

diff --git a/packages/jest-core/src/__tests__/watch-file-changes.test.ts b/packages/jest-core/src/__tests__/watch-file-changes.test.ts
@@ -10,7 +10,7 @@ import * as path from 'path';
 import {tmpdir} from 'os';
 import * as fs from 'graceful-fs';
 import {JestHook} from 'jest-watcher';
-import Runtime = require('jest-runtime');
+import Runtime from 'jest-runtime';
 import {normalize} from 'jest-config';
 import HasteMap = require('jest-haste-map');
 import rimraf = require('rimraf');

diff --git a/packages/jest-core/src/cli/index.ts b/packages/jest-core/src/cli/index.ts
@@ -10,7 +10,7 @@ import type {AggregatedResult} from '@jest/test-result';
 import {CustomConsole} from '@jest/console';
 import {createDirectory, preRunMessage} from 'jest-util';
 import {readConfigs} from 'jest-config';
-import Runtime = require('jest-runtime');
+import Runtime, {Context} from 'jest-runtime';
 import type {ChangedFilesPromise} from 'jest-changed-files';
 import HasteMap = require('jest-haste-map');
 import chalk = require('chalk');
@@ -218,7 +218,7 @@ const _run10000 = async (
 };
 
 const runWatch = async (
-  contexts: Array<Runtime.Context>,
+  contexts: Array<Context>,
   _configs: Array<Config.ProjectConfig>,
   hasDeprecationWarnings: boolean,
   globalConfig: Config.GlobalConfig,
@@ -238,7 +238,7 @@ const runWatch = async (
         undefined,
         filter,
       );
-    } catch (e) {
+    } catch {
       exit(0);
     }
   }
@@ -256,7 +256,7 @@ const runWatch = async (
 
 const runWithoutWatch = async (
   globalConfig: Config.GlobalConfig,
-  contexts: Array<Runtime.Context>,
+  contexts: Array<Context>,
   outputStream: NodeJS.WriteStream,
   onComplete: OnCompleteCallback,
   changedFilesPromise?: ChangedFilesPromise,

diff --git a/packages/jest-core/src/lib/create_context.ts b/packages/jest-core/src/lib/create_context.ts
@@ -6,13 +6,13 @@
  */
 
 import type {Config} from '@jest/types';
-import Runtime = require('jest-runtime');
+import Runtime, {Context} from 'jest-runtime';
 import type {HasteMapObject} from 'jest-haste-map';
 
 export default (
   config: Config.ProjectConfig,
   {hasteFS, moduleMap}: HasteMapObject,
-): Runtime.Context => ({
+): Context => ({
   config,
   hasteFS,
   moduleMap,

diff --git a/packages/jest-jasmine2/src/index.ts b/packages/jest-jasmine2/src/index.ts
@@ -10,7 +10,7 @@ import type {Config, Global} from '@jest/types';
 import type {AssertionResult, TestResult} from '@jest/test-result';
 import type {JestEnvironment} from '@jest/environment';
 import type {SnapshotStateType} from 'jest-snapshot';
-import type {RuntimeType as Runtime} from 'jest-runtime';
+import type Runtime from 'jest-runtime';
 
 import {getCallsite} from '@jest/source-map';
 import installEach from './each';

diff --git a/packages/jest-repl/src/cli/args.ts b/packages/jest-repl/src/cli/args.ts
@@ -7,7 +7,7 @@
  */
 
 import type {Options} from 'yargs';
-import Runtime = require('jest-runtime');
+import Runtime from 'jest-runtime';
 
 export const usage = 'Usage: $0 [--config=<pathToConfigFile>]';
 

diff --git a/packages/jest-repl/src/cli/index.ts b/packages/jest-repl/src/cli/index.ts
@@ -7,7 +7,7 @@
  *
  */
 
-import Runtime = require('jest-runtime');
+import Runtime from 'jest-runtime';
 import yargs = require('yargs');
 import {validateCLIOptions} from 'jest-validate';
 import {deprecationEntries} from 'jest-config';

diff --git a/packages/jest-resolve-dependencies/src/__tests__/dependency_resolver.test.ts b/packages/jest-resolve-dependencies/src/__tests__/dependency_resolver.test.ts
@@ -27,7 +27,7 @@ const filter = (path: Config.Path) =>
   Object.keys(cases).every(key => cases[key](path));
 
 beforeEach(() => {
-  Runtime = require('jest-runtime');
+  Runtime = require('jest-runtime').default;
   config = makeProjectConfig({
     cacheDirectory: path.resolve(tmpdir(), 'jest-resolve-dependencies-test'),
     moduleDirectories: ['node_modules'],

diff --git a/packages/jest-runner/src/runTest.ts b/packages/jest-runner/src/runTest.ts
@@ -17,9 +17,9 @@ import {
   getConsoleOutput,
 } from '@jest/console';
 import type {JestEnvironment} from '@jest/environment';
-import RuntimeClass = require('jest-runtime');
+import type RuntimeClass from 'jest-runtime';
 import * as fs from 'graceful-fs';
-import {ErrorWithStack, interopRequireDefault, setGlobal} from 'jest-util';
+import {ErrorWithStack, setGlobal} from 'jest-util';
 import LeakDetector from 'jest-leak-detector';
 import type {ResolverType} from 'jest-resolve';
 import {getTestEnvironment} from 'jest-config';
@@ -102,16 +102,17 @@ async function runTestInternal(
     });
   }
 
-  const TestEnvironment: typeof JestEnvironment = interopRequireDefault(
-    require(testEnvironment),
+  const TestEnvironment: typeof JestEnvironment = (
+    await import(testEnvironment)
   ).default;
   const testFramework: TestFramework =
     process.env.JEST_CIRCUS === '1'
-      ? require('jest-circus/runner') // eslint-disable-line import/no-extraneous-dependencies
-      : require(config.testRunner);
+      ? // @ts-expect-error: JS file
+        (await import('jest-circus/runner')).default
+      : (await import(config.testRunner)).default;
   const Runtime: typeof RuntimeClass = config.moduleLoader
-    ? require(config.moduleLoader)
-    : require('jest-runtime');
+    ? (await import(config.moduleLoader)).default
+    : (await import('jest-runtime')).default;
 
   const consoleOut = globalConfig.useStderr ? process.stderr : process.stdout;
   const consoleFormatter = (type: LogType, message: LogMessage) =>

diff --git a/packages/jest-runner/src/testWorker.ts b/packages/jest-runner/src/testWorker.ts
@@ -11,7 +11,7 @@ import type {SerializableError, TestResult} from '@jest/test-result';
 import HasteMap = require('jest-haste-map');
 import exit = require('exit');
 import {separateMessageFromStack} from 'jest-message-util';
-import Runtime = require('jest-runtime');
+import Runtime from 'jest-runtime';
 import type {ResolverType} from 'jest-resolve';
 import type {ErrorWithCode, TestRunnerSerializedContext} from './types';
 import runTest from './runTest';

diff --git a/packages/jest-runner/src/types.ts b/packages/jest-runner/src/types.ts
@@ -11,7 +11,7 @@ import type {SerializableError, TestResult} from '@jest/test-result';
 import type {JestEnvironment} from '@jest/environment';
 import type {FS as HasteFS, ModuleMap} from 'jest-haste-map';
 import type {ResolverType} from 'jest-resolve';
-import type {RuntimeType} from 'jest-runtime';
+import type RuntimeType from 'jest-runtime';
 
 export type ErrorWithCode = Error & {code?: string};
 export type Test = {

diff --git a/packages/jest-runtime/src/__mocks__/createRuntime.js b/packages/jest-runtime/src/__mocks__/createRuntime.js
@@ -8,10 +8,10 @@
 import path from 'path';
 
 module.exports = async function createRuntime(filename, config) {
-  const NodeEnvironment = require('jest-environment-node');
-  const Runtime = require('../');
+  const {default: NodeEnvironment} = await import('jest-environment-node');
+  const {default: Runtime} = await import('../');
 
-  const {normalize} = require('jest-config');
+  const {normalize} = await import('jest-config');
 
   config = normalize(
     {

diff --git a/packages/jest-runtime/src/__tests__/Runtime-statics.test.js b/packages/jest-runtime/src/__tests__/Runtime-statics.test.js
@@ -7,7 +7,7 @@
  */
 
 import HasteMap from 'jest-haste-map';
-const Runtime = require('../');
+import Runtime from '../';
 
 jest.mock('jest-haste-map');
 

diff --git a/packages/jest-runtime/src/cli/index.ts b/packages/jest-runtime/src/cli/index.ts
@@ -16,7 +16,6 @@ import {setGlobal, tryRealpath} from 'jest-util';
 import {validateCLIOptions} from 'jest-validate';
 import {deprecationEntries, readConfig} from 'jest-config';
 import {VERSION} from '../version';
-import type {Context} from '../types';
 import * as args from './args';
 
 export async function run(
@@ -67,11 +66,10 @@ export async function run(
     automock: false,
   };
 
-  // Break circular dependency
-  const Runtime: any = require('..');
+  const {default: Runtime} = await import('..');
 
   try {
-    const hasteMap: Context = await Runtime.createContext(config, {
+    const hasteMap = await Runtime.createContext(config, {
       maxWorkers: Math.max(cpus().length - 1, 1),
       watchman: globalConfig.watchman,
     });

diff --git a/packages/jest-runtime/src/index.ts b/packages/jest-runtime/src/index.ts
@@ -50,13 +50,15 @@ import {
   decodePossibleOutsideJestVmPath,
   findSiblingsWithFileExtension,
 } from './helpers';
-import type {Context as JestContext} from './types';
+import type {Context} from './types';
 import jestMock = require('jest-mock');
 import HasteMap = require('jest-haste-map');
 import Resolver = require('jest-resolve');
 import Snapshot = require('jest-snapshot');
 import stripBOM = require('strip-bom');
 
+export type {Context} from './types';
+
 interface JestGlobalsValues extends Global.TestFrameworkGlobals {
   jest: typeof JestGlobals.jest;
   expect: typeof JestGlobals.expect;
@@ -105,12 +107,6 @@ const fromEntries: typeof Object.fromEntries =
     }, {});
   };
 
-namespace Runtime {
-  export type Context = JestContext;
-  // ditch this export when moving to esm - for now we need it for to avoid faulty type elision
-  export type RuntimeType = Runtime;
-}
-
 const testTimeoutSymbol = Symbol.for('TEST_TIMEOUT_SYMBOL');
 const retryTimesSymbol = Symbol.for('RETRY_TIMES');
 
@@ -137,8 +133,7 @@ type RunScriptEvalResult = {[EVAL_RESULT_VARIABLE]: ModuleWrapper};
 
 const runtimeSupportsVmModules = typeof SyntheticModule === 'function';
 
-/* eslint-disable-next-line no-redeclare */
-class Runtime {
+export default class Runtime {
   private _cacheFS: StringMap;
   private _config: Config.ProjectConfig;
   private _coverageOptions: ShouldInstrumentOptions;
@@ -256,7 +251,7 @@ class Runtime {
       watch?: boolean;
       watchman: boolean;
     },
-  ): Promise<JestContext> {
+  ): Promise<Context> {
     createDirectory(config.cacheDirectory);
     const instance = Runtime.createHasteMap(config, {
       console: options.console,
@@ -1718,5 +1713,3 @@ function invariant(condition: unknown, message?: string): asserts condition {
     throw new Error(message);
   }
 }
-
-export = Runtime;