chore: export DiffOptions from jest-diff (#8027)

jestjs · Mar 3, 2019 · 4c25942 · 4c25942
1 parent 5f34db7
commit 4c25942
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -44,7 +44,7 @@
 - `[diff-sequences]`: Migrate to Typescript ([#7820](https://github.com/facebook/jest/pull/7820))
 - `[jest-get-type]`: Migrate to TypeScript ([#7818](https://github.com/facebook/jest/pull/7818))
 - `[jest-regex-util]`: Migrate to TypeScript ([#7822](https://github.com/facebook/jest/pull/7822))
-- `[jest-diff]`: Migrate to TypeScript ([#7824](https://github.com/facebook/jest/pull/7824))
+- `[jest-diff]`: Migrate to TypeScript ([#7824](https://github.com/facebook/jest/pull/7824), [#8027](https://github.com/facebook/jest/pull/8027))
 - `[jest-leak-detector]`: Migrate to TypeScript ([#7825](https://github.com/facebook/jest/pull/7825))
 - `[jest-changed-files]`: Migrate to TypeScript ([#7827](https://github.com/facebook/jest/pull/7827))
 - `[jest-matcher-utils]`: Migrate to TypeScript ([#7835](https://github.com/facebook/jest/pull/7835))

diff --git a/packages/jest-circus/package.json b/packages/jest-circus/package.json
@@ -33,7 +33,6 @@
     "@types/co": "^4.6.0",
     "@types/stack-utils": "^1.0.1",
     "execa": "^1.0.0",
-    "jest-diff": "^24.0.0",
     "jest-runtime": "^24.1.0"
   },
   "engines": {

diff --git a/packages/jest-circus/src/formatNodeAssertErrors.ts b/packages/jest-circus/src/formatNodeAssertErrors.ts
@@ -6,14 +6,16 @@
  */
 
 import {AssertionError} from 'assert';
-import {diff, printExpected, printReceived} from 'jest-matcher-utils';
+import {
+  diff,
+  printExpected,
+  printReceived,
+  DiffOptions,
+} from 'jest-matcher-utils';
 import chalk from 'chalk';
 import prettyFormat from 'pretty-format';
 import {Event, State, TestError} from './types';
 
-// TODO replace with import {DiffOptions} from 'jest-matcher-utils';
-type DiffOptions = Parameters<typeof diff>[2];
-
 interface AssertionErrorWithStack extends AssertionError {
   stack: string;
 }

diff --git a/packages/jest-circus/tsconfig.json b/packages/jest-circus/tsconfig.json
@@ -5,7 +5,6 @@
     "rootDir": "src"
   },
   "references": [
-    {"path": "../jest-diff"},
     {"path": "../jest-each"},
     {"path": "../jest-environment"},
     {"path": "../jest-matcher-utils"},

diff --git a/packages/jest-diff/src/index.ts b/packages/jest-diff/src/index.ts
@@ -10,7 +10,7 @@ import chalk from 'chalk';
 import getType from 'jest-get-type';
 import diffStrings from './diffStrings';
 import {NO_DIFF_MESSAGE, SIMILAR_MESSAGE} from './constants';
-import {DiffOptions} from './types';
+import {DiffOptions as JestDiffOptions} from './types';
 
 const {
   AsymmetricMatcher,
@@ -42,7 +42,7 @@ const FALLBACK_FORMAT_OPTIONS_0 = {...FALLBACK_FORMAT_OPTIONS, indent: 0};
 
 // Generate a string that will highlight the difference between two values
 // with green and red. (similar to how github does code diffing)
-function diff(a: any, b: any, options?: DiffOptions): string | null {
+function diff(a: any, b: any, options?: JestDiffOptions): string | null {
   if (Object.is(a, b)) {
     return NO_DIFF_MESSAGE;
   }
@@ -95,7 +95,7 @@ function diff(a: any, b: any, options?: DiffOptions): string | null {
 function comparePrimitive(
   a: number | boolean,
   b: number | boolean,
-  options?: DiffOptions,
+  options?: JestDiffOptions,
 ) {
   return diffStrings(
     prettyFormat(a, FORMAT_OPTIONS),
@@ -112,7 +112,7 @@ function sortSet(set: Set<unknown>) {
   return new Set(Array.from(set.values()).sort());
 }
 
-function compareObjects(a: Object, b: Object, options?: DiffOptions) {
+function compareObjects(a: Object, b: Object, options?: JestDiffOptions) {
   let diffMessage;
   let hasThrown = false;
 
@@ -150,4 +150,9 @@ function compareObjects(a: Object, b: Object, options?: DiffOptions) {
   return diffMessage;
 }
 
+// eslint-disable-next-line no-redeclare
+namespace diff {
+  export type DiffOptions = JestDiffOptions;
+}
+
 export = diff;
diff --git a/packages/jest-matcher-utils/src/index.ts b/packages/jest-matcher-utils/src/index.ts
@@ -6,7 +6,7 @@
  */
 
 import chalk from 'chalk';
-import jestDiff from 'jest-diff';
+import jestDiff, {DiffOptions} from 'jest-diff';
 import getType from 'jest-get-type';
 import prettyFormat from 'pretty-format';
 const {
@@ -35,6 +35,8 @@ export type MatcherHintOptions = {
   secondArgument?: string;
 };
 
+export {DiffOptions};
+
 export const EXPECTED_COLOR = chalk.green;
 export const RECEIVED_COLOR = chalk.red;
 export const INVERTED_COLOR = chalk.inverse;