ts-file-router 1.0.5 → 2.0.2

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,72 @@ 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',
+});
+```
+
+## 🎯 Usage With Vite
+
+Create a script to generate your routes. Example:
+
+```js
+// scripts/vite.config.ts
+import { generateRoutesPlugin } from 'ts-file-router';
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [
+    generateRoutesPlugin({
+      baseFolder: 'src/screens',
+      outputFile: 'screens.ts',
+      exitCodeOnResolution: false,
+    }),
+  ],
+});
+```
+
+## 🎯 Usage With Watcher (Chokidar peerDependencie)
+
+Create a script to generate your routes. Example:
+
+```js
+// scripts/generate-routes.mjs
+import { generateRoutesWithWatcher } from 'ts-file-router';
+
+generateRoutesWithWatcher({
+  input: {
+    baseFolder: 'src/screens',
+    outputFile: 'screens.ts',
+    exitCodeOnResolution: false,
+  },
+  options: { debounce: 500 },
+});
+```
+
+## 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/generator.d.ts

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

package/dist/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAe,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGhE,eAAO,MAAM,cAAc,GAAI,kEAK5B,qBAAqB,SAqFvB,CAAC"}

package/dist/generator.js

@@ -0,0 +1,69 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { serialize } from './serialize.js';
+export const generateRoutes = ({ baseFolder, outputFile, routeFileName = 'page.tsx', exitCodeOnResolution = true, }) => {
+    // Get the pages dir to resolve routes
+    const basePath = path.resolve(process.cwd(), baseFolder);
+    // Output file for routes
+    const output = path.resolve(basePath, outputFile);
+    const mapRoutes = async (dir) => {
+        const routes = {};
+        const directory = await fs.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) {
+            // ignore index files, underscore marked, or route file generated
+            if (file.includes('index') ||
+                file.startsWith('_') ||
+                file.includes(outputFile)) {
+                continue;
+            }
+            const fullPath = path.join(dir, file);
+            // Get directory info to control file or folder
+            const dirInfo = await fs.stat(fullPath);
+            // Path to browser sync if necessary
+            const relativePath = '/' + path.relative(basePath, dir).replaceAll(/\\/g, '/');
+            // Normalize import path to esm pattern
+            const importPath = './' + path.relative(basePath, fullPath).replaceAll(/\\/g, '/');
+            // Remove extension from file to naming the route
+            const key = path.basename(file, path.extname(file));
+            if (dirInfo.isDirectory()) {
+                // Dev friendly when enter in this conditional file is a directory(folder)
+                const directory = file;
+                // Recursively for sub directories
+                routes[directory] = await mapRoutes(fullPath);
+                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,
+            };
+        }
+        return routes;
+    };
+    const createRoutes = async () => {
+        try {
+            // Create routes
+            const routes = await mapRoutes(basePath);
+            // Create ts file
+            serialize(routes, output);
+            // Promise writeFile was successfully resolved
+            console.log('🚀 Routes generated successfully!\n');
+            if (exitCodeOnResolution) {
+                // Code 0 to finish the process as success
+                process.exit(0);
+            }
+        }
+        catch (err) {
+            console.error('❌ Error generating routes:\n', err);
+            if (exitCodeOnResolution) {
+                // Code 1 to finish the process as error
+                process.exit(1);
+            }
+        }
+    };
+    createRoutes();
+};

package/dist/generatorWatcher.d.ts

@@ -0,0 +1,3 @@
+import { TWatcherConfig } from './types.js';
+export declare const generateRoutesWithWatcher: ({ input, options, }: TWatcherConfig) => Promise<() => Promise<void>>;
+//# sourceMappingURL=generatorWatcher.d.ts.map

package/dist/generatorWatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generatorWatcher.d.ts","sourceRoot":"","sources":["../src/generatorWatcher.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,eAAO,MAAM,yBAAyB,GAAU,qBAG7C,cAAc,iCA0BhB,CAAC"}

package/dist/generatorWatcher.js

@@ -0,0 +1,21 @@
+import { generateRoutes } from './generator.js';
+export const generateRoutesWithWatcher = async ({ input, options = { debounce: 500 }, }) => {
+    const { watch } = await import('chokidar');
+    let timeoutId;
+    const runFromWatcher = () => {
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+        timeoutId = setTimeout(() => {
+            generateRoutes(input);
+        }, options.debounce);
+    };
+    const watcher = watch(input.baseFolder, {
+        ignoreInitial: true,
+        ignored: `${input.baseFolder}/${input.outputFile}`,
+        persistent: true,
+    });
+    console.log(`👀 Watching folder: ${input.baseFolder} for changes...`);
+    watcher.on('add', runFromWatcher);
+    return () => watcher.close();
+};

package/dist/index.d.ts

@@ -1,3 +1,5 @@
-export { start } from './file-router';
-export * from './types';
+export { generateRoutes } from './generator.js';
+export { generateRoutesWithWatcher } from './generatorWatcher.js';
+export { generateRoutesPlugin } from './plugin.js';
+export { TGenerateRoutesConfig } from './types.js';
 //# 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,gBAAgB,CAAC;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -1,20 +1,3 @@
-"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);
+export { generateRoutes } from './generator.js';
+export { generateRoutesWithWatcher } from './generatorWatcher.js';
+export { generateRoutesPlugin } from './plugin.js';

package/dist/plugin.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from 'vite';
+import { TGenerateRoutesConfig } from './types.js';
+export declare const generateRoutesPlugin: ({ baseFolder, outputFile, exitCodeOnResolution, }: TGenerateRoutesConfig) => Plugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGnD,eAAO,MAAM,oBAAoB,GAAI,mDAIlC,qBAAqB,KAAG,MAW1B,CAAC"}

package/dist/plugin.js

@@ -0,0 +1,13 @@
+import { generateRoutesWithWatcher } from './generatorWatcher.js';
+export const generateRoutesPlugin = ({ baseFolder, outputFile, exitCodeOnResolution = false, }) => {
+    return {
+        name: 'file-router-plugin',
+        apply: 'serve',
+        buildStart() {
+            generateRoutesWithWatcher({
+                input: { baseFolder, outputFile, exitCodeOnResolution },
+                options: { debounce: 500 },
+            });
+        },
+    };
+};

package/dist/serialize.d.ts

@@ -0,0 +1,3 @@
+import type { TRoutesTree } from './types.js';
+export declare const serialize: (routes: TRoutesTree, outputPath: string) => void;
+//# sourceMappingURL=serialize.d.ts.map

package/dist/serialize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize.d.ts","sourceRoot":"","sources":["../src/serialize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAuB9C,eAAO,MAAM,SAAS,GAAI,QAAQ,WAAW,EAAE,YAAY,MAAM,SAMhE,CAAC"}

package/dist/serialize.js

@@ -0,0 +1,21 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+const stringifyTS = (obj, indent = 0) => {
+    const spaces = ' '.repeat(indent);
+    const innerSpaces = ' '.repeat(indent + 2);
+    if (typeof obj !== 'object' || obj === null) {
+        return JSON.stringify(obj);
+    }
+    const entries = Object.entries(obj).map(([key, value]) => {
+        const validKey = /^[a-z_$][a-z0-9_$]*$/i.test(key)
+            ? key
+            : JSON.stringify(key);
+        return `${innerSpaces}${validKey}: ${stringifyTS(value, indent + 2)}`;
+    });
+    return `{\n${entries.join(',\n')}\n${spaces}}`;
+};
+export const serialize = (routes, outputPath) => {
+    const content = `export const routes = ${stringifyTS(routes)} as const;\n`;
+    fs.mkdirSync(path.dirname(outputPath), { recursive: true });
+    fs.writeFileSync(outputPath, content, 'utf8');
+};

package/dist/types.d.ts

@@ -1,7 +1,15 @@
-export type TStartConfigs = {
+type TWatcherOptions = {
+    debounce?: number;
+};
+export type TWatcherConfig = {
+    input: TGenerateRoutesConfig;
+    options?: TWatcherOptions;
+};
+export type TGenerateRoutesConfig = {
     baseFolder: string;
     outputFile: string;
     routeFileName?: string;
+    exitCodeOnResolution?: boolean;
 };
 export type TRoute = {
     path: string;
@@ -10,4 +18,5 @@ export type TRoute = {
 export type TRoutesTree = {
     [key: string]: TRoute | TRoutesTree;
 };
+export {};
 //# sourceMappingURL=types.d.ts.map

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,KAAK,eAAe,GAAG;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,qBAAqB,CAAC;IAC7B,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,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

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

package/package.json

@@ -1,20 +1,30 @@
-{
-  "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.2",
+  "description": "router based on project files using typescript",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "start": "tsx ./src/generator.ts",
+    "prebuild": "rimraf dist",
+    "build": "tsc"
+  },
+  "author": "MatheusF10",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^24.10.1",
+    "chokidar": "^5.0.0",
+    "rimraf": "^6.1.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.0"
+  },
+  "peerDependencies": {
+    "chokidar": ">=4.0.0",
+    "vite": ">=3.0.0"
+  }
+}

package/dist/file-router.d.ts

@@ -1,3 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,84 +0,0 @@
-"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.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 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 = path_1.default.basename(file, path_1.default.extname(file));
-                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;