Support installation via Swift Package Manager

[1ec5]

The navigation SDK is currently available for installation via CocoaPods and Carthage, with some of the lighterweight dependencies (MapboxDirections, Turf, etc.) also available for installation via Swift Package Manager. SPM has a brighter long-term outlook than CocoaPods and Carthage, so we should try to support it as soon as it’s ready.

The navigation SDK can only support SPM once all its dependencies also support SPM, in particular:

• Mapbox [map SDK]: Swift Package Manager mapbox-gl-native#15241
• MapboxMaps [map SDK]: Upgrade to Mapbox Maps SDK v10 #2794 Mapbox Maps SDK v10 Integration. #2808
• MapboxAccounts: v2.3.1 mapbox-accounts-ios#1
• MapboxCommon
• MapboxDirections: Add support for Swift Package Manager mapbox-directions-swift#362
• MapboxMobileEvents: Refactor project and add support for SPM mapbox-events-ios#250
• MapboxNavigationNative
• MapboxSpeech: Add support for SPM mapbox-speech-swift#25
• Solar: Add Swift Package Manager support ceeK/Solar#11 v2.2.0 ceeK/Solar#50
• Turf: SPM support turf-swift#30

The following dependencies are also needed for the SPM build to be testable:

• Cedar
• Quick
• Nimble
• OHHTTPStubs
• FBSnapshotTestCase
• SnappyShrimp

/cc @mapbox/navigation-ios @frederoni

[frederoni]

SPM support in MapboxMobileEvents mapbox/mapbox-events-ios#250

[1ec5]

The map SDK, MapboxCommon, and MapboxNavigationNative all require .netrc for downloading, so the changes in swiftlang/swift-package-manager#2833 swiftlang/swift-tools-support-core#88 will help to unblock SPM support in the navigation SDK.

[1ec5]

mapbox/mapbox-directions-swift#494 tracks a major gap in code coverage when testing MapboxDirections with Swift Package Manager.

[MarcoCarnevali]

@1ec5 are there any news about this?

[FestiFete]

Didn't see any updates in v1.2.0 change logs, any news about it?

[1ec5]

MapboxCoreNavigation support for SPM is progressing in #2771. MapboxNavigation support for SPM is blocked by ceeK/Solar#11 and mapbox/mapbox-gl-native#15241. Realistically speaking, MapboxNavigation support for SPM is blocked by upgrading to map SDK v10 because that’s the focus of map SDK development nowadays.

[1ec5]

The issue description above originally focused on framework dependencies, because the idea was to at least stand up SPM as an alternative build environment as part of a transition towards SPM. However, SPM is now important enough that we need to make sure the test targets also build under SPM. Of the six (six!) testing frameworks this repository depends on, only three currently support SPM. Cedar, FBSnapshotTestCase, and SnappyShrimp not only lack support for SPM but are also unmaintained. We can eliminate MapboxCoreNavigationTests’ dependency on Cedar, but for MapboxNavigationTests to fully support SPM, we’ll need to substantially streamline our testing code: #2791.

[1ec5]

As of #2771, you can install MapboxCoreNavigation using SPM. Anecdotally, using SPM saves quite a bit of time compared to Carthage if you only need MapboxCoreNavigation. I’m leaving this issue open to track installing MapboxNavigation using SPM, since that’s what most developers would be interested in. We also need to increase code coverage under SPM to where it is with Carthage: #2792.

[1ec5]

The documentation script also needs to use SPM instead of Carthage to discover the most recent MapboxDirections docset to link to:

mapbox-navigation-ios/scripts/document.sh

Lines 30 to 31 in 2bb7f97

DIRECTIONS_VERSION=$(grep 'mapbox-directions-swift' Cartfile.resolved | grep -oE '"v.+?"' | grep -oE '[^"v]+')

DIRECTIONS_SYMBOLS="AttributeOptions|CoordinateBounds|Directions|DirectionsCredentials|DirectionsOptions|DirectionsPriority|DirectionsProfileIdentifier|DirectionsResult|Intersection|Lane|LaneIndication|MapMatchingResponse|Match|MatchOptions|RoadClasses|Route|RouteLeg|RouteOptions|RouteResponse|RouteStep|SpokenInstruction|Tracepoint|VisualInstruction|VisualInstruction.Component|VisualInstruction.Component.ImageRepresentation|VisualInstruction.Component.TextRepresentation|VisualInstructionBanner|Waypoint"

[1ec5]

As of #2808 and v2.0.0-alpha.1, MapboxNavigation also supports SPM. We’re still tracking some significant tail work:

• MapboxMaps is currently depending on a binary alpha release of Turf, but it needs to depend on a source distribution of Turf going forward.
• MapboxCoreNavigationTests and TestHelper depend on MapboxNavigation: TestHelper should not depend on MapboxNavigation #2820.
• MapboxNavigationTests depends on unmaintained testing frameworks that don’t support SPM: Migrate snapshot tests away from unmaintained testing frameworks #2791.