Files
SwiftLint/Source/SwiftLintBuiltInRules/Rules/Style/RedundantDiscardableLetRule.swift
T
Danny Mösch 58928b7e40 Enforce any on existential types (#5273)
This makes syntactically clear which types are rather expensive.
2023-10-12 08:37:23 +02:00

83 lines
3.1 KiB
Swift

import SwiftSyntax
@SwiftSyntaxRule
struct RedundantDiscardableLetRule: SwiftSyntaxCorrectableRule, ConfigurationProviderRule {
var configuration = SeverityConfiguration<Self>(.warning)
static let description = RuleDescription(
identifier: "redundant_discardable_let",
name: "Redundant Discardable Let",
description: "Prefer `_ = foo()` over `let _ = foo()` when discarding a result from a function",
kind: .style,
nonTriggeringExamples: [
Example("_ = foo()"),
Example("if let _ = foo() { }"),
Example("guard let _ = foo() else { return }"),
Example("let _: ExplicitType = foo()"),
Example("while let _ = SplashStyle(rawValue: maxValue) { maxValue += 1 }"),
Example("async let _ = await foo()")
],
triggeringExamples: [
Example("↓let _ = foo()"),
Example("if _ = foo() { ↓let _ = bar() }")
],
corrections: [
Example("↓let _ = foo()"): Example("_ = foo()"),
Example("if _ = foo() { ↓let _ = bar() }"): Example("if _ = foo() { _ = bar() }")
]
)
func makeRewriter(file: SwiftLintFile) -> (some ViolationsSyntaxRewriter)? {
Rewriter(
locationConverter: file.locationConverter,
disabledRegions: disabledRegions(file: file)
)
}
}
private extension RedundantDiscardableLetRule {
final class Visitor: ViolationsSyntaxVisitor {
override func visitPost(_ node: VariableDeclSyntax) {
if node.hasRedundantDiscardableLetViolation {
violations.append(node.positionAfterSkippingLeadingTrivia)
}
}
}
final class Rewriter: SyntaxRewriter, ViolationsSyntaxRewriter {
private(set) var correctionPositions: [AbsolutePosition] = []
let locationConverter: SourceLocationConverter
let disabledRegions: [SourceRange]
init(locationConverter: SourceLocationConverter, disabledRegions: [SourceRange]) {
self.locationConverter = locationConverter
self.disabledRegions = disabledRegions
}
override func visit(_ node: VariableDeclSyntax) -> DeclSyntax {
guard
node.hasRedundantDiscardableLetViolation,
!node.isContainedIn(regions: disabledRegions, locationConverter: locationConverter)
else {
return super.visit(node)
}
correctionPositions.append(node.positionAfterSkippingLeadingTrivia)
let newNode = node
.with(\.bindingSpecifier, .keyword(.let, presence: .missing))
.with(\.bindings, node.bindings.with(\.leadingTrivia, node.bindingSpecifier.leadingTrivia))
return super.visit(newNode)
}
}
}
private extension VariableDeclSyntax {
var hasRedundantDiscardableLetViolation: Bool {
bindingSpecifier.tokenKind == .keyword(.let)
&& bindings.count == 1
&& bindings.first!.pattern.is(WildcardPatternSyntax.self)
&& bindings.first!.typeAnnotation == nil
&& modifiers.contains(where: { $0.name.text == "async" }) != true
}
}