@sj_lk/eslint-plugin-sj-plugin 0.1.3 → 0.1.5

package/lib/index.js

@@ -11,12 +11,14 @@
 
 const pathChecker = require("./rules/path-checker")
 const publicApiImports = require("./rules/public-api-imports")
+const layerImports = require("./rules/layer-imports")
 //------------------------------------------------------------------------------
 // Plugin Definition
 const plugin = {
     rules: {
         "path-checker": pathChecker,
         "public-api-imports": publicApiImports,
+        "layer-imports": layerImports
     },
 };
 //------------------------------------------------------------------------------

package/lib/rules/layer-imports.js

@@ -0,0 +1,112 @@
+/**
+ * @fileoverview description
+ * @author sj_lk
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+const path = require('path');
+const micromatch = require('micromatch')
+const { isPathRelative } = require('../helpers');
+
+module.exports = {
+  meta: {
+    type: 'suggestion', // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "valdator for layers imports",
+      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',
+            description: 'alias for the rule'
+          },
+          ignoreImportPatterns: {
+            type: 'array',
+            description: 'patterns for ignore'
+          }
+        }
+      }
+    ], defaultOptions: [{alias: ''}], // Add a schema if the rule has options
+    messages: {
+      layersImportError: 'Слой может импортировать в себя только нижележащие слои (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',
+      'shared': 'shared',
+      'pages': 'pages',
+      'widgets': 'widgets'
+    }
+
+    const { alias = '', ignoreImportPatterns = []} = context.options[0] ?? {}
+
+    const getCurrrentFileLayer = () => {
+      const currentFilePath = context.filename
+
+      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 currrentFIleLayer = getCurrrentFileLayer()
+        const importLayer = getImportLayer(importPath)
+
+        if(isPathRelative(importPath)) {
+          return
+        } 
+
+        if(!availableLayers[importLayer] || !availableLayers[currrentFIleLayer]) {
+          return
+        }
+
+        const isIgnored = ignoreImportPatterns.some(pattern => {
+          console.log(importPath, pattern)
+          return micromatch.isMatch(importPath, pattern)
+        })
+
+        if(isIgnored) {
+          return
+        }
+
+        if(!layers[currrentFIleLayer]?.includes(importLayer)) {
+          context.report({node, messageId: 'layersImportError'})
+        }
+      }
+    }
+  },
+};

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

@@ -3,6 +3,7 @@
 /** @type {import('eslint').Rule.RuleModule} */
 
 const { isPathRelative } = require('../helpers')
+const micromatch = require('micromatch')
 
 module.exports = {
   meta: {
@@ -20,17 +21,22 @@ module.exports = {
           alias: {
             type: 'string',
             description: 'alias for the rule',
+          },
+          testFilesPatterns: {
+            type: 'array',
+            description: 'patterns to match test files',
           }
         },
       }
     ], defaultOptions: [{alias: ''}],
     messages: {
-      importProblem: 'Абсолютный импорт разрешен только из Public API (index.ts)'
+      importProblem: 'Абсолютный импорт разрешен только из Public API (index.ts)',
+      testImportProblem: 'Тестовые данные необходимо импортировать из publicAPI (testing.ts)'
     },
   },
 
   create(context) {
-    const alias = context.options[0]?.alias || ''
+    const { alias = '', testFilesPatterns = []} = context.options[0] ?? {}
 
     const allowedLayers = {
       'entities': 'entities',
@@ -48,6 +54,7 @@ module.exports = {
           return;
         }
         const segments = importTo.split('/')
+        
         const layer = segments[0]
 
         if(!allowedLayers[layer]) {
@@ -55,14 +62,24 @@ module.exports = {
         }
 
         const isImportNotFromPublicApi = segments.length > 2
+        const isTestingPublicApi = segments[2] === 'testing' && segments.length < 4
 
-        if(isImportNotFromPublicApi) {
+        if(isImportNotFromPublicApi && !isTestingPublicApi) {
           context.report({
             node, 
             messageId: 'importProblem',
           })
         }
+
+        if(isTestingPublicApi) {
+          const currentFilePath = context.filename
+          const isCurrentFileTesting = testFilesPatterns.some(pattern => micromatch.isMatch(currentFilePath, pattern))
+
+          if(!isCurrentFileTesting) {
+            context.report({node, messageId: 'testImportProblem'})
+          }
+        }
       }
-    };
+    }
   },
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sj_lk/eslint-plugin-sj-plugin",
-  "version": "0.1.3",
-  "description": "fixes",
+  "version": "0.1.5",
+  "description": "add validation for layers imports",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -21,11 +21,12 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
+    "micromatch": "^4.0.8",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^10.0.0",
     "@eslint/js": "^10.0.1",
+    "eslint": "^10.0.0",
     "eslint-doc-generator": "^2.0.0",
     "eslint-plugin-eslint-plugin": "^7.3.2",
     "eslint-plugin-n": "^17.0.0",