feat(no-initialize-state): add arguments to message

#48

Author: NickvanDyke

src/rules/no-initialize-state.js

@@ -21,7 +21,7 @@ export default {
     schema: [],
     messages: {
       avoidInitializingState:
-        'Avoid initializing state in an effect. Instead, pass "{{state}}"\'s initial value to its `useState`. For SSR hydration, prefer `useSyncExternalStore`.',
+        'Avoid initializing state in an effect. Instead, initialize "{{state}}"\'s `useState()` with "{{arguments}}". For SSR hydration, prefer `useSyncExternalStore()`.',
     },
   },
   create: (context) => ({
@@ -38,15 +38,19 @@ export default {
         .filter((ref) => isStateSetter(context, ref))
         .filter((ref) => isImmediateCall(ref.identifier))
         .forEach((ref) => {
+          const callExpr = getCallExpr(ref);
           const useStateNode = getUseStateNode(context, ref);
           const stateName = (
             useStateNode.id.elements[0] ?? useStateNode.id.elements[1]
           )?.name;
+          const argumentText = callExpr.arguments[0]
+            ? context.sourceCode.getText(callExpr.arguments[0])
+            : "undefined";
 
           context.report({
             node: getCallExpr(ref),
             messageId: "avoidInitializingState",
-            data: { state: stateName },
+            data: { state: stateName, arguments: argumentText },
           });
         });
     },

test/no-initialize-state.test.js

@@ -103,7 +103,7 @@ new MyRuleTester().run("no-initialize-state", rule, {
       errors: [
         {
           messageId: "avoidInitializingState",
-          data: { state: "state" },
+          data: { state: "state", arguments: '"Hello"' },
         },
       ],
     },
@@ -122,7 +122,7 @@ new MyRuleTester().run("no-initialize-state", rule, {
       errors: [
         {
           messageId: "avoidInitializingState",
-          data: { state: "state" },
+          data: { state: "state", arguments: "otherState" },
         },
       ],
     },
@@ -141,7 +141,25 @@ new MyRuleTester().run("no-initialize-state", rule, {
       errors: [
         {
           messageId: "avoidInitializingState",
-          data: { state: "state" },
+          data: { state: "state", arguments: "'Hello World'" },
+        },
+      ],
+    },
+    {
+      name: "To undefined",
+      code: js`
+        function MyComponent() {
+          const [state, setState] = useState('Meow');
+
+          useEffect(() => {
+            setState();
+          }, []);
+        }
+      `,
+      errors: [
+        {
+          messageId: "avoidInitializingState",
+          data: { state: "state", arguments: "undefined" },
         },
       ],
     },