SwiftLint 설치하고 적용하기

SwiftLint

Xcode에서  코딩 컨벤션 관련 규칙을 정하고 규칙에 어긋나는 것이 있으면 경고창을 띄워주는 라이브러리

 

설치방법

1. SwiftLint 설치

brew로 설치해보겠다.

해당 폴더로 가서

brew install swiftlint

입력한다.

 

2. Run Script 설정

Targets > 프로젝트 폴더 > 상단의 Build Phases > + 버튼 > New Run Script Phase > Run Script에 아래 코드를 복붙한다.

brew path에 위치한 SwiftLint를 찾아가도록 하는 Script다. 환경변수 설정하는거랑 비슷하다.

if test -d "/opt/homebrew/bin/"; then
  PATH="/opt/homebrew/bin/:${PATH}"
fi

export PATH

if which swiftlint >/dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

 

3. .swiftlint.yml 파일 생성

empty파일을 프로젝트 최상단 디렉토리에 생성한다.

규칙은 팀과 협의하여 컨벤션을 정하도록 한다.

예시는 아래와 같다.

disabled_rules:  // 아래 룰은 검사 대상에서 제외하겠다는 뜻
- trailing_whitespace
- xctfail_message
- function_parameter_count
- legacy_constructor
- force_cast
- trailing_comma
- force_try
- identifier_name

type_body_length: 250  // 타입/함수/파일 등의 코드길이 제한을 변경하겠다는 뜻
line_length: 120
function_body_length: 50
file_length: 500

 

그렇게 모든 설정을 완료하고 Run버튼 누르면 

규칙에 어긋난 코드들이 경고창을 띄운다.