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

fix(nuxt): improve dx around compatibility date prompt (#27965)

Browse Source
This commit is contained in:
Daniel Roe 2024-07-02 14:50:32 +01:00 committed by GitHub
parent f679369908
commit b91ec5d6dd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,7 +13,7 @@ import { hash } from 'ohash'
import consola from 'consola' import consola from 'consola'
import { colorize } from 'consola/utils' import { colorize } from 'consola/utils'
import { updateConfig } from 'c12/update' import { updateConfig } from 'c12/update'
import { formatDate } from 'compatx' import { formatDate, resolveCompatibilityDatesFromEnv } from 'compatx'
import type { DateString } from 'compatx' import type { DateString } from 'compatx'
import escapeRE from 'escape-string-regexp' import escapeRE from 'escape-string-regexp'
@ -95,21 +95,28 @@ async function initNuxt (nuxt: Nuxt) {
} }
// Prompt to set compatibility date // Prompt to set compatibility date
if (!nuxt.options.compatibilityDate) { nuxt.options.compatibilityDate = resolveCompatibilityDatesFromEnv(nuxt.options.compatibilityDate)
const todaysDate = formatDate(new Date())
if (!warnedAboutCompatDate) { if (!nuxt.options.compatibilityDate.default) {
// Print warning const todaysDate = formatDate(new Date())
console.info(`Nuxt now supports pinning the behavior of provider and deployment presets with a compatibility date. We recommend you specify a \`compatibilityDate\` in your \`nuxt.config\` file.`) nuxt.options.compatibilityDate.default = fallbackCompatibilityDate
const shouldShowPrompt = nuxt.options.dev && hasTTY && !isCI
if (!shouldShowPrompt) {
console.log(`Using \`${fallbackCompatibilityDate}\` as fallback compatibility date.`)
} }
// Prompt to update in dev mode async function promptAndUpdate () {
if (!warnedAboutCompatDate && nuxt.options.dev && hasTTY && !isCI) {
const result = await consola.prompt(`Do you want to update your ${colorize('cyan', 'nuxt.config')} to set ${colorize('cyan', `compatibilityDate: '${todaysDate}'`)}?`, { const result = await consola.prompt(`Do you want to update your ${colorize('cyan', 'nuxt.config')} to set ${colorize('cyan', `compatibilityDate: '${todaysDate}'`)}?`, {
type: 'confirm', type: 'confirm',
default: true, default: true,
}) })
if (result === true) { if (result !== true) {
console.log(`Using \`${fallbackCompatibilityDate}\` as fallback compatibility date.`)
return
}
try {
const res = await updateConfig({ const res = await updateConfig({
configFile: 'nuxt.config', configFile: 'nuxt.config',
cwd: nuxt.options.rootDir, cwd: nuxt.options.rootDir,
@ -126,25 +133,32 @@ async function initNuxt (nuxt: Nuxt) {
onUpdate (config) { onUpdate (config) {
config.compatibilityDate = todaysDate config.compatibilityDate = todaysDate
}, },
}).catch((error) => {
consola.error(`Failed to update config: ${error.message}`)
return null
}) })
if (res?.configFile) { if (res?.configFile) {
nuxt.options.compatibilityDate = todaysDate nuxt.options.compatibilityDate = resolveCompatibilityDatesFromEnv(todaysDate)
consola.success(`Compatibility date set to \`${todaysDate}\` in \`${relative(nuxt.options.rootDir, res.configFile)}\``) consola.success(`Compatibility date set to \`${todaysDate}\` in \`${relative(nuxt.options.rootDir, res.configFile)}\``)
return
} }
} } catch (err) {
const message = err instanceof Error ? err.message : err
consola.error(`Failed to update config: ${message}`)
} }
if (!nuxt.options.compatibilityDate) {
nuxt.options.compatibilityDate = fallbackCompatibilityDate
if (!warnedAboutCompatDate) {
console.log(`Using \`${fallbackCompatibilityDate}\` as fallback compatibility date.`) console.log(`Using \`${fallbackCompatibilityDate}\` as fallback compatibility date.`)
} }
}
nuxt.hooks.hookOnce('nitro:init', (nitro) => {
if (warnedAboutCompatDate) { return }
nitro.hooks.hookOnce('compiled', () => {
warnedAboutCompatDate = true warnedAboutCompatDate = true
// Print warning
console.info(`Nuxt now supports pinning the behavior of provider and deployment presets with a compatibility date. We recommend you specify a \`compatibilityDate\` in your \`nuxt.config\` file, or set an environment variable, such as \`COMPATIBILITY_DATE=${todaysDate}\`.`)
if (shouldShowPrompt) { promptAndUpdate() }
})
})
} }
// Restart Nuxt when layer directories are added or removed // Restart Nuxt when layer directories are added or removed