refactor(prefer-screen-queries): detect render methods with helper

Author: Belco90

lib/rules/prefer-screen-queries.ts

@@ -50,7 +50,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
   },
   defaultOptions: [],
 
-  create(context) {
+  create(context, _, helpers) {
     function reportInvalidUsage(node: TSESTree.Identifier) {
       context.report({
         node,
@@ -75,9 +75,8 @@ export default createTestingLibraryRule<Options, MessageIds>({
           return;
         }
         const isWithinFunction = node.init.callee.name === 'within';
-        // TODO add the custom render option #198
         const usesRenderOptions =
-          node.init.callee.name === 'render' &&
+          helpers.isRenderUtil(node.init.callee) &&
           usesContainerOrBaseElement(node.init);
 
         if (!isWithinFunction && !usesRenderOptions) {
@@ -130,7 +129,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
           isCallExpression(node.parent.object) &&
           ASTUtils.isIdentifier(node.parent.object.callee) &&
           node.parent.object.callee.name !== 'within' &&
-          node.parent.object.callee.name === 'render' &&
+          helpers.isRenderUtil(node.parent.object.callee) &&
           !usesContainerOrBaseElement(node.parent.object)
         ) {
           reportInvalidUsage(node);

tests/lib/rules/prefer-screen-queries.test.ts

@@ -127,6 +127,15 @@ ruleTester.run(RULE_NAME, rule, {
         render(foo, { baseElement: treeA }).${queryMethod}()
       `,
     })),
+    // ...ALL_QUERIES_COMBINATIONS.map((queryMethod) => ({
+    //   settings: {
+    //     'testing-library/custom-renders': ['customRender'],
+    //   },
+    //   code: `
+    //     import { anotherRender } from 'whatever'
+    //     const { ${queryMethod} } = anotherRender(foo)
+    //     ${queryMethod}()`,
+    // })),
   ],
 
   invalid: [
@@ -143,6 +152,77 @@ ruleTester.run(RULE_NAME, rule, {
         },
       ],
     })),
+    ...ALL_QUERIES_COMBINATIONS.map((queryMethod) => ({
+      settings: { 'testing-library/utils-module': 'test-utils' },
+      code: `
+        import { render } from 'test-utils'
+        const { ${queryMethod} } = render(foo)
+        ${queryMethod}()`,
+      errors: [
+        {
+          line: 4,
+          column: 9,
+          messageId: 'preferScreenQueries',
+          data: {
+            name: queryMethod,
+          },
+        },
+      ],
+    })),
+
+    ...ALL_QUERIES_COMBINATIONS.map((queryMethod) => ({
+      settings: {
+        'testing-library/custom-renders': ['customRender'],
+      },
+      code: `
+        import { customRender } from 'whatever'
+        const { ${queryMethod} } = customRender(foo)
+        ${queryMethod}()`,
+      errors: [
+        {
+          line: 4,
+          column: 9,
+          messageId: 'preferScreenQueries',
+          data: {
+            name: queryMethod,
+          },
+        },
+      ],
+    })),
+    ...ALL_QUERIES_COMBINATIONS.map((queryMethod) => ({
+      settings: { 'testing-library/utils-module': 'test-utils' },
+      code: `
+        import { render as testingLibraryRender} from '@testing-library/react'
+        const { ${queryMethod} } = testingLibraryRender(foo)
+        ${queryMethod}()`,
+      errors: [
+        {
+          line: 4,
+          column: 9,
+          messageId: 'preferScreenQueries',
+          data: {
+            name: queryMethod,
+          },
+        },
+      ],
+    })),
+    ...ALL_QUERIES_COMBINATIONS.map((queryMethod) => ({
+      settings: { 'testing-library/utils-module': 'test-utils' },
+      code: `
+        import { render } from 'test-utils'
+        const { ${queryMethod} } = render(foo)
+        ${queryMethod}()`,
+      errors: [
+        {
+          line: 4,
+          column: 9,
+          messageId: 'preferScreenQueries',
+          data: {
+            name: queryMethod,
+          },
+        },
+      ],
+    })),
     ...ALL_QUERIES_COMBINATIONS.map((queryMethod) => ({
       code: `render().${queryMethod}()`,
       errors: [