feat: Update rules according to PR 427 (#436)

* feat: Update rules according to PR 427 --------- Co-authored-by: Thatchapon Unprasert <[email protected]>
agoda-com · Nov 7, 2024 · 2f7ddbb · 2f7ddbb
1 parent 4d6f7da
commit 2f7ddbb
Show file tree

Hide file tree

Showing 7 changed files with 734 additions and 101 deletions.
diff --git a/configs/@typescript-eslint/index.js b/configs/@typescript-eslint/index.js
@@ -23,7 +23,14 @@ module.exports = {
       "extendDefaults": true,
     },
   ],
-  "@typescript-eslint/naming-convention": "off",
+  "@typescript-eslint/naming-convention": [
+    "error", 
+    { 
+      "selector": "variable", 
+      "format": ["camelCase", "PascalCase", "UPPER_CASE"], 
+      "leadingUnderscore": "allow" 
+    }
+  ],
   "@typescript-eslint/consistent-type-assertions": ["error"],
   "@typescript-eslint/no-array-constructor": ["error"],
   "@typescript-eslint/no-empty-function": ['error', { 'allow': ['arrowFunctions'] }],

diff --git a/configs/eslint/index.js b/configs/eslint/index.js
@@ -43,14 +43,14 @@ module.exports = {
   "max-len": [
     "error",
     {
-      code: 120,
+      code: 200,
       tabWidth: 2,
       ignoreTemplateLiterals: true,
       ignoreStrings: true,
       ignoreComments: true
     }
   ],
-  "comma-dangle": ["error", "never"],
+  "comma-dangle": ["error", "always-multiline"], // not having a trailing comma results in unnecessary git changes
   "implicit-arrow-linebreak": ["off", "beside"],
   camelcase: [
     "off",
@@ -193,22 +193,7 @@ module.exports = {
       allowUnboundThis: true
     }
   ],
-  "prefer-destructuring": [
-    "error",
-    {
-      VariableDeclarator: {
-        array: false,
-        object: true
-      },
-      AssignmentExpression: {
-        array: true,
-        object: false
-      }
-    },
-    {
-      enforceForRenamedProperties: false
-    }
-  ],
+  "prefer-destructuring": ["off"], // adds unnecessary lines and removes context from code
   "prefer-numeric-literals": ["error"],
   "prefer-reflect": ["off"],
   "prefer-template": ["error"],

diff --git a/configs/import/index.js b/configs/import/index.js
@@ -6,7 +6,7 @@ module.exports = {
       caseSensitive: true
     }
   ],
-  "import/named": ["error"],
+  "import/named": ["off"], // not required for TS
   "import/default": ["off"],
   "import/namespace": ["off"],
   "import/export": ["error"],
@@ -66,7 +66,7 @@ module.exports = {
     }
   ],
   "import/newline-after-import": ["error"],
-  "import/prefer-default-export": ["error"],
+  "import/prefer-default-export": ["off"], // // adds unnecessary code change requirements when updating a 1 export module to multiple export and vice versa
   "import/no-restricted-paths": ["off"],
   "import/max-dependencies": [
     "off",

diff --git a/configs/react/index.js b/configs/react/index.js
@@ -260,12 +260,7 @@ module.exports = {
   ],
   "react/jsx-space-before-closing": ["off", "always"],
   "react/no-array-index-key": ["error"],
-  "react/require-default-props": [
-    "error",
-    {
-      forbidDefaultForRequired: true
-    }
-  ],
+  "react/require-default-props": ["off"], // not relevant to modern React with TS functional components
   "react/forbid-foreign-prop-types": [
     "off",
     {
@@ -297,7 +292,7 @@ module.exports = {
       children: "never"
     }
   ],
-  "react/destructuring-assignment": ["error", "always"],
+  "react/destructuring-assignment": ["off"], // adds unnecessary lines and removes context from code
   "react/no-access-state-in-setstate": ["error"],
   "react/button-has-type": [
     "error",

diff --git a/package.json b/package.json
@@ -36,7 +36,7 @@
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^27.1.7",
     "eslint-plugin-jsx-a11y": "^6.6.1",
-    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react": "^7.31.11",
     "eslint-plugin-react-hooks": "^4.6.0"
   },
   "dependencies": {
@@ -55,7 +55,7 @@
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^27.1.7",
     "eslint-plugin-jsx-a11y": "^6.6.1",
-    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react": "^7.31.11",
     "eslint-plugin-react-hooks": "^4.6.0",
     "husky": "^8.0.2",
     "jest": "^29.3.1",

diff --git a/tests/validate-config.test.js b/tests/validate-config.test.js
@@ -14,8 +14,8 @@ describe('Validate configs by eslint', () => {
         const results = await getErrors();
         const errorMessages = results[0].messages;
         expect(errorMessages).toHaveLength(3);
-        expect(errorMessages[0].ruleId).toBe('no-multi-spaces');
-        expect(errorMessages[1].ruleId).toBe('no-console');
-        expect(errorMessages[2].ruleId).toBe('no-multiple-empty-lines');
+        expect(errorMessages[0].ruleId).toBe('comma-dangle');
+        expect(errorMessages[1].ruleId).toBe('no-multi-spaces');
+        expect(errorMessages[2].ruleId).toBe('no-console');
     });
 });