eslint-plugin-stratified-design 0.5.1 → 0.6.0-beta

package/lib/helpers/lowerLevelImports/1 layer.js

@@ -65,6 +65,20 @@ const createModulePath = (cwd, fileDir, aliases) => {
   };
 };
 
+/**
+ * @param {*} options
+ * @param {string} fileDor
+ * @param {string} modulePath
+ */
+const isFileIndexOfModule = (options, fileDir, filePath) => (modulePath) => {
+  if (!options.isIndexHighest || parsePath(filePath).name !== "index") {
+    return false;
+  }
+  const segments = toSegments(toRelative(fileDir, modulePath));
+  if (segments.length === 2 && segments[0] === ".") return true;
+  return false;
+};
+
 /**
  * Report error about using `options.useLevelNumber`
  * @param {import('eslint').Rule.RuleContext} context
@@ -99,16 +113,20 @@ const reportHasProperLevelNumber = (context, options, rootDir, filePath) => {
       return toPath(parent);
     })();
 
-    const { moduleLevel, isInterfaceError } = (() => {
+    const { moduleLevel, isBarrierError } = (() => {
       const segments = toSegments(toRelative(parentPath, modulePath));
-      const level = extractLevel(segments[1]);
+      const moduleLevel = extractLevel(segments[1]);
+      const isBarrierError =
+        segments.length === 2
+          ? false
+          : segments.some((seg) => extractLevel(seg) !== null);
       return {
-        moduleLevel: level,
-        isInterfaceError: segments.length > 2,
+        moduleLevel,
+        isBarrierError,
       };
     })();
 
-    if (isInterfaceError) {
+    if (isBarrierError) {
       report("barrier");
       return FINISHED;
     }
@@ -218,6 +236,7 @@ module.exports = {
   createRootDir,
   parseFileSource,
   createModulePath,
+  isFileIndexOfModule,
   reportHasProperLevelNumber,
   reportInSubDirOfFileDir,
   reportHasProperLevel,

package/lib/rules/lower-level-imports.js

@@ -21,6 +21,7 @@ const {
   parseFileSource,
   createRootDir,
 } = require("../helpers/lowerLevelImports/");
+const { isFileIndexOfModule } = require("../helpers/lowerLevelImports/1 layer");
 
 //------------------------------------------------------------------------------
 // Rule Definition
@@ -89,6 +90,9 @@ module.exports = {
             useLevelNumber: {
               type: "boolean",
             },
+            isIndexHighest: {
+              type: "boolean",
+            },
           },
           additionalProperties: false,
         },
@@ -151,17 +155,31 @@ module.exports = {
       filePath
     );
 
-    return {
-      ImportDeclaration(node) {
-        if (isExcludedFile) return;
+    const isFileIndex = isFileIndexOfModule(options, fileDir, filePath);
+
+    const report = (node) => {
+      if (isExcludedFile) return;
+
+      const modulePath = createModulePath(node.source.value);
 
-        const modulePath = createModulePath(node.source.value);
+      if (isFileIndex(modulePath)) return;
 
-        if (reportHasProperLevelNumber(node, modulePath) === FINISHED) return;
+      if (reportHasProperLevelNumber(node, modulePath) === FINISHED) return;
 
-        if (reportInSubDirOfFileDir(node, modulePath) === FINISHED) return;
+      if (reportInSubDirOfFileDir(node, modulePath) === FINISHED) return;
 
-        reportHasProperLevel(node, modulePath);
+      reportHasProperLevel(node, modulePath);
+    };
+
+    return {
+      ImportDeclaration(node) {
+        report(node);
+      },
+      ExportNamedDeclaration(node) {
+        report(node);
+      },
+      ExportAllDeclaration(node) {
+        report(node);
       },
     };
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-stratified-design",
-  "version": "0.5.1",
+  "version": "0.6.0-beta",
   "description": "ESlint rules for stratified design",
   "keywords": [
     "eslint",

package/tests/lib/rules/lower-level-imports.js

@@ -187,6 +187,30 @@ ruleTester.run("lower-level-imports", rule, {
         },
       ],
     },
+    {
+      code: "import { func } from '@/layer1/subLayer2/sub'",
+      filename: "./src/layer1/subLayer1/1 layer.js",
+      options: [
+        {
+          structure,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+          useLevelNumber: true,
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/other/file.js'",
+      filename: "./src/other/index.js",
+      options: [
+        {
+          structure,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+          isIndexHighest: true,
+        },
+      ],
+    },
   ],
   invalid: [
     {
@@ -200,6 +224,28 @@ ruleTester.run("lower-level-imports", rule, {
         },
       ],
     },
+    {
+      code: "export { func } from './otherLayerB'",
+      filename: "./src/otherLayerA.js",
+      options: [{ structure, root: "./src" }],
+      errors: [
+        {
+          messageId: "not-registered:file",
+          data: { module: "./otherLayerB", file: "./otherLayerA" },
+        },
+      ],
+    },
+    {
+      code: "export * from './otherLayerB'",
+      filename: "./src/otherLayerA.js",
+      options: [{ structure, root: "./src" }],
+      errors: [
+        {
+          messageId: "not-registered:file",
+          data: { module: "./otherLayerB", file: "./otherLayerA" },
+        },
+      ],
+    },
     {
       code: "import { func } from 'node-module'",
       filename: "./src/layer3/subLayer1.js",
@@ -338,5 +384,22 @@ ruleTester.run("lower-level-imports", rule, {
         },
       ],
     },
+    {
+      code: "import { func } from '@/other/file.js'",
+      filename: "./src/other/index.js",
+      options: [
+        {
+          structure,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "not-registered:file",
+          data: { module: "./other/file.js", file: "./other/index" },
+        },
+      ],
+    },
   ],
 });