Merge pull request #56 from jfrere/main

Recognise mapArray as a tracked scope
solidjs-community · Jan 3, 2023 · 4c2d3af · 4c2d3af
2 parents 1db5114 + df40c38
commit 4c2d3af
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/docs/reactivity.md b/docs/reactivity.md
@@ -227,6 +227,16 @@ css`
   color: ${f};
 `;
 
+function createCustomStore() {
+  const [store, updateStore] = createStore({});
+
+  return mapArray(
+    [],
+    // the second argument to mapArray is not tracked
+    (item) => store.path.to.field
+  );
+}
+
 ```
 
 ### Valid Examples
@@ -508,6 +518,16 @@ function Component() {
   );
 }
 
+function createCustomStore() {
+  const [store, updateStore] = createStore({});
+
+  return mapArray(
+    // the first argument to mapArray is a tracked scope
+    () => store.path.to.field,
+    (item) => ({})
+  );
+}
+
 ```
 <!-- AUTO-GENERATED-CONTENT:END -->
 

diff --git a/src/rules/reactivity.ts b/src/rules/reactivity.ts
@@ -813,6 +813,7 @@ const rule: TSESLint.RuleModule<MessageIds, []> = {
               "createComputed",
               "createSelector",
               "untrack",
+              "mapArray",
             ],
             callee.name
           ) ||

diff --git a/test/rules/reactivity.test.ts b/test/rules/reactivity.test.ts
@@ -223,6 +223,16 @@ export const cases = run("reactivity", rule, {
         }} />
       );
     }`,
+    // mapArray()
+    `function createCustomStore() {
+      const [store, updateStore] = createStore({});
+
+      return mapArray(
+        // the first argument to mapArray is a tracked scope
+        () => store.path.to.field,
+        (item) => ({})
+      );
+    }`,
   ],
   invalid: [
     // Untracked signals
@@ -646,5 +656,19 @@ export const cases = run("reactivity", rule, {
       css\`color: \${f}\`;`,
       errors: [{ messageId: "badSignal", line: 4 }],
     },
+    // mapArray
+    {
+      code: `
+      function createCustomStore() {
+        const [store, updateStore] = createStore({});
+
+        return mapArray(
+          [],
+          // the second argument to mapArray is not tracked
+          (item) => store.path.to.field
+        );
+      }`,
+      errors: [{ messageId: "badUnnamedDerivedSignal", line: 7 }],
+    },
   ],
 });