STRUCT

Settings

Contents

• Properties
  • base
  • configurations
  • defaultSettings
  • defaultConfiguration
• Methods
  • settings(base:debug:release:defaultSettings:defaultConfiguration:)
  • settings(base:configurations:defaultSettings:defaultConfiguration:)

public struct Settings: Equatable, Codable, Sendable

A group of settings configuration.

Properties

base

public var base: SettingsDictionary

A dictionary with build settings that are inherited from all the configurations.

configurations

public var configurations: [Configuration]

defaultSettings

public var defaultSettings: DefaultSettings

defaultConfiguration

public var defaultConfiguration: String?

Methods

settings(base:debug:release:defaultSettings:defaultConfiguration:)

public static func settings(
    base: SettingsDictionary = [:],
    debug: SettingsDictionary = [:],
    release: SettingsDictionary = [:],
    defaultSettings: DefaultSettings = .recommended,
    defaultConfiguration: String? = nil
) -> Settings

Creates settings with default.configurations Debug and Release

• Parameters:

  • base: A dictionary with build settings that are inherited from all the configurations.
  • debug: The debug configuration settings.
  • release: The release configuration settings.
  • defaultSettings: An enum specifying the set of default settings.
  • defaultConfiguration: The default configuration to be used when building the project from command-line.

• Note: To specify custom configurations (e.g. Debug, Beta & Release) or to specify xcconfigs, you can use the alternate static method .settings(base:configurations:defaultSettings:)

• seealso: Configuration

• seealso: DefaultSettings

Parameters

Name	Description
base	A dictionary with build settings that are inherited from all the configurations.
debug	The debug configuration settings.
release	The release configuration settings.
defaultSettings	An enum specifying the set of default settings.
defaultConfiguration	The default configuration to be used when building the project from command-line.

settings(base:configurations:defaultSettings:defaultConfiguration:)

public static func settings(
    base: SettingsDictionary = [:],
    configurations: [Configuration],
    defaultSettings: DefaultSettings = .recommended,
    defaultConfiguration: String? = nil
) -> Settings

Creates settings with any number of configurations.

• Parameters:

  • base: A dictionary with build settings that are inherited from all the configurations.
  • configurations: A list of configurations.
  • defaultSettings: An enum specifying the set of default settings.
  • defaultConfiguration: The default configuration to be used when building the project from command-line.

• Note: Configurations shouldn't be empty, please use the alternate static method .settings(base:debug:release:defaultSettings:) to leverage the default configurations if you don't have any custom configurations.

• seealso: Configuration

• seealso: DefaultSettings

Parameters

Name	Description
base	A dictionary with build settings that are inherited from all the configurations.
configurations	A list of configurations.
defaultSettings	An enum specifying the set of default settings.
defaultConfiguration	The default configuration to be used when building the project from command-line.