How to build a custom Swift framework and how is it related to the SPM?

Question

I am currently building code that I would really like to use as a framework by being able to import MyCustomFramework as I would with Apple frameworks (in the future I would also like to distribute them).

I have some questions about that :

What is the easiest way to build a framework as what I want? Is this possible to do it directly in Xcode or do I need to use command line tools in the Terminal?
Will this framework be compatible with multiple platforms (I am thinking about all Apple platforms but also about other platforms supported by Swift such as Linux).
What is exactly the link between Swift frameworks and the Swift Package Manager ? Do I need SPM to build my framework or is this two different tools?

Thank you.

About compatibility it relies on which libs are you going to use, not all cocoa libs are yet available for linux version of swift. — Matteo Crippa, Dec 27 '16 at 12:56
You can check this tutorial https://www.raywenderlich.com/126365/ios-frameworks-tutorial — Stefan Nestorov, Dec 27 '16 at 13:07
@StefanNestorov Thank you! I see this is a Cocoa *Touch* framework, is this compatible with other platforms ? — Pop Flamingo, Dec 27 '16 at 13:08
Should be available for iOS and osX but not sure for other platforms (Linux). — Stefan Nestorov, Dec 27 '16 at 13:16
Are you talking about client side code or server side code or both? Will your framework be used both in iOS/macOS apps and also in the server side on Linux? — Vadim Eisenberg, Dec 28 '16 at 05:57
@VadimEisenberg the framework may be used on both macOS and Linux — Pop Flamingo, Dec 28 '16 at 12:23
@TrevörAnneDenise, on macOS, do you plan to run it as part of a macOS app, with UI, or as a command line macOS program ? — Vadim Eisenberg, Dec 29 '16 at 16:23
@VadimEisenberg it could be used in both cases, actually I am thinking to many different frameworks. — Pop Flamingo, Dec 30 '16 at 12:18

score 3 · Answer 1 · edited May 23 '17 at 12:24

3

I gave a detailed answer on how to use Xcode to create a Framework target in an answer 2 weeks ago here. The question wasn't specifically related to Frameworks, so I can understand how it doesn't come up in a search. (I also believe if I copied/pasted it here that would be unwelcome, but if I'm wrong I'll do it.)
For now a Swift Framework target can be compatible across Apple platforms, provided you separate UIKit, Foundation, and core code into their own frameworks. (There may be a better way but that's the best way I know.
About Swift core code: Currently Swift is (still) evolving fast. Swift 3 is beginning to have production server-side use and some Linux use, but right now with no binary compatibility (that's part of Swift 4) I'd stick to Apple platforms.
I've heard conflicting things about Swift version compatibility between Swift 2 & 3. By this I mean you can use both in the same project, but there are hurdles if you do.

edited May 23 '17 at 12:24

Community

1
1

answered Dec 27 '16 at 15:32

Thank you for your answer ! If I build a framework and add it to "Linked frameworks and libraries" and try to import it, Xcode does a complains that no such module exists. What do you mean exactly by "no binary compatibility" ? Aren't there already services supporting Swift servers (for instance Heroku ?)? – Pop Flamingo Dec 27 '16 at 15:48
I did a quick search on Swift ABI, there's probably better links, but here's a decent one that explains what the lack of binary compatibility (ABI) in Swift 3 means. https://www.infoq.com/news/2016/05/swift-3-no-stable-abi. You are correct - there are both server side and Linux Swift builds. How stable and forward-compatible they are (particularly Linux) is evolving. Just keep this in mind is all I suggest. One more thing about server-side... like HTTP servers, there are a few builds out there, and I'm sure each have their strengths and weaknesses. Good luck! – Dec 27 '16 at 15:54

Vadim Eisenberg · Accepted Answer · 2016-12-31T09:23:11.593

Currently, Swift Package Manager (SPM) and Xcode Frameworks follow different paths. For Linux, you have to follow the SPM path since the only way to compile a Linux swift application is to use SPM. For macOS command line apps, you can follow the SPM path as well. For iOS apps and macOS UI apps, you have to follow the Xcode Frameworks path.

For the SPM path, you make the project of your framework SPM-enabled: add Package.swift file and set the file layout of your project according to SPM conventions. The project also has to be a git repository. Then the git repository of your project can be specified as a dependency to other SPM-enabled frameworks/applications. Each SPM-enabled project can be converted to an Xcode project any time by using swift package generate-xcodeproj command.

The Xcode Frameworks path is the standard, pre-SPM way of working with frameworks with Xcode, which is described elsewhere. You create an Xcode Project that will define your framework.

So, if you want your framework to be used both in SPM-enabled projects for Linux and macOS command line apps, and in Xcode-enabled projects for iOS and macOS UI apps, you have to follow the dual path. You make your project SPM-enabled and add an Xcode Project which will define your framework. You will have to maintain your project information twice - in Package.swift file and in the Xcode Project.

How to build a custom Swift framework and how is it related to the SPM?

2 Answers2

Linked