chore(ui-react): update eslint config (#1829)

Author: calebpollman

.changeset/good-gifts-camp.md

@@ -0,0 +1,5 @@
+---
+"@aws-amplify/ui-react": patch
+---
+
+chore(ui-react): update eslint config

packages/react/.eslintrc.js

@@ -1,22 +1,43 @@
+// TODO remove these once the full set of rules can be turned on for the repo
+// extensions that should be ran against the entire repo
+const sharedExtensions = [
+  'plugin:react-hooks/recommended',
+
+  // always extend last to override previous extensions
+  'prettier',
+];
+
+// rules that should be ran against the entire repo
+const sharedRules = {
+  // react hook rules
+  'react-hooks/rules-of-hooks': 'error',
+  'react-hooks/exhaustive-deps': 'error',
+};
+
 module.exports = {
   env: { node: true },
   root: true,
   ignorePatterns: [
+    // top level directories
     '__tests__',
+    'dist',
+    'node_modules',
+    'scripts',
+
+    // config files
     '.eslintrc.js',
     'jest.config.js',
+    'jest.setup.ts',
+    'rollup.config.js',
     'tsup.config.ts',
-    'scripts',
-    'dist',
-    'node_modules',
 
-    // TODO Delete this file once the above directories are no longer ignored
+    // TODO remove once the full set of rules can be turned on for the repo
     'src/react-shim.js',
 
     // TODO remove once the icons have been deprecated for v3
     'src/primitives/Icon/icons',
   ],
-  extends: ['plugin:react-hooks/recommended'],
+  extends: sharedExtensions,
   plugins: ['react-hooks'],
   parser: '@typescript-eslint/parser',
   parserOptions: {
@@ -40,7 +61,7 @@ module.exports = {
         'jest/unbound-method': 'error',
       },
     },
-    // TODO remove once the larger set of rules is applied to the whole repo.
+    // TODO remove once the full set of rules can be turned on for the repo
     // To keep the rules-of-hooks on for the entire ui-react package while
     // we add the larger set of rules incrementally, use an overrides object
     // to incrementally apply the new rules
@@ -54,70 +75,75 @@ module.exports = {
         // 'src/primitives/**/*',
       ],
       extends: [
-        'airbnb',
-        'airbnb-typescript',
+        'eslint:recommended',
         'plugin:jest/recommended',
         'plugin:react/recommended',
-        'plugin:react-hooks/recommended',
         'plugin:@typescript-eslint/recommended-requiring-type-checking',
-        'plugin:prettier/recommended',
-      ],
-      plugins: [
-        'react',
-        '@typescript-eslint',
-        'react-hooks',
-        'jest',
-        'prettier',
+
+        // extend last to override previous extensions
+        ...sharedExtensions,
       ],
+      plugins: ['@typescript-eslint', 'jest', 'react', 'react-hooks'],
+      settings: {
+        react: {
+          version: 'detect',
+        },
+      },
       rules: {
+        ...sharedRules,
+
+        // typescript eslint rules either not in recommended rule set or overridden
         '@typescript-eslint/explicit-module-boundary-types': 2,
         '@typescript-eslint/member-ordering': 'error',
         '@typescript-eslint/no-extra-semi': 'error',
+        '@typescript-eslint/no-floating-promises': ['off'],
         '@typescript-eslint/no-unused-expressions': [
           'error',
           { allowTernary: true },
         ],
-        '@typescript-eslint/no-floating-promises': ['off'],
+        '@typescript-eslint/no-use-before-define': ['error'],
         '@typescript-eslint/no-unused-vars': [
           'error',
           { argsIgnorePattern: '_', varsIgnorePattern: '_' },
         ],
         '@typescript-eslint/prefer-nullish-coalescing': 'error',
         '@typescript-eslint/restrict-template-expressions': ['off'],
         '@typescript-eslint/unbound-method': 'error',
+
+        // eslint rules either not in recommended rule set or overridden
         'comma-dangle': ['error', 'only-multiline'],
         'function-paren-newline': 'off',
         'generator-star-spacing': 'off',
         'global-require': 'off',
         'implicit-arrow-linebreak': 'off',
-        'import/no-cycle': 'off',
-        'import/no-extraneous-dependencies': ['off'],
-        'import/prefer-default-export': 'off',
-        'jest/expect-expect': ['error', { assertFunctionNames: ['expect*'] }],
-        'jest/no-mocks-import': 'off',
         'max-params': 2,
         'no-alert': 'error',
         'no-console': 'error',
+        'no-eval': 'error',
         'no-tabs': ['error', { allowIndentationTabs: true }],
+        'no-unused-vars': 'off', // prefer @typescript-eslint version
+        'prefer-const': 'error',
         'prefer-destructuring': ['error', { array: false, object: true }],
-        'prettier/prettier': ['error'],
+
+        // jest rules either not in recommended rule set or overridden
+        'jest/expect-expect': ['error', { assertFunctionNames: ['expect*'] }],
+        'jest/no-mocks-import': 'off',
+
+        // react rules either not in recommended rule set or overridden
+        'react/destructuring-assignment': ['error', 'always'],
+        'react/jsx-boolean-value': 'error',
+        'react/jsx-no-constructed-context-values': ['error'],
+        'react/jsx-no-useless-fragment': ['error', { allowExpressions: true }],
         'react/jsx-props-no-spreading': 'off',
         'react/jsx-wrap-multilines': ['error', { declaration: 'ignore' }],
         'react/no-array-index-key': 'off',
+        'react/no-danger': ['error'],
+        'react/no-unused-prop-types': ['error'],
         'react/prop-types': 'off',
-        'react/require-default-props': [
-          2,
-          { ignoreFunctionalComponents: true },
-        ],
         'react/static-property-placement': ['error', 'static public field'],
-        'react-hooks/rules-of-hooks': 'error',
-        'react-hooks/exhaustive-deps': 'error',
       },
     },
   ],
 
-  rules: {
-    'react-hooks/rules-of-hooks': 'error',
-    'react-hooks/exhaustive-deps': 'error',
-  },
+  rules: sharedRules,
 };

packages/react/package.json

@@ -98,8 +98,6 @@
     "@typescript-eslint/parser": "^5.20.0",
     "degit": "^2.8.4",
     "eslint": "^8.13.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^26.1.4",