Skip to content

feat(schema): Add project spec JSON Schema #1632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philprime wants to merge 1 commit into
base: master
Choose a base branch
from
+2,206 −0
Open

feat(schema): Add project spec JSON Schema #1632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,24 @@ targets:
```
A project would be created with 2 connected targets, with all the required configurations and build settings. See the [Project Spec](Docs/ProjectSpec.md) documentation for all the options you can specify, and [Usage](Docs/Usage.md) for more general documentation.

## Schema validation

XcodeGen provides a JSON Schema for validating project specs and enabling editor features such as code completion. Reference the latest schema in a YAML project spec with:

```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/yonaskolb/XcodeGen/master/schema/xcodegen.schema.json
name: MyProject
```

For a JSON project spec, use the `$schema` property:

```json
{
"$schema": "https://raw.githubusercontent.com/yonaskolb/XcodeGen/master/schema/xcodegen.schema.json",
"name": "MyProject"
}
```

## Installing

Make sure the latest stable (non-beta) version of Xcode is installed first.
Expand Down
Loading