fix(nuxt): handle nightly releases for hoisted types

danielroe · danielroe · commit 3c7e68c84637 · 2024-03-16T17:18:31.000-07:00
diff --git a/packages/nuxt/src/core/nuxt.ts b/packages/nuxt/src/core/nuxt.ts
@@ -4,7 +4,8 @@ import type { LoadNuxtOptions } from '@nuxt/kit'
 import { addBuildPlugin, addComponent, addPlugin, addRouteMiddleware, addServerPlugin, addVitePlugin, addWebpackPlugin, installModule, loadNuxtConfig, logger, nuxtCtx, resolveAlias, resolveFiles, resolvePath, tryResolveModule, useNitro } from '@nuxt/kit'
 import { resolvePath as _resolvePath } from 'mlly'
 import type { Nuxt, NuxtHooks, NuxtOptions } from 'nuxt/schema'
-import { resolvePackageJSON } from 'pkg-types'
+import type { PackageJson } from 'pkg-types'
+import { readPackageJSON, resolvePackageJSON } from 'pkg-types'
 
 import escapeRE from 'escape-string-regexp'
 import fse from 'fs-extra'
@@ -51,6 +52,14 @@ export function createNuxt (options: NuxtOptions): Nuxt {
   return nuxt
 }
 
+const nightlies = {
+  nitropack: 'nitropack-nightly',
+  h3: 'h3-nightly',
+  nuxt: 'nuxt-nightly',
+  '@nuxt/schema': '@nuxt/schema-nightly',
+  '@nuxt/kit': '@nuxt/kit-nightly'
+}
+
 async function initNuxt (nuxt: Nuxt) {
   // Register user hooks
   for (const config of nuxt.options._layers.map(layer => layer.config).reverse()) {
@@ -64,11 +73,28 @@ async function initNuxt (nuxt: Nuxt) {
   nuxt.hook('close', () => nuxtCtx.unset())
 
   const coreTypePackages = nuxt.options.typescript.hoist || []
+  const packageJSON = await readPackageJSON(nuxt.options.rootDir).catch(() => ({}) as PackageJson)
+  const dependencies = new Set([...Object.keys(packageJSON.dependencies || {}), ...Object.keys(packageJSON.devDependencies || {})])
   const paths = Object.fromEntries(await Promise.all(coreTypePackages.map(async (pkg) => {
+    // ignore packages that exist in `package.json` as these can be resolved by TypeScript
+    if (dependencies.has(pkg) && !(pkg in nightlies)) { return [] }
+
+    // deduplicate types for nightly releases
+    if (pkg in nightlies) {
+      const nightly = nightlies[pkg as keyof typeof nightlies]
+      const path = await _resolvePath(nightly, { url: nuxt.options.modulesDir }).then(r => resolvePackageJSON(r)).catch(() => null)
+      if (path) {
+        return [[pkg, [dirname(path)]], [nightly, [dirname(path)]]]
+      }
+    }
+
     const path = await _resolvePath(pkg, { url: nuxt.options.modulesDir }).then(r => resolvePackageJSON(r)).catch(() => null)
-    if (!path) { return }
-    return [pkg, [dirname(path)]]
-  })).then(r => r.filter(Boolean) as [string, [string]][]))
+    if (path) {
+      return [[pkg, [dirname(path)]]]
+    }
+
+    return []
+  })).then(r => r.flat()))
 
   // Set nitro resolutions for types that might be obscured with shamefully-hoist=false
   nuxt.options.nitro.typescript = defu(nuxt.options.nitro.typescript, {
diff --git a/packages/schema/src/config/typescript.ts b/packages/schema/src/config/typescript.ts
@@ -32,7 +32,7 @@ export default defineUntypedSchema({
      */
     hoist: {
       $resolve: (val) => {
-        const defaults = ['nitropack', 'defu', 'h3', '@unhead/vue', 'vue', 'vue-router', '@nuxt/schema']
+        const defaults = ['nitropack', 'defu', 'h3', '@unhead/vue', 'vue', 'vue-router', '@nuxt/schema', 'nuxt', 'consola']
         return val === false ? [] : (Array.isArray(val) ? val.concat(defaults) : defaults)
       }
     },

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ export default defineUntypedSchema({`
`32`	`32`	`*/`
`33`	`33`	`hoist: {`
`34`	`34`	`$resolve: (val) => {`
`35`		`- const defaults = ['nitropack', 'defu', 'h3', '@unhead/vue', 'vue', 'vue-router', '@nuxt/schema']`
	`35`	`+ const defaults = ['nitropack', 'defu', 'h3', '@unhead/vue', 'vue', 'vue-router', '@nuxt/schema', 'nuxt', 'consola']`
`36`	`36`	`return val === false ? [] : (Array.isArray(val) ? val.concat(defaults) : defaults)`
`37`	`37`	`}`
`38`	`38`	`},`