Skip to content
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.

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

Add baseUrl notices to readme #248

Merged
merged 1 commit into from
Feb 4, 2024
Merged

Conversation

hyperupcall
Copy link
Contributor

This updates the documentation to add a notice that baseUrl may need to be set manually, for places where it is relevant.

But, checking the docs for baseUrl, it seems that it is only recommended for use with AMD module loaders (since TypeScript 4.1, it is no longer required when using 'paths`). So, I'm thinking it might be better just to remove the properties all together (with no documentation update)? That will still address the "confusion" from the linked issue, and not add "notices" that do not apply for most people.

Closes #223

@orta
Copy link
Member

orta commented Feb 1, 2024

I've always tried to recommend C&Ping directly from the source, and so it's likely that if we removed the baseUrl, someone would bring it back - which means either post-processing the bases for publishing or leaving a note like this

So, I think this is a pretty reasonable solution overall and I'd be fine with it as the answer

@orta
Copy link
Member

orta commented Feb 1, 2024

Its kind of the same tension in #207

@hyperupcall
Copy link
Contributor Author

hyperupcall commented Feb 4, 2024

@orta I see, that makes sense - README note it is then

@orta orta merged commit 811b956 into tsconfig:main Feb 4, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remix: the baseUrl in remix/tsconfig.json is useless
2 participants