refactor(consistent-data-testid): use createTestingLibraryRule

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

@@ -3,6 +3,7 @@ import {
   TSESLint,
   TSESTree,
 } from '@typescript-eslint/experimental-utils';
+
 import {
   getAssertNodeInfo,
   getDeepestIdentifierNode,
@@ -19,13 +20,13 @@ import {
   isMemberExpression,
   isObjectPattern,
   isProperty,
-} from './node-utils';
+} from '../node-utils';
 import {
   ABSENCE_MATCHERS,
   ALL_QUERIES_COMBINATIONS,
   ASYNC_UTILS,
   PRESENCE_MATCHERS,
-} from './utils';
+} from '../utils';
 
 const SETTING_OPTION_OFF = 'off' as const;
 
@@ -123,14 +124,28 @@ const FIRE_EVENT_NAME = 'fireEvent';
 const USER_EVENT_NAME = 'userEvent';
 const RENDER_NAME = 'render';
 
+export type DetectionOptions = {
+  /**
+   * If true, force `detectTestingLibraryUtils` to skip `canReportErrors`
+   * so it doesn't opt-out rule listener.
+   *
+   * Useful when some rule apply to files other than testing ones
+   * (e.g. `consistent-data-testid`)
+   */
+  skipRuleReportingCheck: boolean;
+};
+
 /**
  * Enhances a given rule `create` with helpers to detect Testing Library utils.
  */
 export function detectTestingLibraryUtils<
   TOptions extends readonly unknown[],
   TMessageIds extends string,
   TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener
->(ruleCreate: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>) {
+>(
+  ruleCreate: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>,
+  { skipRuleReportingCheck = false }: Partial<DetectionOptions> = {}
+) {
   return (
     context: TestingLibraryContext<TOptions, TMessageIds>,
     optionsWithDefault: Readonly<TOptions>
@@ -742,7 +757,7 @@ export function detectTestingLibraryUtils<
      * Determines if file inspected meets all conditions to be reported by rules or not.
      */
     const canReportErrors: CanReportErrorsFn = () => {
-      return isTestingLibraryImported();
+      return skipRuleReportingCheck || isTestingLibraryImported();
     };
 
     /**

lib/create-testing-library-rule.ts → lib/create-testing-library-rule/index.ts

@@ -1,6 +1,9 @@
 import { ESLintUtils, TSESLint } from '@typescript-eslint/experimental-utils';
-import { getDocsUrl } from './utils';
+
+import { getDocsUrl } from '../utils';
+
 import {
+  DetectionOptions,
   detectTestingLibraryUtils,
   EnhancedRuleCreate,
 } from './detect-testing-library-utils';
@@ -15,20 +18,22 @@ export function createTestingLibraryRule<
   TOptions extends readonly unknown[],
   TMessageIds extends string,
   TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener
->(
-  config: Readonly<{
-    name: string;
-    meta: CreateRuleMeta<TMessageIds>;
-    defaultOptions: Readonly<TOptions>;
-    create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
-  }>
-): TSESLint.RuleModule<TMessageIds, TOptions> {
-  const { create, ...remainingConfig } = config;
-
+>({
+  create,
+  detectionOptions = {},
+  ...remainingConfig
+}: Readonly<{
+  name: string;
+  meta: CreateRuleMeta<TMessageIds>;
+  defaultOptions: Readonly<TOptions>;
+  detectionOptions?: Partial<DetectionOptions>;
+  create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
+}>): TSESLint.RuleModule<TMessageIds, TOptions> {
   return ESLintUtils.RuleCreator(getDocsUrl)({
     ...remainingConfig,
     create: detectTestingLibraryUtils<TOptions, TMessageIds, TRuleListener>(
-      create
+      create,
+      detectionOptions
     ),
   });
 }

lib/rules/consistent-data-testid.ts

@@ -1,10 +1,9 @@
-import { getDocsUrl } from '../utils';
-import { ESLintUtils } from '@typescript-eslint/experimental-utils';
+import { createTestingLibraryRule } from '../create-testing-library-rule';
 import { isJSXAttribute, isLiteral } from '../node-utils';
 
 export const RULE_NAME = 'consistent-data-testid';
 export type MessageIds = 'consistentDataTestId';
-type Options = [
+export type Options = [
   {
     testIdAttribute?: string | string[];
     testIdPattern: string;
@@ -13,12 +12,7 @@ type Options = [
 
 const FILENAME_PLACEHOLDER = '{fileName}';
 
-/**
- * This rule is not created with `createTestingLibraryRule` since:
- * - it doesn't need any detection helper
- * - it doesn't apply to testing files but component files
- */
-export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
+export default createTestingLibraryRule<Options, MessageIds>({
   name: RULE_NAME,
   meta: {
     type: 'suggestion',
@@ -64,8 +58,11 @@ export default ESLintUtils.RuleCreator(getDocsUrl)<Options, MessageIds>({
       testIdAttribute: 'data-testid',
     },
   ],
+  detectionOptions: {
+    skipRuleReportingCheck: true,
+  },
 
-  create(context, [options]) {
+  create: (context, [options]) => {
     const { getFilename } = context;
     const { testIdPattern, testIdAttribute: attr } = options;