Create JSON Schema for YAML File

[mkdjr]

Co-author: @jassielof

I took a pass at creating a JSON schema based on the Hayagriva specification. This will likely close #33!

Please provide any and all feedback! This is my first time creating a JSON schema.

This PR might be related to issue #134.

Outstanding Items (copied from below for convenience)

• Are the tests in tests/schema.rs compliant with the package's architecture?
• Does the title field still accept a translator sub-field (see: Create JSON Schema for YAML File #192 (comment))?
• Upload to the JSON Schema Store, as suggested by @Freed-Wu. See https://github.com/SchemaStore/schemastore/blob/master/CONTRIBUTING.md for more information.

[EpicEricEE]

The specification is not fully up to date as the fields added in #102 (abstract, annote and genre) aren't included and are thus also missing here.

[mkdjr]

The specification is not fully up to date as the fields added in #102 (abstract, annote and genre) aren't included and are thus also missing here.

Thanks for pointing this out! I added them to the schema and started a PR to add them to the documentation (#194).

[reknih]

I found a few mismatches with basic.yml. I think that before merging this, we should at a test that checks whether basic.yml (which is normative) passes the schema. We can do this using jsonschema.

[reknih]

Does not support the object mode:

    title:
        value: "ZygOS: Achieving Low Tail Latency for Microsecond-Scale Networked Tasks"
        verbatim: true
        # also possible: sentence-case, title-case, short

[mkdjr]

Do sentence-case and title-case still need to be handled? I just saw that they were removed for any formattable string in 0.4.0. Is that still the case?

If so, basic.yml might need updating, as it lists certain title entries with those fields.

hayagriva/tests/data/basic.yml

Line 42 in edec836

sentence-case: There’s a lot we still don’t know about Libra

There's also an entry in basic.yml that uses a translation field. Is that still in use?

hayagriva/tests/data/basic.yml

Line 227 in edec836

translation: Renaissance, The Unrooted

Feel free to point me towards somewhere in the codebase where I could investigate myself; It's been a while since I've worked on this and don't want to be too burdensome with questions.

[Freed-Wu]

And remember upload it to schemastore 😄

[jassielof]

I'd like to contribute to this PR, since I like Hayagriva and am currently working with it for my thesis. How could I help?

[PgBiel]

I'd like to contribute to this PR, since I like Hayagriva and am currently working with it for my thesis. How could I help?

We don't have a confirmation yet as to whether these changes will be merged or whether further modifications could be needed, so we can't guarantee a speedy merge, but if you're willing to pick up this work, you're free to address the reviews in your own branch and submit a new PR.

[mkdjr]

Finally got back around to working on this! There are three is one things on my mind right now w.r.t. improving the schema so that it can be published.

Person Fields

Do all fields referring to individuals (author, editor, affiliated) have the same subfields (name, given-name, prefix, suffix, alias)?

If so, I can reference a common subschema for fields of this type.

2025-02-24: Addressed by @jassielof's improvements to the schema.

Affiliated Roles

After working on making the values of the type field case insensitive, I realized that the role field for affiliated individuals may also need to be case insensitive.

Is this the case?

2025-02-24: Addressed by @jassielof's improvements to the schema.

Tests

I added tests for validating the schema itself, as well as validating basic.yml. I put the tests under tests/schema.rs and added jsonschema as a development dependency in cargo.toml.

Let me know if any of that should be changed to comply with the package's architecture.

[gwennlbh]

We should probably also mention # yaml-language-server: $schema=... and include it in the examples.

It works with the redhat yaml LSP, which I used on nvim before and also works on VS Code (both combined must cover a substential part of Typst users, outside of Typst.app)