Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: improve support for it.each involving tagged template literals #701

Merged
merged 5 commits into from Nov 12, 2020
Merged

fix: improve support for it.each involving tagged template literals #701

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c8ce37a
fix(no-disabled-tests): fix bug with it.each
k-yle Oct 27, 2020
00d9b8d
fix(no-test-prefixes): fix bug with it.each
k-yle Oct 27, 2020
35684d5
fix(consistent-test-it): fix bug with it.each
k-yle Oct 28, 2020
e71a1e2
fix(no-standalone-expect): coverage back to 100%
k-yle Oct 28, 2020
e0c06d8
fix: code review changes
k-yle Nov 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
72 changes: 72 additions & 0 deletions src/rules/__tests__/consistent-test-it.test.ts
View file
Open in desktop
Expand Up @@ -32,6 +32,14 @@ ruleTester.run('consistent-test-it with fn=test', rule, {
code: 'xtest("foo")',
options: [{ fn: TestCaseName.test }],
},
{
code: 'test.each([])("foo")',
options: [{ fn: TestCaseName.test }],
},
{
code: 'test.each``("foo")',
options: [{ fn: TestCaseName.test }],
},
{
code: 'describe("suite", () => { test("foo") })',
options: [{ fn: TestCaseName.test }],
Expand Down Expand Up @@ -122,6 +130,34 @@ ruleTester.run('consistent-test-it with fn=test', rule, {
},
],
},
{
code: 'it.each([])("foo")',
output: 'test.each([])("foo")',
options: [{ fn: TestCaseName.test }],
errors: [
{
messageId: 'consistentMethod',
data: {
testKeyword: TestCaseName.test,
oppositeTestKeyword: TestCaseName.it,
},
},
],
},
{
code: 'it.each``("foo")',
output: 'test.each``("foo")',
options: [{ fn: TestCaseName.test }],
errors: [
{
messageId: 'consistentMethod',
data: {
testKeyword: TestCaseName.test,
oppositeTestKeyword: TestCaseName.it,
},
},
],
},
{
code: 'describe("suite", () => { it("foo") })',
output: 'describe("suite", () => { test("foo") })',
Expand Down Expand Up @@ -165,6 +201,14 @@ ruleTester.run('consistent-test-it with fn=it', rule, {
code: 'it.concurrent("foo")',
options: [{ fn: TestCaseName.it }],
},
{
code: 'it.each([])("foo")',
options: [{ fn: TestCaseName.it }],
},
{
code: 'it.each``("foo")',
options: [{ fn: TestCaseName.it }],
},
{
code: 'describe("suite", () => { it("foo") })',
options: [{ fn: TestCaseName.it }],
Expand Down Expand Up @@ -241,6 +285,34 @@ ruleTester.run('consistent-test-it with fn=it', rule, {
},
],
},
{
code: 'test.each([])("foo")',
output: 'it.each([])("foo")',
options: [{ fn: TestCaseName.it }],
errors: [
{
messageId: 'consistentMethod',
data: {
testKeyword: TestCaseName.it,
oppositeTestKeyword: TestCaseName.test,
},
},
],
},
{
code: 'test.each``("foo")',
output: 'it.each``("foo")',
options: [{ fn: TestCaseName.it }],
errors: [
{
messageId: 'consistentMethod',
data: {
testKeyword: TestCaseName.it,
oppositeTestKeyword: TestCaseName.test,
},
},
],
},
{
code: 'describe("suite", () => { test("foo") })',
output: 'describe("suite", () => { it("foo") })',
Expand Down
33 changes: 33 additions & 0 deletions src/rules/__tests__/no-disabled-tests.test.ts
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@ ruleTester.run('no-disabled-tests', rule, {
'it("foo", function () {})',
'describe.only("foo", function () {})',
'it.only("foo", function () {})',
'it.each("foo", () => {})',
'it.concurrent("foo", function () {})',
'test("foo", function () {})',
'test.only("foo", function () {})',
Expand Down Expand Up @@ -87,6 +88,22 @@ ruleTester.run('no-disabled-tests', rule, {
code: 'test.skip("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it.skip.each``("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test.skip.each``("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it.skip.each([])("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test.skip.each([])("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'test.concurrent.skip("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
Expand All @@ -107,6 +124,22 @@ ruleTester.run('no-disabled-tests', rule, {
code: 'xtest("foo", function () {})',
errors: [{ messageId: 'disabledTest', column: 1, line: 1 }],
},
{
code: 'xit.each``("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xtest.each``("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xit.each([])("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'xtest.each([])("foo", function () {})',
errors: [{ messageId: 'skippedTest', column: 1, line: 1 }],
},
{
code: 'it("has title but no callback")',
errors: [{ messageId: 'missingFunction', column: 1, line: 1 }],
Expand Down
4 changes: 4 additions & 0 deletions src/rules/__tests__/no-standalone-expect.test.ts
View file
Open in desktop
Expand Up @@ -57,6 +57,10 @@ ruleTester.run('no-standalone-expect', rule, {
},
],
invalid: [
{
code: `(() => {})('testing', () => expect(true))`,
k-yle marked this conversation as resolved.
Show resolved Hide resolved
errors: [{ endColumn: 41, column: 29, messageId: 'unexpectedExpect' }],
},
{
code: `
describe('scenario', () => {
Expand Down
60 changes: 60 additions & 0 deletions src/rules/__tests__/no-test-prefixes.test.ts
View file
Open in desktop
Expand Up @@ -12,8 +12,18 @@ ruleTester.run('no-test-prefixes', rule, {
'test.concurrent("foo", function () {})',
'describe.only("foo", function () {})',
'it.only("foo", function () {})',
'it.each()("foo", function () {})',
{
code: 'it.each``("foo", function () {})',
parserOptions: { ecmaVersion: 6 },
},
'it.concurrent.only("foo", function () {})',
'test.only("foo", function () {})',
'test.each()("foo", function () {})',
{
code: 'test.each``("foo", function () {})',
parserOptions: { ecmaVersion: 6 },
},
'test.concurrent.only("foo", function () {})',
'describe.skip("foo", function () {})',
'it.skip("foo", function () {})',
Expand Down Expand Up @@ -96,5 +106,55 @@ ruleTester.run('no-test-prefixes', rule, {
},
],
},
{
code: 'xit.each``("foo", function () {})',
output: 'it.skip.each``("foo", function () {})',
parserOptions: { ecmaVersion: 6 },
errors: [
{
messageId: 'usePreferredName',
data: { preferredNodeName: 'it.skip.each' },
column: 1,
line: 1,
},
],
},
{
code: 'xtest.each``("foo", function () {})',
output: 'test.skip.each``("foo", function () {})',
parserOptions: { ecmaVersion: 6 },
errors: [
{
messageId: 'usePreferredName',
data: { preferredNodeName: 'test.skip.each' },
column: 1,
line: 1,
},
],
},
{
code: 'xit.each([])("foo", function () {})',
output: 'it.skip.each([])("foo", function () {})',
errors: [
{
messageId: 'usePreferredName',
data: { preferredNodeName: 'it.skip.each' },
column: 1,
line: 1,
},
],
},
{
code: 'xtest.each([])("foo", function () {})',
output: 'test.skip.each([])("foo", function () {})',
errors: [
{
messageId: 'usePreferredName',
data: { preferredNodeName: 'test.skip.each' },
column: 1,
line: 1,
},
],
},
],
});
9 changes: 7 additions & 2 deletions src/rules/consistent-test-it.ts
View file
Open in desktop
Expand Up @@ -82,6 +82,11 @@ export default createRule<
describeNestingLevel++;
}

const funcNode =
node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression
? node.callee.tag
: node.callee;

if (
isTestCase(node) &&
describeNestingLevel === 0 &&
Expand All @@ -93,7 +98,7 @@ export default createRule<
messageId: 'consistentMethod',
node: node.callee,
data: { testKeyword, oppositeTestKeyword },
fix: buildFixer(node.callee, nodeName, testKeyword),
fix: buildFixer(funcNode, nodeName, testKeyword),
});
}

Expand All @@ -110,7 +115,7 @@ export default createRule<
messageId: 'consistentMethodWithinDescribe',
node: node.callee,
data: { testKeywordWithinDescribe, oppositeTestKeyword },
fix: buildFixer(node.callee, nodeName, testKeywordWithinDescribe),
fix: buildFixer(funcNode, nodeName, testKeywordWithinDescribe),
});
}
},
Expand Down
7 changes: 7 additions & 0 deletions src/rules/no-disabled-tests.ts
View file
Open in desktop
Expand Up @@ -39,6 +39,9 @@ export default createRule({
CallExpression(node) {
const functionName = getNodeName(node.callee);

// prevent duplicate warnings for it.each()()
if (node.callee.type === 'CallExpression') return;

switch (functionName) {
case 'describe.skip':
context.report({ messageId: 'skippedTestSuite', node });
Expand All @@ -48,6 +51,10 @@ export default createRule({
case 'it.concurrent.skip':
case 'test.skip':
case 'test.concurrent.skip':
case 'it.skip.each':
case 'test.skip.each':
case 'xit.each':
case 'xtest.each':
context.report({ messageId: 'skippedTest', node });
break;
}
Expand Down
14 changes: 11 additions & 3 deletions src/rules/no-test-prefixes.ts
View file
Open in desktop
@@ -1,3 +1,4 @@
import { AST_NODE_TYPES } from '@typescript-eslint/experimental-utils';
import { createRule, getNodeName, isDescribe, isTestCase } from './utils';

export default createRule({
Expand Down Expand Up @@ -27,12 +28,17 @@ export default createRule({

if (!preferredNodeName) return;

const funcNode =
node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression
? node.callee.tag
: node.callee;

context.report({
messageId: 'usePreferredName',
node: node.callee,
data: { preferredNodeName },
fix(fixer) {
return [fixer.replaceText(node.callee, preferredNodeName)];
return [fixer.replaceText(funcNode, preferredNodeName)];
},
});
},
Expand All @@ -43,12 +49,14 @@ export default createRule({
function getPreferredNodeName(nodeName: string) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: a good refactor for this could be to do split('.') - then you could just splice the only/skip in as element 1, and return .join('.').

I'm fine with this how it is, so that doesn't have to be done - just thinking of the future :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'll leave this one as-is

const firstChar = nodeName.charAt(0);

const suffix = nodeName.endsWith('.each') ? '.each' : '';

if (firstChar === 'f') {
return `${nodeName.slice(1)}.only`;
return `${nodeName.slice(1).replace('.each', '')}.only${suffix}`;
}

if (firstChar === 'x') {
return `${nodeName.slice(1)}.skip`;
return `${nodeName.slice(1).replace('.each', '')}.skip${suffix}`;
}

return null;
Expand Down
14 changes: 14 additions & 0 deletions src/rules/utils.ts
View file
Open in desktop
Expand Up @@ -580,10 +580,16 @@ export interface JestFunctionCallExpressionWithIdentifierCallee<
callee: JestFunctionIdentifier<FunctionName>;
}

export interface JestFunctionCallTaggedTemplateExpression
k-yle marked this conversation as resolved.
Show resolved Hide resolved
extends TSESTree.CallExpression {
callee: TSESTree.TaggedTemplateExpression;
}

export type JestFunctionCallExpression<
FunctionName extends JestFunctionName = JestFunctionName
> =
| JestFunctionCallExpressionWithMemberExpressionCallee<FunctionName>
| JestFunctionCallTaggedTemplateExpression
k-yle marked this conversation as resolved.
Show resolved Hide resolved
| JestFunctionCallExpressionWithIdentifierCallee<FunctionName>;

const joinNames = (a: string | null, b: string | null): string | null =>
Expand All @@ -592,6 +598,7 @@ const joinNames = (a: string | null, b: string | null): string | null =>
export function getNodeName(
node:
| JestFunctionMemberExpression<JestFunctionName>
| TSESTree.TaggedTemplateExpression
| JestFunctionIdentifier<JestFunctionName>,
k-yle marked this conversation as resolved.
Show resolved Hide resolved
): string;
export function getNodeName(node: TSESTree.Node): string | null;
Expand All @@ -601,6 +608,8 @@ export function getNodeName(node: TSESTree.Node): string | null {
}

switch (node.type) {
case AST_NODE_TYPES.TaggedTemplateExpression:
return getNodeName(node.tag);
case AST_NODE_TYPES.MemberExpression:
return joinNames(getNodeName(node.object), getNodeName(node.property));
case AST_NODE_TYPES.NewExpression:
Expand Down Expand Up @@ -651,6 +660,11 @@ export const isTestCase = (
): node is JestFunctionCallExpression<TestCaseName> =>
(node.callee.type === AST_NODE_TYPES.Identifier &&
TestCaseName.hasOwnProperty(node.callee.name)) ||
// e.g. it.each``()
(node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression &&
node.callee.tag.type === AST_NODE_TYPES.MemberExpression &&
isSupportedAccessor(node.callee.tag.property, TestCaseProperty.each)) ||
// e.g. it.concurrent.{skip,only}
(node.callee.type === AST_NODE_TYPES.MemberExpression &&
node.callee.property.type === AST_NODE_TYPES.Identifier &&
TestCaseProperty.hasOwnProperty(node.callee.property.name) &&
Expand Down