SwiftLint란?

---

• Xcode 프로젝트에서 Swift 코드 컨벤션을 적용하는 도구
• SwiftLint를 사용하면 일관된 코드 스타일을 유지하고 일반적인 코딩 규칙을 준수하는 데 도움이 됩니다.
  
  
  

SwiftLint설치 및 적용

---

HomeBrew 설치

brew install swiftlint

CocoaPod 설치

프로젝트의 podfile에 다음 줄을 추가해줍니다
pod 'SwiftLint'

SwiftLint, Xcode Scheme에 통합

Target > build phase > + > new run script phase

스크립트 추가

HomeBrew

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

CocoaPod

${PODS_ROOT}/SwiftLint/swiftlint

경로 에러가 나는 경우

export PATH = "PATH:/opt/homebrew/bin" 는 SwiftLint의 설치 경로 입니다.

터미널에서 which swiftlint 실행하면 설치 경로가 나옵니다.

추가한 스크립트 이름을 SwiftLint Script로 변경해주고, Compile Sources 위로 올려줍니다

swiftlint.yml 파일 추가

프로젝트 상위에 .swiftlint.yml 파일 추가

규칙 적용하기

---

SwiftLint의 기본규칙과 선택규칙
공식문서

Rule

disabled_rules
디폴트로 활성화 되어있는 규칙 중 비활성화 할 규칙을 정하는 키워드

opt_in_rules
기본 규칙이 아닌 규칙을 활성화하는 키워드

whitelist_rules
지정된 규칙들만 활성화 되도록 화이트리스트 등록
❌ disalbed_rules, opt_in_rules은 같이 사용 불가 ❌

included
SwiftLint 검사에서 제외할 파일 경로

excluded
SwiftLint 검사에서 제외할 파일 경로
included에 포함한 것보다 우선적으로 처리

excluded에서 자주 포함하는 경로

excluded:
  - Pods
  - ProjectName/AppDelegate.swift
  - ProjectName/SceneDelegate.swift

custom_rules
사용자가 추가하는 커스텀 룰

.swiftlint.yml 예시

# 실행에서 제외할 디폴트규칙
disabled_rules:
    - trailing_whitespace # 행 끝의 공백
    - force_cast # 강제 캐스팅

# 선택적으로 적용할 규칙
opt_in_rules:
    - empty_count # isEmpty 사용
    - explicit_init # 구조체, 클래스의 initialize를 명시적으로 선언 .init() 불가능
    - contains_over_first_not_nil
    - closure_end_indentation # 클로저의 종료 괄호는 클로저를 시작한는 줄과 동일한 수준으로 들여쓰기
    - discouraged_optional_boolean # Bool을 옵셔널하게 선언하면 안됨
    - legacy_random # Swift 4.2 이상부터 arc4random -> Int.random으로 작성
    - switch_case_on_newline # case 와 : 사이에 새 줄을 넣는 것을 선호

# 지정룰만 활성화
#only_rules:

force_unwrapping: error # 암시적으로 지정
force_try:
    severity: warning # 명시적으로 지정


# 코드의 줄 길이
line_length:
    warning: 200 # 줄 길이가 140자를 넘을 경우 경고
    error: 250 # 줄 길이가 200자를 넘을 경우 오류

# 파일의 길이
file_length:
    warning: 500 # 파일 길이가 500줄을 넘을 경우 경고
    error: 800 # 파일 길이가 800줄을 넘을 경우 오류

#included: # 포함할 경로

# 클래스, 구조체, 열거형의 본문 길이 제한
type_body_length:
    warning: 500
    error: 800

# 타입 이름의 길이를 제한
type_name:
    min_length: 1    # 최소 길이
    max_length:      # 최대 길이
        warning: 50    # 최대 길이를 초과할 경우 경고
        error: 60      # 최대 길이를 초과할 경우 에러
    excluded: ["Name"] # 이름 길이 제한에서 제외할 특정 타입 이름

# 변수, 상수, 함수 등의 식별자 이름의 길이를 제한
identifier_name:
    min_length: 1    # 최소 길이
    max_length:      # 최대 길이
        warning: 50    # 최대 길이를 초과할 경우 경고
        error: 60      # 최대 길이를 초과할 경우 에러
    excluded: ["id", "x", "y", "z"] # 이름 길이 제한에서 제외할 특정 식별자 이름

# 함수의 본문 길이
function_body_length:
    warning: 15
    error: 30
    
# 함수의 복잡성(조건문, 반복문 등의 중첩)를 제한합니다
cyclomatic_complexity:
    warning: 2    # 복잡도가 2를 초과할 경우 경고
    error: 5      # 복잡도가 5를 초과할 경우 에러
    


# 규칙에서 제외할 파일들
excluded:
    - Pods
    - SwiftLint/AppDelegate.swift
    - SwiftLint/SceneDelegate.swift

# 커스텀 룰
custom_rules:
    included: ".*\\.swift"
    no_hell_word: # 사용자 정의 규칙의 이름
        name: "No 'Hell' Word" # 규칙의 설명
        regex: "hell" # 검색하려는 정규 표현식
        message: "The word 'hell' is not allowed." # 위반 시 표시되는 메시지
        severity: error # 위반 시의 심각도 (warning 또는 error)

# 보고 유형
reporter: "xcode"

Gibhub 정리자료

질문과 피드백은 언제나 감사합니다^^

참고문서

https://sunidev.tistory.com/31