eslint-plugin-zozu-plugin 0.0.5 → 0.0.7

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

@@ -3,6 +3,10 @@
 const {isPathRelative} = require('../helpers');
 const micromatch = require("micromatch");
 
+const PUBLIC_ERROR = 'PUBLIC_ERROR';
+const TESTING_PUBLIC_ERROR = 'TESTING_PUBLIC_ERROR';
+
+
 module.exports = {
   meta: {
     type: null, // `problem`, `suggestion`, or `layout`
@@ -11,7 +15,11 @@ module.exports = {
       recommended: false,
       url: null, // URL to the documentation page for this rule
     },
-    fixable: null, // Or `code` or `whitespace`
+    fixable: 'code', // Or `code` or `whitespace`
+    messages: {
+      [PUBLIC_ERROR]: 'Абсолютный импорт разрешен только из Public API (index.ts)',
+      [TESTING_PUBLIC_ERROR]: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'
+    },
     schema: [
       {
         type: 'object',
@@ -52,6 +60,7 @@ module.exports = {
         const segments = importTo.split('/');
 
         const layer = segments[0];
+        const slice = segments[1];
 
         if(!checkingLayers[layer]) {
           return;
@@ -61,7 +70,13 @@ module.exports = {
         const isTestingPublicApi = segments[2] === 'testing' && segments.length < 4;
 
         if (isImportNotFromPublicApi && !isTestingPublicApi) {
-          context.report({node: node, message: 'Абсолютный импорт разрешен только из Public API (index.ts)'});
+          context.report({
+            node: node,
+            messageId: PUBLIC_ERROR,
+            fix: (fixer) => {
+              return fixer.replaceText(node.source, `'${alias}/${layer}/${slice}'`)
+            }
+          });
         }
 
         if (isTestingPublicApi) {
@@ -70,7 +85,7 @@ module.exports = {
             pattern => micromatch.isMatch(currentFilePath, pattern)
           )
           if (!isCurrentFileTesting) {
-            context.report({node: node, message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'});
+            context.report({node: node, messageId: TESTING_PUBLIC_ERROR});
           }
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-zozu-plugin",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "plugin for my pet project",
   "keywords": [
     "eslint",