@octanejs/tanstack-start 0.1.0

package/src/internal/router-generator/index.d.ts

@@ -0,0 +1,40 @@
+export { configSchema, getConfig, resolveConfigPath, baseConfigSchema } from './config.js';
+export type { Config, BaseConfig } from './config.js';
+export { Generator } from './generator.js';
+export type { FileEventType, FileEvent, GeneratorEvent } from './generator.js';
+export type {
+	FormatRouteOptions,
+	GeneratorPlugin,
+	TransformRouteSourceOptions,
+} from './plugin/types.js';
+export {
+	capitalize,
+	cleanPath,
+	trimPathLeft,
+	removeLeadingSlash,
+	removeTrailingSlash,
+	determineInitialRoutePath,
+	replaceBackslash,
+	routePathToVariable,
+	removeUnderscores,
+	resetRegex,
+	multiSortBy,
+	writeIfDifferent,
+	format,
+	removeExt,
+	checkRouteFullPathUniqueness,
+	inferFullPath,
+} from './utils.js';
+export type {
+	RouteNode,
+	GetRouteNodesResult,
+	GetRoutesByFileMapResult,
+	GetRoutesByFileMapResultValue,
+	ImportDeclaration,
+	ImportSpecifier,
+	HandleNodeAccumulator,
+} from './types.js';
+export { getRouteNodes as physicalGetRouteNodes } from './filesystem/physical/getRouteNodes.js';
+export { getRouteNodes as virtualGetRouteNodes } from './filesystem/virtual/getRouteNodes.js';
+export { rootPathId } from './filesystem/physical/rootPathId.js';
+export type { TransformContext, TransformOptions, TransformResult } from './transform/types.js';

package/src/internal/router-generator/index.js

@@ -0,0 +1,49 @@
+import { baseConfigSchema, configSchema, getConfig, resolveConfigPath } from './config.js';
+import { rootPathId } from './filesystem/physical/rootPathId.js';
+import {
+	capitalize,
+	checkRouteFullPathUniqueness,
+	cleanPath,
+	determineInitialRoutePath,
+	format,
+	inferFullPath,
+	multiSortBy,
+	removeExt,
+	removeLeadingSlash,
+	removeTrailingSlash,
+	removeUnderscores,
+	replaceBackslash,
+	resetRegex,
+	routePathToVariable,
+	trimPathLeft,
+	writeIfDifferent,
+} from './utils.js';
+import { getRouteNodes as getRouteNodes$1 } from './filesystem/virtual/getRouteNodes.js';
+import { getRouteNodes } from './filesystem/physical/getRouteNodes.js';
+import { Generator } from './generator.js';
+export {
+	Generator,
+	baseConfigSchema,
+	capitalize,
+	checkRouteFullPathUniqueness,
+	cleanPath,
+	configSchema,
+	determineInitialRoutePath,
+	format,
+	getConfig,
+	inferFullPath,
+	multiSortBy,
+	getRouteNodes as physicalGetRouteNodes,
+	removeExt,
+	removeLeadingSlash,
+	removeTrailingSlash,
+	removeUnderscores,
+	replaceBackslash,
+	resetRegex,
+	resolveConfigPath,
+	rootPathId,
+	routePathToVariable,
+	trimPathLeft,
+	getRouteNodes$1 as virtualGetRouteNodes,
+	writeIfDifferent,
+};

package/src/internal/router-generator/logger.d.ts

@@ -0,0 +1,8 @@
+export interface Logger {
+	log: (...args: Array<any>) => void;
+	debug: (...args: Array<any>) => void;
+	info: (...args: Array<any>) => void;
+	warn: (...args: Array<any>) => void;
+	error: (...args: Array<any>) => void;
+}
+export declare function logging(config: { disabled: boolean }): Logger;

package/src/internal/router-generator/logger.js

@@ -0,0 +1,30 @@
+//#region src/logger.ts
+function logging(config) {
+	function stripEmojis(str) {
+		return str.replace(/[\p{Emoji_Presentation}\p{Extended_Pictographic}]/gu, '');
+	}
+	function formatLogArgs(args) {
+		if (process.env.CI)
+			return args.map((arg) => (typeof arg === 'string' ? stripEmojis(arg) : arg));
+		return args;
+	}
+	return {
+		log: (...args) => {
+			if (!config.disabled) console.log(...formatLogArgs(args));
+		},
+		debug: (...args) => {
+			if (!config.disabled) console.debug(...formatLogArgs(args));
+		},
+		info: (...args) => {
+			if (!config.disabled) console.info(...formatLogArgs(args));
+		},
+		warn: (...args) => {
+			if (!config.disabled) console.warn(...formatLogArgs(args));
+		},
+		error: (...args) => {
+			if (!config.disabled) console.error(...formatLogArgs(args));
+		},
+	};
+}
+//#endregion
+export { logging };

package/src/internal/router-generator/plugin/types.d.ts

@@ -0,0 +1,37 @@
+import { HandleNodeAccumulator, RouteNode } from '../types.js';
+import { Generator } from '../generator.js';
+export interface TransformRouteSourceOptions {
+	source: string;
+	filename: string;
+	node: RouteNode;
+}
+export interface FormatRouteOptions {
+	source: string;
+	node: RouteNode;
+}
+export interface GeneratorPlugin {
+	name: string;
+	init?: (opts: { generator: Generator }) => void;
+	onRouteTreeChanged?: (opts: {
+		routeTree: Array<RouteNode>;
+		routeNodes: Array<RouteNode>;
+		rootRouteNode: RouteNode;
+		acc: HandleNodeAccumulator;
+	}) => void;
+	afterTransform?: (opts: { node: RouteNode; prevNode: RouteNode | undefined }) => void;
+	/**
+	 * Converts framework-specific route syntax into position-preserving
+	 * TypeScript/JSX for route analysis. Hooks run in plugin order and each
+	 * returned value is passed to the next hook. The final source must have the
+	 * same length as the authored source. It is never emitted.
+	 */
+	transformRouteSource?: (
+		opts: TransformRouteSourceOptions,
+	) => string | void | Promise<string | void>;
+	/**
+	 * Formats a newly scaffolded route. Hooks run in plugin order and each
+	 * returned value is passed to the next hook. The built-in TypeScript
+	 * formatter is used only when no plugin handles the route.
+	 */
+	formatRoute?: (opts: FormatRouteOptions) => string | void | Promise<string | void>;
+}

package/src/internal/router-generator/template.d.ts

@@ -0,0 +1,38 @@
+import { Config } from './config.js';
+type TemplateTag = 'tsrImports' | 'tsrPath' | 'tsrExportStart' | 'tsrExportEnd';
+export declare function fillTemplate(
+	config: Config,
+	template: string,
+	values: Record<TemplateTag, string>,
+	formatter?: (source: string) => string | Promise<string>,
+): string | Promise<string>;
+export type TargetTemplate = {
+	fullPkg: string;
+	subPkg: string;
+	rootRoute: {
+		template: () => string;
+		imports: {
+			tsrImports: () => string;
+			tsrExportStart: () => string;
+			tsrExportEnd: () => string;
+		};
+	};
+	route: {
+		template: () => string;
+		imports: {
+			tsrImports: () => string;
+			tsrExportStart: (routePath: string) => string;
+			tsrExportEnd: () => string;
+		};
+	};
+	lazyRoute: {
+		template: () => string;
+		imports: {
+			tsrImports: () => string;
+			tsrExportStart: (routePath: string) => string;
+			tsrExportEnd: () => string;
+		};
+	};
+};
+export declare function getTargetTemplate(config: Config): TargetTemplate;
+export {};

package/src/internal/router-generator/template.js

@@ -0,0 +1,220 @@
+import { format } from './utils.js';
+import { OCTANE_ROUTER_PACKAGE } from '#tanstack-start/package-names';
+//#region src/template.ts
+function fillTemplate(config, template, values, formatter) {
+	const replaced = template.replace(/%%(\w+)%%/g, (_, key) => values[key] || '');
+	return formatter ? formatter(replaced) : format(replaced, config);
+}
+function serializeRoutePath(routePath) {
+	return JSON.stringify(routePath);
+}
+function getTargetTemplate(config) {
+	const target = config.target;
+	switch (target) {
+		case 'react':
+			return {
+				fullPkg: '@tanstack/react-router',
+				subPkg: 'react-router',
+				rootRoute: {
+					template: () =>
+						[
+							'import * as React from "react"\n',
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RootComponent\n }%%tsrExportEnd%%\n\n',
+							'function RootComponent() { return (<React.Fragment><div>Hello "%%tsrPath%%"!</div><Outlet /></React.Fragment>) };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { Outlet, createRootRoute } from '@tanstack/react-router';",
+						tsrExportStart: () => 'export const Route = createRootRoute(',
+						tsrExportEnd: () => ');',
+					},
+				},
+				route: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { createFileRoute } from '@tanstack/react-router';",
+						tsrExportStart: (routePath) =>
+							`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+				lazyRoute: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { createLazyFileRoute } from '@tanstack/react-router';",
+						tsrExportStart: (routePath) =>
+							`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+			};
+		case 'solid':
+			return {
+				fullPkg: '@tanstack/solid-router',
+				subPkg: 'solid-router',
+				rootRoute: {
+					template: () =>
+						[
+							'import * as Solid from "solid-js"\n',
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RootComponent\n }%%tsrExportEnd%%\n\n',
+							'function RootComponent() { return (<><div>Hello "%%tsrPath%%"!</div><Outlet /></>) };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { Outlet, createRootRoute } from '@tanstack/solid-router';",
+						tsrExportStart: () => 'export const Route = createRootRoute(',
+						tsrExportEnd: () => ');',
+					},
+				},
+				route: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { createFileRoute } from '@tanstack/solid-router';",
+						tsrExportStart: (routePath) =>
+							`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+				lazyRoute: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() { return <div>Hello "%%tsrPath%%"!</div> };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { createLazyFileRoute } from '@tanstack/solid-router';",
+						tsrExportStart: (routePath) =>
+							`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+			};
+		case 'vue':
+			return {
+				fullPkg: '@tanstack/vue-router',
+				subPkg: 'vue-router',
+				rootRoute: {
+					template: () =>
+						[
+							'import { h } from "vue"\n',
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RootComponent\n }%%tsrExportEnd%%\n\n',
+							'function RootComponent() { return h("div", {}, ["Hello \\"%%tsrPath%%\\"!", h(Outlet)]) };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { Outlet, createRootRoute } from '@tanstack/vue-router';",
+						tsrExportStart: () => 'export const Route = createRootRoute(',
+						tsrExportEnd: () => ');',
+					},
+				},
+				route: {
+					template: () =>
+						[
+							'import { h } from "vue"\n',
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() { return h("div", {}, "Hello \\"%%tsrPath%%\\"!") };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { createFileRoute } from '@tanstack/vue-router';",
+						tsrExportStart: (routePath) =>
+							`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+				lazyRoute: {
+					template: () =>
+						[
+							'import { h } from "vue"\n',
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() { return h("div", {}, "Hello \\"%%tsrPath%%\\"!") };\n',
+						].join(''),
+					imports: {
+						tsrImports: () => "import { createLazyFileRoute } from '@tanstack/vue-router';",
+						tsrExportStart: (routePath) =>
+							`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+			};
+		case 'octane':
+			return {
+				fullPkg: OCTANE_ROUTER_PACKAGE,
+				subPkg: 'octane-router',
+				rootRoute: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RootComponent\n }%%tsrExportEnd%%\n\n',
+							'function RootComponent() @{\n <div>Hello "%%tsrPath%%"!<Outlet /></div>\n}\n',
+						].join(''),
+					imports: {
+						tsrImports: () => `import { Outlet, createRootRoute } from '${OCTANE_ROUTER_PACKAGE}';`,
+						tsrExportStart: () => 'export const Route = createRootRoute(',
+						tsrExportEnd: () => ');',
+					},
+				},
+				route: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() @{\n <div>Hello "%%tsrPath%%"!</div>\n}\n',
+						].join(''),
+					imports: {
+						tsrImports: () => `import { createFileRoute } from '${OCTANE_ROUTER_PACKAGE}';`,
+						tsrExportStart: (routePath) =>
+							`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+				lazyRoute: {
+					template: () =>
+						[
+							'%%tsrImports%%',
+							'\n\n',
+							'%%tsrExportStart%%{\n component: RouteComponent\n }%%tsrExportEnd%%\n\n',
+							'function RouteComponent() @{\n <div>Hello "%%tsrPath%%"!</div>\n}\n',
+						].join(''),
+					imports: {
+						tsrImports: () => `import { createLazyFileRoute } from '${OCTANE_ROUTER_PACKAGE}';`,
+						tsrExportStart: (routePath) =>
+							`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
+						tsrExportEnd: () => ');',
+					},
+				},
+			};
+		default:
+			throw new Error(`router-generator: Unknown target type: ${target}`);
+	}
+}
+//#endregion
+export { fillTemplate, getTargetTemplate };

package/src/internal/router-generator/transform/transform.d.ts

@@ -0,0 +1,8 @@
+import { TransformOptions, TransformResult } from './types.js';
+export declare function transform({
+	ctx,
+	source,
+	parseSource,
+	filename,
+	node,
+}: TransformOptions): TransformResult;