eslint-plugin-effector 0.1.2 → 0.3.0

package/rules/no-useless-methods/no-useless-methods.js

@@ -0,0 +1,82 @@
+const {
+  extractImportedFromEffector,
+} = require("../../utils/extract-imported-from-effector");
+const { traverseParentByType } = require("../../utils/traverse-parent-by-type");
+
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Forbids useless calls of `sample` and `guard`",
+      category: "Quality",
+      recommended: true,
+    },
+    messages: {
+      uselessMethod:
+        "Method `{{ methodName }}` does nothing in this case. You should assign the result to variable or pass `target` to it.",
+    },
+    schema: [],
+  },
+  create(context) {
+    const importedFromEffector = new Map();
+
+    return {
+      ImportDeclaration(node) {
+        extractImportedFromEffector(importedFromEffector, node);
+      },
+      CallExpression(node) {
+        const POSSIBLE_USELESS_METHODS = ["sample", "guard"];
+        for (const method of POSSIBLE_USELESS_METHODS) {
+          const localMethod = importedFromEffector.get(method);
+          if (!localMethod) {
+            continue;
+          }
+
+          const isEffectorMethod = node?.callee?.name === localMethod;
+          if (!isEffectorMethod) {
+            continue;
+          }
+
+          const resultAssignedInVariable = traverseParentByType(
+            node,
+            "VariableDeclarator"
+          );
+          if (resultAssignedInVariable) {
+            continue;
+          }
+
+          const resultReturnedFromFactory = traverseParentByType(
+            node,
+            "ReturnStatement"
+          );
+          if (resultReturnedFromFactory) {
+            continue;
+          }
+
+          const resultPartOfChain = traverseParentByType(
+            node,
+            "ObjectExpression"
+          );
+          if (resultPartOfChain) {
+            continue;
+          }
+
+          const configHasTarget = node?.arguments?.[0]?.properties?.some(
+            (prop) => prop?.key.name === "target"
+          );
+          if (configHasTarget) {
+            continue;
+          }
+
+          context.report({
+            node,
+            messageId: "uselessMethod",
+            data: {
+              methodName: node?.callee?.name,
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/rules/no-useless-methods/no-useless-methods.md

@@ -0,0 +1,14 @@
+# effector/no-useless-methods
+
+Call of `gaurd`/`sample` without `target` or variable assignment is useless. It can be omitted from source code.
+
+```ts
+// 👎 can be omitted
+guard({ clock: trigger, filter: Boolean });
+
+// 👍 makes sense
+const target1 = guard({ clock: trigger, filter: Boolean });
+
+// 👍 make sense too
+guard({ clock: trigger, filter: Boolean, target: target2 });
+```

package/rules/prefer-sample-over-forward-with-mapping/prefer-sample-over-forward-with-mapping.js

@@ -0,0 +1,95 @@
+const {
+  extractImportedFromEffector,
+} = require("../../utils/extract-imported-from-effector");
+const {
+  traverseNestedObjectNode,
+} = require("../../utils/traverse-nested-object-node");
+
+module.exports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Prefer `sample` over `forward` with `.map`/`.prepend`",
+      category: "Quality",
+      recommended: true,
+    },
+    messages: {
+      overMap:
+        "Instead of `forward` with `{{ eventName }}.map` you can use `sample`",
+      overPrepend:
+        "Instead of `forward` with `{{ eventName }}.prepend` you can use `sample`",
+    },
+    schema: [],
+  },
+  create(context) {
+    const importedFromEffector = new Map();
+
+    return {
+      ImportDeclaration(node) {
+        extractImportedFromEffector(importedFromEffector, node);
+      },
+      CallExpression(node) {
+        const localMethod = importedFromEffector.get("forward");
+        if (!localMethod) {
+          return;
+        }
+
+        const isEffectorMethod = node?.callee?.name === localMethod;
+        if (!isEffectorMethod) {
+          return;
+        }
+
+        const forwardConfig = {
+          from: node.arguments?.[0]?.properties.find(
+            (n) => n.key?.name === "from"
+          ),
+          to: node.arguments?.[0]?.properties.find((n) => n.key?.name === "to"),
+        };
+
+        if (!forwardConfig.from || !forwardConfig.to) {
+          return;
+        }
+
+        function checkForMapping({ paramNode, methodName, messageId }) {
+          if (paramNode.value?.type !== "CallExpression") {
+            return;
+          }
+
+          if (paramNode.value?.callee?.property?.name !== methodName) {
+            return;
+          }
+
+          const eventNode = traverseNestedObjectNode(
+            paramNode.value?.callee?.object
+          );
+          const eventName = eventNode?.name;
+
+          if (!eventName) {
+            return;
+          }
+
+          // console.log(eventName);
+
+          context.report({
+            node,
+            messageId,
+            data: {
+              eventName,
+            },
+          });
+        }
+
+        checkForMapping({
+          paramNode: forwardConfig.from,
+          methodName: "map",
+          messageId: "overMap",
+        });
+        checkForMapping({
+          paramNode: forwardConfig.to,
+          methodName: "prepend",
+          messageId: "overPrepend",
+        });
+      },
+    };
+  },
+};

package/rules/prefer-sample-over-forward-with-mapping/prefer-sample-over-forward-with-mapping.md

@@ -0,0 +1,27 @@
+# effector/prefer-sample-over-forward-with-mapping
+
+Prefer `sample` over `forward` with `.map`/`.prepend`.
+
+```js
+const eventOne = createEvent();
+const eventTwo = createEvent();
+
+// 👎 looks weird
+forward({
+  from: eventOne.map((items) => items.length),
+  to: eventTwo,
+});
+
+// 👎 weird too
+forward({
+  from: eventOne,
+  to: eventTwo.prepend((items) => items.length),
+});
+
+// 👍 better
+sample({
+  source: eventOne,
+  fn: (items) => items.length,
+  target: eventTwo,
+});
+```

package/utils/are-nodes-same-in-text.js

@@ -0,0 +1,22 @@
+const prettier = require("prettier");
+
+function areNodesSameInText({ context, nodes }) {
+  const texts = nodes.map((node) => {
+    let sourceText = context.getSourceCode().getText(node);
+
+    const shouldBeWrapped =
+      sourceText.startsWith("{") && sourceText.endsWith("}");
+
+    if (shouldBeWrapped) {
+      sourceText = `(${sourceText})`;
+    }
+
+    return prettier.format(sourceText, {
+      parser: "babel-ts",
+    });
+  });
+
+  return texts.every((text) => text === texts[0]);
+}
+
+module.exports = { areNodesSameInText };

package/utils/get-corrected-store-name.js

@@ -0,0 +1,23 @@
+const { getStoreNameConvention } = require("./get-store-name-convention");
+
+function getCorrectedStoreName(storeName, context) {
+    const storeNameConvention = getStoreNameConvention(context);
+
+    // handle edge case
+    if (storeName.startsWith("$") && storeName.endsWith("$")) {
+
+        if (storeNameConvention === "prefix") {
+            return `$${storeName.slice(0, -1)}`;
+        } else {
+            return `${storeName.slice(1)}$`;
+        }
+    }
+
+    const correctedStoreName = storeNameConvention === "prefix"
+        ? `$${storeName}`
+        : `${storeName}$`;
+
+    return correctedStoreName;
+}
+
+module.exports = { getCorrectedStoreName };

package/utils/get-store-name-convention.js

@@ -0,0 +1,6 @@
+function getStoreNameConvention(context) {
+    // prefix convention is default
+    return context.settings.effector?.storeNameConvention || "prefix";
+}
+
+module.exports = { getStoreNameConvention };

package/utils/is-store-name-valid.js

@@ -0,0 +1,22 @@
+const { getStoreNameConvention } = require("./get-store-name-convention");
+
+function isStoreNameValid(storeName, context) {
+    const storeNameConvention = getStoreNameConvention(context);
+
+    // validate edge case
+    if (storeName?.startsWith("$") && storeName?.endsWith("$")) {
+        return false
+    }
+
+    if (storeNameConvention === "prefix" && storeName?.startsWith("$")) {
+        return true;
+    }
+
+    if (storeNameConvention === "postfix" && storeName?.endsWith("$")) {
+        return true;
+    }
+
+    return false;
+}
+
+module.exports = { isStoreNameValid };

package/utils/traverse-nested-object-node.js

@@ -0,0 +1,9 @@
+function traverseNestedObjectNode(node) {
+  if (node.type === "MemberExpression") {
+    return traverseNestedObjectNode(node.property);
+  }
+
+  return node;
+}
+
+module.exports = { traverseNestedObjectNode };

package/utils/traverse-parent-by-type.js

@@ -0,0 +1,13 @@
+function traverseParentByType(node, type) {
+  if (!node) {
+    return null;
+  }
+
+  if (node.type === type) {
+    return node;
+  }
+
+  return traverseParentByType(node.parent, type);
+}
+
+module.exports = { traverseParentByType };

package/utils/validate-store-name-convention.js

@@ -0,0 +1,13 @@
+const { getStoreNameConvention } = require("./get-store-name-convention");
+
+function validateStoreNameConvention(context) {
+    const storeNameConvention = getStoreNameConvention(context);
+
+    if (storeNameConvention !== "prefix" && storeNameConvention !== "postfix") {
+        throw new Error(
+            "Invalid Configuration of effector-plugin-eslint/enforce-store-naming-convention. The value should be equal to prefix or postfix."
+        );
+    }
+}
+
+module.exports = { validateStoreNameConvention };

package/coverage/lcov-report/base.css

@@ -1,224 +0,0 @@
-body, html {
-  margin:0; padding: 0;
-  height: 100%;
-}
-body {
-    font-family: Helvetica Neue, Helvetica, Arial;
-    font-size: 14px;
-    color:#333;
-}
-.small { font-size: 12px; }
-*, *:after, *:before {
-  -webkit-box-sizing:border-box;
-     -moz-box-sizing:border-box;
-          box-sizing:border-box;
-  }
-h1 { font-size: 20px; margin: 0;}
-h2 { font-size: 14px; }
-pre {
-    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
-    margin: 0;
-    padding: 0;
-    -moz-tab-size: 2;
-    -o-tab-size:  2;
-    tab-size: 2;
-}
-a { color:#0074D9; text-decoration:none; }
-a:hover { text-decoration:underline; }
-.strong { font-weight: bold; }
-.space-top1 { padding: 10px 0 0 0; }
-.pad2y { padding: 20px 0; }
-.pad1y { padding: 10px 0; }
-.pad2x { padding: 0 20px; }
-.pad2 { padding: 20px; }
-.pad1 { padding: 10px; }
-.space-left2 { padding-left:55px; }
-.space-right2 { padding-right:20px; }
-.center { text-align:center; }
-.clearfix { display:block; }
-.clearfix:after {
-  content:'';
-  display:block;
-  height:0;
-  clear:both;
-  visibility:hidden;
-  }
-.fl { float: left; }
-@media only screen and (max-width:640px) {
-  .col3 { width:100%; max-width:100%; }
-  .hide-mobile { display:none!important; }
-}
-
-.quiet {
-  color: #7f7f7f;
-  color: rgba(0,0,0,0.5);
-}
-.quiet a { opacity: 0.7; }
-
-.fraction {
-  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
-  font-size: 10px;
-  color: #555;
-  background: #E8E8E8;
-  padding: 4px 5px;
-  border-radius: 3px;
-  vertical-align: middle;
-}
-
-div.path a:link, div.path a:visited { color: #333; }
-table.coverage {
-  border-collapse: collapse;
-  margin: 10px 0 0 0;
-  padding: 0;
-}
-
-table.coverage td {
-  margin: 0;
-  padding: 0;
-  vertical-align: top;
-}
-table.coverage td.line-count {
-    text-align: right;
-    padding: 0 5px 0 20px;
-}
-table.coverage td.line-coverage {
-    text-align: right;
-    padding-right: 10px;
-    min-width:20px;
-}
-
-table.coverage td span.cline-any {
-    display: inline-block;
-    padding: 0 5px;
-    width: 100%;
-}
-.missing-if-branch {
-    display: inline-block;
-    margin-right: 5px;
-    border-radius: 3px;
-    position: relative;
-    padding: 0 4px;
-    background: #333;
-    color: yellow;
-}
-
-.skip-if-branch {
-    display: none;
-    margin-right: 10px;
-    position: relative;
-    padding: 0 4px;
-    background: #ccc;
-    color: white;
-}
-.missing-if-branch .typ, .skip-if-branch .typ {
-    color: inherit !important;
-}
-.coverage-summary {
-  border-collapse: collapse;
-  width: 100%;
-}
-.coverage-summary tr { border-bottom: 1px solid #bbb; }
-.keyline-all { border: 1px solid #ddd; }
-.coverage-summary td, .coverage-summary th { padding: 10px; }
-.coverage-summary tbody { border: 1px solid #bbb; }
-.coverage-summary td { border-right: 1px solid #bbb; }
-.coverage-summary td:last-child { border-right: none; }
-.coverage-summary th {
-  text-align: left;
-  font-weight: normal;
-  white-space: nowrap;
-}
-.coverage-summary th.file { border-right: none !important; }
-.coverage-summary th.pct { }
-.coverage-summary th.pic,
-.coverage-summary th.abs,
-.coverage-summary td.pct,
-.coverage-summary td.abs { text-align: right; }
-.coverage-summary td.file { white-space: nowrap;  }
-.coverage-summary td.pic { min-width: 120px !important;  }
-.coverage-summary tfoot td { }
-
-.coverage-summary .sorter {
-    height: 10px;
-    width: 7px;
-    display: inline-block;
-    margin-left: 0.5em;
-    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
-}
-.coverage-summary .sorted .sorter {
-    background-position: 0 -20px;
-}
-.coverage-summary .sorted-desc .sorter {
-    background-position: 0 -10px;
-}
-.status-line {  height: 10px; }
-/* yellow */
-.cbranch-no { background: yellow !important; color: #111; }
-/* dark red */
-.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
-.low .chart { border:1px solid #C21F39 }
-.highlighted,
-.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
-  background: #C21F39 !important;
-}
-/* medium red */
-.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
-/* light red */
-.low, .cline-no { background:#FCE1E5 }
-/* light green */
-.high, .cline-yes { background:rgb(230,245,208) }
-/* medium green */
-.cstat-yes { background:rgb(161,215,106) }
-/* dark green */
-.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
-.high .chart { border:1px solid rgb(77,146,33) }
-/* dark yellow (gold) */
-.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
-.medium .chart { border:1px solid #f9cd0b; }
-/* light yellow */
-.medium { background: #fff4c2; }
-
-.cstat-skip { background: #ddd; color: #111; }
-.fstat-skip { background: #ddd; color: #111 !important; }
-.cbranch-skip { background: #ddd !important; color: #111; }
-
-span.cline-neutral { background: #eaeaea; }
-
-.coverage-summary td.empty {
-    opacity: .5;
-    padding-top: 4px;
-    padding-bottom: 4px;
-    line-height: 1;
-    color: #888;
-}
-
-.cover-fill, .cover-empty {
-  display:inline-block;
-  height: 12px;
-}
-.chart {
-  line-height: 0;
-}
-.cover-empty {
-    background: white;
-}
-.cover-full {
-    border-right: none !important;
-}
-pre.prettyprint {
-    border: none !important;
-    padding: 0 !important;
-    margin: 0 !important;
-}
-.com { color: #999 !important; }
-.ignore-none { color: #999; font-weight: normal; }
-
-.wrapper {
-  min-height: 100%;
-  height: auto !important;
-  height: 100%;
-  margin: 0 auto -48px;
-}
-.footer, .push {
-  height: 48px;
-}

package/coverage/lcov-report/block-navigation.js

@@ -1,79 +0,0 @@
-/* eslint-disable */
-var jumpToCode = (function init() {
-    // Classes of code we would like to highlight in the file view
-    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
-
-    // Elements to highlight in the file listing view
-    var fileListingElements = ['td.pct.low'];
-
-    // We don't want to select elements that are direct descendants of another match
-    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
-
-    // Selecter that finds elements on the page to which we can jump
-    var selector =
-        fileListingElements.join(', ') +
-        ', ' +
-        notSelector +
-        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
-
-    // The NodeList of matching elements
-    var missingCoverageElements = document.querySelectorAll(selector);
-
-    var currentIndex;
-
-    function toggleClass(index) {
-        missingCoverageElements
-            .item(currentIndex)
-            .classList.remove('highlighted');
-        missingCoverageElements.item(index).classList.add('highlighted');
-    }
-
-    function makeCurrent(index) {
-        toggleClass(index);
-        currentIndex = index;
-        missingCoverageElements.item(index).scrollIntoView({
-            behavior: 'smooth',
-            block: 'center',
-            inline: 'center'
-        });
-    }
-
-    function goToPrevious() {
-        var nextIndex = 0;
-        if (typeof currentIndex !== 'number' || currentIndex === 0) {
-            nextIndex = missingCoverageElements.length - 1;
-        } else if (missingCoverageElements.length > 1) {
-            nextIndex = currentIndex - 1;
-        }
-
-        makeCurrent(nextIndex);
-    }
-
-    function goToNext() {
-        var nextIndex = 0;
-
-        if (
-            typeof currentIndex === 'number' &&
-            currentIndex < missingCoverageElements.length - 1
-        ) {
-            nextIndex = currentIndex + 1;
-        }
-
-        makeCurrent(nextIndex);
-    }
-
-    return function jump(event) {
-        switch (event.which) {
-            case 78: // n
-            case 74: // j
-                goToNext();
-                break;
-            case 66: // b
-            case 75: // k
-            case 80: // p
-                goToPrevious();
-                break;
-        }
-    };
-})();
-window.addEventListener('keydown', jumpToCode);