/
index.ts
210 lines (184 loc) · 5.93 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
// This is a fork of Jest's jest-diff package, but it doesn't depend on Node environment (like chalk).
import type { PrettyFormatOptions } from 'pretty-format'
import {
format as prettyFormat,
plugins as prettyFormatPlugins,
} from 'pretty-format'
import { getType } from './getType'
import { DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT, Diff } from './cleanupSemantic'
import { NO_DIFF_MESSAGE, SIMILAR_MESSAGE } from './constants'
import { diffLinesRaw, diffLinesUnified, diffLinesUnified2 } from './diffLines'
import { normalizeDiffOptions } from './normalizeDiffOptions'
import { diffStringsRaw, diffStringsUnified } from './printDiffs'
import type { DiffOptions } from './types'
export type { DiffOptions, DiffOptionsColor } from './types'
export { diffLinesRaw, diffLinesUnified, diffLinesUnified2 }
export { diffStringsRaw, diffStringsUnified }
export { DIFF_DELETE, DIFF_EQUAL, DIFF_INSERT, Diff }
function getCommonMessage(message: string, options?: DiffOptions) {
const { commonColor } = normalizeDiffOptions(options)
return commonColor(message)
}
const {
AsymmetricMatcher,
DOMCollection,
DOMElement,
Immutable,
ReactElement,
ReactTestComponent,
} = prettyFormatPlugins
const PLUGINS = [
ReactTestComponent,
ReactElement,
DOMElement,
DOMCollection,
Immutable,
AsymmetricMatcher,
]
const FORMAT_OPTIONS = {
plugins: PLUGINS,
}
const FALLBACK_FORMAT_OPTIONS = {
callToJSON: false,
maxDepth: 10,
plugins: PLUGINS,
}
// Generate a string that will highlight the difference between two values
// with green and red. (similar to how github does code diffing)
/**
* @param a Expected value
* @param b Received value
* @param options Diff options
* @returns
*/
export function diff(a: any, b: any, options?: DiffOptions): string | null {
if (Object.is(a, b))
return ''
const aType = getType(a)
let expectedType = aType
let omitDifference = false
if (aType === 'object' && typeof a.asymmetricMatch === 'function') {
if (a.$$typeof !== Symbol.for('jest.asymmetricMatcher')) {
// Do not know expected type of user-defined asymmetric matcher.
return null
}
if (typeof a.getExpectedType !== 'function') {
// For example, expect.anything() matches either null or undefined
return null
}
expectedType = a.getExpectedType()
// Primitive types boolean and number omit difference below.
// For example, omit difference for expect.stringMatching(regexp)
omitDifference = expectedType === 'string'
}
if (expectedType !== getType(b)) {
const { aAnnotation, aColor, aIndicator, bAnnotation, bColor, bIndicator } = normalizeDiffOptions(options)
const formatOptions = getFormatOptions(FALLBACK_FORMAT_OPTIONS, options)
const aDisplay = prettyFormat(a, formatOptions)
const bDisplay = prettyFormat(b, formatOptions)
const aDiff = `${aColor(`${aIndicator} ${aAnnotation}:`)} \n${aDisplay}`
const bDiff = `${bColor(`${bIndicator} ${bAnnotation}:`)} \n${bDisplay}`
return `${aDiff}\n\n${bDiff}`
}
if (omitDifference)
return null
switch (aType) {
case 'string':
return diffLinesUnified(a.split('\n'), b.split('\n'), options)
case 'boolean':
case 'number':
return comparePrimitive(a, b, options)
case 'map':
return compareObjects(sortMap(a), sortMap(b), options)
case 'set':
return compareObjects(sortSet(a), sortSet(b), options)
default:
return compareObjects(a, b, options)
}
}
function comparePrimitive(
a: number | boolean,
b: number | boolean,
options?: DiffOptions,
) {
const aFormat = prettyFormat(a, FORMAT_OPTIONS)
const bFormat = prettyFormat(b, FORMAT_OPTIONS)
return aFormat === bFormat
? ''
: diffLinesUnified(aFormat.split('\n'), bFormat.split('\n'), options)
}
function sortMap(map: Map<unknown, unknown>) {
return new Map(Array.from(map.entries()).sort())
}
function sortSet(set: Set<unknown>) {
return new Set(Array.from(set.values()).sort())
}
function compareObjects(
a: Record<string, any>,
b: Record<string, any>,
options?: DiffOptions,
) {
let difference
let hasThrown = false
try {
const formatOptions = getFormatOptions(FORMAT_OPTIONS, options)
difference = getObjectsDifference(a, b, formatOptions, options)
}
catch {
hasThrown = true
}
const noDiffMessage = getCommonMessage(NO_DIFF_MESSAGE, options)
// If the comparison yields no results, compare again but this time
// without calling `toJSON`. It's also possible that toJSON might throw.
if (difference === undefined || difference === noDiffMessage) {
const formatOptions = getFormatOptions(FALLBACK_FORMAT_OPTIONS, options)
difference = getObjectsDifference(a, b, formatOptions, options)
if (difference !== noDiffMessage && !hasThrown) {
difference = `${getCommonMessage(
SIMILAR_MESSAGE,
options,
)}\n\n${difference}`
}
}
return difference
}
function getFormatOptions(
formatOptions: PrettyFormatOptions,
options?: DiffOptions,
): PrettyFormatOptions {
const { compareKeys } = normalizeDiffOptions(options)
return {
...formatOptions,
compareKeys,
}
}
function getObjectsDifference(
a: Record<string, any>,
b: Record<string, any>,
formatOptions: PrettyFormatOptions,
options?: DiffOptions,
): string {
const formatOptionsZeroIndent = { ...formatOptions, indent: 0 }
const aCompare = prettyFormat(a, formatOptionsZeroIndent)
const bCompare = prettyFormat(b, formatOptionsZeroIndent)
if (aCompare === bCompare) {
return getCommonMessage(NO_DIFF_MESSAGE, options)
}
else {
const aDisplay = prettyFormat(a, formatOptions)
const bDisplay = prettyFormat(b, formatOptions)
return diffLinesUnified2(
aDisplay.split('\n'),
bDisplay.split('\n'),
aCompare.split('\n'),
bCompare.split('\n'),
options,
)
}
}