5-1 Swift Lint

주제

Swift Lint

SwiftLint는 Swift 프로젝트에서 코드 스타일과 규칙을 자동으로 점검하고 일관성을 유지하도록 도와주는 도구이다.

설치 방법

Homebrew를 이용한 설치

• 터미널에 명령어 실행

brew install swiftlint

• Xcode 프로젝트에 SwiftLint 추가하기

1. 프로젝트 디렉터리로 이동
2. SwiftLint를 Xcode Build Phase에 추가
   • Xcode에서 프로젝트 설정으로 이동한 뒤, 타겟을 선택합니다.
   • "Build Phases" 탭으로 이동하여 "+" 버튼을 클릭하고 "New Run Script Phase"를 선택합니다.
   • 아래 스크립트를 추가합니다:

if which swiftlint >/dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed. Install it via Homebrew: brew install swiftlint"
fi

이 스크립트는 "Compile Sources" 단계 이전에 위치해야 합니다.

설정 방법

프로젝트 루트 디렉터리에 .swiftlint.yml 파일을 생성하여 규칙을 커스터마이징할 수 있다

disabled_rules: # 비활성화할 규칙
  - trailing_whitespace
  - force_cast

opt_in_rules: # 추가적으로 활성화할 규칙
  - explicit_enum_raw_value
  - strict_fileprivate

line_length: 120 # 한 줄 최대 길이 설정
excluded: # 검사 제외 경로
  - Pods
  - Carthage

자주 사용되는 규칙

1. line_length: 한 줄에 허용되는 최대 글자 수를 제한합니다.
2. force_unwrapping: 강제 언래핑(!) 사용을 경고합니다.
3. trailing_whitespace: 줄 끝에 공백이나 탭이 있는지 확인합니다.
4. force_cast: 강제 캐스팅 사용을 지양합니다.

SwiftLint 실행 방법

// 터미널에서 프로젝트 디렉터리로 이동한 후 , 아래 명령어 실행
swiftlint
// 실행하게 되면 swiftlint가 프로젝트 파일을 분석하고 규칙 위반 사항을 출력합니다.

장점

• 코드 가독성과 유지보수성 향상
• 팀 간 일관된 코드 스타일 유지
• 일반적인 버그나 나쁜 코딩 습관 방지

단점

• 사용하려면 lint 문법들을 공부해야 함
• 잘 사용하지 않음

정리

수업중에 Swiftlint라는걸 소개해줬는데 생소해서 찾아봤습니다.