@lytjs/router-fs 6.5.0

package/README.md

@@ -0,0 +1,80 @@
+# @lytjs/router-fs
+
+LytJS 文件系统路由引擎，自动扫描文件系统生成路由配置。
+
+## 安装
+
+```bash
+pnpm add @lytjs/router-fs
+```
+
+## 快速开始
+
+```typescript
+import { createFileSystemRouter } from '@lytjs/router-fs';
+
+const router = createFileSystemRouter({
+  pagesDir: './src/pages',
+});
+
+// 添加路由
+router.addRoute({
+  path: '/about',
+  componentPath: './src/pages/about.ts',
+  isDynamic: false,
+  isNested: false,
+});
+
+// 匹配路由
+const match = router.match('/about');
+console.log(match); // { path: '/about', ... }
+```
+
+## 特性
+
+- 基于文件系统的自动路由生成
+- 支持动态路由参数
+- 支持嵌套路由
+- 零外部依赖
+
+## API
+
+### createFileSystemRouter(options)
+
+创建文件系统路由引擎实例。
+
+```typescript
+import { createFileSystemRouter } from '@lytjs/router-fs';
+
+const router = createFileSystemRouter({
+  pagesDir: './src/pages',
+  basePath: '/',
+});
+```
+
+### router.addRoute(route)
+
+添加路由。
+
+### router.match(path)
+
+匹配路由。
+
+### router.getRoutes()
+
+获取所有路由。
+
+## 文件结构约定
+
+```
+src/
+└── pages/
+    ├── index.ts       # /
+    ├── about.ts       # /about
+    └── user/
+        └── [id].ts    # /user/:id
+```
+
+## 许可证
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,173 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createFileSystemRouter: () => createFileSystemRouter
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils.ts
+var import_fs = require("fs");
+var import_path = require("path");
+function isDirectory(path) {
+  return (0, import_fs.existsSync)(path) && (0, import_fs.statSync)(path).isDirectory();
+}
+function isFile(path) {
+  return (0, import_fs.existsSync)(path) && (0, import_fs.statSync)(path).isFile();
+}
+function filePathToRoutePath(filePath, baseDir, extensions) {
+  let normalized = (0, import_path.normalize)((0, import_path.relative)(baseDir, filePath));
+  for (const ext of extensions) {
+    if (normalized.endsWith(ext)) {
+      normalized = normalized.slice(0, -ext.length);
+      break;
+    }
+  }
+  normalized = normalized.replace(/\\/g, "/");
+  if (normalized.endsWith("/index")) {
+    normalized = normalized.slice(0, -6);
+  } else if (normalized === "index") {
+    normalized = "";
+  }
+  normalized = normalized.replace(/\[(\w+)\]/g, ":$1");
+  return normalized.startsWith("/") ? normalized : `/${normalized}`;
+}
+function extractDynamicParams(routePath) {
+  const matches = routePath.match(/:(\w+)/g);
+  return matches ? matches.map((m) => m.slice(1)) : [];
+}
+function scanDirectory(dir, baseDir, extensions, ignorePatterns) {
+  const routes = [];
+  if (!isDirectory(dir)) return routes;
+  const files = (0, import_fs.readdirSync)(dir);
+  for (const file of files) {
+    const fullPath = (0, import_path.join)(dir, file);
+    const relativePath = (0, import_path.relative)(baseDir, fullPath);
+    if (ignorePatterns.some((pattern) => {
+      if (relativePath.includes(pattern)) return true;
+      return file.includes(pattern);
+    })) {
+      continue;
+    }
+    if (isDirectory(fullPath)) {
+      routes.push(...scanDirectory(fullPath, baseDir, extensions, ignorePatterns));
+    } else if (isFile(fullPath)) {
+      const ext = extensions.find((e) => file.endsWith(e));
+      if (ext) {
+        const routePath = filePathToRoutePath(fullPath, baseDir, extensions);
+        const params = extractDynamicParams(routePath);
+        routes.push({
+          path: routePath,
+          componentPath: fullPath,
+          isDynamic: params.length > 0,
+          params,
+          isNested: routePath.split("/").length > 2
+        });
+      }
+    }
+  }
+  return routes;
+}
+
+// src/index.ts
+var DEFAULT_OPTIONS = {
+  pagesDir: "src/pages",
+  extensions: [".ts", ".tsx", ".js", ".jsx"],
+  layoutPattern: "_layout",
+  ignorePatterns: ["node_modules", ".git", "dist"],
+  strictMode: false
+};
+function createFileSystemRouter(options) {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  let routes = [];
+  async function refresh() {
+    routes = scanDirectory(
+      config.pagesDir,
+      config.pagesDir,
+      config.extensions,
+      config.ignorePatterns
+    );
+  }
+  function match(path) {
+    for (const route of routes) {
+      if (route.path === path) {
+        return {
+          route,
+          params: {},
+          path
+        };
+      }
+    }
+    const pathSegments = path.split("/").filter(Boolean);
+    for (const route of routes) {
+      const routeSegments = route.path.split("/").filter(Boolean);
+      if (routeSegments.length !== pathSegments.length) continue;
+      const params = {};
+      let match2 = true;
+      for (let i = 0; i < routeSegments.length; i++) {
+        const routeSeg = routeSegments[i];
+        const pathSeg = pathSegments[i];
+        if (!routeSeg || !pathSeg) continue;
+        if (routeSeg.startsWith(":")) {
+          params[routeSeg.slice(1)] = pathSeg;
+        } else if (routeSeg !== pathSeg) {
+          match2 = false;
+          break;
+        }
+      }
+      if (match2) {
+        return {
+          route,
+          params,
+          path
+        };
+      }
+    }
+    return null;
+  }
+  function getRoutes() {
+    return [...routes];
+  }
+  function addRoute(route) {
+    routes.push(route);
+  }
+  function removeRoute(path) {
+    routes = routes.filter((r) => r.path !== path);
+  }
+  function clearRoutes() {
+    routes = [];
+  }
+  refresh().catch((err) => {
+    console.warn("Failed to scan routes:", err);
+  });
+  return {
+    getRoutes,
+    match,
+    addRoute,
+    removeRoute,
+    clearRoutes,
+    refresh
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createFileSystemRouter
+});

package/dist/index.d.cts

@@ -0,0 +1,74 @@
+/**
+ * @lytjs/router-fs - 类型定义
+ */
+/** 路由配置接口 */
+interface RouteConfig {
+    /** 路由路径 */
+    path: string;
+    /** 路由名称 */
+    name?: string;
+    /** 组件路径 */
+    componentPath: string;
+    /** 是否为动态路由 */
+    isDynamic: boolean;
+    /** 动态路由参数名 */
+    params?: string[];
+    /** 是否为嵌套路由 */
+    isNested: boolean;
+    /** 子路由 */
+    children?: RouteConfig[];
+    /** 布局路径 */
+    layoutPath?: string;
+}
+/** 文件系统路由配置选项 */
+interface FileSystemRouterOptions {
+    /** 页面目录路径 */
+    pagesDir: string;
+    /** 页面文件扩展名 */
+    extensions?: string[];
+    /** 布局文件名称模式 */
+    layoutPattern?: string;
+    /** 忽略文件模式 */
+    ignorePatterns?: string[];
+    /** 是否启用严格模式 */
+    strictMode?: boolean;
+}
+/** 路由匹配结果 */
+interface RouteMatch {
+    /** 匹配的路由配置 */
+    route: RouteConfig;
+    /** 路由参数 */
+    params: Record<string, string>;
+    /** 路由路径 */
+    path: string;
+}
+/** 路由管理器接口 */
+interface FileSystemRouter {
+    /** 获取路由配置列表 */
+    getRoutes(): RouteConfig[];
+    /** 匹配路径 */
+    match(path: string): RouteMatch | null;
+    /** 添加路由 */
+    addRoute(route: RouteConfig): void;
+    /** 移除路由 */
+    removeRoute(path: string): void;
+    /** 清除所有路由 */
+    clearRoutes(): void;
+    /** 重新扫描文件系统 */
+    refresh(): Promise<void>;
+}
+
+/**
+ * @lytjs/router-fs
+ *
+ * LytJS File-System Router Engine
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * 创建文件系统路由管理器
+ */
+declare function createFileSystemRouter(options?: FileSystemRouterOptions): FileSystemRouter;
+
+export { type FileSystemRouter, type FileSystemRouterOptions, type RouteConfig, type RouteMatch, createFileSystemRouter };

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @lytjs/router-fs - 类型定义
+ */
+/** 路由配置接口 */
+interface RouteConfig {
+    /** 路由路径 */
+    path: string;
+    /** 路由名称 */
+    name?: string;
+    /** 组件路径 */
+    componentPath: string;
+    /** 是否为动态路由 */
+    isDynamic: boolean;
+    /** 动态路由参数名 */
+    params?: string[];
+    /** 是否为嵌套路由 */
+    isNested: boolean;
+    /** 子路由 */
+    children?: RouteConfig[];
+    /** 布局路径 */
+    layoutPath?: string;
+}
+/** 文件系统路由配置选项 */
+interface FileSystemRouterOptions {
+    /** 页面目录路径 */
+    pagesDir: string;
+    /** 页面文件扩展名 */
+    extensions?: string[];
+    /** 布局文件名称模式 */
+    layoutPattern?: string;
+    /** 忽略文件模式 */
+    ignorePatterns?: string[];
+    /** 是否启用严格模式 */
+    strictMode?: boolean;
+}
+/** 路由匹配结果 */
+interface RouteMatch {
+    /** 匹配的路由配置 */
+    route: RouteConfig;
+    /** 路由参数 */
+    params: Record<string, string>;
+    /** 路由路径 */
+    path: string;
+}
+/** 路由管理器接口 */
+interface FileSystemRouter {
+    /** 获取路由配置列表 */
+    getRoutes(): RouteConfig[];
+    /** 匹配路径 */
+    match(path: string): RouteMatch | null;
+    /** 添加路由 */
+    addRoute(route: RouteConfig): void;
+    /** 移除路由 */
+    removeRoute(path: string): void;
+    /** 清除所有路由 */
+    clearRoutes(): void;
+    /** 重新扫描文件系统 */
+    refresh(): Promise<void>;
+}
+
+/**
+ * @lytjs/router-fs
+ *
+ * LytJS File-System Router Engine
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * 创建文件系统路由管理器
+ */
+declare function createFileSystemRouter(options?: FileSystemRouterOptions): FileSystemRouter;
+
+export { type FileSystemRouter, type FileSystemRouterOptions, type RouteConfig, type RouteMatch, createFileSystemRouter };

package/dist/index.mjs

@@ -0,0 +1,146 @@
+// src/utils.ts
+import { existsSync, readdirSync, statSync } from "fs";
+import { join, normalize, relative } from "path";
+function isDirectory(path) {
+  return existsSync(path) && statSync(path).isDirectory();
+}
+function isFile(path) {
+  return existsSync(path) && statSync(path).isFile();
+}
+function filePathToRoutePath(filePath, baseDir, extensions) {
+  let normalized = normalize(relative(baseDir, filePath));
+  for (const ext of extensions) {
+    if (normalized.endsWith(ext)) {
+      normalized = normalized.slice(0, -ext.length);
+      break;
+    }
+  }
+  normalized = normalized.replace(/\\/g, "/");
+  if (normalized.endsWith("/index")) {
+    normalized = normalized.slice(0, -6);
+  } else if (normalized === "index") {
+    normalized = "";
+  }
+  normalized = normalized.replace(/\[(\w+)\]/g, ":$1");
+  return normalized.startsWith("/") ? normalized : `/${normalized}`;
+}
+function extractDynamicParams(routePath) {
+  const matches = routePath.match(/:(\w+)/g);
+  return matches ? matches.map((m) => m.slice(1)) : [];
+}
+function scanDirectory(dir, baseDir, extensions, ignorePatterns) {
+  const routes = [];
+  if (!isDirectory(dir)) return routes;
+  const files = readdirSync(dir);
+  for (const file of files) {
+    const fullPath = join(dir, file);
+    const relativePath = relative(baseDir, fullPath);
+    if (ignorePatterns.some((pattern) => {
+      if (relativePath.includes(pattern)) return true;
+      return file.includes(pattern);
+    })) {
+      continue;
+    }
+    if (isDirectory(fullPath)) {
+      routes.push(...scanDirectory(fullPath, baseDir, extensions, ignorePatterns));
+    } else if (isFile(fullPath)) {
+      const ext = extensions.find((e) => file.endsWith(e));
+      if (ext) {
+        const routePath = filePathToRoutePath(fullPath, baseDir, extensions);
+        const params = extractDynamicParams(routePath);
+        routes.push({
+          path: routePath,
+          componentPath: fullPath,
+          isDynamic: params.length > 0,
+          params,
+          isNested: routePath.split("/").length > 2
+        });
+      }
+    }
+  }
+  return routes;
+}
+
+// src/index.ts
+var DEFAULT_OPTIONS = {
+  pagesDir: "src/pages",
+  extensions: [".ts", ".tsx", ".js", ".jsx"],
+  layoutPattern: "_layout",
+  ignorePatterns: ["node_modules", ".git", "dist"],
+  strictMode: false
+};
+function createFileSystemRouter(options) {
+  const config = { ...DEFAULT_OPTIONS, ...options };
+  let routes = [];
+  async function refresh() {
+    routes = scanDirectory(
+      config.pagesDir,
+      config.pagesDir,
+      config.extensions,
+      config.ignorePatterns
+    );
+  }
+  function match(path) {
+    for (const route of routes) {
+      if (route.path === path) {
+        return {
+          route,
+          params: {},
+          path
+        };
+      }
+    }
+    const pathSegments = path.split("/").filter(Boolean);
+    for (const route of routes) {
+      const routeSegments = route.path.split("/").filter(Boolean);
+      if (routeSegments.length !== pathSegments.length) continue;
+      const params = {};
+      let match2 = true;
+      for (let i = 0; i < routeSegments.length; i++) {
+        const routeSeg = routeSegments[i];
+        const pathSeg = pathSegments[i];
+        if (!routeSeg || !pathSeg) continue;
+        if (routeSeg.startsWith(":")) {
+          params[routeSeg.slice(1)] = pathSeg;
+        } else if (routeSeg !== pathSeg) {
+          match2 = false;
+          break;
+        }
+      }
+      if (match2) {
+        return {
+          route,
+          params,
+          path
+        };
+      }
+    }
+    return null;
+  }
+  function getRoutes() {
+    return [...routes];
+  }
+  function addRoute(route) {
+    routes.push(route);
+  }
+  function removeRoute(path) {
+    routes = routes.filter((r) => r.path !== path);
+  }
+  function clearRoutes() {
+    routes = [];
+  }
+  refresh().catch((err) => {
+    console.warn("Failed to scan routes:", err);
+  });
+  return {
+    getRoutes,
+    match,
+    addRoute,
+    removeRoute,
+    clearRoutes,
+    refresh
+  };
+}
+export {
+  createFileSystemRouter
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@lytjs/router-fs",
+  "version": "6.5.0",
+  "description": "LytJS File-System based Router Engine",
+  "author": "lytjs",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist node_modules .turbo"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": {},
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/lytjs/lytjs.git",
+    "directory": "packages/ecosystem/packages/router-fs"
+  },
+  "keywords": [
+    "lytjs",
+    "router",
+    "file-system",
+    "fs"
+  ],
+  "homepage": "https://gitee.com/lytjs/lytjs",
+  "bugs": {
+    "url": "https://gitee.com/lytjs/lytjs/issues"
+  }
+}