fix(compartment-mapper)!: invert keys/values of renames in captureFromMap #2667
+20
−11
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
…mMap BREAKING CHANGE: The `CaptureResult.compartmentRenames` record returned by `captureFromMap()` is now _new to old_; previously it was _old to new_. This more accurately solves for the use case of `compartmentRenames`, because the main use case demands the record is inverted. We can plainly see this issue in `captureFromMap`'s test suite (which this change simplifies). In a future change, [branded types](https://www.learningtypescript.com/articles/branded-types) could describe the distinction between key and value, which are currently both `string`. > [!IMPORTANT] > > The only consumer of `captureFromMap` that I'm aware of is _me_, and _me_ doesn't need this to be SemVer major.
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.
BREAKING CHANGE: The
CaptureResult.compartmentRenamesrecord returned bycaptureFromMap()is now new to old; previously it was old to new.This more accurately solves for the use case of
compartmentRenames, because the main use case demands the record is inverted. We can plainly see this issue incaptureFromMap's test suite (which this change simplifies).In a future change, branded types could describe the distinction between key and value, which are currently both
string.Important
The only consumer of
captureFromMapthat I'm aware of is me, and me doesn't need this to be SemVer major.