@nuxt/kit 3.0.0 → 3.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 - Nuxt Project
+Copyright (c) 2016-present - Nuxt Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,5 +1,128 @@
-# Nuxt Kit
 
-> Toolkit for authoring Nuxt Modules
+[![Nuxt banner](./.github/assets/banner.png)](https://nuxt.com)
+
+# 👋 Welcome to Nuxt
+
+
+Nuxt's goal is to make web development intuitive and performant, with a great developer experience.<br>Learn more in the ['What is Nuxt?'](https://nuxt.com/docs/getting-started/introduction) section of our documentation.
+
+
+ <p>
+  <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://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>
+
+<table>
+<thead>
+<tr>
+<th width="2000" colspan="2">
+</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs"><img src="./.github/assets/documentation.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Documentation</h3>
+    <p>
+      We highly recommend you take a look at <a href="https://nuxt.com">the Nuxt documentation</a> to level up.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/modules"><img src="./.github/assets/modules.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Modules</h3>
+    <p>
+      Discover our <a href="https://nuxt.com/modules">list of modules</a> to supercharge your Nuxt project. Created by the Nuxt team and community.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/examples/hello-world"><img src="./.github/assets/examples.png"></a>
+  </td>
+  <td>
+    <h3>Examples</h3>
+    <p>
+      Explore different ways of using Nuxt features and get inspired with <a href="https://nuxt.com/docs/examples/essentials/hello-world">our list of examples</a>.
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
+
+<table>
+<thead>
+<tr>
+<th width="2000" colspan="2">
+</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/reporting-bugs"><img src="./.github/assets/reporting-bugs.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Reporting bugs</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/reporting-bugs">Reporting Bugs</a> page.</p>
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/contribution"><img src="./.github/assets/suggestions.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Suggestions</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/contribution">Contribution</a> page.
+    </p>
+  </td>
+</tr>
+<tr>
+  <td width="80" align="center" valign="top">
+    <br>
+    <a href="https://nuxt.com/docs/community/getting-help"><img src="./.github/assets/questions.png"></a>
+  </td>
+  <td valign="top">
+    <h3>Questions</h3>
+    <p>
+      Check out the <a href="https://nuxt.com/docs/community/getting-help">Getting Help</a> page.
+    </p>
+  </td>
+</tr>
+</tbody>
+</table>
+
+## Local Development
+
+Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#set-up-your-local-development-environment) to contribute to the framework and documentation.
+
+## Nuxt 2
+
+You can find the code for Nuxt 2 on the [`2.x-dev` branch](https://github.com/nuxt/nuxt/tree/2.x-dev) and the documentation at [nuxtjs.org](https://nuxtjs.org).
+
+## Follow us
+
+<p valign="center">
+  <a href="https://chat.nuxt.dev"><img width="20px" src="./.github/assets/discord.svg" alt="Discord"></a>&nbsp;&nbsp;<a href="https://twitter.nuxt.dev"><img width="20px" src="./.github/assets/twitter.svg" alt="Twitter"></a>&nbsp;&nbsp;<a href="https://github.nuxt.dev"><img width="20px" src="./.github/assets/github.svg" alt="GitHub"></a>
+</p>
+
+## License
+
+[MIT](./LICENSE)
 
-Learn more about this package: <https://v3.nuxtjs.org>

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import { ModuleOptions, ModuleDefinition, NuxtModule, Nuxt, NuxtConfig, NuxtOptions, ImportPresetWithDeprecation, NuxtCompatibility, NuxtCompatibilityIssues, ComponentsDir, Component, NuxtTemplate, NuxtHooks, NuxtPlugin, NuxtPluginTemplate, ResolvedNuxtTemplate } from '@nuxt/schema';
+import { ModuleOptions, ModuleDefinition, NuxtModule, Nuxt, NuxtConfig, NuxtOptions, SchemaDefinition, ImportPresetWithDeprecation, NuxtCompatibility, NuxtCompatibilityIssues, ComponentsDir, Component, NuxtTemplate, NuxtHooks, NuxtPlugin, NuxtPluginTemplate, ResolvedNuxtTemplate } from '@nuxt/schema';
 import { LoadConfigOptions } from 'c12';
 import { Import } from 'unimport';
 import { Configuration, WebpackPluginInstance } from 'webpack';
 import { UserConfig, Plugin } from 'vite';
 import * as unctx_index from 'unctx/index';
-import { NitroEventHandler, NitroDevEventHandler, Nitro } from 'nitropack';
+import { NitroRouteConfig, NitroEventHandler, NitroDevEventHandler, Nitro } from 'nitropack';
 import * as consola from 'consola';
 import { genSafeVariableName } from 'knitwork';
 
@@ -21,6 +21,8 @@ interface LoadNuxtConfigOptions extends LoadConfigOptions<NuxtConfig> {
 }
 declare function loadNuxtConfig(opts: LoadNuxtConfigOptions): Promise<NuxtOptions>;
 
+declare function extendNuxtSchema(def: SchemaDefinition | (() => SchemaDefinition)): void;
+
 interface LoadNuxtOptions extends LoadNuxtConfigOptions {
     /** Load nuxt with development mode */
     dev?: boolean;
@@ -69,7 +71,7 @@ interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
 interface ExtendViteConfigOptions extends ExtendConfigOptions {
 }
 /**
- * Extend Webpack config
+ * Extend webpack config
  *
  * The fallback function might be called multiple times
  * when applying to both client and server builds.
@@ -80,7 +82,7 @@ declare function extendWebpackConfig(fn: ((config: Configuration) => void), opti
  */
 declare function extendViteConfig(fn: ((config: UserConfig) => void), options?: ExtendViteConfigOptions): (() => void) | undefined;
 /**
- * Append Webpack plugin to the config.
+ * Append webpack plugin to the config.
  */
 declare function addWebpackPlugin(plugin: WebpackPluginInstance | WebpackPluginInstance[], options?: ExtendWebpackConfigOptions): void;
 /**
@@ -166,6 +168,15 @@ declare function isIgnored(pathname: string): boolean;
 declare function addLayout(this: any, template: NuxtTemplate, name?: string): void;
 
 declare function extendPages(cb: NuxtHooks['pages:extend']): void;
+interface ExtendRouteRulesOptions {
+    /**
+     * Override route rule config
+     *
+     * @default false
+     */
+    override?: boolean;
+}
+declare function extendRouteRules(route: string, rule: NitroRouteConfig, options?: ExtendRouteRulesOptions): void;
 
 /**
  * Normalize a nuxt plugin object
@@ -330,4 +341,4 @@ declare const templateUtils: {
     }) => string;
 };
 
-export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendPages, 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, ExtendConfigOptions, ExtendRouteRulesOptions, ExtendViteConfigOptions, ExtendWebpackConfigOptions, LoadNuxtConfigOptions, LoadNuxtOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, 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 };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { promises, existsSync, readFileSync } from 'node:fs';
-import defu from 'defu';
+import defu, { defu as defu$1 } from 'defu';
 import { applyDefaults } from 'untyped';
 import { dirname, join, normalize, relative, isAbsolute, resolve, basename, parse } from 'pathe';
 import consola from 'consola';
@@ -259,9 +259,11 @@ function requireModulePkg(id, opts = {}) {
 function resolveModule(id, opts = {}) {
   return normalize(_require.resolve(id, {
     paths: [].concat(
+      // @ts-ignore
       global.__NUXT_PREPATHS__,
       opts.paths || [],
       process.cwd(),
+      // @ts-ignore
       global.__NUXT_PATHS__
     ).filter(Boolean)
   }));
@@ -311,18 +313,35 @@ function isIgnored(pathname) {
   }
   if (!nuxt._ignore) {
     nuxt._ignore = ignore(nuxt.options.ignoreOptions);
-    nuxt._ignore.add(nuxt.options.ignore);
+    const resolvedIgnore = nuxt.options.ignore.flatMap((s) => resolveGroupSyntax(s));
+    nuxt._ignore.add(resolvedIgnore);
     const nuxtignoreFile = join(nuxt.options.rootDir, ".nuxtignore");
     if (existsSync(nuxtignoreFile)) {
       nuxt._ignore.add(readFileSync(nuxtignoreFile, "utf-8"));
     }
   }
-  const relativePath = relative(nuxt.options.rootDir, pathname);
+  const cwds = nuxt.options._layers?.map((layer2) => layer2.cwd).sort((a, b) => b.length - a.length);
+  const layer = cwds?.find((cwd) => pathname.startsWith(cwd));
+  const relativePath = relative(layer ?? nuxt.options.rootDir, pathname);
   if (relativePath.startsWith("..")) {
     return false;
   }
   return !!(relativePath && nuxt._ignore.ignores(relativePath));
 }
+function resolveGroupSyntax(group) {
+  let groups = [group];
+  while (groups.some((group2) => group2.includes("{"))) {
+    groups = groups.flatMap((group2) => {
+      const [head, ...tail] = group2.split("{");
+      if (tail.length) {
+        const [body, ...rest] = tail.join("{").split("}");
+        return body.split(",").map((part) => `${head}${part}${rest.join("")}`);
+      }
+      return group2;
+    });
+  }
+  return groups;
+}
 
 async function resolvePath(path, opts = {}) {
   const _path = path;
@@ -477,6 +496,13 @@ async function loadNuxtConfig(opts) {
   return await applyDefaults(NuxtConfigSchema, nuxtConfig);
 }
 
+function extendNuxtSchema(def) {
+  const nuxt = useNuxt();
+  nuxt.hook("schema:extend", (schemas) => {
+    schemas.push(typeof def === "function" ? def() : def);
+  });
+}
+
 async function loadNuxt(opts) {
   opts.cwd = opts.cwd || opts.rootDir;
   opts.overrides = opts.overrides || opts.config || {};
@@ -500,6 +526,7 @@ async function loadNuxt(opts) {
     configOverrides: opts.overrides,
     ready: opts.ready,
     envConfig: opts.dotenv
+    // TODO: Backward format convertion
   });
   return nuxt;
 }
@@ -719,6 +746,15 @@ function extendPages(cb) {
     nuxt.hook("pages:extend", cb);
   }
 }
+function extendRouteRules(route, rule, options = {}) {
+  const nuxt = useNuxt();
+  for (const opts of [nuxt.options, nuxt.options.nitro]) {
+    if (!opts.routeRules) {
+      opts.routeRules = {};
+    }
+    opts.routeRules[route] = options.override ? defu$1(rule, opts.routeRules[route]) : defu$1(opts.routeRules[route], rule);
+  }
+}
 
 function normalizePlugin(plugin) {
   if (typeof plugin === "string") {
@@ -793,4 +829,4 @@ function useNitro() {
   return nuxt._nitro;
 }
 
-export { addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addVitePlugin, addWebpackPlugin, assertNuxtCompatibility, buildNuxt, checkNuxtCompatibility, clearRequireCache, compileTemplate, createResolver, defineNuxtModule, extendPages, 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, 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 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxt/kit",
-  "version": "3.0.0",
-  "repository": "nuxt/framework",
+  "version": "3.1.0",
+  "repository": "nuxt/nuxt",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -10,28 +10,28 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/schema": "3.0.0",
-    "c12": "^1.0.1",
+    "@nuxt/schema": "3.1.0",
+    "c12": "^1.1.0",
     "consola": "^2.15.3",
     "defu": "^6.1.1",
-    "globby": "^13.1.2",
+    "globby": "^13.1.3",
     "hash-sum": "^2.0.0",
-    "ignore": "^5.2.0",
-    "jiti": "^1.16.0",
+    "ignore": "^5.2.4",
+    "jiti": "^1.16.2",
     "knitwork": "^1.0.0",
     "lodash.template": "^4.5.0",
-    "mlly": "^1.0.0",
+    "mlly": "^1.1.0",
     "pathe": "^1.0.0",
     "pkg-types": "^1.0.1",
     "scule": "^1.0.0",
     "semver": "^7.3.8",
-    "unctx": "^2.1.0",
-    "unimport": "^1.0.1",
-    "untyped": "^1.0.0"
+    "unctx": "^2.1.1",
+    "unimport": "^2.0.1",
+    "untyped": "^1.2.2"
   },
   "devDependencies": {
     "@types/lodash.template": "^4",
-    "@types/semver": "^7",
+    "@types/semver": "^7.3.13",
     "unbuild": "latest"
   },
   "engines": {