[Feature]:

Abierto
#26 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
swift
Área
backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Swift
Estrellas
544
Forks
36
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apple/xcode-project-format

Todos los issues de apple/xcode-project-format

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.