allstar icon indicating copy to clipboard operation
allstar copied to clipboard

Provide offical config schema

Open UniquePixels opened this issue 1 year ago • 4 comments

IDEs provide code completion when schemas are provided for yaml files. It would be helpful to have official schemas. I found this: https://github.com/yu-iskw/allstar-jsonschema however the project should provide official schema to ensure compliance.

UniquePixels avatar Nov 27 '24 14:11 UniquePixels

I, too, would like to see schemae provided for the configuration files, possibly shared with the JSON Schema Store (which accepts YAML, despite the name). Not only would this allow supported editors and IDEs to hint at proper usage, but it would allow tools such as @chris48s's v8r -- which is included as one of the linters in MegaLinter -- to validate configuration files. This may help with issue such as those in #158 where it can be challenging to acquire feedback to debug invalid configurations.

wesley-dean-flexion avatar Jan 28 '25 14:01 wesley-dean-flexion

This issue has been marked stale because it has been open for 60 days with no activity.

github-actions[bot] avatar Oct 12 '25 02:10 github-actions[bot]

I, too, drafted a set of schema files. They're generated from the Allstar source code and add descriptions based on source comments. If someone wants to take a look and sanity check what's there, I would appreciate it. I'm also open to contributing these files to this repo, if that's wanted.

https://github.com/wesley-dean/allstar-schema

wesley-dean avatar Oct 14 '25 17:10 wesley-dean

This issue has been marked stale because it has been open for 60 days with no activity.

github-actions[bot] avatar Dec 14 '25 02:12 github-actions[bot]