ts-file-router 1.0.5 → 2.0.1

package/README.md

@@ -7,12 +7,12 @@ Automatically scans folders and outputs a clean, structured `routes.ts` tree rea
 
 ## ✨ Features
 
-- 🔍 Recursive folder scanning  
-- 📄 Auto-generated `routes.ts` (TypeScript code, no `resolveJsonModule` required)  
-- ⚛️ Works perfectly with `React.lazy()` and dynamic imports  
-- 📘 Full TypeScript `.d.ts` definitions included  
-- 🧩 Custom route file name (default: `page.ts`)  
-- 🪶 Zero runtime dependencies  
+- 🔍 Recursive folder scanning
+- 📄 Auto-generated `routes.ts` (TypeScript code, no `resolveJsonModule` required)
+- ⚛️ Works perfectly with `React.lazy()` and dynamic imports
+- 📘 Full TypeScript `.d.ts` definitions included
+- 🧩 Custom route file name (default: `page.ts`)
+- 🪶 Zero runtime dependencies
 - 🎯 Clean, formatted output with readable keys
 
 ---
@@ -23,3 +23,34 @@ Automatically scans folders and outputs a clean, structured `routes.ts` tree rea
 npm install ts-file-router
 # or
 yarn add ts-file-router
+
+```
+
+---
+
+## 🎯 Usage
+
+Create a script to generate your routes. Example:
+
+```js
+// scripts/generate-routes.mjs
+import { generateRoutes } from 'ts-file-router';
+
+generateRoutes({
+  baseFolder: 'src/screens',
+  outputFile: 'src/screens/routes.ts',
+  routeFileName: 'page.tsx',
+});
+```
+
+## What this does
+
+- baseFolder: Root directory where your screens/pages live
+
+- routeFileName: File that represents a route (e.g. page.tsx)
+
+- outputFile: Generated routes file (fully typed)
+
+Run the script with:
+
+node scripts/generate-routes.mjs

package/dist/file-router.d.ts

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

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

@@ -1 +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"}
+{"version":3,"file":"file-router.d.ts","sourceRoot":"","sources":["../src/file-router.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAG7D,eAAO,MAAM,cAAc,GAAI,4CAI5B,qBAAqB,SAiFvB,CAAC"}

package/dist/file-router.js

@@ -3,37 +3,16 @@ 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"));
+exports.generateRoutes = void 0;
 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.tsx', }) => {
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("./utils");
+const generateRoutes = ({ baseFolder, outputFile, routeFileName = 'page.tsx', }) => {
     // Get the pages dir to resolve routes
     const basePath = path_1.default.resolve(process.cwd(), baseFolder);
     // Output file for routes
-    const output = path_1.default.resolve(process.cwd(), outputFile);
-    const generateRouter = async () => {
+    const output = path_1.default.resolve(basePath, outputFile);
+    const createRoutes = async () => {
         const mapRoutes = async (dir) => {
             const routes = {};
             const directory = await promises_1.default.readdir(dir);
@@ -41,12 +20,18 @@ const start = ({ baseFolder, outputFile, routeFileName = 'page.tsx', }) => {
                 throw new Error(`Invalid pages structure: The folder "${dir}" must contain a ${routeFileName} file.`);
             }
             for (const file of directory) {
+                // ignore index files, underscore marked, or route file generated
+                if (file.includes('index') ||
+                    file.startsWith('_') ||
+                    file.includes(outputFile)) {
+                    continue;
+                }
                 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, '/');
+                const relativePath = '/' + path_1.default.relative(basePath, dir).replaceAll(/\\/g, '/');
                 // Remove extension from file to naming the route
                 const key = path_1.default.basename(file, path_1.default.extname(file));
                 if (dirInfo.isDirectory()) {
@@ -57,6 +42,8 @@ const start = ({ baseFolder, outputFile, routeFileName = 'page.tsx', }) => {
                     // Skip this directory iteration
                     continue;
                 }
+                // Mount the route object with path like "/folder" and import
+                // import will be like "(./baseFolder/file or ./baseFolder/folders).extension"
                 routes[key] = {
                     path: relativePath,
                     import: importPath,
@@ -67,18 +54,23 @@ const start = ({ baseFolder, outputFile, routeFileName = 'page.tsx', }) => {
         try {
             // Create routes
             const routes = await mapRoutes(basePath);
+            // Serialize object to typescript format
+            const ts = (0, utils_1.serializeTs)(routes);
             // Cria arquivo TS exportando JSON
-            const tsContent = `// AUTO-GENERATED ROUTES\n\nconst routes = ${serializeRoutes(routes)};\n\nexport default routes;\n`;
+            const tsContent = `// GENERATED-ROUTES-FROM-TS-FILE-ROUTER\n\nexport const routes = ${ts};\n`;
             // Write .ts file
             await promises_1.default.writeFile(output, tsContent, 'utf-8');
+            // Promise writeFile was successfully resolved
             console.log('🚀 Routes generated successfully!\n', output);
+            // Code 0 to finish the process as success
             process.exit(0);
         }
         catch (err) {
             console.error('❌ Error generating routes:', err);
+            // Code 1 to finish the process as error
             process.exit(1);
         }
     };
-    generateRouter();
+    createRoutes();
 };
-exports.start = start;
+exports.generateRoutes = generateRoutes;

package/dist/index.d.ts

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

package/dist/index.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,20 +1,5 @@
 "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;
+exports.generateRoutes = 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);
+Object.defineProperty(exports, "generateRoutes", { enumerable: true, get: function () { return file_router_1.generateRoutes; } });

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-export type TStartConfigs = {
+export type TGenerateRoutesConfig = {
     baseFolder: string;
     outputFile: string;
     routeFileName?: string;

package/dist/types.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAAG;IAClC,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/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './serializeTs';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/utils/index.js

@@ -0,0 +1,17 @@
+"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 });
+__exportStar(require("./serializeTs"), exports);

package/dist/utils/serializeTs.d.ts

@@ -0,0 +1,2 @@
+export declare const serializeTs: (obj: any, ident?: number) => string;
+//# sourceMappingURL=serializeTs.d.ts.map

package/dist/utils/serializeTs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializeTs.d.ts","sourceRoot":"","sources":["../../src/utils/serializeTs.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW,GAAI,KAAK,GAAG,EAAE,cAAS,KAAG,MA0BjD,CAAC"}

package/dist/utils/serializeTs.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeTs = void 0;
+const serializeTs = (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}: ${(0, exports.serializeTs)(value, ident + 2)},\n`;
+        }
+        else {
+            // Routes
+            str += `${pad}${keyStr}: { path: "${value.path}", import: "${value.import}" },\n`;
+        }
+    }
+    str += ' '.repeat(ident - 2) + '}';
+    return str;
+};
+exports.serializeTs = serializeTs;

package/package.json

@@ -1,20 +1,21 @@
-{
-  "name": "ts-file-router",
-  "version": "1.0.5",
-  "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"
-  }
-}
+{
+  "name": "ts-file-router",
+  "version": "2.0.1",
+  "description": "router based on project files using typescript",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "ts-node ./src/file-router",
+    "build": "tsc"
+  },
+  "author": "MatheusF10",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}