Template 개요

Template 사용법

• 해당 레포지토리에서 Use this template 를 사용하여 Github에 Repo를 만들어 시작
• 해당 레포지토리를 Fork 혹은 Download하여 시작

레이어

Features - Services - Core - UserInterface - Shared 5개의 레이어를 가집니다.

• Feature
  • 사용자의 액션을 처리하거나 데이터를 보여주는, 사용자와 직접 맞닿는 레이어
  • ex) AuthFeature, ProfileFeature
• Domain
  • 도메인 로직이 진행되는 레이어
  • ex) AuthDomain, ProfileDomain
• Core
  • 앱의 비즈니스를 포함하지 않고 순수 기능성 모듈이 위치한 레이어
  • ex) NetworkingModule, DatabaseModule
• UserInterface
  • 공용 View, 디자인 시스템, 리소스 등 UI 요소 모듈이 위치한 레이어
  • ex) DesignSystem, LocalizableManager
• Shared
  • 로깅, extension 등 모든 레이어에서 공용으로 재사용될 모듈이 위치한 레이어
  • ex) UtilityModule, LoggingModule

을 생각하여 레이어를 분리하였습니다.

Micro Feature

각 모듈은 Micro Feature 구조를 기반으로 설계됩니다. 확장 가능하고 커지는 프로젝트를 기능별로 수평 확장이 가능하도록 Micro Service에서 영감을 얻은 아키텍쳐입니다.

https://docs.tuist.io/building-at-scale/microfeatures/#product

프로젝트 세팅

프로젝트 루트에서 make init 를 실행하여, 프로젝트 이름과 organization 이름을 입력하여 기본 설정을 할 수 있습니다.

프로젝트 루트에서 make signing를 실행하면 프로젝트 Team Signing을 할 수 있습니다.

모듈 생성

프로젝트 루트에서 make module를 실행하면 모듈 레이어, 이름, Micro Feature 종류를 선택하여 새 모듈을 생성합니다.

Makefile

프로젝트 루트에서 실행할 수 있는 명령어입니다.

• make init : 프로젝트 이름과 organization을 입력하여 프로젝트 기본 세팅

  • swift Scripts/InitEnvironment.swift
  • 터미널로 명령 받은 값을 통해 EnvironmentPlugin의 ProjectEnvironment.swift 파일을 초기화 한다.
  • ⚠️ 원본 상태에서 해야 에러가 안남, 주석을 달거나 줄을 바꾸면 밀리 수 있음

• make signing : 프로젝트 Team Signing

  • swift Scripts/CodeSigning.swift

• make generate : 외부 디펜던시 fetch 및 프로젝트 generate

  • tuist fetch
  • tuist generate

• make module : 모듈 생성

  • swift Scripts/GenerateModule.swift

• make dependency : 디펜던시 추가

  • swift Scripts/NewDependency.swift

• make ci_generate : 디펜던시 fetch 및 CI용 프로젝트 generate (SwiftLint X)

  • tuist fetch
  • TUIST_ENV=CI tuist generate

• make cd_generate : 디펜던시 fetch 및 CI용 프로젝트 generate (SwiftLint X)

  • tuist fetch
  • TUIST_ENV=CD tuist generate

• make clean : 전체 xcodeproj, xcworkspace 파일 삭제

  • rm -rf **/*.xcodeproj
  • rm -rf *.xcworkspace

• make reset : tuist clean 후, 전체 xcodeproj, xcworkspace 파일 삭제

  • tuist clean
  • rm -rf **/*.xcodeproj
  • rm -rf *.xcworkspace

Scaffold

tuist Scaffold(Demo/Interface/Sources/Testing/Tests/UITests) 
  --layer (Features/Services/Core/Shared/UserInterface 레이어 이름)
  --name (모듈 이름)

으로 Project 모듈의 Target 모듈을 직접 생성 가능합니다.

Plugin 생성

1. touch Plugins/MyPlugin/Plugin.swift
2. Plugins/Plugins/Plugins/MyPlugin 아래에 ProjectDescriptionHelpers 폴더
3. 플러그인 내용 파일 생성