sync() — astro Function Reference

Architecture documentation for the sync() function in index.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1 called by 1

Entity Profile

CoreAstro→ RenderingEngine→ sync() — astro Function Reference

Dependency Diagram

graph TD
  869b69aa_9d9a_0f2f_6090_5cedf4bef779["sync()"]
  cd488d83_5ad0_f34a_227f_731e9945a152["index.ts"]
  869b69aa_9d9a_0f2f_6090_5cedf4bef779 -->|defined in| cd488d83_5ad0_f34a_227f_731e9945a152
  2523437b_c067_5714_7895_f8fb9bc10862["syncInternal()"]
  2523437b_c067_5714_7895_f8fb9bc10862 -->|calls| 869b69aa_9d9a_0f2f_6090_5cedf4bef779
  2523437b_c067_5714_7895_f8fb9bc10862["syncInternal()"]
  869b69aa_9d9a_0f2f_6090_5cedf4bef779 -->|calls| 2523437b_c067_5714_7895_f8fb9bc10862
  style 869b69aa_9d9a_0f2f_6090_5cedf4bef779 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/sync/index.ts lines 56–82

export default async function sync(
	inlineConfig: AstroInlineConfig,
	{ fs, telemetry: _telemetry = false }: { fs?: typeof fsMod; telemetry?: boolean } = {},
) {
	ensureProcessNodeEnv('production');
	const logger = createNodeLogger(inlineConfig);
	const { astroConfig, userConfig } = await resolveConfig(inlineConfig ?? {}, 'sync');
	if (_telemetry) {
		telemetry.record(eventCliSession('sync', userConfig));
	}
	let settings = await createSettings(astroConfig, inlineConfig.logLevel, inlineConfig.root);
	settings = await runHookConfigSetup({
		command: 'sync',
		settings,
		logger,
	});
	await runHookConfigDone({ settings, logger });

	return await syncInternal({
		settings,
		logger,
		mode: 'production',
		fs,
		force: inlineConfig.force,
		command: 'sync',
	});
}