Formatting/Linting 설정

[h9kwon]

설명

• 일관적인 코드 스타일 유지를 위해 Formatting 혹은 Linting 설정 필요

필요성

• 팀원 별로 작성하는 코드 스타일이 달라 코드에 일관성이 없어 가독성이 떨어짐
• 스타일 변경만을 위한 불필요한 커밋들이 지속하여 발생

TODO

• Formatting / Linting 중 어떤 것 사용할 지 결정
• 자동화 추가 여부 결정(동일한 규칙을 가지고 로컬에서 각자 돌릴 것인지, build phase에 추가해서 자동화시킬 것인지)
• rules 결정

기타

비교	Formatting	Linting
Tool	SwiftFormat	SwiftLint
기능	지정한 스타일 규칙에 맞춰 포매팅(코드수정) 적용	지정한 스타일 규칙을 어길 시 warning/error 발생
장점	코드 수정을 자동으로 적용시킬 수 있음	파일 라인수, 라인 길이 등 좀 더 깔끔한 코드 구현을 위한 기능 포함
단점	파일 길이 등에 대한 컨트롤은 불가	자동 수정 기능 없어서 warning/error 등을 보고 직접 수정해야 해서 강제성 떨어짐

[h9kwon]

개인 의견

• 먼저 SwiftFormat으로 강제성을 띄게 하는게 강제성이 있어서 '필요성' 측면에서 가장 빠르고 효과적인 방법일 것 같음..!
• 근데 빌드마다 적용시키도록 하면 시뮬 돌릴때마다 돌아가서 빌드시간 늘어난다는 단점은 있음.. 적용방식은 고민 필요해보임

[cirtuare]

개인 의견

• SwiftLint을 구경해보긴 한 정도인데 파일별 길이 조정 기능은 좋다고 생각했음
• 둘 다 적용하되, SwiftLint은 오로지 파일 길이 조절만 적용하고 나머지는 SwiftFormat으로 조정하는 것도 좋아보임
• 핫픽스 등 급한 상황이 존재할 수 있으니, 혹시 가능하다면 원할 때만 Formatting을 적용할 수 있게 하는 건 어떤지..? (PR 체크리스트에 Formatting 적용 여부 항목 추가)

[h9kwon]

• 핫픽스 등 급한 상황이 존재할 수 있으니, 혹시 가능하다면 원할 때만 Formatting을 적용할 수 있게 하는 건 어떤지..? (PR 체크리스트에 Formatting 적용 여부 항목 추가)

@cirtuare build phase 에 추가해 놓으면 사실 시뮬 빌드할때도 자동 적용되어서 따로 formatting을 위한 작업을 하지는 않아도 되는데 이러면 괜찮은건가?? 아니면 다른 귀찮은(아니면 시간이 지체되는..?) 상황이 있을까?