test: add custom rule tester for testing library

Author: Belco90

lib/detect-testing-library-utils.ts

@@ -76,7 +76,7 @@ export function detectTestingLibraryUtils<
       },
 
       /**
-       * Gets if file name being analyzed is valid or not.
+       * Gets if name of the file being analyzed is valid or not.
        *
        * This is based on "testing-library/file-name" setting.
        */

tests/create-testing-library-rule.test.ts

@@ -6,7 +6,6 @@ const ruleTester = createRuleTester();
 ruleTester.run(RULE_NAME, rule, {
   valid: [
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: nothing related to Testing Library at all
       import { shallow } from 'enzyme';
@@ -15,7 +14,6 @@ ruleTester.run(RULE_NAME, rule, {
       `,
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: render imported from other than custom module
       import { render } from '@somewhere/else'
@@ -27,7 +25,6 @@ ruleTester.run(RULE_NAME, rule, {
       },
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: prevent import which should trigger an error since it's imported
       // from other than custom module
@@ -38,7 +35,6 @@ ruleTester.run(RULE_NAME, rule, {
       },
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: import module forced to be reported but not matching file name
       import { foo } from 'report-me'
@@ -50,7 +46,6 @@ ruleTester.run(RULE_NAME, rule, {
   ],
   invalid: [
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: import module forced to be reported
       import { foo } from 'report-me'
@@ -77,7 +72,6 @@ ruleTester.run(RULE_NAME, rule, {
       errors: [{ line: 3, column: 7, messageId: 'fakeError' }],
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: render imported from any module by default (aggressive reporting)
       import { render } from '@somewhere/else'
@@ -94,7 +88,6 @@ ruleTester.run(RULE_NAME, rule, {
       ],
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: render imported from Testing Library module
       import { render } from '@testing-library/react'
@@ -111,7 +104,6 @@ ruleTester.run(RULE_NAME, rule, {
       ],
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: render imported from config custom module
       import { render } from 'test-utils'
@@ -131,7 +123,6 @@ ruleTester.run(RULE_NAME, rule, {
       ],
     },
     {
-      filename: 'MyComponent.test.js',
       code: `
       // case: render imported from Testing Library module if
       // custom module setup

tests/lib/test-utils.ts

@@ -1,18 +1,52 @@
 import { resolve } from 'path';
 import { TSESLint } from '@typescript-eslint/experimental-utils';
 
+// TODO: remove ecmaFeatures object from other tests files
+
+const DEFAULT_TEST_CASE_CONFIG = {
+  filename: 'MyComponent.test.js',
+};
+
+class TestingLibraryRuleTester extends TSESLint.RuleTester {
+  run<TMessageIds extends string, TOptions extends Readonly<unknown[]>>(
+    ruleName: string,
+    rule: TSESLint.RuleModule<TMessageIds, TOptions>,
+    tests: TSESLint.RunTests<TMessageIds, TOptions>
+  ): void {
+    const { valid, invalid } = tests;
+
+    const finalValid = valid.map((testCase) => {
+      if (typeof testCase === 'string') {
+        return {
+          ...DEFAULT_TEST_CASE_CONFIG,
+          code: testCase,
+        };
+      }
+
+      return { ...DEFAULT_TEST_CASE_CONFIG, ...testCase };
+    });
+    const finalInvalid = invalid.map((testCase) => ({
+      ...DEFAULT_TEST_CASE_CONFIG,
+      ...testCase,
+    }));
+
+    super.run(ruleName, rule, { valid: finalValid, invalid: finalInvalid });
+  }
+}
+
 export const createRuleTester = (
   parserOptions: Partial<TSESLint.ParserOptions> = {}
-): TSESLint.RuleTester =>
-  new TSESLint.RuleTester({
+): TSESLint.RuleTester => {
+  return new TestingLibraryRuleTester({
     parser: resolve('./node_modules/@typescript-eslint/parser'),
     parserOptions: {
       ecmaVersion: 2018,
       sourceType: 'module',
-      // TODO: we should deep merge here
+      // TODO: should we deep merge here?
       ecmaFeatures: {
         jsx: true,
       },
       ...parserOptions,
     },
   });
+};

tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es5",
+    "target": "es6",
     "module": "commonjs",
     "moduleResolution": "node",
     "esModuleInterop": true,