93 lines
2.8 KiB
Swift
93 lines
2.8 KiB
Swift
import SwiftSyntax
|
|
|
|
struct NSObjectPreferIsEqualRule: SwiftSyntaxRule, ConfigurationProviderRule {
|
|
var configuration = SeverityConfiguration(.warning)
|
|
|
|
init() {}
|
|
|
|
static let description = RuleDescription(
|
|
identifier: "nsobject_prefer_isequal",
|
|
name: "NSObject Prefer isEqual",
|
|
description: "NSObject subclasses should implement isEqual instead of ==",
|
|
kind: .lint,
|
|
nonTriggeringExamples: NSObjectPreferIsEqualRuleExamples.nonTriggeringExamples,
|
|
triggeringExamples: NSObjectPreferIsEqualRuleExamples.triggeringExamples
|
|
)
|
|
|
|
func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor {
|
|
Visitor(viewMode: .sourceAccurate)
|
|
}
|
|
}
|
|
|
|
private extension NSObjectPreferIsEqualRule {
|
|
final class Visitor: ViolationsSyntaxVisitor {
|
|
override var skippableDeclarations: [DeclSyntaxProtocol.Type] { .extensionsAndProtocols }
|
|
|
|
override func visitPost(_ node: FunctionDeclSyntax) {
|
|
if node.isSelfEqualFunction, node.isInObjcClass {
|
|
violations.append(node.positionAfterSkippingLeadingTrivia)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private extension ClassDeclSyntax {
|
|
var isObjC: Bool {
|
|
if attributes?.isObjc == true {
|
|
return true
|
|
}
|
|
|
|
guard let inheritanceList = inheritanceClause?.inheritedTypeCollection else {
|
|
return false
|
|
}
|
|
return inheritanceList.contains { type in
|
|
type.typeName.as(SimpleTypeIdentifierSyntax.self)?.name.text == "NSObject"
|
|
}
|
|
}
|
|
}
|
|
|
|
private extension FunctionDeclSyntax {
|
|
var isSelfEqualFunction: Bool {
|
|
guard
|
|
modifiers.isStatic,
|
|
identifier.text == "==",
|
|
returnsBool,
|
|
case let parameterList = signature.input.parameterList,
|
|
parameterList.count == 2,
|
|
let lhs = parameterList.first,
|
|
let rhs = parameterList.last,
|
|
lhs.firstName?.text == "lhs",
|
|
rhs.firstName?.text == "rhs",
|
|
let lhsTypeDescription = lhs.type?.withoutTrivia().description,
|
|
let rhsTypeDescription = rhs.type?.withoutTrivia().description,
|
|
lhsTypeDescription == rhsTypeDescription
|
|
else {
|
|
return false
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
var returnsBool: Bool {
|
|
signature.output?.returnType.as(SimpleTypeIdentifierSyntax.self)?.name.text == "Bool"
|
|
}
|
|
}
|
|
|
|
private extension SyntaxProtocol {
|
|
var isInObjcClass: Bool {
|
|
if let parentClass = parent?.as(ClassDeclSyntax.self) {
|
|
return parentClass.isObjC
|
|
} else if parent?.as(DeclSyntax.self) != nil {
|
|
return false
|
|
}
|
|
|
|
return parent?.isInObjcClass ?? false
|
|
}
|
|
}
|
|
|
|
private extension AttributeListSyntax {
|
|
var isObjc: Bool {
|
|
contains { ["objc", "objcMembers"].contains($0.as(AttributeSyntax.self)?.attributeName.text) }
|
|
}
|
|
}
|