[Feature]:

Ouverte
#26 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
20/100
Type d'issue
Fonctionnalité
Clarté
À clarifier
Activité
Active
Stack technique
swift
Domaine
backend

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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.

Langage dominant
Swift
Étoiles
544
Forks
36
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de apple/xcode-project-format

Toutes les issues de apple/xcode-project-format

Issues similaires

Plus d'issues Swift

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.