feat!: Add support for preserving block comment locations. #8231
Conversation
This file contains hidden or 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
BeksOmega
reviewed
Jun 27, 2024
There was a problem hiding th 8000 is comment.
Logic LGTM assuming you tested that round-tripping the coords in RTL works correctly. Easy to typo that stuff.
Can you also:
- Update the breaking change section of the PR description to tell people they'll need to implement these new methods if they're creating a custom comment icon.
- File an issue to update the docs on creating a custom comment icon to include this info?
BeksOmega
approved these changes
Jun 27, 2024
Yep, verified roundtripping with each layout as well as going between them for both XML and JSON.
Done
Sent you a CL updating the docs |
This was referenced Jul 10, 2024
Closed
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.
The basics
The details
Resolves
Fixes #8230
Proposed Changes
This PR preserves the positions of block comments when (de)serializing a workspace.
Reason for Changes
We allow users to position block comments arbitrarily, but while we preserve the location of workspace comments when (de)serializing the workspace, block comments have their positions lost. This is also needed to support the Scratch modernization effort, since Scratch persists block comment locations as well.
Breaking Change
This PR modifies the ICommentIcon interface to have two additional methods:
setBubbleLocation(location: Coordinate): voidandgetBubbleLocation(): Coordinate | undefined. If you have a class that implements ICommentIcon, you'll need to implement these methods as well. They should set and retrieve the location of the comment bubble/box, in workspace coordinates.