eslint-plugin-stratified-design 0.12.4 → 0.12.5

package/docs/rules/lower-level-imports.md

@@ -142,7 +142,7 @@ The default is as follows:
 }
 ```
 
-Imported modules can be excluded from the rule (`lower-level-imports`) using the `excludeImports` option:
+Imported modules are excluded from the rule (`lower-level-imports`) using the `excludeImports` option:
 
 ```json
 {
@@ -153,6 +153,18 @@ Imported modules can be excluded from the rule (`lower-level-imports`) using the
 }
 ```
 
+Explicitly imported types are excluded using `ignoreType` option:
+
+```json
+{
+  "stratified-design/stratified-imports": ["error", { "ignoreType": true }]
+}
+```
+
+```js
+import type { SomeType } from "./type"; // Explicitly imported types are excluded
+```
+
 ## Rule Details
 
 If a file structure is as follows:

package/docs/rules/stratified-imports.md

@@ -87,7 +87,7 @@ The default configuration is as follows:
 }
 ```
 
-Imported modules can be excluded from the rule (`stratified-imports`) using the `excludeImports` option:
+Imported modules are excluded from the rule (`stratified-imports`) using the `excludeImports` option:
 
 ```json
 {
@@ -98,6 +98,18 @@ Imported modules can be excluded from the rule (`stratified-imports`) using the
 }
 ```
 
+Explicitly imported types are excluded using `ignoreType` option:
+
+```json
+{
+  "stratified-design/stratified-imports": ["error", { "ignoreType": true }]
+}
+```
+
+```js
+import type { SomeType } from "./type"; // Explicitly imported types are excluded
+```
+
 ## Rule Details
 
 Consider the following folder structure:

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

@@ -98,6 +98,9 @@ module.exports = {
             isIndexHighest: {
               type: "boolean",
             },
+            ignoreType: {
+              type: "boolean",
+            },
           },
           additionalProperties: false,
         },
@@ -124,6 +127,7 @@ module.exports = {
       aliases: {},
       useLevelNumber: false,
       isIndexHighest: false,
+      ignoreType: false,
       ...(context.options[0] || {}),
     };
 
@@ -167,7 +171,7 @@ module.exports = {
     const isFileIndex = isFileIndexOfModule(options, fileDir, filePath);
 
     const report = (node) => {
-      if (node.importKind === "type") return;
+      if (options.ignoreType && node.importKind === "type") return;
 
       if (isExcludedFile) return;
 

package/lib/rules/stratified-imports.js

@@ -16,6 +16,16 @@ const helper = require("../helpers/stratifiedImports");
 // Rule Definition
 //------------------------------------------------------------------------------
 
+/**
+ * @typedef {{
+ *  aliases: Record<string, string>,
+ *  exclude: string[],
+ *  include: string[],
+ *  excludeImports: string[],
+ *  ignoreType: boolean,
+ * }} Options
+ */
+
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
@@ -49,6 +59,9 @@ module.exports = {
               type: "array",
               items: [{ type: "string" }],
             },
+            ignoreType: {
+              type: "boolean",
+            },
           },
           additionalProperties: false,
         },
@@ -64,10 +77,14 @@ module.exports = {
     },
   },
   create(context) {
+    /**
+     * @type {Options}
+     */
     const options = {
       exclude: ["**/*.{test,spec}.{js,ts,jsx,tsx}"],
       include: ["**/*.{js,ts,jsx,tsx}"],
       excludeImports: [],
+      ignoreType: false,
       aliases: {},
       ...(context.options[0] || {}),
     };
@@ -124,7 +141,7 @@ module.exports = {
      * @returns
      */
     const report = (node) => {
-      if (node.importKind === "type") return;
+      if (options.ignoreType && node.importKind === "type") return;
 
       if (!isStructureValid) {
         reportError(node, "invalid-json");

package/package.json

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

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

@@ -220,7 +220,7 @@ ruleTester.run("lower-level-imports", rule, {
       ],
     },
     {
-      code: "import { func } from '@/other/file.js'",
+      code: "import { func } from '@/other/file'",
       filename: "./src/other/index.js",
       options: [
         {
@@ -239,7 +239,14 @@ ruleTester.run("lower-level-imports", rule, {
     {
       code: "import type { SomeType } from '@/layer2/subLayer2'",
       filename: "./src/layer1/subLayer2.js",
-      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+      options: [
+        {
+          structure,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+          ignoreType: true,
+        },
+      ],
     },
   ],
   invalid: [
@@ -415,7 +422,7 @@ ruleTester.run("lower-level-imports", rule, {
       ],
     },
     {
-      code: "import { func } from '@/other/file.js'",
+      code: "import { func } from '@/other/file'",
       filename: "./src/other/index.js",
       options: [
         {
@@ -427,7 +434,24 @@ ruleTester.run("lower-level-imports", rule, {
       errors: [
         {
           messageId: "not-registered:file",
-          data: { module: "./other/file.js", file: "./other/index" },
+          data: { module: "./other/file", file: "./other/index" },
+        },
+      ],
+    },
+    {
+      code: "import type { SomeType } from '@/layer2/subLayer2'",
+      filename: "./src/layer1/subLayer2.js",
+      options: [
+        {
+          structure,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "barrier",
+          data: { module: "./layer2/subLayer2", file: "./layer1/subLayer2" },
         },
       ],
     },

package/tests/lib/rules/stratified-imports.js

@@ -169,7 +169,7 @@ ruleTester.run("stratified-imports", rule, {
     {
       code: "import type { SomeType } from './layerA'",
       filename: "./mocked/stratified-imports/layerB.js",
-      options: [],
+      options: [{ ignoreType: true }],
     },
   ],
   invalid: [
@@ -316,5 +316,15 @@ ruleTester.run("stratified-imports", rule, {
         },
       ],
     },
+    {
+      code: "import type { SomeType } from './layerA'",
+      filename: "./mocked/stratified-imports/layerB.js",
+      errors: [
+        {
+          messageId: "not-lower-level",
+          data: { module: "layerA", file: "layerB" },
+        },
+      ],
+    },
   ],
 });