@sj_lk/eslint-plugin-sj-plugin 0.1.4 → 0.1.6

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,111 @@
+/**
+ * @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 => {
+          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

@@ -13,7 +13,7 @@ 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`
     schema: [
       {
         type: 'object',
@@ -56,6 +56,7 @@ module.exports = {
         const segments = importTo.split('/')
         
         const layer = segments[0]
+        const slice = segments[1]
 
         if(!allowedLayers[layer]) {
             return;          
@@ -68,6 +69,9 @@ module.exports = {
           context.report({
             node, 
             messageId: 'importProblem',
+            fix: (fixer) => {
+              return fixer.replaceText(node.source, `'${alias}/${layer}/${slice}'`)
+            }
           })
         }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sj_lk/eslint-plugin-sj-plugin",
-  "version": "0.1.4",
-  "description": "add import validation for testing files",
+  "version": "0.1.6",
+  "description": "add feature sliced relative path checker, validator for layers imports and absolute imports from a public API",
   "keywords": [
     "eslint",
     "eslintplugin",