[iOS/Swift] xcode에 SwiftLint 설치하기

 

여러사람이 프로젝트를 개발할 때 커밋메시지 적는것 또한 매우 고민스럽다. 그리고 한 사람이 짠 것처럼 코드 규칙을 잘 지키는것 또한 어렵다. 커밋메시지는 아니더라도, xcode 프로젝트에 swift 코드 컨벤션을 잡아주는 SwiftLint를 적용해보려고 한다. MC1 팀원이 알려줬다!

다음 프로젝트에서는 내가 팀원들을 알려줘야하기 때문에 까먹지 않기 위해서 대충 써보면서 설치해보려고한다.

Lint란?
Lint는 소스코드를 분석해서 코드 스타일이나 프로그램의 오류가 발생할 수 있는 부분을 찾아주는 도구로 활용된다. SwiftLint는 말그대로 Swift언어에서 규칙에 어긋나는 코드를 찾아내서 경고 또는 빌드에러를 반환해준다.

 

---

1. SwiftLint 설치

Mac에 swiftLint를 먼저 설치한다. (나는 Homebrew를 활용해서 설치했다.) (터미널에서입력)

brew install swiftlint

 

2. Script 작성

왼쪽 최상단 프로젝트 클릭 - Targets에서 프로젝트 명 클릭 - Build Phases 탭 클릭 - + 버튼 클릭 - New Run Script Phase

 

클릭하면 새로운 "Run Script"가 생성되는데 이걸 열어서 아래 코드를 입력해주자.

export PATH="$PATH:/opt/homebrew/bin"
if which swiftlint > /dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

 

Run Script 라는 이름을 SwiftLint Script로 바꿔 준 다음, 위치를 Compile Sources 위로 올려준다. (컴파일 하기 전에 스크립트를 실행히셔컷 SwiftLint를 검사하는 것이 효율적이라서 순서를 이렇게 한다고 한다.)

3. .swiftlin.yml 파일 생성

프로젝트에서 command+N을 눌러서 new file 을 만들어준다. Empty 파일을 선택

파일이름은 .swiftlint.yml 로 해야만한다. .으로 시작하는 파일이기 때문에 숨김파일로 처리된다고 한다.

 

4. 규칙 적용하기

이미 적용되어있는 규칙이 많기 때문에 제외할건 제외하고 적용할 건 적용하는게 필요하다. 나는 일단 블로그에 나와있는 것부터 적용해보았다. 나중에 더 잘 알게되면 더 적용할듯?!

disabled_rules: Default rule 중에 비활성화하고 싶은 규칙을 찾아서 적어준다.

disabled_rules: # Default Rules에서 비활성화할 규칙
    
    # 라인 뒤에 공백이 없어야 합니다. https://realm.github.io/SwiftLint/trailing_whitespace.html
    - trailing_whitespace
    
    # 강제 캐스팅은 피해야합니다. https://realm.github.io/SwiftLint/force_cast.html
    - force_cast
    
    # 강제 언래핑은 피해야합니다. https://realm.github.io/SwiftLint/force_unwrapping.html
    - force_unwrapping

opt_in_rules: 기본적으로는 비활성화 되어있지만, 내가 활성화 하고싶은 규칙들을 적어준다.

opt_in_rules:
  # .count==0 보다는 .isEmpty를 사용하는 것이 좋습니다. https://realm.github.io/SwiftLint/empty_count.html
  - empty_count
  
  # 빈 String 문자열과 비교하는 것 보다는 .isEmpty를 사용하는 것이 좋습니다. https://realm.github.io/SwiftLint/empty_string.html
  - empty_string

 

5. 완성!

일부러 공백을 많이 주고 빌드해보니까 이렇게 경고문이뜬다. 이제 코드를 짤대 Lint를 잘 지켜서 짜는 일만 남았다. 후후 :-)

 

📖 Reference

https://github.com/realm/SwiftLint

GitHub - realm/SwiftLint: A tool to enforce Swift style and conventions.

https://tngusmiso.tistory.com/59

[iOS/Swift] XCode 프로젝트에 SwiftLint 적용하기