eslint-plugin-stratified-design 0.12.4 → 0.12.6

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

@@ -20,36 +20,97 @@ const { fromCwd, match } = require("../helpers/common");
  * @typedef {({[name: string]: number})} Levels
  */
 
+const hasArrFunction = (elements, levels) => {
+  return elements.reduce((hasFunc, element) => {
+    if (hasFunc) return true;
+    const type = element.type;
+    if (type === "FunctionExpression" || type === "ArrowFunctionExpression")
+      return true;
+    if (type === "ObjectExpression")
+      return hasObjFunction(element.properties, levels);
+    if (type === "ArrayExpression")
+      return hasArrFunction(element.elements, levels);
+    if ("name" in element && element.name in levels) return true;
+    return false;
+  }, false);
+};
+
+const hasObjFunction = (properties, levels) => {
+  return properties.reduce((hasFunc, property) => {
+    if (hasFunc) return true;
+    if (!("value" in property)) return false;
+    const type = property.value.type;
+    if (type === "FunctionExpression" || type === "ArrowFunctionExpression")
+      return true;
+    if (type === "ObjectExpression")
+      return hasObjFunction(property.value.properties, levels);
+    if (type === "ArrayExpression")
+      return hasArrFunction(property.value.elements, levels);
+    if ("name" in property.value && property.value.name in levels) return true;
+    return false;
+  }, false);
+};
+
+/**
+ * @param {Node | Token} nodeOrToken
+ */
+const deriveDeclaration = (nodeOrToken) => {
+  return (nodeOrToken.type === "ExportNamedDeclaration" ||
+    nodeOrToken.type === "ExportDefaultDeclaration") &&
+    Boolean(nodeOrToken.declaration)
+    ? nodeOrToken.declaration
+    : nodeOrToken;
+};
+
 /**
  * @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" &&
+  const declaration = deriveDeclaration(nodeOrToken);
+
+  if (declaration.type === "FunctionDeclaration") return declaration.id.name;
+  if (declaration.type !== "VariableDeclaration") return null;
+
+  const { init, id } = declaration.declarations[0];
+  if (
     [
       "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;
+    ].includes(init.type)
+  ) {
+    return id.name;
   }
+
   return null;
 };
 
+/**
+ * @param {Node | Token} nodeOrToken
+ * @param {Levels} levels
+ * @returns {string | null}
+ */
+const deriveVarName = (nodeOrToken, levels) => {
+  const declaration = deriveDeclaration(nodeOrToken);
+  if (declaration.type !== "VariableDeclaration") return null;
+  const { init, id } = declaration.declarations[0];
+  if (
+    init.type === "ObjectExpression" &&
+    hasObjFunction(init.properties, levels)
+  ) {
+    return id.name;
+  } else if (
+    init.type === "ArrayExpression" &&
+    hasArrFunction(init.elements, levels)
+  ) {
+    return id.name;
+  } else {
+    return null;
+  }
+};
+
 /**
  * @param {SourceCode} sourceCode
  * @param {Node | Token} nodeOrToken
@@ -89,16 +150,24 @@ const isCalleeLowerLevel = (sourceCode, levels) => {
     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) || deriveVarName(caller, levels);
+    const callerLevel = levels[callerName];
 
-    const callerName = deriveFuncName(caller);
+    if (callerLevel === undefined) return true;
+    if (callerLevel < calleeLevel) return true;
     if (callerName === calleeName) return true; // recursive function
 
     return false;
   };
 };
 
+const deriveCalleeName = (callee) => {
+  if (callee.type === "Identifier") return callee.name;
+  if (callee.type === "MemberExpression")
+    return deriveCalleeName(callee.object);
+  return null;
+};
+
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
@@ -175,10 +244,11 @@ module.exports = {
       Program(node) {
         node.body.forEach((token) => {
           const name = deriveFuncName(token);
-          if (name) {
-            const level = deriveLevel(sourceCode, token);
-            levels[name] = level;
-          }
+          if (name !== null) levels[name] = deriveLevel(sourceCode, token);
+        });
+        node.body.forEach((token) => {
+          const name = deriveVarName(token, levels);
+          if (name !== null) levels[name] = deriveLevel(sourceCode, token);
         });
       },
       CallExpression(node) {
@@ -186,7 +256,7 @@ module.exports = {
           const isReported = report(node, name);
           if (isReported) return;
         }
-        report(node, node.callee.name);
+        report(node, deriveCalleeName(node.callee));
       },
       JSXOpeningElement(node) {
         report(node, node.name.name);

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.6",
   "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

@@ -158,6 +158,66 @@ ruleTester.run("no-same-level-funcs", rule, {
       code: "/*@level 2*/const func = () => 'a'; /*@level 1*/const obj = { func: () => { func() } } ",
       filename: "./src/foo.js",
     },
+
+    {
+      code: "const func = () => 'a'; const obj = { a: func() } ",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/const func = () => 'a'; /*@level 1*/const obj = { func: () => { func() } } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "obj" } }],
+    },
+    {
+      code: "/*@level 2*/const obj = { func2: () => {} }; /*@level 1*/const func1 = () => { obj.func2() } ",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/const obj = { func2(){} }; /*@level 1*/const func1 = () => { obj.func2() } ",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 3*/const func3 = () => 'a'; /*@level 2*/const obj = { func2: func3 }; /*@level 1*/const func1 = () => { obj.func2() } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "obj" } }],
+    },
+
+    {
+      code: "const func = () => 'a'; const arr = [func()];",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/const func = () => 'a'; /*@level 1*/const arr = [() => { func() }];",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 2*/const arr = [() => {}]; /*@level 1*/const func1 = () => { arr[0]() } ",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 3*/const func3 = () => 'a'; /*@level 2*/const arr = [func3]; /*@level 1*/const func1 = () => { arr[0]() } ",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "import { func } from './module'; const arr = [{a: {b: {c: [func]}}}];",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "const func = () => {}; const arr = [{a: {b: {c: [func]}}}];",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "/*@level 3*/const func3 = () => {}; /*@level 2*/const arr = [{a: {b: {c: [func3]}}}]; /*@level 1*/const func1 = () => arr[0].a.b.c[0]();",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "const obj2 = {}; const obj1 = {...obj2};",
+      filename: "./src/foo.js",
+    },
+    {
+      code: "const arr2 = []; const arr1 = [...arr2];",
+      filename: "./src/foo.js",
+    },
   ],
   invalid: [
     {
@@ -175,13 +235,11 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "function func2(){ func1(); }; function func1(){}",
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "export function func2(){ func1(); }; function func1(){}",
       filename: "./src/foo.js",
@@ -192,7 +250,6 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "const func1 = () => {}; const func2 = () => { func1(); }",
       filename: "./src/foo.js",
@@ -203,7 +260,6 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "const func1 = function(){}; const func2 = function(){ func1(); }",
       filename: "./src/foo.js",
@@ -214,7 +270,6 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "const func1 = function func1(){}; const func2 = function func2(){ func1(); }",
       filename: "./src/foo.js",
@@ -225,7 +280,6 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "const fn = () => 1; const value = fn()",
       filename: "./src/foo.js",
@@ -276,7 +330,6 @@ ruleTester.run("no-same-level-funcs", rule, {
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func1" } }],
     },
-
     {
       code: "function func2(){};\n// @level 1\nfunction func1(){ func2(); }",
       filename: "./src/foo.js",
@@ -284,14 +337,45 @@ ruleTester.run("no-same-level-funcs", rule, {
     },
 
     {
-      code: "const func = () => 'a'; const obj = { a: func() } ",
+      code: "const func = () => 'a'; const obj = { func: () => { func() } };",
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func" } }],
     },
     {
-      code: "const func = () => 'a'; const obj = { func: () => { func() } } ",
+      code: "const obj = { func2: () => {} }; const func1 = () => { obj.func2() } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "obj" } }],
+    },
+    {
+      code: "const obj = { func2(){} }; const func1 = () => { obj.func2() } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "obj" } }],
+    },
+    {
+      code: "const func3 = () => 'a'; const obj = { func2: func3 }; const func1 = () => { obj.func2() } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "obj" } }],
+    },
+
+    {
+      code: "const func = () => 'a'; const arr = [() => { func() }];",
       filename: "./src/foo.js",
       errors: [{ messageId: "no-same-level-funcs", data: { func: "func" } }],
     },
+    {
+      code: "const arr = [() => {}]; const func1 = () => { arr[0]() } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "arr" } }],
+    },
+    {
+      code: "const func3 = () => 'a'; const arr = [func3]; const func1 = () => { arr[0]() } ",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "arr" } }],
+    },
+    {
+      code: "const func3 = () => {}; const arr = [{a: {b: {c: [func3]}}}]; const func1 = () => arr[0].a.b.c[0]();",
+      filename: "./src/foo.js",
+      errors: [{ messageId: "no-same-level-funcs", data: { func: "arr" } }],
+    },
   ],
 });

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