-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Expand file tree
/
Copy pathImplicitOptionalInitializationRule.swift
More file actions
132 lines (117 loc) · 5.23 KB
/
ImplicitOptionalInitializationRule.swift
File metadata and controls
132 lines (117 loc) · 5.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
eimport SwiftSyntax
@SwiftSyntaxRule(explicitRewriter: true)
struct ImplicitOptionalInitializationRule: Rule {
var configuration = ImplicitOptionalInitializationConfiguration()
static let description = RuleDescription(
identifier: "implicit_optional_initialization",
name: "Implicit Optional Initialization",
description: "Optionals should be consistently initialized, either with `= nil` or without.",
kind: .style,
nonTriggeringExamples: ImplicitOptionalInitializationRuleExamples.nonTriggeringExamples,
triggeringExamples: ImplicitOptionalInitializationRuleExamples.triggeringExamples,
corrections: ImplicitOptionalInitializationRuleExamples.corrections,
deprecatedAliases: ["redundant_optional_initialization"]
)
}
private extension ImplicitOptionalInitializationRule {
final class Visitor: ViolationsSyntaxVisitor<ConfigurationType> {
var reason: String {
switch configuration.style {
case .always: "Optional should be implicitly initialized without nil"
case .never: "Optional should be explicitly initialized to nil"
}
}
override func visitPost(_ node: PatternBindingSyntax) {
guard let violationPosition = node.violationPosition(for: configuration.style) else { return }
// // violations.append(ReasonedRuleViolation(position: violationPosition, reason: reason))
override func visitPost(_ node: PatternBindingSyntax) {
if let variableDecl = node.parent?.as(VariableDeclSyntax.self),
let attrs = variableDecl.attributes,
attrs.contains(where: { attr in
guard let attribute = attr.as(AttributeSyntax.self) else { return false }
return attribute.attributeName.as(SimpleTypeIdentifierSyntax.self)?.name.text == "Parameter" }) {
return
}
guard let violationPosition = node.violationPosition(for: configuration.style) else { return }
violations.append(ReasonedRuleViolation(position: violationPosition, reason: reason))
}
{
final class Rewriter: ViolationsSyntaxRewriter<ConfigurationType> {
override func visit(_ node: PatternBindingSyntax) -> PatternBindingSyntax {
guard node.violationPosition(for: configuration.style) != nil else {
return super.visit(node)
}
self.numberOfCorrections += 1
return switch configuration.style {
case .never:
node
.with(
\.initializer,
InitializerClauseSyntax(
equal: .equalToken(
leadingTrivia: .space,
trailingTrivia: .space
),
value: ExprSyntax(NilLiteralExprSyntax(nilKeyword: .keyword(.nil))),
trailingTrivia: node.typeAnnotation?.trailingTrivia ?? Trivia()
)
)
.with(\.typeAnnotation, node.typeAnnotation?.with(\.trailingTrivia, Trivia()))
case .always:
node
.with(\.initializer, nil)
.with(
\.trailingTrivia,
node.accessorBlock == nil
? node.initializer?.trailingTrivia ?? Trivia()
: node.trailingTrivia
)
}
}
}
}
private extension PatternBindingSyntax {
func violationPosition(
for style: ImplicitOptionalInitializationConfiguration.Style
) -> AbsolutePosition? {
guard
let parent = parent?.parent?.as(VariableDeclSyntax.self),
parent.bindingSpecifier.tokenKind == .keyword(.var),
!parent.modifiers.contains(keyword: .lazy),
let typeAnnotation,
typeAnnotation.isOptionalType
else { return nil }
// ignore properties with accessors unless they have only willSet or didSet
if let accessorBlock {
if let accessors = accessorBlock.accessors.as(AccessorDeclListSyntax.self) {
if accessors.contains(where: {
$0.accessorSpecifier.tokenKind != .keyword(.willSet)
&& $0.accessorSpecifier.tokenKind != .keyword(.didSet)
}) { // we have more than willSet or didSet
return nil
}
} else { // code block, i.e. getter
return nil
}
}
if (style == .never && !initializer.isNil) || (style == .always && initializer.isNil) {
return positionAfterSkippingLeadingTrivia
}
return nil
}
}
private extension InitializerClauseSyntax? {
var isNil: Bool {
self?.value.is(NilLiteralExprSyntax.self) ?? false
}
}
private extension TypeAnnotationSyntax {
var isOptionalType: Bool {
if type.is(OptionalTypeSyntax.self) { return true }
if let type = type.as(IdentifierTypeSyntax.self),
let genericClause = type.genericArgumentClause {
return genericClause.arguments.count == 1 && type.name.text == "Optional"
}
return false
}
}