아리의 iOS 탐구생활

[iOS] ChatGPT를 이용하여 WWDC 내용을 추출해보자

Ari Lee — Wed, 3 Jul 2024 20:53:26 +0900

요즘 공부할 때 구글링 보다는 GPT를 활용해서 공부를 하고 있는데요.
이번에 WWDC24가 발표되면서 회사 팀 내에서 스터디를 시작하게 되었습니다.

그러면서 제가 효율적으로 공부하기 위한 방법을 찾다가... 발견한 꿀팁을 공유하기 위해 작성하게 되었습니다.

특정 세션 내용을 간단하게 정리된 내용을 추출해보고 싶다.

세션 영상을 보기 전에 약간의 이해도가 있는 상태에서 영상을 보면 좀 더 이해하기 쉽지 않을까? 해서 고민하다가 아래와 같은 방법을 생각하게 되었습니다.

특정 세션의 WWDC 유튜브 영상을 진입한다.
해당 영상의 영어 자막 파일을 .txt 파일로 추출한다.
- 아래 링크로 진입해서 유튜브 영상 링크를 붙여넣어 다운로드 버튼을 누르면 자막 파일을 만들어준다.
- https://downsub.com/
GPT에게 파일과 함께 요청해본다.
- "해당 자막 파일을 주제별로 내용을 정리해주라."
좀 더 궁금한 주제는 더 자세히 정리해달라고 요청해본다.
- 정확하지 않은 내용이 있을 수 있으니 요령껏 필터링해서 참고하자.
- GPT는 잘못된 내용을 기반으로 답변할 수 있으니 항상 의심해야한다. 제공받은 정보가 정확한지 궁금하다면 공식문서를 통해 직접 검증하기 바란다.

Download subtitles from Youtube, Viki, Viu, Wetv, Kocowa and more

DownSub is a free web application that can download subtitles directly from Youtube, Drive, Viu, Vimeo, Viki, Wetv, Kocowa and more.

downsub.com

아래는 채팅 예시이다.

참고로 저는 유료버전인 ChatGPT 4o을 사용했습니다.

주의사항

아무래도 WWDC에 대한 새로운 내용이 GPT는 아직 학습되지 않은 경우가 많다.
오직 자막 내용을 기반으로 정보를 알려주기 때문에 정확도가 떨어진다. (엉뚱한 내용 덧붙혀서 설명할 수도 있음...)

자막을 기반으로 세션 내용 요약본을 추출한다 라는 것을 잘 기억하고,
만약 세션 내용 일부분을 깊게 이해하고 싶다면, 영상과 Apple 공식문서를 함께 참고하면서 공부해보는 것을 권장한다.

WWDC 스크린샷 쉽게 찍는 방법

https://chrome.google.com/webstore/detail/gjoijpfmdhbjkkgnmahganhoinjjpohk

Screenshot YouTube

Take a screenshot of any YouTube video with one click.

chromewebstore.google.com

공부한 내용을 정리하다보면, 세션 영상의 화면을 캡쳐할 일이 잦은데 그럴때 사용하기 좋다.

크롬 확장 프로그램을 활용한 방법이다.
위 링크로 진입하여 확장 프로그램을 다운받으면, 유튜브 영상에 Screenshot이라는 버튼이 추가된다.

https://chrome.google.com/webstore/detail/gjoijpfmdhbjkkgnmahganhoinjjpohk

저는 저장을 파일 대신 클립보드로 설정을 바꾸어서 사용하고 있습니다.

Copy to clipboard

마무리

Meet Swift Testing 모두 정리했더니.. 목차가 기네요....... 근데 이거 재미써요.

저는 위 팁들을 활용해서 영상을 보기전에 GPT를 통해 세션의 작은 주제들을 먼저 얻어내고,

이후 영상을 보면서 미리 정리한 주제를 따라가면서... 학습 내용을 정리해가며 공부하고 있습니다.

궁금하지만 깊게 파고싶지 않은 그런 영상의 내용을 한번 맛보는 용도로도 사용하기 좋은 것 같아요.

확실히 세션 내용 중 어떤 주제가 있고, 어떤 내용이 포함되어있는지 간단히 먼저 정리한 후에 영상을 보며 공부하니까

머리에 쏙쏙!! 이해도 빠르고 정리도 평소보다 빠르게 잘되는 것 같아요.

이전엔 이해가 안되도 두번 세번 보다보면 이해가 되겠지하고 때려박는 느낌이였는데...ㅋㅋ

단 시간 안에 효율적으로 공부하는 느낌(?)이 들어서 이런 꿀팁은 나만 알고있으면 아까우니까... 하는 마음에 공유해봅니다.

(나만 몰랐을수도...)

마무리는 우리 귀염둥이 뿌꾸 사진으로~~~

[iOS/Swift] 라이브러리 SwiftyUserDefaults를 알아보자~

Ari Lee — Wed, 3 Jan 2024 23:53:59 +0900

GitHub - sunshinejr/SwiftyUserDefaults: Modern Swift API for NSUserDefaults

Modern Swift API for NSUserDefaults. Contribute to sunshinejr/SwiftyUserDefaults development by creating an account on GitHub.

github.com

SwiftyUserDefaults는 한 곳에서 키를 정의하고, 값 유형을 쉽게 사용할 수 있으며, 컴파일 시 안전성과 편의성을 높여주는 컴파일 타임 검사를 무료로 이용할 수 있다고 한다.

한마디로 UserDefaults를 사용할 때, 타입 안전성과 코드의 간결성을 동시에 얻을 수 있는 아주 편리한 라이브러리다.

Generic, Subscript, DynamicMemberLookup 등을 활용하여
UserDefaults를 아주 편안하게 사용할 수 있게 구현되어 있다.

SwiftyUserDefaults로 특정 값을 접근하거나 저장하기

1. 키 정의하기

정의하는 방법은 DefaultsKey라는 제네릭 타입을 활용하여 정의해준다. 이때 들어가는 타입은 저장될 타입을 의미한다.
타입을 옵셔널로 설정하지 않을경우 defaultValue를 꼭 설정해 줘야 한다.

let username: DefaultsKey<String?> = .init("username")
let launchCount: DefaultsKey<Int> = .init("launchCount", defaultValue: 0)

더 편리하게 사용하려면 아래 코드 예시와 같이 DefaultsKeys 타입을 확장하여 프로퍼티를 정의해주면 된다.

extension DefaultsKeys {
    var username: DefaultsKey<String?> { .init("username") }
    var launchCount: DefaultsKey<Int> { .init("launchCount", defaultValue: 0) }
}

왜 위 방법이 편리한지는 아래를 살펴보면 이해할 수 있다.

https://github.com/sunshinejr/SwiftyUserDefaults#keypath-dynamicmemberlookup

2. 접근하기

DefaultsKeys를 확장하여 정의한 프로퍼티를 활용할 때

// UserDefaults 값을 손쉽게 가져와 바로 할당할 수 있다.
let username: String? = Defaults.username

DefaultsKey를 직접 사용할 때

let username: DefaultsKey<String?> = .init("username")
let username: String? = Defaults[key: username]

3. 저장하기

DefaultsKeys를 확장하여 정의한 프로퍼티를 활용할 때

// 값을 제자리에서 수정할 수 있다.
Defaults.launchCount += 1

DefaultsKey를 직접 사용할 때

let launchCount: DefaultsKey<Int> = .init("launchCount", defaultValue: 0)
Defaults[key: launchCount] += 1

Defaults는 어떻게 정의되어있을까?

전역적으로 사용되는 Defaults는 어떻게 구현되어있는지 살펴보니 아래와 같이 정의되어있었다.

public var Defaults = DefaultsAdapter<DefaultsKeys>(defaults: .standard, keyStore: .init())

DefaultsAdapter는 UserDefaults를 래핑한 구조체이다.

https://github.com/sunshinejr/SwiftyUserDefaults/blob/master/Sources/DefaultsAdapter.swift

defaults는 UserDefaults를 의미하고, KeyStore는 DefaultsKeyStore 프로토콜을 준수한 타입을 의미한다.
기본적으로는 빈 구조체로 DefaultsKeys라는 구조체가 정의되어있었다.

https://github.com/sunshinejr/SwiftyUserDefaults/blob/master/Sources/DefaultsKeys.swift

이렇게 SwiftyUserDefaults라는 라이브러리를 간단하게 살펴보았는데,
추가로 KVO 기능을 제공하기도 하며,
프로퍼티 래퍼를 활용하여 각 Key 값에 캐싱 및 관찰 옵션을 설정할 수도 있다.
자세한 건 아래 링크를 참고해 보자.

https://github.com/sunshinejr/SwiftyUserDefaults#property-wrappers

꿀팁: UserDefaults에 저장되어있는 모든 Key-Value 쌍을 가져오기

dictionaryRepresentation() | Apple Developer Documentation

Returns a dictionary that contains a union of all key-value pairs in the domains in the search list.

developer.apple.com

dictionaryRepresentation() 메소드를 활용하여 UserDefaults에 저장된 모든 Key와 Value를 딕셔너리 형태로 가져올 수 있다.

아래는 활용 예시!

func removeAll() {
    for key in defaults.dictionaryRepresentation().keys {
        defaults.removeObject(forKey: key)
    }
}

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ댓글✍ 부탁드립니다.

[iOS] 웹뷰를 사용할 때 자바스크립트로 양방향 통신하기

Ari Lee — Sun, 24 Sep 2023 23:16:46 +0900

최근에 웹뷰 관련된 작업을 진행했는데,
웹뷰에서 보내는 메시지를 전달받아 화면을 이동하거나 띄우는 동작을 구현하였다.
사실 뭣도 모르고 기존 프로젝트에 작성되어있던 코드를 참고하여
작업을 완료하였기 때문에...
그냥 넘어가기 굉장히 찝찝하고 이해가 부족하다고 느껴서
정확히 이해하고 넘어가고 싶어서 정리하게 되었다.

내가 알아볼 키워드는 다음과 같다.

WKScriptMessageHandler
WKWebView
evaluateJavaScript

iOS에서 웹뷰를 사용할 때 양방향 통신을 하는 방법

WKScriptMessageHandler | Apple Developer Documentation

An interface for receiving messages from JavaScript code running in a webpage.

developer.apple.com

WKScriptMessageHandler는 iOS의 WebKit 프레임워크에서 제공하는 프로토콜이다.
이 프로토콜은 WKWebView 내부의 JavaScript에서 웹뷰의 호스트 애플리케이션으로 메시지를 보낼 수 있도록 도와준다.

간단히 말해 WKScriptMessageHandler는 웹 페이지 내의 JavaScript 코드와 네이티브 iOS 코드 사이에서 상호작용(메시지 전달)을 할 수 있다.

JavaScript → iOS

웹페이지 내의 버튼을 클릭하면 JavaScript가 WKWebView의 네이티브 애플리케이션으로 어떤 정보나 명령을 보낼 수 있다.

iOS → JavaScript

evaluateJavaScript(_:completionHandler:) | Apple Developer Documentation

Evaluates the specified JavaScript string.

developer.apple.com

iOS 앱에서 사용자의 액션에 대응하여 JavaScript 함수를 호출할 수 있다. 이 경우에는 WKWebView의 evaluateJavaScript 메소드를 사용하면 된다.

사용 예시 (JavaScript → iOS)

import UIKit
import WebKit

final class WebViewController: UIViewController, WKScriptMessageHandler {
    
    private weak var webView: WKWebView!

    override func viewDidLoad() {
        super.viewDidLoad()

        let contentController = WKUserContentController()
        contentController.add(self, name: "messageHandler") // 해당 이름으로 메시지를 식별하거나 보낼 수 있게 된다.

        let config = WKWebViewConfiguration()
        config.userContentController = contentController
        
        webView = WKWebView(frame: .zero, configuration: config)
        view.addSubview(webView)
        // ... (웹 뷰 레이아웃 및 URL 로딩 코드)
    }

    // WKScriptMessageHandler 프로토콜의 메서드. JavaScript로 부터 전달받은 메시지를 전달 받는다.
    func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
        if message.name == "messageHandler", let messageBody = message.body as? [String: Any] {
            print("Received message from JavaScript: \(messageBody)") // 웹으로부터 받은 메시지를 파싱하여 print를 호출하는 코드.
        }
    }
}

위 예제에서는 userContentController 메소드에서 JavaScript로부터 내려온 메시지를 받아서 간단하게 print를 실행하는 모습을 확인할 수 있다.

userContentController(_:didReceive:) | Apple Developer Documentation

Tells the handler that a webpage sent a script message.

developer.apple.com

위 예제를 참고하여 JavaScript에서는 다음과 같은 코드로 iOS에 메시지를 보낼 수 있다.

// iOS에게 메시지를 보내는 코드.
window.webkit.messageHandlers.messageHandler.postMessage("Hello from JavaScript!");

위 코드를 보면 iOS에서 contentController에 add 함수로 등록한 name과 일치하는 이름(window.webkit.messageHandlers.messageHandler.postMessage)으로 메시지를 보내는 모습을 확인할 수 있다.

어떤 메시지를 주고 받을지에 대한 정의는 프론트와 iOS가 같이 인터페이스를 별도로 정의해야한다.
위 코드는 간단한 예시라는 것을 명심하자…!

WKScriptMessage | Apple Developer Documentation

An object that encapsulates a message sent by JavaScript code from a webpage.

developer.apple.com

message.name
- iOS 측에서 WKUserContentController 객체를 사용하여 메시지 핸들러를 추가할 때 지정한 이름이다.
- 이 이름을 통해 웹 페이지 내의 JavaScript에서 해당 핸들러를 식별하고 메시지를 보낼 수 있다.  따라서, 앱 개발자가 미리 정의하고 웹 개발자에게 해당 이름을 알려줘야 한다.
message.body
- JavaScript에서 postMessage 메서드를 호출할 때 전달하는 데이터다.
- 이 데이터의 형태와 내용은 웹 개발자와 앱 개발자 사이의 약속에 따라 다를 수 있다.  예를 들어, 문자열을 보낼 수도 있고, JSON 형태의 데이터를 보낼 수도 있다.

사용 예시 (iOS → JavaScript)

extension WebViewController {

    /// JavaScript 메소드를 호출하는 메소드
    func callJavaScript(script: String, completionHandler: @escaping (Any?, Error?) -> Void) {
        // evaluateJavaScript를 사용하여 웹 페이지 내의 JavaScript 함수를 호출할 수 있다.
        webView.evaluateJavaScript(script) { (result, error) in
            if let error = error {
                print("Error calling JS function: \(error)")
                completionHandler(nil, error)
            } else if let result = result {
                print("Received result from JS function: \(result)")
                completionHandler(result, nil)
            }
        }
    }
}

위 예제에서는 callJavaScript라는 메소드를 별도로 구현하였다.
어떤 특정 상황에서 웹뷰의 기능을 수행해야한다면 위 웹뷰의 evaluateJavaScript 메소드를 통해 JavaScript 함수를 호출하도록 해볼 수 있다.

evaluateJavaScript(_:completionHandler:) | Apple Developer Documentation

Evaluates the specified JavaScript string.

developer.apple.com

결론적으로 message.name과 message.body의 정확한 정의와 사용 방식은 웹 개발자와 앱 개발자 사이의 협업과 의사소통을 통해 정의되어야 한다. 두 개발자는 서로 어떤 메시지 이름을 사용하며, 어떤 형태의 데이터를 주고받을 것인지 사전에 명확히 약속하고 이해해야 한다.

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ댓글✍ 부탁드립니다.

[iOS/Tuist] scafflod를 사용하여 모듈 생성 자동화하기

Ari Lee — Sun, 9 Jul 2023 19:14:34 +0900

안녕하세요. 요즘에 취업 이후 글이 뜸해진 것 같아... 반성하고 다시 돌아온 아리입니다.

직장생활 뿐만 아니라... 어쩌다가 갑자기 강아지를 키우게 되어서 육아하느라고 정신이 없었습니다. (TMI)

취업에 성공하고 개발자로 회사생활을 시작한지 5개월이 다 되어가네요. 울집 강쥐도 태어난지 5개월이 되었어요.

강아지와 함께 살게되면서 생각해야할 것과 할일이 많아져서 너무 바쁘지만 그래도 덕분에 행복하고 즐거운 생활을 하고 있답니다.

이번 글에서는 제가 회사 프로젝트에 Tuist를 적용하게 되었는데,
그 중 템플릿을 만들어 모듈 생성을 자동화하는 방법을 기록해보려고 합니다.

시작하기 전에 저희집 귀염둥이 사진 먼저 투척하고 시작하겠습니다. ‍♀️

울집 강쥐 뿌꾸... 우리집에 온지 100일 된 기념으로 케이크 먹고 행복해하고 있는 중...

# tuist scafflod

해당 명령어를 사용해서 자신만의 템플릿을 정의하거나 Tuist에서 제공하는 템플릿을 사용할 수 있다.

보통은 새로운 컴포넌트나 기능을 만드는 것을 시작할 때 사용해볼 수 있는 기능이다.

# 템플릿 정의하기

먼저 프로젝트 내부 Tuist 디렉토리에 Templetes 디렉토리를 생성하고 그 내부에 템플릿을 추가해준다.

중요한 것은… 템플릿 디렉토리 내부 디렉토리 이름과 Template을 선언할 .swift 파일 이름이 동일해야한다.

경로 예시

템플릿 디렉토리를 생성해주었다면, 내부에 디렉토리 이름과 동일한 .swift 파일을 생성하여 아래와 같이 코드를 추가해준다.

// Module.swift 파일
import ProjectDescription

// scaffold 명령어 시 받을 인자.
let name: Template.Attribute = .required("name")
let author: Template.Attribute = .required("author")
let currentDate: Template.Attribute = .required("currentDate")

// 템플릿 선언.
let moduleTemplate = Template(
    description: "A template for a new feature module",
    attributes: [
        name,
        author,
        currentDate
    ],
    items: ModuleTemplate.allCases.map { $0.item }
)

enum ModuleTemplate: CaseIterable {
    case project
    case temp

    // 템플릿 내부에 추가할 파일.
    var item: Template.Item {
        switch self {
        case .project:
            return .file(path: .basePath + "/Project.swift", templatePath: "Project.stencil")

        case .temp:
            return .file(path: .basePath + "/Sources/Temp.swift", templatePath: "Temp.stencil")
        }
    }
}

// 템플릿을 추가할 기본 경로.
extension String {
    static var basePath: Self {
        return "Grip/Projects/\(name)"
    }
}

보면 Templete 선언 외에도 여러가지가 있는데, 위에서부터 차례대로 알아가보도록 하자.

## Template.Attribute

https://tuist.github.io/tuist/main/documentation/projectdescription/template/attribute

Documentation

tuist.github.io

해당 타입은 커맨드의 옵션을 받는 변수를 선언할 수 있다.
예를 들어 name이라는 attribute가 존재한다면…

tuist scafflod --name Ari

이런식으로 옵션을 추가적으로 받아볼 수 있다.

이 옵션은 위 예시처럼 required로 필수로 받아볼 수 있고 optional하게 받아볼 수도 있다.

## Templete

https://tuist.github.io/tuist/main/documentation/projectdescription/template

Documentation

tuist.github.io

그 다음으로 템플릿 모델을 선언해준다.
위에서 선언해준 attributes를 할당하고, items를 할당해줘야 하는데, 여기에는 템플릿을 생성할 때 추가할 파일들을 할당해주면 된다.

## Templete.Item

https://tuist.github.io/tuist/main/documentation/projectdescription/template/item

Documentation

tuist.github.io

이 아이템은 템플릿을 생성할 때 추가될 파일을 의미한다.
파일은 경로로 전달해줄 수도 있고, 디렉토리 자체를 넘겨줄 수도 있으며, 단순히 문자열로 생성해줄 수도 있다.

위 코드에서는 ModuleTemplate라는 enum 타입을 만들어 items 할당을 손쉽게 할 수 있도록 작성해준 모습을 확인할 수 있다.

이때 추가되는 파일에는 stencil이라는 템플릿 언어를 사용하여 만든 파일을 추가해줘야 한다.

## Stencil

https://github.com/stencilproject/Stencil

GitHub - stencilproject/Stencil: Stencil is a simple and powerful template language for Swift.

Stencil is a simple and powerful template language for Swift. - GitHub - stencilproject/Stencil: Stencil is a simple and powerful template language for Swift.

github.com

스텐실은 Swift를 이용한 템플릿 언어를 의미한다.
(자세한건 위 링크 참고)

아래는 .stencil 파일 예시이다.

// Project.stencil 파일
import ProjectDescription
import ProjectDescriptionHelpers

let project = Project.makeModule(
    name: "{{ name }}",
    product: .staticFramework,
    deploymentTarget: .iOS(targetVersion: "14.0", devices: [.iphone, .ipad]),
    dependencies: [],
    sources: [
        "Sources/**"
    ],
    resources: nil,
    settings: .settings(
        base: SettingsDictionary(),
        configurations: [
            .debug(name: .debug),
            .release(name: .release),
            .release(name: .stage)
        ]
    )
)

// Temp.stencil 파일
//
//  Temp.swift
//  Grip
//
//  Created by {{ author }} on {{ currentDate }}
//  Copyright © 2023 Grip Corp. All rights reserved.
//

import UIKit

struct Temp {}

위 코드를 보면 커맨드로 받은 attribute를 코드 내부에 변수처럼 심어준 것을 확인할 수 있다.

# scafflod 명령어 실행

위와 같이 템플릿 작성을 마쳤다면, 명렁어를 실행해주면 되는데, 편의를 위해 Makefile을 작성해주면 좋다.

Makefile은 보통 git 명령어를 실행하는 프로젝트 디렉토리 내부에 생성해주면 된다.

별도로 확장자는 필요없고 Makefile이라는 파일을 생성해주면 된다.

USER_NAME = $(shell python3 scripts/author_name.py)
CURRENT_DATE = $(shell pipenv run python scripts/current_date.py)

# 사용법: make module name=모듈이름
module:
	@tuist scaffold Module \
	 --name ${name} \
	 --author "$(USER_NAME)" \
	 --current-date "$(CURRENT_DATE)"
	 
	@tuist edit

위는 Makefile의 예시이다.
살펴보면 attribute를 전달해주고 수행 이후에는 tuist edit 명령어를 실행하는 모습을 확인할 수 있다.

새로운 모듈을 생성하고 매니페스트를 편집하기 위해서 해당 명령어로 구성해주었다.

상단에는 USER_NAME과 CURRENT_DATE라는 변수가 선언되어 있는데, 필수는 아니지만...
파이썬으로 사용자 이름과 현재 날짜를 가져오는 스크립트를 실행하는 부분이다.

아래는 파이썬 코드의 예시다.

작성자 가져오기

import subprocess

def get_full_name():
    command = 'osascript -e "long user name of (system info)"'
    process = subprocess.Popen(command, stdout=subprocess.PIPE, shell=True)
    output, _ = process.communicate()
    return output.decode().strip()

print(get_full_name())

현재 날짜 가져오기

import datetime

def get_current_date():
    today = datetime.date.today() # Format the date as "YYYY/MM/DD"
    formatted_date = today.strftime('%Y/%m/%d')
    return formatted_date

print(get_current_date())

이렇게 커맨트 설정까지 마쳤다면 프로젝트 경로에서 make module name=Core 라는 명령어를 수행해주면,
작성된 템플릿을 통해 설정된 경로에 Core라는 이름을 가진 새로운 모듈을 생성해주게 된다.

Reference

tuist scaffold | Tuist Documentation

Learn how to use the scaffold command to generate files from a pre-defined template.

docs.tuist.io

GitHub - minsOne/iOSApplicationTemplate: Tuist based iOS Application Project Template

Tuist based iOS Application Project Template. Contribute to minsOne/iOSApplicationTemplate development by creating an account on GitHub.

github.com

Tuist 로 모듈 생성 자동화하기

안녕하세요? iOS 엔지니어 박형석입니다. 이번 글에서는 Tuist 에서 모듈화 작업 중 실수하기 쉽고 번거로운 작업인 모듈 생성을 자동화해서 명령어 하나로 기본 모듈을 생성하는 방법을 소개하려

medium.com

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ 댓글✍ 부탁드립니다.

[Figma/Tip] 디자인 가이드 확인할 때 유용한 꿀팁 모음

Ari Lee — Fri, 14 Apr 2023 14:39:58 +0900

피그마 이용하면서 활용하면 유용한 단축키, 꿀팁들을 알아봅시다.

# 피그마 단축키 도우미

우측 하단 ? 버튼 > Keyboard shortcuts를 클릭.

섹션별로 탭이 나누어져 있는데, 단축키를 누르면 아래 그림처럼 파란색으로 채워진다.

모두 누르면 탭 자체가 하늘색으로 바뀐다.

(개발자는 단축키를 애용해야 제맛이지 )

개인적으로 디자인 가이드 볼 때, Tools, Zoom 쪽 단축키들이 가장 유용했다.

ex) 코멘트 달 때 c 누르면 코멘트 커서로 바뀐다. (Tools)

# 컬러 코드 확인하기

위 내용과 이어지는 내용인데, i 버튼을 누르면 자동으로 pick color 툴로 커서가 변하면서 아래처럼 컬러코드를 확인할 수 있다.

또다른 방법은 이미지 요소를 선택한 후 우측 inspect 를 확인해서 아래처럼 확인할 수 있다.

# 이미지 리소스 간편 다운로드

아래 사진과 같이 + 버튼을 통해 여러 스케일의 이미지를 추가할 수 있고,
선택한 이미지를 한꺼번에 Export할 수 있다.

또한 Xcode에 Assets을 추가할 때도 2x, 3x 같이 선택해서 드래그해서 넣어주면 자동으로 하나로 합쳐서 2x, 3x 별로 추가된다.

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ 댓글✍ 부탁드립니다.

[후기] YAPP X 인프런 - UX/UI 시작하기 : Figma 입문

Ari Lee — Mon, 6 Mar 2023 19:56:07 +0900

YAPP 후원을 통해 얻은 인프런 수강권으로 피그마 강의를 듣고, 스터디를 진행하며 작성하게 된 후기입니다.

# 피그마 스터디를 시작하게된 계기

이번 YAPP 21기 기수에서는 인프런과 연계하여 수강권을 제공해 주었고, 그중 피그마 강의를 선택하게 되었다.

이유는 iOS 개발자로서 디자이너와 협업하다 보면 Figma라는 툴을 많이 사용하게 되는데, 이 툴을 좀더 잘 활용할 수 있다면[?] 협업하는 데 있어서 도움이 되지 않을까 싶어서 배워보고 싶어졌고, 수강하게 되었다.

# 스터디 진행

주마다 정해진 강의 범위를 함께 정하고, 스터디 시간에는 강의를 보면서 어려웠던 점, 공유해주고 싶은 점들을 이야기하며 진행하였다. 스터디 도중에 회사 과제 전형을 마주하게 되었었는데, 그때 이 강의에서 배웠던 부분을 써먹어서 적용해보기도 했다.

내가 처음으로 제대로 만들어본 간단한 프로토타이핑~

# 후기

스터디 후반에는 면접 일정 및 YAPP 프로젝트 개발 활동 등등 겹치게 되어서 완주하지는 못했다. 하지만 피그마의 기초적인 부분에 대해서 배우게 되었고, 핵심 기능들을 잘 다룰 수 있게 되었다. 다만 Figma 업데이트 속도가 빠른건지 강의 중간 중간 현재 버전과 강의에 나오는 피그마 툴이 약간씩 상의했던 점이 아쉬웠다. (그래도 이 부분은 질문하면 빠르게 답변해주시는 것 같았다!)

그리고 Figma로 협업하면서 마주했던 문제도 있었는데, 이 부분 또한 Figma 공식문서에 해결방안이 잘 나와있어 해결 후 동아리 동료분들에게 공유해주기도 하였다.

Figma 툴을 익힌다고 해서 디자인을 잘할 수 있다거나 그런건 아니지만, 앞으로 iOS 개발하면서 디자이너 분들과 원활한 협업을 위해 한번쯤 배워보는 것도 나쁘지 않다고 생각한다!

앞으로 남은 강의들도 열심히 들어야지!!!

미래의 나.... 화이팅...!!!

이곳은 다른 디자이너 분들이 만든 UI/UX를 엿볼 수 있는 링크다!! 나중에 따라 만들어봐야지 ㅎㅎ~

Lifeplus

한국의 UI/UX 모바일 패턴을 수집합니다.

wwit.design

# 내가 들었던 강의

UX/UI 시작하기 : Figma 입문 (Inflearn Original) - 인프런 | 강의

UI 디자인 스케치, 프로토타이핑 및 협업을 위한 디자인 도구 Figma(피그마)의 기본적인 사용법과 실무 활용법에 대해 학습해 봅니다., - 강의 소개 | 인프런

www.inflearn.com

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ 댓글✍ 부탁드립니다.

[iOS/Tuist] Objective-C 코드가 포함된 라이브러리 의존성 주입시 발생하는 문제

Ari Lee — Mon, 27 Feb 2023 23:10:37 +0900

YAPP 동아리 21기 iOS 2팀 핏프티 프로젝트를 진행하면서 겪었던 문제입니다.
Tuist 4 버전부터는 발생하지 않으니 참고해주세요.

# 문제 상황

먼저 dependencies에 Amplify 라이브러리 설치를 위해 SPM 목록에 아래와 같이 코드를 추가해주었다.

import ProjectDescription
import ProjectDescriptionHelpers

let dependencies = Dependencies(
    carthage: [],
    swiftPackageManager: [
        .remote(
            url: "https://github.com/kakao/kakao-ios-sdk",
            requirement: .upToNextMajor(from: "2.13.0")
        ),
        .remote(
            url: "https://github.com/Moya/Moya.git",
            requirement: .upToNextMajor(from: "15.0.0")
        ),
        .remote(
            url: "https://github.com/onevcat/Kingfisher.git",
            requirement: .upToNextMajor(from: "7.0.0")
        ),
        .remote( // 추가한 코드.
            url: "https://github.com/aws-amplify/amplify-swift.git",
            requirement: .upToNextMajor(from: "2.0.0")
        )
    ],
    platforms: [.iOS]
)

그리고 tuist fetch 이후 tuist generator를 통해 프로젝트를 실행했더니,
다음과 같은 에러가 발생하면서 빌드에 실패했다.

Could not build Objective-C module 'libtommathAmplify'

'../amplify_tommath.h' file not found

# 이유

일반적으로 tuist에서 지원하는 외부 의존성은 다음과 같다.

SPM
- Swift Package Manager 를 사용하는 의존성
Tuist + Swift Package
- Dependencies.swift 를 이용한 Swift Pakcage 의존성
Tuist + Carthage
- Dependencies.swift 를 이용한 Carthage 의존성

나의 경우 2번째 방식인 Tuist + Swift Package을 통해 라이브러리 의존성을 주입시켜주고 있었다.

하지만 이 방법으로 Objective-C 코드가 포함되어있는 라이브러리 설치 및 의존성 주입을 해주게 되면, 몇가지 파일을 찾지 못하는 경우가 발생한다.

ㅎㅎㅎ....

왜 헤더 파일이 Xcode 내부 경로에 등록되지 않는지는 정확한 이유는 모르겠다. tuist 내부적인 문제 같다.

해당 관련 내용이 tuist 공식 문서에 이슈로 박제되어있다.

아직까지 해결되지 않은 이슈같고… 아래와 같이 별도로 설정해주어야 한다고 설명이 나와있다.

하지만 이슈와 해당 내용을 참고해서 설정을 어떻게든 해보려고 했지만…
애초에 나는 Objective-C에 대한 지식도 없으며, 내가 설정을 제대로 한게 맞는건지 조차 잘 파악이 안되서

위 내용으로는 결국 해결하지 못했다.

(혹시 이 글을 보시는 분들 중에 정확한 해결 솔루션을 알고있으시다면... 댓글로 공유해주시면 정말 감사하겠습니다 ㅠㅠ)

# 해결 방법

그래서 내가 해결한 방법은 바로 Dependencies.swift를 이용해서 라이브러리를 설치해주는 것이 아니라,

SPM을 직접 사용해서 라이브러리를 설치해주는 방법으로 해결했다.

먼저 Dependencies.swift 파일에서 SPM 쪽에 라이브러리를 추가해주던 코드를 제거해주었다.

// Dependencies.swift 파일 내부

import ProjectDescription
import ProjectDescriptionHelpers

let dependencies = Dependencies(
    carthage: [],
    swiftPackageManager: [
        .remote(
            url: "https://github.com/kakao/kakao-ios-sdk",
            requirement: .upToNextMajor(from: "2.13.0")
        ),
        .remote(
            url: "https://github.com/Moya/Moya.git",
            requirement: .upToNextMajor(from: "15.0.0")
        ),
        .remote(
            url: "https://github.com/onevcat/Kingfisher.git",
            requirement: .upToNextMajor(from: "7.0.0")
        )
/*
       // 아래 코드는 제거...
       .remote(
           url: "https://github.com/aws-amplify/amplify-swift.git",
           requirement: .upToNextMajor(from: "2.0.0")
       )
*/
    ],
    platforms: [.iOS]
)

그리고 Project.swift에 직접 패키지를 추가하고, 해당 라이브러리의 의존성이 필요한 타겟에 모두 아래와 같이 의존성을 추가해주었다.

// Project.swift 파일 내부
let project = Project.makeModule(
    name: "Fitfty",
    platform: .iOS,
    product: .app,
    packages: [ // packages를 추가하여 Amplify 라이브러리 추가
        .remote(
            url: "https://github.com/aws-amplify/amplify-swift.git",
            requirement: .upToNextMajor(from: "2.0.0")
        )
    ],
    dependencies: [
        .project(target: "Coordinator", path: .relativeToRoot("Projects/Coordinator")),
        .package(product: "Amplify"), // 라이브러리 관련 의존성 주입
        .package(product: "AWSAPIPlugin"),
        .package(product: "AWSDataStorePlugin"),
        .package(product: "AWSCognitoAuthPlugin"),
        .package(product: "AWSS3StoragePlugin")
    ],
    resources: ["Resources/**"],
    infoPlist: .file(path: "Support/Info.plist"),
    entitlements: "Fitfty.entitlements"
)

그리고 해당 라이브러리를 사용하는 모든 모듈에 아래와 같이 의존성을 추가해주었다.

// Auth/Project.swift 파일 내부
import ProjectDescription
import ProjectDescriptionHelpers

let project = Project.makeModule(
    name: "Auth",
    product: .staticFramework,
    dependencies: [
        .Project.Common,
        .Project.Core,
        .SPM.Moya,
        .SPM.Kingfisher,
        .package(product: "Amplify"), // 의존성 추가
        .package(product: "AWSCognitoAuthPlugin"),
        .package(product: "AWSS3StoragePlugin"),
        .package(product: "AWSAPIPlugin"),
        .package(product: "AWSDataStorePlugin")
    ]
)

// 나머지 Core, 메인 화면 등등.. 사용되는 모든 모듈에 의존성을 추가해주었다.

이렇게 설정한 후 tuist clean으로 tuist에서 생성된 모든 파일을 깔끔하게 정리해준 후

tuist fetch를 통해 다시 라이브러리 설치를 해준 다음

tuist generator를 통해 프로젝트를 실행하면 아래와 같은 화면을 확인할 수 있다.

기존에 Xcode에서 수동으로 SPM을 통해 라이브러리 설치를 하면 나타나는 화면과 동일하게 설정되어 있는 모습을 확인할 수 있다.

이 경우, tuist generator를 하면 package 를 resolve한 뒤 프로젝트가 실행된다.

❯ tuist generate
Resolved cache profile 'Development' from Tuist's defaults
Generating workspace Fitfty.xcworkspace
Generating project MainFeed
Generating project Setting
Generating project Common
Generating project Fitfty
Generating project Auth
Generating project Core
Generating project Alamofire
Generating project Coordinator
Generating project Profile
Generating project Onboarding
Generating project Kingfisher
Generating project Moya
Generating project KakaoOpenSDK
Resolving package dependencies using xcodebuild
Project generated.
Total time taken: 4.089s

다시 에러가 났던 경로를 찾아서 들어가면 정상적으로 헤더 파일이 추가되어 있는 것을 확인할 수 있다.

그리고 더이상 발생했던 에러 메세지는 나타나지 않았으며, 빌드도 성공적으로 되었다…

이 문제로 몇일을 삽질했는지 모르겠다…ㅠㅠ

왜 옵젝씨 코드가 포함된 라이브러리는 이런 에러가 나는지 모르겠으나, 하루 빨리 개선되었으면 좋겠다…
왜냐하면 이렇게 설정하면 tuist의 중요한 기능을 사용할 수가 없어 빌드 속도가 늘어나기 때문이다…

당시 해결했던 PR 보러 가기

[Feature] Amplify 라이브러리 설치 및 AmplifyManager 구현 by leeari95 · Pull Request #31 · YAPP-Github/21st-iOS-Team-

Issue 관련 이슈를 연결합니다. fix x 작업 내역 구현 내용 및 작업 했던 내역, 변경 사항을 포함합니다. 라이브러리 Amplify 설치 tuist+SPM으로 라이브러리 의존성 추가 시 에러가 발생합니다. [

github.com

Reference

Adding external dependencies | Tuist Documentation

Learn how to define the contract between the dependency managers and Tuist.

docs.tuist.io

Tuist 로 외부 의존성 관리하기

오늘은 많은 분들이 질문해주셨던 Tuist 3.x 버전에서 변경된 외부 의존성 관리에 대해 알아보려고 합니다.

okanghoon.medium.com

SPM external dependency SDWebImageSwiftUI fails to build · Issue #3762 · tuist/tuist

Describe the bug I created a dummy project depending on SDWebImageSwiftUI using SPM interface, and when I try build it, it fails. Error logs are like this: ❌ /Users/user/Library/Developer/Xcode/Der...

github.com

[Dependencies.swift]: cannot use external dependencies from ObjectiveC code · Issue #4180 · tuist/tuist

Describe the bug Our project uses the well known CocoaLumberjack framework for logging. We come from CocoaPods and are converting to Tuist and its Dependencies. Our main project still has quite som...

github.com

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ 댓글✍ 부탁드립니다.

[iOS] Github에서 API KEY를 숨기기 위한 여러가지 방법들

Ari Lee — Tue, 31 Jan 2023 13:59:54 +0900

다들 API KEY 관리를 어떻게 하시나요?
개발자마다 각각 방식이 다 다른 것 같아요.
이 글에서는 제가 협업하면서, 개인 프로젝트를 진행하면서
알게 된 관리 방법들을 적어보았습니다.
혹시 또 다른 방법이 있다면 공유해주세요.

왜 API KEY를 숨겨야 할까?

API Key를 숨기지 않고 깃허브에 그대로 올리면 다른 사람들도 API key를 볼 수 있어서 되돌릴 수 없는 일들이 벌어질 수도 있다.

AWS 해킹당한 경험담 실제로 Github에 API KEY를 숨기지 않고 올려서 150만 원 정도 청구된 사례가 있다.

따라서 아무나 API 요청을 하지 못하도록,

API KEY를 Github 레파지토리에 실수로라도 올리지 않도록

비밀스럽게 관리해주는 것이 중요하다.

static 변수 활용하기

아래와 같은 방법으로 static 변수를 두어 전역적으로 사용할 수 있게끔 구성하는 방법이다.

import Foundation

struct APIKey {
    static let weatherApiKey = "asdf"
    static let kakaoApiKey = "asdf"
}

// 혹은...

enum Secrets {
    static let apiKey = "asdf"
}

가장 쉽게 감출 수 있지만 개인적으로 선호하지 않는 방법 중 하나이다.

왜냐하면 remote에 코드를 올릴 때 key를 수동으로 지우고 올려야 하기 때문이다.

간혹 key를 지우지 않고 커밋을 하게 된다면 remote에 API KEY가 실수로 올라가는 상황이 발생하기도 한다.

.gitignore와 .plist 활용

.gitignore에 아래와 같이 숨길 .plist 파일을 추가한다.

# .gitignore 중...
Secrets.plist

그리고 .plist 내부에서 API KEY를 관리하는 방식이다.

코드상에서는 이런 식으로 Bundle을 확장하여 apiKey라는 변수를 구현해두고 사용한다.

extension Bundle {
    
    var apiKey: String? {
        guard let file = self.path(forResource: "Secrets", ofType: "plist"),
              let resource = NSDictionary(contentsOfFile: file),
              let key = resource["API_KEY"] as? String else {
            os_log(.error, log: .default, "⛔️ API KEY를 가져오는데 실패하였습니다.")
            return nil
        }
        return key
    }
    
}

// Bundle.main.apiKey 이런식으로 호출해서...

하지만 이 방법도 실수로 Xcode project.pbxproj 내부 경로에

Secrets.plist라는 경로를 별도로 제외시킬 수 없어서, 커밋때 항상 Secrets.plist 파일 경로를 따로 제외한 후

신경써서 커밋을 해야한다는 단점이 있었다.

물론 경로가 추가된다고 해서 remote에 실제 API KEY가 올라가는 것은 아니니 경로에 추가되든 말든 신경쓰지 않아도 무방하다.

(근데... 개인적으로 디렉토리에 빨간 글씨가..... 신경쓰여서.....)

그리고 간혹 info.plist에 API KEY를 설정해야하는 경우도 있는데

그럴 때는 이 방법이 통하지 않는다.

그럼 이런 경우에는 어떻게 하면 좋을까?

.xcconfig 활용하기

.xcconfig 파일을 생성한다.

생성한 .xcconfig 파일 안에 아래와 같이 환경변수를 정의해준다.

//
//  Secrets.xcconfig
//  My App
//
//  Created by Ari on 2023/01/31.
//

// Configuration settings file format documentation can be found at:
// https://help.apple.com/xcode/#/dev745c5c974

KAKAO_APP_KEY = 123
FACEBOOK_APP_ID = 1234
FACEBOOK_CLIENT_TOKEN = 12345

그리고 프로젝트에 configurations를 위에서 만들었던 .xcconfig 파일로 설정해준다.

info.plist에서는 아래와 같이 환경변수를 활용하여 api key를 설정한다.

마지막으로 .gitignore에 해당 .xcconfig 파일을 추가해주면 된다.

# .gitignore 내부...
*.xcconfig

나는 사용해본 방법 중 이 방법이 제일 좋았다.

이것도 물론 커밋할 때마다 Xcode project.pbxproj 파일 내 경로가 추가되지 않도록 신경써서 커밋 해줘야 한다는 건 마찬가지다.

하지만 간혹 Facebook 같이 info.plist에 API 관련된 값들을 설정해주어야 하는 경우가 있는데,

이런 경우에도 remote에 올라가지 않도록 완벽하게 관리가 가능하다.

또 새롭게 알게되는 방법들이 있다면, 기록해둬야지!

제 글에 틀린 내용이 있거나 혹은 도움이 되셨다면, 공감 ㆍ 구독✅ ㆍ 공유 ㆍ 댓글✍ 부탁드립니다.

[Xcode Cloud] Tuist로 만든 프로젝트에 Xcode Cloud 적용하는 법

Ari Lee — Wed, 7 Dec 2022 16:54:09 +0900

YAPP 동아리 Dev. Camp 1차때 팀원들과 함께 해결한 문제이다.

# 문제 상황

Tuist로 프로젝트 생성을 하였다.
생성을 하니, .xcworkspace 파일이 자동으로 생성된 .gitignore에 포함되어있었다. 아마 충돌을 대비해서 추가해둔 것 같다.
이후 Xcode Cloud 적용을 위해서 빌드를 시도했는데, .xcworkspace를 찾을 수 없다는 에러가 났다.

Swift Package Dependencies
Workspace Fitfty.xcworkspace does not exist at Fitfty/Fitfty.xcworkspace

이 문제를 해결하기 위해서 .gitignore에 등록되어있는 .xcworkspace를 제거하자니 매우 찝찝하였다.

협업 시 충돌 피하자고 등록해둔 것 같은데, Xcode Cloud의 에러를 해결하자고 제거하는 것은 용납할 수 없었다.

내 생각엔 분명 방법이 있을 것 같았다. 그래서 다른 방법이 있나 한번 고민해보고 찾아보았다.

# 나의 추측

아마 github 레파지토리를 클론 받아온 후 빌드를 시도하는 것이기 때문에 .gitignore에 등록되어있는 .xcworkspace 파일을 찾을 수 없는 상황인 것 같았다. 그래서 빌드를 시도하기 이전에 따로 스크립트를 추가하여 추가적인 명령어를 실행할 수는 없을까 고민해보았다.

만약 추가적인 명령어를 따로 실행할 수 있다면, tuist generate 명령어를 통해 .xcworkspace를 생성한 후 빌드를 돌리면 된다고 생각했다.

애플 공식문서를 뒤져보니 빌드 중간 중간에 스크립트를 추가할 수 있는 방법이 자세히 나와있었다.

https://developer.apple.com/documentation/xcode/writing-custom-build-scripts

Apple Developer Documentation

developer.apple.com

# 해결 방법

몇번의 에러를 겪어 삽질을 한 결과, 스크립트를 실행하기 위해 먼저 ci_scripts라는 디렉토리에 접근을 하게 된다.

tuist의 xcworkspace를 실행하려면 해당 디렉토리를 나와서 tuist generate 명령어를 실행해줘야한다.

cd .. 명령어로 해당 디렉토리를 나오게 해주었지만 디렉토리를 상대경로로 접근하는 방법은 없을까... 고민하다가, 특별한 방법은 찾지 못해서 대신 주석을 달아 어떤 명령어인지 명시해주기로 타협했다.

ci_post_clone.sh 파일 내용

#!/bin/sh

# swiftlint 다운로드
brew install swiftlint 

# ci_scripts 디렉토리를 나와 프로젝트 경로인 Fitfty로 진입
# Fitfty 디렉토리로 경로 이동 -> /Volumes/workspace/repository/Fitfty
cd ..

# fetch를 통해 라이브러리 다운로드
.tuist-bin/tuist fetch 

# generate를 통해 .xcworkspace 받아오기
.tuist-bin/tuist generate

이렇게 스크립트를 추가해주니 정상적으로 xcworkspace를 생성하고 찾을 수 있어 빌드를 성공할 수 있었다...!!

success... 감격의 순간....

그리고 .tuist-bin 파일을 통해 fetch와 generate를 시도해서 그런지 따로 brew로 tuist를 설치하는 명령어는 필요하지 않다.

이 문제에 대한 래퍼런스가 많지는 않아서 해결하는데 좀 고생했다... 우리처럼 고생하지 않았으면 해서 해결방안을 올려본다!

.tuist-bin/tuist ... 명령어를 사용하기 이전에 tuist bundle 이라는 명령어를 통해 .tuist-bin 디렉토리를 생성해준 다음 레파지토리로 변경사항을 push하고 나서 위 작업을 해줘야 한다.

# 별거아닌 팁

Xcode Cloud 빌드 실패시 로그를 확인해볼 수 있다.

빌드 숫자 부분을 클릭

화살표를 눌러 메뉴를 열고 로그로 진입.

빌드에 대한 자세한 로그를 확인해볼 수 있다.
(근데 가끔 불친절함...ㅋ)

# Tuist로 만든 프로젝트 테스트 빌드는 어떻게 해결할까?

Scheme를 일반 프로젝트가 아니라 Workspace가 붙어있는 Scheme로 설정해주어야 정상적으로 테스트를 동작한다.

구글링 키워드
xcode cloud ci scripts brew

# Reference

Apple Developer Documentation

developer.apple.com

Xcode Cloud - overview & setup

Xcode Cloud is now available to all Apple developers and recently I had a chance to try it out. In this post I gathered some howtos for a typical setup.

wojciechkulik.pl

Xcode Cloud – 3. ci 스크립트 작성

들어가며… 1편에서는 Xcode Cloud 구성 방법, 2편에서는 조금 더 디테일한 구성 방법을 알아봤습니다. 이번 3편에서는 스크립트 작성 (ci_script) 에 대해 알아보겠습니다. 제가 담당하고 있는 프로젝

y8k.me

[Xcode] Tuist를 활용하여 프로젝트를 관리해보기

Ari Lee — Fri, 2 Dec 2022 16:40:45 +0900

이번에 동아리 활동을 시작하게 되면서
프로젝트를 모듈화하여 관리해보자는 의견이 나와 Tuist를 사용해보게 되었다.
어떤 녀석인지 한번 알아보자!!!

Tuist는 Xcode 프로젝트와의 생성, 유지 관리 및 상호 작용을 용이하게 하는 것을 목표로 하는 커맨드 라인 인터페이스(CLI, 명령줄 도구, 터미널을 통해 사용자와 컴퓨터가 상호 작용하는 방식)이다.

바이너리로 배포되므로 종속성을 관리하기 위해 다른 도구에 의존하지 않고도 쉽게 설치하고 사용할 수 있다.

모듈화의 이점

모듈화로 나누어져 있으면 빌드 시 변경된 부분만 빌드하면 되기 때문에 빌드 속도가 향상된다는 장점이 있다.
모듈간 결합도는 낮추고 응집도를 높이는 형태
.pbxproj에 UUID의 conflict을 줄일 수 있다는 장점도 가지고 있다.

Tuist를 사용하기 전에 알아야 할 개념

Target
- project나 Workspace의 파일들을 빌드하여 생성되는 End Product를 의미

Project
- 모든 파일, 리소스를 빌드하는데 필요한 정보의 저장소(repository)
- 프로젝트는 빌드하는 방법을 명시하는 end product인 target을 하나 이상 포함한다.

Project가 가지고 있는 정보
- 소스파일에 대한 참조
- Structure navigator에서 소스파일을 그룹화
- Debug, release와 같은 build configuration을 설정 가능
.xcodeproj라는 디렉토리에 터미널을 통해서 들어가면 아래와 같은 정보가 존재한다.
- Project.pbxproj
  - 각 파일들의 참조값들을 UUID들로 정의되어 있는 파일

cd {projectName}.xcodeproj 
open .
ls -a

.			project.pbxproj		xcuserdata
..			project.xcworkspace

Workspace
- Xcode의 Project 및 기타 리소스를 그룹화하여 함께 작업할 수 있는 Xcode document
- 다수의 Project를 사용하고 싶은 경우, workspace 하위로 관리
- 각 Project의 파일을 구성하는 것 외에도 workspace에 포함된 Project들과 Target간의 관계를 제공

예시로 pod install시에 workspace가 생기는데 내부를 들어가보면 Pods Project가 생긴 것을 확인할 수 있다.

Project가 2개 이상되었기 때문에 이들의 관계를 하나로 묶어서 관리할 Workspace가 필요하여 pod install하면 자동으로 workspace가 생성된다.

왜 Tuist를 사용하는 걸까?

Git을 사용하면서 Xcode 프로젝트 설정(.xcodeproj) 파일의 충돌은 협업을 불편하게 한다. 이를 개선해줄 수 있는 도구이다.
XcodeGen과 다르게 Swift로 프로젝트 설정이 가능하다는 장점이 있다.
- XcodeGen은 yaml 혹은 json으로 프로젝트 설정 파일을 만들어야 된다.

모듈화를 적용했을시 기대되는 효과

코드 안정성
- 모듈간 결합도가 낮아지고 응집도가 높아지는 만큼 안정성이 높아지길 기대
- 문제 발생시 분석이 수월해질 것으로 예상
개발 생산성
- 모듈별 의존성이 낮아지면 고려해야하는 범위가 낮아져 개발 속도가 향상된다.
- 코드 리뷰시 관련 모듈만 검토가 가능해 리뷰어에게 편의가 높아질 것
빌드 속도
- 자주 변경되지 않는 모듈의 빌드가 발생하지 않아 빌드 속도에도 작은 영향을 줄 것.
사용 목적에 맞는 코드 배치
- 용도와 목적에 맞는 코드 배치로 이해하기 쉬운 프로젝트 구성

Tuist를 사용하여 모듈화하기

Tuist 설치

curl -Ls https://install.tuist.io | bash

Tuist로 iOS 프로젝트 생성하기

터미널로 프로젝트를 생성할 폴더로 진입하여 아래 명령어를 입력한다.

tuist init --platform ios // UIKit
tuist init --platform ios --template swiftui // SwiftUI

위 사진처럼 4개의 파일이 생성된다.

Project.swift를 수정하는 명령어 Tuist Edit을 실행한다.

명령어를 실행하면 Manifests 프로젝트가 오픈된다.

tuist edit

Project.swift 파일을 입맛대로 편집한다.
이 파일은 Tuist에서 .xcodeproj, 프로젝트를 어떻게 만들지 정의하는 파일이다.

Project.swift

Project는 아래와 같은 이니셜라이저를 가지고 있다.

public init(
    name: String,
    organizationName: String? = nil,
    options: ProjectDescription.Project.Options = .options(),
    packages: [ProjectDescription.Package] = [],
    settings: ProjectDescription.Settings? = nil,
    targets: [ProjectDescription.Target] = [],
    schemes: [ProjectDescription.Scheme] = [],
    fileHeaderTemplate: ProjectDescription.FileHeaderTemplate? = nil,
    additionalFiles: [ProjectDescription.FileElement] = [],
    resourceSynthesizers: [ProjectDescription.ResourceSynthesizer] = .default
)

name
- 프로젝트 이름
organizationName
- organization의 이름
options
- Tuist가 xcodeproj 파일을 만들 때의 옵션을 설정해줄 수 있다.
packages
- SPM의 package를 의미한다.
settings
- 프로젝트 파일에 있는 build settings의 정보들을 설정해준다.
- Dictionary로 값을 줄 수 있다.
  - https://xcodebuildsettings.com/
targets
- 프로젝트의 타겟을 의미한다.
schemes
- 프로젝트의 scheme를 의미한다.
fileHeaderTemplate
- 내장 Xcode 템플릿에 Custom으로 파일 헤더를 만들 수 있다.

예를 들어서 fileHeaderTemplate: " ___COPYRIGHT___"
이렇게 만들고 프로젝트를 생성한 다음 swift파일을 만들면

//  Copyright © 2022 tuist.io. All rights reserved.

import Foundation

만약 ""으로 해놓으면

//

import Foundation

으로 생성된다. nil이면 기본 값으로

//
//  File.swift
//  Fitfty
//
//  Created by Ari on 2022/12/02.
//  Copyright © 2022 baegteun. All rights reserved.
//

이렇게 생성이 된다.

additionalFiles
- Tuist에서 프로젝트를 만들 때 Xcode에 자동으로 연결해주지 않는 파일을 넣으면 프로젝트에 연결시켜준다.
- 예를 들어 README.md 같은 파일은 프로젝트를 만들 때 Xcode에는 자동으로 보여지지 않는데, 여기에 추가해준다면 Xcode에서도 볼 수 있다.
- 아니면 통신할 서버가 GraphQL이여서 Apollo-iOS를 쓴다면 .graphql 파일을 추가할 수도 있다.
resourceSynthesizers
- Tuist는 프로젝트를 생성할 때 Resources/ 안에 파일 확장자에 따라 enum을 제공해준다.
- 예시로 Assets에 색이랑 이미지를 넣었다면 아래처럼 enum을 자동으로 생성해준다.

public enum CoreAsset {
  public enum Colors {
    public static let girgGray = CoreColors(name: "GIRG_Gray")
    public static let grigBackground = CoreColors(name: "GRIG_Background")
    public static let grigBlack = CoreColors(name: "GRIG_Black")
    public static let grigCompetePrimary = CoreColors(name: "GRIG_CompetePrimary")
    public static let grigCompeteSecondary = CoreColors(name: "GRIG_CompeteSecondary")
    public static let grigOnboardMain = CoreColors(name: "GRIG_OnboardMain")
    public static let grigPrimary = CoreColors(name: "GRIG_Primary")
    public static let grigPrimaryTextColor = CoreColors(name: "GRIG_PrimaryTextColor")
    public static let grigSecondaryTextColor = CoreColors(name: "GRIG_SecondaryTextColor")
    public static let grigWhite = CoreColors(name: "GRIG_White")
  }
  public enum Images {
    public static let grigCompeteIcon = CoreImages(name: "GRIG_CompeteIcon")
    public static let grigGithubIcon = CoreImages(name: "GRIG_GithubIcon")
    public static let grigLogo = CoreImages(name: "GRIG_Logo")
    public static let grigOnboard1 = CoreImages(name: "GRIG_Onboard1")
    public static let grigOnboard2 = CoreImages(name: "GRIG_Onboard2")
    public static let grigOnboard3 = CoreImages(name: "GRIG_Onboard3")
    public static let grigOnboard4 = CoreImages(name: "GRIG_Onboard4")
    public static let grigSword = CoreImages(name: "GRIG_Sword")
  }
}

따라서 resourceSynthesizers란 위에서 제공해주지 않는 확장자들이 Resources/ 에 들어가있을때 어떻게 자동 생성해줄지에 대해 .stencil파일로 정의해주면 프로젝트를 생성할 때 .stencil내용에 따라 생성해준다.

예시로 프로젝트에 Lottie를 사용한다면 Resources/ 에 .json파일이 들어갔을 때 어떻게 자동 생성 시킬지에 대해 만들 수 있다.

.default는 strings, plists, fonts, assets을 자동으로 생성해준다.

Workspace.swift

WorkSpace.swift는 Tuist에서 .xcworkspace 워크스페이스를 어떻게 만들지 정의하는 파일이다.

Workspace는 아래와 같은 이니셜라이저를 가진다.

public init(
    name: String,
    projects: [ProjectDescription.Path],
    schemes: [ProjectDescription.Scheme] = [],
    fileHeaderTemplate: ProjectDescription.FileHeaderTemplate? = nil,
    additionalFiles: [ProjectDescription.FileElement] = [],
    generationOptions: ProjectDescription.Workspace.GenerationOptions = .options()
)

name
- 워크스페이스의 이름
projects
- Workspace에 등록할 프로젝트들의 경로를 넣어주면 된다.
- struct인 Path를 받지만 그냥 문자열을 넣어도 무방하다.
- 기본 경로는 프로젝트의 루트 디렉토리를 기준으로 한다.
schemes, fileHeaderTemplate, additionalFiles
- Project.swift와 동일
generationOptions
- Tuist가 xcworkspace 파일을 만들 때의 옵션을 설정해줄 수 있다.

Config.swift

프로젝트 전역으로 쓰이는 설정을 해줄 수 있다.

예를 들어 Swift의 버전이나 Xcode의 버전 같은게 있다.

Config.swift는 {프로젝트 루트 디렉토리}/Tuist/Config.swift 에 있을 때만 적용된다.

Target

Project.swift에서 언급했던 Target.
Target은 사용할 모듈을 정의하는 struct이다.

Target은 아래와 같은 이니셜라이저를 가진다.

public init(
    name: String,
    platform: ProjectDescription.Platform,
    product: ProjectDescription.Product,
    productName: String? = nil,
    bundleId: String,
    deploymentTarget: ProjectDescription.DeploymentTarget? = nil,
    infoPlist: ProjectDescription.InfoPlist? = .default,
    sources: ProjectDescription.SourceFilesList? = nil,
    resources: ProjectDescription.ResourceFileElements? = nil,
    copyFiles: [ProjectDescription.CopyFilesAction]? = nil,
    headers: ProjectDescription.Headers? = nil,
    entitlements: ProjectDescription.Path? = nil,
    scripts: [ProjectDescription.TargetScript] = [],
    dependencies: [ProjectDescription.TargetDependency] = [],
    settings: ProjectDescription.Settings? = nil,
    coreDataModels: [ProjectDescription.CoreDataModel] = [],
    environment: [String : String] = [:],
    launchArguments: [ProjectDescription.LaunchArgument] = [],
    additionalFiles: [ProjectDescription.FileElement] = []
)

name
- 타겟의 이름
platform
- iOS, macOS, tvOS, watchOS 같은 플랫폼을 의미한다.
product
- app, appClips, staticFramework, framework, unitTest 등을 의미한다.
productName
- 만들어진 product의 이름
- The build product name
bundled
- 프로젝트 파일을 열었을 때 보이는 Bundle Identifier
deploymentTarget
- 배포 타겟을 설정할 수 있다.
infoPlist
- info.plist를 정의한다.
sources
- 소스코드의 경로를 입력해주면 된다.
- 안에 문자열로 경로를 입력해도 된다.
resources
- 앞서서 resourceSynthesizers에서 Tuist가 Resources/ 의 리소스들을 자동으로 코드화한다고 했는데, 그때 이 리소스들이 어디에 있는지에 대한 경로를 의미한다.
- 안에 문자열로 경로를 입력해도 된다.
copyFiles
- 타겟에 대한 Build Phase 파일 복사 작업
headers
- 타겟에 대한 headers
entitlements
- 타겟에 대한 entitlements의 경로를 입력해주면 된다.
scripts
- 타겟에 대한 build Phase 스크립트 작업
dependencies
- 타겟의 의존성에 대한 것을 의미한다.
- 라이브러리나 다른 모듈을 의존성으로 넣을 때 사용한다.
settings
- 타겟의 세팅을 정의한다.
coreDataModels
- CoreData의 모델들의 경로랑 버전을 정의한다.
environment
- scheme에서 Edit Scheme… 버튼을 누르면 나오는 창에서 Environment Variables를 설정할 수 있는데 이때 environment를 설정하면 자동으로 생성한다.

launchArguments
- scheme에서 Edit Scheme… 버튼을 누르면 나오는 창에서 Arguments Passed On Launch를 설정할 수 있는데 이때 launchArguments 설정하면 자동으로 생성한다.

additionalFiles
- 프로젝트를 생성할 때 자동으로 생겨나지 않는 파일을 등록해놓으면 Xcode에서 볼 수 있다.

편집을 모두 마치고 아래 명령어를 입력해주면 프로젝트가 생성된다.

tuist generate

.xcodeproj, .xcworkspace 파일이 생성된다.

Tuist로 생성한 프로젝트 구경가기

GitHub - YAPP-Github/21st-iOS-Team-2-iOS

Contribute to YAPP-Github/21st-iOS-Team-2-iOS development by creating an account on GitHub.

github.com

Reference

Get started | Tuist Documentation

Learn how to install Tuist in your environment and generate your first project.

docs.tuist.io

[Swift] Tuist 모듈화 툴

Tuist..! 모듈화를 위한 툴이에요 드디어 해보게 되었는데요... Tuist에대한 정보가 많이 부족하더라구요 정보에 보탬이되고자 정리를 해서 공유해보려고해요! Tuist에러 때문에 쉐도우복싱도 많이

nsios.tistory.com

[iOS - swift] 4. 모듈화 개념 - Tuist로 프로젝트 관리 방법

1. 모듈화 개념 - Library vs Framework (static library, dynamic library, static framework, dynamic framework) 2. 모듈화 개념 - Binary File 개념 (Mach-O, CPU Architectures, Universal binary, lipo command) 3. 모듈화 개념 - XCFramework 생성

ios-development.tistory.com

Tuist 사용법 - 1. 이론 및 샘플 예제

Tuist? Xcode 프로젝트 관리 툴? Why Tuist? 설치 Manifests Project.swift Workspace.swift Config.swift Target 샘플 프로젝트 모듈 생성 Method 모듈 구조 만들기 결론 Tuist? Xcode 프로젝트를 관리하는 툴입니다. Project.swif

baegteun.tistory.com