git.iko.soy/typeable/hjsonschema
on doctest help sign in
typeable/hjsonschema/README.md
65 lines 3.1 kB history raw
1![hjsonschema logo](./logo.jpg)
3A Haskell implementation of the most commonly used [JSON Schema](http://json-schema.org/) specification ([Draft 4](https://github.com/json-schema-org/json-schema-spec/wiki/Specification-Links#draft-4)).
5[Hackage](https://hackage.haskell.org/package/hjsonschema) / [GitHub](https://github.com/seagreen/hjsonschema) / [Travis CI](https://travis-ci.org/seagreen/hjsonschema)
7# Notes
9+ As of 2017 [json-schema-org](https://github.com/json-schema-org/json-schema-spec) has begun releasing new drafts of the standard. Once this work stabilizes `hjsonschema` will add coverage for the latest draft.
11+ Requires [pcre](http://www.pcre.org/) (`pkgs.pcre` in Nixpkgs).
13+ Schemas with circular references can cause infinite loops. hjsonschema does loop detection but it may not be solid yet -- please open an issue if you find a situation where it fails.
15# Example
17See [here](https://github.com/seagreen/hjsonschema/blob/master/examples/Simple.hs).
19# Tests
21Run all tests:
23`stack test`
25Run only local tests:
27`stack test hjsonschema:local`
29Run remote tests (makes GETs to json-schema.org, also temporarily starts an HTTP server on port 1234):
31`stack test hjsonschema:remote`
33# Details
35## Goals
37+ Be a correct and fast implementation of the spec.
39+ Be a useful reference for implementers in other languages. Haskell's high level nature, expressive type system and referential transparency suit this purpose well.
41## Good Parts
43+ Passes all the required tests in the [language agnostic test suite](https://github.com/json-schema/JSON-Schema-Test-Suite). NOTE: due to an issue with the test suite this isn't true at the moment, see [#175](https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/175).
45+ Very modular, which should make it easy to support future versions of the specification.
47## Bad Parts
49+ Uses the [pcre-heavy](https://hackage.haskell.org/package/pcre-heavy) regular expression library for the "pattern" validator. It should use a library based on the ECMA 262 regex dialect, which the [spec](http://json-schema.org/latest/json-schema-validation.html#anchor33) requires.
51+ Currently doesn't support the optional `"format"` validators.
53## Vendoring
55+ `JSON-Schema-Test-Suite` is vendored from commit # c1b12bf699f29a04b4286711c6e3bbfba66f21e5 [here](https://github.com/json-schema-org/JSON-Schema-Test-Suite).
57+ `src/draft4.json` is from commit # c1b12bf699f29a04b4286711c6e3bbfba66f21e5 [here](https://github.com/json-schema/json-schema). The [root ref in remote ref](./JSON-Schema-Test-Suite/tests/draft4/refRemote.json) test has been modified to fix [#175](https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/175).
59## Credits
61[TJ Weigel](http://tjweigel.com/) created the logo.
63[Tim Baumann](https://github.com/timjb) wrote [aeson-schema](https://hackage.haskell.org/package/aeson-schema), on which hjsonschema's test code and its implementation of `SchemaGraph` were based.
65[Julian Berman](https://github.com/Julian) maintains the fantastic [language agnostic test suite](https://github.com/json-schema/JSON-Schema-Test-Suite).