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.

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

fix(valid-describe): support using each with modifiers #820

Merged
merged 1 commit into from Apr 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 16 additions & 10 deletions src/rules/__tests__/valid-describe.test.ts
Expand Up @@ -12,11 +12,6 @@ const ruleTester = new TSESLint.RuleTester({

ruleTester.run('valid-describe', rule, {
valid: [
'describe["each"]()()',
'describe["each"](() => {})()',
'describe["each"](() => {})("foo")',
'describe["each"]()(() => {})',
'describe["each"]("foo")(() => {})',
'describe.each([1, 2, 3])("%s", (a, b) => {});',
'describe("foo", function() {})',
'describe("foo", () => {})',
Expand Down Expand Up @@ -51,18 +46,21 @@ ruleTester.run('valid-describe', rule, {
}
`,
dedent`
describe.each\`
something | other
${1} | ${2} |
\`
("$something", ({ something, other }) => { });
describe.each\`
foo | foe
${1} | ${2}
\`('$something', ({ foo, foe }) => {});
`,
],
invalid: [
{
code: 'describe.each()()',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 1 }],
},
{
code: 'describe["each"]()()',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 1 }],
},
{
code: 'describe.each(() => {})()',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 1 }],
Expand All @@ -75,10 +73,18 @@ ruleTester.run('valid-describe', rule, {
code: 'describe.each()(() => {})',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 17 }],
},
{
code: 'describe["each"]()(() => {})',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 20 }],
},
{
code: 'describe.each("foo")(() => {})',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 22 }],
},
{
code: 'describe.only.each("foo")(() => {})',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 27 }],
},
{
code: 'describe(() => {})',
errors: [{ messageId: 'nameAndCallback', line: 1, column: 10 }],
Expand Down
15 changes: 0 additions & 15 deletions src/rules/utils.ts
Expand Up @@ -763,21 +763,6 @@ export const isDescribeCall = (
return false;
};

export const isDescribe = (
node: TSESTree.CallExpression,
): node is JestFunctionCallExpression<DescribeAlias> =>
(node.callee.type === AST_NODE_TYPES.Identifier &&
DescribeAlias.hasOwnProperty(node.callee.name)) ||
(node.callee.type === AST_NODE_TYPES.MemberExpression &&
node.callee.object.type === AST_NODE_TYPES.Identifier &&
DescribeAlias.hasOwnProperty(node.callee.object.name) &&
node.callee.property.type === AST_NODE_TYPES.Identifier &&
DescribeProperty.hasOwnProperty(node.callee.property.name)) ||
(node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression &&
node.callee.tag.type === AST_NODE_TYPES.MemberExpression &&
node.callee.tag.object.type === AST_NODE_TYPES.Identifier &&
DescribeAlias.hasOwnProperty(node.callee.tag.object.name));

/**
* Checks if the given node` is a call to `<describe|test|it>.each(...)()`.
* If `true`, the code must look like `<method>.each(...)()`.
Expand Down
4 changes: 2 additions & 2 deletions src/rules/valid-describe.ts
Expand Up @@ -5,7 +5,7 @@ import {
import {
createRule,
getJestFunctionArguments,
isDescribe,
isDescribeCall,
isEachCall,
isFunction,
} from './utils';
Expand Down Expand Up @@ -46,7 +46,7 @@ export default createRule({
return {
CallExpression(node) {
if (
!isDescribe(node) ||
!isDescribeCall(node) ||
node.callee.type === AST_NODE_TYPES.TaggedTemplateExpression
) {
return;
Expand Down