getContext() — astro Function Reference

Architecture documentation for the getContext() function in context.ts from the astro codebase.

Function typescript CoreAstro RoutingSystem

Entity Profile

CoreAstro→ RoutingSystem→ getContext() — astro Function Reference

Dependency Diagram

graph TD
  df07cdeb_75ba_9642_2b65_5219a00c25e0["getContext()"]
  4b7851d8_a04b_b68f_e63e_37c4acd250af["context.ts"]
  df07cdeb_75ba_9642_2b65_5219a00c25e0 -->|defined in| 4b7851d8_a04b_b68f_e63e_37c4acd250af
  style df07cdeb_75ba_9642_2b65_5219a00c25e0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/upgrade/src/actions/context.ts lines 30–60

export async function getContext(argv: string[]): Promise<Context> {
	const flags = arg(
		{
			'--dry-run': Boolean,
			'--help': Boolean,

			'-h': '--help',
		},
		{ argv, permissive: true },
	);

	const packageManager = (await detect({
		// Include the `install-metadata` strategy to have the package manager that's
		// used for installation take precedence
		strategies: ['install-metadata', 'lockfile', 'packageManager-field'],
	})) ?? { agent: 'npm', name: 'npm' };
	const { _: [version = 'latest'] = [], '--help': help = false, '--dry-run': dryRun } = flags;

	return {
		help,
		prompt,
		packageManager,
		packages: [],
		cwd: new URL(pathToFileURL(process.cwd()) + '/'),
		dryRun,
		version,
		exit(code) {
			process.exit(code);
		},
	} satisfies Context;
}