forked from jestjs/jest
/
get_snapshot_summary.ts
139 lines (128 loc) · 3.84 KB
/
get_snapshot_summary.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
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import {Config} from '@jest/types';
import {SnapshotSummary} from '@jest/test-result';
import chalk from 'chalk';
import {pluralize} from 'jest-util';
import {formatTestPath} from './utils';
const ARROW = ' \u203A ';
const DOWN_ARROW = ' \u21B3 ';
const DOT = ' \u2022 ';
const FAIL_COLOR = chalk.bold.red;
const OBSOLETE_COLOR = chalk.bold.yellow;
const SNAPSHOT_ADDED = chalk.bold.green;
const SNAPSHOT_NOTE = chalk.dim;
const SNAPSHOT_REMOVED = chalk.bold.green;
const SNAPSHOT_SUMMARY = chalk.bold;
const SNAPSHOT_UPDATED = chalk.bold.green;
export default (
snapshots: SnapshotSummary,
globalConfig: Config.GlobalConfig,
updateCommand: string,
): Array<string> => {
const summary = [];
summary.push(SNAPSHOT_SUMMARY('Snapshot Summary'));
if (snapshots.added) {
summary.push(
SNAPSHOT_ADDED(
ARROW + pluralize('snapshot', snapshots.added) + ' written ',
) + `from ${pluralize('test suite', snapshots.filesAdded)}.`,
);
}
if (snapshots.unmatched) {
summary.push(
FAIL_COLOR(
`${ARROW}${pluralize('snapshot', snapshots.unmatched)} failed`,
) +
` from ${pluralize('test suite', snapshots.filesUnmatched)}. ` +
SNAPSHOT_NOTE(
'Inspect your code changes or ' + updateCommand + ' to update them.',
),
);
}
if (snapshots.updated) {
summary.push(
SNAPSHOT_UPDATED(
ARROW + pluralize('snapshot', snapshots.updated) + ' updated ',
) + `from ${pluralize('test suite', snapshots.filesUpdated)}.`,
);
}
if (snapshots.filesRemoved) {
if (snapshots.didUpdate) {
summary.push(
SNAPSHOT_REMOVED(
`${ARROW}${pluralize(
'snapshot file',
snapshots.filesRemoved,
)} removed `,
) + `from ${pluralize('test suite', snapshots.filesRemoved)}.`,
);
} else {
summary.push(
OBSOLETE_COLOR(
`${ARROW}${pluralize(
'snapshot file',
snapshots.filesRemoved,
)} obsolete `,
) +
`from ${pluralize('test suite', snapshots.filesRemoved)}. ` +
SNAPSHOT_NOTE(
`To remove ${
snapshots.filesRemoved === 1 ? 'it' : 'them all'
}, ${updateCommand}.`,
),
);
}
}
if (snapshots.filesRemovedList && snapshots.filesRemovedList.length) {
const [head, ...tail] = snapshots.filesRemovedList;
summary.push(` ${DOWN_ARROW} ${DOT}${formatTestPath(globalConfig, head)}`);
tail.forEach(key => {
summary.push(` ${DOT}${formatTestPath(globalConfig, key)}`);
});
}
if (snapshots.unchecked) {
if (snapshots.didUpdate) {
summary.push(
SNAPSHOT_REMOVED(
`${ARROW}${pluralize('snapshot', snapshots.unchecked)} removed `,
) +
`from ${pluralize(
'test suite',
snapshots.uncheckedKeysByFile.length,
)}.`,
);
} else {
summary.push(
OBSOLETE_COLOR(
`${ARROW}${pluralize('snapshot', snapshots.unchecked)} obsolete `,
) +
`from ${pluralize(
'test suite',
snapshots.uncheckedKeysByFile.length,
)}. ` +
SNAPSHOT_NOTE(
`To remove ${
snapshots.unchecked === 1 ? 'it' : 'them all'
}, ${updateCommand}.`,
),
);
}
snapshots.uncheckedKeysByFile.forEach(uncheckedFile => {
summary.push(
` ${DOWN_ARROW}${formatTestPath(
globalConfig,
uncheckedFile.filePath,
)}`,
);
uncheckedFile.keys.forEach(key => {
summary.push(` ${DOT}${key}`);
});
});
}
return summary;
};