eslint-plugin-effector 0.3.1 → 0.5.0

package/utils/extract-imported-from.js

@@ -0,0 +1,9 @@
+function extractImportedFrom({ importMap, node, packageName }) {
+  if (node.source.value === packageName) {
+    for (const s of node.specifiers) {
+      importMap.set(s.imported.name, s.local.name);
+    }
+  }
+}
+
+module.exports = { extractImportedFrom };

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

@@ -1,23 +1,21 @@
 const { getStoreNameConvention } = require("./get-store-name-convention");
 
 function getCorrectedStoreName(storeName, context) {
-    const storeNameConvention = getStoreNameConvention(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)}$`;
-        }
+  // 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}$`;
+  const correctedStoreName =
+    storeNameConvention === "prefix" ? `$${storeName}` : `${storeName}$`;
 
-    return correctedStoreName;
+  return correctedStoreName;
 }
 
-module.exports = { getCorrectedStoreName };
+module.exports = { getCorrectedStoreName };

package/utils/get-nested-object-name.js

@@ -0,0 +1,18 @@
+function getNestedObjectName(node) {
+  let root = node;
+  let name = "";
+
+  while (root.type === "MemberExpression") {
+    name = `${root.property.name}.${name}`;
+    root = root.object;
+  }
+
+  if (root.type === "Identifier") {
+    name = `${root.name}.${name}`;
+  }
+
+  // Remove last dot
+  return name.slice(0, -1);
+}
+
+module.exports = { getNestedObjectName };

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

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

package/utils/is.js

@@ -0,0 +1,30 @@
+const { nodeTypeIs } = require("./node-type-is");
+const { namingOf } = require("./naming");
+
+function isSomething({ isValidNaming, isTypeCorrect }) {
+  return ({ node, context }) => {
+    if (context.parserServices.hasFullTypeInformation) {
+      return isTypeCorrect({ node, context });
+    }
+
+    return isValidNaming({ name: node?.name ?? node?.id?.name, context });
+  };
+}
+
+const isStore = isSomething({
+  isTypeCorrect: nodeTypeIs.store,
+  isValidNaming: namingOf.store.isValid,
+});
+
+const isEffect = isSomething({
+  isTypeCorrect: nodeTypeIs.effect,
+  isValidNaming: namingOf.effect.isValid,
+});
+
+const is = {
+  store: (opts) => isStore(opts),
+  effect: (opts) => isEffect(opts),
+  not: { store: (opts) => !isStore(opts), effect: (opts) => !isEffect(opts) },
+};
+
+module.exports = { is };

package/utils/naming.js

@@ -0,0 +1,47 @@
+const { getStoreNameConvention } = require("./get-store-name-convention");
+
+function isEffectNameValid({ name }) {
+  return Boolean(name?.endsWith("Fx"));
+}
+
+function isGateNameValid({ name }) {
+  const [firstChar] = name.split("");
+
+  return Boolean(firstChar?.toUpperCase() === firstChar);
+}
+
+function isStoreNameValid({ name, context }) {
+  const storeNameConvention = getStoreNameConvention(context);
+
+  // validate edge case
+  if (name?.startsWith("$") && name?.endsWith("$")) {
+    return false;
+  }
+
+  if (storeNameConvention === "prefix" && name?.startsWith("$")) {
+    return true;
+  }
+
+  if (storeNameConvention === "postfix" && name?.endsWith("$")) {
+    return true;
+  }
+
+  return false;
+}
+
+const namingOf = {
+  effect: {
+    isValid: (opts) => isEffectNameValid(opts),
+    isInvalid: (opts) => !isEffectNameValid(opts),
+  },
+  store: {
+    isValid: (opts) => isStoreNameValid(opts),
+    isInvalid: (opts) => !isStoreNameValid(opts),
+  },
+  gate: {
+    isValid: (opts) => isGateNameValid(opts),
+    isInvalid: (opts) => !isGateNameValid(opts),
+  },
+};
+
+module.exports = { namingOf };

package/utils/node-type-is.js

@@ -0,0 +1,55 @@
+function hasType({ node, possibleTypes, context, from }) {
+  const checker = context.parserServices.program.getTypeChecker();
+  const originalNode = context.parserServices.esTreeNodeToTSNodeMap.get(node);
+  const type = checker.getTypeAtLocation(
+    originalNode?.initializer ?? originalNode
+  );
+
+  const symbol = type?.symbol ?? type?.aliasSymbol;
+
+  return (
+    possibleTypes.includes(symbol?.escapedName) &&
+    Boolean(symbol?.parent?.escapedName?.includes(from))
+  );
+}
+
+const nodeTypeIs = {
+  effect: (opts) =>
+    hasType({ ...opts, possibleTypes: ["Effect"], from: "effector" }),
+  store: (opts) =>
+    hasType({ ...opts, possibleTypes: ["Store"], from: "effector" }),
+  event: (opts) =>
+    hasType({ ...opts, possibleTypes: ["Event"], from: "effector" }),
+  unit: (opts) =>
+    hasType({
+      ...opts,
+      possibleTypes: ["Effect", "Store", "Event"],
+      from: "effector",
+    }),
+  gate: (opts) =>
+    hasType({ ...opts, possibleTypes: ["Gate"], from: "effector-react" }),
+  not: {
+    effect: (opts) =>
+      !hasType({
+        ...opts,
+        possibleTypes: ["Effect"],
+        from: "effector",
+      }),
+    store: (opts) =>
+      !hasType({ ...opts, possibleTypes: ["Store"], from: "effector" }),
+    event: (opts) =>
+      !hasType({ ...opts, possibleTypes: ["Event"], from: "effector" }),
+    unit: (opts) =>
+      !hasType({
+        ...opts,
+        possibleTypes: ["Effect", "Store", "Event"],
+        from: "effector",
+      }),
+    gate: (opts) =>
+      !hasType({ ...opts, possibleTypes: ["Gate"], from: "effector-react" }),
+  },
+};
+
+module.exports = {
+  nodeTypeIs,
+};

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

@@ -1,13 +1,13 @@
 const { getStoreNameConvention } = require("./get-store-name-convention");
 
 function validateStoreNameConvention(context) {
-    const storeNameConvention = getStoreNameConvention(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."
-        );
-    }
+  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 };
+module.exports = { validateStoreNameConvention };

package/.github/workflows/ci.yml

@@ -1,43 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
-
-jobs:
-  checks:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [14.x, 16.x]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "yarn"
-      - run: yarn install
-      - run: yarn test --coverage
-
-  reports:
-    runs-on: ubuntu-latest
-
-    if: ${{ github.event_name == 'pull_request' }}
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js
-        uses: actions/setup-node@v2
-        with:
-          cache: "yarn"
-      - run: yarn install
-      - run: yarn test --coverage
-      - name: Code Coverage Report
-        uses: romeovs/lcov-reporter-action@v0.2.11
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-## v0.3.1
-
-- Fixed false-positive in `no-ambiguity-target` with factories ([PR #50](https://github.com/effector/eslint-plugin/pull/50))
-
-## v0.3.0
-
-- Add new rule: `no-useless-methods` ([PR #41](https://github.com/effector/eslint-plugin/pull/41))
-- Add new rule: `no-ambiguity-target` ([PR #42](https://github.com/effector/eslint-plugin/pull/42))
-- Add possibility to configure store's naming convention — suffix of prefix ([PR #37](https://github.com/effector/eslint-plugin/pull/37) by @ilyaryabchinski)
-
-## v0.2.0
-
-- Add tests against Effector 22
-- Specify supported Node.JS versions
-- Add new rule: `prefer-sample-over-forward-with-mapping` ([PR #34](https://github.com/igorkamyshev/eslint-plugin-effector/pull/34))
-
-## v0.1.4
-
-- Exclude test-coverage report from npm-package
-- Fixed SyntaxError in `no-unnecessary-duplication` suggestions ([PR #28](https://github.com/igorkamyshev/eslint-plugin-effector/pull/28))
-
-## v0.1.3
-
-- Fixed false-positive in `no-unnecessary-duplication` with composite `clock`/`source` ([PR #22](https://github.com/igorkamyshev/eslint-plugin-effector/pull/22))
-- Fixed TypeError in `enforce-store-naming-convention` ([PR #25](https://github.com/igorkamyshev/eslint-plugin-effector/pull/25))
-- Fixed false-positive in `enforce-effect-naming-convention` with `combine` ([PR #26](https://github.com/igorkamyshev/eslint-plugin-effector/pull/26))

package/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  testRegex: "./.+\\.test\\.js$",
-  collectCoverage: false,
-  collectCoverageFrom: ["rules/**/{!(examples),}/*.js"],
-  moduleFileExtensions: ["js"],
-  coverageReporters: ["text-summary", "lcov"],
-};

package/utils/extract-imported-from-effector.js

@@ -1,8 +0,0 @@
-function extractImportedFromEffector(importedFromEffector, node) {
-  if (node.source.value === "effector") {
-    for (const s of node.specifiers) {
-      importedFromEffector.set(s.imported.name, s.local.name);
-    }
-  }
-}
-module.exports = { extractImportedFromEffector };

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

@@ -1,22 +0,0 @@
-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 };