ts-file-router 1.0.0

package/dist/file-router.d.ts

@@ -0,0 +1,3 @@
+import { TStartConfigs } from './types';
+export declare const start: ({ baseFolder, outputFile, routeFileName, }: TStartConfigs) => void;
+//# sourceMappingURL=file-router.d.ts.map

package/dist/file-router.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-router.d.ts","sourceRoot":"","sources":["../src/file-router.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAe,MAAM,SAAS,CAAC;AA+BrD,eAAO,MAAM,KAAK,GAAI,4CAInB,aAAa,SAsEf,CAAC"}

package/dist/file-router.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = void 0;
+const path_1 = __importDefault(require("path"));
+const promises_1 = __importDefault(require("fs/promises"));
+// Serialize routes objects to TS file output
+const serializeRoutes = (obj, ident = 2) => {
+    const pad = ' '.repeat(ident);
+    let str = '{\n';
+    for (const key in obj) {
+        const value = obj[key];
+        // Manipulate JS keys
+        const keyStr = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key) ? key : `"${key}"`;
+        if (typeof value === 'object' &&
+            value !== null &&
+            !('path' in value && 'import' in value)) {
+            // Create sub folders
+            str += `${pad}${keyStr}: ${serializeRoutes(value, ident + 2)},\n`;
+        }
+        else {
+            // Routes
+            str += `${pad}${keyStr}: { path: "${value.path}", import: "${value.import}" },\n`;
+        }
+    }
+    str += ' '.repeat(ident - 2) + '}';
+    return str;
+};
+const start = ({ baseFolder, outputFile, routeFileName = 'page.ts', }) => {
+    // Get the pages dir to resolve routes
+    const basePath = path_1.default.resolve(__dirname, baseFolder);
+    // Output file for routes
+    const output = path_1.default.resolve(__dirname, outputFile);
+    const generateRouter = async () => {
+        const mapRoutes = async (dir) => {
+            const routes = {};
+            const directory = await promises_1.default.readdir(dir);
+            if (!directory.includes(routeFileName)) {
+                throw new Error(`Invalid pages structure: The folder "${dir}" must contain a ${routeFileName} file.`);
+            }
+            for (const file of directory) {
+                const fullPath = path_1.default.join(dir, file);
+                // Get directory info to control file or folder
+                const dirInfo = await promises_1.default.stat(fullPath);
+                // Normalize import path to esm pattern
+                const importPath = './' + path_1.default.relative(basePath, fullPath).replaceAll(/\\/g, '/');
+                const relativePath = './' + path_1.default.relative(basePath, dir).replaceAll(/\\/g, '/');
+                // Remove extension from file to naming the route
+                const key = file.replace(/\.ts$/, '');
+                if (dirInfo.isDirectory()) {
+                    // Dev friendly when enter in this conditional file is a directory(folder)
+                    const directory = file;
+                    // Recursion for sub directories
+                    routes[directory] = await mapRoutes(fullPath);
+                    // Skip this directory iteration
+                    continue;
+                }
+                routes[key] = {
+                    path: relativePath,
+                    import: importPath,
+                };
+            }
+            return routes;
+        };
+        try {
+            // Create routes
+            const routes = await mapRoutes(basePath);
+            // Cria arquivo TS exportando JSON
+            const tsContent = `// AUTO-GENERATED ROUTES\n\nconst routes = ${serializeRoutes(routes)};\n\nexport default routes;\n`;
+            // Write .ts file
+            await promises_1.default.writeFile(output, tsContent, 'utf-8');
+            console.log('🚀 Routes generated successfully!\n', output);
+            process.exit(0);
+        }
+        catch (err) {
+            console.error('❌ Error generating routes:', err);
+            process.exit(1);
+        }
+    };
+    generateRouter();
+};
+exports.start = start;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { start } from './file-router';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = void 0;
+var file_router_1 = require("./file-router");
+Object.defineProperty(exports, "start", { enumerable: true, get: function () { return file_router_1.start; } });
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,13 @@
+export type TStartConfigs = {
+    baseFolder: string;
+    outputFile: string;
+    routeFileName?: string;
+};
+export type TRoute = {
+    path: string;
+    import: string;
+};
+export type TRoutesTree = {
+    [key: string]: TRoute | TRoutesTree;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,CAAC;CACrC,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "ts-file-router",
+  "version": "1.0.0",
+  "description": "router based on project files using typescript",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "author": "MatheusF10",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}