Fix "escaped newline symbol" bug in CodeGeneration
module
#2468
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.
I stumbled upon a small bug by accident, and upon investigation, it appeared to have deep roots. Eventually, it warranted its own PR. The bug involved duplicating empty lines in the generated
SyntaxTraits
file after every// MARK: -
without documentation text.The file is generated based on
SyntaxTraitsFile
file ofCodeGeneration
module:In other parts of the module, similar situations are addressed using the "escaped newline" symbol: "". For instance, in the
ResultBuilderFile
file:So in this PR, I resolve the bug by employing the same approach. This not only enhances the consistency of the codebase but also serves as an elegant solution to the problem itself.
All the changes are confined to the
CodeGeneration
module and have no impact on the rest of theSwiftSyntax
library, making them safe to merge.