From f00c2ddc31b5285d14c2f0808c01eafaaf31f5c9 Mon Sep 17 00:00:00 2001 From: liruifengv Date: Fri, 10 Jan 2025 17:44:17 +0800 Subject: [PATCH] fix(errors): fix error messages rendering incorrectly (#12942) * fix(errors): fix error messages rendering incorrectly * fix(errors): fix error messages rendering incorrectly * add `@message` for jsdoc * Create tame-hats-kiss.md --------- Co-authored-by: Florian Lefebvre --- .changeset/tame-hats-kiss.md | 5 +++++ packages/astro/src/core/errors/errors-data.ts | 6 ++++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 .changeset/tame-hats-kiss.md diff --git a/.changeset/tame-hats-kiss.md b/.changeset/tame-hats-kiss.md new file mode 100644 index 0000000000..5b634a73de --- /dev/null +++ b/.changeset/tame-hats-kiss.md @@ -0,0 +1,5 @@ +--- +"astro": patch +--- + +Improves the session error messages diff --git a/packages/astro/src/core/errors/errors-data.ts b/packages/astro/src/core/errors/errors-data.ts index 2fde7bbac6..2510636219 100644 --- a/packages/astro/src/core/errors/errors-data.ts +++ b/packages/astro/src/core/errors/errors-data.ts @@ -870,6 +870,7 @@ export const AstroResponseHeadersReassigned = { /** * @docs + * @message Error when initializing session storage with driver `DRIVER`. `ERROR` * @see * - [experimental.session](https://docs.astro.build/en/reference/experimental-flags/sessions/) * @description @@ -879,12 +880,13 @@ export const SessionStorageInitError = { name: 'SessionStorageInitError', title: 'Session storage could not be initialized.', message: (error: string, driver?: string) => - `Error when initializing session storage${driver ? ` with driver ${driver}` : ''}. ${error ?? ''}`, + `Error when initializing session storage${driver ? ` with driver \`${driver}\`` : ''}. \`${error ?? ''}\``, hint: 'For more information, see https://docs.astro.build/en/reference/experimental-flags/sessions/', } satisfies ErrorData; /** * @docs + * @message Error when saving session data with driver `DRIVER`. `ERROR` * @see * - [experimental.session](https://docs.astro.build/en/reference/experimental-flags/sessions/) * @description @@ -894,7 +896,7 @@ export const SessionStorageSaveError = { name: 'SessionStorageSaveError', title: 'Session data could not be saved.', message: (error: string, driver?: string) => - `Error when saving session data${driver ? ` with driver ${driver}` : ''}. ${error ?? ''}`, + `Error when saving session data${driver ? ` with driver \`${driver}\`` : ''}. \`${error ?? ''}\``, hint: 'For more information, see https://docs.astro.build/en/reference/experimental-flags/sessions/', } satisfies ErrorData;