[swift] SwiftLint 사용법

SwiftLint는 Swift 코드를 정적으로 분석하여 일관된 코딩 스타일을 유지하도록 도와주는 도구입니다. 이 문서에서는 SwiftLint의 기본적인 사용법을 알아보겠습니다.

설치

SwiftLint를 설치하려면 맥용 패키지 관리자인 Homebrew를 사용합니다. 터미널에서 다음 명령을 실행하세요:

brew install swiftlint

설정

SwiftLint를 사용하기 위해 프로젝트에 .swiftlint.yml 파일을 생성해야 합니다. 이 파일은 코드 스타일 및 규칙을 정의하는 데 사용됩니다. 프로젝트의 루트 디렉토리에 .swiftlint.yml 파일을 생성하고 다음과 같이 내용을 작성하세요:

opt_in_rules:
  - opening_brace
  - empty_count
  - trailing_whitespace
  - file_length

excluded:
  - Carthage
  - Pods

이 예제에서는 몇 가지 규칙을 설정하고, 특정 디렉토리를 분석에서 제외하도록 설정하였습니다.

사용

SwiftLint를 사용하여 소스 코드를 분석하려면 터미널에서 다음 명령을 실행하세요:

swiftlint lint

위 명령은 현재 디렉토리의 모든 Swift 소스 코드 파일을 분석합니다. SwiftLint는 각 파일에 대해 코드 스타일 및 규칙을 적용하고, 발견된 문제를 터미널에 출력합니다.

자동화

SwiftLint를 개발 환경에 통합하여 자동으로 코드 분석을 수행할 수 있습니다. 예를 들어, Xcode에서는 Build Phases 탭에서 New Run Script Phase를 추가하고 다음 스크립트를 추가하십시오:

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

위 스크립트는 SwiftLint가 설치되어 있는 경우에만 분석을 수행하고, 그렇지 않은 경우 경고 메시지를 출력합니다.

추가 설정과 사용법

SwiftLint는 다양한 규칙과 설정을 제공합니다. 자세한 내용은 SwiftLint GitHub 저장소에서 확인할 수 있습니다.

SwiftLint를 사용하여 일관된 코딩 스타일을 유지하면 코드가 더 읽기 쉽고 유지 보수가 용이해집니다. Swift 프로젝트에서 코드 품질을 향상시키기 위해 SwiftLint를 사용해 보세요!

참고: 본 문서는 SwiftLint 버전 0.43.0을 기준으로 작성되었습니다.