Migrate from the CocoaPods Plugin to the SPM Plugin

This guide covers the essential steps to migrate from the Kotlin CocoaPods plugin to the spmForKmp plugin.

Diff notation

Lines prefixed with -- should be removed
Lines prefixed with ++ should be added

Gradle

`libs.versions.toml`

libs.versions.toml
[versions]
compose-multiplatform = "1.8.0"
kotlin = "2.2.20"
firebaseIOS = "12.0.0"
++ spmForKmp = "1.0.4"

[plugins]
composeMultiplatform = { id = "org.jetbrains.compose", version.ref = "compose-multiplatform" }
composeCompiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
-- kotlinCocoapods = { id = "org.jetbrains.kotlin.native.cocoapods", version.ref = "kotlin" }
++ spmForKmp = { id = "io.github.frankois944.spmForKmp", version.ref = "spmForKmp" }

Root `build.gradle.kts`

build.gradle.kts
plugins {
    // this is necessary to avoid the plugins to be loaded multiple times
    // in each subproject's classloader
    alias(libs.plugins.kotlinMultiplatform) apply false
    -- alias(libs.plugins.kotlinCocoapods).apply(false)
    ++ alias(libs.plugins.spmForKmp).apply(false)
    alias(libs.plugins.composeMultiplatform).apply(false)
    alias(libs.plugins.composeCompiler).apply(false)
}

Module `build.gradle.kts`

Replace the cocoapods {} block with swiftPackageConfig {} for each target:

myKMPApp/build.gradle.kts
plugins {
    alias(libs.plugins.kotlinMultiplatform)
    -- alias(libs.plugins.kotlinCocoapods)
    ++ alias(libs.plugins.spmForKmp)
}

group = "org.jetbrains.kotlin.shared"
version = "1.0-SNAPSHOT"

kotlin {
    - iosArm64()
    - iosSimulatorArm64()
    - cocoapods {
    -    summary = "Kotlin module with cocoapods dependencies"
    -    ios.deploymentTarget = "16.6"
    -    pod("FirebaseCore") {
    -        version = libs.versions.firebaseIOS.get()
    -    }
    -    pod("FirebaseAnalytics") {
    -        version = libs.versions.firebaseIOS.get()
    -    }
    -    pod("CryptoSwift") {
    -        version = "1.2.3"
    -        linkOnly = true
    -    }
    - }

    + listOf(
    +    iosArm64(),
    +    iosSimulatorArm64()
    + ).forEach {
    +    it.swiftPackageConfig(cinteropName = "nativeBridge") {
    +        minIos = "16.6"
    +        dependency {
    +            remotePackageVersion(
    +                url = uri("https://github.com/firebase/firebase-ios-sdk.git"),
    +                products = {
    +                    add("FirebaseCore", "FirebaseAnalytics", exportToKotlin = true)
    +                },
    +                version = libs.versions.firebaseIOS.get(),
    +            )
    +            remotePackageVersion(
    +                url = uri("https://github.com/krzyzanowskim/CryptoSwift"),
    +                products = {
    +                    add("CryptoSwift")
    +                },
    +                version = "1.2.3",
    +            )
    +        }
    +    }
    + }
}

Xcode

Remove CocoaPods Integration

From your iOS app folder, run:

Terminal

pod deintegrate

Add a New Build Phase

In the Build Phases tab of your Xcode project:

Click + and choose New Run Script Phase
Drag it to the top of the phase list
Paste the following script:

Run Script

cd "$SRCROOT/../../"
./gradlew :shared:embedAndSignAppleFrameworkForXcode

Update Build Settings

In the Build Settings tab, set or update the following:

Setting	Value
Other Linker Flags	`-framework shared`
Framework Search Paths	`$(SRCROOT)/../build/xcode-frameworks/$(CONFIGURATION)/$(SDK_NAME)`

Kotlin Code

Update import statements — the cocoapods package prefix is removed:

-- import cocoapods.FireBaseCore.FIRApp
++ import FireBaseCore.FIRApp

Tip

The original prefix can be restored by configuring packageDependencyPrefix.

Troubleshooting

If you run into dependency resolution issues or crash in Xcode, you may need to include the native dependency directly in your Xcode project. See Automatic Dependency Build Inclusion for details.