[swift] Swift Sourcery 활용 방법
Swift 프로젝트에서 코드를 자동으로 생성하고 관리하는 작업은 번거롭고 시간이 많이 소요될 수 있습니다. 이러한 문제를 해결하기 위해 소스 코드 생성 도구인 Swift Sourcery를 활용할 수 있습니다. Swift Sourcery는 주석 기반의 템플릿을 사용하여 코드를 생성할 수 있는 강력한 도구입니다.
Sourcery 설치
Sourcery를 사용하기 위해 먼저 설치해야 합니다. Swift 패키지 매니저를 통해 설치하는 것이 가장 간단하고 편리합니다. 아래 명령을 터미널에 입력하여 Sourcery를 설치합니다.
$ brew install sourcery
Sourcery 템플릿 작성
자동으로 생성할 코드의 템플릿을 작성해야 합니다. 템플릿은 주석으로 작성되며, 특정 규칙을 따라야 합니다. 예를 들어, 클래스를 생성하는 템플릿은 다음과 같습니다.
// sourcery: AutoGenerateCode
class MyClass {
// AutoGenerateProperty
var myProperty: Int
// AutoGenerateMethod
func myMethod() {
// ...
}
}
위 예시에서 sourcery: AutoGenerateCode와 AutoGenerateProperty, AutoGenerateMethod 주석은 Sourcery에 의해 자동으로 생성될 코드에 대한 힌트 역할을 합니다.
Sourcery 실행
Sourcery는 프로젝트의 소스 파일을 분석하고 템플릿에 따라 자동으로 코드를 생성합니다. 다음 명령을 터미널에 입력하여 Sourcery를 실행합니다.
$ sourcery
이 명령은 소스 코드 및 템플릿을 기반으로 자동 생성된 코드를 프로젝트의 소스 파일에 추가합니다.
Sourcery 플러그인 활용
Sourcery에는 다양한 플러그인이 제공되어 있습니다. 플러그인을 활용하면 추가로 코드를 자동으로 생성할 수 있습니다. 예를 들어,
- Sourcery-AutoInit: 자동으로 초기화 코드를 생성할 수 있습니다.
- Sourcery-AutoMockable: 자동으로 Mock 객체 코드를 생성할 수 있습니다.
위와 같은 플러그인을 활용하여 자동 생성할 코드의 범위를 확장할 수 있습니다.