Skip to content

STRUCT

Workspace.GenerationOptions

Contents

  • Properties
    • enableAutomaticXcodeSchemes
    • autogeneratedWorkspaceSchemes
    • lastXcodeUpgradeCheck
    • renderMarkdownReadme
  • Methods
    • options(enableAutomaticXcodeSchemes:autogeneratedWorkspaceSchemes:lastXcodeUpgradeCheck:renderMarkdownReadme:)
swift
public struct GenerationOptions: Codable, Equatable, Sendable

Generation options allow customizing the generation of the Xcode workspace.

Properties

enableAutomaticXcodeSchemes

swift
public var enableAutomaticXcodeSchemes: Bool?

Enable or disable automatic generation of schemes by Xcode.

autogeneratedWorkspaceSchemes

swift
public var autogeneratedWorkspaceSchemes: AutogeneratedWorkspaceSchemes

Enable or disable automatic generation of Workspace schemes. If enabled, options to configure code coverage and test targets can be passed in via associated values.

lastXcodeUpgradeCheck

swift
public var lastXcodeUpgradeCheck: Version?

Allows to suppress warnings in Xcode about updates to recommended settings added in or below the specified Xcode version. The warnings appear when Xcode version has been upgraded. It is recommended to set the version option to Xcode's version that is used for development of a project, for example .lastXcodeUpgradeCheck(Version(13, 0, 0)) for Xcode 13.0.0.

renderMarkdownReadme

swift
public var renderMarkdownReadme: Bool

Allows to render markdown files inside the workspace including an .xcodesamples.plist inside it.

Methods

options(enableAutomaticXcodeSchemes:autogeneratedWorkspaceSchemes:lastXcodeUpgradeCheck:renderMarkdownReadme:)

swift
public static func options(
    enableAutomaticXcodeSchemes: Bool? = false,
    autogeneratedWorkspaceSchemes: AutogeneratedWorkspaceSchemes = .enabled(),
    lastXcodeUpgradeCheck: Version? = nil,
    renderMarkdownReadme: Bool = false
) -> Self

Released under the MIT License.