/
no-large-snapshots.ts
133 lines (120 loc) · 3.37 KB
/
no-large-snapshots.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
import {
AST_NODE_TYPES,
TSESLint,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import { isAbsolute } from 'path';
import {
createRule,
getAccessorValue,
isExpectMember,
isSupportedAccessor,
} from './utils';
interface RuleOptions {
maxSize?: number;
whitelistedSnapshots?: Record<string, Array<string | RegExp>>;
}
type MessageId = 'noSnapshot' | 'tooLongSnapshots';
type RuleContext = TSESLint.RuleContext<MessageId, [RuleOptions]>;
const reportOnViolation = (
context: RuleContext,
node: TSESTree.CallExpression | TSESTree.ExpressionStatement,
{ maxSize: lineLimit = 50, whitelistedSnapshots = {} }: RuleOptions,
) => {
const startLine = node.loc.start.line;
const endLine = node.loc.end.line;
const lineCount = endLine - startLine;
const allPathsAreAbsolute = Object.keys(whitelistedSnapshots).every(
isAbsolute,
);
if (!allPathsAreAbsolute) {
throw new Error(
'All paths for whitelistedSnapshots must be absolute. You can use JS config and `path.resolve`',
);
}
let isWhitelisted = false;
if (
whitelistedSnapshots &&
node.type === AST_NODE_TYPES.ExpressionStatement &&
'left' in node.expression &&
isExpectMember(node.expression.left)
) {
const fileName = context.getFilename();
const whitelistedSnapshotsInFile = whitelistedSnapshots[fileName];
if (whitelistedSnapshotsInFile) {
const snapshotName = getAccessorValue(node.expression.left.property);
isWhitelisted = whitelistedSnapshotsInFile.some(name => {
if (name instanceof RegExp) {
return name.test(snapshotName);
}
return snapshotName;
});
}
}
if (!isWhitelisted && lineCount > lineLimit) {
context.report({
messageId: lineLimit === 0 ? 'noSnapshot' : 'tooLongSnapshots',
data: { lineLimit, lineCount },
node,
});
}
};
export default createRule<[RuleOptions], MessageId>({
name: __filename,
meta: {
docs: {
category: 'Best Practices',
description: 'disallow large snapshots',
recommended: false,
},
messages: {
noSnapshot: '`{{ lineCount }}`s should begin with lowercase',
tooLongSnapshots:
'Expected Jest snapshot to be smaller than {{ lineLimit }} lines but was {{ lineCount }} lines long',
},
type: 'suggestion',
schema: [
{
type: 'object',
properties: {
maxSize: {
type: 'number',
},
whitelistedSnapshots: {
type: 'object',
patternProperties: {
'.*': { type: 'array' },
},
},
},
additionalProperties: false,
},
],
},
defaultOptions: [{}],
create(context, [options]) {
if (context.getFilename().endsWith('.snap')) {
return {
ExpressionStatement(node) {
reportOnViolation(context, node, options);
},
};
} else if (context.getFilename().endsWith('.js')) {
return {
CallExpression(node) {
if (
'property' in node.callee &&
isSupportedAccessor(node.callee.property) &&
[
'toMatchInlineSnapshot',
'toThrowErrorMatchingInlineSnapshot',
].includes(getAccessorValue(node.callee.property))
) {
reportOnViolation(context, node, options);
}
},
};
}
return {};
},
});