8/28/23, 8:02 PM Building iOS framework with dependencies.

| by Max Kalik | ITNEXT

Open in app

Get unlimited access to the best of Medium for less than $1/week.
Become a member

Building iOS framework with

dependencies.
Max Kalik · Follow
Published in ITNEXT
7 min read · Feb 23

Listen Share More

In my current iOS position, I’m deeply involved in building a

framework for iOS games. I wouldn’t write this article if this
framework weren’t unusual. What do I mean by that — unusual?

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 1/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Usually, frameworks encapsulate only the source code without

dependencies and other libraries, and of course, I don’t mean
Foundation and other build frameworks in iOS. I mean the
dependencies installed using cocoapods which for some business
reason could be included in your framework manually.

Recently I wrote an interesting detailed article/analysis about how to

create an iOS XCFramework with cocoapod dependencies, so if it’s
your case check this out: https://hackernoon.com/cocoapod-as-
xcframework-with-dependencies

In this article, we will build only a manual framework with other

frameworks inside statically. I admire it’s a pretty rare case but
businesses sometimes dictate their terms where we — developers
should implement a workable solution quickly.

Final product

The final product — MyFramework.framework

The task is to create a simple framework only for real devices with
dependencies that can be installed via cocoapod. Where we could

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 2/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

use this framework? In Unity! You can read my article about this
here. But let’s move forward and start to create our final product.

Podfile
Assume, we created a new iOS Framework project. I named it
MyFramework and in the terminal run pod init in the root of the
project folder, so we have Podfile where we can start. Let’s configure
it:

platform :ios, '14.0'

source 'https://cdn.cocoapods.org/'
source 'https://github.com/passbase/cocoapods-specs.git'
source 'https://github.com/passbase/microblink-cocoapods-specs.g

target 'YourFramework' do
pod 'CropViewController', '2.6.1'
pod 'Kingfisher', '7.5.0'
pod 'Intercom', '14.0.6'
pod 'Frames', '4.0.4'
pod 'Passbase', '2.7.0'

end

I didn’t use some abstract cocoapods, I took the real ones on purpose
to show you the real process which you could repeat by yourself. At
the first sight of the list of dependencies, you could say that they are
picked randomly. And yes and no, because all these dependencies
are different ones, for example:

Kingfisher — it’s just a piece of source code

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 3/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

CropViewController — also with source code but with a bundle of

the resource

Intercom is interested to be in this list because it’s an xcframework

itself

Frames dependency is here because it’s a combination of source

code and some sub-dependencies inside including xcframeworks

Passbase is one of the most interesting specimens because to

install this guy we need to use specific source paths including an
additional source path for Passbase’s dependency called
Microblink . All of them are xcframeworks .

Testing all these various dependencies we will create a framework

for manual installation.

Resources
If a framework uses resources (images, video, or other files), then we
need to prepare a separate target for it and this process looks a little
bit like a workaround. Let me describe it step-by-step:

1. Open File / New / Target. Choose macOS and in the Framework &
Library section choose Bundle.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 4/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

2. For now, make sure the resource files belong to this target.

3. Go to Project target / Build phases / Copy Bundle Resources and

remove and exclude everything there except the bundle.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 5/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

4. The last step is not obvious but necessary. Do you remember we

created this bundle for MacOS but we need it for iOS? So, go to Build
Settings of the framework bundle and change Architectures / Base
SDK to iOS.

5. Also in Framework target Build Phases we need to include our

bundle as a target dependency.

Build
https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 6/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Xcode has a powerful CLI to make an archive using xcodebuild with a

set of flags:

xcodebuild archive \
-workspace MyFramework.xcworkspace \
-scheme MyFramework \
-configuration Release \
-sdk iphoneos \
-archivePath archives/ios_devices.xcarchive \
BUILD_LIBRARY_FOR_DISTRIBUTION=YES \
SKIP_INSTALL=NO \

This simple script creates an archive. Open it with the right mouse
button using “Show content” and find a fresh-backed framework in
the products.

Now the framework is ready to be tested. You can just drag this
framework to your test iOS project structure. Don’t forget to Embed
and Sign this framework. Choose a real device where we are going to
test our app with this framework.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 7/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

The result will be not so good. The project will give you an error —
Build failed.

The reason is our dependencies are not found, they weren’t included
in our framework. So let’s solve this problem.

Including dependencies to a framework

Since we install our dependencies using cocoapod we need to update
Podfile. By default, the pods are installed with dynamic linking but
we need to install them with static linkage.

platform :ios, '14.0'

source 'https://cdn.cocoapods.org/'
source 'https://github.com/passbase/cocoapods-specs.git'
source 'https://github.com/passbase/microblink-cocoapods-specs.g

target 'YourFramework' do
use_frameworks! :linkage => :static

pod 'CropViewController', '2.6.1'

pod 'Kingfisher', '7.5.0'
pod 'Intercom', '14.0.6'
pod 'Frames', '4.0.4'
https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 8/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

pod 'Passbase', '~> 2.7.0'

end

So the main update of our Podfile is updating this particular line:

use_frameworks! to use_frameworks! :linkage => :static

The next step is not very obvious (I would say even questionable)
because we need to include all dependencies’ frameworks to our
framework literally by copying them from the Products folder of
Pods into our project.

If doing this manually, you need to Run the framework project first,
then you will get the Products folder with frameworks from each pod
including their bundles.

To get there you can right-click on any framework in the Products

folder and press Open in Finder.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 9/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

From each dependency folder, you need to find a folder with a name
something like Name.framework, and drag and drop it to your
Framework project. By the way, we don’t need to include frameworks’
resource bundles in our project because they will be included
automatically.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 10/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

But, even here we can come across with small nuance. As you
remember some of our dependencies are XCFramework, and the
folder where supposed to be these frameworks are empty.

Among all the product folders you can find a specific one called:
XCFrameworkIntermediates where you can find all frameworks from
XCFrameworks.

So, your project structure should look like this:

Another important thing about frameworks from XCFrameworks is —

we need to embed and sign them in our Framework.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 11/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

After all these manual manipulations, you can build your framework
again and get the final product which you can test. If you did
everything correctly, then your project with the new framework will
run successfully and all methods from the framework will work
without failures.

Potential problems
Traditionally, instead of a conclusion, which nobody cares about, I
think it will be better to list some potential problems and how to
solve them. Let’s get started.

Problem 1: Library not loaded.

Basically, it is an error always together with this message:

dyld[17871]: Library not loaded.

'@rpath/MyFramework.framework/MyFramework'

Solution:
One of the most often errors. We are all people and we can just forget
to sign the framework.

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 12/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Problem 2: Error: Compiled module was created by a newer version of the

compiler.
In your build script of xcodebuild , you most likely forgot to add this
flag: BUILD_LIBRARY_FOR_DISTRIBUTION

Problem 3: Build failed. A client uses the same dependencies which your
framework already uses.
Solution:
Briefly: Versions of the dependencies in a framework and in an app
should be the same.
Detailed: Let’s say you build your framework with cocoapod
Alamofire 5.5.0 and a client app will use your framework and
Alamofire 6.0.0 , so this combination will cause a problem. In other
words, you cannot build your app, and you won’t understand what is
going on, because the error will be about symbols, or something else.

pod 'Intercom', '2.0.0'

pod 'Alamofire', '5.5.0'

Problem 4: The path to your product is not found (the product folder in the
archive is empty)
Solution:
Check flag: SKIP_INSTALL=NO in your build script — it will install your
framework in the archive, in other words, your product folder won’t
be empty.

Problem 5: Property is not a member type of class

MyFramework.MyFramework

.../MyFramework.swiftinterface:6:34: error: 'SomeProperty' is no

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 13/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

public var direction: MyFramework.SomeProperty { get set }

Solution:
The best way to avoid this is if the names of modules in a framework
are different and don’t coincide with the name of the framework
itself. So, if you just started your framework from scratch — keep
your public module name different. For example, our framework is
called MyFramework.xcframework so the name of your general module
could be MyFrameworkMethods

IOS Xcode Framework Xcframework Cocoapods

Follow

Written by Max Kalik

77 Followers · Writer for ITNEXT

iOS Developer

More from Max Kalik and ITNEXT

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 14/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Max Kalik in Better Programming

Setting Up iOS Framework for Unity

From Swift to C#

7 min read · Oct 5, 2022

326 1

Carlos Arguelles in ITNEXT

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 15/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Amazon’s Not So Secret Weapon

The magic of Working Backwards: a real-world case study

10 min read · Aug 8, 2022

2.6K 31

Vitalii Shevchuk in ITNEXT

🦙 How to Run Llama 2 on Mac M1 and Train with Your Own

Data
Llama 2 is the next generation of large language model (LLM) developed and
released by Meta, a leading AI research company. It is…

· 6 min read · Jul 28

232 2

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 16/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Max Kalik in Level Up Coding

Implementing address autocomplete using SwiftUI and

MapKit
Let’s create a small iOS application with address autocompletion feature using
the latest SwiftUI framework.

7 min read · Dec 3, 2022

393

See all from Max Kalik

See all from ITNEXT

Recommended from Medium

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 17/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

André Oriani in Better Programming

Writing Swift-Friendly Kotlin Multiplatform APIs — Part 1

Learn how to code libraries that your iOS teammates will not frown upon using

5 min read · Jul 3

157

Mobile@Exxeta
https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 18/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Tuist and XcodeGen

A short review

4 min read · Apr 20

Lists

Apple's Vision Pro

7 stories · 17 saves

Tech & Tools

15 stories · 30 saves

Icon Design
30 stories · 64 saves

Now in AI: Handpicked by Better Programming

266 stories · 107 saves

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 19/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Lakshminaidu C

Class vs Struct vs Actor

In Swift, actor, struct, and class are three distinct constructs used for defining
data structures and managing concurrency. Each has its…

3 min read · Jul 21

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 20/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Di Nerd 🧑🏿‍💻
Swift Package Manager vs. CocoaPods: The Battle of the
Dependency Managers ⚔️
A Comprehensive Comparison of the Pros and Cons of Each for iOS
Developers

3 min read · Mar 21

The KMP implementation at TeamSnap

Alejandro Moya in TeamSnap Engineering

The KMP implementation at TeamSnap

On previous posts we explained how to setup a KMP library and consume it
from our iOS and Android projects. Now we are going to show you…

5 min read · 3 days ago

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 21/22
8/28/23, 8:02 PM Building iOS framework with dependencies. | by Max Kalik | ITNEXT

Munendra Pratap Singh

iOS Swift S.O.L.I.D. Principles

Background:

8 min read · Aug 18

See more recommendations

https://itnext.io/building-ios-framework-with-dependencies-e6e141f346ec 22/22