eslint-plugin-barrel-rules 1.1.3 → 1.2.0

package/README.ko.md

@@ -3,7 +3,7 @@
 # **Advanced Barrel Pattern Enforcement for JavaScript/TypeScript Projects**
 
 <div align="center">
-  <img src="https://img.shields.io/badge/version-1.1.3-blue.svg" alt="Version"/>
+  <img src="https://img.shields.io/badge/version-1.2.0-blue.svg" alt="Version"/>
   <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/>
   <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"/>
 </div>
@@ -39,7 +39,12 @@ JavaScript/TypeScript 프로젝트에서 Barrel Pattern(배럴 패턴)을 강제
 - ESLint 9
   > Flat config(eslint.config.js), TypeScript 지원 시 "typescript-eslint" config 사용 필요
 - ESLint 8
+
   > Legacy config(.eslintrc.js), TypeScript 지원 시 "@typescript-eslint/parser"를 parser로 지정하고, "@typescript-eslint"를 plugin에 추가해야 함
+
+- TypeScript Alias Import 지원
+  > Import 구문에서 TypeScript 경로 별칭(예: `@ts/barrel/inner`)을 `tsconfig.json` 기반으로 자동 해석합니다.  
+  > 단, ESLint 플러그인 설정에서는 alias 사용 불가능 - 상대경로나 절대경로만 사용하세요.
 - Node.js (ES2015 이상)
 - ES 모듈, CommonJS 모듈 모두 지원
 
@@ -193,20 +198,43 @@ export default tseslint.config([
 
 ## 예시
 
+### 1. 배럴 내부파일 직접 접근
+
 ```ts
-// ❌ 내부 파일을 직접 import하면 차단됩니다.
+file(src / index.ts);
+
+// ❌ 내부 파일 직접 import 차단
 import { Test } from "../domains/foo/components/Test";
 
-// ✅ 반드시 배럴(index) 파일을 통해 import해야 합니다.
+// ✅ barrel(index) 파일을 통한 import만 허용
 import { Test } from "../domains/foo";
 ```
 
+### 2. 격리된 모듈 접근 (TypeScript Alias 지원)
+
+```ts
+file(src / domains / foo / index.ts);
+
+// ❌ 격리된 barrel로의 외부 import 차단 (alias 사용해도 차단)
+// barrel 외부에서 접근 (bar의 경로는 src/domains/bar/)
+import { Test } from "@domains/bar/components/Test";
+// 또는
+import { Test } from "../domains/bar";
+
+// ✅ 같은 barrel 내부에서의 import는 허용 (alias 지원)
+import { Hook } from "@domains/foo/hooks/useTest"; // 같은 barrel 내부에서
+import { Utils } from "./utils/helper"; // 같은 barrel 내부에서
+
+// ✅ 허용된 import 경로는 사용 가능 (alias 지원)
+import { SharedUtil } from "@shared/utils"; // allowedImportPaths에 "src/shared/*"가 있는 경우
+```
+
 ---
 
 ## 앞으로의 계획
 
 - 더 다양한 모듈 경계/추상화 관련 룰 추가 예정 (~Ing)
-- Alias/tsconfig 지원: TypeScript의 paths, Vite의 resolve.alias, 기타 커스텀 경로 매핑을 완벽하게 지원 (~Ing)
+- **Alias/tsconfig 지원: TypeScript의 paths 맵핑 완벽하게 지원** (OK)
 - **CJS 지원** (OK)
 - **ESLint 8 지원** (OK)
 - **번들 플러그인(플러그인 내 모든 기능 통합)** (OK)

package/README.md

@@ -3,7 +3,7 @@
 # **Advanced Barrel Pattern Enforcement for JavaScript/TypeScript Projects**
 
 <div align="center">
-  <img src="https://img.shields.io/badge/version-1.1.3-blue.svg" alt="Version"/>
+  <img src="https://img.shields.io/badge/version-1.2.0-blue.svg" alt="Version"/>
   <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/>
   <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"/>
 </div>
@@ -43,6 +43,9 @@ Direct imports from internal files are blocked, maximizing
   > Flat config(eslint.config.js), for TypeScript support, use the "typescript-eslint" config
 - ESLint 8
   > Legacy config(.eslintrc.js), for TypeScript support, set "@typescript-eslint/parser" as the parser and add "@typescript-eslint" as a plugin
+- TypeScript Alias Import Support
+  > Automatically resolves TypeScript path aliases (e.g., `@ts/barrel/inner`) in import statements based on your `tsconfig.json`.  
+  > Note: ESLint plugin configuration does not support aliases - use relative or absolute paths only.
 - Node.js (ES2015+)
 - Supports both ES Modules and CommonJS
 
@@ -194,9 +197,13 @@ export default tseslint.config([
 
 ---
 
-## Example
+## Examples
+
+### 1. Direct Access
 
 ```ts
+file(src / index.ts);
+
 // ❌ Direct import from internal file is blocked
 import { Test } from "../domains/foo/components/Test";
 
@@ -204,6 +211,25 @@ import { Test } from "../domains/foo/components/Test";
 import { Test } from "../domains/foo";
 ```
 
+### 2. Isolated Module Access (with TypeScript Alias Support)
+
+```ts
+file(src / domains / foo / index.ts);
+
+// ❌ External import to isolated barrel is blocked (even with alias)
+// from outside barrel (bar's path is src/domains/bar/)
+import { Test } from "@domains/bar/components/Test";
+// or
+import { Test } from "../domains/bar";
+
+// ✅ Internal imports within same barrel are allowed (alias supported)
+import { Hook } from "@domains/foo/hooks/useTest"; // from inside same barrel
+import { Utils } from "./utils/helper"; // from inside same barrel
+
+// ✅ Allowed import paths are permitted (alias supported)
+import { SharedUtil } from "@shㅇㅇared/utils"; // if "src/shared/*" is in allowedImportPaths
+```
+
 ---
 
 ## Future Work
@@ -211,8 +237,7 @@ import { Test } from "../domains/foo";
 - More rules for module boundaries and abstraction (~Ing)
 
 - **Alias/tsconfig Support**  
-  Fully supports TypeScript `paths`, Vite `resolve.alias`, and other custom path mappings (~Ing)
-
+  Fully supports TypeScript `paths` (OK)
 - **CJS Support** (OK)
 - **Eslint8 Support** (OK)
 - **Bundle Plugin(capsure any features in plugin)**

package/dist/index.cjs

@@ -36,27 +36,81 @@ module.exports = __toCommonJS(index_exports);
 
 // src/rules/enforce-barrel-pattern.ts
 var import_utils = require("@typescript-eslint/utils");
-var import_path = __toESM(require("path"), 1);
+var import_path2 = __toESM(require("path"), 1);
 var import_resolve = __toESM(require("resolve"), 1);
 
 // src/utils/glob.ts
 var import_fast_glob = __toESM(require("fast-glob"), 1);
 var Glob = class {
-  static resolvePath(path2, baseDir) {
-    const globResult = import_fast_glob.default.sync(path2, {
+  static resolvePath(path3, baseDir) {
+    const globResult = import_fast_glob.default.sync(path3, {
       cwd: baseDir,
       onlyDirectories: true,
       absolute: true
     });
     if (globResult.length === 0) {
       throw new Error(
-        `[Glob] In baseDir: ${baseDir}, path: ${path2}, any directory was not found`
+        `[Glob] In baseDir: ${baseDir}, path: ${path3}, any directory was not found`
       );
     }
     return globResult;
   }
 };
 
+// src/utils/alias.ts
+var import_tsconfig_paths = require("tsconfig-paths");
+var import_path = __toESM(require("path"), 1);
+var Alias = class {
+  constructor() {
+  }
+  static resolvePath(rawPath, currentFileDir) {
+    try {
+      const configResult = (0, import_tsconfig_paths.loadConfig)(currentFileDir);
+      if (configResult.resultType === "success") {
+        for (const [pattern, targets] of Object.entries(configResult.paths)) {
+          const origin = targets[0];
+          if (pattern.includes("*")) {
+            const patternRegex = new RegExp(
+              `^${pattern.replace("*", "(.*)")}$`
+            );
+            const match = rawPath.match(patternRegex);
+            if (match) {
+              const [, matchedPath] = match;
+              const extendedOrigin = origin.replace("*", matchedPath);
+              const absolutePath = import_path.default.resolve(
+                `${configResult.absoluteBaseUrl}/${extendedOrigin}`
+              );
+              return {
+                absolutePath,
+                type: "success"
+              };
+            }
+          } else {
+            if (rawPath === pattern) {
+              const absolutePath = import_path.default.resolve(
+                `${configResult.absoluteBaseUrl}/${origin}`
+              );
+              return {
+                absolutePath,
+                type: "success"
+              };
+            }
+          }
+        }
+      }
+      return {
+        absolutePath: rawPath,
+        type: "fail"
+      };
+    } catch (e) {
+      return {
+        absolutePath: rawPath,
+        type: "fail"
+      };
+    }
+  }
+};
+
 // src/rules/enforce-barrel-pattern.ts
 var BARREL_ENTRY_POINT_FILE_NAMES = [
   "index.ts",
@@ -126,10 +180,18 @@ var enforceBarrelPattern = {
         const absoluteCurrentFilePath = context.getFilename();
         let absoluteImportPath = null;
         try {
-          absoluteImportPath = import_resolve.default.sync(rawImportPath, {
-            basedir: import_path.default.dirname(absoluteCurrentFilePath),
-            extensions: RESOLVE_EXTENSIONS
-          });
+          const aliasResult = Alias.resolvePath(
+            rawImportPath,
+            import_path2.default.dirname(absoluteCurrentFilePath)
+          );
+          if (aliasResult.type === "success") {
+            absoluteImportPath = aliasResult.absolutePath;
+          } else {
+            absoluteImportPath = import_resolve.default.sync(rawImportPath, {
+              basedir: import_path2.default.dirname(absoluteCurrentFilePath),
+              extensions: RESOLVE_EXTENSIONS
+            });
+          }
         } catch (e) {
           return;
         }
@@ -138,7 +200,7 @@ var enforceBarrelPattern = {
           const invalidDirectedImport = absoluteTargetPaths.some(
             (absoluteTargetPath) => {
               const targetPathEntryPoints = BARREL_ENTRY_POINT_FILE_NAMES.map(
-                (entry) => import_path.default.resolve(absoluteTargetPath, entry)
+                (entry) => import_path2.default.resolve(absoluteTargetPath, entry)
               );
               const closedTargetPath = absoluteTargetPath + "/";
               const targetPathEntryPointed = targetPathEntryPoints.includes(absoluteImportPath);

package/dist/index.js

@@ -1,26 +1,80 @@
 // src/rules/enforce-barrel-pattern.ts
 import "@typescript-eslint/utils";
-import path from "path";
+import path2 from "path";
 import resolve from "resolve";
 
 // src/utils/glob.ts
 import FastGlob from "fast-glob";
 var Glob = class {
-  static resolvePath(path2, baseDir) {
-    const globResult = FastGlob.sync(path2, {
+  static resolvePath(path3, baseDir) {
+    const globResult = FastGlob.sync(path3, {
       cwd: baseDir,
       onlyDirectories: true,
       absolute: true
     });
     if (globResult.length === 0) {
       throw new Error(
-        `[Glob] In baseDir: ${baseDir}, path: ${path2}, any directory was not found`
+        `[Glob] In baseDir: ${baseDir}, path: ${path3}, any directory was not found`
       );
     }
     return globResult;
   }
 };
 
+// src/utils/alias.ts
+import { loadConfig } from "tsconfig-paths";
+import path from "path";
+var Alias = class {
+  constructor() {
+  }
+  static resolvePath(rawPath, currentFileDir) {
+    try {
+      const configResult = loadConfig(currentFileDir);
+      if (configResult.resultType === "success") {
+        for (const [pattern, targets] of Object.entries(configResult.paths)) {
+          const origin = targets[0];
+          if (pattern.includes("*")) {
+            const patternRegex = new RegExp(
+              `^${pattern.replace("*", "(.*)")}$`
+            );
+            const match = rawPath.match(patternRegex);
+            if (match) {
+              const [, matchedPath] = match;
+              const extendedOrigin = origin.replace("*", matchedPath);
+              const absolutePath = path.resolve(
+                `${configResult.absoluteBaseUrl}/${extendedOrigin}`
+              );
+              return {
+                absolutePath,
+                type: "success"
+              };
+            }
+          } else {
+            if (rawPath === pattern) {
+              const absolutePath = path.resolve(
+                `${configResult.absoluteBaseUrl}/${origin}`
+              );
+              return {
+                absolutePath,
+                type: "success"
+              };
+            }
+          }
+        }
+      }
+      return {
+        absolutePath: rawPath,
+        type: "fail"
+      };
+    } catch (e) {
+      return {
+        absolutePath: rawPath,
+        type: "fail"
+      };
+    }
+  }
+};
+
 // src/rules/enforce-barrel-pattern.ts
 var BARREL_ENTRY_POINT_FILE_NAMES = [
   "index.ts",
@@ -90,10 +144,18 @@ var enforceBarrelPattern = {
         const absoluteCurrentFilePath = context.getFilename();
         let absoluteImportPath = null;
         try {
-          absoluteImportPath = resolve.sync(rawImportPath, {
-            basedir: path.dirname(absoluteCurrentFilePath),
-            extensions: RESOLVE_EXTENSIONS
-          });
+          const aliasResult = Alias.resolvePath(
+            rawImportPath,
+            path2.dirname(absoluteCurrentFilePath)
+          );
+          if (aliasResult.type === "success") {
+            absoluteImportPath = aliasResult.absolutePath;
+          } else {
+            absoluteImportPath = resolve.sync(rawImportPath, {
+              basedir: path2.dirname(absoluteCurrentFilePath),
+              extensions: RESOLVE_EXTENSIONS
+            });
+          }
         } catch (e) {
           return;
         }
@@ -102,7 +164,7 @@ var enforceBarrelPattern = {
           const invalidDirectedImport = absoluteTargetPaths.some(
             (absoluteTargetPath) => {
               const targetPathEntryPoints = BARREL_ENTRY_POINT_FILE_NAMES.map(
-                (entry) => path.resolve(absoluteTargetPath, entry)
+                (entry) => path2.resolve(absoluteTargetPath, entry)
               );
               const closedTargetPath = absoluteTargetPath + "/";
               const targetPathEntryPointed = targetPathEntryPoints.includes(absoluteImportPath);

package/package.json

@@ -25,7 +25,7 @@
     "isolated barrel module",
     "no-wildcard"
   ],
-  "version": "1.1.3",
+  "version": "1.2.0",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",