feat: experimental simple routes typings code generation

Author: JulianCataldo

packages/engine/src/dev/dev.ts

@@ -8,6 +8,7 @@ import {
 	type GracileHandler,
 } from '../server/request.js';
 import type { GracileConfig } from '../user-config.js';
+import { generateRoutesTypings } from './route-typings.js';
 
 export async function createDevHandler({
 	vite,
@@ -24,6 +25,11 @@ export async function createDevHandler({
 
 	const routes = await collectRoutes(root, gracileConfig.routes?.exclude);
 
+	if (gracileConfig.experimental?.generateRoutesTypings)
+		generateRoutesTypings(root, routes).catch((error) =>
+			logger.error(String(error)),
+		);
+
 	vite.watcher.on('all', (event, file) => {
 		// console.log({ event });
 		if (
@@ -33,6 +39,11 @@ export async function createDevHandler({
 			collectRoutes(root, gracileConfig.routes?.exclude)
 				.then(() => {
 					vite.hot.send('vite:invalidate');
+
+					if (gracileConfig.experimental?.generateRoutesTypings)
+						generateRoutesTypings(root, routes).catch((error) =>
+							logger.error(String(error)),
+						);
 				})
 				.catch((e) => logger.error(String(e)));
 	});

packages/engine/src/dev/route-typings.ts

@@ -0,0 +1,43 @@
+import { mkdir } from 'node:fs/promises';
+import { join } from 'node:path';
+
+import { writeFile } from 'fs/promises';
+
+import type { RoutesManifest } from '../routes/route.js';
+
+export async function generateRoutesTypings(
+	root: string,
+	routes: RoutesManifest,
+) {
+	// NOTE: For future, we'll provide parameters like:
+	// `route('/blog/:id', { id: 'foo' })`.
+	//
+	// export const route: (path: string, params?: Params) => string;
+	//
+
+	const typings = `declare module 'gracile:route' {
+	export const route: (path: Route) => string;
+}
+
+export type Route =
+	| ${[...routes]
+		.map(
+			([v]) =>
+				`\`${v
+					.replace(
+						/\{:(.*)\}/,
+						// eslint-disable-next-line no-template-curly-in-string
+						'${string}',
+					)
+					.replace(
+						/:(.*?)\*\//,
+						// eslint-disable-next-line no-template-curly-in-string
+						'${string}',
+					)}\``,
+		)
+		.join('\n	| ')};
+`;
+
+	await mkdir(join(root, '.gracile')).catch(() => null);
+	await writeFile(join(root, '.gracile/routes.d.ts'), typings);
+}

packages/engine/src/plugin.ts

@@ -55,6 +55,37 @@ export const gracile = (config?: GracileConfig): any /* Plugin */[] => {
 	isClientBuilt = true;
 
 	return [
+		{
+			name: 'gracile-routes-codegen',
+
+			// watchChange(change) {
+			// 	console.log({ change });
+			// },
+
+			resolveId(id) {
+				const virtualModuleId = 'gracile:route';
+				const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+
+				if (id === virtualModuleId) {
+					return resolvedVirtualModuleId;
+				}
+				return null;
+			},
+
+			load(id) {
+				const virtualModuleId = 'gracile:route';
+				const resolvedVirtualModuleId = `\0${virtualModuleId}`;
+
+				if (id === resolvedVirtualModuleId) {
+					return `
+export function route(input){
+return input;
+}`;
+				}
+				return null;
+			},
+		},
+
 		{
 			name: 'vite-plugin-gracile-serve-middleware',
 
@@ -117,7 +148,7 @@ export const gracile = (config?: GracileConfig): any /* Plugin */[] => {
 					root: viteConfig.root || process.cwd(),
 
 					server: { middlewareMode: true },
-					// NOTE: Stub
+					// NOTE: Stub. KEEP IT!
 					optimizeDeps: { include: [] },
 				});
 

packages/engine/src/user-config.ts

@@ -61,4 +61,14 @@ export interface GracileConfig {
 		 */
 		exclude?: string[];
 	};
+
+	/**
+	 * Future, unstable features flags.
+	 */
+	experimental?: {
+		/**
+		 * Exclude routes with an array of patterns. Useful for debugging.
+		 */
+		generateRoutesTypings?: boolean;
+	};
 }