From 6e32bde7ae876158d11e0b4a2d04c51608871f5c Mon Sep 17 00:00:00 2001 From: Alexander Seidmann <40206670+aseidma@users.noreply.github.com> Date: Tue, 21 Dec 2021 14:02:07 +0100 Subject: [PATCH] add overwriting disclaimer to tsconfig section (#2483) --- docs/content/2.concepts/3.typescript.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/content/2.concepts/3.typescript.md b/docs/content/2.concepts/3.typescript.md index 90551caabd..ca3a9a814b 100644 --- a/docs/content/2.concepts/3.typescript.md +++ b/docs/content/2.concepts/3.typescript.md @@ -29,6 +29,12 @@ This file contains the recommended basic TypeScript configuration for your proje ::alert{icon=👉} Nitro also [auto-generates types](/concepts/server-engine#typed-api-routes) for API routes. Plus, Nuxt also generates types for globally available components and [auto-imports from your composables](/docs/directory-structure/composables), plus other core functionality. :: +::alert +Keep in mind that all options extended from `./.nuxt/tsconfig.json` will be overwritten by the options defined in your `tsconfig.json`. +Overwriting options such as `"compilerOptions.paths"` with your own configuration will lead Typescript to not factor in the module resolutions from `./.nuxt/tsconfig.json`. This can lead to module resolutions such as `#app` not being recognized. + +In case you need to extend options provided by `./.nuxt/tsconfig.json` further, you can use the `alias` property withing your `nuxt.config`. `nuxi` will pick them up and extend `./.nuxt/tsconfig.json` accordingly. +:: ## Stricter Checks