Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2025-01-22 11:22:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: rename fallback to global

Browse Source
This commit is contained in:
Julien Huang 2025-01-11 17:52:20 +01:00
parent 97af928232
commit 982af4e1a2
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/kit/src/context.ts
View File

@ -3,9 +3,9 @@ import type { Nuxt } from '@nuxt/schema'
import { asyncNameStorage } from './utils' import { asyncNameStorage } from './utils'
import { logger } from './logger' import { logger } from './logger'
/** Direct access to the Nuxt context - see https://github.com/unjs/unctx. */ /** Direct access to the Nuxt context with asyncLocalStorage - see https://github.com/unjs/unctx. */
export const nuxtCtx = () => getContext<Nuxt>(asyncNameStorage.getStore()!) export const getNuxtCtx = () => getContext<Nuxt>(asyncNameStorage.getStore()!)
export const fallbackNuxtCtx = getContext<Nuxt>('nuxt-fallback') export const globalNuxtCtx = getContext<Nuxt>('nuxt-global')
// TODO: Use use/tryUse from unctx. https://github.com/unjs/unctx/issues/6 // TODO: Use use/tryUse from unctx. https://github.com/unjs/unctx/issues/6
@ -19,9 +19,9 @@ export const fallbackNuxtCtx = getContext<Nuxt>('nuxt-fallback')
* ``` * ```
*/ */
export function useNuxt (): Nuxt { export function useNuxt (): Nuxt {
const instance = nuxtCtx().tryUse() const instance = getNuxtCtx().tryUse()
if (!instance) { if (!instance) {
const fallbackInstance = fallbackNuxtCtx.tryUse() const fallbackInstance = globalNuxtCtx.tryUse()
if (fallbackInstance) { if (fallbackInstance) {
logger.warn('Using fallback global Nuxt instance. You may be using a @nuxt/kit composable outside of a Nuxt context, this behavior is deprecated and will be removed in v4.') logger.warn('Using fallback global Nuxt instance. You may be using a @nuxt/kit composable outside of a Nuxt context, this behavior is deprecated and will be removed in v4.')
return fallbackInstance return fallbackInstance
@ -45,10 +45,10 @@ export function useNuxt (): Nuxt {
* ``` * ```
*/ */
export function tryUseNuxt (): Nuxt | null { export function tryUseNuxt (): Nuxt | null {
const nuxt = nuxtCtx().tryUse() const nuxt = getNuxtCtx().tryUse()
if (!nuxt) { if (!nuxt) {
logger.warn('Using fallback global Nuxt instance. You may be using a @nuxt/kit composable outside of a Nuxt context, this behavior is deprecated and will be removed in v4.') logger.warn('Using fallback global Nuxt instance. You may be using a @nuxt/kit composable outside of a Nuxt context, this behavior is deprecated and will be removed in v4.')
return fallbackNuxtCtx.tryUse() return globalNuxtCtx.tryUse()
} }
return nuxt return nuxt
} }

2
packages/kit/src/index.ts
View File

@ -18,7 +18,7 @@ export type { ExtendConfigOptions, ExtendViteConfigOptions, ExtendWebpackConfigO
export { assertNuxtCompatibility, checkNuxtCompatibility, getNuxtVersion, hasNuxtCompatibility, isNuxtMajorVersion, normalizeSemanticVersion, isNuxt2, isNuxt3 } from './compatibility' export { assertNuxtCompatibility, checkNuxtCompatibility, getNuxtVersion, hasNuxtCompatibility, isNuxtMajorVersion, normalizeSemanticVersion, isNuxt2, isNuxt3 } from './compatibility'
export { addComponent, addComponentsDir } from './components' export { addComponent, addComponentsDir } from './components'
export type { AddComponentOptions } from './components' export type { AddComponentOptions } from './components'
export { nuxtCtx, tryUseNuxt, useNuxt, fallbackNuxtCtx } from './context' export { getNuxtCtx as nuxtCtx, tryUseNuxt, useNuxt, globalNuxtCtx } from './context'
export { isIgnored, resolveIgnorePatterns } from './ignore' export { isIgnored, resolveIgnorePatterns } from './ignore'
export { addLayout } from './layout' export { addLayout } from './layout'
export { addRouteMiddleware, extendPages, extendRouteRules } from './pages' export { addRouteMiddleware, extendPages, extendRouteRules } from './pages'

8
packages/nuxt/src/core/nuxt.ts
View File

@ -4,7 +4,7 @@ import { join, normalize, relative, resolve } from 'pathe'
import { createDebugger, createHooks } from 'hookable' import { createDebugger, createHooks } from 'hookable'
import ignore from 'ignore' import ignore from 'ignore'
import type { LoadNuxtOptions } from '@nuxt/kit' import type { LoadNuxtOptions } from '@nuxt/kit'
import { addBuildPlugin, addComponent, addPlugin, addPluginTemplate, addRouteMiddleware, addServerPlugin, addTypeTemplate, addVitePlugin, addWebpackPlugin, asyncNameStorage, fallbackNuxtCtx, installModule, loadNuxtConfig, nuxtCtx, resolveAlias, resolveFiles, resolveIgnorePatterns, resolvePath, tryResolveModule, useNitro } from '@nuxt/kit' import { addBuildPlugin, addComponent, addPlugin, addPluginTemplate, addRouteMiddleware, addServerPlugin, addTypeTemplate, addVitePlugin, addWebpackPlugin, asyncNameStorage, globalNuxtCtx, installModule, loadNuxtConfig, nuxtCtx, resolveAlias, resolveFiles, resolveIgnorePatterns, resolvePath, tryResolveModule, useNitro } from '@nuxt/kit'
import type { Nuxt, NuxtHooks, NuxtModule, NuxtOptions } from 'nuxt/schema' import type { Nuxt, NuxtHooks, NuxtModule, NuxtOptions } from 'nuxt/schema'
import type { PackageJson } from 'pkg-types' import type { PackageJson } from 'pkg-types'
import { readPackageJSON } from 'pkg-types' import { readPackageJSON } from 'pkg-types'
@ -175,11 +175,11 @@ async function initNuxt (nuxt: Nuxt) {
} }
} }
}) })
if (!fallbackNuxtCtx.tryUse()) { if (!globalNuxtCtx.tryUse()) {
// backward compatibility with 3.x // backward compatibility with 3.x
fallbackNuxtCtx.set(nuxt) globalNuxtCtx.set(nuxt)
nuxt.hook('close', () => { nuxt.hook('close', () => {
fallbackNuxtCtx.unset() globalNuxtCtx.unset()
}) })
} }
// Set nuxt instance for useNuxt // Set nuxt instance for useNuxt