chore: migrate ESLint config (#385)

* chore: replace ESLint standard config by kentcdodds

* chore: auto fix new errors

* chore: fix new errors reported

* chore: forbid imports from @typescript-eslint/experimental-utils/dist

* chore: fix last errors related to imports

* chore: update prettier

* chore: bump eslint plugins

* chore: fix prettier version

* chore: bump eslint and eslint-config-kentcdodds

* chore: remove custom path groups for import/order rule

* chore: switch import/no-import-module-exports rule off

This rule is causing an ESLint error which prevents the rest of the
project to be linted.

* chore: update @babel/new-cap rule reference

* chore: format files

* refactor: update block to avoid unnecessary condition

* refactor: get necessary condition back

Closes #384

Author: Belco90

.eslintrc.json

@@ -6,6 +6,7 @@
     "jest/globals": true
   },
   "extends": [
+    "kentcdodds",
     "plugin:@typescript-eslint/eslint-recommended",
     "plugin:@typescript-eslint/recommended",
     "prettier",
@@ -22,8 +23,35 @@
     "project": "./tsconfig.eslint.json"
   },
   "rules": {
-    "no-var": "error",
+    // TS
     "@typescript-eslint/explicit-function-return-type": "off",
-    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      { "argsIgnorePattern": "^_" }
+    ],
+    "@typescript-eslint/no-use-before-define": "off",
+
+    // ESLint
+    "max-lines-per-function": "off",
+    "no-restricted-imports": [
+      "error",
+      {
+        "patterns": ["@typescript-eslint/experimental-utils/dist/*"]
+      }
+    ],
+
+    // Import
+    "import/no-import-module-exports": "off",
+    "import/order": [
+      "warn",
+      {
+        "groups": ["builtin", "external", "parent", "sibling", "index"],
+        "newlines-between": "always",
+        "alphabetize": {
+          "order": "asc",
+          "caseInsensitive": false
+        }
+      }
+    ]
   }
 }

lib/configs/index.ts

@@ -1,13 +1,13 @@
 import { join } from 'path';
 
-import type { TSESLint } from '@typescript-eslint/experimental-utils';
-
 import {
   importDefault,
   SUPPORTED_TESTING_FRAMEWORKS,
   SupportedTestingFramework,
 } from '../utils';
 
+import type { TSESLint } from '@typescript-eslint/experimental-utils';
+
 export type LinterConfigRules = Record<string, TSESLint.Linter.RuleEntry>;
 
 const configsDir = __dirname;

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

@@ -89,9 +89,9 @@ type IsAbsenceAssertFn = (node: TSESTree.MemberExpression) => boolean;
 type CanReportErrorsFn = () => boolean;
 type FindImportedTestingLibraryUtilSpecifierFn = (
   specifierName: string
-) => TSESTree.ImportClause | TSESTree.Identifier | undefined;
+) => TSESTree.Identifier | TSESTree.ImportClause | undefined;
 type IsNodeComingFromTestingLibraryFn = (
-  node: TSESTree.MemberExpression | TSESTree.Identifier
+  node: TSESTree.Identifier | TSESTree.MemberExpression
 ) => boolean;
 
 export interface DetectionHelpers {
@@ -181,7 +181,7 @@ export function detectTestingLibraryUtils<
      *    reporting)
      */
     function isPotentialTestingLibraryFunction(
-      node: TSESTree.Identifier,
+      node: TSESTree.Identifier | null | undefined,
       isPotentialFunctionCallback: (
         identifierNodeName: string,
         originalNodeName?: string
@@ -472,9 +472,8 @@ export function detectTestingLibraryUtils<
      * Determines whether a given node is fireEvent method or not
      */
     const isFireEventMethod: IsFireEventMethodFn = (node) => {
-      const fireEventUtil = findImportedTestingLibraryUtilSpecifier(
-        FIRE_EVENT_NAME
-      );
+      const fireEventUtil =
+        findImportedTestingLibraryUtilSpecifier(FIRE_EVENT_NAME);
       let fireEventUtilName: string | undefined;
 
       if (fireEventUtil) {
@@ -655,9 +654,8 @@ export function detectTestingLibraryUtils<
           return false;
         }
         const referenceNode = getReferenceNode(node);
-        const referenceNodeIdentifier = getPropertyIdentifierNode(
-          referenceNode
-        );
+        const referenceNodeIdentifier =
+          getPropertyIdentifierNode(referenceNode);
         if (!referenceNodeIdentifier) {
           return false;
         }
@@ -759,54 +757,58 @@ export function detectTestingLibraryUtils<
     /**
      * Finds the import util specifier related to Testing Library for a given name.
      */
-    const findImportedTestingLibraryUtilSpecifier: FindImportedTestingLibraryUtilSpecifierFn = (
-      specifierName
-    ): TSESTree.ImportClause | TSESTree.Identifier | undefined => {
-      const node = getCustomModuleImportNode() ?? getTestingLibraryImportNode();
+    const findImportedTestingLibraryUtilSpecifier: FindImportedTestingLibraryUtilSpecifierFn =
+      (
+        specifierName
+      ): TSESTree.Identifier | TSESTree.ImportClause | undefined => {
+        const node =
+          getCustomModuleImportNode() ?? getTestingLibraryImportNode();
+
+        if (!node) {
+          return undefined;
+        }
 
-      if (!node) {
-        return undefined;
-      }
+        return findImportSpecifier(specifierName, node);
+      };
 
-      return findImportSpecifier(specifierName, node);
-    };
+    const findImportedUserEventSpecifier: () => TSESTree.Identifier | null =
+      () => {
+        if (!importedUserEventLibraryNode) {
+          return null;
+        }
 
-    const findImportedUserEventSpecifier: () => TSESTree.Identifier | null = () => {
-      if (!importedUserEventLibraryNode) {
-        return null;
-      }
+        if (isImportDeclaration(importedUserEventLibraryNode)) {
+          const userEventIdentifier =
+            importedUserEventLibraryNode.specifiers.find((specifier) =>
+              isImportDefaultSpecifier(specifier)
+            );
 
-      if (isImportDeclaration(importedUserEventLibraryNode)) {
-        const userEventIdentifier = importedUserEventLibraryNode.specifiers.find(
-          (specifier) => isImportDefaultSpecifier(specifier)
-        );
+          if (userEventIdentifier) {
+            return userEventIdentifier.local;
+          }
+        } else {
+          if (
+            !ASTUtils.isVariableDeclarator(importedUserEventLibraryNode.parent)
+          ) {
+            return null;
+          }
 
-        if (userEventIdentifier) {
-          return userEventIdentifier.local;
-        }
-      } else {
-        if (
-          !ASTUtils.isVariableDeclarator(importedUserEventLibraryNode.parent)
-        ) {
-          return null;
-        }
+          const requireNode = importedUserEventLibraryNode.parent;
+          if (!ASTUtils.isIdentifier(requireNode.id)) {
+            return null;
+          }
 
-        const requireNode = importedUserEventLibraryNode.parent;
-        if (!ASTUtils.isIdentifier(requireNode.id)) {
-          return null;
+          return requireNode.id;
         }
 
-        return requireNode.id;
-      }
-
-      return null;
-    };
+        return null;
+      };
 
     const getTestingLibraryImportedUtilSpecifier = (
-      node: TSESTree.MemberExpression | TSESTree.Identifier
-    ): TSESTree.ImportClause | TSESTree.Identifier | undefined => {
-      const identifierName: string | undefined = getPropertyIdentifierNode(node)
-        ?.name;
+      node: TSESTree.Identifier | TSESTree.MemberExpression
+    ): TSESTree.Identifier | TSESTree.ImportClause | undefined => {
+      const identifierName: string | undefined =
+        getPropertyIdentifierNode(node)?.name;
 
       if (!identifierName) {
         return undefined;
@@ -848,9 +850,8 @@ export function detectTestingLibraryUtils<
           return importNode.parent;
         }
 
-        const variableDeclarator = findClosestVariableDeclaratorNode(
-          importNode
-        );
+        const variableDeclarator =
+          findClosestVariableDeclaratorNode(importNode);
 
         if (isCallExpression(variableDeclarator?.init)) {
           return variableDeclarator?.init;
@@ -868,8 +869,8 @@ export function detectTestingLibraryUtils<
         return false;
       }
 
-      const identifierName: string | undefined = getPropertyIdentifierNode(node)
-        ?.name;
+      const identifierName: string | undefined =
+        getPropertyIdentifierNode(node)?.name;
 
       if (!identifierName) {
         return false;
@@ -1045,6 +1046,8 @@ export function detectTestingLibraryUtils<
         if (canReportErrors() && ruleInstructions[instruction]) {
           return ruleInstructions[instruction]?.(node);
         }
+
+        return undefined;
       };
     });
 

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

@@ -24,6 +24,7 @@ export function createTestingLibraryRule<
   detectionOptions?: Partial<DetectionOptions>;
   create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
 }>): TSESLint.RuleModule<TMessageIds, TOptions> {
+  // eslint-disable-next-line @babel/new-cap
   return ESLintUtils.RuleCreator(getDocsUrl)({
     ...remainingConfig,
     create: detectTestingLibraryUtils<TOptions, TMessageIds, TRuleListener>(