Update SwiftSyntax to latest development snapshot (realm#4759)

* Merge `spacedBinaryOperator` and `unspacedBinaryOperator`

* New contextual keyword enums

* Update for removed `UnavailabilityConditionSyntax`

* Handle how attributes are now defined

This partially reverts commit 325d0ee.

* Handle removal of `TokenListSyntax`

* Update `Package.swift`

* Extract some SwiftSyntax helpers

* Update to `0.50900.0-swift-DEVELOPMENT-SNAPSHOT-2023-02-06-a`

* Skip attributes with keypath arguments in `attributes` rule

To preserve the rule's existing behavior.

* Limit unowned_variable_capture violations to capture lists

* Add changelog entries

CHANGELOG.md

@@ -73,6 +73,16 @@
   [#3399](https://github.com/realm/SwiftLint/issues/3399)
   [#3605](https://github.com/realm/SwiftLint/issues/3605)
 
+* Speed up linting by up to 6% updating to use a newer version of
+  `SwiftSyntax`.  
+  [JP Simard](https://github.com/jpsim)
+
+* Catch more valid `legacy_multiple` violations.  
+  [JP Simard](https://github.com/jpsim)
+
+* Catch more valid `no_magic_numbers` violations.  
+  [JP Simard](https://github.com/jpsim)
+
 #### Bug Fixes
 
 * Report violations in all `<scope>_length` rules when the error threshold is
@@ -125,6 +135,10 @@
   [Mathias Schreck](https://github.com/lo1tuma)
   [#4772](https://github.com/realm/SwiftLint/issues/4772)
 
+* Fix false positives in `attributes` rule when using property wrappers
+  with keypath arguments.  
+  [JP Simard](https://github.com/jpsim)
+
 ## 0.50.3: Bundle of Towels
 
 #### Breaking

Package.resolved

@@ -32,8 +32,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/apple/swift-syntax.git",
       "state" : {
-        "revision" : "edd2d0cdb988ac45e2515e0dd0624e4a6de54a94",
-        "version" : "0.50800.0-SNAPSHOT-2022-12-29-a"
+        "revision" : "013a48e2312e57b7b355db25bd3ea75282ebf274",
+        "version" : "0.50900.0-swift-DEVELOPMENT-SNAPSHOT-2023-02-06-a"
       }
     },
     {

Package.swift

@@ -30,7 +30,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "1.2.1")),
-        .package(url: "https://github.com/apple/swift-syntax.git", exact: "0.50800.0-SNAPSHOT-2022-12-29-a"),
+        .package(url: "https://github.com/apple/swift-syntax.git", exact: "0.50900.0-swift-DEVELOPMENT-SNAPSHOT-2023-02-06-a"),
         .package(url: "https://github.com/jpsim/SourceKitten.git", .upToNextMinor(from: "0.34.0")),
         .package(url: "https://github.com/jpsim/Yams.git", from: "5.0.4"),
         .package(url: "https://github.com/scottrhoyt/SwiftyTextTable.git", from: "0.9.0"),

Source/SwiftLintFramework/Extensions/SwiftLintFile+BodyLineCount.swift

@@ -44,7 +44,9 @@ extension SwiftLintFile {
             .tokens(viewMode: .sourceAccurate)
             .reduce(into: []) { linesWithTokens, token in
                 if case .stringSegment = token.tokenKind {
-                    let sourceRange = token.withoutTrivia().sourceRange(converter: locationConverter)
+                    let sourceRange = token
+                        .trimmed
+                        .sourceRange(converter: locationConverter)
                     let startLine = sourceRange.start.line!
                     let endLine = sourceRange.end.line!
                     linesWithTokens.formUnion(startLine...endLine)

Source/SwiftLintFramework/Extensions/SwiftSyntax+SwiftLint.swift

@@ -8,7 +8,7 @@ extension SyntaxVisitor: SwiftLintSyntaxVisitor {}
 
 extension SwiftLintSyntaxVisitor {
     func walk<T, SyntaxType: SyntaxProtocol>(tree: SyntaxType, handler: (Self) -> T) -> T {
-        #if DEBUG
+#if DEBUG
         // workaround for stack overflow when running in debug
         // https://bugs.swift.org/browse/SR-11170
         let lock = NSLock()
@@ -31,10 +31,10 @@ extension SwiftLintSyntaxVisitor {
         }
 
         return handler(self)
-        #else
+#else
         walk(tree)
         return handler(self)
-        #endif
+#endif
     }
 
     func walk<T>(file: SwiftLintFile, handler: (Self) -> [T]) -> [T] {
@@ -107,35 +107,33 @@ extension StringLiteralExprSyntax {
 
 extension TokenKind {
     var isEqualityComparison: Bool {
-        self == .spacedBinaryOperator("==") ||
-            self == .spacedBinaryOperator("!=") ||
-            self == .unspacedBinaryOperator("==")
+        self == .binaryOperator("==") || self == .binaryOperator("!=")
     }
 }
 
 extension ModifierListSyntax? {
     var containsLazy: Bool {
-        contains(tokenKind: .contextualKeyword("lazy"))
+        contains(tokenKind: .keyword(.lazy))
     }
 
     var containsOverride: Bool {
-        contains(tokenKind: .contextualKeyword("override"))
+        contains(tokenKind: .keyword(.override))
     }
 
     var containsStaticOrClass: Bool {
         isStatic || isClass
     }
 
     var isStatic: Bool {
-        contains(tokenKind: .staticKeyword)
+        contains(tokenKind: .keyword(.static))
     }
 
     var isClass: Bool {
-        contains(tokenKind: .classKeyword)
+        contains(tokenKind: .keyword(.class))
     }
 
     var isFileprivate: Bool {
-        contains(tokenKind: .fileprivateKeyword)
+        contains(tokenKind: .keyword(.fileprivate))
     }
 
     var isPrivateOrFileprivate: Bool {
@@ -144,13 +142,13 @@ extension ModifierListSyntax? {
         }
 
         return modifiers.contains { elem in
-            (elem.name.tokenKind == .privateKeyword || elem.name.tokenKind == .fileprivateKeyword) &&
+            (elem.name.tokenKind == .keyword(.private) || elem.name.tokenKind == .keyword(.fileprivate)) &&
                 elem.detail == nil
         }
     }
 
     var isFinal: Bool {
-        contains(tokenKind: .contextualKeyword("final"))
+        contains(tokenKind: .keyword(.final))
     }
 
     private func contains(tokenKind: TokenKind) -> Bool {
@@ -162,17 +160,34 @@ extension ModifierListSyntax? {
     }
 }
 
+extension AttributeSyntax {
+    var attributeNameText: String {
+        attributeName.as(SimpleTypeIdentifierSyntax.self)?.name.text ??
+            attributeName.description
+    }
+}
+
+extension AttributeListSyntax? {
+    func contains(attributeNamed attributeName: String) -> Bool {
+        self?.contains { $0.as(AttributeSyntax.self)?.attributeNameText == attributeName } == true
+    }
+}
+
+extension TokenKind {
+    var isUnavailableKeyword: Bool {
+        self == .keyword(.unavailable) || self == .identifier("unavailable")
+    }
+}
+
 extension VariableDeclSyntax {
     var isIBOutlet: Bool {
-        attributes?.contains { attr in
-            attr.as(AttributeSyntax.self)?.attributeName.tokenKind == .identifier("IBOutlet")
-        } ?? false
+        attributes.contains(attributeNamed: "IBOutlet")
     }
 
     var weakOrUnownedModifier: DeclModifierSyntax? {
         modifiers?.first { decl in
-            decl.name.tokenKind == .contextualKeyword("weak") ||
-                decl.name.tokenKind == .contextualKeyword("unowned")
+            decl.name.tokenKind == .keyword(.weak) ||
+                decl.name.tokenKind == .keyword(.unowned)
         }
     }
 
@@ -207,9 +222,7 @@ public extension EnumDeclSyntax {
 
 extension FunctionDeclSyntax {
     var isIBAction: Bool {
-        attributes?.contains { attr in
-            attr.as(AttributeSyntax.self)?.attributeName.tokenKind == .identifier("IBAction")
-        } ?? false
+        attributes.contains(attributeNamed: "IBAction")
     }
 
     /// Returns the signature including arguments, e.g "setEditing(_:animated:)"
@@ -241,13 +254,13 @@ extension FunctionDeclSyntax {
 extension AccessorBlockSyntax {
     var getAccessor: AccessorDeclSyntax? {
         accessors.first { accessor in
-            accessor.accessorKind.tokenKind == .contextualKeyword("get")
+            accessor.accessorKind.tokenKind == .keyword(.get)
         }
     }
 
     var setAccessor: AccessorDeclSyntax? {
         accessors.first { accessor in
-            accessor.accessorKind.tokenKind == .contextualKeyword("set")
+            accessor.accessorKind.tokenKind == .keyword(.set)
         }
     }
 

Source/SwiftLintFramework/Helpers/LegacyFunctionRuleHelper.swift

@@ -62,7 +62,7 @@ enum LegacyFunctionRuleHelper {
 
             correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
 
-            let trimmedArguments = node.argumentList.map { $0.trimmed() }
+            let trimmedArguments = node.argumentList.map { $0.trimmingTrailingComma() }
             let rewriteStrategy = legacyFunctions[funcName]
 
             let expr: ExprSyntax
@@ -82,8 +82,8 @@ enum LegacyFunctionRuleHelper {
             }
 
             return expr
-                .withLeadingTrivia(node.leadingTrivia ?? .zero)
-                .withTrailingTrivia(node.trailingTrivia ?? .zero)
+                .with(\.leadingTrivia, node.leadingTrivia ?? .zero)
+                .with(\.trailingTrivia, node.trailingTrivia ?? .zero)
         }
     }
 }
@@ -103,10 +103,7 @@ private extension FunctionCallExprSyntax {
 }
 
 private extension TupleExprElementSyntax {
-    func trimmed() -> TupleExprElementSyntax {
-        self
-            .withoutTrivia()
-            .withTrailingComma(nil)
-            .withoutTrivia()
+    func trimmingTrailingComma() -> TupleExprElementSyntax {
+        self.trimmed.with(\.trailingComma, nil).trimmed
     }
 }

Source/SwiftLintFramework/Rules/Idiomatic/BlockBasedKVORule.swift

@@ -53,7 +53,7 @@ private extension BlockBasedKVORule {
             }
 
             let types = parameterList
-                .compactMap { $0.type?.withoutTrivia().description.replacingOccurrences(of: " ", with: "") }
+                .compactMap { $0.type?.trimmedDescription.replacingOccurrences(of: " ", with: "") }
             let firstTypes = ["String?", "Any?", "[NSKeyValueChangeKey:Any]?", "UnsafeMutableRawPointer?"]
             let secondTypes = ["String?", "Any?", "Dictionary<NSKeyValueChangeKey,Any>?", "UnsafeMutableRawPointer?"]
             if types == firstTypes || types == secondTypes {

Source/SwiftLintFramework/Rules/Idiomatic/ConvenienceTypeRule.swift

@@ -198,15 +198,11 @@ private extension TypeInheritanceClauseSyntax? {
 
 private extension AttributeListSyntax? {
     var containsObjcMembers: Bool {
-        self?.contains { elem in
-            elem.as(AttributeSyntax.self)?.attributeName.tokenKind == .identifier("objcMembers")
-        } ?? false
+        contains(attributeNamed: "objcMembers")
     }
 
     var containsObjc: Bool {
-        self?.contains { elem in
-            elem.as(AttributeSyntax.self)?.attributeName.tokenKind == .contextualKeyword("objc")
-        } ?? false
+        contains(attributeNamed: "objc")
     }
 }
 
@@ -218,12 +214,12 @@ private extension AttributeListSyntax? {
 
         return attrs.contains { elem in
             guard let attr = elem.as(AttributeSyntax.self),
-                    let arguments = attr.argument?.as(AvailabilitySpecListSyntax.self) else {
+                  let arguments = attr.argument?.as(AvailabilitySpecListSyntax.self) else {
                 return false
             }
 
-            return attr.attributeName.tokenKind == .contextualKeyword("available") && arguments.contains { arg in
-                arg.entry.as(TokenSyntax.self)?.tokenKind == .contextualKeyword("unavailable")
+            return attr.attributeNameText == "available" && arguments.contains { arg in
+                arg.entry.as(TokenSyntax.self)?.tokenKind.isUnavailableKeyword == true
             }
         }
     }

Source/SwiftLintFramework/Rules/Idiomatic/DiscouragedAssertRule.swift

@@ -39,11 +39,11 @@ struct DiscouragedAssertRule: SwiftSyntaxRule, OptInRule, ConfigurationProviderR
 private extension DiscouragedAssertRule {
     final class Visitor: ViolationsSyntaxVisitor {
         override func visitPost(_ node: FunctionCallExprSyntax) {
-            guard node.calledExpression.as(IdentifierExprSyntax.self)?.identifier.withoutTrivia().text == "assert",
+            guard node.calledExpression.as(IdentifierExprSyntax.self)?.identifier.text == "assert",
                   let firstArg = node.argumentList.first,
                   firstArg.label == nil,
                   let boolExpr = firstArg.expression.as(BooleanLiteralExprSyntax.self),
-                  boolExpr.booleanLiteral.tokenKind == .falseKeyword else {
+                  boolExpr.booleanLiteral.tokenKind == .keyword(.false) else {
                 return
             }
 

Source/SwiftLintFramework/Rules/Idiomatic/ExplicitInitRule.swift

@@ -218,7 +218,8 @@ private extension ExplicitInitRule {
             }
 
             correctionPositions.append(violationPosition)
-            return super.visit(node.withCalledExpression("\(calledBase.withoutTrivia())"))
+            let newNode = node.with(\.calledExpression, calledBase.trimmed)
+            return super.visit(newNode)
         }
     }
 }

Source/SwiftLintFramework/Rules/Idiomatic/ExplicitTopLevelACLRule.swift

@@ -108,11 +108,11 @@ private extension ExplicitTopLevelACLRule {
 private extension DeclModifierSyntax {
     var isACLModifier: Bool {
         let aclModifiers: Set<TokenKind> = [
-            .privateKeyword,
-            .fileprivateKeyword,
-            .internalKeyword,
-            .publicKeyword,
-            .contextualKeyword("open")
+            .keyword(.private),
+            .keyword(.fileprivate),
+            .keyword(.internal),
+            .keyword(.public),
+            .keyword(.open)
         ]
 
         return detail == nil && aclModifiers.contains(name.tokenKind)

Source/SwiftLintFramework/Rules/Idiomatic/ExplicitTypeInterfaceRule.swift

@@ -132,7 +132,7 @@ private extension InitializerClauseSyntax {
     }
 
     var isTypeReference: Bool {
-        value.as(MemberAccessExprSyntax.self)?.name.tokenKind == .selfKeyword
+        value.as(MemberAccessExprSyntax.self)?.name.tokenKind == .keyword(.self)
     }
 }
 

Source/SwiftLintFramework/Rules/Idiomatic/FatalErrorMessageRule.swift

@@ -45,7 +45,7 @@ private extension FatalErrorMessageRule {
     final class Visitor: ViolationsSyntaxVisitor {
         override func visitPost(_ node: FunctionCallExprSyntax) {
             guard let expression = node.calledExpression.as(IdentifierExprSyntax.self),
-                  expression.identifier.withoutTrivia().text == "fatalError",
+                  expression.identifier.text == "fatalError",
                 node.argumentList.isEmptyOrEmptyString else {
                 return
             }

Source/SwiftLintFramework/Rules/Idiomatic/FileNameRule.swift

@@ -87,6 +87,6 @@ private class TypeNameCollectingVisitor: SyntaxVisitor {
     }
 
     override func visitPost(_ node: ExtensionDeclSyntax) {
-        names.insert(node.extendedType.withoutTrivia().description)
+        names.insert(node.extendedType.trimmedDescription)
     }
 }

Source/SwiftLintFramework/Rules/Idiomatic/ForWhereRule.swift

@@ -134,26 +134,26 @@ private extension ForWhereRule {
 
         override func visitPost(_ node: ForInStmtSyntax) {
             guard node.whereClause == nil,
-                  case let statements = node.body.statements,
-                  let ifStatement = statements.onlyElement?.item.as(IfStmtSyntax.self),
-                  ifStatement.elseBody == nil,
-                  !ifStatement.containsOptionalBinding,
-                  !ifStatement.containsPatternCondition,
-                  let condition = ifStatement.conditions.onlyElement,
+                  let onlyExprStmt = node.body.statements.onlyElement?.item.as(ExpressionStmtSyntax.self),
+                  let ifExpr = onlyExprStmt.expression.as(IfExprSyntax.self),
+                  ifExpr.elseBody == nil,
+                  !ifExpr.containsOptionalBinding,
+                  !ifExpr.containsPatternCondition,
+                  let condition = ifExpr.conditions.onlyElement,
                   !condition.containsMultipleConditions else {
                 return
             }
 
-            if allowForAsFilter, ifStatement.containsReturnStatement {
+            if allowForAsFilter, ifExpr.containsReturnStatement {
                 return
             }
 
-            violations.append(ifStatement.positionAfterSkippingLeadingTrivia)
+            violations.append(ifExpr.positionAfterSkippingLeadingTrivia)
         }
     }
 }
 
-private extension IfStmtSyntax {
+private extension IfExprSyntax {
     var containsOptionalBinding: Bool {
         conditions.contains { element in
             element.condition.is(OptionalBindingConditionSyntax.self)

Source/SwiftLintFramework/Rules/Idiomatic/FunctionDefaultParameterAtEndRule.swift

@@ -129,8 +129,6 @@ private extension FunctionParameterSyntax {
             return false
         }
 
-        return attrType.attributes?.contains { attr in
-            attr.as(AttributeSyntax.self)?.attributeName.tokenKind == .identifier("escaping")
-        } ?? false
+        return attrType.attributes.contains(attributeNamed: "escaping")
     }
 }