From 23ebfc0c2821d31919fce58977b44f4663d6a8a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20LeBlanc?= Date: Tue, 3 Dec 2024 05:02:16 -0500 Subject: [PATCH] docs: add giget limitation in nuxt layers documentation (#30122) --- docs/2.guide/3.going-further/7.layers.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/2.guide/3.going-further/7.layers.md b/docs/2.guide/3.going-further/7.layers.md index 3285135cfd..f22e64a2ec 100644 --- a/docs/2.guide/3.going-further/7.layers.md +++ b/docs/2.guide/3.going-further/7.layers.md @@ -104,6 +104,10 @@ If you want to extend a private remote source, you need to add the environment v If you want to extend a remote source from a self-hosted GitHub or GitLab instance, you need to supply its URL with the `GIGET_GITHUB_URL=` or `GIGET_GITLAB_URL=` environment variable - or directly configure it with [the `auth` option](https://github.com/unjs/c12#extending-config-layer-from-remote-sources) in your `nuxt.config`. :: +::warning +Bear in mind that if you are extending a remote source as a layer, you will not be able to access its dependencies outside of Nuxt. For example, if the remote layer depends on an eslint plugin, this will not be usable in your eslint config. That is because these dependencies will be located in a special location (`node_modules/.c12/layer_name/node_modules/`) that is not accessible to your package manager. +:: + ::note 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.