Implement require-pickup-in-persist rule (#163)

Author: kireevmp

config/scope.js

@@ -1,5 +1,6 @@
 module.exports = {
   rules: {
     "effector/strict-effect-handlers": "error",
+    "effector/require-pickup-in-persist": "error",
   },
 };

docs/rules/require-pickup-in-persist.md

@@ -0,0 +1,19 @@
+# effector/require-pickup-in-persist
+
+Requires every `persist` call of the [`effector-storage`](https://github.com/yumauri/effector-storage) library to include a `pickup` event when using [`Scope`s](https://effector.dev/api/effector/scope/). This ensures the correct initial value is loaded into the store for each `Scope`.
+
+```ts
+import { persist } from "effector-storage/query";
+
+const $store = createStore("example");
+
+// 👎 no pickup, does not work with Scope
+persist({ store: $store });
+```
+
+```ts
+const pickup = createEvent();
+
+// 👍 pickup is specified
+persist({ store: $store, pickup });
+```

index.js

@@ -18,6 +18,7 @@ module.exports = {
     "no-guard": require("./rules/no-guard/no-guard"),
     "mandatory-scope-binding": require("./rules/mandatory-scope-binding/mandatory-scope-binding"),
     "prefer-useUnit": require("./rules/prefer-useUnit/prefer-useUnit"),
+    "require-pickup-in-persist": require("./rules/require-pickup-in-persist/require-pickup-in-persist"),
     "no-patronum-debug": require("./rules/no-patronum-debug/no-patronum-debug"),
   },
   configs: {

rules/require-pickup-in-persist/examples/correct-complete-config.js

@@ -0,0 +1,18 @@
+import { createStore, createEvent } from "effector";
+
+import { persist } from "effector-storage/local";
+
+const $store = createStore("example");
+const updated = createEvent();
+
+const appStarted = createEvent();
+
+persist({
+  source: $store.updates,
+  target: updated,
+
+  pickup: appStarted,
+
+  key: "store",
+  keyPrefix: "local",
+});

rules/require-pickup-in-persist/examples/correct-core-package.js

@@ -0,0 +1,9 @@
+import { createStore, createEvent } from "effector";
+
+import { persist } from "effector-storage";
+import { local as localAdapter } from "effector-storage/local";
+
+const $store = createStore("example");
+const pickup = createEvent();
+
+persist({ store: $store, pickup, adapter: localAdapter });

rules/require-pickup-in-persist/examples/correct-other-packages.js

@@ -0,0 +1,9 @@
+import { createStore } from "effector";
+
+import { persist } from "other-persist";
+import { persist as persistNested } from "other-persist/nested";
+
+const $store = createStore("example");
+
+persist({ store: $store });
+persistNested({ store: $store });

rules/require-pickup-in-persist/examples/correct-query-package.js

@@ -0,0 +1,8 @@
+import { createStore, createEvent } from "effector";
+
+import { persist as persistQuery } from "effector-storage/query";
+
+const $store = createStore("example");
+const pickup = createEvent();
+
+persistQuery({ store: $store, pickup });

rules/require-pickup-in-persist/examples/correct-scoped-package.js

@@ -0,0 +1,8 @@
+import { createStore, createEvent } from "effector";
+
+import { persist as persistAsync } from "@effector-storage/react-native-async-storage";
+
+const $store = createStore("example");
+const pickup = createEvent();
+
+persistAsync({ store: $store, pickup });

rules/require-pickup-in-persist/examples/correct-skip-misconfigured.js

@@ -0,0 +1,9 @@
+import { createStore } from "effector";
+
+import { persist } from "effector-storage";
+
+const randomCall = () => ({ store: createStore() });
+
+persist();
+persist("invalid");
+persist(randomCall());

rules/require-pickup-in-persist/examples/incorrect-complete-config.js

@@ -0,0 +1,14 @@
+import { createStore, createEvent } from "effector";
+
+import { persist } from "effector-storage/local";
+
+const $store = createStore("example");
+const updated = createEvent();
+
+persist({
+  source: $store,
+  target: updated,
+
+  key: "store",
+  keyPrefix: "local",
+});