Add support for native JSON5 loading of schemas?

[mondeja]

This would be really great because usually there are complex schemas that can only be documented inside multiline comments. There is a $comment keyword added in the draft 7 of JSON Schema but I find it useless for documentation, mainly because the lack of support for structured patterns like lists or code blocks.

The unique problem that I see in a possible implementation is how to parse the null, NaN and Infinity keywords of JSON5, which are beyond JSON limitations. The safest would be, I think, to raise an error if found.

Anyways, I'm not sure if this is beyond of the scope of this project.

Personal current workaround

I'm currently documenting schemas in files apart, but I'm planning to download the JSON5 files in a local folder caching and converting to JSON them, adding that folder to a .gitignore file.

[sirosen]

If you install pyjson5 or json5, you'll be able to run on json5 files.

Is this request different from the existing support? The word "native" can mean different things to different people.

[mondeja]

Sorry, maybe I haven't been clear enough. I'm asking for reading of JSON5 schema files, not running using JSON schemas against JSON5 instance files. For example: check-jsonschema pyproject.toml --schemafile pyproject-schema.json5

[sirosen]

Ah, no, you were perfectly clear. I was just reading this wrong thinking "but we already have JSON5 support!"
That's my mistake.

I'll need to think about this a little bit. The support for YAML schema definitions is already a potential sticking point for users (see #80 ).
For the short-term, to avoid surprises, there's a pretty hacked-in warning for YAML file $ref usages:

check-jsonschema/src/check_jsonschema/loaders/schema/resolver.py

Line 11 in aec38b3

if uri.endswith(".yaml") or uri.endswith(".yml"):

So I need to consider whether or not this can be cleaned up and turned into something more like the instance loading (which is extensible to additional formats by design).

[sirosen]

The parser code is now better shared between instances and schemas, and JSON5 parsing of schemas is now supported.

I've just released this as v0.17.0. Please let me know if you see any trouble with it!