XcodeGen

XcodeGen is a tool that generates your Xcode project file and helps manage your projects settings & configuration. This deck shows how you could use it in your own projects.

Transcript

1. XcodeGen Ste Prescott
2. // !$*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 = "<group>"; }; 8B53914921B4057D00E124A0 /* ViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ViewController.swift; sourceTree = "<group>"; }; 8B53914C21B4057D00E124A0 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = "<group>"; }; 8B53914E21B4057F00E124A0 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; }; 8B53915121B4057F00E124A0 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; }; 8B53915321B4057F00E124A0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; }; 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 = "<group>"; }; 8B53915E21B4057F00E124A0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; }; 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 = "<group>"; }; 8B53916921B4057F00E124A0 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ 8B53915521B4057F00E124A0 /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXFrameworksBuildPhase section */ ... 586 lines
8. “LGTM I think...” Code reviewer
9. .xcodeproj files » Ugly to read » Big reason of merge conflicts » If corrupt good luck » Difficult to code review & diff » A lot of noise
10. General project checklist » Code / Resources » Tests » Additional targets (App Extensions, Static Libraries, ...) » Dependencies » Environments
11. Adding code & resources to .xcodeproj
12. File > New > File
13. Adding Tests to .xcodeproj
15. Adding new targets to .xcodeproj
17. Adding dependencies to .xcodeproj
19. Adding environments to .xcodeproj
21. Quick check What do we have? » A project » Unit & UI test testing » A linked dependency » Configuration based on environments
23. Removing .xcodeproj with XcodeGen
24. project.yml name: XcodeGen options: bundleIdPrefix: me.steprescott targets: XcodeGen: platform: iOS type: application sources: - XcodeGen ...
25. Add unit test target ... XcodeGenTests: platform: iOS type: bundle.unit-test sources: - XcodeGenTests dependencies: - target: XcodeGen ...
26. Add UI test target ... XcodeGenUITests: platform: iOS type: bundle.ui-testing sources: - XcodeGenUITests dependencies: - target: XcodeGen
27. 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
29. 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
30. project.yml include: - Project/targets.yml name: XcodeGen options: bundleIdPrefix: me.steprescott
31. targets.yml include: - Targets/XcodeGen.yml - Targets/XcodeGenTests.yml - Targets/XcodeGenUITests.yml
32. Targets/XcodeGen.yml targets: XcodeGen: platform: iOS type: application sources: - XcodeGen
33. Targets/XcodeGenTests.yml targets: XcodeGenTests: platform: iOS type: bundle.unit-test sources: - XcodeGenTests dependencies: - target: XcodeGen
34. Targets/XcodeGenUITests.yml targets: XcodeGenUITests: platform: iOS type: bundle.ui-testing sources: - XcodeGenUITests dependencies: - target: XcodeGen
35. Adding new targets with XcodeGen
36. Add a new .yml file . !"" Project # !"" Targets + # # !"" NotificationServiceExtension.yml # # !"" XcodeGen.yml # # !"" XcodeGenTests.yml # # $"" XcodeGenUITests.yml # $"" targets.yml $"" project.yml
37. Targets/NotificationServiceExtension.yml targets: NotificationServiceExtension: platform: iOS type: app-extension sources: - NotificationServiceExtension dependencies: - target: XcodeGen
39. Adding dependencies with XcodeGen
40. Targets/XcodeGen.yml targets: XcodeGen: platform: iOS type: application sources: - XcodeGen + dependencies: + - carthage: Alamofire
42. Adding environments with XcodeGen
43. . !"" 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
44. 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
45. Adding schemes with XcodeGen
46. 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
47. 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
49. Quick check Do we have the same as before? » A project » Unit & UI test testing » A linked dependency » Configuration based on environments
50. 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
51. Code review comparison
54. 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
55. Step by step code examples github.com/steprescott/XcodeGen
56. Questions