config: remove ~/assets alias (#8113)

Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Mia Kanashi <[email protected]>

Author: 3 people

.changeset/clever-bats-breathe.md

@@ -0,0 +1,13 @@
+---
+'astro': major
+---
+
+This import alias is no longer included by default with astro:assets. If you were using this alias with experimental assets, you must convert them to relative file paths, or create your own [import aliases](https://docs.astro.build/en/guides/aliases/).
+
+```diff
+---
+// src/pages/posts/post-1.astro
+- import rocket from '~/assets/rocket.png'
++ import rocket from '../../assets/rocket.png';
+---
+```

packages/astro/src/assets/types.ts

@@ -90,7 +90,7 @@ export type LocalImageProps<T> = ImageSharedProps<T> & {
 	 *
 	 * **Example**:
 	 * ```js
-	 * import myImage from "~/assets/my_image.png";
+	 * import myImage from "../assets/my_image.png";
 	 * ```
 	 * And then refer to the image, like so:
 	 * ```astro

packages/astro/src/assets/vite-plugin-assets.ts

@@ -1,5 +1,4 @@
 import MagicString from 'magic-string';
-import { fileURLToPath } from 'node:url';
 import type * as vite from 'vite';
 import { normalizePath } from 'vite';
 import type { AstroPluginOptions, ImageTransform } from '../@types/astro';
@@ -31,18 +30,6 @@ export default function assets({
 		// Expose the components and different utilities from `astro:assets` and handle serving images from `/_image` in dev
 		{
 			name: 'astro:assets',
-			config() {
-				return {
-					resolve: {
-						alias: [
-							{
-								find: /^~\/assets\/(.+)$/,
-								replacement: fileURLToPath(new URL('./assets/$1', settings.config.srcDir)),
-							},
-						],
-					},
-				};
-			},
 			async resolveId(id) {
 				if (id === VIRTUAL_SERVICE_ID) {
 					return await this.resolve(settings.config.image.service.entrypoint);

packages/astro/test/fixtures/content-collection-references/src/content/banners/welcome.json

@@ -1,4 +1,4 @@
 {
   "alt": "Futuristic landscape with chrome buildings and blue skies",
-  "src": "~/assets/the-future.jpg"
+  "src": "../../assets/the-future.jpg"
 }

packages/astro/test/fixtures/core-image-base/src/content/blog/one.md

@@ -1,6 +1,6 @@
 ---
 title: One
-image: ~/assets/penguin2.jpg
+image: ../../assets/penguin2.jpg
 cover:
   image: ../../assets/penguin1.jpg
 ---

packages/astro/test/fixtures/core-image-base/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "astro/tsconfigs/base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "~/assets/*": ["src/assets/*"]
+    },
+  }
+}

packages/astro/test/fixtures/core-image-ssg/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "astro/tsconfigs/base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "~/assets/*": ["src/assets/*"]
+    },
+  }
+}

packages/astro/test/fixtures/core-image/src/content/blog/one.md

@@ -1,11 +1,11 @@
 ---
 title: One
-image: ~/assets/penguin2.jpg
+image: ../../assets/penguin2.jpg
 cover:
   image: ../../assets/penguin1.jpg
 arrayOfImages:
-  - ~/assets/penguin2.jpg
-  - ~/assets/penguin1.jpg
+  - ../../assets/penguin2.jpg
+  - ../../assets/penguin1.jpg
 refinedImage: ../../assets/penguin1.jpg
 ---
 

packages/astro/test/fixtures/core-image/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "astro/tsconfigs/base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "~/assets/*": ["src/assets/*"]
+    },
+  }
+}

packages/astro/tsconfigs/base.json

@@ -23,11 +23,6 @@
     "esModuleInterop": true,
     // Skip typechecking libraries and .d.ts files
     "skipLibCheck": true,
-    // Add alias for assets folder for easy reference to assets
-    "baseUrl": ".",
-    "paths": {
-      "~/assets/*": ["src/assets/*"]
-    },
     // Allow JavaScript files to be imported
     "allowJs": true
   }

packages/integrations/markdoc/test/fixtures/image-assets/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "astro/tsconfigs/base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "~/assets/*": ["src/assets/*"]
+    },
+  }
+}

packages/integrations/mdx/test/fixtures/mdx-images/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "astro/tsconfigs/base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "~/assets/*": ["src/assets/*"]
+    },
+  }
+}