feat(pretty-format)!: remove ConvertAnsi plugin in favour of `jest-…

…serializer-ansi-escapes` (#13040)
jestjs · Jul 20, 2022 · 2842eb6 · 2842eb6
1 parent f96bc2a
commit 2842eb6
Show file tree

Hide file tree

Showing 8 changed files with 6 additions and 140 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 - `[jest-config]` [**BREAKING**] Make `snapshotFormat` default to `escapeString: false` and `printBasicPrototype: false` ([#13036](https://github.com/facebook/jest/pull/13036))
 - `[jest-environment-jsdom]` [**BREAKING**] Upgrade to `jsdom@20` ([#13037](https://github.com/facebook/jest/pull/13037))
+- `[pretty-format]` [**BREAKING**] Remove `ConvertAnsi` plugin in favour of `jest-serializer-ansi-escapes` ([#13040](https://github.com/facebook/jest/pull/13040))
 
 ### Fixes
 

diff --git a/docs/UpgradingToJest29.md b/docs/UpgradingToJest29.md
@@ -31,3 +31,7 @@ If you want to keep the old behavior, you can set the `snapshotFormat` property
 ## JSDOM upgrade
 
 `jest-environment-jsdom` has upgraded `jsdom` from v19 to v20. Due to issues with `@types/jsdom`, if you extend this environment, you might run into type errors. See https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/60999#discussioncomment-3158685.
+
+## `pretty-format`
+
+`ConvertAnsi` plugin is removed in favour of [`jest-serializer-ansi-escapes`](https://github.com/mrazauskas/jest-serializer-ansi-escapes).
diff --git a/packages/pretty-format/package.json b/packages/pretty-format/package.json
@@ -15,13 +15,11 @@
       "types": "./build/index.d.ts",
       "default": "./build/index.js"
     },
-    "./package.json": "./package.json",
-    "./ConvertAnsi": "./build/plugins/ConvertAnsi.js"
+    "./package.json": "./package.json"
   },
   "author": "James Kyle <[email protected]>",
   "dependencies": {
     "@jest/schemas": "^29.0.0-alpha.0",
-    "ansi-regex": "^5.0.1",
     "ansi-styles": "^5.0.0",
     "react-is": "^18.0.0"
   },

diff --git a/packages/pretty-format/src/__tests__/ConvertAnsi.test.ts b/packages/pretty-format/src/__tests__/ConvertAnsi.test.ts
diff --git a/packages/pretty-format/src/index.ts b/packages/pretty-format/src/index.ts
@@ -15,7 +15,6 @@ import {
   printObjectProperties,
 } from './collections';
 import AsymmetricMatcher from './plugins/AsymmetricMatcher';
-import ConvertAnsi from './plugins/ConvertAnsi';
 import DOMCollection from './plugins/DOMCollection';
 import DOMElement from './plugins/DOMElement';
 import Immutable from './plugins/Immutable';
@@ -536,7 +535,6 @@ export function format(val: unknown, options?: OptionsReceived): string {
 
 export const plugins = {
   AsymmetricMatcher,
-  ConvertAnsi,
   DOMCollection,
   DOMElement,
   Immutable,

diff --git a/packages/pretty-format/src/plugins/ConvertAnsi.ts b/packages/pretty-format/src/plugins/ConvertAnsi.ts
diff --git a/scripts/buildUtils.mjs b/scripts/buildUtils.mjs
@@ -69,9 +69,6 @@ export function getPackages() {
         ...(pkg.name === 'expect'
           ? {'./build/matchers': './build/matchers.js'}
           : {}),
-        ...(pkg.name === 'pretty-format'
-          ? {'./ConvertAnsi': './build/plugins/ConvertAnsi.js'}
-          : {}),
       },
       `Package "${pkg.name}" does not export correct files`,
     );

diff --git a/yarn.lock b/yarn.lock
@@ -17945,7 +17945,6 @@ __metadata:
     "@types/react": ^17.0.3
     "@types/react-is": ^17.0.0
     "@types/react-test-renderer": 17.0.2
-    ansi-regex: ^5.0.1
     ansi-styles: ^5.0.0
     expect: ^29.0.0-alpha.0
     immutable: ^4.0.0