Exclude pod when porting to mac with catalyst

Question

Porting apps to mac is finally possible thanks to Catalyst, problem is, numerous pods don't support AppKit. Most common one would be Crashlytics / Firebase.

In [...]/Pods/Crashlytics/iOS/Crashlytics.framework/Crashlytics(CLSInternalReport.o), building for Mac Catalyst, but linking in object file built for iOS Simulator, file '[...]/Pods/Crashlytics/iOS/Crashlytics.framework/Crashlytics' for architecture x86_64

Since it's a recent topic, I couldn't find doc on how to remove a pod from my build for macOS but keep it for iOS and iPadOS.

It is possible to use in code:

#if !targetEnvironment(macCatalyst) 
// Code to exclude for your macOS app
#endif

But that one part of the problem, the other part is to link the pod only for iOS...

What would be the easiest/best course of action when the library is not vital for macOS but still wanted on iOS?

Hey op! It would be great to know if my answer helped you! if it does, please mark the answer as the right answer — Oz Shabat
– Oz Shabat, Commented Aug 25, 2020 at 10:13

thecoolwinter · Accepted Answer · 2021-01-17 08:34:24Z

26

For the best approach of handling unsupported framweorks for Catalyst, you guys should read the solution of Fernando Moya de Rivas, he has a github with a solution here with more up to date information.

He basically said you just need to define an array of all of the libs you don't want to install on mac osx, like this: ['Fabric', 'Crashlytics', 'Firebase/Core', ...].

Then, your pod file can look simple as this:

# Podfile
load 'remove_unsupported_libraries.rb'

target 'My target' do
   use_frameworks!
   # Install your pods
   pod ...
end

# define unsupported pods
def catalyst_unsupported_pods
    ['Fabric', 'Crashlytics', 'Firebase/Core', ...]
end

# Remove unsupported pods from your project
post_install do |installer|   
    installer.configure_support_catalyst
end

edited Jan 17, 2021 at 8:34

thecoolwinter

1,0499 silver badges29 bronze badges

answered Mar 10, 2020 at 7:16

Oz Shabat

1,65218 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

andygeers Over a year ago

I think this should be the accepted answer now. Just note that I think it requires Ruby 2.6.3 to avoid an error when it calls filter

Tancrede Chazallet Over a year ago

I switched this to the accepted answer now, as it seems the consensus :)

Tancrede Chazallet · Accepted Answer · 2019-12-28 22:28:56Z

19

Following @ajgryc answer, I was able to make a sleek solution:

In your podfile add

post_install do |installer|
    installer.pods_project.targets.each do |target|
        if target.name == "Pods-[Name of Project]"
            puts "Updating #{target.name} OTHER_LDFLAGS to OTHER_LDFLAGS[sdk=iphone*]"
            target.build_configurations.each do |config|
                xcconfig_path = config.base_configuration_reference.real_path
                xcconfig = File.read(xcconfig_path)
                new_xcconfig = xcconfig.sub('OTHER_LDFLAGS =', 'OTHER_LDFLAGS[sdk=iphone*] =')
                File.open(xcconfig_path, "w") { |file| file << new_xcconfig }
            end
        end
    end
end

Since Cocoapods 1.8.4

post_install do |installer|
  installer.pods_project.targets.each do |target|
    if target.name == "Pods-[Name of Project]"
      puts "Updating #{target.name} to exclude Crashlytics/Fabric"
      target.build_configurations.each do |config|
        xcconfig_path = config.base_configuration_reference.real_path
        xcconfig = File.read(xcconfig_path)
        xcconfig.sub!('-framework "Crashlytics"', '')
        xcconfig.sub!('-framework "Fabric"', '')
        new_xcconfig = xcconfig + 'OTHER_LDFLAGS[sdk=iphone*] = -framework "Crashlytics" -framework "Fabric"'
        File.open(xcconfig_path, "w") { |file| file << new_xcconfig }
      end
    end
  end
end

And then in run script build phase for Fabric:

if [[$ARCHS != "x86_64"]]; then
  "${PODS_ROOT}/Fabric/run" [your usual key]
fi

edited Dec 28, 2019 at 22:28

answered Nov 8, 2019 at 14:50

Tancrede Chazallet

7,2656 gold badges43 silver badges62 bronze badges

6 Comments

William Denniss Over a year ago

This works well to disable all CocoaPods from being linked in MacCatalyst. Change the third line to if target.name.start_with?("Pods") to catch all Pod targets.

tmm1 Over a year ago

This doesn't seem to work anymore with cocoapods 1.8.4

Ankur Patel Over a year ago

I tried both way "if target.name.start_with?("Pods")" does not work for me also with cocoapods 1.8.4, I got below error, anybody can guide me. in /Users/ios/Desktop/xxxxxx/Pods/FirebaseAnalytics/Frameworks/FIRAnalyticsConnector.framework/FIRAnalyticsConnector(FIRConnectorUtils_d79571aba36a7d46e5c6ca87a6fec1c1.o), building for Mac Catalyst, but linking in object file built for iOS Simulator, file '/Users/ios/Desktop/xxxxxx/Pods/FirebaseAnalytics/Frameworks/FIRAnalyticsConnector.framework/FIRAnalyticsConnector' for architecture x86_64

Honghao Z Over a year ago

For the run script, you can also use: if [[ ${IS_MACCATALYST} != "YES" ]]; then "${PODS_ROOT}/Fabric/run" fi

KleMiX Over a year ago

Can you update an answer to include a link to an issue in cocoa pods so that people reading an answer can upvote it? This should be supported out of the box in my opinion. github.com/CocoaPods/CocoaPods/issues/9364

|

ajgryc · Accepted Answer · 2019-11-07 00:47:49Z

13

+50

Open your Pods-$projectname.release.xcconfig file in your project's Pods directory, and locate the OTHER_LDFLAGS line. Add [sdk=iphone*] immediately after the variable name (as an example, mine now looks like this):

OTHER_LDFLAGS[sdk=iphone*] = $(inherited) -ObjC -l"MailCore-ios" -l"c++" -l"iconv" -l"resolv" -l"xml2" -l"z"

That conditionally sets the link options only when building iphone variants, preventing the pod from being linked on OSX. Of course as you mention, this needs to be combined with #if !targetEnvironment(macCatalyst) and #endif surrounding the code calling the pod or you'll get linker errors.

This allowed me to get past the same problem. (And in case you're wondering what other cool things besides conditional variables you can add to your .xcconfig files, here's a reference I found: https://pewpewthespells.com/blog/xcconfig_guide.html )

answered Nov 7, 2019 at 0:47

ajgryc

4453 silver badges6 bronze badges

4 Comments

Tancrede Chazallet Over a year ago

I have given you the bounty, but accepted my own answer as I give a solution out of the box which will make people's life easier, thank you very much!

Ankur Patel Over a year ago

sorry, but where is a Pods-$projectname.release.xcconfig file. I am not able to find it.

ajgryc Over a year ago

In my config it is in <Project Directory>/Pods/Target Support Files/Pods-<Project Name>

Oz Shabat Over a year ago

this solution isn't recommended as the xcconfig always build itself in every pod install. I would recommend to read this Fernando Moya de Rivas's answer for the best alternative

Andy · Accepted Answer · 2020-02-14 01:10:10Z

10

I have an updated solution that works for me with the following Google pods:

  pod 'FirebaseUI/Auth'
  pod 'FirebaseUI/Phone'
  pod 'FirebaseUI/Email'
  pod 'Firebase/Auth'
  pod 'Firebase/Analytics'
  pod 'Fabric', '~> 1.10.2'
  pod 'Firebase/Crashlytics'
  pod 'Firebase/AdMob'

post_install do |installer|
  installer.pods_project.targets.each do |target|
    if target.name.start_with?("Pods")
        puts "Updating #{target.name} to exclude Crashlytics/Fabric"
      target.build_configurations.each do |config|
        xcconfig_path = config.base_configuration_reference.real_path
        xcconfig = File.read(xcconfig_path)
        xcconfig.sub!('-framework "FirebaseAnalytics"', '')
        xcconfig.sub!('-framework "FIRAnalyticsConnector"', '')
        xcconfig.sub!('-framework "GoogleMobileAds"', '')
        xcconfig.sub!('-framework "Google-Mobile-Ads-SDK"', '')
        xcconfig.sub!('-framework "GoogleAppMeasurement"', '')
        xcconfig.sub!('-framework "Fabric"', '')
        new_xcconfig = xcconfig + 'OTHER_LDFLAGS[sdk=iphone*] = $(inherited) -framework "FirebaseAnalytics"  -framework "FIRAnalyticsConnector"  -framework "GoogleMobileAds" -framework "GoogleAppMeasurement" -framework "GoogleUtilities" "-AppMeasurement" -framework "Fabric"'
        File.open(xcconfig_path, "w") { |file| file << new_xcconfig }
      end
    end
  end
end

edited Feb 14, 2020 at 1:10

answered Feb 13, 2020 at 17:18

Andy

1,8752 gold badges24 silver badges51 bronze badges

5 Comments

fphelp Over a year ago

I'm trying to use this solution as it looks the most clean, but I get this error:

ld: in /Users/<name>/source/<app>/Pods/Fabric/iOS/Fabric.framework/Fabric(Fabric.o), building for Mac Catalyst, but linking in object file built for iOS Simulator, for architecture x86_64

I use exactly what you have above minus the GoogleMobileAds and Google-Mobile-Ads-SDK. Why am I getting this?

Andy Over a year ago

I’m not sure. At this point it’s time to remove Fabric isn’t it? I don’t agree that Google had the right to buy them, but they did and are shutting it down so...

fphelp Over a year ago

Sadly using 'pod Crashlytics' automatically installs Fabric (1.10.2). Not sure why that happens and am cautious about using the 'Firebase/Crashlytics' pod because Google says that that's still in the beta stage :(

Sam Spencer Over a year ago

Does anyone get a build failure with error "unsealed contents present in the bundle root" when doing this?

iMinion Over a year ago

@user13138159 I m trying the above solution but it gives me the error ld: in /Users/<name>/Desktop/<app>/Pods/GoogleAnalytics/Libraries/libGoogleAnalytics.a(GAITrackerImpl.o), building for Mac Catalyst, but linking in object file built for iOS Simulator, file '/Users/<name>/Desktop/<app>/Pods/GoogleAnalytics/Libraries/libGoogleAnalytics.a' for architecture x86_64 clang: error: linker command failed with exit code 1 (use -v to see invocation) what ekzactly you did?

tmm1 · Accepted Answer · 2019-12-20 23:07:43Z

7

With cocoapods 1.8.4, I had to adapt @AncAinu's excellent answer as follows:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    if target.name == "Pods-[Name of Project]"
      puts "Updating #{target.name} to exclude Crashlytics/Fabric"
      target.build_configurations.each do |config|
        xcconfig_path = config.base_configuration_reference.real_path
        xcconfig = File.read(xcconfig_path)
        xcconfig.sub!('-framework "Crashlytics"', '')
        xcconfig.sub!('-framework "Fabric"', '')
        new_xcconfig = xcconfig + 'OTHER_LDFLAGS[sdk=iphone*] = -framework "Crashlytics" -framework "Fabric"'
        File.open(xcconfig_path, "w") { |file| file << new_xcconfig }
      end
    end
  end
end

answered Dec 20, 2019 at 23:07

tmm1

2,1351 gold badge21 silver badges37 bronze badges

5 Comments

tmm1 Over a year ago

FYI, the latest release of Crashlytics is now open-source and thus compiles directly for Catalyst when needed. This hack is no longer required in the case of Crashlytics, but can be useful with other legacy pods.

Bartu Akman Over a year ago

in above Name of the Project part, we have to write name of the project file ? if target.name == "Pods-[MyProjectExample]". something like that or just paste the answer ? because it doest work for me

tmm1 Over a year ago

Yes you have to replace with your project name.

Bartu Akman Over a year ago

I done everything right. if target.name == "Pods-[VPNoid]" clean and build my project again. but still error is complaining. Do u have any idea ?

tmm1 Over a year ago

Remove the []

ZYiOS · Accepted Answer · 2020-10-13 02:46:10Z

Based on what has already been discussed here... here is my solution for projects with multiple targets. It basically is validating the usage of the libs on each target instead of following the target name.

post_install do |installer|
    
    installer.pods_project.targets.each do |target|
        
        # handle non catalyst libs
        libs = ["FirebaseAnalytics", "Google-Mobile-Ads-SDK"]
        
        target.build_configurations.each do |config|
            xcconfig_path = config.base_configuration_reference.real_path
            xcconfig = File.read(xcconfig_path)
            values = ""
            
            libs.each { |lib|
                if xcconfig["-framework \"#{lib}\""]
                    puts "Found '#{lib}' on target '#{target.name}'"
                    xcconfig.sub!(" -framework \"#{lib}\"", '')
                    values += " -framework \"#{lib}\""
                end
            }
            
            if values.length > 0
                puts "Preparing '#{target.name}' for Catalyst\n\n"
                new_xcconfig = xcconfig + 'OTHER_LDFLAGS[sdk=iphone*] = $(inherited)' + values
                File.open(xcconfig_path, "w") { |file| file << new_xcconfig }
            end
        end
    end
end

It outputs something like this

Generating Pods project

Found 'Google-Mobile-Ads-SDK' on target 'Pods-TheApp'
Found 'FirebaseAnalytics' on target 'Pods-TheApp'
Preparing 'Pods-TheApp' for Catalyst

Found 'Google-Mobile-Ads-SDK' on target 'Pods-TheApp-TheAppTests'
Found 'FirebaseAnalytics' on target 'Pods-TheApp-TheAppTests'
Preparing 'Pods-TheApp-TheAppTests' for Catalyst

Found 'Google-Mobile-Ads-SDK' on target 'Pods-TheApp-TheApp_iOS_UI_Tests'
Found 'FirebaseAnalytics' on target 'Pods-TheApp-TheApp_iOS_UI_Tests'
Preparing 'Pods-TheApp-TheApp_iOS_UI_Tests' for Catalyst

Found 'Google-Mobile-Ads-SDK' on target 'Pods-TheAppIntentsExtension'
Found 'FirebaseAnalytics' on target 'Pods-TheAppIntentsExtension'
Preparing 'Pods-TheAppIntentsExtension' for Catalyst

Found 'Google-Mobile-Ads-SDK' on target 'Pods-TheAppTodayExtension'
Found 'FirebaseAnalytics' on target 'Pods-TheAppTodayExtension'
Preparing 'Pods-TheAppTodayExtension' for Catalyst

Collectives™ on Stack Overflow

Exclude pod when porting to mac with catalyst

6 Answers 6

2 Comments

6 Comments

4 Comments

5 Comments

5 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

2 Comments

6 Comments

4 Comments

5 Comments

5 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related