SwiftLint는 Swift 코드의 스타일과 컨벤션을 체크해주는 도구입니다. 이 글에서는 SwiftLint를 사용하는 방법과 주요 사례들에 대해 알아보겠습니다.

1. SwiftLint 설치

SwiftLint를 사용하기 위해서는 먼저 설치해야 합니다. 설치 방법은 다음과 같습니다.

1.1. Homebrew로 설치하기

brew install swiftlint

1.2. Swift Package Manager로 설치하기

git clone https://github.com/realm/SwiftLint.git
cd SwiftLint
swift build -c release -Xswiftc -static-stdlib
cp -f .build/release/swiftlint /usr/local/bin/swiftlint

2. SwiftLint 사용법

SwiftLint를 사용하려면 프로젝트 루트 디렉토리에 .swiftlint.yml 파일을 생성해야 합니다. 이 파일에는 SwiftLint의 설정 옵션들을 지정할 수 있습니다. 아래는 .swiftlint.yml 파일의 예시입니다.

disabled_rules:
  - colon
  - control_statement
  - cyclomatic_complexity
  - empty_count
included:
  - Sources
excluded:
  - Carthage
  - Pods

위의 설정 예시에서는 몇 가지 규칙들을 비활성화하고, 적용할 파일들을 Sources 폴더로 제한하고, Carthage와 Pods 폴더는 무시합니다.

SwiftLint를 실행하려면 프로젝트 루트 디렉토리에서 다음 커맨드를 실행합니다.

swiftlint

위 커맨드를 실행하면 SwiftLint가 프로젝트 내의 소스 코드 파일들을 분석하고, 스타일과 컨벤션에 어긋나는 부분들을 찾아내게 됩니다.

3. 주요 SwiftLint 사례들

3.1. 공백 처리

SwiftLint는 여러 가지 공백 처리에 대한 규칙을 제공합니다. 예를 들어, 함수의 중괄호 앞뒤에는 공백을 추가하도록 권장합니다. 또한, 콤마 다음에는 공백을 추가하도록 권장합니다.

3.2. 네이밍 규칙

SwiftLint는 변수, 상수, 함수, 클래스 등의 네이밍 규칙에 대한 규칙을 제공합니다. 예를 들어, 변수나 상수의 이름은 소문자로 시작하고 카멜케이스를 따르도록 하라는 규칙입니다.

3.3. 코드 여러 줄 정렬

SwiftLint는 코드의 여러 줄을 정렬하는 규칙을 제공합니다. 예를 들어, 여러 줄의 파라미터가 있는 함수 호출 시, 파라미터는 각각 개행하여 정렬하도록 권장합니다.

이렇게 SwiftLint를 사용하여 Swift 코드의 스타일과 컨벤션을 체크할 수 있습니다. SwiftLint는 프로젝트의 코드 퀄리티를 높이는 데 큰 도움을 줄 수 있는 도구이니, 적극적으로 사용해보시기 바랍니다.

참고 링크:

• SwiftLint GitHub
• SwiftLint Rules