eslint-plugin-fsd-paths-check 0.0.9 → 0.0.10

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

@@ -19,7 +19,7 @@ module.exports = {
       recommended: false,
       url: null,
     },
-    fixable: true,
+    fixable: `code`,
     schema: [{
       type: `object`,
       properties: {

package/lib/rules/forbid-imports-from-upper-slices.js

@@ -0,0 +1,109 @@
+"use strict";
+
+const path = require("path");
+const {isPathRelative} = require("../helpers/isPathRelative");
+const micromatch = require("micromatch");
+
+const fsdLayers = {
+  'shared': 'shared',
+  'entities': 'entities',
+  'features': 'features',
+  'widgets': 'widgets',
+  'pages': 'pages',
+  'app': 'app'
+}
+
+const allowedLayerImports = {
+  app: ['pages', 'widgets', 'features', 'entities', 'shared'],
+  pages: ['widgets', 'features', 'entities', 'shared'],
+  widgets: ['features', 'entities', 'shared'],
+  features: ['entities', 'shared'],
+  entities: ['entities', 'shared'],
+  shared: ['shared'],
+}
+
+module.exports = {
+  meta: {
+    type: `suggestion`,
+    docs: {
+      description: "Rule, which forbids imports from upper fsd slices",
+      recommended: false,
+      url: null,
+    },
+    fixable: null,
+    schema: [
+      {
+        type: `object`,
+        properties: {
+          alias: {
+            type: `string`,
+          },
+          ignoreImportPatterns: {
+            type: `array`,
+          }
+        }
+      }
+    ],
+    messages: {
+      doNotImportFromUpperFSDLayers: `Imports from upper FSD layers are prohibited`
+    },
+  },
+
+  create(context) {
+    return {
+      ImportDeclaration: importExportDeclaration(context),
+      ExportNamedDeclaration: importExportDeclaration(context),
+    };
+  },
+};
+
+const importExportDeclaration = (context) => (node) => {
+  const { alias = '', ignoreImportPatterns = [] } = context.options[0] ?? {};
+
+  const getCurrentFileLayer = (currentFilePath) => {
+    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];
+  }
+
+  if(!node.source) {
+    return;
+  }
+
+  const currentFilePath = context.getFilename();
+  const importPath = node.source.value;
+  const currentFileLayer = getCurrentFileLayer(currentFilePath);
+  const importLayer = getImportLayer(importPath);
+
+  if(isPathRelative(importPath)) {
+    return;
+  }
+
+  if(!fsdLayers[importLayer] || !fsdLayers[currentFileLayer]) {
+    return;
+  }
+
+  const isIgnored = ignoreImportPatterns.some((pattern) => {
+    return micromatch.isMatch(importPath, pattern);
+  })
+
+  if(isIgnored) {
+    return;
+  }
+
+  if(!allowedLayerImports[currentFileLayer].includes(importLayer)) {
+    context.report({
+      node,
+      messageId: `doNotImportFromUpperFSDLayers`
+    })
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-fsd-paths-check",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "Plugin to check feature sliced design paths correctness",
   "keywords": [
     "eslint",
@@ -22,11 +22,12 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
+    "micromatch": "^4.0.8",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^8.26.0",
     "@eslint/js": "^8.26.0",
+    "eslint": "^8.26.0",
     "eslint-doc-generator": "^2.0.0",
     "eslint-plugin-eslint-plugin": "^6.0.0",
     "eslint-plugin-n": "^17.0.0",