refactor: merge isDebugUtil & isOneOfDebugUtils utils

Author: G-Rath

lib/create-testing-library-rule/detect-testing-library-utils.ts

@@ -25,6 +25,7 @@ import {
   ABSENCE_MATCHERS,
   ALL_QUERIES_COMBINATIONS,
   ASYNC_UTILS,
+  DEBUG_UTILS,
   PRESENCE_MATCHERS,
 } from '../utils';
 
@@ -79,10 +80,9 @@ type IsRenderUtilFn = (node: TSESTree.Identifier) => boolean;
 type IsRenderVariableDeclaratorFn = (
   node: TSESTree.VariableDeclarator
 ) => boolean;
-type IsDebugUtilFn = (identifierNode: TSESTree.Identifier) => boolean;
-type IsOneOfDebugUtils = (
+type IsDebugUtilFn = (
   identifierNode: TSESTree.Identifier,
-  names: string[]
+  validNames?: ReadonlyArray<typeof DEBUG_UTILS[number]>
 ) => boolean;
 type IsPresenceAssertFn = (node: TSESTree.MemberExpression) => boolean;
 type IsAbsenceAssertFn = (node: TSESTree.MemberExpression) => boolean;
@@ -116,7 +116,6 @@ export interface DetectionHelpers {
   isRenderUtil: IsRenderUtilFn;
   isRenderVariableDeclarator: IsRenderVariableDeclaratorFn;
   isDebugUtil: IsDebugUtilFn;
-  isOneOfDebugUtils: IsOneOfDebugUtils;
   isPresenceAssert: IsPresenceAssertFn;
   isAbsenceAssert: IsAbsenceAssertFn;
   canReportErrors: CanReportErrorsFn;
@@ -600,9 +599,9 @@ export function detectTestingLibraryUtils<
       return isRenderUtil(initIdentifierNode);
     };
 
-    const isOneOfDebugUtils: IsOneOfDebugUtils = (
+    const isDebugUtil: IsDebugUtilFn = (
       identifierNode,
-      names: string[]
+      validNames = DEBUG_UTILS
     ) => {
       const isBuiltInConsole =
         isMemberExpression(identifierNode.parent) &&
@@ -614,26 +613,11 @@ export function detectTestingLibraryUtils<
         isTestingLibraryUtil(
           identifierNode,
           (identifierNodeName, originalNodeName) => {
-            return names.includes(originalNodeName || identifierNodeName);
-          }
-        )
-      );
-    };
-
-    const isDebugUtil: IsDebugUtilFn = (identifierNode) => {
-      const isBuiltInConsole =
-        isMemberExpression(identifierNode.parent) &&
-        ASTUtils.isIdentifier(identifierNode.parent.object) &&
-        identifierNode.parent.object.name === 'console';
-
-      return (
-        !isBuiltInConsole &&
-        isTestingLibraryUtil(
-          identifierNode,
-          (identifierNodeName, originalNodeName) => {
-            return [identifierNodeName, originalNodeName]
-              .filter(Boolean)
-              .includes('debug');
+            return (
+              (validNames as string[]).includes(identifierNodeName) ||
+              (!!originalNodeName &&
+                (validNames as string[]).includes(originalNodeName))
+            );
           }
         )
       );
@@ -832,7 +816,6 @@ export function detectTestingLibraryUtils<
       isRenderUtil,
       isRenderVariableDeclarator,
       isDebugUtil,
-      isOneOfDebugUtils,
       isPresenceAssert,
       isAbsenceAssert,
       canReportErrors,

lib/rules/no-debug.ts

@@ -8,12 +8,13 @@ import {
   isObjectPattern,
   isProperty,
 } from '../node-utils';
+import { DEBUG_UTILS } from '../utils';
 import { createTestingLibraryRule } from '../create-testing-library-rule';
 import { ASTUtils, TSESTree } from '@typescript-eslint/experimental-utils';
 
 export const RULE_NAME = 'no-debug';
 export type MessageIds = 'noDebug';
-type Options = [{ utilNames: Array<'debug' | 'logTestingPlaygroundURL'> }];
+type Options = [{ utilNames: Array<typeof DEBUG_UTILS[number]> }];
 
 export default createTestingLibraryRule<Options, MessageIds>({
   name: RULE_NAME,
@@ -40,7 +41,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
             type: 'array',
             items: {
               type: 'string',
-              enum: ['debug', 'logTestingPlaygroundURL'],
+              enum: DEBUG_UTILS,
             },
           },
         },
@@ -133,7 +134,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
           return;
         }
 
-        const isDebugUtil = helpers.isOneOfDebugUtils(
+        const isDebugUtil = helpers.isDebugUtil(
           callExpressionIdentifier,
           utilNames
         );

lib/utils/index.ts

@@ -66,6 +66,11 @@ const ASYNC_UTILS = [
   'waitForDomChange',
 ] as const;
 
+const DEBUG_UTILS = [
+  'debug', //
+  'logTestingPlaygroundURL',
+] as const;
+
 const EVENTS_SIMULATORS = ['fireEvent', 'userEvent'] as const;
 
 const TESTING_FRAMEWORK_SETUP_HOOKS = ['beforeEach', 'beforeAll'];
@@ -119,6 +124,7 @@ export {
   ASYNC_QUERIES_COMBINATIONS,
   ALL_QUERIES_COMBINATIONS,
   ASYNC_UTILS,
+  DEBUG_UTILS,
   EVENTS_SIMULATORS,
   TESTING_FRAMEWORK_SETUP_HOOKS,
   LIBRARY_MODULES,