[Feature]:

Open
#26 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
swift
Domain
backend

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

enhancement
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

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apple/xcode-project-format

All issues in apple/xcode-project-format

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.