feat: improve compile error reporting (#220)

* feat: improve compile error reporting

* feat: improve error handling in esbuild dependency optimization

* fix: use lineText instead of suggestion/detail so that esbuild produces a more compact/readable output on error

* fix: reformat code frame so that it is displayed in vite error overlay

* chore: add changeset

* Apply suggestions from code review

Co-authored-by: Bjorn Lu <[email protected]>

Co-authored-by: Bjorn Lu <[email protected]>

Author: dominikg

.changeset/eleven-frogs-rhyme.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': minor
+---
+
+Improved error reporting for svelte compiler errors

packages/vite-plugin-svelte/src/index.ts

@@ -17,6 +17,7 @@ import { ensureWatchedFile, setupWatchers } from './utils/watch';
 import { resolveViaPackageJsonSvelte } from './utils/resolve';
 import { addExtraPreprocessors } from './utils/preprocess';
 import { PartialResolvedId } from 'rollup';
+import { toRollupError } from './utils/error';
 
 export function svelte(inlineOptions?: Partial<Options>): Plugin {
 	if (process.env.DEBUG != null) {
@@ -169,7 +170,12 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 				log.error('failed to transform tagged svelte request', svelteRequest);
 				throw new Error(`failed to transform tagged svelte request for id ${id}`);
 			}
-			const compileData = await compileSvelte(svelteRequest, code, options);
+			let compileData;
+			try {
+				compileData = await compileSvelte(svelteRequest, code, options);
+			} catch (e) {
+				throw toRollupError(e);
+			}
 			logCompilerWarnings(compileData.compiled.warnings, options);
 			cache.update(compileData);
 			if (compileData.dependencies?.length && options.server) {

packages/vite-plugin-svelte/src/utils/error.ts

@@ -0,0 +1,92 @@
+import { RollupError } from 'rollup';
+import { Warning } from './options';
+import { buildExtendedLogMessage } from './log';
+import { PartialMessage } from 'esbuild';
+
+/**
+ * convert an error thrown by svelte.compile to a RollupError so that vite displays it in a user friendly way
+ * @param error a svelte compiler error, which is a mix of Warning and an error
+ * @returns {RollupError} the converted error
+ */
+export function toRollupError(error: Warning & Error): RollupError {
+	const { filename, frame, start, code, name } = error;
+	const rollupError: RollupError = {
+		name, // needed otherwise sveltekit coalesce_to_error turns it into a string
+		id: filename,
+		message: buildExtendedLogMessage(error), // include filename:line:column so that it's clickable
+		frame: formatFrameForVite(frame),
+		code,
+		stack: ''
+	};
+	if (start) {
+		rollupError.loc = {
+			line: start.line,
+			column: start.column,
+			file: filename
+		};
+	}
+	return rollupError;
+}
+
+/**
+ * convert an error thrown by svelte.compile to an esbuild PartialMessage
+ * @param error a svelte compiler error, which is a mix of Warning and an error
+ * @returns {PartialMessage} the converted error
+ */
+export function toESBuildError(error: Warning & Error): PartialMessage {
+	const { filename, frame, start } = error;
+	const partialMessage: PartialMessage = {
+		text: buildExtendedLogMessage(error)
+	};
+	if (start) {
+		partialMessage.location = {
+			line: start.line,
+			column: start.column,
+			file: filename,
+			lineText: lineFromFrame(start.line, frame) // needed to get a meaningful error message on cli
+		};
+	}
+	return partialMessage;
+}
+
+/**
+ * extract line with number from codeframe
+ */
+function lineFromFrame(lineNo: number, frame?: string): string {
+	if (!frame) {
+		return '';
+	}
+	const lines = frame.split('\n');
+	const errorLine = lines.find((line) => line.trimStart().startsWith(`${lineNo}: `));
+	return errorLine ? errorLine.substring(errorLine.indexOf(': ') + 3) : '';
+}
+
+/**
+ * vite error overlay expects a specific format to show frames
+ * this reformats svelte frame (colon separated, less whitespace)
+ * to one that vite displays on overlay ( pipe separated, more whitespace)
+ * e.g.
+ * ```
+ * 1: foo
+ * 2: bar;
+ *       ^
+ * 3: baz
+ * ```
+ * to
+ * ```
+ *  1 | foo
+ *  2 | bar;
+ *         ^
+ *  3 | baz
+ * ```
+ * @see https://github.com/vitejs/vite/blob/96591bf9989529de839ba89958755eafe4c445ae/packages/vite/src/client/overlay.ts#L116
+ */
+function formatFrameForVite(frame?: string): string {
+	if (!frame) {
+		return '';
+	}
+	return frame
+		.split('\n')
+		.map((line) => (line.match(/^\s+\^/) ? '   ' + line : ' ' + line.replace(':', ' | ')))
+		.join('\n');
+}

packages/vite-plugin-svelte/src/utils/esbuild.ts

@@ -4,6 +4,7 @@ import { DepOptimizationOptions } from 'vite';
 import { Compiled } from './compile';
 import { log } from './log';
 import { CompileOptions, ResolvedOptions } from './options';
+import { toESBuildError } from './error';
 
 type EsbuildOptions = NonNullable<DepOptimizationOptions['esbuildOptions']>;
 type EsbuildPlugin = NonNullable<EsbuildOptions['plugins']>[number];
@@ -20,8 +21,12 @@ export function esbuildSveltePlugin(options: ResolvedOptions): EsbuildPlugin {
 
 			build.onLoad({ filter: svelteFilter }, async ({ path: filename }) => {
 				const code = await fs.readFile(filename, 'utf8');
-				const contents = await compileSvelte(options, { filename, code });
-				return { contents };
+				try {
+					const contents = await compileSvelte(options, { filename, code });
+					return { contents };
+				} catch (e) {
+					return { errors: [toESBuildError(e)] };
+				}
 			});
 		}
 	};

packages/vite-plugin-svelte/src/utils/log.ts

@@ -155,7 +155,7 @@ function warnBuild(w: Warning) {
 	log.warn.enabled && log.warn(buildExtendedLogMessage(w), w.frame);
 }
 
-function buildExtendedLogMessage(w: Warning) {
+export function buildExtendedLogMessage(w: Warning) {
 	const parts = [];
 	if (w.filename) {
 		parts.push(w.filename);