@nuxt/schema - npm Package Compare versions

Comparing version 3.10.3 to 3.11.0

package.json

 {
   "name": "@nuxt/schema",
-  "version": "3.10.3",
+  "version": "3.11.0",
   "repository": {
@@ -38,11 +38,12 @@ "type": "git",
     "@types/sass-loader": "8.0.8",
-    "@unhead/schema": "1.8.10",
+    "@unhead/schema": "1.8.20",
     "@vitejs/plugin-vue": "5.0.4",
     "@vitejs/plugin-vue-jsx": "3.1.0",
-    "@vue/compiler-core": "3.4.19",
-    "c12": "1.9.0",
-    "esbuild-loader": "4.0.3",
-    "h3": "1.10.2",
+    "@vue/compiler-core": "3.4.21",
+    "@vue/language-core": "2.0.6",
+    "c12": "1.10.0",
+    "esbuild-loader": "4.1.0",
+    "h3": "1.11.1",
     "ignore": "5.3.1",
-    "nitropack": "2.8.1",
+    "nitropack": "2.9.4",
     "ofetch": "1.3.3",
@@ -52,4 +53,4 @@ "unbuild": "latest",
     "unenv": "1.9.0",
-    "vite": "5.1.4",
-    "vue": "3.4.19",
+    "vite": "5.1.6",
+    "vue": "3.4.21",
     "vue-bundle-renderer": "2.0.0",
@@ -70,3 +71,3 @@ "vue-loader": "17.4.2",
     "std-env": "^3.7.0",
-    "ufo": "^1.4.0",
+    "ufo": "^1.5.1",
     "unimport": "^3.7.1",
@@ -73,0 +74,0 @@ "untyped": "^1.4.2"

README.md

@@ -16,13 +16,29 @@ [![Nuxt banner](./.github/assets/banner.svg)](https://nuxt.com)
 It provides a number of features that make it easy to build fast, SEO-friendly, and scalable web applications, including:
-- Server-side rendering, Static Site Generation or Hybrid Rendering
-- Automatic routing with code-splitting
-- State management
-- SEO Optimization
-- Auto imports
-- Extensible with [180+ modules](https://nuxt.com/modules)
+- Server-side rendering, Static Site Generation, Hybrid Rendering and Edge-Side Rendering
+- Automatic routing with code-splitting and pre-fetching
+- Data fetching and state management
+- SEO Optimization and Meta tags definition
+- Auto imports of components, composables and utils
+- TypeScript with zero configuration
+- Go fullstack with our server/ directory
+- Extensible with [200+ modules](https://nuxt.com/modules)
 - Deployment to a variety of [hosting platforms](https://nuxt.com/deploy)
 - ...[and much more](https://nuxt.com) 🚀
 
-## Getting Started
+### Table of Contents
 
+- 🚀 [Getting Started](#getting-started)
+- 💻 [ Vue Development](#vue-development)
+- 📖 [Documentation](#documentation)
+- 🧩 [Modules](#modules)
+- ❤️  [Contribute](#contribute)
+- 🏠 [Local Development](#local-development)
+- ⛰️ [Nuxt 2](#nuxt-2)
+- 🔗 [Follow us](#follow-us)
+- ⚖️ [License](#license)
+
+---
+
+## <a name="getting-started">🚀 Getting Started</a>
+
 Use the following command to create a new starter project. This will create a starter project with all the necessary files and dependencies:
@@ -34,5 +50,6 @@
 
-Discover also [nuxt.new](https://nuxt.new): Open a Nuxt starter on CodeSandbox, StackBlitz or locally to get up and running in a few seconds.
+> [!TIP]
+> Discover also [nuxt.new](https://nuxt.new): Open a Nuxt starter on CodeSandbox, StackBlitz or locally to get up and running in a few seconds.
 
-## Vue Development
+## <a name="vue-development">💻 Vue Development</a>
 
@@ -59,3 +76,3 @@ Simple, intuitive and powerful, Nuxt lets you write Vue components in a way that makes sense. Every repetitive task is automated, so you can focus on writing your full-stack Vue application with confidence.
 
-<style>
+<style scoped>
 #app {
@@ -68,11 +85,11 @@ background-color: #020420;
 
-## Documentation
+## <a name="documentation">📖 Documentation</a>
 
 We highly recommend you take a look at the [Nuxt documentation](https://nuxt.com/docs) to level up. It’s a great resource for learning more about the framework. It covers everything from getting started to advanced topics.
 
-## Modules
+## <a name="modules">🧩 Modules</a>
 
 Discover our [list of modules](https://nuxt.com/modules) to supercharge your Nuxt project, created by the Nuxt team and community.
 
-## Contribute
+## <a name="contribute">❤️ Contribute</a>
 
@@ -86,11 +103,11 @@ We invite you to contribute and help improve Nuxt 💚
 
-## Local Development
+## <a name="local-development">🏠 Local Development</a>
 
 Follow the docs to [Set Up Your Local Development Environment](https://nuxt.com/docs/community/framework-contribution#setup) to contribute to the framework and documentation.
 
-## Nuxt 2
+## <a name="nuxt-2">⛰️ Nuxt 2</a>
 
 You can find the code for Nuxt 2 on the [`2.x` branch](https://github.com/nuxt/nuxt/tree/2.x) and the documentation at [v2.nuxt.com](https://v2.nuxt.com).
 
-## Follow us
+## <a name="follow-us">🔗 Follow us</a>
 
@@ -101,5 +118,4 @@ <p valign="center">
 
-## License
+## <a name="license">⚖️ License</a>
 
 [MIT](./LICENSE)
-

schema/config.d.ts

@@ -18,2 +18,3 @@ import type { ComponentsOptions } from '../src/types/components'
 import type { TSConfig } from 'pkg-types'
+import type { VueCompilerOptions } from '@vue/language-core'
 import type { PluginOptions } from 'mini-css-extract-plugin'
@@ -237,2 +238,16 @@ import type { LoaderOptions } from 'esbuild-loader'
   rootTag: string,
+
+  /**
+   * Customize Nuxt root element tag.
+   * 
+   * @default "div"
+  */
+  teleportTag: string,
+
+  /**
+   * Customize Nuxt Teleport element id.
+   * 
+   * @default "teleports"
+  */
+  teleportId: string | false,
  },
@@ -978,2 +993,11 @@
   /**
+   * Stream server logs to the client as you are developing. These logs can be handled in the `dev:ssr-logs` hook.
+   * 
+   * If set to `silent`, the logs will not be printed to the browser console.
+   * 
+   * @default false
+  */
+  devLogs: boolean | 'silent',
+
+  /**
    * Turn off rendering of Nuxt scripts and JS resource hints. You can also disable scripts more granularly within `routeRules`.
@@ -1097,7 +1121,9 @@ *
   /**
-   * Experimental component islands support with <NuxtIsland> and .island.vue files.
+   * Experimental component islands support with `<NuxtIsland>` and `.island.vue` files.
    * 
-   * @default false
+   * By default it is set to 'auto', which means it will be enabled only when there are islands, server components or server pages in your app.
+   * 
+   * @default "auto"
   */
-  componentIslands: true | 'local' | 'local+remote' | Partial<{ remoteIsland: boolean, selectiveClient: boolean }> | false,
+  componentIslands: true | 'auto' | 'local' | 'local+remote' | Partial<{ remoteIsland: boolean, selectiveClient: boolean | 'deep' }> | false,
 
@@ -1474,2 +1500,9 @@ /**
   /**
+   * Modules to generate deep aliases for within `compilerOptions.paths`. This does not yet support subpaths. It may be necessary when using Nuxt within a pnpm monorepo with `shamefully-hoist=false`.
+   * 
+   * @default ["nitropack","defu","h3","@unhead/vue","vue","vue-router","@nuxt/schema","nuxt","consola"]
+  */
+  hoist: Array<string>,
+
+  /**
    * Include parent workspace in the Nuxt project. Mostly useful for themes and module authors.
@@ -1496,3 +1529,3 @@ *
   */
-  tsConfig: TSConfig,
+  tsConfig: 0 extends 1 & VueCompilerOptions ? TSConfig : TSConfig & { vueCompilerOptions?: VueCompilerOptions},
 
@@ -1502,5 +1535,5 @@ /**
    * 
-   * We recommend instead either enabling [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) or adding TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)].
+   * We recommend instead letting the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) generate accurate types for your components.
    * 
-   * @default true
+   * @default false
   */
@@ -1507,0 +1540,0 @@ shim: boolean,

schema/config.defaults.json

@@ -27,3 +27,3 @@ {
     },
-    "publicDir": "/<srcDir>/public",
+    "publicDir": false,
     "vue": {
@@ -100,3 +100,3 @@ "isProduction": true,
     "writeEarlyHints": false,
-    "componentIslands": false,
+    "componentIslands": "auto",
     "configSchema": true,
@@ -150,3 +150,5 @@ "polyfillVueUseHead": false,
     "rootId": "__nuxt",
-    "rootTag": "div"
+    "rootTag": "div",
+    "teleportTag": "div",
+    "teleportId": "teleports"
   },
@@ -341,5 +343,16 @@ "dev": false,
     "builder": null,
+    "hoist": [
+      "nitropack",
+      "defu",
+      "h3",
+      "@unhead/vue",
+      "vue",
+      "vue-router",
+      "@nuxt/schema",
+      "nuxt",
+      "consola"
+    ],
     "includeWorkspace": false,
     "typeCheck": false,
-    "shim": true
+    "shim": false
   },
@@ -351,2 +364,3 @@ "future": {
     "inlineStyles": true,
+    "devLogs": false,
     "noScripts": false
@@ -353,0 +367,0 @@ },

schema/config.md

@@ -152,2 +152,16 @@
 
+## `teleportTag`
+- **Type**: `string`
+- **Default**: `"div"`
+
+> Customize Nuxt root element tag.
+
+
+## `teleportId`
+- **Type**: `string | false`
+- **Default**: `"teleports"`
+
+> Customize Nuxt Teleport element id.
+
+
 # `spaLoadingTemplate`
@@ -622,2 +636,12 @@ - **Type**: `string | boolean`
 
+## `devLogs`
+- **Type**: `boolean | 'silent'`
+- **Default**: `false`
+
+> Stream server logs to the client as you are developing. These logs can be handled in the `dev:ssr-logs` hook.
+
+
+If set to `silent`, the logs will not be printed to the browser console.
+
+
 ## `noScripts`
@@ -735,8 +759,11 @@ - **Type**: `boolean`
 ## `componentIslands`
-- **Type**: `true | 'local' | 'local+remote' | Partial<{ remoteIsland: boolean, selectiveClient: boolean }> | false`
-- **Default**: `false`
+- **Type**: `true | 'auto' | 'local' | 'local+remote' | Partial<{ remoteIsland: boolean, selectiveClient: boolean | 'deep' }> | false`
+- **Default**: `"auto"`
 
-> Experimental component islands support with <NuxtIsland> and .island.vue files.
+> Experimental component islands support with `<NuxtIsland>` and `.island.vue` files.
 
 
+By default it is set to 'auto', which means it will be enabled only when there are islands, server components or server pages in your app.
+
+
 ## `configSchema`
@@ -1044,2 +1071,9 @@ - **Type**: `boolean`
 
+## `hoist`
+- **Type**: `array`
+- **Default**: `["nitropack","defu","h3","@unhead/vue","vue","vue-router","@nuxt/schema","nuxt","consola"]`
+
+> Modules to generate deep aliases for within `compilerOptions.paths`. This does not yet support subpaths. It may be necessary when using Nuxt within a pnpm monorepo with `shamefully-hoist=false`.
+
+
 ## `includeWorkspace`
@@ -1066,3 +1100,3 @@ - **Type**: `boolean`
 - **Type**: `boolean`
-- **Default**: `true`
+- **Default**: `false`
 
@@ -1072,3 +1106,3 @@ > Generate a `*.vue` shim.
 
-We recommend instead either enabling [**Take Over Mode**](https://vuejs.org/guide/typescript/overview.html#volar-takeover-mode) or adding TypeScript Vue Plugin (Volar)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin)].
+We recommend instead letting the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) generate accurate types for your components.
 
@@ -1098,4 +1132,4 @@
 ## `publicDir`
-- **Type**: `string`
-- **Default**: `"/<srcDir>/public"`
+- **Type**: `boolean`
+- **Default**: `false`
 
@@ -1102,0 +1136,0 @@

No alert changes

Improved metrics

Total package byte prevSize

499745

increased by2.16%

Lines of code

10847

increased by1.96%

Number of lines in readme file

116

increased by16%

Worsened metrics

Dev dependency count

25

increased by4.17%

Dependency changes

• Updatedufo@^1.5.1