feat: improve error messages

johannschopplich · johannschopplich · commit c01f36c0d385 · 2024-02-19T13:54:31.000+01:00
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -31,8 +31,8 @@ interface ModuleOptions {
   /**
    * Kirby KQL API route path
    *
-   * @default 'api/query' for `basic` authentication
-   * @default 'api/kql' for `bearer` authentication
+   * @default 'api/query' // for `basic` authentication
+   * @default 'api/kql' // for `bearer` authentication
    */
   prefix?: string
 
diff --git a/docs/package.json b/docs/package.json
@@ -8,6 +8,6 @@
     "serve": "vitepress serve"
   },
   "devDependencies": {
-    "vitepress": "^1.0.0-rc.43"
+    "vitepress": "^1.0.0-rc.44"
   }
 }
diff --git a/playground/app.vue b/playground/app.vue
@@ -1,9 +1,13 @@
-<template>
-  <Head>
-    <Title>nuxt-kql</Title>
-    <Link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@exampledev/new.css@1.1.2/new.min.css" />
-  </Head>
+<script setup lang="ts">
+useServerHead({
+  title: 'nuxt-kql',
+  link: [
+    { rel: 'stylesheet', href: 'https://cdn.jsdelivr.net/npm/@exampledev/new.css@1.1.2/new.min.css' },
+  ],
+})
+</script>
 
+<template>
   <NuxtLayout>
     <NuxtPage />
   </NuxtLayout>
diff --git a/src/module.ts b/src/module.ts
@@ -17,8 +17,8 @@ export interface ModuleOptions {
   /**
    * Kirby KQL API route path
    *
-   * @default 'api/query' for `basic` authentication
-   * @default 'api/kql' for `bearer` authentication
+   * @default 'api/query' // for `basic` authentication
+   * @default 'api/kql' // for `bearer` authentication
    */
   prefix?: string
 
@@ -155,14 +155,14 @@ export default defineNuxtModule<ModuleOptions>({
 
     // Make sure Kirby URL and KQL endpoint are set
     if (!options.url)
-      logger.error('Missing `KIRBY_BASE_URL` in `.env`')
+      logger.error('Missing `KIRBY_BASE_URL` environment variable')
 
     // Make sure authentication credentials are set
     if (options.auth === 'basic' && (!options.credentials || !options.credentials.username || !options.credentials.password))
-      logger.error('Missing `KIRBY_API_USERNAME` and `KIRBY_API_PASSWORD` in `.env` for basic authentication')
+      logger.error('Missing `KIRBY_API_USERNAME` and `KIRBY_API_PASSWORD` environment variable for basic authentication')
 
     if (options.auth === 'bearer' && !options.token)
-      logger.error('Missing `KIRBY_API_TOKEN` in `.env` for bearer authentication')
+      logger.error('Missing `KIRBY_API_TOKEN` environment variable for bearer authentication')
 
     if (!options.prefix) {
       if (options.auth === 'basic')
diff --git a/src/prefetch.ts b/src/prefetch.ts
@@ -19,7 +19,7 @@ export async function prefetchQueries(
 
     if (language && !query.query) {
       logger.error(
-        `Couldn't prefetch ${key} KQL query: \`language\` option requires a \`query\``,
+        `Failed to prefetch ${key} multi-language KQL query: \`query\` is required`,
       )
       continue
     }
@@ -38,8 +38,8 @@ export async function prefetchQueries(
         }),
       )
     }
-    catch (e) {
-      logger.error(`Couldn't prefetch ${key} KQL query:`, e)
+    catch (error) {
+      logger.error(`Failed to prefetch ${key} KQL query:`, error)
     }
   }
 
diff --git a/src/runtime/server/handler.ts b/src/runtime/server/handler.ts
@@ -42,7 +42,7 @@ async function fetcher({
 
     return result
   }
-  catch (err) {
+  catch (error) {
     if (kql.server.verboseErrors) {
       if (isQueryRequest)
         consola.error('Failed to execute KQL query:', query)
@@ -54,7 +54,7 @@ async function fetcher({
       statusMessage: isQueryRequest
         ? 'Failed to execute KQL query'
         : `Failed to fetch "${path}"`,
-      data: (err as NuxtError).message,
+      data: (error as NuxtError).message,
     })
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@`
`8`	`8`	`"serve": "vitepress serve"`
`9`	`9`	`},`
`10`	`10`	`"devDependencies": {`
`11`		`- "vitepress": "^1.0.0-rc.43"`
	`11`	`+ "vitepress": "^1.0.0-rc.44"`
`12`	`12`	`}`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ export async function prefetchQueries(`
`19`	`19`
`20`	`20`	`if (language && !query.query) {`
`21`	`21`	`logger.error(`
`22`		- `Couldn't prefetch ${key} KQL query: \`language\` option requires a \`query\``,
	`22`	+ `Failed to prefetch ${key} multi-language KQL query: \`query\` is required`,
`23`	`23`	`)`
`24`	`24`	`continue`
`25`	`25`	`}`
`@@ -38,8 +38,8 @@ export async function prefetchQueries(`
`38`	`38`	`}),`
`39`	`39`	`)`
`40`	`40`	`}`
`41`		`- catch (e) {`
`42`		- logger.error(`Couldn't prefetch ${key} KQL query:`, e)
	`41`	`+ catch (error) {`
	`42`	+ logger.error(`Failed to prefetch ${key} KQL query:`, error)
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ async function fetcher({`
`42`	`42`
`43`	`43`	`return result`
`44`	`44`	`}`
`45`		`- catch (err) {`
	`45`	`+ catch (error) {`
`46`	`46`	`if (kql.server.verboseErrors) {`
`47`	`47`	`if (isQueryRequest)`
`48`	`48`	`consola.error('Failed to execute KQL query:', query)`
`@@ -54,7 +54,7 @@ async function fetcher({`
`54`	`54`	`statusMessage: isQueryRequest`
`55`	`55`	`? 'Failed to execute KQL query'`
`56`	`56`	: `Failed to fetch "${path}"`,
`57`		`- data: (err as NuxtError).message,`
	`57`	`+ data: (error as NuxtError).message,`
`58`	`58`	`})`
`59`	`59`	`}`
`60`	`60`	`}`