docs: explain how to auto-install git layer deps (#24250)

Co-authored-by: Daniel Roe <daniel@roe.dev>
This commit is contained in:
Dominic Marcelino 2024-01-18 16:33:22 +01:00 committed by GitHub
parent 64c5f97d4a
commit f3d81ef7d6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -98,8 +98,16 @@ export default defineNuxtConfig({
If you want to extend a private remote source, you need to add the environment variable `GIGET_AUTH=<token>` to provide a token.
::
::callout{color="amber" icon="i-ph-warning-duotone"}
Currently, with git remote sources, if a layer has npm dependencies, you will need to manually install them in the target project. We are working on this to auto-install layer dependencies with git sources.
::callout{color="blue" icon="i-ph-info-duotone"}
When using git remote sources, if a layer has npm dependencies and you wish to install them, you can do so by specifying `install: true` in your layer options.
```ts [nuxt.config.ts]
export default defineNuxtConfig({
extends: [
['github:username/repoName', { install: true }]
]
})
```
::
### npm Package