refactor: unified all error messages

Author: antfu

packages/devtools-kit/src/index.ts

@@ -129,7 +129,7 @@ export function extendServerRpc<ClientFunctions = Record<string, never>, ServerF
 ): BirpcGroup<ClientFunctions, ServerFunctions> {
   const ctx = _getContext(nuxt)
   if (!ctx)
-    throw new Error('Failed to get devtools context.')
+    throw new Error('[Nuxt DevTools] Failed to get devtools context.')
 
   return ctx.extendServerRpc<ClientFunctions, ServerFunctions>(namespace, functions)
 }

packages/devtools-wizard/src/index.ts

@@ -27,11 +27,11 @@ async function run() {
   consola.log(`\n${colors.gray('Learn more at https://devtools.nuxt.com\n')}`)
 
   if (moduleName.endsWith('-edge') || moduleName.endsWith('-nightly'))
-    throw new Error('Nightly release of Nuxt DevTools requires to be installed locally. Learn more at https://github.com/nuxt/devtools/#nightly-release-channel')
+    throw new Error('[Nuxt DevTools] Nightly release of Nuxt DevTools requires to be installed locally. Learn more at https://github.com/nuxt/devtools/#nightly-release-channel')
 
   const nuxtVersion = await getNuxtVersion(cwd)
   if (!nuxtVersion) {
-    consola.error('Unable to find any installed nuxt version in the current directory')
+    consola.error('[Nuxt DevTools] Unable to find any installed nuxt version in the current directory')
     process.exit(1)
   }
   if (command === 'enable') {

packages/devtools/client/composables/dev-auth.ts

@@ -47,7 +47,7 @@ export async function ensureDevAuthToken() {
       classes: 'text-red',
     })
     await authConfirmAction()
-    throw new Error('Invalid auth token')
+    throw new Error('[Nuxt DevTools] Invalid auth token')
   }
 
   return devAuthToken.value!
@@ -83,6 +83,6 @@ async function authConfirmAction() {
       icon: 'carbon-close',
       classes: 'text-orange',
     })
-    throw new Error('User canceled auth')
+    throw new Error('[Nuxt DevTools] User canceled auth')
   }
 }

packages/devtools/client/composables/rpc.ts

@@ -69,8 +69,8 @@ async function connectVite() {
 
   if (!hot) {
     wsConnecting.value = true
-    console.error('[nuxt-devtools] Unable to find Vite HMR context')
-    throw new Error('Unable to connect to devtools')
+    console.error('[Nuxt DevTools] Unable to find Vite HMR context')
+    throw new Error('[Nuxt DevTools] Unable to connect to devtools')
   }
 
   hot.on(WS_EVENT_NAME, (data) => {

packages/devtools/src/server-rpc/analyze-build.ts

@@ -17,7 +17,7 @@ export function setupAnalyzeBuildRPC({ nuxt, refresh, ensureDevAuthToken }: Nuxt
 
   async function startAnalyzeBuild(name: string) {
     if (promise)
-      throw new Error('Already building')
+      throw new Error('[Nuxt DevTools] A building process is already running')
 
     const result = startSubprocess({
       command: 'npx',

packages/devtools/src/server-rpc/assets.ts

@@ -112,12 +112,12 @@ export function setupAssetsRPC({ nuxt, ensureDevAuthToken, refresh, options }: N
         files.map(async ({ path, content, encoding, override }) => {
           let finalPath = resolve(baseDir, path)
           if (!finalPath.startsWith(baseDir))
-            throw new Error(`File ${path} is not allowed to upload, it's outside of the public directory`)
+            throw new Error(`[Nuxt DevTools] File ${path} is not allowed to upload, it's outside of the public directory`)
 
           const { ext } = parse(finalPath)
           if (extensions !== '*') {
             if (!extensions.includes(ext.toLowerCase().slice(1)))
-              throw new Error(`File extension ${ext} is not allowed to upload, allowed extensions are: ${extensions.join(', ')}\nYou can configure it in Nuxt config at \`devtools.assets.uploadExtensions\`.`)
+              throw new Error(`[Nuxt DevTools] File extension ${ext} is not allowed to upload, allowed extensions are: ${extensions.join(', ')}\nYou can configure it in Nuxt config at \`devtools.assets.uploadExtensions\`.`)
           }
 
           if (!override) {
@@ -150,7 +150,7 @@ export function setupAssetsRPC({ nuxt, ensureDevAuthToken, refresh, options }: N
 
       const exist = cache?.find(asset => asset.filePath === newPath)
       if (exist)
-        throw new Error(`File ${newPath} already exists`)
+        throw new Error(`[Nuxt DevTools] File ${newPath} already exists, failed to rename`)
       return await fsp.rename(oldPath, newPath)
     },
   } satisfies Partial<ServerFunctions>

packages/devtools/src/server-rpc/index.ts

@@ -81,7 +81,7 @@ export function setupRPC(nuxt: Nuxt, options: ModuleOptions) {
       if (options.disableAuthorization)
         return
       if (token !== await getDevAuthToken())
-        throw new Error('Invalid dev auth token.')
+        throw new Error('[Nuxt DevTools] Invalid dev auth token.')
     },
   }
 

packages/devtools/src/server-rpc/npm.ts

@@ -132,7 +132,7 @@ export function setupNpmRPC({ nuxt, ensureDevAuthToken }: NuxtDevtoolsServerCont
         const code = result.exitCode
         if (code !== 0) {
           console.error(result.stderr)
-          throw new Error(`Failed to install module, process exited with ${code}`)
+          throw new Error(`[Nuxt DevTools] Failed to install module, process exited with ${code}`)
         }
 
         // If all modules have been installed, write back to the config file, and auto restart.
@@ -193,7 +193,7 @@ export function setupNpmRPC({ nuxt, ensureDevAuthToken }: NuxtDevtoolsServerCont
         const code = result.exitCode
         if (code !== 0) {
           console.error(result.stderr)
-          throw new Error(`Failed to uninstall module', process exited with ${code}`)
+          throw new Error(`[Nuxt DevTools] Failed to uninstall module, process exited with ${code}`)
         }
 
         await fs.writeFile(filepath, generated, 'utf-8')

packages/devtools/src/utils/magicast.ts

@@ -8,7 +8,7 @@ export async function magicastGuard(fn: (() => Promise<string>), message = '') {
   }
   catch (e) {
     logger.error(e)
-    throw new Error(`Magicast failed to modify Nuxt config automatically. Maybe the config are composed too dynamically that we failed to statically analyze it. ${message}`)
+    throw new Error(`[Nuxt DevTools] Magicast failed to modify Nuxt config automatically. Maybe the config are composed too dynamically that we failed to statically analyze it. ${message}`)
   }
 
   return generated