XcodeProj

public final class XcodeProj : Equatable

Model that represents a .xcodeproj project.

  • Project workspace

    Declaration

    Swift

    public var workspace: XCWorkspace
  • .pbxproj representatino

    Declaration

    Swift

    public var pbxproj: PBXProj
  • Shared data.

    Declaration

    Swift

    public var sharedData: XCSharedData?
  • Declaration

    Swift

    public static func == (lhs: XcodeProj, rhs: XcodeProj) -> Bool
  • Writes project to the given path.

    Declaration

    Swift

    public func write(path: AbsolutePath, override: Bool = true) throws

    Parameters

    path

    path to .xcodeproj file.

    override

    if project should be overridden. Default is true. If false will throw error if project already exists at the given path.

  • Returns workspace file path relative to the given path.

    Declaration

    Swift

    public static func workspacePath(_ path: AbsolutePath) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    Return Value

    worspace file path relative to the given path.

  • Writes workspace to the given path.

    Declaration

    Swift

    public func writeWorkspace(path: AbsolutePath, override: Bool = true) throws

    Parameters

    path

    path to .xcodeproj file.

    override

    if workspace should be overridden. Default is true. If false will throw error if workspace already exists at the given path.

  • Returns project file path relative to the given path.

    Declaration

    Swift

    public static func pbxprojPath(_ path: AbsolutePath) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    Return Value

    project file path relative to the given path.

  • Writes project to the given path.

    Declaration

    Swift

    public func writePBXProj(path: AbsolutePath, override: Bool = true) throws

    Parameters

    path

    path to .xcodeproj file.

    override

    if project should be overridden. Default is true. If false will throw error if project already exists at the given path.

  • Returns shared data path relative to the given path.

    Declaration

    Swift

    public static func sharedDataPath(_ path: AbsolutePath) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    Return Value

    shared data path relative to the given path.

  • Returns schemes folder path relative to the given path.

    Declaration

    Swift

    public static func schemesPath(_ path: AbsolutePath) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    Return Value

    schemes folder path relative to the given path.

  • Returns scheme file path relative to the given path.

    Declaration

    Swift

    public static func schemePath(_ path: AbsolutePath, schemeName: String) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    schemeName

    scheme name

    Return Value

    scheme file path relative to the given path.

  • Writes all project schemes to the given path.

    Declaration

    Swift

    public func writeSchemes(path: AbsolutePath, override: Bool = true) throws

    Parameters

    path

    path to .xcodeproj file.

    override

    if project should be overridden. Default is true. If true will remove all existing schemes before writing. If false will throw error if scheme already exists at the given path.

  • Returns debugger folder path relative to the given path.

    Declaration

    Swift

    public static func debuggerPath(_ path: AbsolutePath) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    schemeName

    scheme name

    Return Value

    debugger folder path relative to the given path.

  • Returns breakpoints plist path relative to the given path.

    Declaration

    Swift

    public static func breakPointsPath(_ path: AbsolutePath) -> AbsolutePath

    Parameters

    path

    .xcodeproj file path

    schemeName

    scheme name

    Return Value

    breakpoints plist path relative to the given path.

  • Writes all project breakpoints to the given path.

    Declaration

    Swift

    public func writeBreakPoints(path: AbsolutePath, override: Bool = true) throws

    Parameters

    path

    path to .xcodeproj file.

    override

    if project should be overridden. Default is true. If true will remove all existing debugger data before writing. If false will throw error if breakpoints file exists at the given path.