feat: add a schema for validate-pyproject

[henryiii]

Adding a schema, generation from our dataclass-based config system, and the expected plugin.

[henryiii]

CC @abravalheri if you'd like to take a look. :)

[abravalheri]

Sorry for the delay @henryiii.

I had a look on the parts that I have some knowledge (and I admit I skipped the implementation details to generate a JSON schema 😝), but things look fine to me.

Specifically, I believe that "validate_pyproject.tool_schema".scikit-build = "scikit_build_core.settings.skbuild_schema:get_skbuild_schema" should work fine with validate-pyproject.

If you want to add any integration test, something you can try is (ref):

    def test_valid(valid_example: dict):
        validator = validate_pyproject.api.Validator()
        assert validator(valid_example) is not None

    def test_invalid(invalid_example: dict):
        validator = validate_pyproject.api.Validator()
        with pytest.raises(Exception):
            validator(invalid_example)

[abravalheri]

sphinx-jsonschema is the best I could find in the "sphinx space" for JSON schemas, but sometimes it still can be difficult to read/interpret the generated HTML (specially when the level of nesting is high).

There might be better alternatives in the javascript universe, but that is difficult to integrate with sphinx or with pip install¹.

If you ever find a different alternative, please let me know.

Footnotes

1. It there is something I hate doing is setting up a nodejs environment in the CI just to be able to run a couple nodejs-based CLI tools... ↩