Skip to content
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.

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

add json-schema #1357

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add json-schema #1357

wants to merge 1 commit into from

Conversation

Kila2
Copy link

@Kila2 Kila2 commented May 9, 2023

add json schema files.

@yonaskolb
Copy link
Owner

Wow looks like a lot of work went into these. How did you create them?
What is your intention of adding them here? They would serve as a good source of truth for documentation, but at the moment they just duplicate information.
I'm worried about the maintenance work these would create if these weren't generated, or these weren't being used to generate documentation.

@Kila2
Copy link
Author

Kila2 commented May 9, 2023

Wow looks like a lot of work went into these. How did you create them? What is your intention of adding them here? They would serve as a good source of truth for documentation, but at the moment they just duplicate information. I'm worried about the maintenance work these would create if these weren't generated, or these weren't being used to generate documentation.

  • Except for xcode_settings.json, all the files are handwritten.
  • I wanted to have the ability to provide completion, suggestions, and automatic validation when viewing or writing project.yml when using VSCode with the Yaml plugin. Therefore, these files were created based on projectSpec.md.
  • Perhaps the documentation can be regenerated based on this file. Currently, the files cover most cases, but there are still some small parts that have not been added to the json-schema, such as the Test Target Object.

The current completion level is sufficient for my needs. I have submitted a PR to provide additional features.

@imWildCat
Copy link

I'm worried about the maintenance work these would create if these weren't generated, or these weren't being used to generate documentation.

That's a valid concern. But currently the configuration structs are usually not Codable, which makes it not feasible to generate the JSON schema in the short term.

As we don't usually introduce breaking changes in the format of project.yml, it is not a bad idea to merge handwritten schema to this repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants