feat: check if no-side-effects-wait-for is called inside tests

lib/rules/no-side-effects-wait-for.ts

@@ -2,9 +2,9 @@ import { ESLintUtils, TSESTree } from '@typescript-eslint/experimental-utils'
 import { getDocsUrl } from '../utils'
 import { isBlockStatement, findClosestCallNode, isMemberExpression, isCallExpression, isIdentifier } from '../node-utils'
 
-export const RULE_NAME: string = 'no-side-effects-wait-for';
+export const RULE_NAME = 'no-side-effects-wait-for';
 
-const WAIT_EXPRESSION_QUERY: string =
+const WAIT_EXPRESSION_QUERY =
  'CallExpression[callee.name=/^(waitFor)$/]';
 
 const SIDE_EFFECTS: Array<string> = ['fireEvent', 'userEvent']
@@ -30,6 +30,8 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
  },
  defaultOptions: [],
  create: function(context) {
+ let isImportingTestingLibrary = false;
+
  function reportSideEffects(
  node: TSESTree.BlockStatement
  ) {
@@ -48,7 +50,7 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
  }
  })
 
- if (isBlockStatement(node) && hasSideEffects(node.body)) {
+ if (isImportingTestingLibrary && isBlockStatement(node) && hasSideEffects(node.body)) {
  context.report({
  node,
  loc: node.loc.start,
@@ -60,6 +62,9 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
  return {
  [`${WAIT_EXPRESSION_QUERY} > ArrowFunctionExpression > BlockStatement`]: reportSideEffects,
  [`${WAIT_EXPRESSION_QUERY} > FunctionExpression > BlockStatement`]: reportSideEffects,
+ ImportDeclaration(node: TSESTree.ImportDeclaration) {
+ isImportingTestingLibrary = /testing-library/g.test(node.source.value as string);
+ }
  };
  }
 })

tests/lib/rules/no-side-effects-wait-for.test.ts

@@ -11,18 +11,21 @@ ruleTester.run(RULE_NAME, rule, {
  valid: [
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => expect(a).toEqual('a'))
  `,
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  expect(a).toEqual('a')
  })
  `,
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  console.log('testing-library')
  expect(b).toEqual('b')
@@ -31,6 +34,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  console.log('testing-library')
  expect(b).toEqual('b')
@@ -39,37 +43,43 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {})
  `,
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {})
  `,
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  // testing
  })
  `,
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  // testing
  })
  `,
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  fireEvent.keyDown(input, {key: 'ArrowDown'})
  await waitFor(() => {
  expect(b).toEqual('b')
  })
  `
  }, {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  fireEvent.keyDown(input, {key: 'ArrowDown'})
  await waitFor(function() {
  expect(b).toEqual('b')
@@ -81,6 +91,7 @@ ruleTester.run(RULE_NAME, rule, {
  // fireEvent
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  fireEvent.keyDown(input, {key: 'ArrowDown'})
  })
@@ -89,6 +100,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  expect(b).toEqual('b')
  fireEvent.keyDown(input, {key: 'ArrowDown'})
@@ -98,6 +110,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  fireEvent.keyDown(input, {key: 'ArrowDown'})
  expect(b).toEqual('b')
@@ -107,6 +120,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  fireEvent.keyDown(input, {key: 'ArrowDown'})
  })
@@ -115,6 +129,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  expect(b).toEqual('b')
  fireEvent.keyDown(input, {key: 'ArrowDown'})
@@ -124,6 +139,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  fireEvent.keyDown(input, {key: 'ArrowDown'})
  expect(b).toEqual('b')
@@ -134,6 +150,7 @@ ruleTester.run(RULE_NAME, rule, {
  // userEvent
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  userEvent.keyDown(input, {key: 'ArrowDown'})
  })
@@ -142,6 +159,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  expect(b).toEqual('b')
  userEvent.keyDown(input, {key: 'ArrowDown'})
@@ -151,6 +169,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(() => {
  userEvent.keyDown(input, {key: 'ArrowDown'})
  expect(b).toEqual('b')
@@ -160,6 +179,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  userEvent.keyDown(input, {key: 'ArrowDown'})
  })
@@ -168,6 +188,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  expect(b).toEqual('b')
  userEvent.keyDown(input, {key: 'ArrowDown'})
@@ -177,6 +198,7 @@ ruleTester.run(RULE_NAME, rule, {
  },
  {
  code: `
+ import { waitFor } from '@testing-library/react'; 
  await waitFor(function() {
  userEvent.keyDown(input, {key: 'ArrowDown'})
  expect(b).toEqual('b')