SwiftLint는 Swift 코드의 스타일 가이드 준수를 강제화하기 위한 오픈 소스 라이브러리입니다. 이를 통해 개발자는 프로젝트에서 일관된 네이밍 컨벤션을 유지할 수 있습니다.

SwiftLint 설정하기

1. 처음으로 SwiftLint를 사용하려면 터미널에서 다음 명령어를 사용하여 SwiftLint를 설치해야 합니다:

brew install swiftlint

또는 CocoaPods를 사용한다면, Podfile에 다음과 같이 추가한 후 pod install 명령어를 실행하세요:

pod 'SwiftLint'

1. SwiftLint를 프로젝트에 적용하기 위해 .swiftlint.yml 파일을 생성합니다. 이 파일은 프로젝트 루트 디렉토리에 위치해야 합니다.

included:
  - Sources
  - Tests

excluded:
  - Carthage
  - Pods
  - Build

overrides:
  - include: '**/*.swift'
    excluded: 'Generated'

1. 프로젝트를 빌드하거나 열면 SwiftLint가 활성화되고, 스위프트 소스 파일에 대해 정의된 규칙을 강제화합니다.

네이밍 컨벤션 규칙 설정하기

SwiftLint는 다양한 네이밍 컨벤션을 체크하는 규칙을 설정할 수 있습니다. 다음은 일부 일반적인 규칙 예시입니다.

• variable_name: 변수/상수명은 소문자로 시작하고 카멜 케이스로 작성되어야 합니다.
• type_name: 타입(클래스, 구조체, 열거형 등)명은 대문자로 시작하고 카멜 케이스로 작성되어야 합니다.
• function_parameter: 함수 파라미터명은 소문자로 시작하고 카멜 케이스로 작성되어야 합니다.
• enum_case: 열거형 케이스명은 소문자로 시작하고 스네이크 케이스로 작성되어야 합니다.

.swiftlint.yml 파일의 rules 섹션에 원하는 규칙을 추가하면 됩니다. 예를 들어 다음은 variable_name 규칙을 설정하는 예시입니다:

rules:
  variable_name:
    severity: warning
    excluded:
      - myExcludedVariable

위 예시에서 severity는 규칙 위반시 표시되는 오류의 심각도를 나타내며, excluded는 특정 변수를 규칙 검사에서 제외할 때 사용합니다.

사용자 정의 규칙 만들기

SwiftLint는 사용자 정의 규칙을 만들 수 있는 기능도 제공합니다. 이를 통해 프로젝트에 특정한 네이밍 규칙을 추가할 수 있습니다. 사용자 정의 규칙은 .swiftlint.yml 파일의 custom_rules 섹션에 정의됩니다.

기본 규칙과 마찬가지로 사용자 정의 규칙도 다양한 옵션과 구성 요소를 가질 수 있습니다. 자세한 내용은 SwiftLint 공식 문서를 참고하세요.

마치며

SwiftLint를 사용하면 프로젝트에서 네이밍 컨벤션을 일관성 있게 유지할 수 있습니다. 적절한 네이밍은 코드를 읽고 유지보수하는 데 매우 중요하므로 SwiftLint를 활용하여 프로젝트의 코드 품질을 향상시키세요.

참고 자료:

• SwiftLint GitHub repository
• SwiftLint Documentation
• Swift Style Guide - Naming Conventions