[iOS] SwiftLint 적용하기

코드 개선에 도움을 주는 Lint를 적용해보자! 

 

1. 먼저, SwiftLint를 적용하려면  Pod가 설치되어 있어야한다.  

https://ppomelo.tistory.com/20

[iOS] CocoaPods 코코아팟 설치 및 FMDB 사용하기

 

2. Podfile에 SwiftLint 추가하기

pod 'SwiftLint'

 

3. 터미널 > 프로젝트 위치로 이동 > pod install

$ cd <프로젝트 위치>
$ pod install

 

4. Target > Build Phase > + > New Run Script Phase

 

5. Run Script에 다음과 같이 추가해준다.

${PODS_ROOT}/SwiftLint/swiftlint

 

6.  Build

빌드를 해보면 굳이 이런거 까지 경고를 띄워야하나 싶을 정도로 많은 warning과 error가 발생한다. 

따라서 .swiftLint.yml 파일을 추가하여 이것들을 제어할 수 있다.

 

7. 터미널 > .swiftlint.yml 생성

$ vi  .swiftlint.yml

 

8. .swiftlint.yml에 제외하고자 하는 것들을 추가하면 된다

disabled_rules: # 실행에서 제외할 룰 식별자들
  - colon
  - comma
  - control_statement
opt_in_rules: # 일부 룰은 옵트 인 형태로 제공
  - empty_count
  - missing_docs
  # 사용 가능한 모든 룰은 swiftlint rules 명령으로 확인 가능
included: # 린트 과정에 포함할 파일 경로. 이 항목이 존재하면 `--path`는 무시됨
  - Source
excluded: # 린트 과정에서 무시할 파일 경로. `included`보다 우선순위 높음
  - Carthage
  - Pods
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift

더 자세한  사항은 https://github.com/realm/SwiftLint/blob/master/README_KR.md 를 참고하자

realm/SwiftLint