STRUCT

PackageSettings

Contents

• Properties
  • productTypes
  • productDestinations
  • baseSettings
  • targetSettings
  • projectOptions
• Methods
  • init(productTypes:productDestinations:baseSettings:targetSettings:projectOptions:)
  • init(productTypes:productDestinations:baseSettings:targetSettings:projectOptions:)

public struct PackageSettings: Codable, Equatable, Sendable

A custom Swift Package Manager configuration

// swift-tools-version: 5.9
import PackageDescription

#if TUIST
    import ProjectDescription
    import ProjectDescriptionHelpers

    let packageSettings = PackageSettings(
        productTypes: [
            "Alamofire": .framework, // default is .staticFramework
        ]
    )
#endif

let package = Package(
    name: "PackageName",
    dependencies: [
        .package(url: "https://github.com/Alamofire/Alamofire", from: "5.0.0"),
    ]
)

Properties

productTypes

public var productTypes: [String: Product]

The custom Product type to be used for SPM targets.

productDestinations

public var productDestinations: [String: Destinations]

Custom product destinations where key of the dictionary is the name of the SPM product and the value contains the supported destinations. Note: This setting should only be used when using Tuist for SPM package projects, not for your external dependencies. SPM implicitly always supports all platforms, but some commands like tuist cache depend on destinations being explicit. If a product does not support all destinations, you can use productDestinations to make the supported destinations explicit.

baseSettings

public var baseSettings: Settings

The base settings to be used for targets generated from SwiftPackageManager

targetSettings

public var targetSettings: [String: Settings]

Additional settings to be added to targets generated from SwiftPackageManager.

projectOptions

public var projectOptions: [String: Project.Options]

Custom project configurations to be used for projects generated from SwiftPackageManager.

Methods

init(productTypes:productDestinations:baseSettings:targetSettings:projectOptions:)

public init(
    productTypes: [String: Product] = [:],
    productDestinations: [String: Destinations] = [:],
    baseSettings: Settings = .settings(),
    targetSettings: [String: Settings] = [:],
    projectOptions: [String: Project.Options] = [:]
)

Creates PackageSettings instance for custom Swift Package Manager configuration.

• Parameters:
  • productTypes: The custom Product types to be used for SPM targets.
  • productDestinations: Custom destinations to be used for SPM products.
  • baseSettings: Additional settings to be added to targets generated from SwiftPackageManager.
  • targetSettings: Additional settings to be added to targets generated from SwiftPackageManager.
  • projectOptions: Custom project configurations to be used for projects generated from SwiftPackageManager.

Parameters

Name	Description
productTypes	The custom Product types to be used for SPM targets.
productDestinations	Custom destinations to be used for SPM products.
baseSettings	Additional settings to be added to targets generated from SwiftPackageManager.
targetSettings	Additional settings to be added to targets generated from SwiftPackageManager.
projectOptions	Custom project configurations to be used for projects generated from SwiftPackageManager.

init(productTypes:productDestinations:baseSettings:targetSettings:projectOptions:)

public init(
    productTypes: [String: Product] = [:],
    productDestinations: [String: Destinations] = [:],
    baseSettings: Settings = .settings(),
    targetSettings: [String: SettingsDictionary],
    projectOptions: [String: Project.Options] = [:]
)

Creates PackageSettings instance for custom Swift Package Manager configuration.

• Parameters:
  • productTypes: The custom Product types to be used for SPM targets.
  • productDestinations: Custom destinations to be used for SPM products.
  • baseSettings: Additional settings to be added to targets generated from SwiftPackageManager.
  • targetSettings: Additional settings to be added to targets generated from SwiftPackageManager.
  • projectOptions: Custom project configurations to be used for projects generated from SwiftPackageManager.

Parameters

Name	Description
productTypes	The custom Product types to be used for SPM targets.
productDestinations	Custom destinations to be used for SPM products.
baseSettings	Additional settings to be added to targets generated from SwiftPackageManager.
targetSettings	Additional settings to be added to targets generated from SwiftPackageManager.
projectOptions	Custom project configurations to be used for projects generated from SwiftPackageManager.