Skip to content

Update typeRoots.md example for clarity on typeRoots usage #3591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daleyjem wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Update typeRoots.md example for clarity on typeRoots usage #3591

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions packages/tsconfig-reference/copy/en/options/typeRoots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ By default all _visible_ "`@types`" packages are included in your compilation.
Packages in `node_modules/@types` of any enclosing folder are considered _visible_.
For example, that means packages within `./node_modules/@types/`, `../node_modules/@types/`, `../../node_modules/@types/`, and so on.

If `typeRoots` is specified, _only_ packages under `typeRoots` will be included. For example:
If `typeRoots` is specified, _only_ packages under `typeRoots` will be included. For example, the following config file will include _all_ packages under `./typings` and `./vendor/types`, and no packages from `./node_modules/@types`:

```json tsconfig
{
Expand All @@ -17,5 +17,4 @@ If `typeRoots` is specified, _only_ packages under `typeRoots` will be included.
}
```

This config file will include _all_ packages under `./typings` and `./vendor/types`, and no packages from `./node_modules/@types`.
All paths are relative to the `tsconfig.json`.
__Note:__ All paths are relative to the `tsconfig.json`.