fix: match exsolve resolution errors when @nuxt/kit is missing

Author: danielroe

packages/nuxt-cli/src/utils/kit.ts

@@ -2,6 +2,9 @@ import { pathToFileURL } from 'node:url'
 import { resolveModulePath } from 'exsolve'
 import { withNodePath } from './paths'
 
+// `exsolve` and Node.js word their resolution failures differently
+const KIT_NOT_FOUND_RE = /Cannot (?:find|resolve) module ['"]@nuxt\/kit['"]/
+
 export async function loadKit(rootDir: string): Promise<typeof import('@nuxt/kit')> {
   try {
     const kitPath = resolveModulePath('@nuxt/kit', { from: tryResolveNuxt(rootDir) || rootDir })
@@ -18,7 +21,7 @@ export async function loadKit(rootDir: string): Promise<typeof import('@nuxt/kit
     return kit
   }
   catch (e: any) {
-    if (e.toString().includes('Cannot find module \'@nuxt/kit\'')) {
+    if (KIT_NOT_FOUND_RE.test(String(e))) {
       throw new Error(
         'nuxi requires `@nuxt/kit` to be installed in your project. Try installing `nuxt` v3+ or `@nuxt/bridge` first.',
       )

packages/nuxt-cli/test/unit/utils/kit.spec.ts

@@ -0,0 +1,30 @@
+import { mkdtemp } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+import process from 'node:process'
+
+import { afterEach, beforeEach, describe, expect, it } from 'vitest'
+
+import { loadKit } from '../../../src/utils/kit'
+
+let nodePath: string | undefined
+
+// `vitest` points `NODE_PATH` at the pnpm store, where `@nuxt/kit` is resolvable
+beforeEach(() => {
+  nodePath = process.env.NODE_PATH
+  delete process.env.NODE_PATH
+})
+
+afterEach(() => {
+  process.env.NODE_PATH = nodePath
+})
+
+describe('loadKit', () => {
+  it('should explain how to install `@nuxt/kit` when it cannot be resolved', async () => {
+    const rootDir = await mkdtemp(join(tmpdir(), 'nuxi-kit-'))
+
+    await expect(loadKit(rootDir)).rejects.toThrowError(
+      'nuxi requires `@nuxt/kit` to be installed in your project. Try installing `nuxt` v3+ or `@nuxt/bridge` first.',
+    )
+  })
+})