[iOS] SwiftGen으로 리소스 관리하기

 

SwiftGen은 CocoaPods, Homebrew, Mint 등 다양한 방법을 통해 설치할 수 있는데,

본 글에서는 Homebrew로 설치해보겠습니다.

 

터미널에서 아래 명령어를 순차적으로 실행합니다.

brew update
brew install swiftgen

 

 

설치를 완료하고 나면 리소스들을 코드로 파싱해줄 수 있는 yml 파일이 필요한데,

yml 파일은 터미널에서 swiftgen config init 을 입력해 생성할 수 있습니다.

 

 

 

 

또는 Xcode에서도 스크립트를 추가해 yml 파일을 생성할 수도 있는데,

우선 프로젝트 파일 - Targets - Build Phases - [+] New Run Script Phase로 스크립트 섹션을 추가합니다.

 

 

 

 

터미널에서 입력하는 명령어와 마찬가지로 swiftgen config init을 작성하고 프로젝트를 빌드하면

홈 디렉토리에 swiftgen.yml 파일이 생성되어 있는 것을 확인할 수 있습니다!

 

파일을 열어보면 모두 주석처리가 되어있을 텐데

필요한 부분만 적절히 찾아서 주석을 해제하고 프로젝트에 맞게 작성하면 됩니다.

 

 

 

 

현재 제 프로젝트의 폴더구조가 왼쪽과 같은데요.

Image Asset과 Color Asset을 구분된 파일로 만들어두었고, Font 폴더에도 폰트들을 다수 넣어두었습니다.

 

이 구조에 맞춰 스크립트를 작성하면 오른쪽과 같습니다.

inputs 영역에 리소스 파일을 작성해주는데, 리소스 파일이 yml 파일과 같은 위치에 있지 않으니 파일 경로를 상세히 작성해줍니다.

 

(⚠️ 경로 상세히 적기 귀찮다고 yml 파일의 위치를 옮겨 빌드하면

Command PhaseScriptExecution failed with a nonzero exit code 오류가 납니다!

yml 파일 위치는 건드리지 않기 ⚠️)

 

outputs 영역에는 이 리소스들을 관리할 새로 생성될 파일명을 지정해주면 됩니다.

자세한 옵션은 SwiftGen GitHub에서 확인할 수 있습니다.

 

 

 

 

이제 다시 Run Script로 돌아와서 swift config run으로 변경하여 입력하고 빌드해봅니다.

 

(물론 터미널에서 직접 입력해도 되지만, 한 번 Run Script로 작성해두면

빌드할때마다 해당 명령어가 실행되어 자동으로 outputs 파일들을 업데이트해주기 때문에 편리합니다.)

 

 

 

지정한 경로에 지정한 파일명을 갖는 Asset.swift와 Font.swift가 생성되었습니다!

 

 

 

 

 

아직 프로젝트에는 두 파일이 추가되지 않았을 텐데, Add File을 통해 프로젝트에도 파일을 추가해줍니다.

 

 

 

 

파일을 열어보면 이렇게 Enum 형태로 코드가 자동으로 작성되어 있습니다!

이제 이 코드를 이용해 리소스를 사용해보겠습니다.

 

 

let myButton: UIButton = {
    let btn = UIButton()
    btn.imageView.image = Asset.Image.TabBar.homeOn.image // Image Asset 사용
    btn.titleLabel.textColor = Asset.Color.green100.color // Color Assset 사용
    btn.titleLabel.font = FontFamily.NotoSansKR.regular.font(size: 14) // Font Asset 사용
    return btn
}()

짠! 엄청 간단합니다 👍

 

 

---

참고

https://vapor3965.tistory.com/103