Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify whitespace handling in linter and formatter #962

Merged
merged 1 commit into from
Mar 17, 2025
+59 −15
Merged

Unify whitespace handling in linter and formatter #962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions Sources/SwiftFormat/PrettyPrint/Comment.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,27 @@ extension StringProtocol {
/// - Returns: The string with trailing whitespace removed.
func trimmingTrailingWhitespace() -> String {
if isEmpty { return String() }
let scalars = unicodeScalars
var idx = scalars.index(before: scalars.endIndex)
while scalars[idx].properties.isWhitespace {
if idx == scalars.startIndex { return String() }
idx = scalars.index(before: idx)
let utf8Array = Array(utf8)
var idx = utf8Array.endIndex - 1
while utf8Array[idx].isWhitespace {
if idx == utf8Array.startIndex { return String() }
idx -= 1
}
return String(decoding: utf8Array[...idx], as: UTF8.self)
}
}
Comment on lines 22 to +32
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the formatter's whitespace criteria to match the linter's.
The formatter no longer considers characters like U+2028 as whitespace, so they will no longer be removed.

This change has no significant impact on performance.

.build/release/swift-format lint --measure-instructions --recursive /tmp/swift-syntax

before: 50321785572
after: 49557836028


extension UTF8.CodeUnit {
/// Checks if the UTF-8 code unit represents a whitespace character.
///
/// - Returns: `true` if the code unit represents a whitespace character, otherwise `false`.
var isWhitespace: Bool {
switch self {
case UInt8(ascii: " "), UInt8(ascii: "\n"), UInt8(ascii: "\t"), UInt8(ascii: "\r"), /*VT*/ 0x0B, /*FF*/ 0x0C:
return true
default:
return false
}
return String(String.UnicodeScalarView(scalars[...idx]))
}
}

Expand Down
10 changes: 1 addition & 9 deletions Sources/SwiftFormat/PrettyPrint/WhitespaceLinter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,16 +339,8 @@ public class WhitespaceLinter {
startingAt offset: Int,
in data: [UTF8.CodeUnit]
) -> ArraySlice<UTF8.CodeUnit> {
func isWhitespace(_ char: UTF8.CodeUnit) -> Bool {
switch char {
case UInt8(ascii: " "), UInt8(ascii: "\n"), UInt8(ascii: "\t"), UInt8(ascii: "\r"), /*VT*/ 0x0B, /*FF*/ 0x0C:
return true
default:
return false
}
}
guard
let whitespaceEnd = data[offset...].firstIndex(where: { !isWhitespace($0) })
let whitespaceEnd = data[offset...].firstIndex(where: { !$0.isWhitespace })
else {
return data[offset..<data.endIndex]
}
Expand Down
13 changes: 13 additions & 0 deletions Tests/SwiftFormatTests/PrettyPrint/CommentTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,4 +1094,17 @@ final class CommentTests: PrettyPrintTestCase {

assertPrettyPrintEqual(input: input, expected: input, linelength: 80)
}

func testUnexpectedUnicodeCharacters() {
let input =
"""
// Hello World\u{2028}
// Hello\u{20}\u{2028}World
// Hello World\u{2028}\u{2029}\u{2029}
// Hello World\u{20}\u{20}\u{20}\u{2028}

"""

assertPrettyPrintEqual(input: input, expected: input, linelength: 80)
}
}
25 changes: 25 additions & 0 deletions Tests/SwiftFormatTests/PrettyPrint/WhitespaceLintTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,4 +255,29 @@ final class WhitespaceLintTests: WhitespaceTestCase {
]
)
}

func testUnexpectedUnicodeCharacters() {
assertWhitespaceLint(
input: """
// Hello World\u{2028}
// Hello\u{20}\u{2028}World
// Hello World\u{2028}\u{2029}\u{2029}
// Hello World \u{2028}
// Hello World\u{2028}1️⃣\u{20}\u{20}\u{20}

""",
expected: """
// Hello World\u{2028}
// Hello\u{20}\u{2028}World
// Hello World\u{2028}\u{2029}\u{2029}
// Hello World \u{2028}
// Hello World\u{2028}

""",
linelength: 30,
findings: [
FindingSpec("1️⃣", message: "remove trailing whitespace")
]
)
}
}