-
-
Notifications
You must be signed in to change notification settings - Fork 145
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
feat: schema generator for basic & advanced configs #310
base: master
Are you sure you want to change the base?
Conversation
Hopefully we can make this dynamic / auto-generated later.
Im not sure if this is really necessary, We already have to add config values in the docs it would be really annoying to have to add them in 3 different places |
We could auto-generate the docs from these schemas. Obviously you don't get auto complete from the docs, so it's probably better if we do that instead. |
I like to have examples and explain in-depth how things work. Which can be done in the docs |
JSON schemas also have the "example" array in each item, so you can give examples like "properties": {
"type": "string",
"examples": ["yes", "awawhawfrjoiwaojif"]
} |
I meant larger and more fancy examples using markdown. Im sorry but i don't really see the point in this PR. We now have split the docs to its eaiser to maintain |
The point of this PR is basically auto-completion. |
Also, I went through all of the config docs, and it seems to just be a few lists here, maybe a info, warning, tip etc. there, and I don't see any images or anything fancy. |
I wonder if it is possible to generate Vitepress sites using json schemas |
Description
Adds a schema generator so you can have autocomplete.
To use this in configs, run the generator script and add:
#:schema ./configuration.schema.json
for basic configs#:schema ./features.schema.json
for advanced configsThis uses the schema directive in Even Better TOML (linking to the Open VSX registry instead of the normal extension registry because it's outdated on the normal / default Visual Studio marketplace) / Taplo
Testing
Procedure:
Checklist
Things need to be done before this Pull Request can be merged.