createRoutesList() — astro Function Reference

Source Code

packages/astro/src/core/routing/manifest/create.ts lines 485–782

export async function createRoutesList(
	params: CreateRouteManifestParams,
	logger: Logger,
	{
		dev = false,
		skipBuildOutputAssignment = false,
	}: {
		dev?: boolean;
		/**
		 * When `true`, the assignment of `settings.buildOutput` is skipped.
		 * Usually, that's needed when this function has already been called.
		 */
		skipBuildOutputAssignment?: boolean;
	} = {},
): Promise<RoutesList> {
	const { settings } = params;
	const { config } = settings;
	// Create a map of all routes so redirects can refer to any route
	const routeMap = new Map();

	const fileBasedRoutes = createFileBasedRoutes(params, logger);
	for (const route of fileBasedRoutes) {
		routeMap.set(route.route, route);
	}

	const injectedRoutes = createInjectedRoutes(params);
	for (const route of injectedRoutes) {
		routeMap.set(route.route, route);
	}

	const redirectRoutes = createRedirectRoutes(params, routeMap);

	// we remove the file based routes that were deemed redirects
	const filteredFiledBasedRoutes = fileBasedRoutes.filter((fileBasedRoute) => {
		const isRedirect = redirectRoutes.findIndex((rd) => rd.route === fileBasedRoute.route);
		return isRedirect < 0;
	});

	const routes: RouteData[] = [
		...[...filteredFiledBasedRoutes, ...injectedRoutes, ...redirectRoutes].sort(routeComparator),
	];

	if (skipBuildOutputAssignment !== true) {
		settings.buildOutput = getPrerenderDefault(config) ? 'static' : 'server';
	}

	// Check the prerender option for each route
	const limit = pLimit(10);
	let promises = [];
	for (const route of routes) {
		promises.push(
			limit(async () => {
				if (route.type !== 'page' && route.type !== 'endpoint' && route.type !== 'redirect') return;
				// External redirects aren't taken into account
				if (route.type === 'redirect' && !route.redirectRoute) return;
				const localFs = params.fsMod ?? nodeFs;
				const content = await localFs.promises.readFile(
					fileURLToPath(
						new URL(
							// The destination redirect might be a prerendered
							route.type === 'redirect' && route.redirectRoute
								? route.redirectRoute.component
								: route.component,
							settings.config.root,
						),
					),
					'utf-8',
				);

				await getRoutePrerenderOption(content, route, settings, logger);
			}),
		);
	}
	await Promise.all(promises);

	// Report route collisions
	for (const [index, higherRoute] of routes.entries()) {
		for (const lowerRoute of routes.slice(index + 1)) {
			detectRouteCollision(higherRoute, lowerRoute, config, logger);
		}
	}