https://github.com/leavez/cocoapods-static-swift-framework

A cocoapods plugin enables static framework for all pods
https://github.com/leavez/cocoapods-static-swift-framework

cocoapods-plugin statically-linking swift

Last synced: about 20 hours ago
JSON representation

A cocoapods plugin enables static framework for all pods

• Host: GitHub
• URL: https://github.com/leavez/cocoapods-static-swift-framework
• Owner: leavez
• License: mit
• Created: 2018-01-03T07:38:33.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-07-22T01:48:18.000Z (over 2 years ago)
• Last Synced: 2024-11-05T21:25:01.426Z (8 days ago)
• Topics: cocoapods-plugin, statically-linking, swift
• Language: Ruby
• Homepage:
• Size: 24.4 KB
• Stars: 253
• Watchers: 5
• Forks: 17
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# cocoapods-static-swift-framework

A cocoapods plugin that enables static frameworks for all pods.

Cocoapods only supports static framework at pod level, which means an option in podspec and just valid for that pod. By using this plugin, we can make all pod to static framework with only one word!

(There's 'swift' in the plugin name as it's originally built for swift. You can also use it for pure objc project too.)

## Usage

Install via gem:

```

$ gem install cocoapods-static-swift-framework

```

Add the following to your podfile:

```ruby

plugin 'cocoapods-static-swift-framework'

```

NOTE: Static frameworks is still using framework, not static library. So don't forget to add `use_frameworks!`

NOTE: From cocoapods 1.7, the generated resource bundle specified with `s.resource_bundle` in podspec, will not be copied to the .framework folder. It's a default behavior of cocoapods.

## About Static framework

### Why

Too many dynamic frameworks will increase app boot time dramatically, also the `Copy framework` build phase will expend unendurable time in the code-build-run loop. (There is also a dyld [crash](https://github.com/Ruenzuo/cocoapods-amimono#why-would-you-want-this-plugin-in-your-podfile)) Static framework have no these problems.

### What is a static framework

First of all, what is a framework? Framework is just a bundle with specifications to organize files, for whom xcode provides convenient methods to link bianry and copy resources. 

Static framework, or precisely static-linking framework, has no official defination. There's only (dynamic) framework. "When linking, it found that the binary in the framework is static-linking, then it will link the binary staticaly. There's no special handling." an Apple engineer answered me at WWDC. 

Resources in static framework can't be copied to app's main bundle automatically. If you use cocoapods, it will handle it automatically, but not for the manual integration.

The binary in the framework will be linked statically, as its name, to the main binary. There's no framework file in the `Framework` folder of the app bundle. Resources will copied to app bundle's root path. So there's a potential bug of conflict of resource file names.

## requirement

- Xcode 9+

- cocoapods 1.5+ (v1.7 tested)

## License

MIT

Appreciate a 🌟 if you like it.  Another cocoapods plugin made by me to improve pod compile time: [cocoapods-binary](https://github.com/leavez/cocoapods-binary)