[Feature]:
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
Research direction
The issue describes the project’s overall purpose and capabilities, but does not specify a feature to implement or name files, tests, or an entry point. Read CONTRIBUTING.md to learn the project’s accepted scope, then clarify which Xcode project format capability is missing and how it should be verified before starting work.
Written by the indexing model from the issue text.
Description
Describe the feature
xcode-project-format
xcode-project-format is a Swift library for reading, writing, and manipulating Xcode's JSON-based project.xcproj format. It models the format as a rich set of value types nested under a single namespace, XCSchema, so consumers get precise, typed access to a project's structure instead of hand-parsing JSON.
The goal is to give the ecosystem a shared, accurate model of the Xcode project format — so tools like generators, linters, verifiers, and validators don't each have to reverse-engineer the format from scratch.
The package also ships xcprojformatter, a small CLI tool built on the library.
Getting started
Requirements
Swift 6.1 or later
macOS 14 or later (the library also builds on non-Darwin platforms; see Package.swift)
Installation
Add the package as a dependency in your Package.swift:
dependencies: [
.package(url: "https://github.com/apple/xcode-project-format/", from: "0.1.0")
]
Usage
import XcodeProjectFormat
func listTargets(in projectURL: URL) throws {
let projectData = try Data(contentsOf: projectURL)
let project = try XCSchema.Project(jsonRepresentation: projectData)
for target in project.targets {
print(target.name)
}
}
You'll find types for folders, file references, groups, targets, build phases, build rules, and the rest of the Xcode project model within this package.
Documentation
The project documentation is available at Swift Package Index.
To preview it locally:
swift package add-dependency https://github.com/swiftlang/swift-docc-plugin --from 1.5.0
swift package --disable-sandbox preview-documentation
Contributing
We welcome contributions within a defined scope. See CONTRIBUTING.md for what we accept, what's out of scope for now, and how to get started.
Support
GitHub Issues — bug reports, feature requests, and questions
License
Licensed under the Apache License 2.0 with Runtime Library Exception.
Use case
xcode-project-format
xcode-project-format is a Swift library for reading, writing, and manipulating Xcode's JSON-based project.xcproj format. It models the format as a rich set of value types nested under a single namespace, XCSchema, so consumers get precise, typed access to a project's structure instead of hand-parsing JSON.
The goal is to give the ecosystem a shared, accurate model of the Xcode project format — so tools like generators, linters, verifiers, and validators don't each have to reverse-engineer the format from scratch.
The package also ships xcprojformatter, a small CLI tool built on the library.
Getting started
Requirements
Swift 6.1 or later
macOS 14 or later (the library also builds on non-Darwin platforms; see Package.swift)
Installation
Add the package as a dependency in your Package.swift:
dependencies: [
.package(url: "https://github.com/apple/xcode-project-format/", from: "0.1.0")
]
Usage
import XcodeProjectFormat
func listTargets(in projectURL: URL) throws {
let projectData = try Data(contentsOf: projectURL)
let project = try XCSchema.Project(jsonRepresentation: projectData)
for target in project.targets {
print(target.name)
}
}
You'll find types for folders, file references, groups, targets, build phases, build rules, and the rest of the Xcode project model within this package.
Documentation
The project documentation is available at Swift Package Index.
To preview it locally:
swift package add-dependency https://github.com/swiftlang/swift-docc-plugin --from 1.5.0
swift package --disable-sandbox preview-documentation
Contributing
We welcome contributions within a defined scope. See CONTRIBUTING.md for what we accept, what's out of scope for now, and how to get started.
Support
GitHub Issues — bug reports, feature requests, and questions
License
Licensed under the Apache License 2.0 with Runtime Library Exception.
Alternatives considered
No response
Additional context
xcode-project-format
xcode-project-format is a Swift library for reading, writing, and manipulating Xcode's JSON-based project.xcproj format. It models the format as a rich set of value types nested under a single namespace, XCSchema, so consumers get precise, typed access to a project's structure instead of hand-parsing JSON.
The goal is to give the ecosystem a shared, accurate model of the Xcode project format — so tools like generators, linters, verifiers, and validators don't each have to reverse-engineer the format from scratch.
The package also ships xcprojformatter, a small CLI tool built on the library.
Getting started
Requirements
Swift 6.1 or later
macOS 14 or later (the library also builds on non-Darwin platforms; see Package.swift)
Installation
Add the package as a dependency in your Package.swift:
dependencies: [
.package(url: "https://github.com/apple/xcode-project-format/", from: "0.1.0")
]
Usage
import XcodeProjectFormat
func listTargets(in projectURL: URL) throws {
let projectData = try Data(contentsOf: projectURL)
let project = try XCSchema.Project(jsonRepresentation: projectData)
for target in project.targets {
print(target.name)
}
}
You'll find types for folders, file references, groups, targets, build phases, build rules, and the rest of the Xcode project model within this package.
Documentation
The project documentation is available at Swift Package Index.
To preview it locally:
swift package add-dependency https://github.com/swiftlang/swift-docc-plugin --from 1.5.0
swift package --disable-sandbox preview-documentation
Contributing
We welcome contributions within a defined scope. See CONTRIBUTING.md for what we accept, what's out of scope for now, and how to get started.
Support
GitHub Issues — bug reports, feature requests, and questions
License
Licensed under the Apache License 2.0 with Runtime Library Exception.
- Dominant language
- Swift
- Stars
- 544
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apple/xcode-project-format
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Negative encoding value crashes the decoderPossibly taken @nassersala claimed this 59 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
[Bug]: Decoder does not restore the parent value after decoding a childPossibly taken @hippi345 claimed this 31 days ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
XcodeOpenenhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
[Feature]:Openenhancement
Difficulty 1/5 Under an hour Newbie friendliness 15/100
All issues in apple/xcode-project-format
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
OneBusAway/onebusaway-ios#1749 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Crash when searching subtitles with the assrt provider (force unwrap of nil in AssrtSubtitle.swift)Openbug: crash feature: subtitle
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 Under an hour Newbie friendliness 62/100