fix: tolerate an undefined baseUrl compiler option
#208
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aleclarson
force-pushed
the
fix/missing-baseUrl
branch
from
38e04a8
to
6a88d79
Compare
aleclarson
commented
Apr 20, 2022
| @@ -22,7 +22,7 @@ export interface ConfigLoaderParams { | |||
| export interface ConfigLoaderSuccessResult { | |||
| resultType: "success"; | |||
| configFileAbsolutePath: string; | |||
| baseUrl: string; | |||
| baseUrl?: string; | |||
There was a problem hiding this comment.
This is why it's a breaking change
There was a problem hiding this comment.
Making a previously required property optional is not a breaking change IMO, especially in this case:
- It won't change anything for projects having a
baseUrl - There's virtually no projects using
tsconfig-pathsthat currently do not have abaseUrl, because it was basically broken
There was a problem hiding this comment.
This PR introduces a compiler error into any downstream package that happens to use loadConfig and expects the baseUrl property to only ever be a string. If a change can cause downstream compiler errors, I consider it breaking.
There was a problem hiding this comment.
Oh I was not aware of the public API, my bad!
marvinroger
approved these changes
Apr 20, 2022
|
@aleclarson Could you also add an entry for this PR in the CHANGELOG under unreleased heading, noting it as a breaking change. |
aleclarson
force-pushed
the
fix/missing-baseUrl
branch
from
6a88d79
to
b1647e4
Compare
|
LGTM |
Merged
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #143
This is a breaking change.