chore: provide links to documentation for errors/warnings

closes #11305
sveltejs · Dec 9, 2024 · 919d142 · 919d142
1 parent c1c59e7
commit 919d142
Show file tree

Hide file tree

Showing 15 changed files with 347 additions and 371 deletions.
diff --git a/.changeset/breezy-feet-knock.md b/.changeset/breezy-feet-knock.md
@@ -0,0 +1,5 @@
+---
+'svelte': patch
+---
+
+chore: provide links to documentation for errors/warnings
diff --git a/packages/svelte/scripts/process-messages/templates/client-errors.js b/packages/svelte/scripts/process-messages/templates/client-errors.js
@@ -7,11 +7,10 @@ import { DEV } from 'esm-env';
  */
 export function CODE(PARAMETER) {
 	if (DEV) {
-		const error = new Error(`${'CODE'}\n${MESSAGE}`);
+		const error = new Error(`${'CODE'} (https://svelte.dev/e/${'CODE'})\n${MESSAGE}`);
 		error.name = 'Svelte error';
 		throw error;
 	} else {
-		// TODO print a link to the documentation
-		throw new Error('CODE');
+		throw new Error(`${'CODE'} (https://svelte.dev/e/${'CODE'})`);
 	}
 }
diff --git a/packages/svelte/scripts/process-messages/templates/client-warnings.js b/packages/svelte/scripts/process-messages/templates/client-warnings.js
@@ -9,9 +9,12 @@ var normal = 'font-weight: normal';
  */
 export function CODE(PARAMETER) {
 	if (DEV) {
-		console.warn(`%c[svelte] ${'CODE'}\n%c${MESSAGE}`, bold, normal);
+		console.warn(
+			`%c[svelte] ${'CODE'} (https://svelte.dev/e/${'CODE'})\n%c${MESSAGE}`,
+			bold,
+			normal
+		);
 	} else {
-		// TODO print a link to the documentation
-		console.warn('CODE');
+		console.warn(`${'CODE'} (https://svelte.dev/e/${'CODE'})`);
 	}
 }
diff --git a/packages/svelte/scripts/process-messages/templates/compile-errors.js b/packages/svelte/scripts/process-messages/templates/compile-errors.js
@@ -56,5 +56,5 @@ function e(node, code, message) {
  * @returns {never}
  */
 export function CODE(node, PARAMETER) {
-	e(node, 'CODE', MESSAGE);
+	e(node, `${'CODE'} (https://svelte.dev/e/${'CODE'})`, MESSAGE);
 }
diff --git a/packages/svelte/scripts/process-messages/templates/compile-warnings.js b/packages/svelte/scripts/process-messages/templates/compile-warnings.js
@@ -47,5 +47,5 @@ export const codes = CODES;
  * @param {string} PARAMETER
  */
 export function CODE(node, PARAMETER) {
-	w(node, 'CODE', MESSAGE);
+	w(node, `${'CODE'} (https://svelte.dev/e/${'CODE'})`, MESSAGE);
 }
diff --git a/packages/svelte/scripts/process-messages/templates/server-errors.js b/packages/svelte/scripts/process-messages/templates/server-errors.js
@@ -4,7 +4,7 @@
  * @returns {never}
  */
 export function CODE(PARAMETER) {
-	const error = new Error(`${'CODE'}\n${MESSAGE}`);
+	const error = new Error(`${'CODE'} (https://svelte.dev/e/${'CODE'})\n${MESSAGE}`);
 	error.name = 'Svelte error';
 	throw error;
 }
diff --git a/packages/svelte/scripts/process-messages/templates/shared-errors.js b/packages/svelte/scripts/process-messages/templates/shared-errors.js
@@ -7,11 +7,11 @@ import { DEV } from 'esm-env';
  */
 export function CODE(PARAMETER) {
 	if (DEV) {
-		const error = new Error(`${'CODE'}\n${MESSAGE}`);
+		const error = new Error(`${'CODE'} (https://svelte.dev/e/${'CODE'})\n${MESSAGE}`);
 		error.name = 'Svelte error';
 		throw error;
 	} else {
 		// TODO print a link to the documentation
-		throw new Error('CODE');
+		throw new Error(`${'CODE'} (https://svelte.dev/e/${'CODE'})`);
 	}
 }
diff --git a/packages/svelte/scripts/process-messages/templates/shared-warnings.js b/packages/svelte/scripts/process-messages/templates/shared-warnings.js
@@ -9,9 +9,13 @@ var normal = 'font-weight: normal';
  */
 export function CODE(PARAMETER) {
 	if (DEV) {
-		console.warn(`%c[svelte] ${'CODE'}\n%c${MESSAGE}`, bold, normal);
+		console.warn(
+			`%c[svelte] ${'CODE'} (https://svelte.dev/e/${'CODE'})\n%c${MESSAGE}`,
+			bold,
+			normal
+		);
 	} else {
 		// TODO print a link to the documentation
-		console.warn('CODE');
+		console.warn(`${'CODE'} (https://svelte.dev/e/${'CODE'})`);
 	}
 }