The right way to make a Swift framework?

What’s a framework?

A framework is a hierarchical listing that encapsulates shared sources, reminiscent of a dynamic shared library, nib recordsdata, picture recordsdata, localized strings, header recordsdata, and reference documentation in a single bundle.

So in a nutshell, a framework is a extremely reusable part on your apps.

The right way to make it?

There may be an article about Xcode conventions which can allow you to arrange your initiatives, it is best to examine that first, when you haven’t earlier than.

Conventional manner

There’s a conventional strategy to make a framework in Xcode. I’m going to create a shared framework for all of the apple platforms (iOS, macOS, tvOS, watchOS), which goes to be able to logging issues to the usual console.

Let’s make the challenge:

• Create a brand new challenge utilizing one of many framework targets
• Observe the directions fill & identify all of the fields
• Add all the opposite platform framework targets
• Rename all targets in keeping with the platform names

Now in Finder:

• Create a Sources folder and transfer all of the Swift and header recordsdata there
• Create an Belongings folder with platforms subfolders
• Transfer all of the Information.plist recordsdata into the proper platfrom subdirectory
• Create a Checks folder and transfer take a look at recordsdata there

Again to Xcode:

• Take away each group and add the brand new Folders from Finder
• Verify that each goal has the proper recordsdata (framework & checks)
• Contained in the header file, substitute UIKit depencency with Basis

The objective is to attain a construction considerably like this:

Undertaking settings:

• Choose the proper plist recordsdata for the targets
• Set your bundle identifiers (use my conventions)
• Setup platform variations (recommendation: assist 1 older model too)
• Setup the plist recordsdata for the checks from the construct settings pane
• Set the product identify (Console) in your framework construct settings
• Verify your construct phases and add the general public header file.

Scheme settings:

• Go to the scheme settings and setup shared schemes for the frameworks
• Collect protection knowledge when you want it
• Write your framework you should utilize Swift “macros” to detect platforms

NOTE: There’s a flag in Xcode to permit app extension API solely, if you’re embedding your framework inside an software extension it needs to be enabled!

Congratulations, now you could have your model new Swift framework made within the conventional manner. Let’s proceed with a neat trick.

Common cross platform framework

It’s potential to create a multiplatform single scheme Xcode challenge with cross platform assist for each platform, nevertheless it’s not advisable as a result of it’s a hack. Nevertheless a number of open supply libraries do the identical manner, so why shouldn’t we.

• Delete all of the targets, schemes, besides macOS!!!
• Rename the remaining goal, scheme (we don’t want platform names)
• Use the challenge configuration file, set the xcconfig on the challenge
• Delete Information.plist recordsdata, use one for the framework and one for the checks
• Rename bundle identifier (we don’t want platform names there too)

WARN: States may be combined up if you’re constructing for a number of platforms, nonetheless it is a good clear strategy to assist each platforms, with out duplications.

The right way to use a Swift framework?

Embedding your framework is probably the most easy factor to do. You may merely drag the framework challenge to a different Xcode challenge, the one factor left to do is to the embedded the framework into the appliance. You may go to the embedded binaries part inside the final challenge data tab and add the framework as a dependency.

Swift Bundle Supervisor

With SPM, you must make a Bundle.swift file first, then you definitely’ll have the ability to construct your targets with the swift construct command. Now that Xcode helps the Swift Bundle Supervisor, it’s very easy to combine third get together frameworks through the use of it.

You may obtain the ultimate framework examples from GitHub.

Just be sure you don’t miss out my deep dive into swift frameworks submit.