@pplancq/eslint-config 3.0.1 → 4.0.1

package/rules/react.js

@@ -1,9 +1,18 @@
-module.exports = {
-  extends: ['./react-jsx-a11y.js', './base.js', './typescript.js'],
-  plugins: ['react', 'react-hooks'],
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true,
+const reactPlugin = require('eslint-plugin-react');
+const reactHooksPlugin = require('eslint-plugin-react-hooks');
+const testingLibraryPlugin = require('eslint-plugin-testing-library');
+const jestDom = require('eslint-plugin-jest-dom');
+
+const reactRules = {
+  plugins: {
+    react: reactPlugin,
+    'react-hooks': reactHooksPlugin,
+  },
+  languageOptions: {
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
     },
   },
   rules: {
@@ -640,211 +649,220 @@ module.exports = {
       'Object.freeze', // https://tc39.github.io/ecma262/#sec-object.freeze
     ],
   },
-  overrides: [
-    {
-      files: ['**/*.ts?(x)'],
-      settings: {
-        'import/resolver': {
-          node: {
-            extensions: ['.js', '.jsx', '.ts', '.tsx'],
-          },
-        },
+};
+
+const reactTypescriptRules = {
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
       },
-      parserOptions: {
-        jsxPragma: null,
+    },
+  },
+  languageOptions: {
+    parserOptions: {
+      jsxPragma: null,
+    },
+  },
+  rules: {
+    // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
+
+    // import/extensions
+    // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        js: 'never',
+        jsx: 'never',
+        ts: 'never',
+        tsx: 'never',
       },
-      rules: {
-        // eslint-plugin-import https://github.com/import-js/eslint-plugin-import
-
-        // import/extensions
-        // https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md
-        'import/extensions': [
-          'error',
-          'ignorePackages',
-          {
-            js: 'never',
-            jsx: 'never',
-            ts: 'never',
-            tsx: 'never',
-          },
-        ],
+    ],
 
-        // eslint-plugin-react https://github.com/jsx-eslint/eslint-plugin-react
+    // eslint-plugin-react https://github.com/jsx-eslint/eslint-plugin-react
 
-        // Enforce a defaultProps definition for every prop that is not a required prop
-        // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/require-default-props.md
-        'react/require-default-props': 'off',
+    // Enforce a defaultProps definition for every prop that is not a required prop
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/require-default-props.md
+    'react/require-default-props': 'off',
 
-        // Disallow file extensions that may contain JSX
-        // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
-        'react/jsx-filename-extension': [
-          'error',
-          {
-            extensions: ['.jsx', '.tsx'],
-          },
-        ],
+    // Disallow file extensions that may contain JSX
+    // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-filename-extension.md
+    'react/jsx-filename-extension': [
+      'error',
+      {
+        extensions: ['.jsx', '.tsx'],
       },
-    },
-    {
-      files: ['*.{test,spec,steps}.{js,jsx,ts,tsx}'],
-      plugins: ['testing-library', 'jest-dom'],
-      rules: {
-        // eslint-plugin-jest-dom https://github.com/testing-library/eslint-plugin-jest-dom
+    ],
+  },
+};
 
-        // Prefer toBeChecked over checking attributes
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-checked.md
-        'jest-dom/prefer-checked': 'error',
+const reactTestRules = {
+  plugins: {
+    'testing-library': testingLibraryPlugin,
+    'jest-dom': jestDom,
+  },
+  rules: {
+    // eslint-plugin-jest-dom https://github.com/testing-library/eslint-plugin-jest-dom
 
-        // Prefer toBeEmpty over checking innerHTML
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-empty.md
-        'jest-dom/prefer-empty': 'error',
+    // Prefer toBeChecked over checking attributes
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-checked.md
+    'jest-dom/prefer-checked': 'error',
 
-        // Prefer toBeDisabled or toBeEnabled over checking attributes
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-enabled-disabled.md
-        'jest-dom/prefer-enabled-disabled': 'error',
+    // Prefer toBeEmpty over checking innerHTML
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-empty.md
+    'jest-dom/prefer-empty': 'error',
 
-        // Prefer toHaveFocus over checking document.activeElement
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-focus.md
-        'jest-dom/prefer-focus': 'error',
+    // Prefer toBeDisabled or toBeEnabled over checking attributes
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-enabled-disabled.md
+    'jest-dom/prefer-enabled-disabled': 'error',
 
-        // Prefer .toBeInTheDocument() for asserting the existence of a DOM node
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-in-document.md
-        'jest-dom/prefer-in-document': 'error',
+    // Prefer toHaveFocus over checking document.activeElement
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-focus.md
+    'jest-dom/prefer-focus': 'error',
 
-        // Prefer toBeRequired over checking properties
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-required.md
-        'jest-dom/prefer-required': 'error',
+    // Prefer .toBeInTheDocument() for asserting the existence of a DOM node
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-in-document.md
+    'jest-dom/prefer-in-document': 'error',
 
-        // Prefer toHaveAttribute over checking getAttribute/hasAttribute
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-attribute.md
-        'jest-dom/prefer-to-have-attribute': 'error',
+    // Prefer toBeRequired over checking properties
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-required.md
+    'jest-dom/prefer-required': 'error',
 
-        // Prefer toHaveClass over checking element className
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-class.md
-        'jest-dom/prefer-to-have-class': 'error',
+    // Prefer toHaveAttribute over checking getAttribute/hasAttribute
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-attribute.md
+    'jest-dom/prefer-to-have-attribute': 'error',
 
-        // Prefer toHaveStyle over checking element style
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-style.md
-        'jest-dom/prefer-to-have-style': 'error',
+    // Prefer toHaveClass over checking element className
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-class.md
+    'jest-dom/prefer-to-have-class': 'error',
 
-        // Prefer toHaveTextContent over checking element.textContent
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-text-content.md
-        'jest-dom/prefer-to-have-text-content': 'error',
+    // Prefer toHaveStyle over checking element style
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-style.md
+    'jest-dom/prefer-to-have-style': 'error',
 
-        // Prefer toHaveValue over checking element.value
-        // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-value.md
-        'jest-dom/prefer-to-have-value': 'error',
+    // Prefer toHaveTextContent over checking element.textContent
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-text-content.md
+    'jest-dom/prefer-to-have-text-content': 'error',
 
-        // eslint-plugin-testing-library https://github.com/testing-library/eslint-plugin-testing-library
+    // Prefer toHaveValue over checking element.value
+    // https://github.com/testing-library/eslint-plugin-jest-dom/blob/main/docs/rules/prefer-to-have-value.md
+    'jest-dom/prefer-to-have-value': 'error',
 
-        // Enforce promises from async event methods are handled
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-events.md
-        'testing-library/await-async-events': 'off',
+    // eslint-plugin-testing-library https://github.com/testing-library/eslint-plugin-testing-library
 
-        // Enforce promises from async queries to be handled
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-queries.md
-        'testing-library/await-async-queries': 'error',
+    // Enforce promises from async event methods are handled
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-events.md
+    'testing-library/await-async-events': 'off',
 
-        // Enforce promises from async utils to be awaited properly
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-utils.md
-        'testing-library/await-async-utils': 'error',
+    // Enforce promises from async queries to be handled
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-queries.md
+    'testing-library/await-async-queries': 'error',
 
-        // Ensures consistent usage of data-testid
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/consistent-data-testid.md
-        'testing-library/consistent-data-testid': 'off',
+    // Enforce promises from async utils to be awaited properly
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/await-async-utils.md
+    'testing-library/await-async-utils': 'error',
 
-        // Disallow unnecessary await for sync events
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-await-sync-events.md
-        'testing-library/no-await-sync-events': 'off',
+    // Ensures consistent usage of data-testid
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/consistent-data-testid.md
+    'testing-library/consistent-data-testid': 'off',
 
-        // Disallow unnecessary await for sync queries
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-await-sync-queries.md
-        'testing-library/no-await-sync-queries': 'error',
+    // Disallow unnecessary await for sync events
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-await-sync-events.md
+    'testing-library/no-await-sync-events': 'off',
 
-        // Disallow the use of container methods
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-container.md
-        'testing-library/no-container': 'error',
+    // Disallow unnecessary await for sync queries
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-await-sync-queries.md
+    'testing-library/no-await-sync-queries': 'error',
 
-        // Disallow the use of debugging utilities like debug
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-debugging-utils.md
-        'testing-library/no-debugging-utils': 'error',
+    // Disallow the use of container methods
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-container.md
+    'testing-library/no-container': 'error',
 
-        // Disallow importing from DOM Testing Library
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-dom-import.md
-        'testing-library/no-dom-import': ['error', 'react'],
+    // Disallow the use of debugging utilities like debug
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-debugging-utils.md
+    'testing-library/no-debugging-utils': 'error',
 
-        // Disallow the use of the global RegExp flag (/g) in queries
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-global-regexp-flag-in-query.md
-        'testing-library/no-global-regexp-flag-in-query': 'off',
+    // Disallow importing from DOM Testing Library
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-dom-import.md
+    'testing-library/no-dom-import': ['error', 'react'],
 
-        // Disallow the use of cleanup
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-manual-cleanup.md
-        'testing-library/no-manual-cleanup': 'off',
+    // Disallow the use of the global RegExp flag (/g) in queries
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-global-regexp-flag-in-query.md
+    'testing-library/no-global-regexp-flag-in-query': 'off',
 
-        // Disallow direct Node access
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-node-access.md
-        'testing-library/no-node-access': 'error',
+    // Disallow the use of cleanup
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-manual-cleanup.md
+    'testing-library/no-manual-cleanup': 'off',
 
-        // Disallow the use of promises passed to a fireEvent method
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-promise-in-fire-event.md
-        'testing-library/no-promise-in-fire-event': 'error',
+    // Disallow direct Node access
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-node-access.md
+    'testing-library/no-node-access': 'error',
 
-        // Disallow the use of render in testing frameworks setup functions
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-render-in-lifecycle.md
-        'testing-library/no-render-in-lifecycle': 'error',
+    // Disallow the use of promises passed to a fireEvent method
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-promise-in-fire-event.md
+    'testing-library/no-promise-in-fire-event': 'error',
 
-        // Disallow wrapping Testing Library utils or empty callbacks in act
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-unnecessary-act.md
-        'testing-library/no-unnecessary-act': 'error',
+    // Disallow the use of render in testing frameworks setup functions
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-render-in-lifecycle.md
+    'testing-library/no-render-in-lifecycle': 'error',
 
-        // Disallow the use of multiple expect calls inside waitFor
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-multiple-assertions.md
-        'testing-library/no-wait-for-multiple-assertions': 'error',
+    // Disallow wrapping Testing Library utils or empty callbacks in act
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-unnecessary-act.md
+    'testing-library/no-unnecessary-act': 'error',
 
-        // Disallow the use of side effects in waitFor
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-side-effects.md
-        'testing-library/no-wait-for-side-effects': 'error',
+    // Disallow the use of multiple expect calls inside waitFor
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-multiple-assertions.md
+    'testing-library/no-wait-for-multiple-assertions': 'error',
 
-        // Ensures no snapshot is generated inside of a waitFor call
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-snapshot.md
-        'testing-library/no-wait-for-snapshot': 'error',
+    // Disallow the use of side effects in waitFor
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-side-effects.md
+    'testing-library/no-wait-for-side-effects': 'error',
 
-        // Suggest using explicit assertions rather than standalone queries
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-explicit-assert.md
-        'testing-library/prefer-explicit-assert': 'off',
+    // Ensures no snapshot is generated inside of a waitFor call
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/no-wait-for-snapshot.md
+    'testing-library/no-wait-for-snapshot': 'error',
 
-        // Suggest using find(All)By* query instead of waitFor + get(All)By* to wait for elements
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-find-by.md
-        'testing-library/prefer-find-by': 'error',
+    // Suggest using explicit assertions rather than standalone queries
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-explicit-assert.md
+    'testing-library/prefer-explicit-assert': 'off',
 
-        // Suggest using implicit assertions for getBy* & findBy* queries
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-implicit-assert.md
-        'testing-library/prefer-implicit-assert': 'off',
+    // Suggest using find(All)By* query instead of waitFor + get(All)By* to wait for elements
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-find-by.md
+    'testing-library/prefer-find-by': 'error',
 
-        // Ensure appropriate get*/query* queries are used with their respective matchers
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-presence-queries.md
-        'testing-library/prefer-presence-queries': 'error',
+    // Suggest using implicit assertions for getBy* & findBy* queries
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-implicit-assert.md
+    'testing-library/prefer-implicit-assert': 'off',
 
-        // Suggest using queryBy* queries when waiting for disappearance
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-query-by-disappearance.md
-        'testing-library/prefer-query-by-disappearance': 'error',
+    // Ensure appropriate get*/query* queries are used with their respective matchers
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-presence-queries.md
+    'testing-library/prefer-presence-queries': 'error',
 
-        // Ensure the configured get*/query* query is used with the corresponding matchers
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-query-matchers.md
-        'testing-library/prefer-query-matchers': 'error',
+    // Suggest using queryBy* queries when waiting for disappearance
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-query-by-disappearance.md
+    'testing-library/prefer-query-by-disappearance': 'error',
 
-        // Suggest using screen while querying
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-screen-queries.md
-        'testing-library/prefer-screen-queries': 'error',
+    // Ensure the configured get*/query* query is used with the corresponding matchers
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-query-matchers.md
+    'testing-library/prefer-query-matchers': 'error',
 
-        // Suggest using userEvent over fireEvent for simulating user interactions
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-user-event.md
-        'testing-library/prefer-user-event': 'off',
+    // Suggest using screen while querying
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-screen-queries.md
+    'testing-library/prefer-screen-queries': 'error',
 
-        // Enforce a valid naming for return value from render
-        // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/render-result-naming-convention.md
-        'testing-library/render-result-naming-convention': 'error',
-      },
-    },
-  ],
+    // Suggest using userEvent over fireEvent for simulating user interactions
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/prefer-user-event.md
+    'testing-library/prefer-user-event': 'off',
+
+    // Enforce a valid naming for return value from render
+    // https://github.com/testing-library/eslint-plugin-testing-library/blob/main/docs/rules/render-result-naming-convention.md
+    'testing-library/render-result-naming-convention': 'error',
+  },
+};
+
+module.exports = {
+  reactRules,
+  reactTypescriptRules,
+  reactTestRules,
 };