dnrops
/
SwiftLint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Extract examples

This commit is contained in:
Danny Mösch 2023-06-13 22:52:10 +02:00
parent 83ab977a1b
commit ba42a6aa36
2 changed files with 230 additions and 225 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

228
Source/SwiftLintBuiltInRules/Rules/Style/RedundantSelfInClosureRule.swift
View File

@ -1,7 +1,5 @@
import SwiftSyntax import SwiftSyntax
// swiftlint:disable file_length
struct RedundantSelfInClosureRule: SwiftSyntaxRule, CorrectableRule, ConfigurationProviderRule, OptInRule { struct RedundantSelfInClosureRule: SwiftSyntaxRule, CorrectableRule, ConfigurationProviderRule, OptInRule {
var configuration = SeverityConfiguration<Self>(.warning) var configuration = SeverityConfiguration<Self>(.warning)
@ -10,231 +8,11 @@ struct RedundantSelfInClosureRule: SwiftSyntaxRule, CorrectableRule, Configurati
name: "Redundant Self in Closure", name: "Redundant Self in Closure",
description: "Explicit use of 'self' is not required", description: "Explicit use of 'self' is not required",
kind: .style, kind: .style,
nonTriggeringExamples: [ nonTriggeringExamples: RedundantSelfInClosureRuleExamples.nonTriggeringExamples,
Example(""" triggeringExamples: RedundantSelfInClosureRuleExamples.triggeringExamples,
struct S { corrections: RedundantSelfInClosureRuleExamples.corrections
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
x = 1
f { x = 1 }
g()
}
}
}
"""),
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [weak self] in
self?.x = 1
self?.g()
guard let self = self ?? C() else { return }
self?.x = 1
}
C().f { self.x = 1 }
f { [weak self] in if let self { x = 1 } }
}
}
"""),
Example("""
struct S {
var x = 0, error = 0, exception = 0
var y: Int?, z: Int?, u: Int, v: Int?, w: Int?
func f(_ work: @escaping (Int) -> Void) { work() }
func g(x: Int) {
f { u in
self.x = x
let x = 1
self.x = 2
if let y, let v {
self.y = 3
self.v = 1
}
guard let z else {
let v = 4
self.x = 5
self.v = 6
return
}
self.z = 7
while let v { self.v = 8 }
for w in [Int]() { self.w = 9 }
self.u = u
do {} catch { self.error = 10 }
do {} catch let exception { self.exception = 11 }
}
}
}
"""),
Example("""
enum E {
case a(Int)
case b(Int, Int)
}
struct S {
var x: E = .a(3), y: Int, z: Int
func f(_ work: @escaping () -> Void) { work() }
func g(x: Int) {
f {
switch x {
case let .a(y):
self.y = 1
case .b(let y, var z):
self.y = 2
self.z = 3
}
}
}
}
""")
],
triggeringExamples: [
Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
↓self.x = 1
if ↓self.x == 1 { ↓self.g() }
}
}
}
"""),
Example("""
class C {
var x = 0
func g() {
{
↓self.x = 1
↓self.g()
}()
}
}
"""),
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [self] in
↓self.x = 1
↓self.g()
f { self.x = 1 }
}
}
}
"""),
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [unowned self] in ↓self.x = 1 }
f { [self = self] in ↓self.x = 1 }
f { [s = self] in s.x = 1 }
}
}
"""),
Example("""
struct S {
var x = 0
var y: Int?, z: Int?, v: Int?, w: Int?
func f(_ work: @escaping () -> Void) { work() }
func g(w: Int, _ v: Int) {
f {
self.w = 1
↓self.x = 2
if let y { ↓self.x = 3 }
else { ↓self.y = 3 }
guard let z else {
↓self.z = 4
↓self.x = 5
return
}
↓self.y = 6
while let y { ↓self.x = 7 }
for y in [Int]() { ↓self.x = 8 }
self.v = 9
do {
let x = 10
self.x = 11
}
↓self.x = 12
}
}
}
"""),
Example("""
struct S {
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { let g = ↓self.g() }
}
}
""", excludeFromDocumentation: true)
] + triggeringCompilerSpecificExamples,
corrections: [
Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
↓self.x = 1
if ↓self.x == 1 { ↓self.g() }
}
}
}
"""): Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
x = 1
if x == 1 { g() }
}
}
}
""")
]
) )
#if compiler(>=5.8)
private static let triggeringCompilerSpecificExamples = [
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [weak self] in
self?.x = 1
guard let self else { return }
↓self.x = 1
}
f { [weak self] in
self?.x = 1
if let self = self else { ↓self.x = 1 }
self?.x = 1
}
f { [weak self] in
self?.x = 1
while let self else { ↓self.x = 1 }
self?.x = 1
}
}
}
""")
]
#else
private static let triggeringCompilerSpecificExamples = [Example]()
#endif
func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor { func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor {
ContextVisitor() ContextVisitor()
} }

227
Source/SwiftLintBuiltInRules/Rules/Style/RedundantSelfInClosureRuleExamples.swift Normal file
View File

@ -0,0 +1,227 @@
struct RedundantSelfInClosureRuleExamples {
static let nonTriggeringExamples = [
Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
x = 1
f { x = 1 }
g()
}
}
}
"""),
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [weak self] in
self?.x = 1
self?.g()
guard let self = self ?? C() else { return }
self?.x = 1
}
C().f { self.x = 1 }
f { [weak self] in if let self { x = 1 } }
}
}
"""),
Example("""
struct S {
var x = 0, error = 0, exception = 0
var y: Int?, z: Int?, u: Int, v: Int?, w: Int?
func f(_ work: @escaping (Int) -> Void) { work() }
func g(x: Int) {
f { u in
self.x = x
let x = 1
self.x = 2
if let y, let v {
self.y = 3
self.v = 1
}
guard let z else {
let v = 4
self.x = 5
self.v = 6
return
}
self.z = 7
while let v { self.v = 8 }
for w in [Int]() { self.w = 9 }
self.u = u
do {} catch { self.error = 10 }
do {} catch let exception { self.exception = 11 }
}
}
}
"""),
Example("""
enum E {
case a(Int)
case b(Int, Int)
}
struct S {
var x: E = .a(3), y: Int, z: Int
func f(_ work: @escaping () -> Void) { work() }
func g(x: Int) {
f {
switch x {
case let .a(y):
self.y = 1
case .b(let y, var z):
self.y = 2
self.z = 3
}
}
}
}
""")
]
static let triggeringExamples = [
Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
↓self.x = 1
if ↓self.x == 1 { ↓self.g() }
}
}
}
"""),
Example("""
class C {
var x = 0
func g() {
{
↓self.x = 1
↓self.g()
}()
}
}
"""),
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [self] in
↓self.x = 1
↓self.g()
f { self.x = 1 }
}
}
}
"""),
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [unowned self] in ↓self.x = 1 }
f { [self = self] in ↓self.x = 1 }
f { [s = self] in s.x = 1 }
}
}
"""),
Example("""
struct S {
var x = 0
var y: Int?, z: Int?, v: Int?, w: Int?
func f(_ work: @escaping () -> Void) { work() }
func g(w: Int, _ v: Int) {
f {
self.w = 1
↓self.x = 2
if let y { ↓self.x = 3 }
else { ↓self.y = 3 }
guard let z else {
↓self.z = 4
↓self.x = 5
return
}
↓self.y = 6
while let y { ↓self.x = 7 }
for y in [Int]() { ↓self.x = 8 }
self.v = 9
do {
let x = 10
self.x = 11
}
↓self.x = 12
}
}
}
"""),
Example("""
struct S {
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { let g = ↓self.g() }
}
}
""", excludeFromDocumentation: true)
] + triggeringCompilerSpecificExamples
static let corrections = [
Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
↓self.x = 1
if ↓self.x == 1 { ↓self.g() }
}
}
}
"""): Example("""
struct S {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f {
x = 1
if x == 1 { g() }
}
}
}
""")
]
#if compiler(>=5.8)
private static let triggeringCompilerSpecificExamples = [
Example("""
class C {
var x = 0
func f(_ work: @escaping () -> Void) { work() }
func g() {
f { [weak self] in
self?.x = 1
guard let self else { return }
↓self.x = 1
}
f { [weak self] in
self?.x = 1
if let self = self else { ↓self.x = 1 }
self?.x = 1
}
f { [weak self] in
self?.x = 1
while let self else { ↓self.x = 1 }
self?.x = 1
}
}
}
""")
]
#else
private static let triggeringCompilerSpecificExamples = [Example]()
#endif
}