Remove the legacy trivia workaround. #646
Conversation
|
cc @dylansturg This gets rid of some tech debt so in the future we won't run into issues with how SwiftSyntax's trivia differs from what swift-format expects it to be. |
| } else { | ||
| syntaxLocation = node?.startLocation(converter: context.sourceLocationConverter) | ||
| syntaxLocation = nil |
There was a problem hiding this comment.
Do you recall why node is optional? It seems weird to allow a finding without a location.
There was a problem hiding this comment.
If I remove the optionality here, we break OrderedImports where there are code paths that pass an optional TokenSyntax to this function.
From a quick glance, my guess is that those code paths only run when the token is actually non-nil, but untangling that is probably best done in a separate PR.
|
|
||
| // We treat block comments after the semicolon slightly differently from end-of-line | ||
| // comments. Assume that an end-of-line comment should stay on the same line when a | ||
| // semicolon is removed, but if we have something like `f(); /* blah */ g()`, assume that |
There was a problem hiding this comment.
Is there a test for this? It looks like the new test has the statement with a block comment on a line without any other statements.
There was a problem hiding this comment.
Good call, added a test.
This was added when SwiftSyntax changed its behavior regarding trailing trivia -- previously it was only whitespace but now it includes all trivia up to the next newline, including comments (block comments and end-of-line comments). This workaround rewrote trivia to correspond to the old layout before processing the syntax tree further so that we didn't have to overhaul all the rules at the time. However, it isn't good for long-term maintenance for swift-format to be written with assumptions about trivia that aren't consistent with how syntax trees Straight Outta The Parser are formed.
allevato
force-pushed
the
new-trivia-behavior
branch
from
de7370a
to
2556e08
Compare
This was added when SwiftSyntax changed its behavior regarding trailing trivia -- previously it was only whitespace but now it includes all trivia up to the next newline, including comments (block comments and end-of-line comments). This workaround rewrote trivia to correspond to the old layout before processing the syntax tree further so that we didn't have to overhaul all the rules at the time.
However, it isn't good for long-term maintenance for swift-format to be written with assumptions about trivia that aren't consistent with how syntax trees Straight Outta The Parser are formed.