eslint-plugin-path-checker-relative 0.0.6 → 0.0.8

package/lib/rules/layer-imports.js

@@ -0,0 +1,115 @@
+/**
+ * @fileoverview fix slice layer
+ * @author layer-imports
+ */
+"use strict";
+const path = require("path");
+const isPathRelative = require("../helpers");
+const micromatch = require("micromatch");
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "fix slice layer",
+      recommended: false,
+      url: null, // URL to the documentation page for this rule
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [
+      {
+        type: "object",
+        properties: {
+          alias: {
+            type: "string",
+          },
+          testFilesPattern: {
+            type: "array",
+          },
+        },
+      },
+    ], // Add a schema if the rule has options
+    messages: {
+      "Слой может импортировать в себя только нижележащие слои (shared, entities, features, widgets, pages, app)":
+        "Слой может импортировать в себя только нижележащие слои (shared, entities, features, widgets, pages, app)",
+    }, // Add messageId and message
+  },
+
+  create(context) {
+    const layers = {
+      app: ["pages", "widgets", "features", "shared", "entities"],
+      pages: ["widgets", "features", "shared", "entities"],
+      widgets: ["features", "shared", "entities"],
+      features: ["shared", "entities"],
+      entities: ["shared", "entities"],
+      shared: ["shared"],
+    };
+
+    const availableLayers = {
+      app: "app",
+      entities: "entities",
+      features: "features",
+      pages: "pages",
+      shared: "shared",
+      widgets: "widgets",
+    };
+
+    const { alias = "", ignoreImportPatterns = [] } = context.options[0] ?? {};
+
+    const getCurrentFileLayer = () => {
+      const currentFile = context.filename;
+
+      const normalizedPath = path.toNamespacedPath(currentFile);
+      const projectPath = normalizedPath?.split("src")[1];
+
+      const segment = projectPath?.split("/");
+
+      return segment?.[1];
+    };
+
+    const getImportLayer = (value) => {
+      const importPath = alias ? value.replace(`${alias}/`, "") : value;
+      const segment = importPath?.split("/");
+      return segment?.[0];
+    };
+
+    return {
+      ImportDeclaration(node) {
+        const importPath = node.source.value;
+        const currentFileLayer = getCurrentFileLayer();
+        const importLayer = getImportLayer(importPath);
+
+        if (isPathRelative(importPath)) {
+          return;
+        }
+
+        if (
+          !availableLayers[importLayer] ||
+          !availableLayers[currentFileLayer]
+        ) {
+          return;
+        }
+
+        const isIgnored = ignoreImportPatterns.some((pattern) =>
+          micromatch.isMatch(importPath, pattern)
+        );
+
+        if (isIgnored) {
+          return;
+        }
+
+        if (!layers[currentFileLayer]?.includes(importLayer)) {
+          context.report({
+            node: node,
+            messageId:
+              "Слой может импортировать в себя только нижележащие слои (shared, entities, features, widgets, pages, app)",
+          });
+        }
+      },
+    };
+  },
+};

package/lib/rules/path-checker.js

@@ -52,7 +52,7 @@ module.exports = {
 
 const layers = {
   'entities': 'entities',
-  'feature': 'feature',
+  'features': 'features',
   'pages': 'pages',
   'shared': 'shared',
   'widgets': 'widgets',

package/lib/rules/public-api-imports.js

@@ -7,6 +7,7 @@
 const path = require("path");
 
 const isPathRelative = require("../helpers");
+const micromatch = require("micromatch");
 
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
@@ -25,17 +26,22 @@ module.exports = {
           alias: {
             type: "string",
           },
+          testFilesPattern: {
+            type: "array",
+          },
         },
       },
     ],
     messages: {
       "Абсолютный импорт разрешен только из Public API (index.ts)":
         "Абсолютный импорт разрешен только из Public API (index.ts)",
+      "Тестовые данные необходимо импортировать из publicApi/testing.ts":
+        "Тестовые данные необходимо импортировать из publicApi/testing.ts",
     },
   },
 
   create(context) {
-    const alias = context.options[0]?.alias || "";
+    const { alias = "", testFilesPattern = [] } = context.options[0] ?? {};
 
     const checkingLayers = {
       entities: "entities",
@@ -63,13 +69,32 @@ module.exports = {
 
         const isImportNotFromPublicApi = segment.length > 2;
 
-        if (isImportNotFromPublicApi) {
+        const isTestingPublicApi =
+          segment[2] === "testing" && segment.length < 4;
+
+        if (isImportNotFromPublicApi && !isTestingPublicApi) {
           context.report({
             node,
             messageId:
               "Абсолютный импорт разрешен только из Public API (index.ts)",
           });
         }
+
+        if (isTestingPublicApi) {
+          const currentFilePath = context.filename;
+
+          const isCurrentFileTesting = testFilesPattern.some((pattern) =>
+            micromatch.isMatch(currentFilePath, pattern)
+          );
+
+          if (!isCurrentFileTesting) {
+            context.report({
+              node,
+              messageId:
+                "Тестовые данные необходимо импортировать из publicApi/testing.ts",
+            });
+          }
+        }
       },
     };
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-path-checker-relative",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "plugin for production project",
   "keywords": [
     "eslint",
@@ -21,6 +21,7 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
+    "micromatch": "^4.0.8",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {