-
Notifications
You must be signed in to change notification settings - Fork 38
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
fix!: Clarify Snippet API #94
Merged
Merged
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
I suggested this when a `Label`s title was an `Option`. We shouldn't be creating labels with empty strings.
bc76df2
to
7893419
Compare
Muscraft
reviewed
Mar 12, 2024
This fits with the session-type / type-state style builder and allows Diagnoatic adapters, like rustc, to leverage it vs the hard-coded functions.
This will make it easier for diagnostic systems to convert their messages to a `Message`
adf2bb5
to
373ab44
Compare
Muscraft
reviewed
Mar 12, 2024
Muscraft
approved these changes
Mar 12, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! I think this is a good change overall.
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.
This is a batch API change from talking to @Muscraft about what would make the clearer, what will make it more easily adapt to rustc, and what will make it better encoded the design in the type system.
Renames:
Snippet
->Message
Slice
->Snippet
Slice::new
toSnippet::source
SourceAnnotation
->Annotation
AnnotationType
->Level
Other breaking changes:
Snippet::line_start
is now defaulted to1
instead of requiredMessage
fromLevel
Annotation
fromLevel
Annotation::label
is now optionalNew:
What wasn't done:
Annotation
from usingLevel
to aStyle { Level, Neutral, Added, Removed }
footer
or convert it fromVec<Label>
toVec<Message>
Option
to have constructor methods that areOption
Message
&mut
builder which gets messy with the nesting builder APIMessage::id
toMessage::code
. I feel like the former is more semantically meaningful