chore: remove deprecated exports from jest-util (#8863)

jestjs · Aug 22, 2019 · b8a4a85 · b8a4a85
1 parent 7b8393e
commit b8a4a85
Show file tree

Hide file tree

Showing 17 changed files with 24 additions and 156 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@
 - `[*]` [**BREAKING**] Upgrade to Micromatch v4 ([#8852](https://github.com/facebook/jest/pull/8852))
 - `[docs]` Fix broken link pointing to legacy JS file in "Snapshot Testing".
 - `[jest-environment-jsdom]` [**BREAKING**] Upgrade JSDOM from v11 to v15 ([#8851](https://github.com/facebook/jest/pull/8851))
+- `[jest-util]` [**BREAKING**] Remove deprecated exports ([#8863](https://github.com/facebook/jest/pull/8863))
 
 ### Performance
 

diff --git a/packages/jest-core/src/runJest.ts b/packages/jest-core/src/runJest.ts
@@ -9,7 +9,7 @@ import * as path from 'path';
 import chalk from 'chalk';
 import {sync as realpath} from 'realpath-native';
 import {CustomConsole} from '@jest/console';
-import {formatTestResults, interopRequireDefault} from 'jest-util';
+import {interopRequireDefault} from 'jest-util';
 import exit = require('exit');
 import * as fs from 'graceful-fs';
 import {JestHook, JestHookEmitter} from 'jest-watcher';
@@ -18,6 +18,7 @@ import {Test} from 'jest-runner';
 import {Config} from '@jest/types';
 import {
   AggregatedResult,
+  formatTestResults,
   makeEmptyAggregatedTestResult,
 } from '@jest/test-result';
 // eslint-disable-next-line import/no-extraneous-dependencies

diff --git a/packages/jest-fake-timers/package.json b/packages/jest-fake-timers/package.json
@@ -12,7 +12,8 @@
   "dependencies": {
     "@jest/types": "^24.9.0",
     "jest-message-util": "^24.9.0",
-    "jest-mock": "^24.9.0"
+    "jest-mock": "^24.9.0",
+    "jest-util": "^24.9.0"
   },
   "engines": {
     "node": ">= 8"

diff --git a/packages/jest-fake-timers/src/jestFakeTimers.ts b/packages/jest-fake-timers/src/jestFakeTimers.ts
@@ -7,6 +7,7 @@
 
 import {ModuleMocker} from 'jest-mock';
 import {StackTraceConfig, formatStackTrace} from 'jest-message-util';
+import {setGlobal} from 'jest-util';
 
 type Callback = (...args: Array<unknown>) => void;
 
@@ -42,16 +43,6 @@ type TimerConfig<Ref> = {
 
 const MS_IN_A_YEAR = 31536000000;
 
-// TODO: Copied from `jest-util` to avoid cyclic dependency. Import from `jest-util` in the next major
-const setGlobal = (
-  globalToMutate: NodeJS.Global | Window,
-  key: string,
-  value: unknown,
-) => {
-  // @ts-ignore: no index
-  globalToMutate[key] = value;
-};
-
 export default class FakeTimers<TimerRef> {
   private _cancelledTicks!: Record<string, boolean>;
   private _config: StackTraceConfig;

diff --git a/packages/jest-fake-timers/tsconfig.json b/packages/jest-fake-timers/tsconfig.json
@@ -6,6 +6,7 @@
   },
   "references": [
     {"path": "../jest-message-util"},
-    {"path": "../jest-mock"}
+    {"path": "../jest-mock"},
+    {"path": "../jest-util"}
   ]
 }
diff --git a/packages/jest-jasmine2/package.json b/packages/jest-jasmine2/package.json
@@ -12,6 +12,7 @@
   "dependencies": {
     "@babel/traverse": "^7.1.0",
     "@jest/environment": "^24.9.0",
+    "@jest/source-map": "^24.9.0",
     "@jest/test-result": "^24.9.0",
     "@jest/types": "^24.9.0",
     "chalk": "^2.0.1",

diff --git a/packages/jest-jasmine2/src/index.ts b/packages/jest-jasmine2/src/index.ts
@@ -12,7 +12,7 @@ import {JestEnvironment} from '@jest/environment';
 import {SnapshotStateType} from 'jest-snapshot';
 import Runtime = require('jest-runtime');
 
-import {getCallsite} from 'jest-util';
+import {getCallsite} from '@jest/source-map';
 import installEach from './each';
 import {installErrorOnPrivate} from './errorOnPrivate';
 import JasmineReporter from './reporter';

diff --git a/packages/jest-jasmine2/tsconfig.json b/packages/jest-jasmine2/tsconfig.json
@@ -12,6 +12,7 @@
     {"path": "../jest-message-util"},
     {"path": "../jest-runtime"},
     {"path": "../jest-snapshot"},
+    {"path": "../jest-source-map"},
     {"path": "../jest-test-result"},
     {"path": "../jest-types"},
     {"path": "../jest-util"},

diff --git a/packages/jest-reporters/package.json b/packages/jest-reporters/package.json
@@ -5,6 +5,7 @@
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "dependencies": {
+    "@jest/console": "^24.9.0",
     "@jest/environment": "^24.9.0",
     "@jest/test-result": "^24.9.0",
     "@jest/transform": "^24.9.0",

diff --git a/packages/jest-reporters/src/__tests__/default_reporter.test.js b/packages/jest-reporters/src/__tests__/default_reporter.test.js
@@ -5,7 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-'use strict';
+import DefaultReporter from '../default_reporter';
+
+jest.mock('jest-util', () => ({
+  ...jest.requireActual('jest-util'),
+  // This is not a CI environment, which removes all output by default.
+  isInteractive: true,
+}));
 
 const aggregatedResults = {};
 const options = {};
@@ -26,22 +32,15 @@ const testResult = {
   testFilePath: '/foo',
 };
 
-let DefaultReporter;
 let stdout;
 
 let oldIsTTY;
 let oldStderr;
 let oldStdout;
 
 beforeEach(() => {
-  jest.resetModules();
   jest.useFakeTimers();
 
-  // This is not a CI environment, which removes all output by default.
-  jest.unmock('jest-util');
-  const util = require('jest-util');
-  util.isInteractive = true;
-
   oldIsTTY = process.stdin.isTTY;
   oldStdout = process.stdout.write;
   oldStderr = process.stderr.write;
@@ -52,8 +51,6 @@ beforeEach(() => {
   process.stdin.isTTY = true;
   process.stderr.write = jest.fn();
   stdout = process.stdout.write = jest.fn();
-
-  DefaultReporter = require('../default_reporter').default;
 });
 
 afterEach(() => {

diff --git a/packages/jest-reporters/src/default_reporter.ts b/packages/jest-reporters/src/default_reporter.ts
@@ -7,7 +7,8 @@
 
 import {Config} from '@jest/types';
 import {AggregatedResult, TestResult} from '@jest/test-result';
-import {clearLine, getConsoleOutput, isInteractive} from 'jest-util';
+import {clearLine, isInteractive} from 'jest-util';
+import {getConsoleOutput} from '@jest/console';
 import chalk from 'chalk';
 import {ReporterOnStartOptions, Test} from './types';
 import BaseReporter from './base_reporter';

diff --git a/packages/jest-reporters/tsconfig.json b/packages/jest-reporters/tsconfig.json
@@ -5,6 +5,7 @@
     "outDir": "build"
   },
   "references": [
+    {"path": "../jest-console"},
     {"path": "../jest-environment"},
     {"path": "../jest-haste-map"},
     {"path": "../jest-resolve"},

diff --git a/packages/jest-util/package.json b/packages/jest-util/package.json
@@ -10,18 +10,10 @@
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "dependencies": {
-    "@jest/console": "^24.9.0",
-    "@jest/fake-timers": "^24.9.0",
-    "@jest/source-map": "^24.9.0",
-    "@jest/test-result": "^24.9.0",
     "@jest/types": "^24.9.0",
-    "callsites": "^3.0.0",
     "chalk": "^2.0.1",
-    "graceful-fs": "^4.1.15",
     "is-ci": "^2.0.0",
-    "mkdirp": "^0.5.1",
-    "slash": "^3.0.0",
-    "source-map": "^0.6.0"
+    "mkdirp": "^0.5.1"
   },
   "devDependencies": {
     "@types/graceful-fs": "^4.1.2",

diff --git a/packages/jest-util/src/__tests__/getFailedSnapshot.test.ts b/packages/jest-util/src/__tests__/getFailedSnapshot.test.ts
diff --git a/packages/jest-util/src/getFailedSnapshotTests.ts b/packages/jest-util/src/getFailedSnapshotTests.ts
diff --git a/packages/jest-util/src/index.ts b/packages/jest-util/src/index.ts
@@ -5,20 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// TODO: Remove these exports in the next major
-import {JestFakeTimers as FakeTimers} from '@jest/fake-timers';
-import {getCallsite} from '@jest/source-map';
-import {
-  BufferedConsole,
-  CustomConsole,
-  NullConsole,
-  getConsoleOutput,
-} from '@jest/console';
-import {formatTestResults} from '@jest/test-result';
 import clearLine from './clearLine';
 import createDirectory from './createDirectory';
 import ErrorWithStack from './ErrorWithStack';
-import getFailedSnapshotTests from './getFailedSnapshotTests';
 import installCommonGlobals from './installCommonGlobals';
 import interopRequireDefault from './interopRequireDefault';
 import isInteractive from './isInteractive';
@@ -32,20 +21,12 @@ import testPathPatternToRegExp from './testPathPatternToRegExp';
 import * as preRunMessage from './preRunMessage';
 import pluralize from './pluralize';
 
-export = {
-  BufferedConsole,
-  Console: CustomConsole,
+export {
   ErrorWithStack,
-  FakeTimers,
-  NullConsole,
   clearLine,
   convertDescriptorToString,
   createDirectory,
   deepCyclicCopy,
-  formatTestResults,
-  getCallsite,
-  getConsoleOutput,
-  getFailedSnapshotTests,
   installCommonGlobals,
   interopRequireDefault,
   isInteractive,

diff --git a/packages/jest-util/tsconfig.json b/packages/jest-util/tsconfig.json
@@ -5,10 +5,6 @@
     "outDir": "build"
   },
   "references": [
-    {"path": "../jest-console"},
-    {"path": "../jest-fake-timers"},
-    {"path": "../jest-source-map"},
-    {"path": "../jest-test-result"},
     {"path": "../jest-types"}
   ]
 }