Check disabled regions for all syntax types in parent rewriter class (#…

…5292)
realm · Oct 23, 2023 · 4c0f337 · 4c0f337
1 parent ee02f19
commit 4c0f337
Show file tree

Hide file tree

Showing 39 changed files with 68 additions and 179 deletions.
diff --git a/Source/SwiftLintBuiltInRules/Helpers/LegacyFunctionRuleHelper.swift b/Source/SwiftLintBuiltInRules/Helpers/LegacyFunctionRuleHelper.swift
@@ -48,11 +48,8 @@ enum LegacyFunctionRuleHelper {
         }
 
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
-            guard
-                node.isLegacyFunctionExpression(legacyFunctions: legacyFunctions),
-                let funcName = node.calledExpression.as(DeclReferenceExprSyntax.self)?.baseName.text,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard node.isLegacyFunctionExpression(legacyFunctions: legacyFunctions),
+                  let funcName = node.calledExpression.as(DeclReferenceExprSyntax.self)?.baseName.text else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ExplicitInitRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ExplicitInitRule.swift
@@ -191,15 +191,11 @@ private extension ExplicitInitRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
-            guard
-                let calledExpression = node.calledExpression.as(MemberAccessExprSyntax.self),
-                let violationPosition = calledExpression.explicitInitPosition,
-                let calledBase = calledExpression.base,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard let calledExpression = node.calledExpression.as(MemberAccessExprSyntax.self),
+                  let violationPosition = calledExpression.explicitInitPosition,
+                  let calledBase = calledExpression.base else {
                 return super.visit(node)
             }
-
             correctionPositions.append(violationPosition)
             let newNode = node.with(\.calledExpression, calledBase.trimmed)
             return super.visit(newNode)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/JoinedDefaultParameterRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/JoinedDefaultParameterRule.swift
@@ -49,11 +49,9 @@ private extension JoinedDefaultParameterRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
-            guard let violationPosition = node.violationPosition,
-                    !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+            guard let violationPosition = node.violationPosition else {
                 return super.visit(node)
             }
-
             correctionPositions.append(violationPosition)
             let newNode = node.with(\.arguments, [])
             return super.visit(newNode)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstantRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstantRule.swift
@@ -33,28 +33,20 @@ private extension LegacyConstantRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: DeclReferenceExprSyntax) -> ExprSyntax {
-            guard
-                let correction = LegacyConstantRuleExamples.patterns[node.baseName.text],
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard let correction = LegacyConstantRuleExamples.patterns[node.baseName.text] else {
                 return super.visit(node)
             }
-
             correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
             return ("\(raw: correction)" as ExprSyntax)
                 .with(\.leadingTrivia, node.leadingTrivia)
                 .with(\.trailingTrivia, node.trailingTrivia)
         }
 
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
-            guard
-                node.isLegacyPiExpression,
-                let calledExpression = node.calledExpression.as(DeclReferenceExprSyntax.self),
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard node.isLegacyPiExpression,
+                  let calledExpression = node.calledExpression.as(DeclReferenceExprSyntax.self) else {
                 return super.visit(node)
             }
-
             correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
             return ("\(raw: calledExpression.baseName.text).pi" as ExprSyntax)
                 .with(\.leadingTrivia, node.leadingTrivia)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstructorRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/LegacyConstructorRule.swift
@@ -139,8 +139,7 @@ private extension LegacyConstructorRule {
             guard let identifierExpr = node.calledExpression.as(DeclReferenceExprSyntax.self),
                   case let identifier = identifierExpr.baseName.text,
                   let correctedName = constructorsToCorrectedNames[identifier],
-                  let args = constructorsToArguments[identifier],
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let args = constructorsToArguments[identifier] else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/PreferZeroOverExplicitInitRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/PreferZeroOverExplicitInitRule.swift
@@ -47,9 +47,7 @@ private extension PreferZeroOverExplicitInitRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: FunctionCallExprSyntax) -> ExprSyntax {
-            guard node.hasViolation,
-                  let name = node.name,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+            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
@@ -134,8 +134,7 @@ private extension PrivateOverFilePrivateRule {
         // 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,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -146,8 +145,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: ClassDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -158,8 +156,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: StructDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -170,8 +167,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: EnumDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -182,8 +178,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: ProtocolDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -194,8 +189,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: FunctionDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -206,8 +200,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: VariableDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  let modifierIndex = node.modifiers.fileprivateModifierIndex else {
                 return DeclSyntax(node)
             }
 
@@ -218,8 +211,7 @@ private extension PrivateOverFilePrivateRule {
 
         override func visit(_ node: TypeAliasDeclSyntax) -> DeclSyntax {
             guard let modifier = node.modifiers.fileprivateModifier,
-                  let modifierIndex = node.modifiers.fileprivateModifierIndex,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+                  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
@@ -40,8 +40,7 @@ private extension RedundantNilCoalescingRule {
                 let lastExpression = node.last,
                 lastExpression.is(NilLiteralExprSyntax.self),
                 let secondToLastExpression = node.dropLast().last?.as(BinaryOperatorExprSyntax.self),
-                secondToLastExpression.operator.tokenKind.isNilCoalescingOperator,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
+                secondToLastExpression.operator.tokenKind.isNilCoalescingOperator
             else {
                 return super.visit(node)
             }

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantOptionalInitializationRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/RedundantOptionalInitializationRule.swift
@@ -119,6 +119,8 @@ private extension RedundantOptionalInitializationRule {
     }
 
     final class Rewriter: ViolationsSyntaxRewriter {
+        override func visitAny(_ node: Syntax) -> Syntax? { nil }
+
         override func visit(_ node: VariableDeclSyntax) -> DeclSyntax {
             guard node.bindingSpecifier.tokenKind == .keyword(.var),
                   !node.modifiers.contains(keyword: .lazy) else {

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

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ToggleBoolRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/ToggleBoolRule.swift
@@ -42,9 +42,7 @@ private extension ToggleBoolRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: ExprListSyntax) -> ExprListSyntax {
-            guard node.hasToggleBoolViolation,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter),
-                  let firstExpr = node.first, let index = node.index(of: firstExpr) else {
+            guard node.hasToggleBoolViolation, let firstExpr = node.first, let index = node.index(of: firstExpr) else {
                 return super.visit(node)
             }
             correctionPositions.append(node.positionAfterSkippingLeadingTrivia)

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

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededBreakInSwitchRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededBreakInSwitchRule.swift
@@ -103,8 +103,7 @@ private extension UnneededBreakInSwitchRule {
         override func visit(_ node: SwitchCaseSyntax) -> SwitchCaseSyntax {
             let stmts = CodeBlockItemListSyntax(node.statements.dropLast())
 
-            guard let breakStatement = node.unneededBreak, let secondLast = stmts.last,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+            guard let breakStatement = node.unneededBreak, let secondLast = stmts.last else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededSynthesizedInitializerRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UnneededSynthesizedInitializerRule.swift
@@ -49,6 +49,8 @@ private extension UnneededSynthesizedInitializerRule {
     final class Rewriter: ViolationsSyntaxRewriter {
         private var unneededInitializers: [InitializerDeclSyntax] = []
 
+        override func visitAny(_ node: Syntax) -> Syntax? { nil }
+
         override func visit(_ node: StructDeclSyntax) -> DeclSyntax {
             unneededInitializers = node.unneededInitializers.filter {
                 !$0.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)

diff --git a/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UntypedErrorInCatchRule.swift b/Source/SwiftLintBuiltInRules/Rules/Idiomatic/UntypedErrorInCatchRule.swift
@@ -121,11 +121,7 @@ private extension UntypedErrorInCatchRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: CatchClauseSyntax) -> CatchClauseSyntax {
-            guard
-                let item = node.catchItems.onlyElement,
-                item.isIdentifierPattern,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            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
@@ -61,13 +61,9 @@ private extension AnyObjectProtocolRule {
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: InheritedTypeSyntax) -> InheritedTypeSyntax {
             let typeName = node.type
-            guard
-                typeName.is(ClassRestrictionTypeSyntax.self),
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard typeName.is(ClassRestrictionTypeSyntax.self) else {
                 return super.visit(node)
             }
-
             correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
             return super.visit(
                 node.with(

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

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/PrivateUnitTestRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/PrivateUnitTestRule.swift
@@ -167,11 +167,7 @@ private extension PrivateUnitTestRule {
         }
 
         override func visit(_ node: ClassDeclSyntax) -> DeclSyntax {
-            guard
-                node.isPrivate,
-                node.hasParent(configuredIn: configuration),
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard node.isPrivate, node.hasParent(configuredIn: configuration) else {
                 return super.visit(node)
             }
 
@@ -181,11 +177,7 @@ private extension PrivateUnitTestRule {
         }
 
         override func visit(_ node: FunctionDeclSyntax) -> DeclSyntax {
-            guard
-                node.isTestMethod,
-                node.isPrivate,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard node.isTestMethod, node.isPrivate else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/StrongIBOutletRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/StrongIBOutletRule.swift
@@ -42,9 +42,7 @@ private extension StrongIBOutletRule {
         override func visit(_ node: VariableDeclSyntax) -> DeclSyntax {
             guard let violationPosition = node.violationPosition,
                   let weakOrUnownedModifier = node.weakOrUnownedModifier,
-                  case let modifiers = node.modifiers,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+                  case let modifiers = node.modifiers else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/UnneededOverrideRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/UnneededOverrideRule.swift
@@ -61,8 +61,7 @@ private extension UnneededOverrideRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: FunctionDeclSyntax) -> DeclSyntax {
-            if isUnneededOverride(node) &&
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) {
+            if isUnneededOverride(node) {
                 correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
                 let expr: DeclSyntax = ""
                 return expr

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/UnusedClosureParameterRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/UnusedClosureParameterRule.swift
@@ -35,12 +35,9 @@ private extension UnusedClosureParameterRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: ClosureExprSyntax) -> ExprSyntax {
-            guard
-                node.namedParameters.isNotEmpty,
-                let signature = node.signature,
-                let input = signature.parameterClause,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard node.namedParameters.isNotEmpty,
+                  let signature = node.signature,
+                  let input = signature.parameterClause else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Lint/UnusedControlFlowLabelRule.swift b/Source/SwiftLintBuiltInRules/Rules/Lint/UnusedControlFlowLabelRule.swift
@@ -96,8 +96,7 @@ private extension UnusedControlFlowLabelRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: LabeledStmtSyntax) -> StmtSyntax {
-            guard let violationPosition = node.violationPosition,
-                  !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter) else {
+            guard let violationPosition = node.violationPosition else {
                 return super.visit(node)
             }
 

diff --git a/Source/SwiftLintBuiltInRules/Rules/Style/ClosingBraceRule.swift b/Source/SwiftLintBuiltInRules/Rules/Style/ClosingBraceRule.swift
@@ -34,13 +34,9 @@ private extension ClosingBraceRule {
 
     final class Rewriter: ViolationsSyntaxRewriter {
         override func visit(_ node: TokenSyntax) -> TokenSyntax {
-            guard
-                node.hasClosingBraceViolation,
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
-            else {
+            guard node.hasClosingBraceViolation else {
                 return super.visit(node)
             }
-
             correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
             return super.visit(node.with(\.trailingTrivia, Trivia()))
         }

diff --git a/Source/SwiftLintBuiltInRules/Rules/Style/ClosureSpacingRule.swift b/Source/SwiftLintBuiltInRules/Rules/Style/ClosureSpacingRule.swift
@@ -61,10 +61,7 @@ private extension ClosureSpacingRule {
             var node = node
             node.statements = visit(node.statements)
 
-            guard
-                !node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter),
-                node.shouldCheckForClosureSpacingRule(locationConverter: locationConverter)
-            else {
+            guard node.shouldCheckForClosureSpacingRule(locationConverter: locationConverter) else {
                 return super.visit(node)
             }