👋 안녕 XcodeGen

오늘은 XcodeGen에 대해 공부한 내용과 그 결과로 내린 결론에 대해 얘기하는 시간을 가져보겠습니다!

XcodeGen이란?

XcodeGen은 폴더 구조와 프로젝트 스펙에 맞춰서 Xcode 프로젝트를 만들어주는 커맨드 라인 도구입니다.

대표적으로 라인에서 XcodeGen을 사용하고 있는 것 같습니다.

처음에 리드미만 읽고 큰 프로젝트에 적용해보려 하면 막막할 수 있기 때문에 사용법을 차례대로 읽으며 작은 프로젝트에 기능을 단계적으로 적용하는 것을 추천드립니다.

XcodeGen의 특징

• 프로젝트 파일(.xcodeproj)을 코드 저장소에 올리지 않고 명령어를 통해 프로젝트 파일을 만들기 때문에 머지할 때 프로젝트 파일에서 컨플릭트가 생길 일이 없습니다.

• 프로젝트 설정을 봐야 할 때 이곳저곳 돌아다닐 필요 없이 project.yml 파일 하나만 보면 됩니다.

• 새로운 프로젝트를 찍어낼 때 편합니다. 저 같은 경우는 새로운 기술 적용을 위해 간단한 앱 프로젝트를 여러 개 찍어낼 경우가 있는데요, 이럴 때 공통으로 사용할 수 있는 project.yml 파일이 있으니 참 편했습니다.

• SwiftGen, SwiftLint 등 Build Phase에 스크립트를 추가해야 할 때도 간편하게 project.yml 파일에 적어두기만 하면 됩니다.

• Carthage를 추가적인 설정없이 간편하게 사용할 수 있다고 합니다만, 사용해보진 않았습니다. Carthage는 사용하려면 Xcode 12에선 별도의 스크립트가 필요한데다가, M1칩에선 작동하지 않는다고 합니다. 그래서 당분간 Carthage를 쓸 일은 없을 것 같아 테스트를 안해봤습니다. 자세한 내용은 여기에서 확인해주세요.

실제 사용 예시

저는 실제로 뜨개질 단수계 겸 뭐든 셀 수 있는 카운터 어플리케이션인 Stitch에서 XcodeGen을 사용하고 있습니다. project.yml 파일은 다음과 같습니다.

프로젝트 껍데기만 기본적으로 만들어주는 내용이라 pod이 없는데도 pod install을 하고, SPM도 몇 개 쓰고 있지 않지만 이것만으로도 개인 작업 능률이 많이 올라갔습니다.

힘든 점

XcodeGen을 사용하면 기본적으로 .xcodeproj 파일을 .gitignore에 적어둡니다. 이러한 이유로 origin의 바뀐 코드를 pull하거나 main 브랜치에서 rebase나 merge로 땡겨올 때 코드는 바뀌지만 .xcodeproj는 그대로인 상황이 발생합니다.

그래서 매번 xcodegen generate 명령어를 사용해야 하는데, 저는 이 부분이 많이 귀찮았습니다.

이 귀찮음을 해결하기 위해 git hooks를 사용해보려고 했는데 비슷한 것을 찾았지만 저한테 필요한 기능이 아니었습니다.

결론

평소에 git pull이나 merge를 할 때 스크립트를 사용하는 개발팀이 아니라면 XcodeGen을 사용하는 것이 조금 무리가 있을거란 생각이 듭니다.

XcodeGen을 사용하기 위해선 팀원과의 많은 논의가 필요할 것 같습니다. 하지만 협업하는 인원이 많지 않거나 워킹 브랜치가 적은 경우엔 아주 적합한 것 같습니다.

오늘은 여기까지 입니다! 저는 개인 프로젝트에 XcodeGen을 계속 사용해보고 더 깊게 알아봐야겠네요.

참고한 글

• XcodeGen Usage
• 프로젝트에 XcodeGen 도입하기