SwiftLint?

Swift 코드 컨벤션을 자동으로 검사해주는 툴이다.

SwiftLint 적용

SwiftLint에 대한 전체 문서는 이곳을 확인해주세요.

설치

CocoaPods, Homebrew, Mint, 빌드된 패키지 총 4가지 방법으로 이용할 수 있고,
여기선 Homebrew를 통해 사용해보고자 한다.

다음 명령어를 통해 맥에 swiftlint를 설치합니다.

brew install swiftlint

만약 Homebrew가 없다면 아래 명령어를 통해 Homebrew 설치 후에 재진행합니다.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

프로젝트 설정

빌드 시에 SwiftLint 실행을 위해 다음 경로를 통해 Run Sciprt를 추가해준다.

Targets > Build Phases > New Run Script Phase

추가된 기본 Run Script는 다음과 같다.

Runs Script에 다음 명령어를 작성하면 설정이 완료된다.

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

.swiftlint.yml

Rule에 관한 문서는 이곳을 확인해주세요.

프로젝트에 적용될 Lint의 설정을 담당하는 파일이다.

기본적인 구성은 아래와 같다.

disabled_rules: # 비활성화 지정

opt_in_rules: # 룰 활성화

#only_rules: # 지정룰만 활성화

#included: # 포함할 경로

#excluded: # 무시할 경로

사용할 설정을 다음과 같이 작성한다.

결과

yml 파일을 설정하고 실행하면 설정에 맞지 않는 컨벤션을 잡아서 에러나 경고를 띄워준다.

전체 코드는 깃허브에 있습니다.