Slide 1

Slide 1 text

XcodeGen Ste Prescott

Slide 2

Slide 2 text

// !$*UTF8*$! { archiveVersion = 1; classes = { }; objectVersion = 50; objects = { /* Begin PBXBuildFile section */ 8B53914821B4057D00E124A0 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B53914721B4057D00E124A0 /* AppDelegate.swift */; }; 8B53914A21B4057D00E124A0 /* ViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B53914921B4057D00E124A0 /* ViewController.swift */; }; 8B53914D21B4057D00E124A0 /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 8B53914B21B4057D00E124A0 /* Main.storyboard */; }; 8B53914F21B4057F00E124A0 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 8B53914E21B4057F00E124A0 /* Assets.xcassets */; }; 8B53915221B4057F00E124A0 /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 8B53915021B4057F00E124A0 /* LaunchScreen.storyboard */; }; 8B53915D21B4057F00E124A0 /* XcodeGenTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B53915C21B4057F00E124A0 /* XcodeGenTests.swift */; }; 8B53916821B4057F00E124A0 /* XcodeGenUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8B53916721B4057F00E124A0 /* XcodeGenUITests.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ 8B53915921B4057F00E124A0 /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 8B53913C21B4057D00E124A0 /* Project object */; proxyType = 1; remoteGlobalIDString = 8B53914321B4057D00E124A0; remoteInfo = XcodeGen; }; 8B53916421B4057F00E124A0 /* PBXContainerItemProxy */ = { isa = PBXContainerItemProxy; containerPortal = 8B53913C21B4057D00E124A0 /* Project object */; proxyType = 1; remoteGlobalIDString = 8B53914321B4057D00E124A0; remoteInfo = XcodeGen; }; /* End PBXContainerItemProxy section */ /* Begin PBXFileReference section */ 8B53914421B4057D00E124A0 /* XcodeGen.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = XcodeGen.app; sourceTree = BUILT_PRODUCTS_DIR; }; 8B53914721B4057D00E124A0 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; 8B53914921B4057D00E124A0 /* ViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewController.swift; sourceTree = ""; }; 8B53914C21B4057D00E124A0 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = ""; }; 8B53914E21B4057F00E124A0 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = ""; }; 8B53915121B4057F00E124A0 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = ""; }; 8B53915321B4057F00E124A0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 8B53915821B4057F00E124A0 /* XcodeGenTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = XcodeGenTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; 8B53915C21B4057F00E124A0 /* XcodeGenTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = XcodeGenTests.swift; sourceTree = ""; }; 8B53915E21B4057F00E124A0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 8B53916321B4057F00E124A0 /* XcodeGenUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = XcodeGenUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; 8B53916721B4057F00E124A0 /* XcodeGenUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = XcodeGenUITests.swift; sourceTree = ""; }; 8B53916921B4057F00E124A0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ 8B53915521B4057F00E124A0 /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXFrameworksBuildPhase section */ ... 586 lines

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

“LGTM I think...” Code reviewer

Slide 9

Slide 9 text

.xcodeproj files » Ugly to read » Big reason of merge conflicts » If corrupt good luck » Difficult to code review & diff » A lot of noise

Slide 10

Slide 10 text

General project checklist » Code / Resources » Tests » Additional targets (App Extensions, Static Libraries, ...) » Dependencies » Environments

Slide 11

Slide 11 text

Adding code & resources to .xcodeproj

Slide 12

Slide 12 text

File > New > File

Slide 13

Slide 13 text

Adding Tests to .xcodeproj

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

Adding new targets to .xcodeproj

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

Adding dependencies to .xcodeproj

Slide 18

Slide 18 text

No content

Slide 19

Slide 19 text

Adding environments to .xcodeproj

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

Quick check What do we have? » A project » Unit & UI test testing » A linked dependency » Configuration based on environments

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

Removing .xcodeproj with XcodeGen

Slide 24

Slide 24 text

project.yml name: XcodeGen options: bundleIdPrefix: me.steprescott targets: XcodeGen: platform: iOS type: application sources: - XcodeGen ...

Slide 25

Slide 25 text

Add unit test target ... XcodeGenTests: platform: iOS type: bundle.unit-test sources: - XcodeGenTests dependencies: - target: XcodeGen ...

Slide 26

Slide 26 text

Add UI test target ... XcodeGenUITests: platform: iOS type: bundle.ui-testing sources: - XcodeGenUITests dependencies: - target: XcodeGen

Slide 27

Slide 27 text

name: XcodeGen options: bundleIdPrefix: me.steprescott targets: XcodeGen: platform: iOS type: application sources: - XcodeGen XcodeGenTests: platform: iOS type: bundle.unit-test sources: - XcodeGenTests dependencies: - target: XcodeGen XcodeGenUITests: platform: iOS type: bundle.ui-testing sources: - XcodeGenUITests dependencies: - target: XcodeGen

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

Quick tip! You can split the project configuration over multiple smaller .yml files. . !"" Project # !"" Targets # # !"" XcodeGen.yml # # !"" XcodeGenTests.yml # # $"" XcodeGenUITests.yml # $"" targets.yml $"" project.yml

Slide 30

Slide 30 text

project.yml include: - Project/targets.yml name: XcodeGen options: bundleIdPrefix: me.steprescott

Slide 31

Slide 31 text

targets.yml include: - Targets/XcodeGen.yml - Targets/XcodeGenTests.yml - Targets/XcodeGenUITests.yml

Slide 32

Slide 32 text

Targets/XcodeGen.yml targets: XcodeGen: platform: iOS type: application sources: - XcodeGen

Slide 33

Slide 33 text

Targets/XcodeGenTests.yml targets: XcodeGenTests: platform: iOS type: bundle.unit-test sources: - XcodeGenTests dependencies: - target: XcodeGen

Slide 34

Slide 34 text

Targets/XcodeGenUITests.yml targets: XcodeGenUITests: platform: iOS type: bundle.ui-testing sources: - XcodeGenUITests dependencies: - target: XcodeGen

Slide 35

Slide 35 text

Adding new targets with XcodeGen

Slide 36

Slide 36 text

Add a new .yml file . !"" Project # !"" Targets + # # !"" NotificationServiceExtension.yml # # !"" XcodeGen.yml # # !"" XcodeGenTests.yml # # $"" XcodeGenUITests.yml # $"" targets.yml $"" project.yml

Slide 37

Slide 37 text

Targets/NotificationServiceExtension.yml targets: NotificationServiceExtension: platform: iOS type: app-extension sources: - NotificationServiceExtension dependencies: - target: XcodeGen

Slide 38

Slide 38 text

No content

Slide 39

Slide 39 text

Adding dependencies with XcodeGen

Slide 40

Slide 40 text

Targets/XcodeGen.yml targets: XcodeGen: platform: iOS type: application sources: - XcodeGen + dependencies: + - carthage: Alamofire

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Adding environments with XcodeGen

Slide 43

Slide 43 text

. !"" Project # !"" Configs + # # !"" Development.xcconfig + # # $"" Production.xcconfig # !"" Schemes + # # !"" Development.yml + # # $"" Production.yml # !"" Targets # # !"" NotificationServiceExtension.yml # # !"" XcodeGen.yml # # !"" XcodeGenTests.yml # # $"" XcodeGenUITests.yml + # !"" configs.yml + # !"" schemes.yml # $"" targets.yml $"" project.yml

Slide 44

Slide 44 text

Configs/*.xcconfig files Development.xconfig PRODUCT_NAME = Dev PRODUCT_BUNDLE_IDENTIFIER = me.steprescott.xcodegen-dev Production.xconfig PRODUCT_NAME = Production PRODUCT_BUNDLE_IDENTIFIER = me.steprescott.xcodegen

Slide 45

Slide 45 text

Adding schemes with XcodeGen

Slide 46

Slide 46 text

schemes: Development: build: parallelizeBuild: true targets: XcodeGen: all XcodeGenTests: testing XcodeGenUITests: testing run: config: Development test: config: Development targets: - XcodeGenTests - XcodeGenUITests profile: config: Development analyze: config: Development archive: config: Development

Slide 47

Slide 47 text

schemes: Production: build: parallelizeBuild: true targets: XcodeGen: all XcodeGenTests: testing XcodeGenUITests: testing run: config: Production test: config: Production targets: - XcodeGenTests - XcodeGenUITests profile: config: Production analyze: config: Production archive: config: Production

Slide 48

Slide 48 text

No content

Slide 49

Slide 49 text

Quick check Do we have the same as before? » A project » Unit & UI test testing » A linked dependency » Configuration based on environments

Slide 50

Slide 50 text

Comparisons Before After Line count 1,915 575 Merge risk High None Code review Noisy Focused » 30% the size of the original project » Settings / configurations more visible

Slide 51

Slide 51 text

Code review comparison

Slide 52

Slide 52 text

No content

Slide 53

Slide 53 text

No content

Slide 54

Slide 54 text

Generating the .xcodeproj Install XcodeGen with Homebrew Run xcodegen via CLI or add Git hooks Post-checkout & Post-merge #!/bin/bash export PATH=/usr/local/bin:$PATH set -e echo " ! Running hook" xcodegen

Slide 55

Slide 55 text

Step by step code examples github.com/steprescott/XcodeGen

Slide 56

Slide 56 text

Questions