chore: migrate pretty-format to ESM

jestjs · Nov 4, 2020 · 341f941 · 341f941
1 parent 30b6cee
commit 341f941
Show file tree

Hide file tree

Showing 41 changed files with 191 additions and 121 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 ### Fixes
 
 - `[jest-transform]` Show enhanced `SyntaxError` message for all `SyntaxError`s ([#10749](https://github.com/facebook/jest/pull/10749))
+- `[pretty-format]` [**BREAKING**] Convert to ES Modules ([#10515](https://github.com/facebook/jest/pull/10515))
 
 ### Chore & Maintenance
 

diff --git a/docs/JestPlatform.md b/docs/JestPlatform.md
@@ -160,7 +160,7 @@ Exports a function that converts any JavaScript value into a human-readable stri
 ### Example
 
 ```javascript
-const prettyFormat = require('pretty-format');
+const {format: prettyFormat} = require('pretty-format');
 
 const val = {object: {}};
 val.circularReference = val;

diff --git a/package.json b/package.json
@@ -141,6 +141,7 @@
     "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0"
   },
   "resolutions": {
+    "@testing-library/dom": "patch:@testing-library/dom@*#./patches/dom-testing.diff",
     "@types/jest/jest-diff": "^25.1.0",
     "@types/jest/pretty-format": "^25.1.0"
   }

diff --git a/packages/jest-circus/src/formatNodeAssertErrors.ts b/packages/jest-circus/src/formatNodeAssertErrors.ts
@@ -14,7 +14,7 @@ import {
   printExpected,
   printReceived,
 } from 'jest-matcher-utils';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 
 interface AssertionErrorWithStack extends AssertionError {
   stack: string;

diff --git a/packages/jest-circus/src/utils.ts b/packages/jest-circus/src/utils.ts
@@ -13,7 +13,7 @@ import StackUtils = require('stack-utils');
 import type {AssertionResult, Status} from '@jest/test-result';
 import type {Circus} from '@jest/types';
 import {ErrorWithStack, convertDescriptorToString, formatTime} from 'jest-util';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import {ROOT_DESCRIBE_BLOCK_NAME, getState} from './state';
 
 const stackUtils = new StackUtils({cwd: 'A path that does not exist'});

diff --git a/packages/jest-config/src/Deprecated.ts b/packages/jest-config/src/Deprecated.ts
@@ -7,7 +7,7 @@
 
 import chalk = require('chalk');
 import type {DeprecatedOptions} from 'jest-validate';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 
 const format = (value: unknown) => prettyFormat(value, {min: true});
 

diff --git a/packages/jest-diff/README.md b/packages/jest-diff/README.md
@@ -165,7 +165,7 @@ You might call this function for case insensitive or Unicode equivalence compari
 ### Example of diffLinesUnified2
 
 ```js
-import format from 'pretty-format';
+import {format} from 'pretty-format';
 
 const a = {
   text: 'Ignore indentation in serialized object',

diff --git a/packages/jest-diff/src/index.ts b/packages/jest-diff/src/index.ts
@@ -7,7 +7,10 @@
 
 import chalk = require('chalk');
 import getType = require('jest-get-type');
-import prettyFormat = require('pretty-format');
+import {
+  format as prettyFormat,
+  plugins as prettyFormatPlugins,
+} from 'pretty-format';
 import {DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT, Diff} from './cleanupSemantic';
 import {NO_DIFF_MESSAGE, SIMILAR_MESSAGE} from './constants';
 import {diffLinesRaw, diffLinesUnified, diffLinesUnified2} from './diffLines';
@@ -33,7 +36,7 @@ const {
   Immutable,
   ReactElement,
   ReactTestComponent,
-} = prettyFormat.plugins;
+} = prettyFormatPlugins;
 
 const PLUGINS = [
   ReactTestComponent,

diff --git a/packages/jest-each/src/__tests__/array.test.ts b/packages/jest-each/src/__tests__/array.test.ts
@@ -6,7 +6,7 @@
  *
  */
 
-import pretty = require('pretty-format');
+import {format as pretty} from 'pretty-format';
 import each from '../';
 
 const noop = () => {};

diff --git a/packages/jest-each/src/table/array.ts b/packages/jest-each/src/table/array.ts
@@ -8,7 +8,7 @@
 
 import * as util from 'util';
 import type {Global} from '@jest/types';
-import pretty = require('pretty-format');
+import {format as pretty} from 'pretty-format';
 import type {EachTests} from '../bind';
 
 const SUPPORTED_PLACEHOLDERS = /%[sdifjoOp%]/g;

diff --git a/packages/jest-each/src/table/template.ts b/packages/jest-each/src/table/template.ts
@@ -8,7 +8,7 @@
 
 import type {Global} from '@jest/types';
 import {isPrimitive} from 'jest-get-type';
-import pretty = require('pretty-format');
+import {format as pretty} from 'pretty-format';
 import type {EachTests} from '../bind';
 
 type Template = Record<string, unknown>;

diff --git a/packages/jest-each/src/validation.ts b/packages/jest-each/src/validation.ts
@@ -8,7 +8,7 @@
 
 import chalk = require('chalk');
 import type {Global} from '@jest/types';
-import pretty = require('pretty-format');
+import {format as pretty} from 'pretty-format';
 
 type TemplateData = Global.TemplateData;
 

diff --git a/packages/jest-jasmine2/src/expectationResultFactory.ts b/packages/jest-jasmine2/src/expectationResultFactory.ts
@@ -6,7 +6,7 @@
  */
 
 import type {FailedAssertion} from '@jest/test-result';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 
 function messageFormatter({error, message, passed}: Options) {
   if (passed) {

diff --git a/packages/jest-jasmine2/src/isError.ts b/packages/jest-jasmine2/src/isError.ts
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 
 export default function isError(
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types

diff --git a/packages/jest-leak-detector/src/index.ts b/packages/jest-leak-detector/src/index.ts
@@ -11,7 +11,7 @@ import {promisify} from 'util';
 import {setFlagsFromString} from 'v8';
 import {runInNewContext} from 'vm';
 import {isPrimitive} from 'jest-get-type';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 
 const tick = promisify(setImmediate);
 

diff --git a/packages/jest-matcher-utils/src/__tests__/index.test.ts b/packages/jest-matcher-utils/src/__tests__/index.test.ts
@@ -8,7 +8,7 @@
 
 import chalk = require('chalk');
 import {alignedAnsiStyleSerializer} from '@jest/test-utils';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import {
   MatcherHintOptions,
   diff,

diff --git a/packages/jest-matcher-utils/src/index.ts b/packages/jest-matcher-utils/src/index.ts
@@ -18,7 +18,10 @@ import diffDefault, {
   diffStringsUnified,
 } from 'jest-diff';
 import getType = require('jest-get-type');
-import prettyFormat = require('pretty-format');
+import {
+  format as prettyFormat,
+  plugins as prettyFormatPlugins,
+} from 'pretty-format';
 import Replaceable from './Replaceable';
 import deepCyclicCopyReplaceable from './deepCyclicCopyReplaceable';
 
@@ -29,7 +32,7 @@ const {
   Immutable,
   ReactElement,
   ReactTestComponent,
-} = prettyFormat.plugins;
+} = prettyFormatPlugins;
 
 const PLUGINS = [
   ReactTestComponent,

diff --git a/packages/jest-message-util/src/index.ts b/packages/jest-message-util/src/index.ts
@@ -13,7 +13,7 @@ import micromatch = require('micromatch');
 import slash = require('slash');
 import StackUtils = require('stack-utils');
 import type {Config, TestResult} from '@jest/types';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import type {Frame} from './types';
 
 export type {Frame} from './types';

diff --git a/packages/jest-serializer/src/__tests__/index.test.ts b/packages/jest-serializer/src/__tests__/index.test.ts
@@ -8,7 +8,7 @@
 import {tmpdir} from 'os';
 import * as path from 'path';
 import * as fs from 'graceful-fs';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import serializer from '..';
 
 const objs = [

diff --git a/packages/jest-snapshot/src/__tests__/dedentLines.test.ts b/packages/jest-snapshot/src/__tests__/dedentLines.test.ts
@@ -5,11 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import format = require('pretty-format');
+import {plugins as builtinPlugins, format} from 'pretty-format';
 import {dedentLines} from '../dedentLines';
 
 const $$typeof = Symbol.for('react.test.json');
-const plugins = [format.plugins.ReactTestComponent];
+const plugins = [builtinPlugins.ReactTestComponent];
 
 const formatLines2 = val => format(val, {indent: 2, plugins}).split('\n');
 const formatLines0 = val => format(val, {indent: 0, plugins}).split('\n');

diff --git a/packages/jest-snapshot/src/__tests__/mockSerializer.test.ts b/packages/jest-snapshot/src/__tests__/mockSerializer.test.ts
@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import plugin from '../mockSerializer';
 
 test('mock with 0 calls and default name', () => {

diff --git a/packages/jest-snapshot/src/__tests__/printSnapshot.test.ts b/packages/jest-snapshot/src/__tests__/printSnapshot.test.ts
@@ -8,7 +8,7 @@
 import ansiRegex = require('ansi-regex');
 import styles = require('ansi-styles');
 import chalk = require('chalk');
-import format = require('pretty-format');
+import {format} from 'pretty-format';
 import {
   aBackground2,
   aBackground3,

diff --git a/packages/jest-snapshot/src/plugins.ts b/packages/jest-snapshot/src/plugins.ts
@@ -5,7 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import prettyFormat = require('pretty-format');
+import {
+  Plugin as PrettyFormatPlugin,
+  Plugins as PrettyFormatPlugins,
+  plugins as prettyFormatPlugins,
+} from 'pretty-format';
 import jestMockSerializer from './mockSerializer';
 
 const {
@@ -15,9 +19,9 @@ const {
   ReactElement,
   ReactTestComponent,
   AsymmetricMatcher,
-} = prettyFormat.plugins;
+} = prettyFormatPlugins;
 
-let PLUGINS: prettyFormat.Plugins = [
+let PLUGINS: PrettyFormatPlugins = [
   ReactTestComponent,
   ReactElement,
   DOMElement,
@@ -28,8 +32,8 @@ let PLUGINS: prettyFormat.Plugins = [
 ];
 
 // Prepend to list so the last added is the first tested.
-export const addSerializer = (plugin: prettyFormat.Plugin): void => {
+export const addSerializer = (plugin: PrettyFormatPlugin): void => {
   PLUGINS = [plugin].concat(PLUGINS);
 };
 
-export const getSerializers = (): prettyFormat.Plugins => PLUGINS;
+export const getSerializers = (): PrettyFormatPlugins => PLUGINS;
diff --git a/packages/jest-snapshot/src/printSnapshot.ts b/packages/jest-snapshot/src/printSnapshot.ts
@@ -33,7 +33,7 @@ import {
   getLabelPrinter,
   matcherHint,
 } from 'jest-matcher-utils';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import {
   aBackground2,
   aBackground3,

diff --git a/packages/jest-snapshot/src/utils.ts b/packages/jest-snapshot/src/utils.ts
@@ -10,7 +10,7 @@ import chalk = require('chalk');
 import * as fs from 'graceful-fs';
 import naturalCompare = require('natural-compare');
 import type {Config} from '@jest/types';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 import {getSerializers} from './plugins';
 import type {SnapshotData} from './types';
 

diff --git a/packages/jest-validate/src/__tests__/fixtures/jestConfig.ts b/packages/jest-validate/src/__tests__/fixtures/jestConfig.ts
@@ -127,7 +127,8 @@ const validConfig = {
   watchman: true,
 };
 
-const format = (value: string) => require('pretty-format')(value, {min: true});
+const format = (value: string) =>
+  require('pretty-format').format(value, {min: true});
 
 const deprecatedConfig = {
   preprocessorIgnorePatterns: (config: Record<string, any>) =>

diff --git a/packages/jest-validate/src/utils.ts b/packages/jest-validate/src/utils.ts
@@ -7,7 +7,7 @@
 
 import chalk = require('chalk');
 import leven from 'leven';
-import prettyFormat = require('pretty-format');
+import prettyFormat from 'pretty-format';
 
 const BULLET: string = chalk.bold('\u25cf');
 export const DEPRECATION = `${BULLET} Deprecation Warning`;