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

feat: added json schema generation #35

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

FlyinPancake
Copy link
Contributor

I thought it would be nice to have a JSON schema for the configuration. This is still considered to be a draft, so any changes are welcome, perhaps moving the whole thing behind a feature flag.

This will help people who use LSPs with neovim or VSC to have a nicer experience having type completions with their config files

@FlyinPancake FlyinPancake marked this pull request as draft September 9, 2024 10:02
@LivacoNew
Copy link
Owner

Seems to work fine with my NeoVim/Taplo setup. I do think this shouldn't be in the actual runtime, and moreso done by us and bundled into releases for people to add in. Best way to do that is indeed hiding it behind a feature flag and then I can just run it myself on release, that way the release binaries don't have this bundled in.

@LivacoNew
Copy link
Owner

LivacoNew commented Sep 12, 2024

To-Do;

  • Gate behind feature flag
  • Update CI to generate these for each commit
  • Document flag in wiki
  • Add wiki page for it
  • Update default configs to include schema file - Only do this on full releases to prevent micromanaging it on each commit

@FlyinPancake
Copy link
Contributor Author

I don't know how the Wiki pages are handled, so I didn't do that one 😞.

Furthermore, the CI does not touch the default config as of now, I don't know how to do it without hacks.

@LivacoNew
Copy link
Owner

I'll see if I can figure out the config file stuff in a bit, probably just doing some funky stuff in the build scripts.

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.

2 participants