Skip to content

Commit f20934f

Browse files
G-RathG-Rath
committed
fix(prefer-expect-assertions): support .each
Fixes #676
1 parent e6b8c77 commit f20934f

File tree

5 files changed

+212
-21
lines changed

5 files changed

+212
-21
lines changed

Diff for: ‎src/rules/__tests__/lowercase-name.test.ts

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ const ruleTester = new TSESLint.RuleTester({
1414
ruleTester.run('lowercase-name', rule, {
1515
valid: [
1616
'it.each()',
17+
'it.each()(1)',
1718
'randomFunction()',
1819
'foo.bar()',
1920
'it()',

Diff for: ‎src/rules/__tests__/prefer-expect-assertions.test.ts

+181
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const ruleTester = new TSESLint.RuleTester({
1212

1313
ruleTester.run('prefer-expect-assertions', rule, {
1414
valid: [
15+
'test("nonsense", [])',
1516
'test("it1", () => {expect.assertions(0);})',
1617
'test("it1", function() {expect.assertions(0);})',
1718
'test("it1", function() {expect.hasAssertions();})',
@@ -259,3 +260,183 @@ ruleTester.run('prefer-expect-assertions', rule, {
259260
},
260261
],
261262
});
263+
264+
ruleTester.run('.each support', rule, {
265+
valid: [
266+
'test.each()("is fine", () => { expect.assertions(0); })',
267+
'test.each``("is fine", () => { expect.assertions(0); })',
268+
'test.each()("is fine", () => { expect.hasAssertions(); })',
269+
'test.each``("is fine", () => { expect.hasAssertions(); })',
270+
'it.each()("is fine", () => { expect.assertions(0); })',
271+
'it.each``("is fine", () => { expect.assertions(0); })',
272+
'it.each()("is fine", () => { expect.hasAssertions(); })',
273+
'it.each``("is fine", () => { expect.hasAssertions(); })',
274+
{
275+
code: 'test.each()("is fine", () => {})',
276+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
277+
},
278+
{
279+
code: 'test.each``("is fine", () => {})',
280+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
281+
},
282+
{
283+
code: 'it.each()("is fine", () => {})',
284+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
285+
},
286+
{
287+
code: 'it.each``("is fine", () => {})',
288+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
289+
},
290+
dedent`
291+
describe.each(['hello'])('%s', () => {
292+
it('is fine', () => {
293+
expect.assertions(0);
294+
});
295+
});
296+
`,
297+
dedent`
298+
describe.each\`\`('%s', () => {
299+
it('is fine', () => {
300+
expect.assertions(0);
301+
});
302+
});
303+
`,
304+
dedent`
305+
describe.each(['hello'])('%s', () => {
306+
it('is fine', () => {
307+
expect.hasAssertions();
308+
});
309+
});
310+
`,
311+
dedent`
312+
describe.each\`\`('%s', () => {
313+
it('is fine', () => {
314+
expect.hasAssertions();
315+
});
316+
});
317+
`,
318+
dedent`
319+
describe.each(['hello'])('%s', () => {
320+
it.each()('is fine', () => {
321+
expect.assertions(0);
322+
});
323+
});
324+
`,
325+
dedent`
326+
describe.each\`\`('%s', () => {
327+
it.each()('is fine', () => {
328+
expect.assertions(0);
329+
});
330+
});
331+
`,
332+
dedent`
333+
describe.each(['hello'])('%s', () => {
334+
it.each()('is fine', () => {
335+
expect.hasAssertions();
336+
});
337+
});
338+
`,
339+
dedent`
340+
describe.each\`\`('%s', () => {
341+
it.each()('is fine', () => {
342+
expect.hasAssertions();
343+
});
344+
});
345+
`,
346+
],
347+
invalid: [
348+
{
349+
code: dedent`
350+
test.each()("is not fine", () => {
351+
expect(someValue).toBe(true);
352+
});
353+
`,
354+
errors: [
355+
{
356+
messageId: 'haveExpectAssertions',
357+
column: 1,
358+
line: 1,
359+
},
360+
],
361+
},
362+
{
363+
code: dedent`
364+
describe.each()('something', () => {
365+
it("is not fine", () => {
366+
expect(someValue).toBe(true);
367+
});
368+
});
369+
`,
370+
errors: [
371+
{
372+
messageId: 'haveExpectAssertions',
373+
column: 3,
374+
line: 2,
375+
},
376+
],
377+
},
378+
{
379+
code: dedent`
380+
describe.each()('something', () => {
381+
test.each()("is not fine", () => {
382+
expect(someValue).toBe(true);
383+
});
384+
});
385+
`,
386+
errors: [
387+
{
388+
messageId: 'haveExpectAssertions',
389+
column: 3,
390+
line: 2,
391+
},
392+
],
393+
},
394+
{
395+
code: dedent`
396+
test.each()("is not fine", async () => {
397+
expect(someValue).toBe(true);
398+
});
399+
`,
400+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
401+
errors: [
402+
{
403+
messageId: 'haveExpectAssertions',
404+
column: 1,
405+
line: 1,
406+
},
407+
],
408+
},
409+
{
410+
code: dedent`
411+
it.each()("is not fine", async () => {
412+
expect(someValue).toBe(true);
413+
});
414+
`,
415+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
416+
errors: [
417+
{
418+
messageId: 'haveExpectAssertions',
419+
column: 1,
420+
line: 1,
421+
},
422+
],
423+
},
424+
{
425+
code: dedent`
426+
describe.each()('something', () => {
427+
test.each()("is not fine", async () => {
428+
expect(someValue).toBe(true);
429+
});
430+
});
431+
`,
432+
options: [{ onlyFunctionsWithAsyncKeyword: true }],
433+
errors: [
434+
{
435+
messageId: 'haveExpectAssertions',
436+
column: 3,
437+
line: 2,
438+
},
439+
],
440+
},
441+
],
442+
});

Diff for: ‎src/rules/lowercase-name.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ const findNodeNameAndArgument = (
3535

3636
if (isEachCall(node)) {
3737
if (
38-
node.parent?.type === AST_NODE_TYPES.CallExpression &&
39-
hasStringAsFirstArgument(node.parent)
38+
node.parent.arguments.length > 0 &&
39+
isStringNode(node.parent.arguments[0])
4040
) {
4141
return [node.callee.object.name, node.parent.arguments[0]];
4242
}

Diff for: ‎src/rules/prefer-expect-assertions.ts

+23-15
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ import {
88
createRule,
99
getAccessorValue,
1010
hasOnlyOneArgument,
11+
isEachCall,
12+
isFunction,
1113
isSupportedAccessor,
14+
isTestCase,
1215
} from './utils';
1316

1417
const isExpectAssertionsOrHasAssertionsCall = (
@@ -40,12 +43,6 @@ const suggestRemovingExtraArguments = (
4043
]),
4144
});
4245

43-
interface PreferExpectAssertionsCallExpression extends TSESTree.CallExpression {
44-
arguments: [
45-
TSESTree.Expression,
46-
TSESTree.ArrowFunctionExpression & { body: TSESTree.BlockStatement },
47-
];
48-
}
4946
interface RuleOptions {
5047
onlyFunctionsWithAsyncKeyword?: boolean;
5148
}
@@ -103,14 +100,28 @@ export default createRule<[RuleOptions], MessageIds>({
103100
defaultOptions: [{ onlyFunctionsWithAsyncKeyword: false }],
104101
create(context, [options]) {
105102
return {
106-
'CallExpression[callee.name=/^(it|test)$/][arguments.1.body.body]'(
107-
node: PreferExpectAssertionsCallExpression,
108-
) {
109-
if (options.onlyFunctionsWithAsyncKeyword && !node.arguments[1].async) {
103+
CallExpression(node: TSESTree.CallExpression) {
104+
if (!isTestCase(node)) {
105+
return;
106+
}
107+
108+
const args = isEachCall(node) ? node.parent.arguments : node.arguments;
109+
110+
if (args.length < 2) {
111+
return;
112+
}
113+
114+
const [, testFn] = args;
115+
116+
if (
117+
!isFunction(testFn) ||
118+
testFn.body.type !== AST_NODE_TYPES.BlockStatement ||
119+
(options.onlyFunctionsWithAsyncKeyword && !testFn.async)
120+
) {
110121
return;
111122
}
112123

113-
const testFuncBody = node.arguments[1].body.body;
124+
const testFuncBody = testFn.body.body;
114125

115126
if (!isFirstLineExprStmt(testFuncBody)) {
116127
context.report({
@@ -120,10 +131,7 @@ export default createRule<[RuleOptions], MessageIds>({
120131
messageId,
121132
fix: fixer =>
122133
fixer.insertTextBeforeRange(
123-
[
124-
node.arguments[1].body.range[0] + 1,
125-
node.arguments[1].body.range[1],
126-
],
134+
[testFn.body.range[0] + 1, testFn.body.range[1]],
127135
text,
128136
),
129137
})),

Diff for: ‎src/rules/utils.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -692,19 +692,20 @@ export const isDescribe = (
692692
DescribeAlias.hasOwnProperty(node.callee.tag.object.name));
693693

694694
/**
695-
* Checks if the given node` is a call to `<describe|test|it>.each(...)`.
696-
* If `true`, the code must look like `<method>.each(...)`.
695+
* Checks if the given node` is a call to `<describe|test|it>.each(...)()`.
696+
* If `true`, the code must look like `<method>.each(...)()`.
697697
*
698698
* @param {JestFunctionCallExpression<DescribeAlias | TestCaseName>} node
699699
*
700-
* @return {node is JestFunctionCallExpressionWithMemberExpressionCallee<DescribeAlias | TestCaseName, DescribeProperty.each | TestCaseProperty.each>}
700+
* @return {node is JestFunctionCallExpressionWithMemberExpressionCallee<DescribeAlias | TestCaseName, DescribeProperty.each | TestCaseProperty.each> & {parent: TSESTree.CallExpression}}
701701
*/
702702
export const isEachCall = (
703703
node: JestFunctionCallExpression<DescribeAlias | TestCaseName>,
704704
): node is JestFunctionCallExpressionWithMemberExpressionCallee<
705705
DescribeAlias | TestCaseName,
706706
DescribeProperty.each | TestCaseProperty.each
707-
> =>
707+
> & { parent: TSESTree.CallExpression } =>
708+
node.parent?.type === AST_NODE_TYPES.CallExpression &&
708709
node.callee.type === AST_NODE_TYPES.MemberExpression &&
709710
isSupportedAccessor(node.callee.property, DescribeProperty.each);
710711

0 commit comments

Comments
 (0)