Upgrade the DontRepeatTypeInStaticProperties rule.

- Using the `visit` method to examine all the variable declarations
  should allow specific decls to be ignored.
- Update the PipelineGenerator to call `visitPost` methods
- Modify the PipelineGenerator to produce output matching the current
  generated files.

Author: shawnhyam

Documentation/RuleDocumentation.md

@@ -4,7 +4,7 @@
 
 Use the rules below in the `rules` block of your `.swift-format`
 configuration file, as described in
-[Configuration](Configuration.md). All of these rules can be
+[Configuration](Documentation/Configuration.md). All of these rules can be
 applied in the linter, but only some of them can format your source code
 automatically.
 

Sources/SwiftFormat/Core/LintPipeline.swift

@@ -65,6 +65,13 @@ extension LintPipeline {
   /// - Parameters:
   ///   - rule: The type of the syntax rule we're cleaning up.
   ///   - node: The syntax node htat our traversal has left.
+  func visitPost<Rule: SyntaxLintRule, Node: SyntaxProtocol>(
+    _ visitPost: (Rule) -> (Node) -> Void, for node: Node
+  ) {
+    guard context.shouldFormat(Rule.self, node: Syntax(node)) else { return }
+    let rule = self.rule(Rule.self)
+    visitPost(rule)(node)
+  }
   func onVisitPost<R: Rule, Node: SyntaxProtocol>(
     rule: R.Type, for node: Node
   ) {

Sources/SwiftFormat/Core/Pipelines+Generated.swift

@@ -76,17 +76,16 @@ class LintPipeline: SyntaxVisitor {
     visitIfEnabled(AllPublicDeclarationsHaveDocumentation.visit, for: node)
     visitIfEnabled(AlwaysUseLowerCamelCase.visit, for: node)
     visitIfEnabled(BeginDocumentationCommentWithOneLineSummary.visit, for: node)
-    visitIfEnabled(DontRepeatTypeInStaticProperties.visit, for: node)
     visitIfEnabled(NoLeadingUnderscores.visit, for: node)
     visitIfEnabled(TypeNamesShouldBeCapitalized.visit, for: node)
     visitIfEnabled(UseTripleSlashForDocumentationComments.visit, for: node)
     return .visitChildren
   }
   override func visitPost(_ node: ClassDeclSyntax) {
     onVisitPost(rule: AllPublicDeclarationsHaveDocumentation.self, for: node)
+    visitPost(AlwaysUseLowerCamelCase.visitPost, for: node)
     onVisitPost(rule: AlwaysUseLowerCamelCase.self, for: node)
     onVisitPost(rule: BeginDocumentationCommentWithOneLineSummary.self, for: node)
-    onVisitPost(rule: DontRepeatTypeInStaticProperties.self, for: node)
     onVisitPost(rule: NoLeadingUnderscores.self, for: node)
     onVisitPost(rule: TypeNamesShouldBeCapitalized.self, for: node)
     onVisitPost(rule: UseTripleSlashForDocumentationComments.self, for: node)
@@ -182,7 +181,6 @@ class LintPipeline: SyntaxVisitor {
 
   override func visit(_ node: EnumDeclSyntax) -> SyntaxVisitorContinueKind {
     visitIfEnabled(BeginDocumentationCommentWithOneLineSummary.visit, for: node)
-    visitIfEnabled(DontRepeatTypeInStaticProperties.visit, for: node)
     visitIfEnabled(FullyIndirectEnum.visit, for: node)
     visitIfEnabled(NoLeadingUnderscores.visit, for: node)
     visitIfEnabled(OneCasePerLine.visit, for: node)
@@ -192,7 +190,6 @@ class LintPipeline: SyntaxVisitor {
   }
   override func visitPost(_ node: EnumDeclSyntax) {
     onVisitPost(rule: BeginDocumentationCommentWithOneLineSummary.self, for: node)
-    onVisitPost(rule: DontRepeatTypeInStaticProperties.self, for: node)
     onVisitPost(rule: FullyIndirectEnum.self, for: node)
     onVisitPost(rule: NoLeadingUnderscores.self, for: node)
     onVisitPost(rule: OneCasePerLine.self, for: node)
@@ -202,14 +199,12 @@ class LintPipeline: SyntaxVisitor {
 
   override func visit(_ node: ExtensionDeclSyntax) -> SyntaxVisitorContinueKind {
     visitIfEnabled(AvoidRetroactiveConformances.visit, for: node)
-    visitIfEnabled(DontRepeatTypeInStaticProperties.visit, for: node)
     visitIfEnabled(NoAccessLevelOnExtensionDeclaration.visit, for: node)
     visitIfEnabled(UseTripleSlashForDocumentationComments.visit, for: node)
     return .visitChildren
   }
   override func visitPost(_ node: ExtensionDeclSyntax) {
     onVisitPost(rule: AvoidRetroactiveConformances.self, for: node)
-    onVisitPost(rule: DontRepeatTypeInStaticProperties.self, for: node)
     onVisitPost(rule: NoAccessLevelOnExtensionDeclaration.self, for: node)
     onVisitPost(rule: UseTripleSlashForDocumentationComments.self, for: node)
   }
@@ -423,7 +418,6 @@ class LintPipeline: SyntaxVisitor {
   override func visit(_ node: ProtocolDeclSyntax) -> SyntaxVisitorContinueKind {
     visitIfEnabled(AllPublicDeclarationsHaveDocumentation.visit, for: node)
     visitIfEnabled(BeginDocumentationCommentWithOneLineSummary.visit, for: node)
-    visitIfEnabled(DontRepeatTypeInStaticProperties.visit, for: node)
     visitIfEnabled(NoLeadingUnderscores.visit, for: node)
     visitIfEnabled(TypeNamesShouldBeCapitalized.visit, for: node)
     visitIfEnabled(UseTripleSlashForDocumentationComments.visit, for: node)
@@ -432,7 +426,6 @@ class LintPipeline: SyntaxVisitor {
   override func visitPost(_ node: ProtocolDeclSyntax) {
     onVisitPost(rule: AllPublicDeclarationsHaveDocumentation.self, for: node)
     onVisitPost(rule: BeginDocumentationCommentWithOneLineSummary.self, for: node)
-    onVisitPost(rule: DontRepeatTypeInStaticProperties.self, for: node)
     onVisitPost(rule: NoLeadingUnderscores.self, for: node)
     onVisitPost(rule: TypeNamesShouldBeCapitalized.self, for: node)
     onVisitPost(rule: UseTripleSlashForDocumentationComments.self, for: node)
@@ -469,7 +462,6 @@ class LintPipeline: SyntaxVisitor {
   override func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind {
     visitIfEnabled(AllPublicDeclarationsHaveDocumentation.visit, for: node)
     visitIfEnabled(BeginDocumentationCommentWithOneLineSummary.visit, for: node)
-    visitIfEnabled(DontRepeatTypeInStaticProperties.visit, for: node)
     visitIfEnabled(NoLeadingUnderscores.visit, for: node)
     visitIfEnabled(TypeNamesShouldBeCapitalized.visit, for: node)
     visitIfEnabled(UseSynthesizedInitializer.visit, for: node)
@@ -479,7 +471,6 @@ class LintPipeline: SyntaxVisitor {
   override func visitPost(_ node: StructDeclSyntax) {
     onVisitPost(rule: AllPublicDeclarationsHaveDocumentation.self, for: node)
     onVisitPost(rule: BeginDocumentationCommentWithOneLineSummary.self, for: node)
-    onVisitPost(rule: DontRepeatTypeInStaticProperties.self, for: node)
     onVisitPost(rule: NoLeadingUnderscores.self, for: node)
     onVisitPost(rule: TypeNamesShouldBeCapitalized.self, for: node)
     onVisitPost(rule: UseSynthesizedInitializer.self, for: node)
@@ -568,6 +559,7 @@ class LintPipeline: SyntaxVisitor {
     visitIfEnabled(AllPublicDeclarationsHaveDocumentation.visit, for: node)
     visitIfEnabled(AlwaysUseLowerCamelCase.visit, for: node)
     visitIfEnabled(BeginDocumentationCommentWithOneLineSummary.visit, for: node)
+    visitIfEnabled(DontRepeatTypeInStaticProperties.visit, for: node)
     visitIfEnabled(NeverUseImplicitlyUnwrappedOptionals.visit, for: node)
     visitIfEnabled(UseTripleSlashForDocumentationComments.visit, for: node)
     return .visitChildren
@@ -576,6 +568,7 @@ class LintPipeline: SyntaxVisitor {
     onVisitPost(rule: AllPublicDeclarationsHaveDocumentation.self, for: node)
     onVisitPost(rule: AlwaysUseLowerCamelCase.self, for: node)
     onVisitPost(rule: BeginDocumentationCommentWithOneLineSummary.self, for: node)
+    onVisitPost(rule: DontRepeatTypeInStaticProperties.self, for: node)
     onVisitPost(rule: NeverUseImplicitlyUnwrappedOptionals.self, for: node)
     onVisitPost(rule: UseTripleSlashForDocumentationComments.self, for: node)
   }

Sources/SwiftFormat/Rules/AlwaysUseLowerCamelCase.swift

@@ -17,6 +17,7 @@ import SwiftSyntax
 ///
 /// This rule does not apply to test code, defined as code which:
 ///   * Contains the line `import XCTest`
+///   * The function is marked with `@Test` attribute
 ///
 /// Lint: If an identifier contains underscores or begins with a capital letter, a lint error is
 ///       raised.

Sources/SwiftFormat/Rules/DontRepeatTypeInStaticProperties.swift

@@ -22,69 +22,26 @@ import SwiftSyntax
 @_spi(Rules)
 public final class DontRepeatTypeInStaticProperties: SyntaxLintRule {
 
-  public override func visit(_ node: ClassDeclSyntax) -> SyntaxVisitorContinueKind {
-    diagnoseStaticMembers(node.memberBlock.members, endingWith: node.name.text)
-    return .skipChildren
-  }
-
-  public override func visit(_ node: EnumDeclSyntax) -> SyntaxVisitorContinueKind {
-    diagnoseStaticMembers(node.memberBlock.members, endingWith: node.name.text)
-    return .skipChildren
-  }
-
-  public override func visit(_ node: ProtocolDeclSyntax) -> SyntaxVisitorContinueKind {
-    diagnoseStaticMembers(node.memberBlock.members, endingWith: node.name.text)
-    return .skipChildren
-  }
-
-  public override func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind {
-    diagnoseStaticMembers(node.memberBlock.members, endingWith: node.name.text)
-    return .skipChildren
-  }
-
-  public override func visit(_ node: ExtensionDeclSyntax) -> SyntaxVisitorContinueKind {
-    let members = node.memberBlock.members
-
-    switch Syntax(node.extendedType).as(SyntaxEnum.self) {
-    case .identifierType(let simpleType):
-      diagnoseStaticMembers(members, endingWith: simpleType.name.text)
-    case .memberType(let memberType):
-      // We don't need to drill recursively into this structure because types with more than two
-      // components are constructed left-heavy; that is, `A.B.C.D` is structured as `((A.B).C).D`,
-      // and the final component of the top type is what we want.
-      diagnoseStaticMembers(members, endingWith: memberType.name.text)
-    default:
-      // Do nothing for non-nominal types. If Swift adds support for extensions on non-nominals,
-      // we'll need to update this if we need to support some subset of those.
-      break
+  /// Visits the static/class properties and diagnoses any where the name has the containing
+  /// type name (excluding possible namespace prefixes, like `NS` or `UI`) as a suffix.
+  public override func visit(_ node: VariableDeclSyntax) -> SyntaxVisitorContinueKind {
+    guard node.modifiers.contains(anyOf: [.class, .static]), let typeName = Syntax(node).typeName() else {
+      return .visitChildren
     }
 
-    return .skipChildren
-  }
-
-  /// Iterates over the static/class properties in the given member list and diagnoses any where the
-  /// name has the containing type name (excluding possible namespace prefixes, like `NS` or `UI`)
-  /// as a suffix.
-  private func diagnoseStaticMembers(_ members: MemberBlockItemListSyntax, endingWith typeName: String) {
-    for member in members {
-      guard
-        let varDecl = member.decl.as(VariableDeclSyntax.self),
-        varDecl.modifiers.contains(anyOf: [.class, .static])
-      else { continue }
-
-      let bareTypeName = removingPossibleNamespacePrefix(from: typeName)
-
-      for binding in varDecl.bindings {
-        guard let identifierPattern = binding.pattern.as(IdentifierPatternSyntax.self) else {
-          continue
-        }
+    let bareTypeName = removingPossibleNamespacePrefix(from: typeName)
+    for binding in node.bindings {
+      guard let identifierPattern = binding.pattern.as(IdentifierPatternSyntax.self) else {
+        continue
+      }
 
-        let varName = identifierPattern.identifier.text
-        if varName.contains(bareTypeName) {
-          diagnose(.removeTypeFromName(name: varName, type: bareTypeName), on: identifierPattern)
-        }
+      let varName = identifierPattern.identifier.text
+      if varName.contains(bareTypeName) {
+        diagnose(.removeTypeFromName(name: varName, type: bareTypeName), on: identifierPattern)
       }
     }
+
+    return .visitChildren
   }
 
   /// Returns the portion of the given string that excludes a possible Objective-C-style capitalized
@@ -110,3 +67,37 @@ extension Finding.Message {
     "remove the suffix '\(type)' from the name of the variable '\(name)'"
   }
 }
+
+extension Syntax {
+  /// Returns the name of the immediately enclosing type of this node if there is one,
+  /// otherwise nil.
+  fileprivate func typeName() -> String? {
+    if let node = self.as(ClassDeclSyntax.self) {
+      return node.name.text
+    } else if let node = self.as(EnumDeclSyntax.self) {
+      return node.name.text
+    } else if let node = self.as(ProtocolDeclSyntax.self) {
+      return node.name.text
+    } else if let node = self.as(StructDeclSyntax.self) {
+      return node.name.text
+    } else if let node = self.as(ExtensionDeclSyntax.self) {
+      switch Syntax(node.extendedType).as(SyntaxEnum.self) {
+      case .identifierType(let simpleType):
+        return simpleType.name.text
+      case .memberType(let memberType):
+        // the final component of the top type `A.B.C.D` is what we want `D`.
+        return memberType.name.text
+      default:
+        // Do nothing for non-nominal types. If Swift adds support for extensions on non-nominals,
+        // we'll need to update this if we need to support some subset of those.
+        break
+      }
+    } else if let parent = self.parent {
+      return parent.typeName()
+    }
+
+    return nil
+  }
+
+
+}

Sources/SwiftFormat/Rules/NeverForceUnwrap.swift

@@ -16,6 +16,7 @@ import SwiftSyntax
 ///
 /// This rule does not apply to test code, defined as code which:
 ///   * Contains the line `import XCTest`
+///   * The function is marked with `@Test` attribute
 ///
 /// Lint: If a force unwrap is used, a lint warning is raised.
 @_spi(Rules)

Sources/SwiftFormat/Rules/NeverUseForceTry.swift

@@ -16,6 +16,7 @@ import SwiftSyntax
 ///
 /// This rule does not apply to test code, defined as code which:
 ///   * Contains the line `import XCTest`
+///   * The function is marked with `@Test` attribute
 ///
 /// Lint: Using `try!` results in a lint error.
 ///

Sources/SwiftFormat/Rules/NeverUseImplicitlyUnwrappedOptionals.swift

@@ -18,6 +18,7 @@ import SwiftSyntax
 ///
 /// This rule does not apply to test code, defined as code which:
 ///   * Contains the line `import XCTest`
+///   * The function is marked with `@Test` attribute
 ///
 /// TODO: Create exceptions for other UI elements (ex: viewDidLoad)
 ///

Sources/generate-swift-format/PipelineGenerator.swift

@@ -68,17 +68,18 @@ final class PipelineGenerator: FileGenerator {
     )
 
     for (nodeType, lintRules) in ruleCollector.syntaxNodeLinters.sorted(by: { $0.key < $1.key }) {
+      let lintRules = lintRules.sorted(by: { $0.name < $1.name })
       handle.write(
         """
 
           override func visit(_ node: \(nodeType)) -> SyntaxVisitorContinueKind {
 
         """)
 
-      for ruleName in lintRules.sorted() {
+      for ruleName in lintRules {
         handle.write(
           """
-              visitIfEnabled(\(ruleName).visit, for: node)
+              visitIfEnabled(\(ruleName.name).visit, for: node)
 
           """)
       }
@@ -93,12 +94,20 @@ final class PipelineGenerator: FileGenerator {
         handle.write(
           """
             override func visitPost(_ node: \(nodeType)) {
+          
           """
         )
-        for ruleName in lintRules.sorted() {
+       for ruleName in lintRules {
+          if ruleName.visitPost {
+            handle.write(
+              """
+                  visitPost(\(ruleName.name).visitPost, for: node)
+
+              """)
+          }
           handle.write(
             """
-                onVisitPost(rule: \(ruleName).self, for: node)
+                onVisitPost(rule: \(ruleName.name).self, for: node)
 
             """)
         }

Sources/generate-swift-format/RuleCollector.swift

@@ -30,6 +30,9 @@ final class RuleCollector {
     /// The syntax node types visited by the rule type.
     let visitedNodes: [String]
 
+    /// The syntax node types visited by the rule type.
+    let visitedPostNodes: [String]
+
     /// Indicates whether the rule can format code (all rules can lint).
     let canFormat: Bool
 
@@ -44,7 +47,7 @@ final class RuleCollector {
   var allFormatters = Set<DetectedRule>()
 
   /// A dictionary mapping syntax node types to the lint/format rules that visit them.
-  var syntaxNodeLinters = [String: [String]]()
+  var syntaxNodeLinters = [String: [(name: String, visitPost: Bool)]]()
 
   /// Populates the internal collections with rules in the given directory.
   ///
@@ -79,7 +82,8 @@ final class RuleCollector {
         // tree.
         allLinters.insert(detectedRule)
         for visitedNode in detectedRule.visitedNodes {
-          syntaxNodeLinters[visitedNode, default: []].append(detectedRule.typeName)
+          let visitPost = detectedRule.visitedPostNodes.contains(visitedNode)
+          syntaxNodeLinters[visitedNode, default: []].append((detectedRule.typeName, visitPost: visitPost))
         }
       }
     }
@@ -126,16 +130,25 @@ final class RuleCollector {
         continue
       }
 
-      // Now that we know it's a format or lint rule, collect the `visit` methods.
+      // Now that we know it's a format or lint rule, collect the `visit` and `visitPost` methods.
       var visitedNodes = [String]()
+      var visitedPostNodes = [String]()
       for member in members {
         guard let function = member.decl.as(FunctionDeclSyntax.self) else { continue }
-        guard function.name.text == "visit" else { continue }
-        let params = function.signature.parameterClause.parameters
-        guard let firstType = params.firstAndOnly?.type.as(IdentifierTypeSyntax.self) else {
-          continue
+        if function.name.text == "visit" {
+          let params = function.signature.parameterClause.parameters
+          guard let firstType = params.firstAndOnly?.type.as(IdentifierTypeSyntax.self) else {
+            continue
+          }
+          visitedNodes.append(firstType.name.text)
+        }
+        if function.name.text == "visitPost" {
+          let params = function.signature.parameterClause.parameters
+          guard let firstType = params.firstAndOnly?.type.as(IdentifierTypeSyntax.self) else {
+            continue
+          }
+          visitedPostNodes.append(firstType.name.text)
         }
-        visitedNodes.append(firstType.name.text)
       }
 
       /// Ignore it if it doesn't have any; there's no point in putting no-op rules in the pipeline.
@@ -148,6 +161,7 @@ final class RuleCollector {
         typeName: typeName,
         description: description?.text,
         visitedNodes: visitedNodes,
+        visitedPostNodes: visitedPostNodes,
         canFormat: canFormat,
         isOptIn: ruleType.isOptIn)
     }