fix: add back code to update user's env.d.ts with proper types (#8214)

withastro · Aug 24, 2023 · 55c10d1 · 55c10d1
1 parent 44bd0cd
commit 55c10d1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.changeset/tasty-dragons-smash.md b/.changeset/tasty-dragons-smash.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Automatically update user's env.d.ts with the proper types to help out migrating away from assets being experimental
diff --git a/packages/astro/src/vite-plugin-inject-env-ts/index.ts b/packages/astro/src/vite-plugin-inject-env-ts/index.ts
@@ -50,6 +50,16 @@ export async function setUpEnvTs({
 	if (fs.existsSync(envTsPath)) {
 		let typesEnvContents = await fs.promises.readFile(envTsPath, 'utf-8');
 
+		// TODO: Remove this in 4.0, this code is only to help users migrate away from assets being experimental for a long time
+		if (typesEnvContents.includes('types="astro/client-image"')) {
+			typesEnvContents = typesEnvContents.replace(
+				'types="astro/client-image"',
+				'types="astro/client"'
+			);
+			await fs.promises.writeFile(envTsPath, typesEnvContents, 'utf-8');
+			info(logging, 'assets', `Removed ${bold(envTsPathRelativetoRoot)} types`);
+		}
+
 		if (!fs.existsSync(dotAstroDir))
 			// Add `.astro` types reference if none exists
 			return;