[swift] SwiftLint를 사용하여 코드 스타일 검사 도구 설정

15 Dec 2023

swift

SwiftLint는 Swift 언어의 코드 스타일을 검사해주는 도구로, 개발자들이 일관된 코딩 스타일을 유지하고 품질을 향상시킬 수 있도록 도와줍니다. 이번 포스트에서는 SwiftLint를 프로젝트에 추가하고 설정하는 방법에 대해 알아보겠습니다.

SwiftLint 추가하기

먼저 프로젝트의 root 디렉토리에 SwiftLint를 추가해야 합니다. 이를 수행하는 가장 간단한 방법은 CocoaPods나 Carthage를 사용하여 SwiftLint를 프로젝트에 추가하는 것입니다.

CocoaPods를 사용하는 경우

Podfile에 다음과 같이 SwiftLint를 추가합니다:

target 'YourProjectTarget' do
  use_frameworks!
  pod 'SwiftLint'
end

그런 다음 터미널에서 pod install을 실행하여 SwiftLint를 설치합니다.

Carthage를 사용하는 경우

Cartfile에 다음과 같이 SwiftLint를 추가합니다:

github "realm/SwiftLint"

그런 다음 터미널에서 carthage update를 실행하고 프레임워크를 프로젝트에 추가합니다.

SwiftLint 설정하기

설정 파일 만들기

SwiftLint를 프로젝트에 추가한 후에는 설정 파일을 생성해야 합니다. 프로젝트 루트 디렉토리에 .swiftlint.yml 파일을 만듭니다.

규칙 구성

.swiftlint.yml 파일에는 코드 스타일 검사에 사용할 규칙을 구성할 수 있습니다. 예를 들어, 다음과 같이 warning과 error로 각각의 룰을 설정할 수 있습니다:

included:
  - Source

excluded:
  - Carthage
  - Pods

opt_in_rules:
  - trailing_semicolon
  - sorted_imports

disabled_rules:
  - leading_whitespace

line_length:
  warning: 120
  error: 140

위의 예제에서는 몇 가지 기본적인 규칙을 설정했습니다. 이러한 설정은 프로젝트의 요구에 맞게 사용자 정의할 수 있습니다.

Xcode에서 통합

프로젝트 설정으로 이동하여 Build Phases > New Run Script Phase를 추가하고, 다음 스크립트를 추가하여 SwiftLint를 실행합니다.

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

이제 프로젝트를 빌드하면 SwiftLint가 실행되면서 코드 스타일을 검사하고 경고나 오류를 표시할 것입니다.

이렇게하면 SwiftLint를 사용하여 프로젝트의 코드 스타일을 관리할 수 있게 됩니다. 코드 스타일 검사 도구를 설정하면 팀 내의 일관성을 유지하고 코드 품질을 향상시킬 수 있습니다.

참고 문헌: