Latest 1.6.1
Homepage https://github.com/xcodeswift/xcproj
License MIT
Platforms osx 10.10, ios 8.0, requires ARC
Dependencies PathKit, AEXML
Authors ,



Swift Package Manager


Twitter: @xcodedotswift



License


Join the community on Spectrum

xcproj is a library written in Swift for parsing and working with Xcode projects. It’s heavily inspired in CocoaPods XcodeProj and xcode.

Continuous Integration ✅

  • Master: Build Status
  • Integration: Build Status

Motivation 💅

Being able to write command line scripts in Swift to update your Xcode projects configuration. Here you have some examples:

  • Add new Build phases.
  • Update the project Build Settings.
  • Create new Schemes.

Projects that benefit from xcproj ❤️

Project Description
XcodeGen Generate Xcode projects dynamically from a YAML file
xclint Lint the format of your Xcode projects
xctools Handy command line tools

Contribute 👨‍👩‍👧

  1. Git clone the repository [email protected]:xcodeswift/xcproj.git.
  2. Generate xcproj with swift package generate-xcodeproj.
  3. Open xcproj.xcodeproj.

Setup 🦋

Using Swift Package Manager

Add the dependency in your Package.swift file:

let package = Package(
    name: "myproject",
    dependencies: [
        .package(url: "https://github.com/xcodeswift/xcproj.git", .upToNextMajor(from: "0.2.0")),
        ],
    targets: [
        .target(
            name: "myproject",
            dependencies: ["xcproj"]),
        ]
)

Using Marathon

Edit your Marathonfile and specify the dependency in there:

https://github.com/xcodeswift/xcproj.git

Using CocoaPods

Edit your Podfile and specify the dependency:

pod "xcproj"

Using Carthage

Edit your Cartfile and specify the dependency:

github "xcodeswift/xcproj"

Note: xcproj is only available for macOS and iOS projects.

How to use xcproj 🐒

Xcode provides models that represent Xcode projects and are initialized by parsing the content from your project files. The generated models are classes that can be mutated at any time. These mutations in the models are kept in memory until they are persisted by writing them back to disk by writing either the XcodeProj or the XCWorkspace model. Modifications in your projects are usually executed in three steps:

  1. Read the project or workspace initializing a XcodeProj or a XCWorkspace object respectively.
  2. Modify those objects or any of its dependencies.
  3. Write it back to disk.
// Removing all frameworks build phases
let project = try! XcodeProj(path: "myproject.xcodeproj")
project.pbxproj.frameworksBuildPhases.removeAll()
try! project.write(path: "myproject.xcodeproj")

The diagram below shows the sructure of a Xcode project.

A XcodeProj has the following properties:

  • XCSharedData that contains the information about the schemes of the project.
  • XCWorkspace that defines the structure of the project workspace.
  • PBXProj that defines the strcuture of the project.

Among other properties, the most important one in the PBXProj object is Objects. Projects are defined by a list of those objects that can be classified in the following groups:

  • Build phases objects: Define the available build phases.
  • Target objects: Define your project targets and dependencies between them.
  • Configuration objects: Define the available configs and the link between them and the targets.
  • File objects: Define the project files, build files and groups.

All objects subclass PBXObject, and have an unique & deterministic reference. Moreover, they are hashable and conform the Equatable protocol.

diagram

You can read more about what each of these objects is for on the following link

Considerations

  • Objects references are used to define dependencies between objects. In the future we might rather use objects references instead of the unique identifier.
  • The write doesn’t validate the structure of the project. It’s up to the developer to validate the changes that have been done using xcproj.
  • New versions of Xcode might introduce new models or property that are not supported by xcproj. If you find any, don’t hesitate to open an issue on the repository.

Examples

Reading MyApp.xcodeproj

let project = try XcodeProj(path: "MyApp.xcodeproj")

Writing MyApp.xcodeproj

try project.write(path: "MyApp.xcodeproj")

Adding Home group inside Sources group

guard var sourcesGroup = project.pbxproj.objects.groups.first(where: {$0.value.name == "Sources"})?.value else { return }    
let homeGroup = PBXGroup(reference: "xxx", children: [], sourceTree: .group, path: "Home")
sourcesGroup.children.append(homeGroup.reference)
project.pbxproj.objects.addObject(homeGroup)

Add HomeViewController.swift file inside HomeGroup

let homeGroup = PBXGroup(reference: "xxx", children: [], sourceTree: .group, path: "Home")
let homeViewController = PBXFileReference(reference: "xxx", sourceTree: .group, path: "HomeViewController.swift")
homeGroup.children.append(homeViewController.reference)

Add HomeViewController.swift file to MyApp target

let homeViewController = PBXFileReference(reference: "xxx", sourceTree: .group, path: "HomeViewController.swift")
guard let sourcesBuildPhase = project.pbxproj
    .objects.nativeTargets
    .values
    .first(where: {$0.name == "MyApp"})
    .flatMap({  target -> PBXSourcesBuildPhase? in
        return project.pbxproj.objects.sourcesBuildPhases.values.first(where: { target.buildPhases.contains($0.reference) })
    }) else { return }
// PBXBuildFile is a proxy model that allows specifying some build attributes to the files
let buildFile = PBXBuildFile(reference: "yyy", fileRef: homeViewController.reference)
project.pbxproj.objects.addObject(buildFile)
sourcesBuildPhase.files.append(buildFile.reference)

Documentation 📄

You can check out the documentation on the following link. The documentation is automatically generated in every release by using Jazzy from Realm.

References 📚

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]










License

MIT License

Copyright (c) 2017 xcode.swift

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Latest podspec

{
    "name": "xcproj",
    "version": "1.6.1",
    "summary": "Read/Modify/Write your Xcode projects",
    "homepage": "https://github.com/xcodeswift/xcproj",
    "social_media_url": "https://twitter.com/xcodeswiftio",
    "license": "MIT",
    "authors": [
        "Pedro Pinu00f1era",
        "Yonas Kolb"
    ],
    "source": {
        "git": "https://github.com/xcodeswift/xcproj.git",
        "tag": "1.6.1"
    },
    "requires_arc": true,
    "platforms": {
        "osx": "10.10",
        "ios": "8.0"
    },
    "source_files": "Sources/**/*.{swift}",
    "dependencies": {
        "PathKit": [
            "~> 0.8"
        ],
        "AEXML": [
            "~> 4.1"
        ]
    },
    "pushed_with_swift_version": "4.0"
}

Pin It on Pinterest

Share This