@nuxt/kit 3.2.2 → 3.3.0

package/README.md

@@ -11,6 +11,7 @@ Nuxt's goal is to make web development intuitive and performant, with a great de
   <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/v/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Version"></a>
   <a href="https://www.npmjs.com/package/nuxt"><img src="https://img.shields.io/npm/dm/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="Downloads"></a>
   <a href="./LICENSE"><img src="https://img.shields.io/github/license/nuxt/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D" alt="License"></a>
+  <a href="https://nuxt.com"><img src="https://img.shields.io/badge/Open%20Documentation-18181B?logo=nuxt.js" alt="Website"></a>
   <a href="https://volta.net/nuxt/nuxt?utm_source=nuxt_readme"><img src="https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg" alt="Volta board"></a>
  </p>
 

package/dist/index.d.ts

@@ -126,7 +126,7 @@ type AddComponentOptions = {
     filePath: string;
 } & Partial<Exclude<Component, 'shortPath' | 'async' | 'level' | 'import' | 'asyncImport'>>;
 /**
- * Register a directory to be scanned for components and imported only when used.
+ * Register a component by its name and filePath.
  *
  * Requires Nuxt 2.13+
  */
@@ -317,20 +317,8 @@ interface RequireModuleOptions extends ResolveModuleOptions {
     interopDefault?: boolean;
 }
 /** @deprecated Do not use CJS utils */
-declare function isNodeModules(id: string): boolean;
-/** @deprecated Do not use CJS utils */
-declare function clearRequireCache(id: string): void;
-/** @deprecated Do not use CJS utils */
-declare function scanRequireTree(id: string, files?: Set<string>): Set<string>;
-/** @deprecated Do not use CJS utils */
-declare function getRequireCacheItem(id: string): NodeModule | undefined;
-/** Resolve the `package.json` file for a given module. */
-declare function requireModulePkg(id: string, opts?: RequireModuleOptions): any;
-/** @deprecated Do not use CJS utils */
 declare function resolveModule(id: string, opts?: ResolveModuleOptions): string;
 /** @deprecated Do not use CJS utils */
-declare function tryResolveModule(path: string, opts?: ResolveModuleOptions): string | null;
-/** @deprecated Do not use CJS utils */
 declare function requireModule(id: string, opts?: RequireModuleOptions): any;
 /** @deprecated Do not use CJS utils */
 declare function importModule(id: string, opts?: RequireModuleOptions): Promise<any>;
@@ -339,6 +327,14 @@ declare function tryImportModule(id: string, opts?: RequireModuleOptions): Promi
 /** @deprecated Do not use CJS utils */
 declare function tryRequireModule(id: string, opts?: RequireModuleOptions): any;
 
+/**
+ * Resolve a module from a given root path using an algorithm patterned on
+ * the upcoming `import.meta.resolve`. It returns a file URL
+ *
+ * @internal
+ */
+declare function tryResolveModule(id: string, url?: string | string[]): Promise<any>;
+
 /** @deprecated */
 declare function compileTemplate(template: NuxtTemplate, ctx: any): Promise<string>;
 /** @deprecated */
@@ -350,4 +346,4 @@ declare const templateUtils: {
     }) => string;
 };
 
-export { AddComponentOptions, AddPluginOptions, AddRouteMiddlewareOptions, ExtendConfigOptions, ExtendRouteRulesOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addRouteMiddleware, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendNuxtSchema, extendPages, extendRouteRules, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, getRequireCacheItem, hasNuxtCompatibility, importModule, installModule, isIgnored, isNodeModules, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, updateTemplates, useLogger, useNitro, useNuxt };
+export { AddComponentOptions, AddPluginOptions, AddRouteMiddlewareOptions, ExtendConfigOptions, ExtendRouteRulesOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addRouteMiddleware, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, compileTemplate, createResolver, defineNuxtModule, extendNuxtSchema, extendPages, extendRouteRules, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, hasNuxtCompatibility, importModule, installModule, isIgnored, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, resolveAlias, resolveFiles, resolveModule, resolvePath, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, updateTemplates, useLogger, useNitro, useNuxt };

package/dist/index.mjs

@@ -1,14 +1,15 @@
 import { promises, existsSync, readFileSync } from 'node:fs';
+import { performance } from 'node:perf_hooks';
 import { defu } from 'defu';
 import { applyDefaults } from 'untyped';
-import { dirname, join, normalize, relative, isAbsolute, resolve, basename, parse } from 'pathe';
+import { dirname, normalize, join, relative, isAbsolute, resolve, basename, parse } from 'pathe';
 import consola from 'consola';
 import { getContext } from 'unctx';
 import satisfies from 'semver/functions/satisfies.js';
 import lodashTemplate from 'lodash.template';
 import { genSafeVariableName, genDynamicImport, genImport } from 'knitwork';
 import { pathToFileURL, fileURLToPath } from 'node:url';
-import { interopDefault } from 'mlly';
+import { interopDefault, resolvePath as resolvePath$1 } from 'mlly';
 import jiti from 'jiti';
 import { globby } from 'globby';
 import { resolveAlias as resolveAlias$1 } from 'pathe/utils';
@@ -40,7 +41,7 @@ async function checkNuxtCompatibility(constraints, nuxt = useNuxt()) {
   const issues = [];
   if (constraints.nuxt) {
     const nuxtVersion = getNuxtVersion(nuxt);
-    const nuxtSemanticVersion = nuxtVersion.replace(/-[0-9]+\.[0-9a-f]{7,8}/, "");
+    const nuxtSemanticVersion = nuxtVersion.replace(/-[0-9]+\.[0-9a-f]+/, "");
     if (!satisfies(nuxtSemanticVersion, constraints.nuxt, { includePrerelease: true })) {
       issues.push({
         name: "nuxt",
@@ -164,7 +165,23 @@ ${issues.toString()}`);
     if (definition.hooks) {
       nuxt.hooks.addHooks(definition.hooks);
     }
-    await definition.setup?.call(null, _options, nuxt);
+    const mark = performance.mark();
+    const res = await definition.setup?.call(null, _options, nuxt) ?? {};
+    const perf = performance.measure(`nuxt:module:${uniqueKey || Math.round(Math.random() * 1e4)}`, mark.name);
+    const setupTime = Math.round(perf.duration * 100) / 100;
+    if (setupTime > 5e3) {
+      logger.warn(`Slow module \`${uniqueKey || "<no name>"}\` took \`${setupTime}ms\` to setup.`);
+    } else if (nuxt.options.debug) {
+      logger.info(`Module \`${uniqueKey || "<no name>"}\` took \`${setupTime}ms\` to setup.`);
+    }
+    if (res === false) {
+      return false;
+    }
+    return defu(res, {
+      timings: {
+        setup: setupTime
+      }
+    });
   }
   normalizedModule.getMeta = () => Promise.resolve(definition.meta);
   normalizedModule.getOptions = getOptions;
@@ -232,30 +249,12 @@ function clearRequireCache(id) {
   }
   delete _require.cache[id];
 }
-function scanRequireTree(id, files = /* @__PURE__ */ new Set()) {
-  if (isNodeModules(id) || files.has(id)) {
-    return files;
-  }
-  const entry = getRequireCacheItem(id);
-  if (!entry) {
-    files.add(id);
-    return files;
-  }
-  files.add(entry.id);
-  for (const child of entry.children) {
-    scanRequireTree(child.id, files);
-  }
-  return files;
-}
 function getRequireCacheItem(id) {
   try {
     return _require.cache[id];
   } catch (e) {
   }
 }
-function requireModulePkg(id, opts = {}) {
-  return requireModule(join(id, "package.json"), opts);
-}
 function resolveModule(id, opts = {}) {
   return normalize(_require.resolve(id, {
     paths: [].concat(
@@ -268,7 +267,7 @@ function resolveModule(id, opts = {}) {
     ).filter(Boolean)
   }));
 }
-function tryResolveModule(path, opts = {}) {
+function tryResolveModule$1(path, opts = {}) {
   try {
     return resolveModule(path, opts);
   } catch (error) {
@@ -286,16 +285,16 @@ function requireModule(id, opts = {}) {
   const requiredModule = _require(resolvedPath);
   return requiredModule;
 }
-function importModule(id, opts = {}) {
+function importModule$1(id, opts = {}) {
   const resolvedPath = resolveModule(id, opts);
   if (opts.interopDefault !== false) {
     return import(pathToFileURL(resolvedPath).href).then(interopDefault);
   }
   return import(pathToFileURL(resolvedPath).href);
 }
-function tryImportModule(id, opts = {}) {
+function tryImportModule$1(id, opts = {}) {
   try {
-    return importModule(id, opts).catch(() => void 0);
+    return importModule$1(id, opts).catch(() => void 0);
   } catch {
   }
 }
@@ -306,6 +305,23 @@ function tryRequireModule(id, opts = {}) {
   }
 }
 
+async function tryResolveModule(id, url = import.meta.url) {
+  try {
+    return await resolvePath$1(id, { url });
+  } catch {
+  }
+}
+async function importModule(id, url = import.meta.url) {
+  const resolvedPath = await resolvePath$1(id, { url });
+  return import(pathToFileURL(resolvedPath).href).then(interopDefault);
+}
+function tryImportModule(id, url = import.meta.url) {
+  try {
+    return importModule(id, url).catch(() => void 0);
+  } catch {
+  }
+}
+
 function isIgnored(pathname) {
   const nuxt = tryUseNuxt();
   if (!nuxt) {
@@ -374,7 +390,7 @@ async function resolvePath(path, opts = {}) {
       return pathWithIndex;
     }
   }
-  const resolveModulePath = tryResolveModule(_path, { paths: [cwd, ...modulesDir] });
+  const resolveModulePath = tryResolveModule$1(_path, { paths: [cwd, ...modulesDir] });
   if (resolveModulePath) {
     return resolveModulePath;
   }
@@ -432,7 +448,7 @@ async function resolveFiles(path, pattern, opts = {}) {
 async function installModule(moduleToInstall, _inlineOptions, _nuxt) {
   const nuxt = useNuxt();
   const { nuxtModule, inlineOptions } = await normalizeModule(moduleToInstall, _inlineOptions);
-  const res = await nuxtModule(inlineOptions, nuxt);
+  const res = await nuxtModule(inlineOptions, nuxt) ?? {};
   if (res === false) {
     return;
   }
@@ -442,6 +458,7 @@ async function installModule(moduleToInstall, _inlineOptions, _nuxt) {
   nuxt.options._installedModules = nuxt.options._installedModules || [];
   nuxt.options._installedModules.push({
     meta: await nuxtModule.getMeta?.(),
+    timings: res.timings,
     entryPath: typeof moduleToInstall === "string" ? resolveAlias(moduleToInstall) : void 0
   });
 }
@@ -451,7 +468,7 @@ async function normalizeModule(nuxtModule, inlineOptions) {
     const _src = resolveModule(resolveAlias(nuxtModule), { paths: nuxt.options.modulesDir });
     const isESM = _src.endsWith(".mjs");
     try {
-      nuxtModule = isESM ? await importModule(_src) : requireModule(_src);
+      nuxtModule = isESM ? await importModule(_src, nuxt.options.rootDir) : requireModule(_src);
     } catch (error) {
       console.error(`Error while requiring module \`${nuxtModule}\`: ${error}`);
       throw error;
@@ -509,7 +526,6 @@ function extendNuxtSchema(def) {
 async function loadNuxt(opts) {
   opts.cwd = opts.cwd || opts.rootDir;
   opts.overrides = opts.overrides || opts.config || {};
-  const resolveOpts = { paths: opts.cwd };
   opts.overrides.dev = !!opts.dev;
   const nearestNuxtPkg = await Promise.all(["nuxt3", "nuxt", "nuxt-edge"].map((pkg2) => resolvePackageJSON(pkg2, { url: opts.cwd }).catch(() => null))).then((r) => r.filter(Boolean).sort((a, b) => b.length - a.length)[0]);
   if (!nearestNuxtPkg) {
@@ -517,12 +533,13 @@ async function loadNuxt(opts) {
   }
   const pkg = await readPackageJSON(nearestNuxtPkg);
   const majorVersion = parseInt((pkg.version || "").split(".")[0]);
+  const rootDir = pathToFileURL(opts.cwd || process.cwd()).href;
   if (majorVersion === 3) {
-    const { loadNuxt: loadNuxt3 } = await importModule(pkg._name || pkg.name, resolveOpts);
+    const { loadNuxt: loadNuxt3 } = await importModule(pkg._name || pkg.name, rootDir);
     const nuxt2 = await loadNuxt3(opts);
     return nuxt2;
   }
-  const { loadNuxt: loadNuxt2 } = await tryImportModule("nuxt-edge", resolveOpts) || await importModule("nuxt", resolveOpts);
+  const { loadNuxt: loadNuxt2 } = await tryImportModule("nuxt-edge", rootDir) || await importModule("nuxt", rootDir);
   const nuxt = await loadNuxt2({
     rootDir: opts.cwd,
     for: opts.dev ? "dev" : "build",
@@ -534,12 +551,12 @@ async function loadNuxt(opts) {
   return nuxt;
 }
 async function buildNuxt(nuxt) {
-  const resolveOpts = { paths: nuxt.options.rootDir };
+  const rootDir = pathToFileURL(nuxt.options.rootDir).href;
   if (nuxt.options._majorVersion === 3) {
-    const { build: build2 } = await tryImportModule("nuxt3", resolveOpts) || await importModule("nuxt", resolveOpts);
+    const { build: build2 } = await tryImportModule("nuxt3", rootDir) || await importModule("nuxt", rootDir);
     return build2(nuxt);
   }
-  const { build } = await tryImportModule("nuxt-edge", resolveOpts) || await importModule("nuxt", resolveOpts);
+  const { build } = await tryImportModule("nuxt-edge", rootDir) || await importModule("nuxt", rootDir);
   return build(nuxt);
 }
 
@@ -652,13 +669,21 @@ async function addComponent(opts) {
     preload: false,
     mode: "all",
     shortPath: opts.filePath,
+    priority: 0,
     ...opts
   };
   nuxt.hook("components:extend", (components) => {
     const existingComponent = components.find((c) => (c.pascalName === component.pascalName || c.kebabName === component.kebabName) && c.mode === component.mode);
     if (existingComponent) {
-      const name = existingComponent.pascalName || existingComponent.kebabName;
-      console.warn(`Overriding ${name} component.`);
+      const existingPriority = existingComponent.priority ?? 0;
+      const newPriority = component.priority ?? 0;
+      if (newPriority < existingPriority) {
+        return;
+      }
+      if (newPriority === existingPriority) {
+        const name = existingComponent.pascalName || existingComponent.kebabName;
+        console.warn(`Overriding ${name} component. You can specify a \`priority\` option when calling \`addComponent\` to avoid this warning.`);
+      }
       Object.assign(existingComponent, component);
     } else {
       components.push(component);
@@ -786,6 +811,10 @@ function normalizePlugin(plugin) {
   if (!plugin.src) {
     throw new Error("Invalid plugin. src option is required: " + JSON.stringify(plugin));
   }
+  const nonTopLevelPlugin = plugin.src.match(/\/plugins\/[^/]+\/index\.[^/]+$/i);
+  if (nonTopLevelPlugin && nonTopLevelPlugin.length > 0 && !useNuxt().options.plugins.find((i) => (typeof i === "string" ? i : i.src).endsWith(nonTopLevelPlugin[0]))) {
+    console.warn(`[warn] [nuxt] [deprecation] You are using a plugin that is within a subfolder of your plugins directory without adding it to your config explicitly. You can move it to the top-level plugins directory, or include the file '~${nonTopLevelPlugin[0]}' in your plugins config (https://nuxt.com/docs/api/configuration/nuxt-config#plugins-1) to remove this warning.`);
+  }
   plugin.src = normalize(resolveAlias(plugin.src));
   if (plugin.ssr) {
     plugin.mode = "server";
@@ -850,4 +879,4 @@ function useNitro() {
   return nuxt._nitro;
 }
 
-export { addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addRouteMiddleware, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendNuxtSchema, extendPages, extendRouteRules, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, getRequireCacheItem, hasNuxtCompatibility, importModule, installModule, isIgnored, isNodeModules, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, updateTemplates, useLogger, useNitro, useNuxt };
+export { addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addRouteMiddleware, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, compileTemplate, createResolver, defineNuxtModule, extendNuxtSchema, extendPages, extendRouteRules, extendViteConfig, extendWebpackConfig, findPath, getNuxtVersion, hasNuxtCompatibility, importModule$1 as importModule, installModule, isIgnored, isNuxt2, isNuxt3, loadNuxt, loadNuxtConfig, logger, normalizePlugin, normalizeTemplate, nuxtCtx, requireModule, resolveAlias, resolveFiles, resolveModule, resolvePath, templateUtils, tryImportModule$1 as tryImportModule, tryRequireModule, tryResolveModule, tryUseNuxt, updateTemplates, useLogger, useNitro, useNuxt };

package/package.json

@@ -1,32 +1,38 @@
 {
   "name": "@nuxt/kit",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "repository": "nuxt/nuxt",
   "license": "MIT",
   "type": "module",
-  "main": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@nuxt/schema": "3.2.2",
-    "c12": "^1.1.2",
+    "@nuxt/schema": "3.3.0",
+    "c12": "^1.2.0",
     "consola": "^2.15.3",
     "defu": "^6.1.2",
     "globby": "^13.1.3",
     "hash-sum": "^2.0.0",
     "ignore": "^5.2.4",
-    "jiti": "^1.17.1",
+    "jiti": "^1.17.2",
     "knitwork": "^1.0.0",
     "lodash.template": "^4.5.0",
-    "mlly": "^1.1.1",
+    "mlly": "^1.2.0",
     "pathe": "^1.1.0",
     "pkg-types": "^1.0.2",
     "scule": "^1.0.0",
     "semver": "^7.3.8",
     "unctx": "^2.1.2",
-    "unimport": "^2.2.4",
+    "unimport": "^3.0.2",
     "untyped": "^1.2.2"
   },
   "devDependencies": {