createSettings() — astro Function Reference

Architecture documentation for the createSettings() function in settings.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1

Entity Profile

CoreAstro→ RenderingEngine→ createSettings() — astro Function Reference

Dependency Diagram

graph TD
  ade7b9f5_5373_99b0_0e0d_1038e888f26c["createSettings()"]
  b5841de7_4ddd_6101_37ae_9e92ac43fb0f["settings.ts"]
  ade7b9f5_5373_99b0_0e0d_1038e888f26c -->|defined in| b5841de7_4ddd_6101_37ae_9e92ac43fb0f
  47934f85_fc58_9c44_0089_601e41df2278["createBaseSettings()"]
  ade7b9f5_5373_99b0_0e0d_1038e888f26c -->|calls| 47934f85_fc58_9c44_0089_601e41df2278
  style ade7b9f5_5373_99b0_0e0d_1038e888f26c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/config/settings.ts lines 167–191

export async function createSettings(
	config: AstroConfig,
	logLevel: AstroInlineConfig['logLevel'],
	cwd?: string,
): Promise<AstroSettings> {
	const tsconfig = await loadTSConfig(cwd);
	const settings = createBaseSettings(config, logLevel);

	let watchFiles = [];
	if (cwd) {
		watchFiles.push(fileURLToPath(new URL('./package.json', pathToFileURL(cwd))));
	}

	if (typeof tsconfig !== 'string') {
		watchFiles.push(
			...[tsconfig.tsconfigFile, ...(tsconfig.extended ?? []).map((e) => e.tsconfigFile)],
		);
		settings.tsConfig = tsconfig.tsconfig;
		settings.tsConfigPath = tsconfig.tsconfigFile;
	}

	settings.watchFiles = watchFiles;

	return settings;
}