This repository was archived by the owner on Jun 10, 2020. It is now read-only.
Follow-up to the fields added in #173, and add Problem#rendered #175
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
It turns out that there is more boilerplate to fill that I missed. Also add deprecation notices.
|
@eed3si9n This PR contains 494f384 which is part of the https://github.com/sbt/util/tree/v1.2.1 tag but seems to be missing from the https://github.com/sbt/util/tree/1.2.x branch. |
muuki88
reviewed
Aug 27, 2018
| */ | ||
| default Optional<String> rendered() { return Optional.empty(); } | ||
| } |
There was a problem hiding this comment.
Can you also add the excellent commit message as documentation here? It explains pretty good why this field is necessary and how it differs from message.
There was a problem hiding this comment.
Which part of the commit message exactly? I've tried to keep the comment generic enough since the implementation may change.
There was a problem hiding this comment.
This new addition makes sense, good job.
Dotty has its own logic for displaying problems with the proper file path, position, and caret, but if we store this information in Problem#message we end up with duplicated information in the output since Zinc will prepend/append similar things (see sbt.internal.inc.ProblemStringFormats). So far, we worked around this in Dotty by using an empty position in the sbt bridge reporter, but this means that crucial semantic information that could be used by a Build Server Protocol implementation and other tools is lost. This commit allows us to avoid by adding an optional `rendered` field to `Problem`: when this field is set, its value controls what the user sees, otherwise we fallback to the default behavior (the logic to do this will be added to Zinc after this PR is merged and a new release of sbt-util is made).
smarter
force-pushed
the
followup-range
branch
from
18269e6 to
15522a0
Compare
smarter
added a commit
to smarter/zinc
that referenced
this pull request
Aug 28, 2018
See sbt/util#175 for more information.
|
A validation involving this pull request is in progress... |
This comment has been minimized.
This comment has been minimized.
smarter
added a commit
to smarter/zinc
that referenced
this pull request
Aug 28, 2018
See sbt/util#175 for more information.
This comment has been minimized.
This comment has been minimized.
eed3si9n
approved these changes
Aug 29, 2018
|
The formatting was added in #174. I forgot to merge it. |
smarter
added a commit
to smarter/zinc
that referenced
this pull request
Aug 30, 2018
And bump util to 1.2.2 to include sbt/util#175
smarter
added a commit
to smarter/zinc
that referenced
this pull request
Aug 30, 2018
And bump util to 1.2.2 to include sbt/util#175
jvican
pushed a commit
to scalacenter/zinc
that referenced
this pull request
Dec 15, 2019
And bump util to 1.2.2 to include sbt/util#175
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.