fix: alias astro to @types/astro

withastro · Jun 2, 2022 · c8816d4 · c8816d4
1 parent cfb85ee
commit c8816d4
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 5 deletions.
diff --git a/.changeset/calm-queens-study.md b/.changeset/calm-queens-study.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Alias imports for astro to @types/astro
diff --git a/packages/astro/src/core/create-vite.ts b/packages/astro/src/core/create-vite.ts
@@ -96,11 +96,19 @@ export async function createVite(
 			postcss: astroConfig.style.postcss || {},
 		},
 		resolve: {
-			alias: {
-				// This is needed for Deno compatibility, as the non-browser version
-				// of this module depends on Node `crypto`
-				randombytes: 'randombytes/browser',
-			},
+			alias: [
+				{
+					// This is needed for Deno compatibility, as the non-browser version
+					// of this module depends on Node `crypto`
+					find: 'randombytes',
+					replacement: 'randombytes/browser',
+				},
+				{
+					// Typings are imported from 'astro' (e.g. import { Type } from 'astro')
+					find: /^astro$/,
+					replacement: fileURLToPath(new URL('../@types/astro', import.meta.url)),
+				},
+			],
 		},
 		// Note: SSR API is in beta (https://vitejs.dev/guide/ssr.html)
 		ssr: {

diff --git a/packages/astro/test/fixtures/type-imports/src/pages/index.astro b/packages/astro/test/fixtures/type-imports/src/pages/index.astro
@@ -0,0 +1,19 @@
+---
+import type { MarkdownInstance } from 'astro'
+---
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width" />
+		<title>Astro</title>
+		<style is:global>
+			h1 {
+				color: red;
+			}
+		</style>
+	</head>
+	<body>
+		<h1>Astro</h1>
+		<img src="/puppy.png"/>
+	</body>
+</html>
diff --git a/packages/astro/test/imports.test.js b/packages/astro/test/imports.test.js
diff --git a/packages/astro/test/type-imports.test.js b/packages/astro/test/type-imports.test.js
@@ -0,0 +1,16 @@
+import { expect } from 'chai';
+import { loadFixture } from './test-utils.js';
+
+describe('Type Imports', async () => {
+	let fixture;
+
+	before(async () => {
+		fixture = await loadFixture({ root: './fixtures/type-imports' });
+		await fixture.build();
+	});
+
+	it('Allows importing types from "astro"', async () => {
+		// if the build passes then the test succeeds
+		expect(true).to.be.true;
+	});
+});