/
lowercase-name.ts
157 lines (140 loc) · 4.11 KB
/
lowercase-name.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
import {
AST_NODE_TYPES,
TSESLint,
TSESTree,
} from '@typescript-eslint/experimental-utils';
import {
DescribeAlias,
JestFunctionCallExpressionWithIdentifierCallee,
JestFunctionName,
TestCaseName,
createRule,
isDescribe,
isTestCase,
} from './utils';
type ArgumentLiteral = TSESTree.Literal | TSESTree.TemplateLiteral;
interface FirstArgumentStringCallExpression extends TSESTree.CallExpression {
arguments: [ArgumentLiteral];
}
type CallExpressionWithCorrectCalleeAndArguments = JestFunctionCallExpressionWithIdentifierCallee<
TestCaseName.it | TestCaseName.test | DescribeAlias.describe
> &
FirstArgumentStringCallExpression;
const hasStringAsFirstArgument = (
node: TSESTree.CallExpression,
): node is FirstArgumentStringCallExpression =>
node.arguments &&
node.arguments[0] &&
(node.arguments[0].type === AST_NODE_TYPES.Literal ||
node.arguments[0].type === AST_NODE_TYPES.TemplateLiteral);
const isJestFunctionWithLiteralArg = (
node: TSESTree.CallExpression,
): node is CallExpressionWithCorrectCalleeAndArguments =>
(isTestCase(node) || isDescribe(node)) &&
node.callee.type === AST_NODE_TYPES.Identifier &&
hasStringAsFirstArgument(node);
const testDescription = (argument: ArgumentLiteral): string | null => {
if (argument.type === AST_NODE_TYPES.Literal) {
const { value } = argument;
if (typeof value === 'string') {
return value;
}
return null;
}
return argument.quasis[0].value.raw;
};
const jestFunctionName = (
node: CallExpressionWithCorrectCalleeAndArguments,
allowedPrefixes: readonly string[],
) => {
const description = testDescription(node.arguments[0]);
if (
description === null ||
allowedPrefixes.some(name => description.startsWith(name))
) {
return null;
}
const firstCharacter = description.charAt(0);
if (!firstCharacter) {
return null;
}
if (firstCharacter !== firstCharacter.toLowerCase()) {
return node.callee.name;
}
return null;
};
export default createRule<
[
Partial<{
ignore: readonly JestFunctionName[];
allowedPrefixes: readonly string[];
}>,
],
'unexpectedLowercase'
>({
name: __filename,
meta: {
type: 'suggestion',
docs: {
description:
'Enforce `it`, `test` and `describe` to have descriptions that begin with a lowercase letter. This provides more readable test failures.',
category: 'Best Practices',
recommended: false,
},
fixable: 'code',
messages: {
unexpectedLowercase: '`{{ method }}`s should begin with lowercase',
},
schema: [
{
type: 'object',
properties: {
ignore: {
type: 'array',
items: { enum: ['describe', 'test', 'it'] },
additionalItems: false,
},
allowedPrefixes: {
type: 'array',
items: { type: 'string' },
additionalItems: false,
},
},
additionalProperties: false,
},
],
} as const,
defaultOptions: [{ ignore: [], allowedPrefixes: [] }],
create(context, [{ ignore = [], allowedPrefixes = [] }]) {
return {
CallExpression(node) {
if (!isJestFunctionWithLiteralArg(node)) {
return;
}
const erroneousMethod = jestFunctionName(node, allowedPrefixes);
if (erroneousMethod && !ignore.includes(node.callee.name)) {
context.report({
messageId: 'unexpectedLowercase',
data: { method: erroneousMethod },
node,
fix(fixer) {
const [firstArg] = node.arguments;
// guaranteed by jestFunctionName
const description = testDescription(firstArg)!;
const rangeIgnoringQuotes: TSESLint.AST.Range = [
firstArg.range[0] + 1,
firstArg.range[1] - 1,
];
const newDescription =
description.substring(0, 1).toLowerCase() +
description.substring(1);
return [
fixer.replaceTextRange(rangeIgnoringQuotes, newDescription),
];
},
});
}
},
};
},
});