Added a formatter to pretty print diagnostics #874
Merged
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
flashspys
commented
Oct 2, 2022
flashspys
force-pushed
the
diagnostics-formatter
branch
from
a1b1415 to
e043a9b
Compare
DougGregor
reviewed
Oct 3, 2022
DougGregor
reviewed
Oct 3, 2022
|
This looks great! |
|
@swift-ci please test |
ahoppen
reviewed
Oct 4, 2022
ahoppen
reviewed
Oct 4, 2022
ahoppen
reviewed
Oct 4, 2022
|
|
||
| /// Print given diagnostics for a given syntax tree on the command line | ||
| public static func annotatedSource(tree: SourceFileSyntax, diags: [Diagnostic]) -> String { | ||
|
|
|
@ahoppen I've added some test cases, and fixed the first bug 😊 |
ahoppen
reviewed
Oct 5, 2022
| // | ||
| //===----------------------------------------------------------------------===// | ||
| import XCTest | ||
| @_spi(Testing) import SwiftDiagnostics |
There was a problem hiding this comment.
I don’t think this needs to be @_spi(Testing) because we don’t have any types or functions in SwiftDiagnostics annotated with @_spi(Testing)
Update DiagnosticsFormatter.swift Use correct fileheader typo simplify if statement Applied QA Remove old diagnostics printing Applied QA Remove superfluous line Update Sources/SwiftDiagnostics/DiagnosticsFormatter.swift Co-authored-by: Alex Hoppen <[email protected]> Add some test cases Remove unnecessary @spi_
flashspys
force-pushed
the
diagnostics-formatter
branch
from
e7c04b7 to
34c67ee
Compare
|
@swift-ci Please test |
3 tasks
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.
Hello swift-syntax team 👋,
in my first PR for this project I want to add a diagnostics formatter to this project. The output from
swift-parser-test print-diagswas not very pretty:With this PR the output will look like the following:
Currently, the formatter will print any number of error messages next to the original source lines. It is already even capable of printing only affected lines in bigger files, including some context:
In future pull request I want to add more functionality to this, including colored output and display of hints, fixits and notes.