-
Notifications
You must be signed in to change notification settings - Fork 18
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
Remove the JSON from Qleverfile #117
Comments
@tpluscode Thank you for the comment. Can you be more specific on why you find the JSON awkward? By the way, the |
First thing is readability. JSON also feels alien to the textual format used. Like... putting binary columns in a relational database. And the current formatting requires to jump some hoops to stringify it just right. From JavaScript, this is not exactly |
@tpluscode Coming back to this after three stressful weeks. I am not a fan of the "dynamic" sections. But I agree that YAML would be a natural format. When we started, we wanted something that is as simple as possible and no more complex than necessary. YAML is the way to go when you have multiline stuff, where indentation is important for readability. For most Qleverfiles, this is what we want now (either sequences of commands or SPARQL queries or both). The switch will be a bit annoying because we will have to support the old format for a while. But that's life. |
@hannahbast let's talk about how we can do that together. We can contribute validation & things around it so it becomes easier to work with it. @tpluscode and @ludovicm67 have ideas/experience in it. |
I have been looking into Qleverfiles recently and I find the JSON keys a little awkward.
Take the
[index]
section from wikidata exampleI'd propose to allow "dynamic" sections to break up the complex objects from
MULTI_INPUT_JSON
andSETTINGS_JSON
Alternatively, you could support YAML instead. That would for example allow you to publish a JSON Schema for validation and editor suggestions
PS
The standard way to write locale in this case would be like
en-US
. Curious why it's broken up as two keysThe text was updated successfully, but these errors were encountered: