mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-26 07:32:01 +00:00
Compare commits
14 Commits
8692857ae3
...
6c7f539f99
Author | SHA1 | Date | |
---|---|---|---|
|
6c7f539f99 | ||
|
9bf8465806 | ||
|
f94d3f2bc6 | ||
|
9c8cd4b74b | ||
|
7b69dc9463 | ||
|
bbf481fb26 | ||
|
6666197364 | ||
|
dc229914c7 | ||
|
d2540e45d0 | ||
|
9bb36478ff | ||
|
519df56854 | ||
|
dad9d00008 | ||
|
cb9a4ec847 | ||
|
bcef9571dd |
@ -21,8 +21,8 @@ Or follow the steps below to set up a new Nuxt project on your computer.
|
|||||||
<!-- markdownlint-disable-next-line MD001 -->
|
<!-- markdownlint-disable-next-line MD001 -->
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
- **Node.js** - [`v18.0.0`](https://nodejs.org/en) or newer
|
- **Node.js** - [`18.x`](https://nodejs.org/en) or newer (but we recommend the [active LTS release](https://github.com/nodejs/release#release-schedule))
|
||||||
- **Text editor** - We recommend [Visual Studio Code](https://code.visualstudio.com/) with the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously known as Volar)
|
- **Text editor** - There is no IDE requirement, but we recommend [Visual Studio Code](https://code.visualstudio.com/) with the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously known as Volar) or [WebStorm](https://www.jetbrains.com/webstorm/), which, along with [other JetBrains IDEs](https://www.jetbrains.com/ides/), offers great Nuxt support right out-of-the-box.
|
||||||
- **Terminal** - In order to run Nuxt commands
|
- **Terminal** - In order to run Nuxt commands
|
||||||
|
|
||||||
::note
|
::note
|
||||||
|
98
docs/2.guide/2.directory-structure/1.shared.md
Normal file
98
docs/2.guide/2.directory-structure/1.shared.md
Normal file
@ -0,0 +1,98 @@
|
|||||||
|
---
|
||||||
|
title: 'shared'
|
||||||
|
head.title: 'shared/'
|
||||||
|
description: 'Use the shared/ directory to share functionality between the Vue app and the Nitro server.'
|
||||||
|
navigation.icon: 'i-ph-folder'
|
||||||
|
---
|
||||||
|
|
||||||
|
The `shared/` directory allows you to share code that can be used in both the Vue app and the Nitro server.
|
||||||
|
|
||||||
|
::tip
|
||||||
|
The `shared/` directory is available in Nuxt v3.14+.
|
||||||
|
::
|
||||||
|
|
||||||
|
::important
|
||||||
|
Code in the `shared/` directory cannot import any Vue or Nitro code.
|
||||||
|
::
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
**Method 1:** Using named export
|
||||||
|
|
||||||
|
```ts twoslash [shared/utils/capitalize.ts]
|
||||||
|
export const capitalize = (input: string) => {
|
||||||
|
return input[0].toUpperCase() + input.slice(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Method 2:** Using default export
|
||||||
|
|
||||||
|
```ts twoslash [shared/utils/capitalize.ts]
|
||||||
|
export default function capitalize (input: string) {
|
||||||
|
return input[0].toUpperCase() + input.slice(1)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Usage:** You can now use auto-imported utility functions in `.js`, `.ts` and `.vue` files within your Vue app and the `server/` directory.
|
||||||
|
|
||||||
|
If you have [set `compatibilityVersion: 4` in your `nuxt.config.ts`](/docs/getting-started/upgrade#opting-in-to-nuxt-4), you can use the auto-imported functions in the `app/` directory. This is part of Nuxt's progressive compatibility features preparing for version 4.
|
||||||
|
|
||||||
|
```vue [app.vue]
|
||||||
|
<script setup lang="ts">
|
||||||
|
const hello = capitalize('hello')
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div>
|
||||||
|
{{ hello }}
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
```
|
||||||
|
|
||||||
|
```ts [server/api/hello.get.ts]
|
||||||
|
export default defineEventHandler((event) => {
|
||||||
|
return {
|
||||||
|
hello: capitalize('hello')
|
||||||
|
}
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Auto Imports
|
||||||
|
|
||||||
|
Only files in the `shared/utils/` and `shared/types/` directories will be auto-imported. Files nested within subdirectories of these directories will not be auto-imported.
|
||||||
|
|
||||||
|
::tip
|
||||||
|
The way `shared/utils` and `shared/types` auto-imports work and are scanned is identical to the [`composables/`](/docs/guide/directory-structure/composables) and [`utils/`](/docs/guide/directory-structure/utils) directories.
|
||||||
|
::
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/directory-structure/composables#how-files-are-scanned"}
|
||||||
|
|
||||||
|
```bash [Directory Structure]
|
||||||
|
-| shared/
|
||||||
|
---| capitalize.ts # Not auto-imported
|
||||||
|
---| formatters
|
||||||
|
-----| lower.ts # Not auto-imported
|
||||||
|
---| utils/
|
||||||
|
-----| lower.ts # Auto-imported
|
||||||
|
-----| formatters
|
||||||
|
-------| upper.ts # Not auto-imported
|
||||||
|
---| types/
|
||||||
|
-----| bar.d.ts # Auto-imported
|
||||||
|
```
|
||||||
|
|
||||||
|
Any other files you create in the `shared/` folder must be manually imported using the `#shared` alias (automatically configured by Nuxt):
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// For files directly in the shared directory
|
||||||
|
import capitalize from '#shared/capitalize'
|
||||||
|
|
||||||
|
// For files in nested directories
|
||||||
|
import lower from '#shared/formatters/lower'
|
||||||
|
|
||||||
|
// For files nested in a folder within utils
|
||||||
|
import upper from '#shared/utils/formatters/upper'
|
||||||
|
```
|
||||||
|
|
||||||
|
This alias ensures consistent imports across your application, regardless of the importing file's location.
|
||||||
|
|
||||||
|
:read-more{to="/docs/guide/concepts/auto-imports"}
|
@ -189,7 +189,6 @@ export default createConfigForNuxt({
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
// Sort rule keys in eslint config
|
// Sort rule keys in eslint config
|
||||||
// @ts-expect-error incorrect types 🤔
|
|
||||||
{
|
{
|
||||||
files: ['**/eslint.config.mjs'],
|
files: ['**/eslint.config.mjs'],
|
||||||
name: 'local/sort-eslint-config',
|
name: 'local/sort-eslint-config',
|
||||||
|
@ -40,7 +40,7 @@
|
|||||||
"@nuxt/ui-templates": "workspace:*",
|
"@nuxt/ui-templates": "workspace:*",
|
||||||
"@nuxt/vite-builder": "workspace:*",
|
"@nuxt/vite-builder": "workspace:*",
|
||||||
"@nuxt/webpack-builder": "workspace:*",
|
"@nuxt/webpack-builder": "workspace:*",
|
||||||
"@types/node": "22.9.0",
|
"@types/node": "22.9.1",
|
||||||
"@unhead/dom": "1.11.11",
|
"@unhead/dom": "1.11.11",
|
||||||
"@unhead/shared": "1.11.11",
|
"@unhead/shared": "1.11.11",
|
||||||
"@unhead/vue": "1.11.11",
|
"@unhead/vue": "1.11.11",
|
||||||
@ -75,7 +75,7 @@
|
|||||||
"@nuxt/webpack-builder": "workspace:*",
|
"@nuxt/webpack-builder": "workspace:*",
|
||||||
"@testing-library/vue": "8.1.0",
|
"@testing-library/vue": "8.1.0",
|
||||||
"@types/eslint__js": "8.42.3",
|
"@types/eslint__js": "8.42.3",
|
||||||
"@types/node": "22.9.0",
|
"@types/node": "22.9.1",
|
||||||
"@types/semver": "7.5.8",
|
"@types/semver": "7.5.8",
|
||||||
"@unhead/schema": "1.11.11",
|
"@unhead/schema": "1.11.11",
|
||||||
"@unhead/vue": "1.11.11",
|
"@unhead/vue": "1.11.11",
|
||||||
@ -91,7 +91,7 @@
|
|||||||
"devalue": "5.1.1",
|
"devalue": "5.1.1",
|
||||||
"eslint": "9.15.0",
|
"eslint": "9.15.0",
|
||||||
"eslint-plugin-no-only-tests": "3.3.0",
|
"eslint-plugin-no-only-tests": "3.3.0",
|
||||||
"eslint-plugin-perfectionist": "3.9.1",
|
"eslint-plugin-perfectionist": "4.0.2",
|
||||||
"eslint-typegen": "0.3.2",
|
"eslint-typegen": "0.3.2",
|
||||||
"h3": "npm:h3-nightly@2.0.0-1718872656.6765a6e",
|
"h3": "npm:h3-nightly@2.0.0-1718872656.6765a6e",
|
||||||
"happy-dom": "15.11.6",
|
"happy-dom": "15.11.6",
|
||||||
|
429
pnpm-lock.yaml
429
pnpm-lock.yaml
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user