@arcpkg/initiator 0.0.1-beta.0.1

package/js/routing.js

@@ -0,0 +1,533 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { Pajo } from '@arcpkg/pajo';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export class RouteGenerator {
+    config;
+    routeFiles = [];
+    modules = new Set();
+    modulePathOverrides = new Map();
+    constructor(config = {}, dirname = __dirname) {
+        this.config = {
+            srcDir: config.srcDir || Pajo.join(dirname, 'src') || '',
+            modulesDir: config.modulesDir || Pajo.join(dirname, 'src\\modules') || '',
+            pagesDir: config.pagesDir || Pajo.join(dirname, 'src\\pages') || '',
+            outputFile: config.outputFile || Pajo.join(dirname, 'src\\auto-routes.tsx') || '',
+            layoutFileName: config.layoutFileName || '_layout',
+            errorFileName: config.errorFileName || '_error',
+            notFoundFileName: config.notFoundFileName || '_404'
+        };
+        console.log(`--> RouteGenerator config:: `, this.config);
+    }
+    async generate() {
+        console.log('🔍 Scanning for route files...');
+        await this.loadModulePathOverrides();
+        await this.findRouteFiles();
+        await this.generateAutoRoutesFile();
+        console.log(`✅ Generated ${this.config.outputFile} with ${this.routeFiles.length} routes`);
+        console.log(`📦 Found modules with routes: ${Array.from(this.modules).join(', ')}`);
+        console.log(`🔄 Module path overrides: ${Array.from(this.modulePathOverrides.entries()).map(([k, v]) => `${k} -> ${v}`).join(', ')}`);
+    }
+    async loadModulePathOverrides() {
+        try {
+            if (!fs.existsSync(this.config.modulesDir)) {
+                return;
+            }
+            const moduleDirs = fs.readdirSync(this.config.modulesDir, { withFileTypes: true })
+                .filter(dirent => dirent.isDirectory())
+                .map(dirent => dirent.name);
+            for (const moduleName of moduleDirs) {
+                const configPath = path.join(this.config.modulesDir, moduleName, 'config.json');
+                if (fs.existsSync(configPath)) {
+                    try {
+                        const configContent = fs.readFileSync(configPath, 'utf-8');
+                        const config = JSON.parse(configContent);
+                        if (config.path && typeof config.path === 'string') {
+                            let modulePath = config.path.trim();
+                            if (modulePath.startsWith('/')) {
+                                modulePath = modulePath.substring(1);
+                            }
+                            if (modulePath.endsWith('/')) {
+                                modulePath = modulePath.slice(0, -1);
+                            }
+                            if (modulePath) {
+                                this.modulePathOverrides.set(moduleName, modulePath);
+                                console.log(`🔄 Module ${moduleName} path override: ${modulePath}`);
+                            }
+                        }
+                    }
+                    catch (error) {
+                        console.error(`Error reading config.json for module ${moduleName}:`, error);
+                    }
+                }
+            }
+        }
+        catch (error) {
+            console.error('Error loading module path overrides:', error);
+        }
+    }
+    async findRouteFiles() {
+        this.routeFiles = [];
+        await this.scanDirectoryForRoutes(this.config.pagesDir);
+        if (fs.existsSync(this.config.modulesDir)) {
+            const moduleDirs = fs.readdirSync(this.config.modulesDir, { withFileTypes: true })
+                .filter(dirent => dirent.isDirectory())
+                .map(dirent => dirent.name);
+            for (const moduleName of moduleDirs) {
+                const modulePagesDir = path.join(this.config.modulesDir, moduleName, 'pages');
+                if (fs.existsSync(modulePagesDir)) {
+                    this.modules.add(moduleName);
+                    await this.scanDirectoryForRoutes(modulePagesDir, moduleName);
+                }
+            }
+        }
+    }
+    async scanDirectoryForRoutes(dir, moduleName) {
+        try {
+            const items = fs.readdirSync(dir, { withFileTypes: true });
+            for (const item of items) {
+                const fullPath = path.join(dir, item.name);
+                if (item.name === 'node_modules' ||
+                    item.name === 'dist' ||
+                    item.name === 'build' ||
+                    item.name.startsWith('.')) {
+                    continue;
+                }
+                if (item.isDirectory()) {
+                    await this.scanDirectoryForRoutes(fullPath, moduleName);
+                }
+                else if (item.isFile()) {
+                    const ext = path.extname(item.name).toLowerCase();
+                    if (['.tsx', '.jsx'].includes(ext)) {
+                        const fileName = path.basename(item.name, ext);
+                        if (fileName === this.config.layoutFileName ||
+                            fileName === this.config.errorFileName ||
+                            fileName === this.config.notFoundFileName) {
+                            continue;
+                        }
+                        await this.processRouteFile(fullPath, moduleName);
+                    }
+                }
+            }
+        }
+        catch (error) {
+            console.error(`Error scanning directory ${dir}:`, error);
+        }
+    }
+    async processRouteFile(filePath, moduleName) {
+        try {
+            let routePath = this.convertFilePathToRoutePath(filePath, moduleName);
+            const componentName = this.extractComponentName(filePath, moduleName);
+            const layoutComponent = this.findLayoutComponent(filePath, moduleName);
+            const errorComponent = this.findErrorComponent(filePath, moduleName);
+            const notFoundComponent = this.findNotFoundComponent(filePath, moduleName);
+            const routeFile = {
+                filePath,
+                relativePath: path.relative(this.config.srcDir, filePath),
+                routePath,
+                componentName,
+                layoutComponent,
+                errorComponent,
+                notFoundComponent,
+                moduleName
+            };
+            this.routeFiles.push(routeFile);
+        }
+        catch (error) {
+            console.error(`Error processing route file ${filePath}:`, error);
+        }
+    }
+    convertFilePathToRoutePath(filePath, moduleName) {
+        let routePath = filePath;
+        routePath = routePath.replace(this.config.srcDir, '');
+        if (moduleName) {
+            const modulePagesPrefix = `modules${path.sep}${moduleName}${path.sep}pages`;
+            if (routePath.includes(modulePagesPrefix)) {
+                routePath = routePath.substring(routePath.indexOf(modulePagesPrefix) + modulePagesPrefix.length);
+                let modulePrefix = `/${moduleName}`;
+                if (this.modulePathOverrides.has(moduleName)) {
+                    const overridePath = this.modulePathOverrides.get(moduleName);
+                    if (overridePath) {
+                        modulePrefix = `/${overridePath}`;
+                    }
+                }
+                routePath = modulePrefix + routePath;
+            }
+        }
+        else {
+            const pagesPrefix = 'pages';
+            if (routePath.includes(pagesPrefix)) {
+                routePath = routePath.substring(routePath.indexOf(pagesPrefix) + pagesPrefix.length);
+            }
+        }
+        routePath = routePath.replace(/\.(tsx|jsx)$/, '');
+        routePath = routePath.replace(/\\/g, '/');
+        if (routePath.endsWith('/index')) {
+            routePath = routePath.replace(/\/index$/, '');
+        }
+        routePath = routePath.replace(/\[([^\]]+)\]/g, '{$1}');
+        if (!routePath.startsWith('/')) {
+            routePath = '/' + routePath;
+        }
+        if (routePath === '/' || routePath === '//') {
+            return '/';
+        }
+        return routePath;
+    }
+    extractComponentName(filePath, moduleName) {
+        const fileName = path.basename(filePath, path.extname(filePath));
+        const dirName = path.dirname(filePath);
+        const parts = dirName.split(path.sep);
+        let startIndex = 0;
+        if (moduleName) {
+            const modulePagesPath = path.sep + 'modules' + path.sep + moduleName + path.sep + 'pages';
+            startIndex = parts.findIndex((part, index, arr) => {
+                const pathSoFar = arr.slice(0, index + 1).join(path.sep);
+                return pathSoFar.endsWith(modulePagesPath);
+            }) + 1;
+        }
+        else {
+            const pagesPath = path.sep + 'pages';
+            startIndex = parts.findIndex((part, index, arr) => {
+                const pathSoFar = arr.slice(0, index + 1).join(path.sep);
+                return pathSoFar.endsWith(pagesPath);
+            }) + 1;
+        }
+        if (startIndex < 0)
+            startIndex = 0;
+        const relevantParts = parts.slice(startIndex);
+        let componentName = moduleName ? this.toPascalCase(moduleName) : '';
+        relevantParts.forEach(part => {
+            if (part && part !== 'pages') {
+                componentName += this.toPascalCase(part);
+            }
+        });
+        let fileNamePart = fileName;
+        if (fileName.startsWith('{') && fileName.endsWith('}')) {
+            const paramName = fileName.substring(1, fileName.length - 1);
+            fileNamePart = this.toPascalCase(paramName) + 'Params';
+        }
+        else {
+            fileNamePart = this.toPascalCase(fileName);
+        }
+        if (!fileNamePart.endsWith('Page')) {
+            fileNamePart += 'Page';
+        }
+        const reservedNames = ['Layout', 'ErrorBoundary', 'NotFound'];
+        if (reservedNames.includes(fileNamePart)) {
+            fileNamePart += 'Component';
+        }
+        return componentName + fileNamePart;
+    }
+    toPascalCase(str) {
+        if (!str)
+            return '';
+        return str
+            .split(/[-_]/)
+            .map(part => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase())
+            .join('');
+    }
+    findLayoutComponent(filePath, moduleName) {
+        const dir = path.dirname(filePath);
+        let currentDir = dir;
+        while (currentDir !== this.config.srcDir && currentDir !== path.dirname(this.config.srcDir)) {
+            const layoutPath = path.join(currentDir, `${this.config.layoutFileName}.tsx`);
+            if (fs.existsSync(layoutPath)) {
+                return this.generateComponentName(layoutPath, moduleName, 'Layout');
+            }
+            if (moduleName) {
+                const modulePath = path.join(this.config.modulesDir, moduleName);
+                if (currentDir === modulePath) {
+                    break;
+                }
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        const globalLayoutPath = path.join(this.config.pagesDir, `${this.config.layoutFileName}.tsx`);
+        if (fs.existsSync(globalLayoutPath)) {
+            return 'Layout';
+        }
+        return undefined;
+    }
+    findErrorComponent(filePath, moduleName) {
+        const dir = path.dirname(filePath);
+        let currentDir = dir;
+        while (currentDir !== this.config.srcDir && currentDir !== path.dirname(this.config.srcDir)) {
+            const errorPath = path.join(currentDir, `${this.config.errorFileName}.tsx`);
+            if (fs.existsSync(errorPath)) {
+                return this.generateComponentName(errorPath, moduleName, 'ErrorBoundary');
+            }
+            if (moduleName) {
+                const modulePath = path.join(this.config.modulesDir, moduleName);
+                if (currentDir === modulePath) {
+                    break;
+                }
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        const globalErrorPath = path.join(this.config.pagesDir, `${this.config.errorFileName}.tsx`);
+        if (fs.existsSync(globalErrorPath)) {
+            return 'ErrorBoundary';
+        }
+        return undefined;
+    }
+    findNotFoundComponent(filePath, moduleName) {
+        if (!moduleName)
+            return undefined;
+        const modulePagesDir = path.join(this.config.modulesDir, moduleName, 'pages');
+        const notFoundPath = path.join(modulePagesDir, `${this.config.notFoundFileName}.tsx`);
+        if (fs.existsSync(notFoundPath)) {
+            return this.generateComponentName(notFoundPath, moduleName, 'NotFound');
+        }
+        return undefined;
+    }
+    generateComponentName(filePath, moduleName, suffix) {
+        if (!moduleName) {
+            return suffix;
+        }
+        const fileName = path.basename(filePath, path.extname(filePath));
+        const dirName = path.dirname(filePath);
+        const modulePagesPath = path.join(this.config.modulesDir, moduleName, 'pages');
+        const relativePath = path.relative(modulePagesPath, dirName);
+        let componentName = this.toPascalCase(moduleName);
+        if (relativePath && relativePath !== '.') {
+            const dirParts = relativePath.split(path.sep).filter(part => part && part !== '.');
+            dirParts.forEach(part => {
+                componentName += this.toPascalCase(part);
+            });
+        }
+        if (fileName !== this.config.layoutFileName &&
+            fileName !== this.config.errorFileName &&
+            fileName !== this.config.notFoundFileName) {
+            componentName += this.toPascalCase(fileName);
+        }
+        return componentName + suffix;
+    }
+    async generateAutoRoutesFile() {
+        const outputDir = path.dirname(this.config.outputFile);
+        if (!fs.existsSync(outputDir)) {
+            fs.mkdirSync(outputDir, { recursive: true });
+        }
+        const content = this.generateFileContent();
+        fs.writeFileSync(this.config.outputFile, content, 'utf-8');
+    }
+    getRelativeImportPath(targetPath) {
+        const outputDir = path.dirname(this.config.outputFile);
+        const relative = path.relative(outputDir, targetPath);
+        let importPath = relative.replace(/\\/g, '/');
+        if (!importPath.startsWith('.') && !importPath.startsWith('/')) {
+            importPath = './' + importPath;
+        }
+        importPath = importPath.replace(/\.(tsx|jsx)$/, '');
+        return importPath;
+    }
+    generateFileContent() {
+        const components = new Set();
+        const imports = [
+            `import { lazy } from 'react';`,
+            `import type { RouteObject } from 'react-router-dom';`,
+            ``
+        ];
+        const globalLayoutPath = path.join(this.config.pagesDir, `${this.config.layoutFileName}.tsx`);
+        const globalErrorPath = path.join(this.config.pagesDir, `${this.config.errorFileName}.tsx`);
+        const global404Path = path.join(this.config.pagesDir, `${this.config.notFoundFileName}.tsx`);
+        if (fs.existsSync(globalLayoutPath)) {
+            const importPath = this.getRelativeImportPath(globalLayoutPath);
+            imports.push(`const Layout = lazy(() => import('${importPath}'));`);
+            components.add('Layout');
+        }
+        if (fs.existsSync(globalErrorPath)) {
+            const importPath = this.getRelativeImportPath(globalErrorPath);
+            imports.push(`const ErrorBoundary = lazy(() => import('${importPath}'));`);
+            components.add('ErrorBoundary');
+        }
+        if (fs.existsSync(global404Path)) {
+            const importPath = this.getRelativeImportPath(global404Path);
+            imports.push(`const NotFound = lazy(() => import('${importPath}'));`);
+            components.add('NotFound');
+        }
+        imports.push(``);
+        const specialComponents = new Map();
+        const findSpecialFiles = (baseDir, isModule = false, moduleName) => {
+            if (!fs.existsSync(baseDir))
+                return;
+            const walkDir = (dir) => {
+                try {
+                    const items = fs.readdirSync(dir, { withFileTypes: true });
+                    for (const item of items) {
+                        const fullPath = path.join(dir, item.name);
+                        if (item.isDirectory()) {
+                            walkDir(fullPath);
+                        }
+                        else if (item.isFile()) {
+                            const ext = path.extname(item.name).toLowerCase();
+                            if (['.tsx', '.jsx'].includes(ext)) {
+                                const fileName = path.basename(item.name, ext);
+                                if (fileName === this.config.layoutFileName ||
+                                    fileName === this.config.errorFileName ||
+                                    fileName === this.config.notFoundFileName) {
+                                    const componentName = this.generateComponentName(fullPath, moduleName, fileName === this.config.layoutFileName ? 'Layout' :
+                                        fileName === this.config.errorFileName ? 'ErrorBoundary' : 'NotFound');
+                                    if (!components.has(componentName)) {
+                                        specialComponents.set(fullPath, componentName);
+                                        components.add(componentName);
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+                catch (error) {
+                    console.error(`Error walking directory ${dir}:`, error);
+                }
+            };
+            walkDir(baseDir);
+        };
+        findSpecialFiles(this.config.pagesDir, false);
+        this.modules.forEach(moduleName => {
+            const modulePagesDir = path.join(this.config.modulesDir, moduleName, 'pages');
+            if (fs.existsSync(modulePagesDir)) {
+                findSpecialFiles(modulePagesDir, true, moduleName);
+            }
+        });
+        specialComponents.forEach((componentName, filePath) => {
+            const importPath = this.getRelativeImportPath(filePath);
+            imports.push(`const ${componentName} = lazy(() => import('${importPath}'));`);
+        });
+        if (specialComponents.size > 0) {
+            imports.push(``);
+        }
+        this.routeFiles.forEach(route => {
+            const importPath = this.getRelativeImportPath(route.filePath);
+            imports.push(`const ${route.componentName} = lazy(() => import('${importPath}'));`);
+            components.add(route.componentName);
+        });
+        imports.push(``);
+        const routes = ['export const routes: RouteObject[] = ['];
+        const sortedRoutes = this.routeFiles.sort((a, b) => {
+            if (a.routePath === '/')
+                return -1;
+            if (b.routePath === '/')
+                return 1;
+            if (!a.moduleName && b.moduleName)
+                return -1;
+            if (a.moduleName && !b.moduleName)
+                return 1;
+            if (a.moduleName === b.moduleName) {
+                return a.routePath.localeCompare(b.routePath);
+            }
+            return 0;
+        });
+        let lastModuleName = undefined;
+        sortedRoutes.forEach((route, index) => {
+            if (route.moduleName !== lastModuleName) {
+                if (lastModuleName !== undefined) {
+                    routes.push(``);
+                }
+                if (route.moduleName) {
+                    let displayName = route.moduleName;
+                    if (this.modulePathOverrides.has(route.moduleName)) {
+                        const overridePath = this.modulePathOverrides.get(route.moduleName);
+                        displayName = `${route.moduleName} (path: ${overridePath})`;
+                    }
+                    routes.push(`  // ${displayName} module routes`);
+                }
+                lastModuleName = route.moduleName;
+            }
+            const routeLines = ['  {'];
+            routeLines.push(`    path: '${route.routePath.replace(/\{([^}]+)\}/g, ':$1')}',`);
+            let layoutComponent = route.layoutComponent;
+            if (!layoutComponent && route.moduleName) {
+                const moduleLayoutPath = path.join(this.config.modulesDir, route.moduleName, 'pages', `${this.config.layoutFileName}.tsx`);
+                if (fs.existsSync(moduleLayoutPath)) {
+                    layoutComponent = this.generateComponentName(moduleLayoutPath, route.moduleName, 'Layout');
+                }
+            }
+            if (layoutComponent) {
+                routeLines.push(`    element: <${layoutComponent}><${route.componentName} /></${layoutComponent}>,`);
+            }
+            else {
+                routeLines.push(`    element: <${route.componentName} />,`);
+            }
+            let errorComponent = route.errorComponent;
+            if (!errorComponent && route.moduleName) {
+                const moduleErrorPath = path.join(this.config.modulesDir, route.moduleName, 'pages', `${this.config.errorFileName}.tsx`);
+                if (fs.existsSync(moduleErrorPath)) {
+                    errorComponent = this.generateComponentName(moduleErrorPath, route.moduleName, 'ErrorBoundary');
+                }
+            }
+            if (errorComponent) {
+                routeLines.push(`    errorElement: <${errorComponent} />`);
+            }
+            if (routeLines[routeLines.length - 1].endsWith(',')) {
+                routeLines[routeLines.length - 1] = routeLines[routeLines.length - 1].slice(0, -1);
+            }
+            routeLines.push('  }');
+            if (index < sortedRoutes.length - 1) {
+                routeLines[routeLines.length - 1] += ',';
+            }
+            routes.push(routeLines.join('\n'));
+        });
+        const modulesWith404 = new Set();
+        specialComponents.forEach((componentName, filePath) => {
+            const fileName = path.basename(filePath, path.extname(filePath));
+            if (fileName === this.config.notFoundFileName) {
+                const pathParts = filePath.split(path.sep);
+                const modulesIndex = pathParts.indexOf('modules');
+                if (modulesIndex !== -1 && modulesIndex + 1 < pathParts.length) {
+                    const moduleName = pathParts[modulesIndex + 1];
+                    if (!modulesWith404.has(moduleName)) {
+                        modulesWith404.add(moduleName);
+                        if (routes[routes.length - 1].endsWith(',')) {
+                            routes[routes.length - 1] = routes[routes.length - 1].slice(0, -1);
+                        }
+                        let moduleRoutePath = `/${moduleName}`;
+                        if (this.modulePathOverrides.has(moduleName)) {
+                            const overridePath = this.modulePathOverrides.get(moduleName);
+                            if (overridePath) {
+                                moduleRoutePath = `/${overridePath}`;
+                            }
+                        }
+                        routes.push(`,`);
+                        routes.push(`  {`);
+                        routes.push(`    path: '${moduleRoutePath}/*',`.replace(/\{([^}]+)\}/g, ':$1'));
+                        routes.push(`    element: <${componentName} />`);
+                        routes.push(`  }`);
+                    }
+                }
+            }
+        });
+        if (components.has('NotFound')) {
+            if (routes[routes.length - 1].endsWith(',')) {
+                routes[routes.length - 1] = routes[routes.length - 1].slice(0, -1);
+            }
+            routes.push(`,`);
+            routes.push(`  {`);
+            routes.push(`    path: '*',`.replace(/\{([^}]+)\}/g, ':$1'));
+            routes.push(`    element: <NotFound />`);
+            routes.push(`  }`);
+        }
+        routes.push('];');
+        routes.push('');
+        routes.push('export default routes;');
+        return [
+            ...imports,
+            '',
+            ...routes
+        ].join('\n');
+    }
+}
+async function RouteInitiator(dirname = __dirname) {
+    const config = {};
+    const generator = new RouteGenerator(config, dirname);
+    try {
+        await generator.generate();
+        console.log('🎉 Route generation completed successfully!');
+    }
+    catch (err) {
+        console.error('❌ Failed to generate routes: ', err);
+    }
+}
+export default RouteInitiator;