processTemplateReadme() — astro Function Reference

Architecture documentation for the processTemplateReadme() function in template.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine calls 1 called by 1

Entity Profile

CoreAstro→ RenderingEngine→ processTemplateReadme() — astro Function Reference

Dependency Diagram

graph TD
  5efefaab_aaa7_f01a_cf9f_0451f47845c8["processTemplateReadme()"]
  33b7e98e_3257_427a_5948_5ab38c474d26["template.ts"]
  5efefaab_aaa7_f01a_cf9f_0451f47845c8 -->|defined in| 33b7e98e_3257_427a_5948_5ab38c474d26
  0fddab5d_7945_0e3f_5243_8599487fed07["copyTemplate()"]
  0fddab5d_7945_0e3f_5243_8599487fed07 -->|calls| 5efefaab_aaa7_f01a_cf9f_0451f47845c8
  1ce03599_63aa_c670_0279_e9705ea75c5a["removeTemplateMarkerSections()"]
  5efefaab_aaa7_f01a_cf9f_0451f47845c8 -->|calls| 1ce03599_63aa_c670_0279_e9705ea75c5a
  style 5efefaab_aaa7_f01a_cf9f_0451f47845c8 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/create-astro/src/actions/template.ts lines 33–45

export function processTemplateReadme(content: string, packageManager: string): string {
	// Remove sections marked with template markers
	let processed = removeTemplateMarkerSections(content);

	// Replace package manager references if not npm
	if (packageManager !== 'npm') {
		processed = processed
			.replace(/\bnpm run\b/g, packageManager)
			.replace(/\bnpm\b/g, packageManager);
	}

	return processed;
}