import fs, { promises, existsSync, readdirSync, statSync, readFileSync, mkdirSync, writeFileSync } from 'node:fs'; import { mkdir, readFile, readdir, writeFile, rm, stat, unlink, open } from 'node:fs/promises'; import { randomUUID } from 'node:crypto'; import { AsyncLocalStorage } from 'node:async_hooks'; import { dirname, resolve, normalize, basename, extname, relative, isAbsolute, join } from 'pathe'; import { createHooks, createDebugger } from 'hookable'; import ignore from 'ignore'; import { useLogger, tryUseNuxt, useNuxt, directoryToURL, getLayerDirectories, resolveFiles, resolvePath, defineNuxtModule, findPath, addPlugin, addTemplate, addTypeTemplate, addComponent, useNitro, addBuildPlugin, isIgnored, resolveAlias as resolveAlias$1, addPluginTemplate, addImportsSources, addVitePlugin, createIsIgnored, updateTemplates, tryResolveModule, normalizeModuleTranspilePath, resolveNuxtModule, resolveIgnorePatterns, logger as logger$1, createResolver, importModule, tryImportModule, runWithNuxtContext, nuxtCtx, loadNuxtConfig, addWebpackPlugin, addServerPlugin, installModules, addServerTemplate, addServerHandler, addRouteMiddleware, normalizeTemplate, compileTemplate, normalizePlugin, templateUtils } from '@nuxt/kit'; import { resolvePackageJSON, readPackageJSON } from 'pkg-types'; import { hash, isEqual, serialize } from 'ohash'; import consola, { consola as consola$1 } from 'consola'; import onChange from 'on-change'; import { colors } from 'consola/utils'; import { resolveCompatibilityDatesFromEnv, formatDate } from 'compatx'; import escapeRE from 'escape-string-regexp'; import { withTrailingSlash as withTrailingSlash$1, parseURL, parseQuery, joinURL, withLeadingSlash, encodePath, withoutLeadingSlash } from 'ufo'; import { ImpoundPlugin } from 'impound'; import defu$1, { defu } from 'defu'; import { satisfies, coerce, gt } from 'semver'; import { isCI, provider, isWindows, hasTTY } from 'std-env'; import { genArrayFromRaw, genSafeVariableName, genImport, genDynamicImport, genObjectFromRawEntries, genString, genExport } from 'knitwork'; import { addDependency } from 'nypm'; import { reverseResolveAlias, filename, resolveAlias } from 'pathe/utils'; import { createRoutesContext } from 'unplugin-vue-router'; import { resolveOptions } from 'unplugin-vue-router/options'; import { toRouteMatcher, createRouter, exportMatcher } from 'radix3'; import { fileURLToPath, pathToFileURL } from 'node:url'; import { resolveModulePath } from 'exsolve'; import { runInNewContext } from 'node:vm'; import { klona } from 'klona'; import { parseAndWalk, ScopeTracker, walk, isBindingIdentifier, getUndeclaredIdentifiersInFunction } from 'oxc-walker'; import { parseSync } from 'oxc-parser'; import { transform } from 'oxc-transform'; import { splitByCase, kebabCase, pascalCase, camelCase } from 'scule'; import { createUnplugin } from 'unplugin'; import { findStaticImports, findExports, parseStaticImport, parseNodeModulePath, lookupNodeModuleSubpath } from 'mlly'; import MagicString from 'magic-string'; import { stripLiteral } from 'strip-literal'; import { unheadVueComposablesImports } from '@unhead/vue'; import { defineUnimportPreset, createUnimport, toExports, scanDirExports } from 'unimport'; import { glob } from 'tinyglobby'; import { parse, walk as walk$1, ELEMENT_NODE } from 'ultrahtml'; import { parseQuery as parseQuery$1 } from 'vue-router'; import { createTransformer } from 'unctx/transform'; import { cpus } from 'node:os'; import { createNitro, scanHandlers, writeTypes, copyPublicAssets, prepare, build as build$1, prerender, createDevServer } from 'nitropack'; import { dynamicEventHandler, defineEventHandler } from 'h3'; import { watch as watch$1 } from 'chokidar'; import { debounce } from 'perfect-debounce'; import { resolveSchema, generateTypes } from 'untyped'; import untypedPlugin from 'untyped/babel-plugin'; import { createJiti } from 'jiti'; import { minify } from 'oxc-minify'; import { resolve as resolve$1 } from 'node:path'; import { parseTar, createTar } from 'nanotar'; function toArray(value) { return Array.isArray(value) ? value : [value]; } async function isDirectory$1(path) { return (await promises.lstat(path)).isDirectory(); } const logger = useLogger("nuxt"); function resolveToAlias(path, nuxt = tryUseNuxt()) { return reverseResolveAlias(path, { ...nuxt?.options.alias || {}, ...strippedAtAliases }).pop() || path; } const strippedAtAliases = { "@": "", "@@": "" }; const isStackblitz = provider === "stackblitz"; async function promptToInstall(name, installCommand, options) { for (const parent of options.searchPaths || []) { if (await resolvePackageJSON(name, { parent }).catch(() => null)) { return true; } } logger.info(`Package ${name} is missing`); if (isCI) { return false; } if (options.prompt === true || options.prompt !== false && !isStackblitz) { const confirm = await logger.prompt(`Do you want to install ${name} package?`, { type: "confirm", name: "confirm", initial: true }); if (!confirm) { return false; } } logger.info(`Installing ${name}...`); try { await installCommand(); logger.success(`Installed ${name}`); return true; } catch (err) { logger.error(err); return false; } } const installPrompts = /* @__PURE__ */ new Set(); function installNuxtModule(name, options) { if (installPrompts.has(name)) { return; } installPrompts.add(name); const nuxt = useNuxt(); return promptToInstall(name, async () => { const { runCommand } = await import('@nuxt/cli'); await runCommand("module", ["add", name, "--cwd", nuxt.options.rootDir]); }, { rootDir: nuxt.options.rootDir, searchPaths: nuxt.options.modulesDir, ...options }); } function ensurePackageInstalled(name, options) { return promptToInstall(name, () => addDependency(name, { cwd: options.rootDir, dev: true }), options); } const features = { __proto__: null, ensurePackageInstalled: ensurePackageInstalled, installNuxtModule: installNuxtModule }; let _distDir = dirname(fileURLToPath(import.meta.url)); if (/(?:chunks|shared)$/.test(_distDir)) { _distDir = dirname(_distDir); } const distDir = _distDir; const pkgDir = resolve(distDir, ".."); async function resolveTypePath(path, subpath, searchPaths = tryUseNuxt()?.options.modulesDir) { try { const r = resolveModulePath(path, { from: searchPaths?.map((d) => directoryToURL(d)), conditions: ["types", "import", "require"], extensions: [".js", ".mjs", ".cjs", ".ts", ".mts", ".cts"] }); if (subpath) { return r.replace(/(?:\.d)?\.[mc]?[jt]s$/, ""); } const rootPath = await resolvePackageJSON(r); return dirname(rootPath); } catch { return null; } } function getNameFromPath(path, relativeTo) { const relativePath = relativeTo ? normalize(path).replace(withTrailingSlash$1(normalize(relativeTo)), "") : basename(path); const prefixParts = splitByCase(dirname(relativePath)); const fileName = basename(relativePath, extname(relativePath)); const segments = resolveComponentNameSegments(fileName.toLowerCase() === "index" ? "" : fileName, prefixParts).filter(Boolean); return kebabCase(segments).replace(QUOTE_RE, ""); } function hasSuffix(path, suffix) { return basename(path, extname(path)).endsWith(suffix); } function resolveComponentNameSegments(fileName, prefixParts) { const fileNameParts = splitByCase(fileName); const fileNamePartsContent = fileNameParts.join("/").toLowerCase(); const componentNameParts = prefixParts.flatMap((p) => splitByCase(p)); let index = prefixParts.length - 1; const matchedSuffix = []; while (index >= 0) { const prefixPart = prefixParts[index]; matchedSuffix.unshift(...splitByCase(prefixPart).map((p) => p.toLowerCase())); const matchedSuffixContent = matchedSuffix.join("/"); if (fileNamePartsContent === matchedSuffixContent || fileNamePartsContent.startsWith(matchedSuffixContent + "/") || // e.g. Item/Item/Item.vue -> Item prefixPart.toLowerCase() === fileNamePartsContent && prefixParts[index + 1] && prefixParts[index] === prefixParts[index + 1]) { componentNameParts.length = index; } index--; } return [...componentNameParts, ...fileNameParts]; } function isVue(id, opts = {}) { const { search } = parseURL(decodeURIComponent(pathToFileURL(id).href)); if (id.endsWith(".vue") && !search) { return true; } if (!search) { return false; } const query = parseQuery(search); if (query.nuxt_component) { return false; } if (query.macro && (search === "?macro=true" || !opts.type || opts.type.includes("script"))) { return true; } const type = "setup" in query ? "script" : query.type; if (!("vue" in query) || opts.type && !opts.type.includes(type)) { return false; } return true; } const JS_RE$1 = /\.(?:[cm]?j|t)sx?$/; function isJS(id) { const { pathname } = parseURL(decodeURIComponent(pathToFileURL(id).href)); return JS_RE$1.test(pathname); } function getLoader(id) { const { pathname } = parseURL(decodeURIComponent(pathToFileURL(id).href)); const ext = extname(pathname); if (ext === ".vue") { return "vue"; } if (!JS_RE$1.test(ext)) { return null; } return ext.endsWith("x") ? "tsx" : "ts"; } function matchWithStringOrRegex(value, matcher) { if (typeof matcher === "string") { return value === matcher; } else if (matcher instanceof RegExp) { return matcher.test(value); } return false; } function uniqueBy(arr, key) { if (arr.length < 2) { return arr; } const res = []; const seen = /* @__PURE__ */ new Set(); for (const item of arr) { if (seen.has(item[key])) { continue; } seen.add(item[key]); res.push(item); } return res; } const QUOTE_RE = /["']/g; const EXTENSION_RE = /\b\.\w+$/g; const SX_RE = /\.[tj]sx$/; const SegmentTokenType = { static: "static", dynamic: "dynamic", optional: "optional", catchall: "catchall", group: "group" }; const SegmentParserState = { initial: "initial", ...SegmentTokenType }; const enUSComparator = new Intl.Collator("en-US"); async function resolvePagesRoutes(pattern, nuxt = useNuxt()) { const pagesDirs = getLayerDirectories(nuxt).map((d) => d.appPages); const scannedFiles = []; for (const dir of pagesDirs) { const files = await resolveFiles(dir, pattern); scannedFiles.push(...files.map((file) => ({ relativePath: relative(dir, file), absolutePath: file }))); } scannedFiles.sort((a, b) => enUSComparator.compare(a.relativePath, b.relativePath)); const allRoutes = generateRoutesFromFiles(uniqueBy(scannedFiles, "relativePath"), { shouldUseServerComponents: !!nuxt.options.experimental.componentIslands }); const pages = uniqueBy(allRoutes, "path"); const shouldAugment = nuxt.options.experimental.scanPageMeta || nuxt.options.experimental.typedPages; if (shouldAugment === false) { await nuxt.callHook("pages:extend", pages); return pages; } const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys || []; const augmentCtx = { extraExtractionKeys: /* @__PURE__ */ new Set([ "middleware", ...extraPageMetaExtractionKeys ]), fullyResolvedPaths: new Set(scannedFiles.map((file) => file.absolutePath)) }; if (shouldAugment === "after-resolve") { await nuxt.callHook("pages:extend", pages); await augmentPages(pages, nuxt.vfs, augmentCtx); } else { const augmentedPages = await augmentPages(pages, nuxt.vfs, augmentCtx); await nuxt.callHook("pages:extend", pages); await augmentPages(pages, nuxt.vfs, { pagesToSkip: augmentedPages, ...augmentCtx }); augmentedPages?.clear(); } await nuxt.callHook("pages:resolved", pages); return pages; } const INDEX_PAGE_RE = /\/index$/; function generateRoutesFromFiles(files, options = {}) { if (!files.length) { return []; } const routes = []; const sortedFiles = [...files].sort((a, b) => a.relativePath.length - b.relativePath.length); for (const file of sortedFiles) { const segments = file.relativePath.replace(new RegExp(`${escapeRE(extname(file.relativePath))}$`), "").split("/"); const route = { name: "", path: "", file: file.absolutePath, children: [] }; let parent = routes; const lastSegment = segments[segments.length - 1]; if (lastSegment.endsWith(".server")) { segments[segments.length - 1] = lastSegment.replace(".server", ""); if (options.shouldUseServerComponents) { route.mode = "server"; } } else if (lastSegment.endsWith(".client")) { segments[segments.length - 1] = lastSegment.replace(".client", ""); route.mode = "client"; } for (let i = 0; i < segments.length; i++) { const segment = segments[i]; const tokens = parseSegment(segment, file.absolutePath); if (tokens.every((token) => token.type === SegmentTokenType.group)) { continue; } const segmentName = tokens.map(({ value, type }) => type === SegmentTokenType.group ? "" : value).join(""); route.name += (route.name && "/") + segmentName; const routePath = getRoutePath(tokens, segments[i + 1] !== void 0 && segments[i + 1] !== "index"); const path = withLeadingSlash(joinURL(route.path, routePath.replace(INDEX_PAGE_RE, "/"))); const child = parent.find((parentRoute) => parentRoute.name === route.name && parentRoute.path === path.replace("([^/]*)*", "(.*)*")); if (child && child.children) { parent = child.children; route.path = ""; } else if (segmentName === "index" && !route.path) { route.path += "/"; } else if (segmentName !== "index") { route.path += routePath; } } parent.push(route); } return prepareRoutes(routes); } async function augmentPages(routes, vfs, ctx = {}) { ctx.augmentedPages ??= /* @__PURE__ */ new Set(); for (const route of routes) { if (route.file && !ctx.pagesToSkip?.has(route.file)) { const fileContent = route.file in vfs ? vfs[route.file] : fs.readFileSync(ctx.fullyResolvedPaths?.has(route.file) ? route.file : await resolvePath(route.file), "utf-8"); const routeMeta = getRouteMeta(fileContent, route.file, ctx.extraExtractionKeys); if (route.meta) { routeMeta.meta = defu({}, routeMeta.meta, route.meta); } if (route.rules) { routeMeta.rules = defu({}, routeMeta.rules, route.rules); } Object.assign(route, routeMeta); ctx.augmentedPages.add(route.file); } if (route.children && route.children.length > 0) { await augmentPages(route.children, vfs, ctx); } } return ctx.augmentedPages; } const SFC_SCRIPT_RE = /[^>]*)>(?[\s\S]*?)<\/script[^>]*>/gi; function extractScriptContent(sfc) { const contents = []; for (const match of sfc.matchAll(SFC_SCRIPT_RE)) { if (match?.groups?.content) { contents.push({ loader: match.groups.attrs && /[tj]sx/.test(match.groups.attrs) ? "tsx" : "ts", code: match.groups.content.trim() }); } } return contents; } const PAGE_EXTRACT_RE = /(definePageMeta|defineRouteRules)\([\s\S]*?\)/g; const defaultExtractionKeys = ["name", "path", "props", "alias", "redirect", "middleware"]; const DYNAMIC_META_KEY = "__nuxt_dynamic_meta_key"; const pageContentsCache = {}; const extractCache = {}; function getRouteMeta(contents, absolutePath, extraExtractionKeys = /* @__PURE__ */ new Set()) { if (!(absolutePath in pageContentsCache) || pageContentsCache[absolutePath] !== contents) { pageContentsCache[absolutePath] = contents; delete extractCache[absolutePath]; } if (absolutePath in extractCache && extractCache[absolutePath]) { return klona(extractCache[absolutePath]); } const loader = getLoader(absolutePath); const scriptBlocks = !loader ? null : loader === "vue" ? extractScriptContent(contents) : [{ code: contents, loader }]; if (!scriptBlocks) { extractCache[absolutePath] = {}; return {}; } const extractedData = {}; const extractionKeys = /* @__PURE__ */ new Set([...defaultExtractionKeys, ...extraExtractionKeys]); for (const script of scriptBlocks) { const found = {}; for (const macro of script.code.matchAll(PAGE_EXTRACT_RE)) { found[macro[1]] = false; } if (Object.keys(found).length === 0) { continue; } const dynamicProperties = /* @__PURE__ */ new Set(); parseAndWalk(script.code, absolutePath.replace(/\.\w+$/, "." + script.loader), (node) => { if (node.type !== "ExpressionStatement" || node.expression.type !== "CallExpression" || node.expression.callee.type !== "Identifier") { return; } const fnName = node.expression.callee.name; if (fnName in found === false || found[fnName] !== false) { return; } found[fnName] = true; let code = script.code; let pageExtractArgument = node.expression.arguments[0]; if (/tsx?/.test(script.loader)) { const transformed = transform(absolutePath, script.code.slice(node.start, node.end), { lang: script.loader }); if (transformed.errors.length) { for (const error of transformed.errors) { logger.warn(`Error while transforming \`${fnName}()\`` + error.codeframe); } return; } pageExtractArgument = parseSync("", transformed.code, { lang: "js" }).program.body[0].expression.arguments[0]; code = transformed.code; } if (pageExtractArgument?.type !== "ObjectExpression") { logger.warn(`\`${fnName}\` must be called with an object literal (reading \`${absolutePath}\`), found ${pageExtractArgument?.type} instead.`); return; } if (fnName === "defineRouteRules") { const { value, serializable } = isSerializable(code, pageExtractArgument); if (!serializable) { logger.warn(`\`${fnName}\` must be called with a serializable object literal (reading \`${absolutePath}\`).`); return; } extractedData.rules = value; return; } if (fnName === "definePageMeta") { for (const key of extractionKeys) { const property = pageExtractArgument.properties.find((property2) => property2.type === "Property" && property2.key.type === "Identifier" && property2.key.name === key); if (!property) { continue; } const { value, serializable } = isSerializable(code, property.value); if (!serializable) { logger.debug(`Skipping extraction of \`${key}\` metadata as it is not JSON-serializable (reading \`${absolutePath}\`).`); dynamicProperties.add(extraExtractionKeys.has(key) ? "meta" : key); continue; } if (extraExtractionKeys.has(key)) { extractedData.meta ??= {}; extractedData.meta[key] = value; } else { extractedData[key] = value; } } for (const property of pageExtractArgument.properties) { if (property.type !== "Property") { continue; } const isIdentifierOrLiteral = property.key.type === "Literal" || property.key.type === "Identifier"; if (!isIdentifierOrLiteral) { continue; } const name = property.key.type === "Identifier" ? property.key.name : String(property.value); if (!extraExtractionKeys.has(name)) { dynamicProperties.add("meta"); break; } } if (dynamicProperties.size) { extractedData.meta ??= {}; extractedData.meta[DYNAMIC_META_KEY] = dynamicProperties; } } }); } extractCache[absolutePath] = extractedData; return klona(extractedData); } const COLON_RE = /:/g; function getRoutePath(tokens, hasSucceedingSegment = false) { return tokens.reduce((path, token) => { switch (token.type) { case SegmentTokenType.optional: return path + `:${token.value}?`; case SegmentTokenType.dynamic: return path + `:${token.value}()`; case SegmentTokenType.catchall: return path + (hasSucceedingSegment ? `:${token.value}([^/]*)*` : `:${token.value}(.*)*`); case SegmentTokenType.group: return path; case SegmentTokenType.static: default: return path + encodePath(token.value).replace(COLON_RE, "\\:"); } }, "/"); } const PARAM_CHAR_RE = /[\w.]/; function parseSegment(segment, absolutePath) { let state = SegmentParserState.initial; let i = 0; let buffer = ""; const tokens = []; function consumeBuffer() { if (!buffer) { return; } if (state === SegmentParserState.initial) { throw new Error("wrong state"); } tokens.push({ type: state, value: buffer }); buffer = ""; } while (i < segment.length) { const c = segment[i]; switch (state) { case SegmentParserState.initial: buffer = ""; if (c === "[") { state = SegmentParserState.dynamic; } else if (c === "(") { state = SegmentParserState.group; } else { i--; state = SegmentParserState.static; } break; case SegmentParserState.static: if (c === "[") { consumeBuffer(); state = SegmentParserState.dynamic; } else if (c === "(") { consumeBuffer(); state = SegmentParserState.group; } else { buffer += c; } break; case SegmentParserState.catchall: case SegmentParserState.dynamic: case SegmentParserState.optional: case SegmentParserState.group: if (buffer === "...") { buffer = ""; state = SegmentParserState.catchall; } if (c === "[" && state === SegmentParserState.dynamic) { state = SegmentParserState.optional; } if (c === "]" && (state !== SegmentParserState.optional || segment[i - 1] === "]")) { if (!buffer) { throw new Error("Empty param"); } else { consumeBuffer(); } state = SegmentParserState.initial; } else if (c === ")" && state === SegmentParserState.group) { if (!buffer) { throw new Error("Empty group"); } else { consumeBuffer(); } state = SegmentParserState.initial; } else if (c && PARAM_CHAR_RE.test(c)) { buffer += c; } else if (state === SegmentParserState.dynamic || state === SegmentParserState.optional) { if (c !== "[" && c !== "]") { logger.warn(`'\`${c}\`' is not allowed in a dynamic route parameter and has been ignored. Consider renaming \`${absolutePath}\`.`); } } break; } i++; } if (state === SegmentParserState.dynamic) { throw new Error(`Unfinished param "${buffer}"`); } consumeBuffer(); return tokens; } function findRouteByName(name, routes) { for (const route of routes) { if (route.name === name) { return route; } if (route.children && route.children.length > 0) { const child = findRouteByName(name, route.children); if (child) { return child; } } } } const NESTED_PAGE_RE = /\//g; function prepareRoutes(routes, parent, names = /* @__PURE__ */ new Set()) { for (const route of routes) { if (route.name) { route.name = route.name.replace(INDEX_PAGE_RE, "").replace(NESTED_PAGE_RE, "-"); if (names.has(route.name)) { const existingRoute = findRouteByName(route.name, routes); const extra = existingRoute?.name ? `is the same as \`${existingRoute.file}\`` : "is a duplicate"; logger.warn(`Route name generated for \`${route.file}\` ${extra}. You may wish to set a custom name using \`definePageMeta\` within the page file.`); } } if (parent && route.path[0] === "/") { route.path = route.path.slice(1); } if (route.children?.length) { route.children = prepareRoutes(route.children, route, names); } if (route.children?.find((childRoute) => childRoute.path === "")) { delete route.name; } if (route.name) { names.add(route.name); } } return routes; } function serializeRouteValue(value, skipSerialisation = false) { if (skipSerialisation || value === void 0) { return void 0; } return JSON.stringify(value); } function normalizeRoutes(routes, metaImports = /* @__PURE__ */ new Set(), options) { return { imports: metaImports, routes: genArrayFromRaw(routes.map((page) => { const markedDynamic = page.meta?.[DYNAMIC_META_KEY] ?? /* @__PURE__ */ new Set(); const metaFiltered = {}; let skipMeta = true; for (const key in page.meta || {}) { if (key !== DYNAMIC_META_KEY && page.meta[key] !== void 0) { skipMeta = false; metaFiltered[key] = page.meta[key]; } } const skipAlias = toArray(page.alias).every((val) => !val); const route = { path: serializeRouteValue(page.path), props: serializeRouteValue(page.props), name: serializeRouteValue(page.name), meta: serializeRouteValue(metaFiltered, skipMeta), alias: serializeRouteValue(toArray(page.alias), skipAlias), redirect: serializeRouteValue(page.redirect) }; for (const key of [...defaultExtractionKeys, "meta"]) { if (route[key] === void 0) { delete route[key]; } } if (page.children?.length) { route.children = normalizeRoutes(page.children, metaImports, options).routes; } if (!page.file) { return route; } const file = normalize(page.file); const pageImportName = genSafeVariableName(filename(file) + hash(file)); const metaImportName = pageImportName + "Meta"; metaImports.add(genImport(`${file}?macro=true`, [{ name: "default", as: metaImportName }])); if (page._sync) { metaImports.add(genImport(file, [{ name: "default", as: pageImportName }])); } const pageImport = page._sync && page.mode !== "client" ? pageImportName : genDynamicImport(file); const metaRoute = { name: `${metaImportName}?.name ?? ${route.name}`, path: `${metaImportName}?.path ?? ${route.path}`, props: `${metaImportName}?.props ?? ${route.props ?? false}`, meta: `${metaImportName} || {}`, alias: `${metaImportName}?.alias || []`, redirect: `${metaImportName}?.redirect`, component: page.mode === "server" ? `() => createIslandPage(${route.name})` : page.mode === "client" ? `() => createClientPage(${pageImport})` : pageImport }; if (page.mode === "server") { metaImports.add(` let _createIslandPage async function createIslandPage (name) { _createIslandPage ||= await import(${JSON.stringify(options?.serverComponentRuntime)}).then(r => r.createIslandPage) return _createIslandPage(name) };`); } else if (page.mode === "client") { metaImports.add(` let _createClientPage async function createClientPage(loader) { _createClientPage ||= await import(${JSON.stringify(options?.clientComponentRuntime)}).then(r => r.createClientPage) return _createClientPage(loader); }`); } if (route.children) { metaRoute.children = route.children; } if (route.meta) { metaRoute.meta = `{ ...(${metaImportName} || {}), ...${route.meta} }`; } if (options?.overrideMeta) { for (const key of ["name", "path"]) { if (markedDynamic.has(key)) { continue; } metaRoute[key] = route[key] ?? `${metaImportName}?.${key}`; } for (const key of ["meta", "alias", "redirect", "props"]) { if (markedDynamic.has(key)) { continue; } if (route[key] == null) { delete metaRoute[key]; continue; } metaRoute[key] = route[key]; } } else { if (route.alias != null) { metaRoute.alias = `${route.alias}.concat(${metaImportName}?.alias || [])`; } if (route.redirect != null) { metaRoute.redirect = route.redirect; } } return metaRoute; })) }; } const PATH_TO_NITRO_GLOB_RE = /\/[^:/]*:\w.*$/; function pathToNitroGlob(path) { if (!path) { return null; } if (path.indexOf(":") !== path.lastIndexOf(":")) { return null; } return path.replace(PATH_TO_NITRO_GLOB_RE, "/**"); } function resolveRoutePaths(page, parent = "/") { return [ joinURL(parent, page.path), ...page.children?.flatMap((child) => resolveRoutePaths(child, joinURL(parent, page.path))) || [] ]; } function isSerializable(code, node) { if (node.type === "ObjectExpression") { const valueString = code.slice(node.start, node.end); try { return { value: JSON.parse(runInNewContext(`JSON.stringify(${valueString})`, {})), serializable: true }; } catch { return { serializable: false }; } } if (node.type === "ArrayExpression") { const values = []; for (const element of node.elements) { if (!element) { continue; } const { serializable, value } = isSerializable(code, element); if (!serializable) { return { serializable: false }; } values.push(value); } return { value: values, serializable: true }; } if (node.type === "Literal" && (typeof node.value === "string" || typeof node.value === "boolean" || typeof node.value === "number" || node.value === null)) { return { value: node.value, serializable: true }; } if (node.type === "TSSatisfiesExpression" || node.type === "TSAsExpression" || node.type === "ParenthesizedExpression") { return isSerializable(code, node.expression); } return { serializable: false }; } function toRou3Patterns(pages, prefix = "/") { const routes = []; for (const page of pages) { const path = page.path.replace(/\([^)]*\)/g, "").replace(/:(\w+)\*.*/g, (_, name) => `**:${name}`).replace(/:([^/*]*)/g, (_, name) => `:${name.replace(/\W/g, (r) => r === "?" ? "" : "_")}`); routes.push(joinURL(prefix, path)); if (page.children) { routes.push(...toRou3Patterns(page.children, joinURL(prefix, path))); } } return routes; } function globRouteRulesFromPages(pages, paths = {}, prefix = "") { for (const page of pages) { if (page.rules) { if (Object.keys(page.rules).length) { const glob = pathToNitroGlob(prefix + page.path); if (glob) { paths[glob] = page.rules; } } delete page.rules; } if (page.children?.length) { globRouteRulesFromPages(page.children, paths, prefix + page.path + "/"); } } return paths; } function removePagesRules(routes) { for (const route of routes) { delete route.rules; if (route.children?.length) { removePagesRules(route.children); } } } const HAS_MACRO_RE = /\bdefinePageMeta\s*\(\s*/; const CODE_EMPTY = ` const __nuxt_page_meta = null export default __nuxt_page_meta `; const CODE_DEV_EMPTY = ` const __nuxt_page_meta = {} export default __nuxt_page_meta `; const CODE_HMR = ` // Vite if (import.meta.hot) { import.meta.hot.accept(mod => { Object.assign(__nuxt_page_meta, mod) }) } // webpack if (import.meta.webpackHot) { import.meta.webpackHot.accept((err) => { if (err) { window.location = window.location.href } }) }`; const PageMetaPlugin = (options = {}) => createUnplugin(() => { return { name: "nuxt:pages-macros-transform", enforce: "post", transformInclude(id) { return !!parseMacroQuery(id).macro; }, transform(code, id) { const query = parseMacroQuery(id); if (query.type && query.type !== "script") { return; } const s = new MagicString(code); function result() { if (s.hasChanged()) { return { code: s.toString(), map: options.sourcemap ? s.generateMap({ hires: true }) : void 0 }; } } const hasMacro = HAS_MACRO_RE.test(code); const imports = findStaticImports(code); const scriptImport = imports.find((i) => parseMacroQuery(i.specifier).type === "script"); if (scriptImport) { const reorderedQuery = rewriteQuery(scriptImport.specifier); const quotedSpecifier = getQuotedSpecifier(scriptImport.code)?.replace(scriptImport.specifier, reorderedQuery) ?? JSON.stringify(reorderedQuery); s.overwrite(0, code.length, `export { default } from ${quotedSpecifier}`); return result(); } const currentExports = findExports(code); for (const match of currentExports) { if (match.type !== "default" || !match.specifier) { continue; } const reorderedQuery = rewriteQuery(match.specifier); const quotedSpecifier = getQuotedSpecifier(match.code)?.replace(match.specifier, reorderedQuery) ?? JSON.stringify(reorderedQuery); s.overwrite(0, code.length, `export { default } from ${quotedSpecifier}`); return result(); } if (!hasMacro && !code.includes("export { default }") && !code.includes("__nuxt_page_meta")) { if (!code) { s.append(options.dev ? CODE_DEV_EMPTY + CODE_HMR : CODE_EMPTY); const { pathname } = parseURL(decodeURIComponent(pathToFileURL(id).href)); logger.error(`The file \`${pathname}\` is not a valid page as it has no content.`); } else { s.overwrite(0, code.length, options.dev ? CODE_DEV_EMPTY + CODE_HMR : CODE_EMPTY); } return result(); } const importMap = /* @__PURE__ */ new Map(); const addedImports = /* @__PURE__ */ new Set(); for (const i of imports) { const parsed = parseStaticImport(i); for (const name of [ parsed.defaultImport, ...Object.values(parsed.namedImports || {}), parsed.namespacedImport ].filter(Boolean)) { importMap.set(name, i); } } function isStaticIdentifier(name) { return !!(name && importMap.has(name)); } function addImport(name) { if (!isStaticIdentifier(name)) { return; } const importValue = importMap.get(name).code.trim(); if (!addedImports.has(importValue)) { addedImports.add(importValue); } } const declarationNodes = []; const addedDeclarations = /* @__PURE__ */ new Set(); function addDeclaration(node) { const codeSectionKey = `${resolveStart(node)}-${resolveEnd(node)}`; if (addedDeclarations.has(codeSectionKey)) { return; } addedDeclarations.add(codeSectionKey); declarationNodes.push(node); } function addImportOrDeclaration(name, node) { if (isStaticIdentifier(name)) { addImport(name); } else { const declaration = scopeTracker.getDeclaration(name); if (declaration && declaration !== node) { processDeclaration(declaration); } } } const scopeTracker = new ScopeTracker({ preserveExitedScopes: true }); function processDeclaration(scopeTrackerNode) { if (scopeTrackerNode?.type === "Variable") { addDeclaration(scopeTrackerNode); for (const decl of scopeTrackerNode.variableNode.declarations) { if (!decl.init) { continue; } walk(decl.init, { enter: (node, parent) => { if (node.type === "AwaitExpression") { logger.error(`Await expressions are not supported in definePageMeta. File: '${id}'`); throw new Error("await in definePageMeta"); } if (isBindingIdentifier(node, parent) || node.type !== "Identifier") { return; } addImportOrDeclaration(node.name, scopeTrackerNode); } }); } } else if (scopeTrackerNode?.type === "Function") { if (scopeTrackerNode.node.type === "ArrowFunctionExpression") { return; } const name = scopeTrackerNode.node.id?.name; if (!name) { return; } addDeclaration(scopeTrackerNode); const undeclaredIdentifiers = getUndeclaredIdentifiersInFunction(scopeTrackerNode.node); for (const name2 of undeclaredIdentifiers) { addImportOrDeclaration(name2); } } } const { program: ast } = parseAndWalk(code, id, { scopeTracker, parseOptions: { lang: query.lang ?? "ts" } }); scopeTracker.freeze(); let instances = 0; walk(ast, { scopeTracker, enter: (node) => { if (node.type !== "CallExpression" || node.callee.type !== "Identifier") { return; } if (!("name" in node.callee) || node.callee.name !== "definePageMeta") { return; } instances++; const meta = node.arguments[0]; if (!meta) { return; } const metaCode = code.slice(meta.start, meta.end); const m = new MagicString(metaCode); if (meta.type === "ObjectExpression") { for (let i = 0; i < meta.properties.length; i++) { const prop = meta.properties[i]; if (prop.type === "Property" && prop.key.type === "Identifier" && options.extractedKeys?.includes(prop.key.name)) { const { serializable } = isSerializable(metaCode, prop.value); if (!serializable) { continue; } const nextProperty = meta.properties[i + 1]; if (nextProperty) { m.overwrite(prop.start - meta.start, nextProperty.start - meta.start, ""); } else if (code[prop.end] === ",") { m.overwrite(prop.start - meta.start, prop.end - meta.start + 1, ""); } else { m.overwrite(prop.start - meta.start, prop.end - meta.start, ""); } } } } const definePageMetaScope = scopeTracker.getCurrentScope(); walk(meta, { scopeTracker, enter(node2, parent) { if (isBindingIdentifier(node2, parent) || node2.type !== "Identifier") { return; } const declaration = scopeTracker.getDeclaration(node2.name); if (declaration) { if (declaration.isUnderScope(definePageMetaScope) && (scopeTracker.isCurrentScopeUnder(declaration.scope) || resolveStart(declaration) < node2.start)) { return; } } if (isStaticIdentifier(node2.name)) { addImport(node2.name); } else if (declaration) { processDeclaration(declaration); } } }); const importStatements = Array.from(addedImports).join("\n"); const declarations = declarationNodes.sort((a, b) => resolveStart(a) - resolveStart(b)).map((node2) => code.slice(resolveStart(node2), resolveEnd(node2))).join("\n"); const extracted = [ importStatements, declarations, `const __nuxt_page_meta = ${m.toString() || "null"} export default __nuxt_page_meta` + (options.dev ? CODE_HMR : "") ].join("\n"); s.overwrite(0, code.length, extracted.trim()); } }); if (instances > 1) { throw new Error("Multiple `definePageMeta` calls are not supported. File: " + id.replace(/\?.+$/, "")); } if (!s.hasChanged() && !code.includes("__nuxt_page_meta")) { s.overwrite(0, code.length, options.dev ? CODE_DEV_EMPTY + CODE_HMR : CODE_EMPTY); } return result(); }, vite: { handleHotUpdate: { order: "post", handler: ({ file, modules, server }) => { if (options.routesPath && options.isPage?.(file)) { const macroModule = server.moduleGraph.getModuleById(file + "?macro=true"); const routesModule = server.moduleGraph.getModuleById("virtual:nuxt:" + encodeURIComponent(options.routesPath)); return [ ...modules, ...macroModule ? [macroModule] : [], ...routesModule ? [routesModule] : [] ]; } } } } }; }); const QUERY_START_RE = /^\?/; const MACRO_RE = /¯o=true/; function rewriteQuery(id) { return id.replace(/\?.+$/, (r) => "?macro=true&" + r.replace(QUERY_START_RE, "").replace(MACRO_RE, "")); } function parseMacroQuery(id) { const { search } = parseURL(decodeURIComponent(isAbsolute(id) ? pathToFileURL(id).href : id).replace(/\?macro=true$/, "")); const query = parseQuery(search); if (id.includes("?macro=true")) { return { macro: "true", ...query }; } return query; } const QUOTED_SPECIFIER_RE = /(["']).*\1/; function getQuotedSpecifier(id) { return id.match(QUOTED_SPECIFIER_RE)?.[0]; } function resolveStart(node) { return "fnNode" in node ? node.fnNode.start : node.start; } function resolveEnd(node) { return "fnNode" in node ? node.fnNode.end : node.end; } const INJECTION_RE_TEMPLATE = /\b_ctx\.\$route\b/g; const INJECTION_RE_SCRIPT = /\bthis\.\$route\b/g; const INJECTION_SINGLE_RE = /\bthis\.\$route\b|\b_ctx\.\$route\b/; const RouteInjectionPlugin = (nuxt) => createUnplugin(() => { return { name: "nuxt:route-injection-plugin", enforce: "post", transformInclude(id) { return isVue(id, { type: ["template", "script"] }); }, transform: { filter: { code: { include: INJECTION_SINGLE_RE } }, handler(code) { if (code.includes("_ctx._.provides[__nuxt_route_symbol") || code.includes("this._.provides[__nuxt_route_symbol")) { return; } let replaced = false; const s = new MagicString(code); const strippedCode = stripLiteral(code); const replaceMatches = (regExp, replacement) => { for (const match of strippedCode.matchAll(regExp)) { const start = match.index; const end = start + match[0].length; s.overwrite(start, end, replacement); replaced ||= true; } }; replaceMatches(INJECTION_RE_TEMPLATE, "(_ctx._.provides[__nuxt_route_symbol] || _ctx.$route)"); replaceMatches(INJECTION_RE_SCRIPT, "(this._.provides[__nuxt_route_symbol] || this.$route)"); if (replaced) { s.prepend("import { PageRouteSymbol as __nuxt_route_symbol } from '#app/components/injections';\n"); } if (s.hasChanged()) { return { code: s.toString(), map: nuxt.options.sourcemap.client || nuxt.options.sourcemap.server ? s.generateMap({ hires: true }) : void 0 }; } } } }; }); const OPTIONAL_PARAM_RE = /^\/?:.*(?:\?|\(\.\*\)\*)$/; const runtimeDir = resolve(distDir, "pages/runtime"); async function resolveRouterOptions(nuxt, builtInRouterOptions) { const context = { files: [] }; for (const layer of nuxt.options._layers) { const path = await findPath(resolve(layer.config.srcDir, layer.config.dir?.app || "app", "router.options")); if (path) { context.files.unshift({ path }); } } context.files.unshift({ path: builtInRouterOptions, optional: true }); await nuxt.callHook("pages:routerOptions", context); return context.files; } const pagesModule = defineNuxtModule({ meta: { name: "nuxt:pages", configKey: "pages" }, defaults: (nuxt) => ({ enabled: typeof nuxt.options.pages === "boolean" ? nuxt.options.pages : void 0, pattern: `**/*{${nuxt.options.extensions.join(",")}}` }), async setup(_options, nuxt) { const options = typeof _options === "boolean" ? { enabled: _options ?? nuxt.options.pages, pattern: `**/*{${nuxt.options.extensions.join(",")}}` } : { ..._options }; options.pattern = Array.isArray(options.pattern) ? [...new Set(options.pattern)] : options.pattern; let inlineRulesCache = {}; let updateRouteConfig; if (nuxt.options.experimental.inlineRouteRules) { nuxt.hook("nitro:init", (nitro) => { updateRouteConfig = async (inlineRules) => { if (!isEqual(inlineRulesCache, inlineRules)) { await nitro.updateConfig({ routeRules: defu(inlineRules, nitro.options._config.routeRules) }); inlineRulesCache = inlineRules; } }; }); } const resolvePagesRoutes$1 = async (pattern, nuxt2) => { const pages = await resolvePagesRoutes(pattern, nuxt2); if (nuxt2.options.experimental.inlineRouteRules) { const routeRules = globRouteRulesFromPages(pages); await updateRouteConfig?.(routeRules); } else { removePagesRules(pages); } return pages; }; const useExperimentalTypedPages = nuxt.options.experimental.typedPages; const builtInRouterOptions = await findPath(resolve(runtimeDir, "router.options")) || resolve(runtimeDir, "router.options"); const pagesDirs = getLayerDirectories(nuxt).map((dirs) => dirs.appPages); nuxt.options.alias["#vue-router"] = "vue-router"; const routerPath = await resolveTypePath("vue-router", "", nuxt.options.modulesDir) || "vue-router"; nuxt.hook("prepare:types", ({ tsConfig }) => { tsConfig.compilerOptions ||= {}; tsConfig.compilerOptions.paths ||= {}; tsConfig.compilerOptions.paths["#vue-router"] = [routerPath]; delete tsConfig.compilerOptions.paths["#vue-router/*"]; }); const isNonEmptyDir = (dir) => existsSync(dir) && readdirSync(dir).length; const userPreference = options.enabled; const isPagesEnabled = async () => { if (typeof userPreference === "boolean") { return userPreference; } const routerOptionsFiles = await resolveRouterOptions(nuxt, builtInRouterOptions); if (routerOptionsFiles.filter((p) => !p.optional).length > 0) { return true; } if (pagesDirs.some((dir) => isNonEmptyDir(dir))) { return true; } const pages = await resolvePagesRoutes$1(options.pattern, nuxt); if (pages.length) { if (nuxt.apps.default) { nuxt.apps.default.pages = pages; } return true; } return false; }; options.enabled = await isPagesEnabled(); nuxt.options.pages = options; Object.defineProperty(nuxt.options.pages, "toString", { enumerable: false, get: () => () => options.enabled }); if (nuxt.options.dev && options.enabled) { addPlugin(resolve(runtimeDir, "plugins/check-if-page-unused")); } nuxt.hook("app:templates", (app) => { if (!nuxt.options.ssr && app.pages?.some((p) => p.mode === "server")) { logger.warn("Using server pages with `ssr: false` is not supported with auto-detected component islands. Set `experimental.componentIslands` to `true`."); } }); const restartPaths = nuxt.options._layers.flatMap((layer) => { const pagesDir = (layer.config.rootDir === nuxt.options.rootDir ? nuxt.options.dir : layer.config.dir)?.pages || "pages"; return [ resolve(layer.config.srcDir || layer.cwd, layer.config.dir?.app || "app", "router.options.ts"), resolve(layer.config.srcDir || layer.cwd, pagesDir) ]; }); nuxt.hooks.hook("builder:watch", async (event, relativePath) => { const path = resolve(nuxt.options.srcDir, relativePath); if (restartPaths.some((p) => p === path || path.startsWith(p + "/"))) { const newSetting = await isPagesEnabled(); if (options.enabled !== newSetting) { logger.info("Pages", newSetting ? "enabled" : "disabled"); return nuxt.callHook("restart"); } } }); if (!options.enabled) { addPlugin(resolve(distDir, "app/plugins/router")); addTemplate({ filename: "pages.mjs", getContents: () => [ "export { useRoute } from '#app/composables/router'", "export const START_LOCATION = Symbol('router:start-location')" ].join("\n") }); addTemplate({ filename: "router.options.mjs", getContents: () => { return [ "export const hashMode = false", "export default {}" ].join("\n"); } }); addTypeTemplate({ filename: "types/middleware.d.ts", getContents: () => [ "declare module 'nitropack' {", " interface NitroRouteConfig {", " appMiddleware?: string | string[] | Record", " }", "}", "export {}" ].join("\n") }, { nuxt: true, nitro: true }); addComponent({ name: "NuxtPage", priority: 10, // built-in that we do not expect the user to override filePath: resolve(distDir, "pages/runtime/page-placeholder") }); nuxt.hook("nitro:init", (nitro) => { if (nuxt.options.dev || !nuxt.options.ssr || !nitro.options.static || !nitro.options.prerender.crawlLinks) { return; } nitro.options.prerender.routes.push("/"); }); return; } if (useExperimentalTypedPages) { const declarationFile = "./types/typed-router.d.ts"; const typedRouterOptions = { routesFolder: [], dts: resolve(nuxt.options.buildDir, declarationFile), logs: nuxt.options.debug && nuxt.options.debug.router, async beforeWriteFiles(rootPage) { rootPage.children.forEach((child) => child.delete()); const pages = nuxt.apps.default?.pages || await resolvePagesRoutes$1(options.pattern, nuxt); if (nuxt.apps.default) { nuxt.apps.default.pages = pages; } const addedPagePaths = /* @__PURE__ */ new Set(); function addPage(parent, page, basePath = "") { const absolutePagePath = joinURL(basePath, page.path); const route = addedPagePaths.has(absolutePagePath) ? parent : page.path[0] === "/" ? rootPage.insert(page.path, page.file) : parent.insert(page.path, page.file); addedPagePaths.add(absolutePagePath); if (page.meta) { route.addToMeta(page.meta); } if (page.alias) { route.addAlias(page.alias); } if (page.name) { route.name = page.name; } if (page.children) { page.children.forEach((child) => addPage(route, child, absolutePagePath)); } } for (const page of pages) { addPage(rootPage, page); } } }; nuxt.hook("prepare:types", ({ references }) => { references.push({ path: declarationFile }); references.push({ types: "unplugin-vue-router/client" }); }); const context = createRoutesContext(resolveOptions(typedRouterOptions)); const dtsFile = resolve(nuxt.options.buildDir, declarationFile); await mkdir(dirname(dtsFile), { recursive: true }); await context.scanPages(false); if (nuxt.options._prepare || !nuxt.options.dev) { const dts = await readFile(dtsFile, "utf-8"); addTemplate({ filename: "types/typed-router.d.ts", getContents: () => dts }); } nuxt.hook("app:templatesGenerated", async (_app, _templates, options2) => { if (!options2?.filter || options2.filter({ filename: "routes.mjs" })) { await context.scanPages(); } }); } nuxt.hook("prepare:types", ({ references }) => { references.push({ types: useExperimentalTypedPages ? "vue-router/auto-routes" : "vue-router" }); }); nuxt.hook("imports:sources", (sources) => { const routerImports = sources.find((s) => s.from === "#app/composables/router" && s.imports.includes("onBeforeRouteLeave")); if (routerImports) { routerImports.from = "vue-router"; } }); const updateTemplatePaths = getLayerDirectories(nuxt).flatMap((dirs) => [ dirs.appPages, dirs.appLayouts, dirs.appMiddleware ]); function isPage(file, pages = nuxt.apps.default?.pages) { if (!pages) { return false; } return pages.some((page) => page.file === file) || pages.some((page) => page.children && isPage(file, page.children)); } nuxt.hooks.hookOnce("app:templates", async (app) => { app.pages ||= await resolvePagesRoutes$1(options.pattern, nuxt); }); nuxt.hook("builder:watch", async (event, relativePath) => { const path = resolve(nuxt.options.srcDir, relativePath); const shouldAlwaysRegenerate = nuxt.options.experimental.scanPageMeta && isPage(path); if (event === "change" && !shouldAlwaysRegenerate) { return; } if (shouldAlwaysRegenerate || updateTemplatePaths.some((dir) => path.startsWith(dir))) { nuxt.apps.default.pages = await resolvePagesRoutes$1(options.pattern, nuxt); } }); nuxt.hook("app:resolve", (app) => { if (app.mainComponent === resolve(nuxt.options.appDir, "components/welcome.vue")) { app.mainComponent = resolve(runtimeDir, "app.vue"); } app.middleware.unshift({ name: "validate", path: resolve(runtimeDir, "validate"), global: true }); }); nuxt.hook("app:resolve", (app) => { const nitro = useNitro(); if (nitro.options.prerender.crawlLinks || Object.values(nitro.options.routeRules).some((rule) => rule.prerender)) { app.plugins.push({ src: resolve(runtimeDir, "plugins/prerender.server"), mode: "server" }); } }); const prerenderRoutes = /* @__PURE__ */ new Set(); function processPages(pages, currentPath = "/") { for (const page of pages) { if (OPTIONAL_PARAM_RE.test(page.path) && !page.children?.length) { prerenderRoutes.add(currentPath); } if (page.path.includes(":")) { continue; } const route = joinURL(currentPath, page.path); prerenderRoutes.add(route); if (page.children) { processPages(page.children, route); } } } nuxt.hook("pages:extend", (pages) => { if (nuxt.options.dev) { return; } prerenderRoutes.clear(); processPages(pages); }); nuxt.hook("nitro:build:before", (nitro) => { if (nuxt.options.dev || nuxt.options.router.options.hashMode) { return; } nitro.options.ssrRoutes = [ ...nitro.options.ssrRoutes || [], ...toRou3Patterns(nuxt.apps.default?.pages || []) ]; if (!nitro.options.static && !nitro.options.prerender.crawlLinks) { const routeRulesMatcher = toRouteMatcher(createRouter({ routes: nitro.options.routeRules })); for (const route of prerenderRoutes) { const rules = defu({}, ...routeRulesMatcher.matchAll(route).reverse()); if (rules.prerender) { nitro.options.prerender.routes.push(route); } } } if (!nitro.options.static || !nitro.options.prerender.crawlLinks) { return; } if (nuxt.options.ssr) { const [firstPage] = [...prerenderRoutes].sort(); nitro.options.prerender.routes.push(firstPage || "/"); return; } for (const route of nitro.options.prerender.routes || []) { prerenderRoutes.add(route); } nitro.options.prerender.routes = Array.from(prerenderRoutes); }); nuxt.hook("imports:extend", (imports) => { imports.push( { name: "definePageMeta", as: "definePageMeta", from: resolve(runtimeDir, "composables") }, { name: "useLink", as: "useLink", from: "vue-router" } ); if (nuxt.options.experimental.inlineRouteRules) { imports.push({ name: "defineRouteRules", as: "defineRouteRules", from: resolve(runtimeDir, "composables") }); } }); const componentStubPath = await resolvePath(resolve(runtimeDir, "component-stub")); if (nuxt.options.test && nuxt.options.dev) { nuxt.hook("pages:extend", (routes) => { routes.push({ _sync: true, path: "/__nuxt_component_test__/:pathMatch(.*)", file: componentStubPath }); }); } if (nuxt.options.experimental.appManifest) { nuxt.hook("pages:extend", (routes) => { const nitro = useNitro(); let resolvedRoutes; for (const [path, rule] of Object.entries(nitro.options.routeRules)) { if (!rule.redirect) { continue; } resolvedRoutes ||= routes.flatMap((route) => resolveRoutePaths(route)); if (resolvedRoutes.includes(path)) { continue; } routes.push({ _sync: true, path: path.replace(/\/[^/]*\*\*/, "/:pathMatch(.*)"), file: componentStubPath }); } }); } const extraPageMetaExtractionKeys = nuxt.options?.experimental?.extraPageMetaExtractionKeys || []; const extractedKeys = nuxt.options.future.compatibilityVersion === 4 ? [...defaultExtractionKeys, "middleware", ...extraPageMetaExtractionKeys] : ["middleware", ...extraPageMetaExtractionKeys]; nuxt.hook("modules:done", () => { addBuildPlugin(PageMetaPlugin({ dev: nuxt.options.dev, sourcemap: !!nuxt.options.sourcemap.server || !!nuxt.options.sourcemap.client, isPage, routesPath: resolve(nuxt.options.buildDir, "routes.mjs"), extractedKeys: nuxt.options.experimental.scanPageMeta ? extractedKeys : [] })); }); addPlugin(resolve(runtimeDir, "plugins/prefetch.client")); if (nuxt.options.experimental.templateRouteInjection) { addBuildPlugin(RouteInjectionPlugin(nuxt), { server: false }); } addPlugin(resolve(runtimeDir, "plugins/router")); const getSources = (pages) => pages.filter((p) => Boolean(p.file)).flatMap( (p) => [relative(nuxt.options.srcDir, p.file), ...p.children?.length ? getSources(p.children) : []] ); nuxt.hook("build:manifest", (manifest) => { if (nuxt.options.dev) { return; } const sourceFiles = nuxt.apps.default?.pages?.length ? getSources(nuxt.apps.default.pages) : []; for (const [key, chunk] of Object.entries(manifest)) { if (chunk.src && Object.values(nuxt.apps).some((app) => app.pages?.some((page) => page.mode === "server" && page.file === join(nuxt.options.srcDir, chunk.src)))) { delete manifest[key]; continue; } if (chunk.isEntry) { chunk.dynamicImports = chunk.dynamicImports?.filter((i) => !sourceFiles.includes(i)); } } }); const serverComponentRuntime = await findPath(join(distDir, "components/runtime/server-component")) ?? join(distDir, "components/runtime/server-component"); const clientComponentRuntime = await findPath(join(distDir, "components/runtime/client-component")) ?? join(distDir, "components/runtime/client-component"); addTemplate({ filename: "routes.mjs", getContents({ app }) { if (!app.pages) { return ROUTES_HMR_CODE + "export default []"; } const { routes, imports } = normalizeRoutes(app.pages, /* @__PURE__ */ new Set(), { serverComponentRuntime, clientComponentRuntime, overrideMeta: !!nuxt.options.experimental.scanPageMeta }); return ROUTES_HMR_CODE + [...imports, `export default ${routes}`].join("\n"); } }); addTemplate({ filename: "pages.mjs", getContents: () => "export { START_LOCATION, useRoute } from 'vue-router'" }); nuxt.options.vite.resolve ||= {}; nuxt.options.vite.resolve.dedupe ||= []; nuxt.options.vite.resolve.dedupe.push("vue-router"); addTemplate({ filename: "router.options.mjs", getContents: async ({ nuxt: nuxt2 }) => { const routerOptionsFiles = await resolveRouterOptions(nuxt2, builtInRouterOptions); const configRouterOptions = genObjectFromRawEntries(Object.entries(nuxt2.options.router.options).map(([key, value]) => [key, genString(value)])); return [ ...routerOptionsFiles.map((file, index) => genImport(file.path, `routerOptions${index}`)), `const configRouterOptions = ${configRouterOptions}`, `export const hashMode = ${[...routerOptionsFiles.filter((o) => o.path !== builtInRouterOptions).map((_, index) => `routerOptions${index}.hashMode`).reverse(), nuxt2.options.router.options.hashMode].join(" ?? ")}`, "export default {", "...configRouterOptions,", ...routerOptionsFiles.map((_, index) => `...routerOptions${index},`), "}" ].join("\n"); } }); addTypeTemplate({ filename: "types/middleware.d.ts", getContents: ({ app }) => { const namedMiddleware = app.middleware.filter((mw) => !mw.global); return [ "import type { NavigationGuard } from 'vue-router'", `export type MiddlewareKey = ${namedMiddleware.map((mw) => genString(mw.name)).join(" | ") || "never"}`, "declare module 'nuxt/app' {", " interface PageMeta {", " middleware?: MiddlewareKey | NavigationGuard | Array", " }", "}" ].join("\n"); } }); addTypeTemplate({ filename: "types/nitro-middleware.d.ts", getContents: ({ app }) => { const namedMiddleware = app.middleware.filter((mw) => !mw.global); return [ `export type MiddlewareKey = ${namedMiddleware.map((mw) => genString(mw.name)).join(" | ") || "never"}`, "declare module 'nitropack' {", " interface NitroRouteConfig {", " appMiddleware?: MiddlewareKey | MiddlewareKey[] | Record", " }", "}" ].join("\n"); } }, { nuxt: true, nitro: true }); addTypeTemplate({ filename: "types/layouts.d.ts", getContents: ({ app }) => { return [ "import type { ComputedRef, MaybeRef } from 'vue'", `export type LayoutKey = ${Object.keys(app.layouts).map((name) => genString(name)).join(" | ") || "string"}`, "declare module 'nuxt/app' {", " interface PageMeta {", " layout?: MaybeRef | ComputedRef", " }", "}" ].join("\n"); } }); if (nuxt.options.experimental.viewTransition) { addTypeTemplate({ filename: "types/view-transitions.d.ts", getContents: () => { return [ "declare module 'nuxt/app' {", " interface PageMeta {", " viewTransition?: boolean | 'always'", " }", "}", "export {}" ].join("\n"); } }); } addComponent({ name: "NuxtPage", priority: 10, // built-in that we do not expect the user to override filePath: resolve(distDir, "pages/runtime/page") }); } }); const ROUTES_HMR_CODE = ( /* js */ ` if (import.meta.hot) { import.meta.hot.accept((mod) => { const router = import.meta.hot.data.router const generateRoutes = import.meta.hot.data.generateRoutes if (!router || !generateRoutes) { import.meta.hot.invalidate('[nuxt] Cannot replace routes because there is no active router. Reloading.') return } router.clearRoutes() const routes = generateRoutes(mod.default || mod) function addRoutes (routes) { for (const route of routes) { router.addRoute(route) } router.replace(router.currentRoute.value.fullPath) } if (routes && 'then' in routes) { routes.then(addRoutes) } else { addRoutes(routes) } }) } export function handleHotUpdate(_router, _generateRoutes) { if (import.meta.hot) { import.meta.hot.data ||= {} import.meta.hot.data.router = _router import.meta.hot.data.generateRoutes = _generateRoutes } } ` ); const UNHEAD_LIB_RE = /node_modules[/\\](?:@unhead[/\\][^/\\]+|unhead)[/\\]/; function toImports(specifiers) { return specifiers.map((specifier) => { const imported = specifier.imported; const isNamedImport = imported && imported.name !== specifier.local.name; return isNamedImport ? `${imported.name} as ${specifier.local.name}` : specifier.local.name; }); } const UnheadVue = "@unhead/vue"; const UnheadVueRE = /@unhead\/vue/; const UnheadImportsPlugin = (options) => createUnplugin(() => { return { name: "nuxt:head:unhead-imports", enforce: "post", transformInclude(id) { id = normalize(id); return (isJS(id) || isVue(id, { type: ["script"] })) && !id.startsWith("virtual:") && !id.startsWith(normalize(distDir)) && !UNHEAD_LIB_RE.test(id); }, transform: { filter: { code: { include: UnheadVueRE } }, handler(code, id) { const s = new MagicString(code); const importsToAdd = []; parseAndWalk(code, id, function(node) { if (node.type === "ImportDeclaration" && [UnheadVue, "#app/composables/head"].includes(String(node.source.value))) { importsToAdd.push(...node.specifiers); const { start, end } = node; s.remove(start, end); } }); const importsFromUnhead = importsToAdd.filter((specifier) => unheadVueComposablesImports[UnheadVue].includes(specifier.imported?.name)); const importsFromHead = importsToAdd.filter((specifier) => !unheadVueComposablesImports[UnheadVue].includes(specifier.imported?.name)); if (importsFromUnhead.length) { if (!normalize(id).includes("node_modules")) { logger.warn(`You are importing from \`${UnheadVue}\` in \`./${relative(normalize(options.rootDir), normalize(id))}\`. Please import from \`#imports\` instead for full type safety.`); } s.prepend(`${genImport("#app/composables/head", toImports(importsFromUnhead))} `); } if (importsFromHead.length) { s.prepend(`${genImport(UnheadVue, toImports(importsFromHead))} `); } if (s.hasChanged()) { return { code: s.toString(), map: options.sourcemap ? s.generateMap({ hires: true }) : void 0 }; } } } }; }); const components = ["NoScript", "Link", "Base", "Title", "Meta", "Style", "Head", "Html", "Body"]; const metaModule = defineNuxtModule({ meta: { name: "nuxt:meta", configKey: "unhead" }, setup(options, nuxt) { const runtimeDir = resolve(distDir, "head/runtime"); nuxt.options.build.transpile.push("@unhead/vue"); const isNuxtV4 = nuxt.options._majorVersion === 4 || nuxt.options.future?.compatibilityVersion === 4; const componentsPath = resolve(runtimeDir, "components"); for (const componentName of components) { addComponent({ name: componentName, filePath: componentsPath, export: componentName, // built-in that we do not expect the user to override priority: 10, // kebab case version of these tags is not valid kebabName: componentName }); } if (!nuxt.options.dev) { nuxt.options.optimization.treeShake.composables.client["@unhead/vue"] = [ "useServerHead", "useServerSeoMeta", "useServerHeadSafe" ]; } nuxt.options.alias["#unhead/composables"] = resolve(runtimeDir, "composables", isNuxtV4 ? "v4" : "v3"); addBuildPlugin(UnheadImportsPlugin({ sourcemap: !!nuxt.options.sourcemap.server, rootDir: nuxt.options.rootDir })); const importPaths = nuxt.options.modulesDir.map((d) => directoryToURL(d)); const unheadPlugins = resolveModulePath("@unhead/vue/plugins", { try: true, from: importPaths }) || "@unhead/vue/plugins"; if (nuxt.options.experimental.polyfillVueUseHead) { nuxt.options.alias["@vueuse/head"] = resolveModulePath("@unhead/vue", { try: true, from: importPaths }) || "@unhead/vue"; addPlugin({ src: resolve(runtimeDir, "plugins/vueuse-head-polyfill") }); } addTemplate({ filename: "unhead-options.mjs", getContents() { if (isNuxtV4 && !options.legacy) { return ` export default { disableDefaults: true, }`; } const disableCapoSorting = !nuxt.options.experimental.headNext; return `import { DeprecationsPlugin, PromisesPlugin, TemplateParamsPlugin, AliasSortingPlugin } from ${JSON.stringify(unheadPlugins)}; export default { disableDefaults: true, disableCapoSorting: ${Boolean(disableCapoSorting)}, plugins: [DeprecationsPlugin, PromisesPlugin, TemplateParamsPlugin, AliasSortingPlugin], }`; } }); addTemplate({ filename: "unhead.config.mjs", getContents() { return [ `export const renderSSRHeadOptions = ${JSON.stringify(options.renderSSRHeadOptions || {})}` ].join("\n"); } }); nuxt.hooks.hook("nitro:config", (config) => { config.virtual["#internal/unhead-options.mjs"] = () => nuxt.vfs["#build/unhead-options.mjs"]; config.virtual["#internal/unhead.config.mjs"] = () => nuxt.vfs["#build/unhead.config.mjs"]; }); addPlugin({ src: resolve(runtimeDir, "plugins/unhead") }); } }); const commonPresets = [ // vue-demi (mocked) defineUnimportPreset({ from: "vue-demi", imports: [ "isVue2", "isVue3" ] }) ]; const granularAppPresets = [ { from: "#app/components/nuxt-link", imports: ["defineNuxtLink"] }, { imports: ["useNuxtApp", "tryUseNuxtApp", "defineNuxtPlugin", "definePayloadPlugin", "useRuntimeConfig", "defineAppConfig"], from: "#app/nuxt" }, { imports: ["useAppConfig", "updateAppConfig"], from: "#app/config" }, { imports: ["defineNuxtComponent"], from: "#app/composables/component" }, { imports: ["useAsyncData", "useLazyAsyncData", "useNuxtData", "refreshNuxtData", "clearNuxtData"], from: "#app/composables/asyncData" }, { imports: ["useHydration"], from: "#app/composables/hydrate" }, { imports: ["callOnce"], from: "#app/composables/once" }, { imports: ["useState", "clearNuxtState"], from: "#app/composables/state" }, { imports: ["clearError", "createError", "isNuxtError", "showError", "useError"], from: "#app/composables/error" }, { imports: ["useFetch", "useLazyFetch"], from: "#app/composables/fetch" }, { imports: ["useCookie", "refreshCookie"], from: "#app/composables/cookie" }, { imports: ["onPrehydrate", "prerenderRoutes", "useRequestHeader", "useRequestHeaders", "useResponseHeader", "useRequestEvent", "useRequestFetch", "setResponseStatus"], from: "#app/composables/ssr" }, { imports: ["onNuxtReady"], from: "#app/composables/ready" }, { imports: ["preloadComponents", "prefetchComponents", "preloadRouteComponents"], from: "#app/composables/preload" }, { imports: ["abortNavigation", "addRouteMiddleware", "defineNuxtRouteMiddleware", "setPageLayout", "navigateTo", "useRoute", "useRouter"], from: "#app/composables/router" }, { imports: ["isPrerendered", "loadPayload", "preloadPayload", "definePayloadReducer", "definePayloadReviver"], from: "#app/composables/payload" }, { imports: ["useLoadingIndicator"], from: "#app/composables/loading-indicator" }, { imports: ["getAppManifest", "getRouteRules"], from: "#app/composables/manifest" }, { imports: ["reloadNuxtApp"], from: "#app/composables/chunk" }, { imports: ["useRequestURL"], from: "#app/composables/url" }, { imports: ["usePreviewMode"], from: "#app/composables/preview" }, { imports: ["useRouteAnnouncer"], from: "#app/composables/route-announcer" }, { imports: ["useRuntimeHook"], from: "#app/composables/runtime-hook" }, { imports: ["useHead", "useHeadSafe", "useServerHeadSafe", "useServerHead", "useSeoMeta", "useServerSeoMeta", "injectHead"], from: "#app/composables/head" } ]; const scriptsStubsPreset = { imports: [ "useScriptTriggerConsent", "useScriptEventPage", "useScriptTriggerElement", "useScript", "useScriptGoogleAnalytics", "useScriptPlausibleAnalytics", "useScriptCrisp", "useScriptClarity", "useScriptCloudflareWebAnalytics", "useScriptFathomAnalytics", "useScriptMatomoAnalytics", "useScriptGoogleTagManager", "useScriptGoogleAdsense", "useScriptSegment", "useScriptMetaPixel", "useScriptXPixel", "useScriptIntercom", "useScriptHotjar", "useScriptStripe", "useScriptLemonSqueezy", "useScriptVimeoPlayer", "useScriptYouTubePlayer", "useScriptGoogleMaps", "useScriptNpm", "useScriptUmamiAnalytics", "useScriptSnapchatPixel", "useScriptRybbitAnalytics" ], priority: -1, from: "#app/composables/script-stubs" }; const routerPreset = defineUnimportPreset({ imports: ["onBeforeRouteLeave", "onBeforeRouteUpdate"], from: "#app/composables/router" }); const vuePreset = defineUnimportPreset({ from: "vue", imports: [ //