[swift] SwiftLint를 사용하여 오래된 코드를 개선하는 방법은 무엇인가요?

28 Nov 2023

swift

오래된 코드는 유지 보수가 어려울 뿐만 아니라 버그 발생 및 성능 저하의 원인이 될 수 있습니다. 이러한 문제를 해결하기 위해 SwiftLint라는 도구를 사용할 수 있습니다. SwiftLint는 Swift 코드를 정적으로 분석하고 일관된 코딩 스타일을 유지하도록 도와줍니다.

SwiftLint의 설치와 설정은 다음과 같은 단계를 따릅니다.

SwiftLint 설치하기 SwiftLint를 사용하기 위해 먼저 설치해야 합니다. 설치 방법은 다음과 같습니다.
```
$ brew install swiftlint
```
SwiftLint 설정 파일 만들기 SwiftLint를 사용하려면 프로젝트의 루트 디렉토리에 .swiftlint.yml 파일을 만들어야 합니다. 이 파일은 코드 스타일 규칙을 정의하는 데 사용됩니다. 예를 들어, 일관된 들여쓰기, 함수 이름 규칙, 경고 또는 에러로 처리될 특정 사항 등을 지정할 수 있습니다.
```
included:
  - Source

excluded:
  - Carthage
  - Pods

line_length:
  warning: 120

force_cast:
  warning: true
```
위 예제에서는 included 섹션에 Source 디렉토리의 코드만 분석하도록 하고, excluded 섹션에는 Carthage와 Pods 디렉토리를 제외하도록 설정했습니다. 또한 line_length 규칙을 정의하여 120자가 넘어가면 경고를 발생시키도록, force_cast 규칙을 정의하여 as!를 사용하는 경우 경고를 발생시키도록 설정했습니다.
SwiftLint 적용하기 SwiftLint를 적용하기 위해 프로젝트의 루트 디렉토리에서 다음 명령어를 실행합니다.
```
$ swiftlint
```
실행하면 SwiftLint가 설정 파일을 기반으로 프로젝트의 코드를 분석하고 경고 또는 에러를 발견하면 결과를 출력합니다.
```
Loading configuration from '.swiftlint.yml'
Linting Swift files at paths
...
```
이렇게 프로젝트를 여러 번 실행하여 코드를 분석하면서 SwiftLint를 통해 개선할 부분을 찾을 수 있습니다. 경고 또는 에러가 출력된 부분을 확인하고, SwiftLint가 추천하는 방식으로 코드를 수정하면 됩니다.

SwiftLint를 사용하면 코드에 일관성을 유지하고 버그를 사전에 잡아낼 수 있으므로 프로젝트의 코드 품질을 개선하는 데 도움이 됩니다. 또한 전체 팀이 동일한 코딩 스타일을 따르도록 하여 협업을 원활하게 할 수도 있습니다.

참고 자료:

SwiftLint GitHub 페이지