eslint-plugin-zozu-plugin 0.0.4 → 0.0.6

package/lib/rules/layer-imports.js

@@ -0,0 +1,97 @@
+"use strict";
+
+const path = require('path');
+const {isPathRelative} = require('../helpers');
+const micromatch = require("micromatch");
+
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "description",
+      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',
+          },
+          ignoreFilesPatterns: {
+            type: 'array',
+          }
+        }
+      }
+    ],
+    messages: {}, // 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',
+      'shared': 'shared',
+      'pages': 'pages',
+      'widgets': 'widgets',
+    }
+    const {alias = '', ignoreImportPatterns = []} = context.options[0] ?? {};
+
+    const getCurrentFileLayer = () => {
+      const currentFilePath = context.getFilename();
+
+      const normalizedPath = path.toNamespacedPath(currentFilePath);
+      const projectPath = normalizedPath?.split('src')[1];
+      const segments = projectPath?.split('\\');
+
+      return segments?.[1];
+    }
+
+    const getImportLayer = (value) => {
+      const importPath = alias ? value.replace(`${alias}/`, '') : value;
+      const segments = importPath?.split('/');
+
+      return segments?.[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 => {
+          return micromatch.isMatch(importPath, pattern);
+        });
+
+        if (isIgnored) {
+          return;
+        }
+
+        if (!layers[currentFileLayer]?.includes(importLayer)) {
+          context.report({node: node, message: 'Слой может импортировать в себя только нижележащие слои (shared, enities, features, widgets, pages, app'});
+        }
+      }
+    };
+  },
+};

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

@@ -1,6 +1,7 @@
 "use strict";
 
 const {isPathRelative} = require('../helpers');
+const micromatch = require("micromatch");
 
 module.exports = {
   meta: {
@@ -17,6 +18,9 @@ module.exports = {
         properties: {
           alias: {
             type: 'string',
+          },
+          testFilesPatterns: {
+            type: 'array',
           }
         }
       }
@@ -25,7 +29,7 @@ module.exports = {
   },
 
   create(context) {
-    const alias = context.options[0]?.alias || '';
+    const {alias = '', testFilesPatterns = []} = context.options[0] ?? {};
 
     const checkingLayers = {
       'entities': 'entities',
@@ -54,9 +58,21 @@ module.exports = {
         }
         const isImportNotFromPublicApi = segments.length > 2;
 
-        if (isImportNotFromPublicApi) {
+        const isTestingPublicApi = segments[2] === 'testing' && segments.length < 4;
+
+        if (isImportNotFromPublicApi && !isTestingPublicApi) {
           context.report({node: node, message: 'Абсолютный импорт разрешен только из Public API (index.ts)'});
         }
+
+        if (isTestingPublicApi) {
+          const currentFilePath = context.getFilename();
+          const isCurrentFileTesting = testFilesPatterns.some(
+            pattern => micromatch.isMatch(currentFilePath, pattern)
+          )
+          if (!isCurrentFileTesting) {
+            context.report({node: node, message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'});
+          }
+        }
       }
     };
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-zozu-plugin",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "plugin for my pet project",
   "keywords": [
     "eslint",
@@ -21,11 +21,12 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
+    "micromatch": "^4.0.8",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^9.0.0",
     "@eslint/js": "^9.0.0",
+    "eslint": "^9.0.0",
     "eslint-doc-generator": "^2.0.0",
     "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-n": "^17.0.0",