SwiftLint는 Swift 코드의 일관성과 가독성을 검사하기 위한 도구입니다. 이 도구는 Swift 코드의 스타일 가이드를 준수하도록 도와주고, 개발자들이 일관된 스타일로 코드를 작성할 수 있도록 지원합니다. SwiftLint는 커맨드라인 도구로 사용할 수 있으며, 개발자들은 커맨드라인에서 SwiftLint를 실행하여 코드를 검사할 수 있습니다.
설치
SwiftLint는 brew를 통해 쉽게 설치할 수 있습니다. 다음 명령어를 실행하여 SwiftLint를 설치합니다.
brew install swiftlint
사용
SwiftLint를 사용하기 위해서는 다음 명령어를 사용합니다.
swiftlint lint [파일명]
위 명령어를 실행하면 지정된 파일 또는 프로젝트 전체의 코드를 검사하여 스타일 가이드에 따라 경고나 오류를 표시합니다. [파일명]은 선택적으로 지정할 수 있으며, 특정 파일을 검사하고자 할 때 사용합니다. 만약 [파일명]을 지정하지 않을 경우, 현재 디렉토리에서 모든 Swift 파일을 검사합니다.
SwiftLint는 설정 파일인 .swiftlint.yml을 사용하여 스타일 가이드를 설정할 수 있습니다. 이 설정 파일은 프로젝트의 루트 디렉토리에 위치해야 합니다. 설정 파일을 사용하면 개발자는 프로젝트 전체에 일관된 스타일 가이드를 적용할 수 있습니다.
설정 파일
SwiftLint의 설정 파일 .swiftlint.yml은 YAML 포맷으로 작성됩니다. 설정 파일을 사용하여 다양한 스타일 가이드 옵션을 설정할 수 있습니다. 예를 들어, 들여쓰기 스타일, 변수 및 함수 이름 규칙, 줄 길이 제한 등을 설정할 수 있습니다.
다음은 .swiftlint.yml의 예입니다.
disabled_rules:
- line_length
- todo
opt_in_rules:
- empty_count
line_length:
warning: 120
error: 150
variable_name:
allow_single_char_names: false
type_name:
allowed_symbols: ['_']
위의 설정 파일 예제에서는 line_length와 todo 규칙을 비활성화하고, empty_count 규칙을 활성화했습니다. 또한, line_length 규칙에 대해 경고는 120자, 오류는 150자로 설정하고, variable_name과 type_name 규칙에 대해 추가적인 설정을 적용하였습니다.
결과
SwiftLint가 지정된 파일 또는 프로젝트를 검사한 결과는 커맨드라인에 출력됩니다. 경고와 오류는 해당 라인 번호와 함께 출력되며, 개발자들은 이를 참고하여 코드를 수정할 수 있습니다.
또한, SwiftLint는 Xcode와 같은 통합 개발 환경에서도 사용할 수 있습니다. SwiftLint 프로젝트에는 Xcode 플러그인이 포함되어 있어 코드 편집 시 자동으로 SwiftLint를 실행하여 스타일 가이드를 검사할 수 있습니다.