SwiftLint를 적용하면서 수정한 것들🙀

🐥입사 전에는 프로젝트를 할 때, 항상 SwiftLint를 적용하며 개발했었다.

 

입사 후, 회사 프로젝트에서는 린트가 적용되어 있지 않았고, 그 필요성을 느껴 린트 적용을 제안했다. 작성되어 있던 코드들에서 수많은 에러가 났고, 다소 번거로운 작업들도 있었지만, 무의식적으로 작성하던 코드가 권장되는 컨벤션이었다는 것도 알게 되고, 모르던 컨벤션들도 새로 알게 되어 의미 있었다고 생각한다.

 

아래의 글은 프로젝트에 린트를 적용하며 수정했던 과정에 대한 기록이다.👩‍💻

 

2020년 8월 14일 금요일 (warning: 999+, error: 999+)로 시작

SwiftLint 최초 적용시 약 11826개의 에러로 시작함😱 (999+/999+)

[ 2020.8.14 ]

 

 

제외할 규칙과 파일들을 추가하면서 총 3702개가 됨 (999+/105)

[ 2020.8.14 ]

// .swiftlint.yml

disabled_rules:
- leading_whitespace
- trailing_whitespace

excluded:
- 파일 위치/AppDelegate.swift
- Pods

 

 

line_length 제외 추가 총 3473개 (999+/89)

[ 2020.8.14 ]

 

전반적으로 길게 작성된 코드들이 많았고, 우선 제외했다.

// .swiftlint.yml

disabled_rules:
- line_length

 

 

Libaries 제외 총 2553개 (999+/78)

[ 2020.8.14 ]

외부 라이브러리 파일도 추가로 제외했다.

// swiftlint.yml

excluded:
- Libraries

 

 

2020년 8월 18일 화요일 (warning: 999+, error:78) 로 시작😹

Force Cast Violation: Force casts should be avoided. (force_cast)

[ 24개 - 2020.8.18 ]

강제 캐스팅하는 부분이 없도록 수정하였다. 아래는 그 중 대표적인 2가지 예시다.

Dictionary extention 수정

[ 4개 - 2020.8.18 ]

딕셔너리의 키값을 소문자나 대문자로 바꾸는 함수가 extension에 정의되어 있었는데, 강제 캐스팅을 하는 방식이었다.

아래의 출처를 통해 강제 캐스팅이 없도록 수정하였다. 

// 변경 전 
extension Dictionary where Key: ExpressibleByStringLiteral {
    mutating func lowercaseKeys() {
        for key in self.keys {
            let str = (key as! String).lowercased()
            self[str as! Key] = self.removeValue(forKey: key)
        }
    }

    mutating func uppercaseKeys() {
        for key in self.keys {
            let str = (key as! String).uppercased()
            self[str as! Key] = self.removeValue(forKey: key)

        }
    }
}

// 변경 후
extension Dictionary where Key: StringProtocol {
    mutating func setAllKeysLowercase() {
        for key in self.keys {
            if let lowercaseKey = key.lowercased() as? Key {
                self[lowercaseKey] = self.removeValue(forKey: key)
            }
        }
    }

    mutating func setAllKeysUppercase() {
        for key in self.keys {
            if let uppercaseKey = key.uppercased() as? Key {
                self[uppercaseKey] = self.removeValue(forKey: key)
            }
        }
    }
}

// 출처: https://stackoverflow.com/questions/33180028/extend-dictionary-where-key-is-of-type-string

 

UserDefaults value as! Int 강제 캐스팅

[ 2개 - 2020.8.18 ]

`Int`값을 갖고 있는 UserDefaults는 강제 캐스팅하지 않고 `func integer(forKey defaultName: String) -> Int`를 사용하면 된다.

// 변경 전
return FontSize(rawValue: UserDefaults.standard.value(forKey: "키값") as! Int)

// 변경 후
return FontSize(rawValue: UserDefaults.standard.integer(forKey: "키값"))

 

Type Name Violation: Type name should only contain alphanumeric characters: 'LINE_POSITION' (type_name)
Identifier Name Violation: Enum element name should only contain alphanumeric characters: 'LINE_POSITION_TOP' (identifier_name)

[ 8개 - 2020.8.18 ]

스위프트에서는 카멜케이스🐫가 기본 명명법으로 사용하고 있다. 또한 Enum 타입명은 대문자로 시작하고, case는 소문자로 시작한다.

// 변경 전
enum LINE_POSITION {
    case LINE_POSITION_TOP
    case LINE_POSITION_BOTTOM
}

// 변경 후 
enum LinePosition {
    case top
    case bottom
}

 

Force Try Violation: Force tries should be avoided. (force_try) 

[3개 - 2020.8.18 ]

try! 구문을 사용했는데 에러가 발생하면 런타임 에러를 발생시키고, 앱이 강제 종료되므로 try? 구문이 권장된다.

// 변경 전
let realm = try! Realm()

// 변경 후
let realm = try? Realm()

 

Shorthand Operator Violation: Prefer shorthand operators (+=, -=, *=, /=) over doing the operation and assigning. (shorthand_operator) 2889 (999+, 9)

[ 1개 - 2020.8.18 ]

연산을 할 때, 프로퍼티를 반복적으로 명시하는 것보다 축약된 연산 표현을 쓰는 것을 권장한다.

// 변경 전
naviHeight = naviHeight + top

// 변경 후
naviHeight += top

 

Vertical Whitespace Violation: Limit vertical whitespace to a single empty line. Currently 2. (vertical_whitespace) 2946 (999+, 9) 

[ 100여개 - 2020.8.18 ]

코드 사이에 한 줄씩만 띄도록 수정했다.

 

Colon Violation: Colons should be next to the identifier when specifying a type and next to the key in dictionary literals. (colon) 

[ 900여개 - 2020.8.18 ]

스위프트에서는 타입 정의(let a: Int?)나 딕셔너리에서(Dictionary[key: _, value: _]) 콜론`:`을 사용할 때, 앞은 붙이고 뒤는 한 칸 스페이스를 넣는 게 일반적이다. 많은 부분이 그렇지 않아, 모두 수정을 하였다.

// 변경 전
var localized:String {}

// 변경 후
var localized: String {}

 

Trailing Semicolon Violation: Lines should not have trailing semicolons. (trailing_semicolon) (999+, 9) 

[ 4개 - 2020.8.18 ]

코드 끝에 세미콜론`;`이 붙어 있는 경우가 있었다. 스위프트에서는 세미콜론을 사용하지 않는 것이 일반적이므로 삭제했다.

 

 

Unneeded Break in Switch Violation: Avoid using unneeded break statements. (unneeded_break_in_switch) (999+, 9) 

[ 10개 - 2020.8.18 ]

스위프트의 Switch 문은 case를 만족시킨 후에 다음 case로 fall through를 하지 않아, break문이 필요없다.  case에 대한 동작이 아무것도 없을 때만 사용하면 되기 때문에 불필요한 break문을 제거했다.

 

 

Unneeded NotificationCenter Removal Violation: Observers are automatically unregistered on dealloc (iOS 9 / macOS 10.11) so you should't call removeObserver(self) in the deinit. (unneeded_notification_center_removal) 

[ 4개 - 2020.8.18 ]

(스위프트는 더 이상 필요하지 않은 인스턴스를 자동으로 할당 해제하여 리소스를 확보한다. Swift는 자동 참조 계산(ARC)을 통해 인스턴스의 메모리 관리를 처리한다. 일반적으로 인스턴스 할당이 해제될 때 수동으로 정리할 필요가 없다.)

 

OS X 10.11와 iOS 9.0부터 NSNotificationCenter 및 NSDistributedNotificationCenter는 더 이상 할당이 해제되려는 등록된 옵저버에게 알림을 보내지 않는다. 따라서, 옵저버가 할당 해제 방법으로 등록을 취소할 필요가 없다.

-[NSNotificationCenter addObserverForName : object : queue : usingBlock] 메서드를 통한 블록 기반 옵저버는 시스템이 여전히 이러한 옵저버에 대한 강력한 참조를 보유하므로 더 이상 사용하지 않을 때는 등록을 해제해야 한다. 만약 제대로 제거해 주지 않으면 옵저버가 소속된 객체가 해제되었을 때, Notification 이 전달되면 앱이 죽는다.

 

따라서, deinit에서 removeObserver(self)를 호출하지 않아도 되므로 삭제하였다. 

 

 

Unused Closure Parameter Violation: Unused parameter "timer" in a closure should be replaced with _. (unused_closure_parameter) 

[ 54개 - 2020.8.18 ]

사용하지 않는 클로저 파라미터들을 `_` 와일드카드 식별자로 변경하였다. 

// 변경 전
webRTCClient?.set(remoteSdp: description, completion: { (error) in

// 변경 후
webRTCClient?.set(remoteSdp: description, completion: { _ in

 

 

2020년 8월 19일 수요일 (warning: 741, error:9)로 시작🤯

Opening Brace Spacing Violation: Opening braces should be preceded by a single space and on the same line as the declaration. (opening_brace)  (741, 9)

[ 1076개 - 2020.8.19 ]

함수 등에서 앞의 대괄호`{`를 열 때, 앞 쪽에 공백이 한 칸 들어가야 하는데, 붙어 있는 것들을 모두 수정했다.

// 변경 전
func setTableView(){}

// 변경 후
func setTableView() {}

 

또한, 불필요한 주석과 iOS 버전별 분기 처리 부분을 삭제했다. 개발 초반에는 iOS 10부터 지원하려고 했으나, 개발 과정에서 iOS 11로 변경되었다. iOS 10을 위한 분기 처리가 남아있어, 이를 삭제하였다. 

 

 

 

2020년 8월 20일 목요일 (warning: 767, error: 8)로 시작😣

Switch and Case Statement Alignment Violation: Case statements should vertically align with their enclosing switch statement. (switch_case_alignment) (767, 8) 

[ 10개 - 2020.8.20 ]

스위프트의 Switch문은 Case 구문과 앞쪽이 동일하게 정렬이 되어야 하는데 그렇지 않은 부분이 있어 수정했다.

// 변경 전
switch something {
case .A:
    ...
    case .B:
    ...
    default:
    ...

// 변경 후
switch something {
case .A:
...
case .B:
...
default:
...

 

Control Statement Violation: if, for, guard, switch, while, and catch statements shouldn't unnecessarily wrap their conditionals or arguments in parentheses. (control_statement) (757, 8) 

[ 2개 - 2020.8.20 ]

스위프트에서는 if 구문 등의 조건 부분을 소괄호로 묶지 않아도 된다.

// 변경 전
if(widthRatio > heightRatio) {}

// 변경 후
if widthRatio > heightRatio {}

 

Comma Spacing Violation: There should be no space before and one after any comma. (comma) 

[ 26개 - 2020.8.20 ]

콤마`,`를 사용한 경우, 그 앞은 붙고 그 뒤는 한 칸씩 공백이 들어가야 하는데 그렇지 않은 경우들이 있어서 수정했다.

 

 

Statement Position Violation: Else and catch should be on the same line, one space after the previous declaration. (statement_position) 

[ 297개 - 2020.8.20 ]

else 구문이 이전 괄호와 동일한 줄에 표시하는 것을 권장한다.

// 변경 전
if {

}
else {

}



// 변경 후 
if { 

} else {

}

 

Mark Violation: MARK comment should be in valid format. e.g. '// MARK: ...' or '// MARK: - ...' (mark)  (445, 8)

[ 4개 - 2020.8.20 ]

Mark 주석의 형태는 `// MARK:` 나 `// MARK: -`를 사용해야 한다.

 

 

Returning Whitespace Violation: Return arrow and return type should be separated by a single space or on a separate line. (return_arrow_whitespace) (441, 8)

[ 42개 - 2020.8.20 ]

반환 타입을 알려주는 화살표`->`와 반환 타입 사이에 공백이 한 칸씩 필요한데 붙어 있는 경우들이 있었다.

// 변경 전
func 함수()->반환타입 {}

// 변경 후
func 함수() -> 반환타입 {}

 

Weak Delegate Violation: Delegates should be weak to avoid reference cycles. (weak_delegate) 

[ 5개 - 2020.8.20 ]

delegate 프로퍼티는 순환 참조를 막기 위해 weak 참조를 해야 한다. 

// 변경 전
var delegate: 클래스Delegate?

// 변경 후
weak var delegate: 클래스Delegate?

 

Class Delegate Protocol Violation: Delegate protocols should be class-only so they can be weakly referenced. (class_delegate_protocol) 

[ 2개 - 2020.8.20 ]

delegate 프로토콜은 약한 참조를 할 수 있도록 class 전용이 되어야 한다.

// 변경 전
protocol 클래스Delegate {
...
}

// 변경 후
protocol 클래스Delegate: class {
    ...
}

 

Trailing Newline Violation: Files should have a single trailing newline. (trailing_newline)

[ 8개 - 2020.8.20 ]

파일의 끝에 빈 줄이 여러 줄인 경우가 있었다. 파일의 끝에 빈 줄은 한 줄만 들어가는 것을 권장한다.

 

 

No Space in Method Call Violation: Don't add a space between the method name and the parentheses. (no_space_in_method_call) (378, 8)

[ 6개 - 2020.8.20 ]

메서드 호출 시에 메서드와 괄호 사이에 공백이 들어가는 경우가 있었다. 붙이는 것을 권장하고 있다.

 

 

Syntactic Sugar Violation: Shorthand syntactic sugar should be used, i.e. [String: Int] instead of Dictionary<String, Int>. (syntactic_sugar)

[ 102개 - 2020.8.20 ]

Dictionary 타입을 사용할 때, `Dictionary<Key, Value>` 보다 `[Key: Value]`로 명시하는 것을 권장한다.

// 변경 전
var 파라미터 = Dictionary<String, Int>()

// 변경 후
var 파라미터 = [String: Int]()

 

 

Syntactic Sugar Violation: Shorthand syntactic sugar should be used, i.e. [Int] instead of Array. (syntactic_sugar)

[ 32개 - 2020.8.20 ]

Array 타입을 사용할 때, `Array<Element>` 보다 `[Element]`로 명시하는 것을 권장한다.

// 변경 전
var 파라미터 = Array<String>()

// 변경 후
var 파라미터 = [String]()

 

 

Void Return Violation: Prefer -> Void over -> (). (void_return) 

[ 1개 - 2020.8.20 ]

Void 타입을 반환하는 경우, 빈 괄호 `()`를 쓰는 것보다 `Void`를 명시하는 것을 권장한다.

// 변경 전
func 함수(completion: @escaping () -> ()) {}

// 변경 후
func 함수(completion: @escaping () -> Void) {}

 

 

Computed Accessors Order Violation: Computed properties should declare first the getter and then the setter. (computed_accessors_order) 

[ 17개 - 2020.8.20 ]

연산 프로퍼티에 `get`과 `set`의 순서가 `get`이 먼저 나와야 한다. 

 

 

Implicit Getter Violation: Computed read-only properties should avoid using the get keyword. (implicit_getter) 

[ 1개 - 2020.8.20 ]

`set`을 하지 않는 읽기 전용 연산 프로퍼티의 경우 `get` 키워드를 사용하지 않아도 된다.

 

 

Vertical Parameter Alignment Violation: Function parameters should be aligned vertically if they're in multiple lines in a declaration. (vertical_parameter_alignment) 

[ 4개 - 2020.8.20 ]

함수 파라미터들이 따로 한 줄씩 작성되어 있었는데, 그 파라미터들이 정렬되지 않은 경우가 있었다. 

 

 

 

2020년 8월 21일 금요일 (warning: 244, error: 8)로 시작🤔

For Where Violation: where clauses are preferred over a single if inside a for. (for_where) 

[ 8개 - 2020.8.21 ]

for 문 안에서 if 문으로 조건 확인을 하는 경우, 그보다 for문에 where 절 사용을 권장한다.

// 변경 전
for index in 3..<array.count {
    if index % 2 == 1 {
    ...
    }
}

// 변경 후
for index in 3..<array.count where index % 2 == 1 {
...
}

 

 

Immutable value 'str' was never used; consider replacing with '_' or removing it 

[ 2개 - 2020.8.21 ]

사용하지 않는 상수가 있으면 와일드카드 식별자 `_`로 대체하거나 삭제한다.

 

 

Empty Enum Arguments Violation: Arguments can be omitted when matching enums with associated types if they are not used. (empty_enum_arguments) 

[ 2개 - 2020.8.21 ]

Switch문에서 enum을 사용할 때, enum의 연관 값을 사용하지 않는다면 삭제해도 된다.

// Ex)
enum Barcode {
    case upc(Int, Int, Int, Int)
    case qrCode(String)
}

var productBarcode = Barcode.upc(8, 85909, 51226, 3)

// 변경 전
switch productBarcode {
case .upc(_,_,_,_):
    print("UPC: \(productBarcode.self)")
case .qrCode(let productCode):
    print("QR code: \(productCode).")
}

// 변경 후
switch productBarcode {
case .upc:
    print("UPC: \(productBarcode.self)")
case .qrCode(let productCode):
    print("QR code: \(productCode).")
}

 

 

Multiple Closures with Trailing Closure Violation: Trailing closure syntax should not be used when passing more than one closure argument. (multiple_closures_with_trailing_closure) 

[ 12개 - 2020.8.21 ]

클로저가 여러 개 있는 함수의 경우, 마지막 클로저 파라미터를 축약하지 않는 것을 더 권장한다.

// 변경 전
UIView.animate(withDuration: 0.2,
               animations: {}, 
}) { _ in
    self.removeFromSuperview()
}

// 변경 후
UIView.animate(withDuration: 0.2,
      	      animations: {},
      	      competion: { _ in
       	          self.removeFromSuperview() 
})

 

 

Legacy Constructor Violation: Swift constructors are preferred over legacy convenience functions. (legacy_constructor) 

[ 6개 - 2020.8.21 ]

스위프트에서는 오래된 C 함수보다 ✨새로운 sturct initializer를 사용하기를 권장하고 있다. 

// 변경 전
NSMakeRange(0, length)

// 변경 후
NSRange(location: 0, length: length)

 

 

Closure Parameter Position Violation: Closure parameters should be on the same line as opening brace. (closure_parameter_position) 

[ 13개 - 2020.8.21 ]

클로저의 파라미터가 다음 줄로 넘어가 있는 경우가 있었는데, 파라미터들이 클로저의 괄호와 같은 줄에 위치해야 한다는 것이다.

 

 

Redundant Discardable Let Violation: Prefer _ = foo() over let _ = foo() when discarding a result from a function. (redundant_discardable_let) 

[ 12개 - 2020.8.21 ]

함수의 반환 값을 사용하지 않을 때, `let _  = 함수()`보다 그냥 `_ = 함수()` 로 사용하는 것이 더 좋다.

아니면 함수를 정의할 때 @discardableResult를 붙여주면 반환 값이 사용되지 않더라도 에러가 뜨지 않게 할 수 있다. 

// 변경 전
let _ = 함수명()

// 변경 후
_ = 함수명()

OR

@discardableResult
func 함수명() -> 반환값 {

}

 

 

Unused Optional Binding Violation: Prefer != nil over let _ = (unused_optional_binding) 

[ 2개 - 2020.8.21 ]

사용하지 않는 옵셔널 바인딩은 nil이 아닌 것을 확인하는 방식이 더 좋다.

// 변경 전
if let _ = 변수 {}

// 변경 후
if 변수 != nil {}

 

 

Redundant Optional Initialization Violation: Initializing an optional variable with nil is redundant. (redundant_optional_initialization) 

[ 1개 - 2020.8.21 ]

옵셔널 변수라면 최초에 자동으로 nil로 초기화가 되기 때문에 명시해주지 않아도 된다.

// 변경 전
var 변수명: String? = nil

// 변경 후
var 변수명: String?

 

 

Redundant String Enum Value Violation: String enum values can be omitted when they are equal to the enumcase name. (redundant_string_enum_value)

[ 19개 - 2020.8.21 ]

String 타입의 Enum에서 동일한 값이라면 중복으로 쓰지 않아도 사용할 수 있어 삭제하였다.

// 변경 전
enum CallType: String {
   case video = "video"
   case voice = "voice"
 }

// 변경 후
enum CallType: String {
    case video
    case voice
}

 

 

Identifier Name Violation: Variable name should be between 3 and 40 characters long: 'vc' (identifier_name)

[ 60개 => 28개 - 2020.8.21 ]

ViewController 변수가 'vc'로 대부분 작성되어 있었는데, 좀 더 명확하게 특정 컨트롤러 변수명으로 변경하여 어떤 뷰컨트롤러인지 알 수 있도록 수정했다.

 

 

Expression implicitly coerced from 'Date?' to 'Any'

[ 2개 - 2020.8.21 ]

암시적으로 Any 타입으로 강제된 Date? 타입을 String 타입으로 바꿔주었다.

// 변경 전
print("date: ", Date 타입 변수)

// 변경 후
print("date: \(String(describing: Date 타입 변수))")

 

 

File Line Length Violation: File should contain 400 lines or less: currently contains 401 (file_length)

[ 9개 - 2020.8.21 ]

- 400줄 이하로 큰 수정 없이 간단히 줄일 수 있는 2개의 파일만 수정했다.

 

 

Orphaned Doc Comment Violation: A doc comment should be attached to a declaration. (orphaned_doc_comment)

[ 40개 => 29개 2020.8.21 ]

- 문서 주석이 아닌데 '/' 기호를 3개 이상 쓰는 곳이 있었다. 필요한 부분을 제외한 3곳만 수정했다. 

 

 

Comment Spacing Violation: Prefer at least one space after slashes for comments. (comment_spacing)

- 주석 // 다음에 공백이 있어야 함.

 

 

Trailing Comma Violation: Collection literals should not have tailing commas. (trailing_comma)

[ 1개]

- 컬렉션 요소 마지막 값 뒤에 콜론이 붙은 경우가 있어 삭제했다.

 

 

Closing Brace Spacing Violation: Closing brace with closing parenthesis should not have any whitespaces in the middle.(closing_brace)

[ 1개]

- 닫히는 소괄호 안에 있는 닫히는 대괄호 사이에 공백이 있어 삭제했다.

 

 

최종적으로 swiftlint.yml 규칙 수정

[ 2020.8.24 ]

이미 작성되어 있는 코드의 수정이 크게 필요할 것 같아 function, file 등의 length, parameter count 등의 규칙은 전부다 수정하지 못하고  제외를 하였다. 차차 리팩토링이 되면 좋을 것 같다.😏 length에 대한 조건도 매우(?) 넉넉히 주었는데.. 점차 코드 개선을 할 수 있길 기대한다. 😁

disabled_rules:
- leading_whitespace
- trailing_whitespace
- line_length
- cyclomatic_complexity
- function_body_length
- function_parameter_count
- orphaned_doc_comment

opt_in_rules:
type_body_length:
    - 1000
    - 1500

file_length:
    warning: 3000
    error: 4000

type_name:
    min_length:
        warning: 1
    max_length:
        warning: 80
        error: 100

identifier_name:
    min_length:
        warning: 1

excluded:
- 파일 위치/AppDelegate.swift
- Pods
- Libraries