Apple has a lot frameworks and APIs that I do not even know a lot of them. We’re additionally dwelling within the age of utility extensions. If you’re making an attempt to create a model new goal in Xcode, you would possibly find yourself scratching your head. 🤔

That is nice for each for builders and end-users, however after creating a couple of targets and platforms (your challenge grows and) you would possibly ask the query:

How ought to I organise my codebase?

Don’t be concerned an excessive amount of about it, I may need the fitting reply for you! 😉

The issue with complicated initiatives

You’ll be able to create apps in Xcode for all the key working techniques: iOS, macOS, tvOS, watchOS. Within the newest model of Xcode you may also add greater than 20 extension only for iOS, plus there are many app extensions accessible for macOS as nicely. Think about a posh utility with a number of extensions & targets. This example can result in inconsistent bundle identifiers and extra ad-hoc naming options. Oh, by the best way watchOS purposes are only a particular extensions for iOS targets and do not forget about your assessments, these are particular person targets as nicely! ⚠️

So far as I can see, in case you are making an attempt to assist a number of platforms you’ll have loads of targets inside your Xcode challenge, moreover each new goal will include some type of supply information and belongings. Ought to I point out schemes too? 😂

Even Apple eliminated it is Lister pattern code, that demonstrated certainly one of a hellish Xcode challenge with 14 targets, 11 schemes, however the total challenge contained solely 71 Swift supply information. That is not an excessive amount of code, however you possibly can see the problem right here, proper?

It is time to discover ways to organise your challenge! 💡

Xcode challenge group

So my primary concept is to have an affordable naming conceptand folder construction contained in the challenge. This entails targets, schemes, bundle identifiers, location of supply information and belongings on the disk. Let’s begin with a easy instance that comprises a number of targets to have a greater understanding. 🤓

If you’re utilizing the Swift Package deal Supervisor eg. for Swift backends, SPM will generate your Xcode challenge information for you, so that you shoudn’t care an excessive amount of about conventions and namings in any respect. 🤷‍♂️

Venture identify

Are you creating a brand new utility? Be at liberty to call your challenge as you need. 😉

Are you going to make a framework? Prolong your challenge identify with the Equipment suffix. Folks often desire to make use of the ProjectKit fashion for libraries in order that’s the right option to go. When you’ve got a killer identify, use that as an alternative of the equipment fashion! 😛

Obtainable platforms

All the time use the next platform names:

Goal naming conference

Identify your targets like:

[platform] [template name]

Do not embrace challenge identify within the targets (that might be only a duplicate) Use the extension names from the brand new goal window (eg. At this time Extension) Use “Software” template identify for the primary utility targets Use “Framework” as template identify for framework targets Order your targets in a logical manner (see the instance)

Scheme names

Merely use goal names for schemes too (prefix with challenge identify if required).

[project] - [platform] [template name]

You’ll be able to prefix schemes together with your challenge identify if you would like, however the generic rule is right here to make use of the very same identify as your goal. I additionally wish to separate framework schemes visually from the schems that include utility logic, that is why I at all times transfer them to the highest of the record. Nonetheless a greater strategy is to separate frameworks right into a standalone git repository & join them by a package deal supervisor. 📦

Bundle identifiers

This one is difficult due to code signing. You’ll be able to go along with one thing like this:

[reverse domain].[project].[platform].[template name]

Listed below are the foundations:

• Begin together with your reverse area identify (com.instance)
• After the area, insert your challenge identify
• Embody platform names, aside from iOS, I do not append that one.
• Use the template identify as a suffix (like .todayextension)
• Do not add utility as a template identify
• Use .watchkitapp, .watchkitextension for legacy watchOS targets
• Do not use greater than 4 dots (see instance under)!

If you’ll use com.instance.challenge.ios.in the present day.extension that is not going to work, as a result of it comprises greater than 4 dots. So you need to merely go along with com.instance.challenge.ios.todayextension and names like that. 😢

Anyway, simply at all times attempt to signal your app and undergo the shop. Good luck. 🍀

Venture folders

The factor is that I at all times create bodily folders on the disk. In the event you make a bunch in Xcode, nicely by default that is not going to be an precise folder and all of your supply information and belongings can be positioned underneath the challenge’s principal listing.

I do know it is a private desire however I do not wish to name a large “wasteland” of information as a challenge. I’ve seen many chaotic initiatives with out correct file group. 🤐

It doesn’t matter what, however I at all times comply with this primary sample:

• Create folders for the targets
• Create a Sources folder for the Swift supply information
• Create an Property folder for all the pieces else (pictures, and so forth).

Underneath the Sources I at all times make extra subfolders for particular person VIPER modules, or just for controllers, fashions, objects, and so forth.

Instance use case

Here’s a fast instance challenge in Xcode that makes use of my conventions.

As you possibly can see I adopted the sample from above. Let’s assume that my challenge identify is TheSwiftDev. Here’s a fast overview of the total setup:

Goal & scheme names (with bundle identifiers):

• iOS Software (com.tiborbodecs.theswiftdev)
• iOS Software Unit Exams (n/a)
• iOS Software UI Exams (n/a)
• iOS At this time Extension (com.tiborbodecs.theswiftdev.todayextension)
• watchOS Software (com.tiborbodecs.theswiftdev.watchos)
• watchOS Software Extension (com.tiborbodecs.theswiftdev.watchos.extension)
• tvOS Software (com.tiborbodecs.theswiftdev.macos)
• macOS Software (com.tiborbodecs.theswiftdev.tvos)

In the event you rename your iOS goal with a WatchKit companion app, watch out!!! You even have to alter the WKCompanionAppBundleIdentifier property inside your watch utility goal’s Information.plist file by hand. ⚠️

This methodology would possibly seems to be like an overkill at first sight, however belief me it is value to comply with these conventions. As your app grows, finally you’ll face the identical points as I discussed at first. It is higher to have a plan for the longer term.