Move rule examples below implementation closure (#1832)

Sources/FormatRule.swift

@@ -56,14 +56,14 @@ public final class FormatRule: Equatable, Comparable, CustomStringConvertible {
     }
 
     init(help: String,
-         examples: String? = nil,
          deprecationMessage: String? = nil,
          runOnceOnly: Bool = false,
          disabledByDefault: Bool = false,
          orderAfter: [FormatRule] = [],
          options: [String] = [],
          sharedOptions: [String] = [],
-         _ fn: @escaping (Formatter) -> Void)
+         _ fn: @escaping (Formatter) -> Void,
+         examples: (() -> String)? = nil)
     {
         self.fn = fn
         self.help = help
@@ -73,7 +73,7 @@ public final class FormatRule: Equatable, Comparable, CustomStringConvertible {
         self.options = options
         self.sharedOptions = sharedOptions
         self.deprecationMessage = deprecationMessage
-        self.examples = examples
+        self.examples = examples?()
     }
 
     public func apply(with formatter: Formatter) {

Sources/Rules/Acronyms.swift

@@ -11,19 +11,6 @@ import Foundation
 public extension FormatRule {
     static let acronyms = FormatRule(
         help: "Capitalize acronyms when the first character is capitalized.",
-        examples: """
-        ```diff
-        - let destinationUrl: URL
-        - let urlRouter: UrlRouter
-        - let screenId: String
-        - let entityUuid: UUID
-
-        + let destinationURL: URL
-        + let urlRouter: URLRouter
-        + let screenID: String
-        + let entityUUID: UUID
-        ```
-        """,
         disabledByDefault: true,
         options: ["acronyms"]
     ) { formatter in
@@ -85,5 +72,19 @@ public extension FormatRule {
                 formatter.replaceToken(at: index, with: updatedToken)
             }
         }
+    } examples: {
+        """
+        ```diff
+        - let destinationUrl: URL
+        - let urlRouter: UrlRouter
+        - let screenId: String
+        - let entityUuid: UUID
+
+        + let destinationURL: URL
+        + let urlRouter: URLRouter
+        + let screenID: String
+        + let entityUUID: UUID
+        ```
+        """
     }
 }

Sources/Rules/AndOperator.swift

@@ -11,28 +11,7 @@ import Foundation
 public extension FormatRule {
     /// Replace the `&&` operator with `,` where applicable
     static let andOperator = FormatRule(
-        help: "Prefer comma over `&&` in `if`, `guard` or `while` conditions.",
-        examples: """
-        ```diff
-        - if true && true {
-        + if true, true {
-        ```
-
-        ```diff
-        - guard true && true else {
-        + guard true, true else {
-        ```
-
-        ```diff
-        - if functionReturnsBool() && true {
-        + if functionReturnsBool(), true {
-        ```
-
-        ```diff
-        - if functionReturnsBool() && variable {
-        + if functionReturnsBool(), variable {
-        ```
-        """
+        help: "Prefer comma over `&&` in `if`, `guard` or `while` conditions."
     ) { formatter in
         formatter.forEachToken { i, token in
             switch token {
@@ -102,5 +81,27 @@ public extension FormatRule {
                 index += 1
             }
         }
+    } examples: {
+        """
+        ```diff
+        - if true && true {
+        + if true, true {
+        ```
+
+        ```diff
+        - guard true && true else {
+        + guard true, true else {
+        ```
+
+        ```diff
+        - if functionReturnsBool() && true {
+        + if functionReturnsBool(), true {
+        ```
+
+        ```diff
+        - if functionReturnsBool() && variable {
+        + if functionReturnsBool(), variable {
+        ```
+        """
     }
 }

Sources/Rules/AnyObjectProtocol.swift

@@ -11,17 +11,7 @@ import Foundation
 public extension FormatRule {
     /// Prefer `AnyObject` over `class` for class-based protocols
     static let anyObjectProtocol = FormatRule(
-        help: "Prefer `AnyObject` over `class` in protocol definitions.",
-        examples: """
-        ```diff
-        - protocol Foo: class {}
-        + protocol Foo: AnyObject {}
-        ```
-
-        **NOTE:** The guideline to use `AnyObject` instead of `class` was only
-        introduced in Swift 4.1, so the `anyObjectProtocol` rule is disabled unless the
-        swift version is set to 4.1 or above.
-        """
+        help: "Prefer `AnyObject` over `class` in protocol definitions."
     ) { formatter in
         formatter.forEach(.keyword("protocol")) { i, _ in
             guard formatter.options.swiftVersion >= "4.1",
@@ -37,5 +27,16 @@ public extension FormatRule {
             }
             formatter.replaceToken(at: classIndex, with: .identifier("AnyObject"))
         }
+    } examples: {
+        """
+        ```diff
+        - protocol Foo: class {}
+        + protocol Foo: AnyObject {}
+        ```
+
+        **NOTE:** The guideline to use `AnyObject` instead of `class` was only
+        introduced in Swift 4.1, so the `anyObjectProtocol` rule is disabled unless the
+        swift version is set to 4.1 or above.
+        """
     }
 }

Sources/Rules/AssertionFailures.swift

@@ -13,22 +13,6 @@ public extension FormatRule {
         help: """
         Changes all instances of assert(false, ...) to assertionFailure(...)
         and precondition(false, ...) to preconditionFailure(...).
-        """,
-        examples: """
-        ```diff
-        - assert(false)
-        + assertionFailure()
-        ```
-
-        ```diff
-        - assert(false, "message", 2, 1)
-        + assertionFailure("message", 2, 1)
-        ```
-
-        ```diff
-        - precondition(false, "message", 2, 1)
-        + preconditionFailure("message", 2, 1)
-        ```
         """
     ) { formatter in
         formatter.forEachToken { i, token in
@@ -55,5 +39,22 @@ public extension FormatRule {
                 break
             }
         }
+    } examples: {
+        """
+        ```diff
+        - assert(false)
+        + assertionFailure()
+        ```
+
+        ```diff
+        - assert(false, "message", 2, 1)
+        + assertionFailure("message", 2, 1)
+        ```
+
+        ```diff
+        - precondition(false, "message", 2, 1)
+        + preconditionFailure("message", 2, 1)
+        ```
+        """
     }
 }

Sources/Rules/BlankLineAfterImports.swift

@@ -12,17 +12,6 @@ public extension FormatRule {
     /// Insert blank line after import statements
     static let blankLineAfterImports = FormatRule(
         help: "Insert blank line after import statements.",
-        examples: """
-        ```diff
-          import A
-          import B
-          @testable import D
-        +
-          class Foo {
-            // foo
-          }
-        ```
-        """,
         sharedOptions: ["linebreaks"]
     ) { formatter in
         formatter.forEach(.keyword("import")) { currentImportIndex, _ in
@@ -45,5 +34,17 @@ public extension FormatRule {
                 formatter.insertLinebreak(at: endOfLine)
             }
         }
+    } examples: {
+        """
+        ```diff
+          import A
+          import B
+          @testable import D
+        +
+          class Foo {
+            // foo
+          }
+        ```
+        """
     }
 }

Sources/Rules/BlankLineAfterSwitchCase.swift

@@ -14,28 +14,6 @@ public extension FormatRule {
         Insert a blank line after multiline switch cases (excluding the last case,
         which is followed by a closing brace).
         """,
-        examples: #"""
-        ```diff
-          func handle(_ action: SpaceshipAction) {
-              switch action {
-              case .engageWarpDrive:
-                  navigationComputer.destination = targetedDestination
-                  await warpDrive.spinUp()
-                  warpDrive.activate()
-        +
-              case let .scanPlanet(planet):
-                  scanner.target = planet
-                  scanner.scanAtmosphere()
-                  scanner.scanBiosphere()
-                  scanner.scanForArticialLife()
-        +
-              case .handleIncomingEnergyBlast:
-                  await energyShields.prepare()
-                  energyShields.engage()
-              }
-          }
-        ```
-        """#,
         disabledByDefault: true,
         orderAfter: [.redundantBreak]
     ) { formatter in
@@ -61,5 +39,28 @@ public extension FormatRule {
                 }
             }
         }
+    } examples: {
+        #"""
+        ```diff
+          func handle(_ action: SpaceshipAction) {
+              switch action {
+              case .engageWarpDrive:
+                  navigationComputer.destination = targetedDestination
+                  await warpDrive.spinUp()
+                  warpDrive.activate()
+        +
+              case let .scanPlanet(planet):
+                  scanner.target = planet
+                  scanner.scanAtmosphere()
+                  scanner.scanBiosphere()
+                  scanner.scanForArticialLife()
+        +
+              case .handleIncomingEnergyBlast:
+                  await energyShields.prepare()
+                  energyShields.engage()
+              }
+          }
+        ```
+        """#
     }
 }

Sources/Rules/BlankLinesAroundMark.swift

@@ -12,27 +12,6 @@ public extension FormatRule {
     /// Adds a blank line around MARK: comments
     static let blankLinesAroundMark = FormatRule(
         help: "Insert blank line before and after `MARK:` comments.",
-        examples: """
-        ```diff
-          func foo() {
-            // foo
-          }
-          // MARK: bar
-          func bar() {
-            // bar
-          }
-
-          func foo() {
-            // foo
-          }
-        +
-          // MARK: bar
-        +
-          func bar() {
-            // bar
-          }
-        ```
-        """,
         options: ["lineaftermarks"],
         sharedOptions: ["linebreaks"]
     ) { formatter in
@@ -55,5 +34,27 @@ public extension FormatRule {
                 formatter.insertLinebreak(at: lastIndex)
             }
         }
+    } examples: {
+        """
+        ```diff
+          func foo() {
+            // foo
+          }
+          // MARK: bar
+          func bar() {
+            // bar
+          }
+
+          func foo() {
+            // foo
+          }
+        +
+          // MARK: bar
+        +
+          func bar() {
+            // bar
+          }
+        ```
+        """
     }
 }