[ADR][가상] 아키텍처 의사 결정 기록: 코드 품질과 일관성을 위한 SwiftLint 채택
06 May 2023
Contents:
코드 품질과 일관성을 위한 SwiftLint 채택
작성일 : 2023-05-06
작성자 : 안정민
상태
- 제안됨(Proposed)
배경
- 프로젝트의 소스 코드 일관성 및 품질 유지를 위해 코드 스타일과 규칙을 적용할 필요가 있음
- 코드 리뷰 과정에서 스타일에 대한 논의를 줄이고, 팀원 간 일관된 스타일을 적용하여 가독성과 유지보수성 향상 필요
- 자동화 도구를 사용하여 스타일 규칙 적용을 강제하고 싶음
결정
SwiftLint를 사용하여 프로젝트의 코드 스타일 및 규칙을 관리하고 적용하기로 결정하였음
이유
포맷팅 관련 도구로 SwiftLint, SwiftFormat이 있지만, 프로젝트 요구사항과 팀 전문성을 신중하게 고려한 후 다음과 같은 이유로 SwiftLint를 사용하기로 결정했습니다.
- SwiftLint는 널리 사용되는 Swift 코드 스타일 및 규칙 관리 도구로 인기와 신뢰성이 검증되어 있음
- 커뮤니티에서 많이 사용되며, 많은 기능과 룰셋을 제공함
- 프로젝트에 맞는 커스텀 룰도 설정할 수 있어 유연성을 제공함
- Xcode Extension도 제공되어 개발 중에도 실시간으로 스타일 및 규칙을 적용할 수 있음
- CI/CD 파이프라인과 연동하여 자동화된 코드 검사를 수행할 수 있어 코드 품질 관리에 도움이 됨
결과 및 영향
SwiftLint를 도입하면 아래와 같은 결과를 기대할 수 있습니다.
- 코드 일관성 개선: 프로젝트 전체에서 일관된 스타일 가이드를 적용하여 코드 가독성과 유지 관리성이 향상됨
- 개발 시간 절약: 코드 리뷰 과정에서 스타일에 대한 논쟁이 줄어들어 개발자들이 더 중요한 기능 개발에 집중할 수 있음
- 더 나은 협업: 프로젝트의 코드 스타일과 모범 사례가 표준화되어, 새로운 팀원이 프로젝트에 빠르게 적응하고 기여할 수 있음
결론
SwiftLint를 프로젝트에 도입함으로써, 코드 일관성, 품질, 가독성이 향상되고 개발 시간이 절약되며 협업이 개선됩니다. SwiftLint를 사용하여 팀의 생산성과 코드 품질을 향상시키는 것이 바람직하다고 판단합니다. 따라서, 우리 팀에서 SwiftLint를 채택하고 사용하는 것을 제안합니다. 이를 통해 프로젝트 전반의 코드 품질과 개발 경험을 향상시킬 수 있을 것입니다.