eslint-plugin-effector 0.7.5 → 0.8.1

package/README.md

@@ -6,16 +6,27 @@ Enforcing best practices for [Effector](http://effector.dev/)
 
 ## Installation
 
-First, install [ESLint](http://eslint.org):
+Install [ESLint](http://eslint.org) and `eslint-plugin-effector`:
+
+### pnpm
+
+```
+$ pnpm install --dev eslint
+$ pnpm install --dev eslint-plugin-effector
+```
+
+### yarn
 
 ```
-$ yarn add -D eslint
+$ yarn add --dev eslint
+$ yarn add --dev eslint-plugin-effector
 ```
 
-Next, install `eslint-plugin-effector`:
+### npm
 
 ```
-$ yarn add -D eslint-plugin-effector
+$ npm install --dev eslint
+$ npm install --dev eslint-plugin-effector
 ```
 
 ## Usage
@@ -68,7 +79,8 @@ This preset is recommended for projects that use [Fork API](https://effector.dev
 This preset is recommended for projects that use [React](https://reactjs.org) with Effector.
 
 - [effector/enforce-gate-naming-convention](rules/enforce-gate-naming-convention/enforce-gate-naming-convention.md)
-- [effector/mandatory-useEvent](rules/mandatory-useEvent/mandatory-useEvent.md)
+- [effector/mandatory-scope-binding](rules/mandatory-scope-binding/mandatory-scope-binding.md)
+- [effector/prefer-useUnit](rules/prefer-useUnit/prefer-useUnit.md)
 
 #### plugin:effector/future
 
@@ -86,5 +98,5 @@ This preset contains rules, which enforce _future-effector_ code-style.
 3. Commit changes by `git commit -m "Release X.X.X"`
 4. Create git tag for release by `git tag -a vX.X.X -m "vX.X.X"`
 5. Push changes to remote by `git push --follow-tags`
-6. Release package to registry by `yarn clean-publish`
+6. Release package to registry by `pnpm clean-publish`
 7. Fill release page with changelog on GitHub

package/config/react.js

@@ -1,6 +1,7 @@
 module.exports = {
   rules: {
     "effector/enforce-gate-naming-convention": "error",
-    "effector/mandatory-useEvent": "error",
+    "effector/mandatory-scope-binding": "error",
+    "effector/prefer-useUnit": "warn",
   },
 };

package/index.js

@@ -15,7 +15,8 @@ module.exports = {
     "keep-options-order": require("./rules/keep-options-order/keep-options-order"),
     "no-forward": require("./rules/no-forward/no-forward"),
     "no-guard": require("./rules/no-guard/no-guard"),
-    "mandatory-useEvent": require("./rules/mandatory-useEvent/mandatory-useEvent"),
+    "mandatory-scope-binding": require("./rules/mandatory-scope-binding/mandatory-scope-binding"),
+    "prefer-useUnit": require("./rules/prefer-useUnit/prefer-useUnit"),
   },
   configs: {
     recommended: require("./config/recommended"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-effector",
-  "version": "0.7.5",
+  "version": "0.8.1",
   "description": "Enforcing best practices for Effector",
   "keywords": [
     "eslint",

package/rules/keep-options-order/config.js

@@ -1,3 +1,3 @@
-const correctOrder = ["clock", "source", "filter", "fn", "target"];
+const correctOrder = ["clock", "source", "filter", "fn", "target", "greedy"];
 
 module.exports = { correctOrder };

package/rules/{mandatory-useEvent/mandatory-useEvent.js → mandatory-scope-binding/mandatory-scope-binding.js}

@@ -9,14 +9,14 @@ module.exports = {
     type: "problem",
     docs: {
       description:
-        "Forbids `Event` and `Effect` usage without `useEvent` in React components.",
+        "Forbids `Event` and `Effect` usage without `useUnit` in React components.",
       category: "Quality",
       recommended: true,
-      url: createLinkToRule("mandatory-useEvent"),
+      url: createLinkToRule("mandatory-scope-binding"),
     },
     messages: {
       useEventNeeded:
-        "{{ unitName }} must be wrapped with `useEvent` from `effector-react` before usage inside React components",
+        "{{ unitName }} must be wrapped with `useUnit` from `effector-react` before usage inside React components",
     },
     schema: [],
   },

package/rules/prefer-useUnit/prefer-useUnit.js

@@ -0,0 +1,56 @@
+const { createLinkToRule } = require("../../utils/create-link-to-rule");
+const { extractImportedFrom } = require("../../utils/extract-imported-from");
+
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description:
+        "Suggests to replace old hooks `useStore`/`useEvent` by the new one `useUnit`",
+      category: "Quality",
+      recommended: true,
+      url: createLinkToRule("prefer-useUnit"),
+    },
+    messages: {
+      useUnitNeeded: "`{{ hookName }}` could be replaced by `useUnit`",
+    },
+    schema: [],
+  },
+  create(context) {
+    const importedFromEffectorReact = new Map();
+
+    return {
+      ImportDeclaration(node) {
+        extractImportedFrom({
+          importMap: importedFromEffectorReact,
+          packageName: "effector-react",
+          node,
+        });
+      },
+      CallExpression(node) {
+        const OLD_HOOKS = ["useStore", "useEvent"];
+        const NEW_HOOK = ["useUnit"];
+
+        for (const oldHookName of OLD_HOOKS) {
+          const localOldHookName = importedFromEffectorReact.get(oldHookName);
+          if (!localOldHookName) {
+            continue;
+          }
+
+          const isOldHook = node.callee.name === localOldHookName;
+          if (!isOldHook) {
+            continue;
+          }
+
+          context.report({
+            node,
+            messageId: "useUnitNeeded",
+            data: {
+              hookName: oldHookName,
+            },
+          });
+        }
+      },
+    };
+  },
+};