eslint-plugin-stratified-design 0.12.3 → 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/no-same-level-funcs.js

@@ -17,9 +17,39 @@ const { fromCwd, match } = require("../helpers/common");
  * @typedef {import('eslint').Rule.Node} Node
  * @typedef {import('eslint').AST.Token} Token
  * @typedef {import('eslint').SourceCode} SourceCode
- * @typedef {({[name: string]: number | null})} Levels
+ * @typedef {({[name: string]: number})} Levels
  */
 
+/**
+ * @param {Node | Token} nodeOrToken
+ * @returns {string | null}
+ */
+const deriveFuncName = (nodeOrToken) => {
+  const declaration =
+    (nodeOrToken.type === "ExportNamedDeclaration" ||
+      nodeOrToken.type === "ExportDefaultDeclaration") &&
+    Boolean(nodeOrToken.declaration)
+      ? nodeOrToken.declaration
+      : nodeOrToken;
+  const isFuncDeclaration = declaration.type === "FunctionDeclaration";
+  const isVarDeclaration =
+    declaration.type === "VariableDeclaration" &&
+    [
+      "ArrowFunctionExpression",
+      "FunctionExpression",
+      "CallExpression",
+      "TaggedTemplateExpression",
+    ].includes(declaration.declarations[0].init.type);
+
+  if (isFuncDeclaration || isVarDeclaration) {
+    const name = isFuncDeclaration
+      ? declaration.id.name
+      : declaration.declarations[0].id.name;
+    return name;
+  }
+  return null;
+};
+
 /**
  * @param {SourceCode} sourceCode
  * @param {Node | Token} nodeOrToken
@@ -34,7 +64,7 @@ const deriveLevel = (sourceCode, nodeOrToken) => {
       return levelInNum;
     }
   }
-  return null;
+  return 1;
 };
 
 /**
@@ -56,12 +86,15 @@ const isCalleeLowerLevel = (sourceCode, levels) => {
    */
   return (node, calleeName) => {
     const calleeLevel = levels[calleeName];
-    if (calleeLevel === undefined) return true;
-    if (calleeLevel !== null) {
-      const caller = traceAncestor(sourceCode, node);
-      const callerLevel = deriveLevel(sourceCode, caller);
-      if (callerLevel !== null && callerLevel < calleeLevel) return true;
-    }
+    if (calleeLevel === undefined) return true; // 호출되는 함수가 존재하지 않으면 true 리턴. 함수 내의 함수의 경우에는 항상 calleeLevel 이 undefined 이다.
+
+    const caller = traceAncestor(sourceCode, node);
+    const callerLevel = deriveLevel(sourceCode, caller);
+    if (callerLevel < calleeLevel) return true;
+
+    const callerName = deriveFuncName(caller);
+    if (callerName === calleeName) return true; // recursive function
+
     return false;
   };
 };
@@ -116,6 +149,7 @@ module.exports = {
     if (isExcludedFile) return {};
 
     /**
+     * @description 함수들의 레벨. 함수 내의 함수는 여기에 기록되지 않는다.
      * @type {Levels}
      */
     const levels = {};
@@ -140,22 +174,9 @@ module.exports = {
     return {
       Program(node) {
         node.body.forEach((token) => {
-          const declaration = (token.type === 'ExportNamedDeclaration' || token.type === 'ExportDefaultDeclaration') && Boolean(token.declaration) ? token.declaration : token
-          const isFuncDeclaration = declaration.type === "FunctionDeclaration";
-          const isVarDeclaration =
-          declaration.type === "VariableDeclaration" &&
-            [
-              "ArrowFunctionExpression",
-              "FunctionExpression",
-              "CallExpression",
-              "TaggedTemplateExpression",
-            ].includes(declaration.declarations[0].init.type);
-
-          if (isFuncDeclaration || isVarDeclaration) {
+          const name = deriveFuncName(token);
+          if (name) {
             const level = deriveLevel(sourceCode, token);
-            const name = isFuncDeclaration
-              ? declaration.id.name
-              : declaration.declarations[0].id.name;
             levels[name] = level;
           }
         });

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.3",
+  "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/no-same-level-funcs.js

@@ -56,7 +56,15 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
     },
     {
-      code: "// @level 2\nexport function func2(){};\n// @level 1\nfunction func1(){ func2(); }",
+      code: "/*@level 2*/function func2(){}; /*@level 1*/function func1(){ func2(); }",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/function func2(){}; function func1(){ func2(); }",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/export function func2(){}; /*@level 1*/function func1(){ func2(); }",
       filename: "./src/foo.js",
     },
 
@@ -104,6 +112,52 @@ ruleTester.run("no-same-level-funcs", rule, {
       code: "/*\n@level 2\nsomething\n*/\nexport const func2 = () => {};\n/*something\n@level 1\n*/\nconst func1 = () => func2();",
       filename: "./src/foo.js",
     },
+
+    {
+      code: "// @level 2\nfunction func2(){};\nfunction func1(){ func2(); }",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "func2" } }],
+    },
+    {
+      code: "// @level 2\nexport function func2(){};\nfunction func1(){ func2(); }",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "func2" } }],
+    },
+
+    {
+      code: "function recursiveFunc() { recursiveFunc() }",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "const recursiveFunc = () => { recursiveFunc() }",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "export const recursiveFunc = () => { recursiveFunc() }",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "//@level 2\nconst recursiveFunc = () => { recursiveFunc() }",
+      filename: "./src/foo.js",
+    },
+
+    {
+      code: "const funcWithInnerFunc = () => { const innerFunc = () => {}; innerFunc()  }",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/const func2 = () => {}; /*@level 1*/const func1 = () => { const innerFunc = () => { func2() }; innerFunc(); }",
+      filename: "./src/foo.js",
+    },
+
+    {
+      code: "/*@level 2*/const func = () => 'a'; /*@level 1*/const obj = { a: func() } ",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/const func = () => 'a'; /*@level 1*/const obj = { func: () => { func() } } ",
+      filename: "./src/foo.js",
+    },
   ],
   invalid: [
     {
@@ -224,20 +278,20 @@ ruleTester.run("no-same-level-funcs", rule, {
     },
 
     {
-      code: "// @level 2\nfunction func2(){};\nfunction func1(){ func2(); }",
+      code: "function func2(){};\n// @level 1\nfunction func1(){ func2(); }",
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func2" } }],
     },
+
     {
-      code: "// @level 2\nexport function func2(){};\nfunction func1(){ func2(); }",
+      code: "const func = () => 'a'; const obj = { a: func() } ",
       filename: "./src/foo.js",
-      errors: [{ messageId: "no-same-level-funcs", data: { func: "func2" } }],
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "func" } }],
     },
-
     {
-      code: "function func2(){};\n// @level 1\nfunction func1(){ func2(); }",
+      code: "const func = () => 'a'; const obj = { func: () => { func() } } ",
       filename: "./src/foo.js",
-      errors: [{ messageId: "no-same-level-funcs", data: { func: "func2" } }],
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "func" } }],
     },
   ],
 });

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" },
+        },
+      ],
+    },
   ],
 });