openDocsCommand.run() — astro Function Reference

Architecture documentation for the openDocsCommand.run() function in open-docs.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1

Entity Profile

CoreAstro→ RenderingEngine→ openDocsCommand.run() — astro Function Reference

Dependency Diagram

graph TD
  32b90bcd_a2cd_dd61_acf3_f427c9ba9147["openDocsCommand.run()"]
  e747d472_6996_c37d_df20_4820655907c4["open-docs.ts"]
  32b90bcd_a2cd_dd61_acf3_f427c9ba9147 -->|defined in| e747d472_6996_c37d_df20_4820655907c4
  e20cc44b_fc8a_531c_5e96_abf1e7bf9c13["getExecInputForPlatform()"]
  32b90bcd_a2cd_dd61_acf3_f427c9ba9147 -->|calls| e20cc44b_fc8a_531c_5e96_abf1e7bf9c13
  style 32b90bcd_a2cd_dd61_acf3_f427c9ba9147 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/cli/docs/core/open-docs.ts lines 38–50

	async run({ url, operatingSystemProvider, logger, commandExecutor, cloudIdeProvider }: Options) {
		const platform = cloudIdeProvider.name ?? operatingSystemProvider.name;
		const input = getExecInputForPlatform(platform);
		if (!input) {
			logger.error(
				'SKIP_FORMAT',
				`It looks like your platform ("${platform}") isn't supported!\nTo view Astro's docs, please visit ${url}`,
			);
			return;
		}
		const [command, args = []] = input;
		await commandExecutor.execute(command, [...args, encodeURI(url)]);
	},