feat: expose user astro error (#8012)

withastro · Aug 11, 2023 · 866ed40 · 866ed40
1 parent 519a1c4
commit 866ed40
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 2 deletions.
diff --git a/.changeset/wild-bobcats-carry.md b/.changeset/wild-bobcats-carry.md
@@ -0,0 +1,5 @@
+---
+'astro': minor
+---
+
+Add a new `astro/errors` module. Developers can import `AstroUserError`, and provide a `message` and an optional `hint` 
diff --git a/packages/astro/package.json b/packages/astro/package.json
@@ -69,6 +69,7 @@
       "types": "./zod.d.ts",
       "default": "./zod.mjs"
     },
+    "./errors": "./dist/core/errors/userError.js",
     "./middleware": {
       "types": "./dist/core/middleware/index.d.ts",
       "default": "./dist/core/middleware/index.js"

diff --git a/packages/astro/src/core/errors/errors.ts b/packages/astro/src/core/errors/errors.ts
@@ -19,6 +19,7 @@ export interface ErrorLocation {
 
 type ErrorTypes =
 	| 'AstroError'
+	| 'AstroUserError'
 	| 'CompilerError'
 	| 'CSSError'
 	| 'MarkdownError'
@@ -171,3 +172,25 @@ export interface ErrorWithMetadata {
 	};
 	cause?: any;
 }
+
+/**
+ * Special error that is exposed to users.
+ * Compared to AstroError, it contains a subset of information.
+ */
+export class AstroUserError extends Error {
+	type: ErrorTypes = 'AstroUserError';
+	/**
+	 * A message that explains to the user how they can fix the error.
+	 */
+	hint: string | undefined;
+	name = 'AstroUserError';
+	constructor(message: string, hint?: string) {
+		super();
+		this.message = message;
+		this.hint = hint;
+	}
+
+	static is(err: unknown): err is AstroUserError {
+		return (err as AstroUserError).type === 'AstroUserError';
+	}
+}
diff --git a/packages/astro/src/core/errors/index.ts b/packages/astro/src/core/errors/index.ts
@@ -7,6 +7,7 @@ export {
 	CompilerError,
 	MarkdownError,
 	isAstroError,
+	AstroUserError,
 } from './errors.js';
 export { codeFrame } from './printer.js';
 export { createSafeError, positionAt } from './utils.js';
diff --git a/packages/astro/src/core/errors/userError.ts b/packages/astro/src/core/errors/userError.ts
@@ -0,0 +1 @@
+export { AstroUserError as AstroError } from './errors.js';
diff --git a/packages/astro/src/core/messages.ts b/packages/astro/src/core/messages.ts
@@ -17,7 +17,12 @@ import {
 import type { ResolvedServerUrls } from 'vite';
 import type { ZodError } from 'zod';
 import { renderErrorMarkdown } from './errors/dev/utils.js';
-import { AstroError, CompilerError, type ErrorWithMetadata } from './errors/index.js';
+import {
+	AstroError,
+	CompilerError,
+	type ErrorWithMetadata,
+	AstroUserError,
+} from './errors/index.js';
 import { emoji, padMultilineString } from './util.js';
 
 const PREFIX_PADDING = 6;
@@ -198,7 +203,7 @@ export function formatConfigErrorMessage(err: ZodError) {
 }
 
 export function formatErrorMessage(err: ErrorWithMetadata, args: string[] = []): string {
-	const isOurError = AstroError.is(err) || CompilerError.is(err);
+	const isOurError = AstroError.is(err) || CompilerError.is(err) || AstroUserError.is(err);
 
 	args.push(
 		`${bgRed(black(` error `))}${red(