SwiftLint는 Swift 코드를 정적으로 분석하여 코드 스타일 및 안티 패턴을 검사하는 도구입니다. 코드의 일관성과 가독성을 유지하기 위해 사용됩니다. SwiftLint를 사용하여 코드 수정을 자동으로 적용하는 방법을 알아보겠습니다.

1. SwiftLint 설치하기 SwiftLint를 사용하기 위해서는 먼저 설치해야 합니다. 다음 명령어를 사용하여 SwiftLint를 설치합니다.

   $ brew install swiftlint
   

2. 프로젝트 설정 추가하기 SwiftLint를 프로젝트에 적용하기 위해 프로젝트 디렉토리에 .swiftlint.yml 파일을 생성합니다. 이 파일은 SwiftLint의 규칙과 설정을 정의하는 역할을 합니다. 다음은 .swiftlint.yml 파일의 예시입니다.

   included:
     - Source/**/*.swift
   
   excluded:
     - Carthage
     - Pods
     - Source/ThirdParty
     - Source/Generated
   

   이 예시에서는 Source 디렉토리 내의 모든 .swift 파일을 포함하고, Carthage, Pods, Source/ThirdParty, Source/Generated 디렉토리는 제외합니다. .swiftlin.yml 파일을 프로젝트에 저장한 후, 해당 파일의 위치를 찾을 수 있는지 확인해야 합니다.

3. SwiftLint 실행하기 SwiftLint를 실행하여 코드를 분석하고 자동으로 수정할 수 있습니다. 프로젝트의 루트 디렉토리에서 다음 명령어를 실행합니다.

   $ swiftlint autocorrect
   

   이 명령어를 실행하면 SwiftLint가 설정된 규칙에 맞지 않는 부분을 찾아서 자동으로 수정합니다. 수정된 내용은 바로 코드 파일에 적용되며, 변경 사항을 다시 확인하고 원할 경우 수정할 수 있습니다.

4. Xcode 빌드 전에 SwiftLint 실행하기 (옵션) SwiftLint는 Xcode 빌드 전에도 실행할 수 있습니다. 이렇게 하면 코드가 빌드되기 전에 SwiftLint에 의해 자동으로 수정되고, 규칙을 준수하는지 확인할 수 있습니다. 이를 위해 다음과 같이 Build Phases를 설정합니다.

   • Build Phases에서 New Run Script Phase를 추가합니다.
   • 다음 명령어를 추가하고, Run script only when installing를 체크합니다.

     if which $SWIFTLINT >/dev/null; then
         $SWIFTLINT autocorrect --path "${SRCROOT}/"
     else
         echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
     fi
     

   • 스크립트를 추가한 후, Xcode를 실행하여 프로젝트를 빌드합니다. SwiftLint가 실행되고 코드 스타일을 적용하고 수정합니다.

SwiftLint를 사용하여 코드 수정을 자동으로 적용하는 방법에 대해 알아보았습니다. 이를 통해 일관된 스타일과 좋은 코드 품질을 유지할 수 있습니다. SwiftLint의 공식 문서나 GitHub 저장소에서 자세한 내용을 확인할 수 있습니다.

참고 자료:

• SwiftLint GitHub 저장소
• SwiftLint 공식 문서