Improved diagnostic rendering #42236
Draft
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
|
|
RadCod3
force-pushed
the
improved-diagnostic-rendering
branch
from
bc654cc
to
4fa5982
Compare
poorna2152
reviewed
Feb 28, 2024
cli/ballerina-cli/src/main/java/io/ballerina/cli/task/CompileTask.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/task/CompileTask.java
Outdated
Show resolved
Hide resolved
poorna2152
reviewed
Feb 28, 2024
cli/ballerina-cli/src/main/java/io/ballerina/cli/task/CompileTask.java
Outdated
Show resolved
Hide resolved
poorna2152
reviewed
Feb 28, 2024
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
poorna2152
reviewed
Feb 28, 2024
...arser/src/main/java/io/ballerina/compiler/internal/diagnostics/StringDiagnosticProperty.java
Show resolved
Hide resolved
poorna2152
reviewed
Feb 28, 2024
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/task/CompileTask.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/task/CompileTask.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/DiagnosticAnnotation.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/DiagnosticAnnotation.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/utils/DiagnosticAnnotation.java
Outdated
Show resolved
Hide resolved
RadCod3
force-pushed
the
improved-diagnostic-rendering
branch
2 times, most recently
from
7e60e7e
to
c6fabf7
Compare
nipunayf
added
the
Team/CompilerFE
RadCod3
force-pushed
the
improved-diagnostic-rendering
branch
2 times, most recently
from
8c1e4d1
to
d20fec1
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #42236 +/- ##
============================================
- Coverage 76.80% 76.60% -0.20%
+ Complexity 53972 53574 -398
============================================
Files 2924 2908 -16
Lines 203952 202367 -1585
Branches 26597 26354 -243
============================================
- Hits 156638 155028 -1610
- Misses 38777 38846 +69
+ Partials 8537 8493 -44 ☔ View full report in Codecov by Sentry. |
...src/test/resources/test-resources/diagnostics-test-files/bal-project-error/project2/main.bal
Outdated
Show resolved
Hide resolved
prakanth97
reviewed
Apr 24, 2024
cli/ballerina-cli/src/main/java/io/ballerina/cli/diagnostics/AnnotateDiagnostics.java
Outdated
Show resolved
Hide resolved
poorna2152
reviewed
Apr 26, 2024
cli/ballerina-cli/src/test/java/io/ballerina/cli/diagnostics/AnnotateDiagnosticsTest.java
Outdated
Show resolved
Hide resolved
Shifted from string concatenation to string builders. Combined some common login in DiagnosticAnnotation for when lines are hidden and not hidden in the multi-line diagnostic case. Also made the amount of lines to be shown before we start hiding lines configurable.
|
This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the |
|
This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the |
cli/ballerina-cli/src/main/java/io/ballerina/cli/diagnostics/DiagnosticAnnotation.java
Outdated
Show resolved
Hide resolved
cli/ballerina-cli/src/main/java/io/ballerina/cli/diagnostics/DiagnosticAnnotation.java
Outdated
Show resolved
Hide resolved
|
This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the |
|
Closed PR due to inactivity for more than 18 days. |
Comment on lines
+6
to
+10
| if (a < 0) { | ||
| return 0; | ||
| } else (b < 0) { | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
Suggested change
| if (a < 0) { | |
| return 0; | |
| } else (b < 0) { | |
| return 0; | |
| } | |
| if (a < 0 || b < 0) { | |
| return 0; | |
| } |
| private static final String INTERNAL_COLOR = "blue"; | ||
| private static final String HINT_COLOR = "green"; | ||
| private static final String INFO_COLOR = "blue"; | ||
| private static final String WARNING_COLOR = "yellow"; |
There was a problem hiding this comment.
another option to use orange
| private static int countTabChars(String line, int end) { | ||
| int count = 0; | ||
| for (int i = 0; i < end; i++) { | ||
| if (line.charAt(i) == '\t') { |
There was a problem hiding this comment.
Can define this as a constant and use
Co-authored-by: Felix Schnabel <[email protected]>
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.
Purpose
The purpose of this PR is to introduce an enhanced diagnostic rendering feature to the Ballerina compiler, aligning it with the standards set by the Rustc compiler. We do this by providing users with more informative and user-friendly error messages.
This addresses task 1 of #42124.
Approach
I've created a separate class to use
Diagnosticobjects and output a better error message. This is to maintain compatibility with anything else that depends on the current diagnostic implementations. Furthermore, I've used a bumped up version of jline to access a library called jansi which was merged into jline, for cross platform supported ANSI rendering.Information about what token is indeed missing was passed using the
properties()function inSyntaxDiagnostic.java.Samples
Missing tokens and keywords
These type of errors are rendered as below,
The
+symbol represents that it should be newly added.Invalid tokens
Invalid tokens are highlighted in red in addition to being pointed by a
^symbol.Other errors
Other errors in general are underlined by
^symbols.Multi-lined diagnostics are rendered as below. If it's more than 2 lines, the lines in between are hidden.
Remarks
@|...|@used in the code are the syntax used by jansi to render the correct ANSI escape codes. See jansi/AnsiRenderer.Check List