feat: update Problem to account for related information and code #6871
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
16 tasks
smarter
reviewed
Apr 11, 2022
smarter
reviewed
Apr 11, 2022
internal/util-interface/src/main/java/xsbti/DiagnosticRelatedInformation.java
Outdated
Show resolved
Hide resolved
smarter
reviewed
Apr 11, 2022
internal/util-interface/src/main/java/xsbti/DiagnosticRelatedInformation.java
Outdated
Show resolved
Hide resolved
smarter
reviewed
Apr 11, 2022
smarter
reviewed
Apr 11, 2022
| * <p>NOTE: To avoid breaking compatibility we provide a default to account for older Scala | ||
| * version that do not have codes. | ||
| */ | ||
| default Optional<DiagnosticCode> diagnosticCode() { |
There was a problem hiding this comment.
Is this enough information to get sbt to produce errors that look like what dotty natively produce without us having to pass in a rendered string? That would help solve scala/scala3#14691
|
@ckipp01 Thanks for the contribution. Could you target 1.7.x branch instead which runs mima, plz? |
This PR makes changes to the existing `xsbti.Problem` to account for an
optional diagnostic code that the compiler can return for a given
diagnostic and also related information.
Given a piece of code like:
```scala
try {}
```
You'll receive the following:
```
-- [E002] Syntax Warning: /Users/ckipp/Documents/scala-workspace/dotty-error-index/examples/002_EmptyCatchAndFinallyBlockID.scala:3:2
3 | try {}
| ^^^^^^
| A try without catch or finally is equivalent to putting
| its body in a block; no exceptions are handled.
```
The `E002` here is the actual code. Right now there would be no
description.
Some diagnostics have multiple positions that they need to represent.
You can see an example of this
[here](scala/scala3#14002) in Dotty with the
use of inlining. Instead of needing to rely on including all of that
information in the diagnostic message it can now be extracted out into
a `DiagnosticRelatedInformation`.
These changes reference the conversation in sbt#6868
Sure, the rebase isn't clean, so it's just easier for me to close and open another. I'll go ahead and do that. |
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 PR makes changes to the existing
xsbti.Problemto account for anoptional diagnostic code that the compiler can return for a given
diagnostic and also related information.
Example of
DiagnosticCodeGiven a piece of code like:
try {}You'll receive the following:
The
E002here is the actual code. Right now there would be nodescription.
Example of
DiagnosticRelatedInformationSome diagnostics have multiple positions that they need to represent.
You can see an example of this
here in Dotty with the
use of inlining. Instead of needing to rely on including all of that
information in the diagnostic message it can now be extracted out into
a
DiagnosticRelatedInformation.These changes reference the conversation in #6868