tuist/xcodeproj


📝 Read, update and write your Xcode projects

License: MIT

Language: Swift

Keywords: ios, macos, objective-c, swift, swift-3, swift-4, xcode, xcodeproj


XcodeProj

CircleCI Swift Package Manager Release Code Coverage Slack License

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


Projects Using XcodeProj

Project Repository
Tuist github.com/tuist/tuist
Sourcery github.com/krzysztofzablocki/Sourcery
ProjLint github.com/JamitLabs/ProjLint
XcodeGen github.com/yonaskolb/XcodeGen

If you are also leveraging XcodeProj in your project, feel free to open a PR to include it in the list above.

Installation

Swift Package Manager

Add the dependency in your Package.swift file:

let package = Package(
    name: "myproject",
    dependencies: [
        .package(url: "https://github.com/tuist/xcodeproj.git", .upToNextMajor(from: "6.7.0")),
        ],
    targets: [
        .target(
            name: "myproject",
            dependencies: ["XcodeProj"]),
        ]
)

Carthage

Only macOS

# Cartfile
github "tuist/xcodeproj" ~> 6.7.0

CocoaPods

pod 'xcodeproj', '~> 6.7.0'

Scripting

Using swift-sh you can automate project-tasks using scripts, for example we can make a script that keeps a project’s version key in sync with the current git tag that represents the project’s version:

#!/usr/bin/swift sh
import Foundation
import XcodeProj  // @tuist ~> 6.7.0
import PathKit

guard CommandLine.arguments.count == 3 else {
    let arg0 = Path(CommandLine.arguments[0]).lastComponent
    fputs("usage: \(arg0) <project> <new-version>\n", stderr)
    exit(1)
}

let projectPath = Path(CommandLine.arguments[1])
let newVersion = CommandLine.arguments[2]
let xcodeproj = try XcodeProj(path: projectPath)
let key = "CURRENT_PROJECT_VERSION"

for conf in xcodeproj.pbxproj.buildConfigurations where conf.buildSettings[key] != nil {
    conf.buildSettings[key] = newVersion
}

try xcodeproj.write(path: projectPath)

You could then store this in your repository, for example at scripts/set-project-version and then run it:

$ scripts/set-project-version ./App.xcodeproj 1.2.3
$ git add App.xcodeproj
$ git commit -m "Bump version"
$ git tag 1.2.3

Future adaption could easily include determining the version and bumping it automatically. If so, we recommend using a library that provides a Version object.

Documentation 📝

Want to start using XcodeProj? Start by digging into our documentation which will help you get familiar with the API and get to know more about the Xcode projects structure.

References 📚

Contributing

  1. Git clone the repository git@github.com:tuist/xcodeproj.git.
  2. Generate xcodeproj with swift package generate-xcodeproj.
  3. Open XcodeProj.xcodeproj.

License

XcodeProj is released under the MIT license. See LICENSE for details.

FOSSA Status

Open source

Tuist is a proud supporter of the Software Freedom Conservacy

Become a Conservancy Supporter!

Project Statistics

Sourcerank 8
Repository Size 16.9 MB
Stars 914
Forks 95
Watchers 43
Open issues 15
Dependencies 84
Contributors 41
Tags 49
Created
Last updated
Last pushed

Top Contributors See all

Yonas Kolb Pedro Piñera Buendía Brian T. Kelley Toshihiro Suzuki Vadim Ilya Puchka Dave Lee Artem Novichkov Alvar Hansen Derek Clarkson Alex Rupérez Ian Leitch Max Howell Jakub Turek Michael Gubik Keith Smiley Keith Smiley Sam Duke Aseem Sood Rui Costa

Packages Referencing this Repo

xcodeproj
Read/Modify/Write your Xcode projects
Latest release 6.3.0 - Updated - 914 stars
xcproj
Read/Modify/Write your Xcode projects
Latest release 4.3.0 - Updated - 914 stars

Recent Tags See all

6.7.0 March 31, 2019
6.6.0 March 01, 2019
6.5.0 February 02, 2019
6.4.0 January 06, 2019
6.3.0 October 18, 2018
6.2.0 October 12, 2018
6.1.0 October 10, 2018
6.0.1 September 24, 2018
4.3.1 September 19, 2018
6.0.0 September 18, 2018
6.0.0 September 18, 2018
5.2.0 September 14, 2018
5.1.1 September 11, 2018
5.1.0 September 10, 2018
5.0.0 August 17, 2018

Interesting Forks See all

mxcl/xcodeproj
📝 Read, update and write your Xcode projects
Swift - MIT - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-04-02 10:03:59 UTC

Login to resync this repository