refactor: some fix after review

salute-developers · Dec 27, 2023 · 436080e · 436080e
1 parent ac9a9b6
commit 436080e
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 15 deletions.
diff --git a/packages/eslint-config/rules/index.js b/packages/eslint-config/rules/index.js
@@ -1,5 +1,3 @@
-/* config/eslint/index.js */
-
 const projectName = "salute-rules";
 
 const fs = require("fs");

diff --git a/packages/eslint-config/rules/no-redundant-commit.js b/packages/eslint-config/rules/no-redundant-commit.js
@@ -84,9 +84,9 @@ module.exports = {
     meta: {
         type: null, // `problem`, `suggestion`, or `layout`
         docs: {
-            description: "asdf",
-            recommended: false,
-            url: null, // URL to the documentation page for this rule
+            description: "This forbid synchronous setting of state in effect to prevent redundant commits",
+            recommended: true,
+            url: "https://react.dev/learn/you-might-not-need-an-effect#adjusting-some-state-when-a-prop-changes",
         },
         fixable: null, // Or `code` or `whitespace`
         schema: [], // Add a schema if the rule has options
@@ -109,16 +109,16 @@ module.exports = {
                 ) {
                     context.report({
                         node,
-                        message: "Don't use synchronous state settlers in effects",
+                        message: "Avoid using synchronous state setters within effects",
                     });
                 }
 
-                // checking is it is useEffect call
+                // Checking if the invoked function is useEffect
                 if (node.callee.type === "Identifier" && node.callee.name === "useEffect" && currentComponent) {
                     isInUseEffect = true;
                 }
 
-                // checking is it is useState call
+                // Checking if the function call is useState
                 if (node.callee.type === "Identifier" && node.callee.name === "useState" && currentComponent) {
                     const isDestructuringDeclarator =
                         node.parent &&
@@ -160,7 +160,7 @@ module.exports = {
                     isInUseEffect = false;
                 }
 
-                // Current implementation don't take into account nested setTimeout
+                // The current implementation does not consider nested setTimeout calls.
                 if (
                     node.callee.type === "Identifier" &&
                     (node.callee.name === "setTimeout" || node.callee.name === "setInterval")
@@ -186,7 +186,7 @@ module.exports = {
                 const name = getFunctionName(node);
 
                 if (name && isComponentName(name)) {
-                    // We  doesn't take into account nested component declaration
+                    // We  doesn't consider nested component declaration
                     currentComponent = node;
                 }
             },
@@ -206,7 +206,7 @@ module.exports = {
                 const name = getFunctionName(node);
 
                 if (name && isComponentName(name)) {
-                    // We  doesn't take into account nested component declaration
+                    // We  doesn't consider nested component declaration
                     currentComponent = node;
                 }
 

diff --git a/packages/eslint-config/rules/no-redundant-commit.test.js b/packages/eslint-config/rules/no-redundant-commit.test.js
@@ -110,7 +110,7 @@ const tests = {
         return <Page/>
       }
       `,
-            errors: [{ message: "Don't use synchronous state settlers in effects" }],
+            errors: [{ message: "Avoid using synchronous state setters within effects" }],
         },
         {
             code: ` 
@@ -127,7 +127,7 @@ const tests = {
         return <Page/>
       }
       `,
-            errors: [{ message: "Don't use synchronous state settlers in effects" }],
+            errors: [{ message: "Avoid using synchronous state setters within effects" }],
         },
         {
             code: ` 
@@ -146,7 +146,7 @@ const tests = {
         return <Loader />;
       }
       `,
-            errors: [{ message: "Don't use synchronous state settlers in effects" }],
+            errors: [{ message: "Avoid using synchronous state setters within effects" }],
         },
         {
             code: ` 
@@ -165,7 +165,7 @@ const tests = {
         return <Loader />;
       }
       `,
-            errors: [{ message: "Don't use synchronous state settlers in effects" }],
+            errors: [{ message: "Avoid using synchronous state setters within effects" }],
         },
     ],
 };