Skip to content

[proposal] Please provide us a JSON schema for the new arduino-cli.yaml config file #587

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

Closed
kittaakos opened this issue Feb 19, 2020 · 1 comment · Fixed by #2068
Closed
Assignees
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@kittaakos
Copy link
Contributor

Feature request

Current behavior

The new arduino-cli.yaml config file, the new Settings API everything works perfectly 💪, however, I am missing the JSON schema for the configuration file. As a consumer of the CLI, I want to programmatically validate the config file before I use it.

As a start, the actual JSON schema could be released with the CLI, inside the archive. Once it gets rock solid, perhaps it could be published to http://schemastore.org/json/.

Expected behavior

Environment

  • CLI version (output of arduino-cli version):
  • OS and platform:

Additional context

@umbynos
Copy link
Contributor

umbynos commented Feb 6, 2023

AC: Structural validation of the file should be sufficient. The process should be as automated as possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants