Add commentValue property to Trivia for cleaned comments
#2966
Conversation
- Copied changes from PR swiftlang#2578 (swiftlang#2578) - Original work by @adammcarter - Manual copy due to inaccessible original branch
zyadtaha
force-pushed
the
trivia-piece-comment-value
branch
from
3ad450f to
c23e3dc
Compare
|
Thanks for the feedback, @ahoppen! I've addressed the comments—let me know if anything else needs attention. |
Add release note for Trivia.commentValue Address PR review Address second review
zyadtaha
force-pushed
the
trivia-piece-comment-value
branch
from
c23e3dc to
04f700e
Compare
|
Hey @ahoppen, just wanted to check if there's anything else needed from my side on this PR. Let me know if you have any concerns. Thanks! |
|
|
||
| // Helper function to trim leading and trailing newlines | ||
| func trimNewlines(_ text: String) -> String { | ||
| let trimmed = text.drop(while: { $0 == "\n" }) |
There was a problem hiding this comment.
You should also cover \r\n (Windows-style newlines) here as well.
| func processBlockComment(_ text: String, prefix: String, suffix: String) -> String { | ||
| var text = text | ||
| text.removeFirst(prefix.count) | ||
| text.removeLast(suffix.count) |
There was a problem hiding this comment.
We can’t generally assume that the comment will end with */. For example, if you have a source file with an unterminated block comment, the end of file token will have the block comment as trivia but that trivia doesn’t end with */.
|
|
||
| // Helper function to process multiline block comments | ||
| func processMultilineBlockComment(_ text: String) -> String { | ||
| var lines = text.split(separator: "\n", omittingEmptySubsequences: false).map(String.init) |
There was a problem hiding this comment.
Could you avoid constructing String here and instead work on Substring. Substring avoids memory allocations and is thus more performant.
| let minIndentation = | ||
| lines | ||
| .filter { !$0.isEmpty } | ||
| .map { $0.prefix { $0 == " " }.count } |
There was a problem hiding this comment.
I guess we should also handle tabs as indentation.
| return text | ||
| } | ||
|
|
||
| // Helper function to process multiline block comments |
There was a problem hiding this comment.
Could you be a little more specific in the comment what this function does? As it stands right now, the comment doesn’t really add any value, it just rephrases the function name.
| lines.removeLast() | ||
| } else { | ||
| lines[lines.count - 1].removeLast(2) | ||
| lines[lines.count - 1] = trimWhitespace(lines[lines.count - 1]) |
There was a problem hiding this comment.
This removes all whitespace from the last line, not just minIndentation, right?
Actually, on second reading, does their trim whitespace and then drop the prefix again in the map below, potentially removing contents of the comment?
| text.hasPrefix("/*\n") | ||
| ? processMultilineBlockComment(text) | ||
| : processBlockComment(text, prefix: "/*", suffix: "*/") |
There was a problem hiding this comment.
I don’t think we need a general distinction here. Say if you have
/* abc
def
ghi
*/
We should still be able to strip the indentation. We just need to exclude the first line from the indentation stripping.
| @@ -42,6 +42,112 @@ public struct Trivia: Sendable { | |||
| pieces.isEmpty | |||
| } | |||
|
|
|||
| /// The string contents of all the comment pieces with any comments tokens trimmed. | |||
| public var commentValue: String { | |||
| var comments = [String]() | |||
There was a problem hiding this comment.
Could this be an array of Substring instead of String to avoid intermediate memory allocations for the comment value pieces?
This PR continues the work from #2578, addressing the review comments and refining the behavior of
Trivia.commentValue.