Skip to content
This repository was archived by the owner on Oct 12, 2022. It is now read-only.

Improve documentation of typeRoots #692

Open
ghost opened this issue Dec 12, 2017 · 1 comment
Open

Improve documentation of typeRoots #692

ghost opened this issue Dec 12, 2017 · 1 comment

Comments

@ghost
Copy link

ghost commented Dec 12, 2017

A lot of people seem to think it's necessary to specify typeRoots to import things -- e.g., microsoft/TypeScript#20610. Our documentation says that things in typeRoots are "included", which could cause people to think they need to "include" things to be able to import them, which isn't true -- imports go through module resolution, not typeRoots.

@ghost
Copy link
Author

ghost commented Jan 16, 2018

The meaning of "include" also affects the "exclude" option in tsconfig -- a lot of people think they can use it to prevent a file from being imported, for example in microsoft/TypeScript#21189.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

0 participants