Files
SwiftLint/Source/SwiftLintFramework/Rules/Performance/ContainsOverRangeNilComparisonRule.swift
T
Danny Mösch 449190d324 Verify examples in rules by default and enforce explicit exclusion (#4065)
A rule must conform to ManuallyTestedExamplesRule to skip generation of a test for its examples.
2022-08-09 22:32:09 +02:00

35 lines
1.5 KiB
Swift

import SourceKittenFramework
public struct ContainsOverRangeNilComparisonRule: CallPairRule, OptInRule, ConfigurationProviderRule {
public var configuration = SeverityConfiguration(.warning)
public init() {}
public static let description = RuleDescription(
identifier: "contains_over_range_nil_comparison",
name: "Contains over range(of:) comparison to nil",
description: "Prefer `contains` over `range(of:) != nil` and `range(of:) == nil`.",
kind: .performance,
nonTriggeringExamples: [
Example("let range = myString.range(of: \"Test\")"),
Example("myString.contains(\"Test\")"),
Example("!myString.contains(\"Test\")"),
Example("resourceString.range(of: rule.regex, options: .regularExpression) != nil")
],
triggeringExamples: ["!=", "=="].flatMap { comparison in
return [
Example("↓myString.range(of: \"Test\") \(comparison) nil")
]
}
)
public func validate(file: SwiftLintFile) -> [StyleViolation] {
let pattern = "\\)\\s*(==|!=)\\s*nil"
return validate(file: file, pattern: pattern, patternSyntaxKinds: [.keyword],
callNameSuffix: ".range", severity: configuration.severity,
reason: "Prefer `contains` over range(of:) comparison to nil") { expression in
return expression.enclosedArguments.map { $0.name } == ["of"]
}
}
}