Improve debug description of syntax nodes #1503
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
Member
|
Beautiful! |
DougGregor
approved these changes
Apr 7, 2023
bnbarham
approved these changes
Apr 7, 2023
Contributor
bnbarham
left a comment
bnbarham
left a comment
There was a problem hiding this comment.
−3,206
Aw yeah, that's what I like to see!
ahoppen
force-pushed
the
ahoppen/better-debug-description
branch
from
2836eec to
4eb805c
Compare
Member
Author
|
@swift-ci Please test |
kimdv
approved these changes
Apr 8, 2023
kimdv
approved these changes
Apr 8, 2023
Member
Author
|
@swift-ci Please test |
rintaro
approved these changes
Apr 9, 2023
ahoppen
added a commit
to ahoppen/swift
that referenced
this pull request
Apr 12, 2023
…favor of debugDescription Companion of swiftlang/swift-syntax#1503
ahoppen
force-pushed
the
ahoppen/better-debug-description
branch
from
4eb805c to
7a02b13
Compare
Member
Author
|
@swift-ci Please test |
Member
Author
|
@swift-ci Please test Windows |
This improves the description generated by the `debugDescription` function to something like the following which is easier to read IMO
```
SourceFileSyntax
├─CodeBlockItemListSyntax
│ ╰─CodeBlockItemSyntax
│ ╰─MacroExpansionExprSyntax
│ ├─pound
│ ├─identifier("stringify")
│ ├─leftParen
│ ├─TupleExprElementListSyntax
│ │ ╰─TupleExprElementSyntax
│ │ ╰─InfixOperatorExprSyntax
│ │ ├─IntegerLiteralExprSyntax
│ │ │ ╰─integerLiteral("2")
│ │ ├─BinaryOperatorExprSyntax
│ │ │ ╰─binaryOperator("+")
│ │ ╰─IntegerLiteralExprSyntax
│ │ ╰─integerLiteral("3")
│ ╰─rightParen
╰─eof
```
Since we now have this nice representation, it also removes the conformances to `CustomReflectable` (deleting 3000 lines of code :hooray:) and doing some new `CustomReflectable` hackery to make the debugger just print `debugDescription` and not try to print the node’s children itself. This way you an now do `po node` in the debugger to get the debug description from above, instead of having to do `e print(node.recursiveDescription)`
ahoppen
force-pushed
the
ahoppen/better-debug-description
branch
from
7a02b13 to
e618702
Compare
Contributor
|
@swift-ci please test |
Member
Author
|
@swift-ci Please test macOS |
Member
Author
|
@swift-ci Please test Windows |
ahoppen
added a commit
to ahoppen/swift-syntax
that referenced
this pull request
Apr 18, 2023
…escription Improve debug description of syntax nodes
ahoppen
added a commit
to ahoppen/swift-syntax
that referenced
this pull request
Apr 18, 2023
…escription Improve debug description of syntax nodes
ahoppen
added a commit
to ahoppen/swift
that referenced
this pull request
Apr 19, 2023
…favor of debugDescription Companion of swiftlang/swift-syntax#1503
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 improves the description generated by the
debugDescriptionfunction to something like the following which is easier to read IMOSince we now have this nice representation, it also removes the conformances to
CustomReflectable(deleting 3000 lines of code 🎉 ) and doing some newCustomReflectablehackery to make the debugger just printdebugDescriptionand not try to print the node’s children itself. This way you an now dopo nodein the debugger to get the debug description from above, instead of having to doe print(node.recursiveDescription)