8000 provide JSON Schema to allow validating config file · Issue #413 · tealdeer-rs/tealdeer · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

provide JSON Schema to allow validating config file #413

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

Open
KiaraGrouwstra opened this issue Feb 23, 2025 · 2 comments
Open

provide JSON Schema to allow validating config file #413

KiaraGrouwstra opened this issue Feb 23, 2025 · 2 comments

Comments

@KiaraGrouwstra
Copy link

Is your feature request related to a problem? Please describe.
We now have a description of the format, which helps users get going to tweak their own setup. However, we currently do not yet offer static checks to help validate these.

Describe the solution you'd like
It would be nice to offer a JSON Schema file for config validation, including by LSP language servers such as TOML's taplo.

Describe alternatives you've considered
not make mistakes

Additional context
n/a

@niklasmohrin
Copy link
Collaborator

Sounds like a cool idea! I wouldn't want to maintain the schema by hand, but I suppose there should be a way to generate at least a basic schema automatically using serde.

We would still have to figure out how exactly this should work, I can imagine that we would include the generated schema with the release, or maybe even have something like tldr --print-config-schema or so.

@niklasmohrin
Copy link
Collaborator

For reference, https://github.com/GREsau/schemars could work

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

No branches or pull requests

2 participants
0