Skip to content

Commit 34e7885

Browse files
talanovtalanov
committed
Add explicit_return opt-in rule: rebase, upgrade
1 parent 83850a7 commit 34e7885

9 files changed

Lines changed: 462 additions & 337 deletions

File tree

‎.swiftlint.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ disabled_rules:
2525
- discouraged_optional_collection
2626
- explicit_acl
2727
- explicit_enum_raw_value
28+
- explicit_return
2829
- explicit_top_level_acl
2930
- explicit_type_interface
3031
- file_types_order

‎CHANGELOG.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@
3333
built-in rules in accordance with the SARIF specification.
3434
[ahmadalfy](https://github.com/ahmadalfy)
3535
[#6499](https://github.com/realm/SwiftLint/issues/6499)
36+
37+
* Add `explicit_return` opt-in rule that warns against omitting the `return`
38+
keyword inside closures, functions and getters.
39+
[m-chojnacki](https://github.com/m-chojnacki)
40+
[talanov](https://github.com/talanov)
41+
[#3632](https://github.com/realm/SwiftLint/issues/3632)
42+
[#3859](https://github.com/realm/SwiftLint/issues/3859)
3643

3744
* Add `allow_underscore_prefixed_names` option to `unused_parameter` so
3845
underscore-prefixed parameter names can be treated as intentionally
@@ -3011,10 +3018,6 @@ accordingly._
30113018
[JP Simard](https://github.com/jpsim)
30123019

30133020
### Bug Fixes
3014-
* Add `explicit_return` opt-in rule that warns against omitting the `return`
3015-
keyword inside closures, functions and getters.
3016-
3017-
#### Bug Fixes
30183021

30193022
* Fix false positive in `self_in_property_initialization` rule when using
30203023
closures inside `didSet` and other accessors.

‎Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/ExplicitReturnConfiguration.swift‎

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,32 @@
1-
public struct ExplicitReturnConfiguration: RuleConfiguration, Equatable {
2-
public enum ReturnKind: String, CaseIterable {
1+
import SwiftLintCore
2+
3+
@AutoConfigParser
4+
struct ExplicitReturnConfiguration: SeverityBasedRuleConfiguration {
5+
@AcceptableByConfigurationElement
6+
enum ReturnKind: String, CaseIterable, Comparable {
37
case closure
48
case function
59
case getter
6-
}
10+
case `subscript`
11+
case initializer
712

8-
public static let defaultIncludedKinds = Set(ReturnKind.allCases)
13+
static func < (lhs: Self, rhs: Self) -> Bool {
14+
lhs.rawValue < rhs.rawValue
15+
}
16+
}
917

10-
private(set) var severityConfiguration = SeverityConfiguration(.warning)
18+
static let defaultIncludedKinds = Set(ReturnKind.allCases)
1119

20+
@ConfigurationElement(key: "severity")
21+
private(set) var severityConfiguration = SeverityConfiguration<Parent>(.warning)
22+
@ConfigurationElement(key: "included")
1223
private(set) var includedKinds = Self.defaultIncludedKinds
1324

14-
public var consoleDescription: String {
15-
let includedKinds = self.includedKinds.map { $0.rawValue }
16-
return severityConfiguration.consoleDescription +
17-
", included: [\(includedKinds.sorted().joined(separator: ", "))]"
18-
}
19-
20-
public init(includedKinds: Set<ReturnKind> = Self.defaultIncludedKinds) {
25+
init(includedKinds: Set<ReturnKind> = Self.defaultIncludedKinds) {
2126
self.includedKinds = includedKinds
2227
}
2328

24-
public mutating func apply(configuration: Any) throws {
25-
guard let configuration = configuration as? [String: Any] else {
26-
throw ConfigurationError.unknownConfiguration
27-
}
28-
29-
if let includedKinds = configuration["included"] as? [String] {
30-
self.includedKinds = try Set(includedKinds.map {
31-
guard let kind = ReturnKind(rawValue: $0) else {
32-
throw ConfigurationError.unknownConfiguration
33-
}
34-
35-
return kind
36-
})
37-
}
38-
39-
if let severityString = configuration["severity"] as? String {
40-
try severityConfiguration.apply(configuration: severityString)
41-
}
42-
}
43-
44-
public func isKindIncluded(_ kind: ReturnKind) -> Bool {
45-
return self.includedKinds.contains(kind)
29+
func isKindIncluded(_ kind: ReturnKind) -> Bool {
30+
includedKinds.contains(kind)
4631
}
4732
}

‎Source/SwiftLintBuiltInRules/Rules/Style/ExplicitReturnRule.swift‎

Lines changed: 64 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,97 @@
11
import Foundation
2-
import SourceKittenFramework
32
import SwiftSyntax
43

5-
public struct ExplicitReturnRule: ConfigurationProviderRule, SubstitutionCorrectableRule, OptInRule {
6-
public var configuration = ExplicitReturnConfiguration()
4+
@SwiftSyntaxRule(correctable: true, optIn: true)
5+
struct ExplicitReturnRule: Rule {
6+
var configuration = ExplicitReturnConfiguration()
77

8-
public init() {}
9-
10-
public static let description = RuleDescription(
8+
static let description = RuleDescription(
119
identifier: "explicit_return",
1210
name: "Explicit Return",
13-
description: "Prefer explicit returns in closures, functions and getters.",
11+
description: "Prefer explicit returns in closures, functions and getters",
1412
kind: .style,
1513
nonTriggeringExamples: ExplicitReturnRuleExamples.nonTriggeringExamples,
1614
triggeringExamples: ExplicitReturnRuleExamples.triggeringExamples,
1715
corrections: ExplicitReturnRuleExamples.corrections
1816
)
19-
20-
public func validate(file: SwiftLintFile) -> [StyleViolation] {
21-
return violations(file: file).map {
22-
StyleViolation(
23-
ruleDescription: Self.description,
24-
severity: configuration.severityConfiguration.severity,
25-
location: Location(file: file, byteOffset: $0)
26-
)
27-
}
28-
}
29-
30-
public func violationRanges(in file: SwiftLintFile) -> [NSRange] {
31-
return violations(file: file).compactMap {
32-
file.stringView.byteRangeToNSRange(ByteRange(location: $0, length: 0))
33-
}
34-
}
35-
36-
public func substitution(for violationRange: NSRange, in file: SwiftLintFile) -> (NSRange, String)? {
37-
return (violationRange, "return ")
38-
}
39-
40-
private func violations(file: SwiftLintFile) -> [ByteCount] {
41-
guard let tree = file.syntaxTree else { return [] }
42-
43-
let visitor = ExplicitReturnVisitor(includedKinds: configuration.includedKinds)
44-
visitor.walk(tree)
45-
46-
return visitor.positions.map { ByteCount($0.utf8Offset) }
47-
}
4817
}
4918

50-
private final class ExplicitReturnVisitor: SyntaxVisitor {
51-
private let includedKinds: Set<ExplicitReturnConfiguration.ReturnKind>
52-
53-
private(set) var positions: [AbsolutePosition] = []
54-
55-
init(includedKinds: Set<ExplicitReturnConfiguration.ReturnKind>) {
56-
self.includedKinds = includedKinds
57-
}
58-
59-
override func visitPost(_ node: ClosureExprSyntax) {
60-
guard includedKinds.contains(.closure),
61-
let firstItem = node.statements.first?.item,
62-
node.statements.count == 1 else { return }
19+
private extension ExplicitReturnRule {
20+
final class Visitor: ViolationsSyntaxVisitor<ConfigurationType> {
21+
override var skippableDeclarations: [any DeclSyntaxProtocol.Type] { [ProtocolDeclSyntax.self] }
6322

64-
if firstItem.isImplicitlyReturnable {
65-
positions.append(firstItem.positionAfterSkippingLeadingTrivia)
23+
override func visitPost(_ node: AccessorDeclSyntax) {
24+
if configuration.isKindIncluded(.getter),
25+
node.accessorSpecifier.tokenKind == .keyword(.get),
26+
let body = node.body {
27+
collectViolation(in: body.statements)
28+
}
6629
}
67-
}
68-
69-
override func visitPost(_ node: FunctionDeclSyntax) {
70-
guard includedKinds.contains(.function),
71-
node.signature.allowsImplicitReturns,
72-
let firstItem = node.body?.statements.first?.item,
73-
node.body?.statements.count == 1 else { return }
7430

75-
if firstItem.isImplicitlyReturnable {
76-
positions.append(firstItem.positionAfterSkippingLeadingTrivia)
31+
override func visitPost(_ node: ClosureExprSyntax) {
32+
if configuration.isKindIncluded(.closure) {
33+
collectViolation(in: node.statements)
34+
}
7735
}
78-
}
7936

80-
override func visitPost(_ node: VariableDeclSyntax) {
81-
guard includedKinds.contains(.getter) else { return }
37+
override func visitPost(_ node: FunctionDeclSyntax) {
38+
if configuration.isKindIncluded(.function),
39+
node.signature.allowsImplicitReturns,
40+
let body = node.body {
41+
collectViolation(in: body.statements)
42+
}
43+
}
8244

83-
for binding in node.bindings {
84-
if let accessor = binding.accessor?.as(CodeBlockSyntax.self) {
85-
// Shorthand syntax for getters: `var foo: Int { 0 }`
86-
guard let firstItem = accessor.statements.first?.item,
87-
accessor.statements.count == 1 else { continue }
45+
override func visitPost(_ node: InitializerDeclSyntax) {
46+
if configuration.isKindIncluded(.initializer),
47+
node.optionalMark != nil,
48+
let body = node.body {
49+
collectViolation(in: body.statements)
50+
}
51+
}
8852

89-
if firstItem.isImplicitlyReturnable {
90-
positions.append(firstItem.positionAfterSkippingLeadingTrivia)
91-
}
92-
} else if let accessorBlock = binding.accessor?.as(AccessorBlockSyntax.self) {
93-
// Full syntax for getters: `var foo: Int { get { 0 } }`
94-
guard let accessor = accessorBlock.accessors.first(where: { $0.accessorKind.text == "get" }),
95-
let firstItem = accessor.body?.statements.first?.item,
96-
accessor.body?.statements.count == 1 else { continue }
53+
override func visitPost(_ node: PatternBindingSyntax) {
54+
if configuration.isKindIncluded(.getter),
55+
case let .getter(itemList) = node.accessorBlock?.accessors {
56+
collectViolation(in: itemList)
57+
}
58+
}
9759

98-
if firstItem.isImplicitlyReturnable {
99-
positions.append(firstItem.positionAfterSkippingLeadingTrivia)
100-
}
60+
override func visitPost(_ node: SubscriptDeclSyntax) {
61+
if configuration.isKindIncluded(.subscript),
62+
case let .getter(itemList) = node.accessorBlock?.accessors {
63+
collectViolation(in: itemList)
10164
}
10265
}
103-
}
104-
}
10566

106-
private extension Syntax {
107-
var isImplicitlyReturnable: Bool {
108-
isProtocol(ExprSyntaxProtocol.self)
67+
private func collectViolation(in itemList: CodeBlockItemListSyntax) {
68+
guard let onlyItem = itemList.onlyElement?.item,
69+
!onlyItem.is(ReturnStmtSyntax.self),
70+
Syntax(onlyItem).isProtocol((any ExprSyntaxProtocol).self) else {
71+
return
72+
}
73+
let position = onlyItem.positionAfterSkippingLeadingTrivia
74+
violations.append(
75+
at: position,
76+
correction: .init(
77+
start: position,
78+
end: position,
79+
replacement: "return "
80+
)
81+
)
82+
}
10983
}
11084
}
11185

11286
private extension FunctionSignatureSyntax {
11387
var allowsImplicitReturns: Bool {
114-
if let simpleType = output?.returnType.as(SimpleTypeIdentifierSyntax.self) {
115-
return simpleType.name.text != "Void" && simpleType.name.text != "Never"
116-
} else if let tupleType = output?.returnType.as(TupleTypeSyntax.self) {
88+
guard let returnClause else { return false }
89+
if let identifierType = returnClause.type.as(IdentifierTypeSyntax.self) {
90+
return identifierType.name.text != "Void" && identifierType.name.text != "Never"
91+
}
92+
if let tupleType = returnClause.type.as(TupleTypeSyntax.self) {
11793
return !tupleType.elements.isEmpty
118-
} else {
119-
return output != nil
12094
}
95+
return true
12196
}
12297
}

0 commit comments

Comments
 (0)