[swift] SwiftGen 설치 및 설정 방법

SwiftGen은 iOS 프로젝트에서 사용되는 리소스들을 자동으로 생성해주는 도구입니다. 이 도구를 사용하면 코드에서 리소스에 접근하는 데 필요한 문자열, 이미지 등을 타이핑하지 않고 간편하게 사용할 수 있습니다.

SwiftGen 설치하기

SwiftGen을 설치하려면 다음 단계를 따라주세요:

  1. 터미널을 열고 프로젝트의 루트 디렉토리로 이동합니다.
  2. Homebrew가 설치되어 있지 않다면, 다음 명령어를 터미널에 입력하여 Homebrew를 설치합니다:
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    
  3. 다음 명령어를 실행하여 SwiftGen을 설치합니다:
    brew install swiftgen
    

SwiftGen 설정하기

SwiftGen을 설치했다면, 다음 단계를 따라 프로젝트에 SwiftGen을 설정해보세요:

  1. 프로젝트의 루트 디렉토리로 이동한 상태에서 다음 명령어를 실행하여 SwiftGen 설정 파일인 swiftgen.yml을 생성합니다:
    swiftgen init
    
  2. swiftgen.yml 파일을 편집하여 리소스 유형에 맞는 섹션을 추가합니다. 예를 들어, 이미지 리소스를 사용한다면 다음과 같이 설정할 수 있습니다:
    # swiftgen.yml
    images:
      inputs: 
        - Resources/Images/**/*.{png,jpg}
      outputs:
        - template: swift4
          params:
            enumName: Asset
            forceFallbacksLocalization: true
    
  3. 필요한 리소스가 포함된 프로젝트 타겟의 Build Phases 설정으로 이동합니다.
  4. “New Run Script Phase”를 클릭하여 새로운 스크립트 단계를 추가합니다.
  5. 아래 스크립트를 추가하고, “Input Files” 필드에는 swiftgen.yml 파일의 경로를 입력합니다:

     if which swiftgen >/dev/null; then
         swiftgen
     else
         echo "warning: SwiftGen not installed, download it from https://github.com/SwiftGen/SwiftGen"
     fi
    

이제 프로젝트를 빌드하면 SwiftGen이 자동으로 설정한 대로 리소스에 접근할 수 있는 코드를 생성해줍니다.

SwiftGen의 자세한 사용 방법에 대해서는 공식 문서를 참고하시기 바랍니다.