atuinsh / atuin

✨ Magical shell history
https://atuin.sh
MIT License
18.54k stars 520 forks source link

JSON schema for `config.toml` #2161

Closed niklasravnsborg closed 1 week ago

niklasravnsborg commented 1 week ago

Having a schema for the config.toml file that Atuin uses would be highly beneficial. This would not only facilitate easier editing of configurations but could also enable auto-generation of documentation tables or other useful outputs.

Schemas can be integrated using the $schema key to enable editor completions:

"$schema" = 'https://example.org/schema.json'

For reference, here are a few example schema files:

Resources for creating a schema:

ellie commented 1 week ago

Hey! Thanks for the issue

This one is a dupe of #1626

I'm aware of what they are and am not opposed to having one, but I'd rather not have it something that we have to maintain manually