Обзор и настройка CocoaPods

Настройка среды для работы с CocoaPods

Установите менеджер зависимостей CocoaPods:

sudo gem install cocoapods

sudo gem install cocoapods-generate

Если у вас возникнут проблемы во время установки, обратитесь к разделу Возможные проблемы и решения.

Добавление и настройка плагина Kotlin CocoaPods Gradle

Если ваша среда настроена правильно, вы можете создать новый многоплатформенный проект Kotlin и выбрать Менеджер зависимостей CocoaPods в качестве опции распространения iOS-фреймворка. Плагин автоматически сгенерирует проект для вас.

Если вы хотите настроить свой проект вручную:

1. В build.gradle(.kts) вашего проекта примените плагин CocoaPods и плагин Kotlin Multiplatform:

   plugins {
       kotlin("multiplatform") version "1.8.0"
       kotlin("native.cocoapods") version "1.8.0"
   }
   

2. Настройте version, summary, homepage, и baseName файла Podspec в блоке cocoapods.

   plugins {
       kotlin("multiplatform") version "1.8.0"
       kotlin("native.cocoapods") version "1.8.0"
   }
   
   kotlin {
       cocoapods {
           // Required properties
           // Specify the required Pod version here. Otherwise, the Gradle project version is used.
           version = "1.0"
           summary = "Some description for a Kotlin/Native module"
           homepage = "Link to a Kotlin/Native module homepage"
   
           // Optional properties
           // Configure the Pod name here instead of changing the Gradle project name
           name = "MyCocoaPod"
   
           framework {
               // Required properties              
               // Framework name configuration. Use this property instead of deprecated 'frameworkName'
               baseName = "MyFramework"
   
               // Optional properties
               // Specify the framework linking type. It's dynamic by default. 
               isStatic = false
               // Dependency export
               export(project(":anotherKMMModule"))
               transitiveExport = false // This is default.
               // Bitcode embedding
               embedBitcode(BITCODE)
           }
   
           // Maps custom Xcode configuration to NativeBuildType
           xcodeConfigurationToNativeBuildType["CUSTOM_DEBUG"] = NativeBuildType.DEBUG
           xcodeConfigurationToNativeBuildType["CUSTOM_RELEASE"] = NativeBuildType.RELEASE
       }
   }
   

3. Переимпортируйте проект.

4. Сгенерируйте обёртку Gradle, чтобы избежать проблем совместимости во время сборки в Xcode.

При применении плагина CocoaPods выполняется следующее:

• Добавляет как debug и release фреймворки в качестве выходных бинарных файлов для всех macOS, iOS, tvOS и watchOS таргетов.

• Создаёт задачу podspec, которая генерирует файл Podspec для проекта.

Файл Podspec включает путь к выходному фреймворку и стадии скриптов, которые автоматизируют построение этого фреймворка во время процесса сборки проекта Xcode.

Обновление Podfile для Xcode

Если вы хотите импортировать свой проект Kotlin в проект Xcode, вам необходимо внести некоторые изменения в ваш Podfile:

• Если ваш проект имеет зависимости от Git, HTTP или пользовательских репозиториев Podspec, вы также должны указать путь к Podspec в Podfile.

  Например, если вы добавляете зависимость от podspecWithFilesExample, укажите путь к Podspec в Podfile:

  target 'ios-app' do
      # ... other dependencies ...
      pod 'podspecWithFilesExample', :path => 'cocoapods/externalSources/url/podspecWithFilesExample'
  end
  

  :path должен содержать путь к файлу Pod.

• При добавлении библиотеки из пользовательского репозитория Podspec, вы также должны указать местоположение спецификаций в начале вашего Podfile:

  source 'https://github.com/Kotlin/kotlin-cocoapods-spec.git'
  
  target 'kotlin-cocoapods-xcproj' do
      # ... other dependencies ...
      pod 'example'
  end
  

Если вы не внесете эти изменения в Podfile, задача podInstall завершится ошибкой, и плагин CocoaPods отобразит сообщение об ошибке в журнале.

Посмотрите ветку withXcproject образцового проекта, который содержит пример интеграции Xcode с существующим проектом Xcode под названием kotlin-cocoapods-xcproj.

Возможные проблемы и решения

tasks.named<org.jetbrains.kotlin.gradle.tasks.DefFileTask>("generateDefNearbyMessages").configure {
    doLast {
        outputFile.writeText("""
            language = Objective-C
            headers = GNSMessages.h
        """.trimIndent())
    }
}