Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phimage/xcodeprojkit
Parse project file and write it to open step format.
https://github.com/phimage/xcodeprojkit
openstep parser plist swift xcode xcodeproj xcodeproject
Last synced: 23 days ago
JSON representation
Parse project file and write it to open step format.
- Host: GitHub
- URL: https://github.com/phimage/xcodeprojkit
- Owner: phimage
- License: mit
- Created: 2017-08-02T20:36:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T22:32:02.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T21:11:43.331Z (6 months ago)
- Topics: openstep, parser, plist, swift, xcode, xcodeproj, xcodeproject
- Language: Swift
- Homepage:
- Size: 342 KB
- Stars: 14
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# XcodeProjKit
[](http://mit-license.org)
[](https://developer.apple.com/resources/)
[](https://developer.apple.com/swift)
[](https://github.com/phimage/XcodeProjKit/actions/workflows/swift.yml)
[](https://github.com/sponsors/phimage)
Parse project file and write it to open step format.
Work also on simple plist in xml, binary or json format.
## Project description
Plist files could be in binary, xml or open step format. All could be parsed natively using `PropertyListSerialization`.
:warning: But you cannot be written back into open step format.
This project aim to
- check xcode project file. Error could occurs after merging file using git.
- rewrite the file into open step format, if you edit it using some command line like [plutil](https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/plutil.1.html).
Alternatively you can use apple private framework DVTFoundation, like [Xcodeproj](https://github.com/CocoaPods/Xcodeproj) do.
## Usage
### Read
```swift
let xcodeProj = try XcodeProj(url: url)
let project: PBXProject = xcodeProj.project
let mainGroup: PBXGroup? = project.mainGroup
let targets: [PBXNativeTarget] = project.targets
let buildConfigurationList: XCConfigurationList? = project.buildConfigurationList
```
### Write
```swift
try xcodeProj.write(to: newURL, format: .openStep)
```
## Setup
### Using Swift Package Manager
```swift
let package = Package(
name: "MyProject",
dependencies: ["
.package(url: "https://github.com/phimage/XcodeProjKit.git", from: "3.0.0"),
],
targets: [
.target(
name: "MyProject",
dependencies: ["XcodeProjKit"]),
]
)
```
### Using Carthage
Carthage is a decentralized dependency manager for Objective-C and Swift.
Add the project to your Cartfile.
```
github "phimage/XcodeProjKit"
```
Run carthage update and follow the additional steps in order to add MomXML to your project.
### Using Cocoapod
Add the project to your Podfile.
```
pod "XcodeProjKit"
```
### References
- http://danwright.info/blog/2010/10/xcode-pbxproject-files/
- http://www.monobjc.net/xcode-project-file-format.html
- https://github.com/apple/swift-package-manager/tree/master/Sources/Xcodeproj
### Thanks
- @Karumi for the test files : https://github.com/Karumi/Kin
- @allu22 for the PR
### Used by
- [iblinter](https://github.com/IBDecodable/IBLinter) a command line tool to check your storyboards
- [plistconvert](https://github.com/phimage/plistconvert) a command line tool to convert plist and pbxproj to different supported format (work on linux and macOS)
- [xprojup](https://github.com/phimage/xprojup) a command line tool to update xcode proj to latest version (to avoid warnings)
- [punic](https://github.com/phimage/punic) a command line tool too remove the usage of binary frameworks introduced by [Carthage](https://github.com/Carthage/Carthage) and to go back to developpement with sources.
### Contribute
- Fork
- Make PR