Let all rewriters have a configuration by default (#5467)

realm · Feb 11, 2024 · 4078e41 · 4078e41
1 parent c874c4e
commit 4078e41
Show file tree

Hide file tree

Showing 54 changed files with 128 additions and 286 deletions.
diff --git a/Source/SwiftLintBuiltInRules/Helpers/LegacyFunctionRuleHelper.swift b/Source/SwiftLintBuiltInRules/Helpers/LegacyFunctionRuleHelper.swift
@@ -35,16 +35,16 @@ enum LegacyFunctionRuleHelper {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter<Configuration: RuleConfiguration>: ViolationsSyntaxRewriter<Configuration> {
         private let legacyFunctions: [String: RewriteStrategy]
 
         init(
             legacyFunctions: [String: RewriteStrategy],
-            locationConverter: SourceLocationConverter,
-            disabledRegions: [SourceRange]
+            configuration: Configuration,
+            file: SwiftLintFile
         ) {
             self.legacyFunctions = legacyFunctions
-            super.init(locationConverter: locationConverter, disabledRegions: disabledRegions)
+            super.init(configuration: configuration, file: file)
         }
 
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/DuplicateImportsRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/DuplicateImportsRule.swift
@@ -35,12 +35,8 @@ struct DuplicateImportsRule: SwiftSyntaxCorrectableRule {
         queuedFatalError("Unreachable: `validate(file:)` will be used instead")
     }
 
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
-        Rewriter(
-            importPositionsToRemove: file.duplicateImportsViolationPositions(),
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
-        )
+    func makeRewriter(file: SwiftLintFile) -> ViolationsSyntaxRewriter<ConfigurationType>? {
+        Rewriter(configuration: configuration, file: file)
     }
 }
 
@@ -152,17 +148,8 @@ private extension SwiftLintFile {
 }
 
 private extension DuplicateImportsRule {
-    final class Rewriter: ViolationsSyntaxRewriter {
-        let importPositionsToRemove: [AbsolutePosition]
-
-        init(
-            importPositionsToRemove: [AbsolutePosition],
-            locationConverter: SourceLocationConverter,
-            disabledRegions: [SourceRange]
-        ) {
-            self.importPositionsToRemove = importPositionsToRemove
-            super.init(locationConverter: locationConverter, disabledRegions: disabledRegions)
-        }
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
+        private lazy var importPositionsToRemove = file.duplicateImportsViolationPositions()
 
         override func visit(_ node: CodeBlockItemListSyntax) -> CodeBlockItemListSyntax {
             let itemsToRemove = node

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ExplicitInitRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ExplicitInitRule.swift
@@ -201,7 +201,7 @@ private extension ExplicitInitRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
             guard let calledExpression = node.calledExpression.as(MemberAccessExprSyntax.self),
                   let violationPosition = calledExpression.explicitInitPosition,

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/JoinedDefaultParameterRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/JoinedDefaultParameterRule.swift
@@ -47,7 +47,7 @@ private extension JoinedDefaultParameterRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
             guard let violationPosition = node.violationPosition else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyCGGeometryFunctionsRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyCGGeometryFunctionsRule.swift
@@ -108,11 +108,11 @@ struct LegacyCGGeometryFunctionsRule: SwiftSyntaxCorrectableRule {
         )
     }
 
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
+    func makeRewriter(file: SwiftLintFile) -> ViolationsSyntaxRewriter<ConfigurationType>? {
         LegacyFunctionRuleHelper.Rewriter(
             legacyFunctions: Self.legacyFunctions,
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
+            configuration: configuration,
+            file: file
         )
     }
 }
diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstantRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstantRule.swift
@@ -31,7 +31,7 @@ private extension LegacyConstantRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: DeclReferenceExprSyntax) -> ExprSyntax {
             guard let correction = LegacyConstantRuleExamples.patterns[node.baseName.text] else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstructorRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstructorRule.swift
@@ -134,7 +134,7 @@ private extension LegacyConstructorRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
             guard let identifierExpr = node.calledExpression.as(DeclReferenceExprSyntax.self),
                   case let identifier = identifierExpr.baseName.text,

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyNSGeometryFunctionsRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyNSGeometryFunctionsRule.swift
@@ -108,11 +108,11 @@ struct LegacyNSGeometryFunctionsRule: SwiftSyntaxCorrectableRule {
         )
     }
 
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
+    func makeRewriter(file: SwiftLintFile) -> ViolationsSyntaxRewriter<ConfigurationType>? {
         LegacyFunctionRuleHelper.Rewriter(
             legacyFunctions: Self.legacyFunctions,
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
+            configuration: configuration,
+            file: file
         )
     }
 }
diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/NimbleOperatorRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/NimbleOperatorRule.swift
@@ -80,7 +80,7 @@ private extension NimbleOperatorRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
             guard let expectation = node.expectation(),
                   let predicate = predicatesMapping[expectation.operatorExpr.baseName.text],

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/PreferZeroOverExplicitInitRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/PreferZeroOverExplicitInitRule.swift
@@ -45,7 +45,7 @@ private extension PreferZeroOverExplicitInitRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
             guard node.hasViolation, let name = node.name else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/PrivateOverFilePrivateRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/PrivateOverFilePrivateRule.swift
@@ -1,7 +1,7 @@
 import SwiftSyntax
 
-@SwiftSyntaxRule
-struct PrivateOverFilePrivateRule: SwiftSyntaxCorrectableRule {
+@SwiftSyntaxRule(explicitRewriter: true)
+struct PrivateOverFilePrivateRule: Rule {
     var configuration = PrivateOverFilePrivateConfiguration()
 
     static let description = RuleDescription(
@@ -54,14 +54,6 @@ struct PrivateOverFilePrivateRule: SwiftSyntaxCorrectableRule {
                 Example("private class MyClass {\nfileprivate(set) var myInt = 4\n}")
         ]
     )
-
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
-        Rewriter(
-            validateExtensions: configuration.validateExtensions,
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
-        )
-    }
 }
 
 private extension PrivateOverFilePrivateRule {
@@ -123,17 +115,10 @@ private extension PrivateOverFilePrivateRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
-        private let validateExtensions: Bool
-
-        init(validateExtensions: Bool, locationConverter: SourceLocationConverter, disabledRegions: [SourceRange]) {
-            self.validateExtensions = validateExtensions
-            super.init(locationConverter: locationConverter, disabledRegions: disabledRegions)
-        }
-
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         // don't call super in any of the `visit` methods to avoid digging into the children
         override func visit(_ node: ExtensionDeclSyntax) -> DeclSyntax {
-            guard validateExtensions, let modifier = node.modifiers.fileprivateModifier,
+            guard configuration.validateExtensions, let modifier = node.modifiers.fileprivateModifier,
                   let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantNilCoalescingRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantNilCoalescingRule.swift
@@ -33,7 +33,7 @@ private extension RedundantNilCoalescingRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: ExprListSyntax) -> ExprListSyntax {
             guard
                 node.count > 2,

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantOptionalInitializationRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantOptionalInitializationRule.swift
@@ -118,7 +118,7 @@ private extension RedundantOptionalInitializationRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visitAny(_ node: Syntax) -> Syntax? { nil }
 
         override func visit(_ node: VariableDeclSyntax) -> DeclSyntax {

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantVoidReturnRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantVoidReturnRule.swift
@@ -1,7 +1,7 @@
 import SwiftSyntax
 
-@SwiftSyntaxRule
-struct RedundantVoidReturnRule: SwiftSyntaxCorrectableRule {
+@SwiftSyntaxRule(explicitRewriter: true)
+struct RedundantVoidReturnRule: Rule {
     var configuration = RedundantVoidReturnConfiguration()
 
     static let description = RuleDescription(
@@ -68,14 +68,6 @@ struct RedundantVoidReturnRule: SwiftSyntaxCorrectableRule {
                 Example("protocol Foo {\n    #if true\n    func foo()\n    #endif\n}")
         ]
     )
-
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
-        Rewriter(
-            configuration: configuration,
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
-        )
-    }
 }
 
 private extension RedundantVoidReturnRule {
@@ -92,18 +84,7 @@ private extension RedundantVoidReturnRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
-        let configuration: ConfigurationType
-
-        init(
-            configuration: ConfigurationType,
-            locationConverter: SourceLocationConverter,
-            disabledRegions: [SourceRange]
-        ) {
-            self.configuration = configuration
-            super.init(locationConverter: locationConverter, disabledRegions: disabledRegions)
-        }
-
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: ClosureSignatureSyntax) -> ClosureSignatureSyntax {
             guard configuration.includeClosures,
                   let output = node.returnClause,

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ReturnValueFromVoidFunctionRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ReturnValueFromVoidFunctionRule.swift
@@ -26,7 +26,7 @@ private extension ReturnValueFromVoidFunctionRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ statements: CodeBlockItemListSyntax) -> CodeBlockItemListSyntax {
             guard let returnStmt = statements.last?.item.as(ReturnStmtSyntax.self),
                   let expr = returnStmt.expression,

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ShorthandOptionalBindingRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ShorthandOptionalBindingRule.swift
@@ -90,7 +90,7 @@ private extension ShorthandOptionalBindingRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: OptionalBindingConditionSyntax) -> OptionalBindingConditionSyntax {
             guard node.isShadowingOptionalBinding else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ToggleBoolRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ToggleBoolRule.swift
@@ -40,7 +40,7 @@ private extension ToggleBoolRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: ExprListSyntax) -> ExprListSyntax {
             guard node.hasToggleBoolViolation, let firstExpr = node.first, let index = node.index(of: firstExpr) else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/TrailingSemicolonRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/TrailingSemicolonRule.swift
@@ -35,7 +35,7 @@ private extension TrailingSemicolonRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: TokenSyntax) -> TokenSyntax {
             guard node.isTrailingSemicolon else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededBreakInSwitchRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededBreakInSwitchRule.swift
@@ -99,7 +99,7 @@ private extension UnneededBreakInSwitchRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: SwitchCaseSyntax) -> SwitchCaseSyntax {
             let stmts = CodeBlockItemListSyntax(node.statements.dropLast())
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededSynthesizedInitializerRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededSynthesizedInitializerRule.swift
@@ -46,7 +46,7 @@ private extension UnneededSynthesizedInitializerRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         private var unneededInitializers: [InitializerDeclSyntax] = []
 
         override func visitAny(_ node: Syntax) -> Syntax? { nil }

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UntypedErrorInCatchRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UntypedErrorInCatchRule.swift
@@ -119,7 +119,7 @@ private extension UntypedErrorInCatchRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: CatchClauseSyntax) -> CatchClauseSyntax {
             guard let item = node.catchItems.onlyElement, item.isIdentifierPattern else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/AnyObjectProtocolRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/AnyObjectProtocolRule.swift
@@ -43,11 +43,8 @@ struct AnyObjectProtocolRule: SwiftSyntaxCorrectableRule, OptInRule {
         return Visitor(configuration: configuration, file: file)
     }
 
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
-        Rewriter(
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
-        )
+    func makeRewriter(file: SwiftLintFile) -> ViolationsSyntaxRewriter<ConfigurationType>? {
+        Rewriter(configuration: configuration, file: file)
     }
 }
 
@@ -58,7 +55,7 @@ private extension AnyObjectProtocolRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: InheritedTypeSyntax) -> InheritedTypeSyntax {
             let typeName = node.type
             guard typeName.is(ClassRestrictionTypeSyntax.self) else {

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/LowerACLThanParentRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/LowerACLThanParentRule.swift
@@ -91,7 +91,7 @@ private extension LowerACLThanParentRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: DeclModifierSyntax) -> DeclModifierSyntax {
             guard node.isHigherACLThanParent else {
                 return super.visit(node)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/MarkRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/MarkRule.swift
@@ -25,7 +25,7 @@ private extension MarkRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ token: TokenSyntax) -> TokenSyntax {
             var pieces = token.leadingTrivia.pieces
             for result in token.violationResults() {

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/PrivateUnitTestRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/PrivateUnitTestRule.swift
@@ -1,8 +1,8 @@
 import Foundation
 import SwiftSyntax
 
-@SwiftSyntaxRule
-struct PrivateUnitTestRule: SwiftSyntaxCorrectableRule {
+@SwiftSyntaxRule(explicitRewriter: true)
+struct PrivateUnitTestRule: Rule {
     var configuration = PrivateUnitTestConfiguration()
 
     static let description = RuleDescription(
@@ -125,14 +125,6 @@ struct PrivateUnitTestRule: SwiftSyntaxCorrectableRule {
                     """)
         ]
     )
-
-    func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
-        Rewriter(
-            configuration: configuration,
-            locationConverter: file.locationConverter,
-            disabledRegions: disabledRegions(file: file)
-        )
-    }
 }
 
 private extension PrivateUnitTestRule {
@@ -156,16 +148,7 @@ private extension PrivateUnitTestRule {
         }
     }
 
-    final class Rewriter: ViolationsSyntaxRewriter {
-        private let configuration: PrivateUnitTestConfiguration
-
-        init(configuration: PrivateUnitTestConfiguration,
-             locationConverter: SourceLocationConverter,
-             disabledRegions: [SourceRange]) {
-            self.configuration = configuration
-            super.init(locationConverter: locationConverter, disabledRegions: disabledRegions)
-        }
-
+    final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
         override func visit(_ node: ClassDeclSyntax) -> DeclSyntax {
             guard node.isPrivate, node.hasParent(configuredIn: configuration) else {
                 return super.visit(node)