chore: migrate jest-util to TypeScript (jestjs#7844)

captain-yossarian · Jul 18, 2019 · a714205 · a714205
1 parent 19322c9
commit a714205
Show file tree

Hide file tree

Showing 46 changed files with 889 additions and 695 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@
 - `[jest-serializer]`: Migrate to TypeScript ([#7841](https://github.com/facebook/jest/pull/7841))
 - `[jest-message-util]`: Migrate to TypeScript ([#7834](https://github.com/facebook/jest/pull/7834))
 - `[@jest/types]`: New package to handle shared types ([#7834](https://github.com/facebook/jest/pull/7834))
+- `[jest-util]`: Migrate to TypeScript ([#7844](https://github.com/facebook/jest/pull/7844))
 
 ### Performance
 

diff --git a/e2e/__tests__/__snapshots__/consoleAfterTeardown.test.js.snap b/e2e/__tests__/__snapshots__/consoleAfterTeardown.test.js.snap
@@ -15,6 +15,6 @@ PASS __tests__/console.test.js
       15 | });
       16 | 
 
-      at BufferedConsole.log (../../packages/jest-util/build/BufferedConsole.js:169:10)
+      at BufferedConsole.log (../../packages/jest-util/build/BufferedConsole.js:182:10)
       at log (__tests__/console.test.js:13:13)
 `;
diff --git a/packages/jest-circus/src/index.js b/packages/jest-circus/src/index.js
@@ -18,6 +18,7 @@ import type {
   TestMode,
 } from 'types/Circus';
 import {bind as bindEach} from 'jest-each';
+// $FlowFixMe: Converted to TS
 import {ErrorWithStack} from 'jest-util';
 import {dispatch} from './state';
 

diff --git a/packages/jest-circus/src/utils.js b/packages/jest-circus/src/utils.js
@@ -22,6 +22,7 @@ import type {
   TestName,
   TestResults,
 } from 'types/Circus';
+// $FlowFixMe: Converted to TS
 import {convertDescriptorToString} from 'jest-util';
 import isGeneratorFn from 'is-generator-fn';
 import co from 'co';

diff --git a/packages/jest-message-util/src/index.ts b/packages/jest-message-util/src/index.ts
@@ -14,7 +14,6 @@ import slash from 'slash';
 import {codeFrameColumns} from '@babel/code-frame';
 import StackUtils from 'stack-utils';
 
-type Glob = Config.Glob;
 type Path = Config.Path;
 type AssertionResult = TestResult.AssertionResult;
 type SerializableError = TestResult.SerializableError;
@@ -33,12 +32,12 @@ try {
   // node internals in the browser though, so no issue.
 }
 
-type StackTraceConfig = {
-  rootDir: string;
-  testMatch: Array<Glob>;
-};
+export type StackTraceConfig = Pick<
+  Config.ProjectConfig,
+  'rootDir' | 'testMatch'
+>;
 
-type StackTraceOptions = {
+export type StackTraceOptions = {
   noStackTrace: boolean;
 };
 

diff --git a/packages/jest-runner/src/runTest.js b/packages/jest-runner/src/runTest.js
@@ -39,7 +39,6 @@ function freezeConsole(
   testConsole: BufferedConsole | Console | NullConsole,
   config: ProjectConfig,
 ) {
-  // $FlowFixMe: overwrite it for pretty errors
   testConsole._log = function fakeConsolePush(_type, message) {
     const error = new ErrorWithStack(
       `${chalk.red(
@@ -89,7 +88,6 @@ async function runTestInternal(
   if (customEnvironment) {
     testEnvironment = getTestEnvironment({
       ...config,
-      // $FlowFixMe
       testEnvironment: customEnvironment,
     });
   }

diff --git a/packages/jest-util/src/setGlobal.js → packages/jest-types/src/SourceMaps.ts b/packages/jest-util/src/setGlobal.js → packages/jest-types/src/SourceMaps.ts
@@ -3,11 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-import type {Global} from 'types/Global';
-
-export default (global: Global, key: string, value: any) =>
-  (global[key] = value);
+export type SourceMapRegistry = {[key: string]: string};
diff --git a/packages/jest-types/src/TestResult.ts b/packages/jest-types/src/TestResult.ts
@@ -123,6 +123,7 @@ export type AssertionResult = {
 };
 
 export type FormattedAssertionResult = {
+  ancestorTitles: Array<string>;
   failureMessages: Array<string> | null;
   fullName: string;
   location: Callsite | null | undefined;
@@ -150,7 +151,7 @@ export type AggregatedResultWithoutCoverage = {
 };
 
 export type AggregatedResult = AggregatedResultWithoutCoverage & {
-  coverageMap?: CoverageMap | null | undefined;
+  coverageMap?: CoverageMap | null;
 };
 
 export type Suite = {
@@ -160,10 +161,10 @@ export type Suite = {
 };
 
 export type TestResult = {
-  console: ConsoleBuffer | null | undefined;
+  console?: ConsoleBuffer | null;
   coverage?: RawCoverage;
-  displayName: string | null | undefined;
-  failureMessage: string | null | undefined;
+  displayName?: string | null;
+  failureMessage?: string | null;
   leaks: boolean;
   memoryUsage?: Bytes;
   numFailingTests: number;

diff --git a/packages/jest-types/src/index.ts b/packages/jest-types/src/index.ts
@@ -7,6 +7,7 @@
 
 import * as Config from './Config';
 import * as Console from './Console';
+import * as SourceMaps from './SourceMaps';
 import * as TestResult from './TestResult';
 
-export {Config, Console, TestResult};
+export {Config, Console, SourceMaps, TestResult};
diff --git a/packages/jest-util/package.json b/packages/jest-util/package.json
@@ -8,22 +8,27 @@
   },
   "license": "MIT",
   "main": "build/index.js",
+  "types": "build/index.d.ts",
   "dependencies": {
+    "@jest/types": "^24.1.0",
+    "@types/node": "*",
     "callsites": "^3.0.0",
     "chalk": "^2.0.1",
     "graceful-fs": "^4.1.15",
     "is-ci": "^2.0.0",
     "jest-message-util": "^24.0.0",
+    "jest-mock": "^24.0.0",
     "mkdirp": "^0.5.1",
+    "readable-stream": "^3.1.1",
     "slash": "^2.0.0",
     "source-map": "^0.6.0"
   },
   "devDependencies": {
-    "@types/callsites": "^2.0.0",
     "@types/graceful-fs": "^4.1.2",
     "@types/is-ci": "^1.0.10",
     "@types/mkdirp": "^0.5.2",
-    "jest-mock": "^24.0.0"
+    "@types/readable-stream": "^2.3.0",
+    "@types/slash": "^2.0.0"
   },
   "engines": {
     "node": ">= 6"

diff --git a/packages/jest-util/src/BufferedConsole.js b/packages/jest-util/src/BufferedConsole.js