Add paths tag for questions regarding tsconfig paths not working (#38)

Maybe there is more information that could be added?

I just pasted this from the "paths are not magic" tag in the typescript
server
This commit is contained in:
DidaS 2024-09-23 16:14:46 +01:00 committed by GitHub
parent 7268a7287a
commit 9e71877d91
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

12
data/tags/paths.md Normal file
View file

@ -0,0 +1,12 @@
---
question: How to use tsconfig paths?
keywords:
- "paths"
- "baseUrl"
- "magic"
---
The `paths` and `baseUrl` compiler options don't cause any remapping of imports paths, they only inform TS of existing mappings, which you'll have to setup with some other tool.
`baseUrl` is a pretty well-supported option (e.g. using the `NODE_PATH` environment variable with node or `resolve.modules` with webpack).
`paths` can be trickier to setup, (see [this](https://nodejs.org/api/packages.html#packages_subpath_imports)), and you may find it to not be worth the effort.