[iOS] SwiftLint 적용하기

SwiftLint란?

SwiftLint는 코드의 스타일 오류를 표시하는데 도움이 되는 신속한 코드 스타일 분석 도구이다.

스타일을 따르지 않을 때, 빌드를 실패로 표시하거나 경고를 표시하여 스타일을 적용하는데 도움을 준다.

 

1. 코코아팟 설치하기

pod 'SwiftLint'

2. Script 추가하기

Target → Build Phase → + → New Run Script Phase

 

Run Script에 아래 코드를 추가한다.

${PODS_ROOT}/SwiftLint/swiftlint

그리고 Run Script 이름을 SwiftLint Script로 변경했다.

그리고 위치를 Compile Sources 위로 올려주었다!

이렇게 하면, 컴파일 전에 스크립트를 실행해서 SwiftLint 룰 검사를 먼저 진행한다고 한다.

 

그리고 빌드를 진행하면!

이렇게 많은 Warning들이 생겨난 것을 확인할 수 있다.

지금은 직접 내가 작성한 것이 아닌, Default Rules를 모두 적용시킨 상태이기 때문에 이렇게 많은 경고들을 볼 수 있다.

Default Rules는 여기서 확인 가능!

 

3. SwiftLint 사용하기

우리가 이제 할 수 있는 것은 다음과 같다.

• disable rules (규칙 무효화)
• opt-in on non-default rules (기본 아닌 규칙에 대한 선택)
• specify only the rules you want to enable (ignoring all default rules) (모든 규칙 무시하고, 사용하려는 규칙만 지정)

 

먼저 .swiftlint.yml 파일을 생성해야한다.

프로젝트의 가장 상위 폴더에서 Empty 파일을 생성한다. 파일 이름은 .swiftlint.yml으로 저장한다.

 

그러면 이렇게 파일이 생성된다!

여기서 원하는 대로 작성하고 사용하면 된다.

disabled_rules: # Default Rules에서 비활성할 규칙
- trailing_whitespace # Lines should not have trailing whitespace.

opt_in_rules: # 기본적으로 비활성화되어있으나 활성화할 규칙
- yoda_condition

excluded: # File or Directory Lint should exclude.
- Pods

 

 

Opt-In Rules

기본적으로 비활성화되어있으나, 활성화하고 싶은 규칙을 추가한다.

Guidelines on when to mark a rule as opt-in:

• A rule that can have many false positives (e.g. [empty_count](<https://realm.github.io/SwiftLint/empty_count.html>))
• A rule that is too slow
• A rule that is not general consensus or is only useful in some cases (e.g. [force_unwrapping](<https://realm.github.io/SwiftLint/force_unwrapping.html>))

Disable Rules in code

아래와 같은 포맷을 사용하여 비활성화할 수 있다.

// swiftlint:disable <rule1> [<rule2> <rule3>...]

이 규칙은 파일의 끝이나 활성화 커멘트가 나올 때까지 비활성화된다.

// swiftlint:enable <rule1> [<rule2> <rule3>...]

예를 들면 다음과 같다.

// swiftlint:disable colon
let noWarning :String = "" // 변수 이름 직후에 콜론에 대한 경고 X

// swiftlint:enable colon
let hasWarning :String = "" // 변수 이름 직후에 콜론에 대한 경고 O

all 키워드를 포함하면, 활성화 커멘트가 나올 때까지 모든 규칙이 비활성화된다.

// swiftlint:disable all
// swiftlint:enable all

Configuration

SwiftLint를 실행할 디렉토리에서 .swiftlint.yml 파일을 추가해서 SwiftLint를 구성할 수 있다.

• disabled_rules
  • Default Rules 중에 비활성화하고 싶은 규칙 추가

  disabled_rules: # Default Rules에서 비활성할 규칙
  - trailing_whitespace # Lines should not have trailing whitespace.
  

• opt_in_rules
  • 기본적으로 비활성화되어있지만 활성화하고 싶은 규칙 추가

  opt_in_rules: # 기본적으로 비활성화되어있으나 활성화할 규칙
  - yoda_condition
  

• only_rules
  • 이 목록에 지정된 규칙만 활성화. disabled_rules 또는 opt_in_rules와 함께 지정할 수 없다.
• analyzer_rules
  • 오직 analyze 명령에 의해서만 실행되는 완전히 별도의 규칙 목록이다. 모든 analyzer 규칙은 opt-in이므로 이 규칙 목록만 구성할 수 있으며, disabled_rules, only_rules와 동일한 규칙이 없다.
• included
  • SwiftLint 검사에서 포함할 파일 경로를 추가한다.
• excluded
  • SwiftLint 검사에서 제외할 파일 경로를 추가한다. included에 포함된 것보다 우선적으로 처리된다.

  excluded: # SwiftLint 검사에서 제외할 파일 경로
    - Pods
    - ProjectName/AppDelegate.swift
    - ProjectName/SceneDelegate.swift
  

 

 

 

참고 자료

SwiftLintFramework Reference

Improving Swift Code Readability With SwiftLint