feat(nuxt, kit): auto import defineNuxtConfig (#7497)

nuxt · Sep 14, 2022 · ac0b3a6 · ac0b3a6
1 parent aaac469
commit ac0b3a6
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/packages/kit/src/loader/config.ts b/packages/kit/src/loader/config.ts
@@ -7,6 +7,7 @@ import { NuxtConfigSchema } from '@nuxt/schema'
 export interface LoadNuxtConfigOptions extends LoadConfigOptions<NuxtConfig> {}
 
 export async function loadNuxtConfig (opts: LoadNuxtConfigOptions): Promise<NuxtOptions> {
+  (globalThis as any).defineNuxtConfig = (c: any) => c
   const result = await loadConfig<NuxtConfig>({
     name: 'nuxt',
     configFile: 'nuxt.config',
@@ -16,6 +17,7 @@ export async function loadNuxtConfig (opts: LoadNuxtConfigOptions): Promise<Nuxt
     globalRc: true,
     ...opts
   })
+  delete (globalThis as any).defineNuxtConfig
   const { configFile, layers = [], cwd } = result
   const nuxtConfig = result.config!
 

diff --git a/packages/nuxt/src/core/nuxt.ts b/packages/nuxt/src/core/nuxt.ts
@@ -234,10 +234,11 @@ export async function loadNuxt (opts: LoadNuxtOptions): Promise<Nuxt> {
   return nuxt
 }
 
-/** @deprecated Use import { defineNuxtConfig } from  'nuxt/config' */
+/** @deprecated `defineNuxtConfig` is auto imported. Remove import or alternatively use `import { defineNuxtConfig } from  'nuxt/config'`. */
 export function defineNuxtConfig (config: NuxtConfig): NuxtConfig {
   return config
 }
 
-/** @deprecated Use import type { NuxtConfig } from  'nuxt/config' */
-export type { NuxtConfig }
+/** @deprecated Use `import type { NuxtConfig } from  'nuxt/config'`.  */
+type _NuxtConfig = NuxtConfig
+export type { _NuxtConfig as NuxtConfig }
diff --git a/packages/nuxt/types.d.ts b/packages/nuxt/types.d.ts
@@ -1,2 +1,6 @@
 /// <reference types="nitropack" />
 export * from './dist/index'
+
+declare global {
+  const defineNuxtConfig: typeof import('nuxt/config')['defineNuxtConfig']
+}
diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -1,3 +1,3 @@
-import { defineNuxtConfig } from 'nuxt/config'
+export default defineNuxtConfig({
 
-export default defineNuxtConfig({})
+})