프로젝트 개발 시 오픈 소스 라이브러리를 사용하는 경우가 많습니다. 이러한 라이브러리들은 개발 효율성을 높여주고, 유용한 기능들을 제공해줍니다. 하지만 라이브러리를 사용해 프로젝트를 개발할 때 그들에게 올바른 크레딧을 주는 것은 중요합니다.

이를 위해 Swift AcknowList를 사용할 수 있습니다. Swift AcknowList는 오픈 소스 라이브러리를 관리하고 출처 정보를 제공하기 위한 도구입니다. 이를 이용하여 프로젝트의 라이선스 및 크레딧 정보를 쉽게 관리할 수 있습니다.

Swift AcknowList란?

Swift AcknowList는 디스크에 저장된 라이브러리의 라이선스 및 크레딧 정보를 표시하는 리스트를 생성하는 스크립트입니다. 이 스크립트는 프로젝트의 런 스크립트에 포함되어 실행됩니다. AcknowList는 오픈 소스 라이브러리의 이름, 버전, 라이선스 및 출처 정보를 정리하여 Markdown 형식으로 제공합니다.

Swift AcknowList 사용 방법

다음은 Swift AcknowList를 사용해 오픈 소스 라이브러리를 관리하는 단계입니다.

단계 1: AcknowList 스크립트 추가

프로젝트의 루트 디렉토리에 acknowledgements.md 파일을 만들고, 해당 파일에 다음 스크립트를 추가합니다.

#import Foundation

let licensesURLs = [
    "라이브러리1": "https://github.com/라이브러리1",
    "라이브러리2": "https://github.com/라이브러리2",
    // 필요한 만큼 라이브러리 정보를 추가합니다.
]

let acknowledgementsPath = "acknowledgements.md"
let acknowledgementsData = readFile(atPath: acknowledgementsPath) ?? Data()
let acknowledgements = String(data: acknowledgementsData, encoding: .utf8) ?? ""

var text = "\(acknowledgements)\n"

for (library, url) in licensesURLs {
    text += "\n### \(library)\n\n[Link] \(url)\n"
    
    if let licensePath = Bundle.main.path(forResource: "\(library)/LICENSE", ofType: nil) {
        if let licenseData = readFile(atPath: licensePath) {
            let license = String(data: licenseData, encoding: .utf8) ?? ""
            text += "\n \n\(license)\n"
        } else {
            print("License file not found for library: \(library)")
        }
    } else {
        print("License file not found for library: \(library)")
    }
}

if let textData = text.data(using: .utf8) {
    writeFile(atPath: acknowledgementsPath, data: textData)
}

func readFile(atPath path: String) -> Data? {
    return FileManager.default.contents(atPath: path)
}

func writeFile(atPath path: String, data: Data) {
    FileManager.default.createFile(atPath: path, contents: data, attributes: nil)
}

단계 2: 라이브러리 정보 추가

licensesURLs 딕셔너리에 라이브러리의 이름과 GitHub 레포지토리 링크를 추가합니다. 필요한 만큼 라이브러리 정보를 추가할 수 있습니다.

단계 3: 라이브러리 라이선스 파일 추가

각 라이브러리의 루트 디렉토리에 LICENSE 파일을 추가합니다. 이 파일에 라이브러리의 라이선스 내용을 작성합니다. Swift AcknowList는 라이선스 파일을 찾아서 정보를 읽어옵니다.

단계 4: AcknowList 실행

프로젝트의 런 스크립트에 acknowledgements.md 파일을 생성하는 스크립트를 추가합니다. 다음은 Xcode의 런 스크립트 파일 (Run Script)에서 AcknowList 스크립트를 실행하는 예시입니다.

if [[ "$CONFIGURATION" == "Release" ]]; then
  swift <path_to_acknowlist_script>
fi

<path_to_acknowlist_script>를 AcknowList 스크립트 파일의 경로로 변경해주시기 바랍니다.

단계 5: AcknowList 리스트 확인

프로젝트의 루트 디렉토리에 acknowledgements.md 파일이 생성되었는지 확인합니다. 이 파일에는 오픈 소스 라이브러리의 크레딧 정보가 정리되어 있습니다. 이제 오픈 소스 라이브러리에게 올바른 크레딧을 전달할 수 있게 되었습니다.

추가로, AcknowList는 Markdown 형식으로 생성되기 때문에 필요한 경우 스타일을 추가하거나 수정하여 보다 시각적으로 관리하실 수도 있습니다.

이렇게 Swift AcknowList를 사용하여 오픈 소스 라이브러리를 관리하는 방법을 알아보았습니다. 프로젝트에서 사용하는 모든 라이브러리들에게 올바른 크레딧을 제공함으로써, 개발 생태계에서의 상호 협력과 예의를 유지할 수 있습니다.

더 많은 정보는 Swift AcknowList GitHub 레포지토리에서 확인하실 수 있습니다.