Skip to content

Commit 1167669

Browse files
committed
README: Update structure, consistency, spacing, and wrapping
1 parent 9514122 commit 1167669

File tree

1 file changed

+37
-44
lines changed

1 file changed

+37
-44
lines changed

README.md

Lines changed: 37 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
JSON Schema Test Suite [![Build Status](https://github.com/json-schema-org/JSON-Schema-Test-Suite/workflows/Test%20Suite%20Sanity%20Checking/badge.svg)](https://github.com/json-schema-org/JSON-Schema-Test-Suite/actions?query=workflow%3A%22Test+Suite+Sanity+Checking%22)
2-
======
1+
# JSON Schema Test Suite [![Build Status](https://github.com/json-schema-org/JSON-Schema-Test-Suite/workflows/Test%20Suite%20Sanity%20Checking/badge.svg)](https://github.com/json-schema-org/JSON-Schema-Test-Suite/actions?query=workflow%3A%22Test+Suite+Sanity+Checking%22)
32

43
This repository contains a set of JSON objects that implementors of JSON Schema
54
validation libraries can use to test their validators.
@@ -9,8 +8,7 @@ It is meant to be language agnostic and should require only a JSON parser.
98
The conversion of the JSON objects into tests within your test framework of
109
choice is still the job of the validator implementor.
1110

12-
Structure of a Test
13-
-------------------
11+
## Structure of a Test
1412

1513
The tests in this suite are contained in the `tests` directory at the root of
1614
this repository. Inside that directory is a subdirectory for each draft or
@@ -45,80 +43,76 @@ illustrate the structure of these with an example:
4543
}
4644
```
4745

48-
In short: a description, a schema under test, and some tests, where each
49-
test in the `tests` array is an objects with a description of the case
50-
itself, the instance under test, and a boolean indicating whether it
51-
should be valid or invalid.
46+
In short: a description, a schema under test, and some tests, where each test
47+
in the `tests` array is an objects with a description of the case itself, the
48+
instance under test, and a boolean indicating whether it should be valid
49+
or invalid.
5250

53-
Test Subdirectories
54-
-------------------
51+
## Test Subdirectories
5552

5653
There is currently only one subdirectory that may exist within each draft
5754
directory. This is:
5855

5956
1. `optional/`: Contains tests that are considered optional.
6057

61-
Coverage
62-
--------
58+
## Coverage
6359

64-
Drafts 07, 06, 04 and 03 should have full coverage, with drafts 06 and
65-
07 being considered current and actively supported.
60+
Drafts 07, 06, 04 and 03 should have full coverage, with drafts 06 and 07 being
61+
considered current and actively supported.
6662

67-
Draft 2019-09 support is under development. Contributions are very
68-
welcome, especially from implementers as they add support to their own
69-
implementations.
63+
Draft 2019-09 support is under development. Contributions are very welcome,
64+
especially from implementers as they add support to their own implementations.
7065

71-
If you see anything missing from the current supported drafts, or incorrect
72-
on any draft still accepting bug fixes, please file an issue or submit a PR.
66+
If you see anything missing from the current supported drafts, or incorrect on
67+
any draft still accepting bug fixes, please file an issue or submit a PR.
7368

74-
Who Uses the Test Suite
75-
-----------------------
69+
## Who Uses the Test Suite
7670

7771
This suite is being used by:
7872

79-
### Clojure ###
73+
### Clojure
8074

8175
* [jinx](https://github.com/juxt/jinx)
8276
* [json-schema](https://github.com/tatut/json-schema)
8377

84-
### Coffeescript ###
78+
### Coffeescript
8579

8680
* [jsck](https://github.com/pandastrike/jsck)
8781

88-
### C++ ###
82+
### C++
8983

9084
* [Modern C++ JSON schema validator](https://github.com/pboettch/json-schema-validator)
9185

92-
### Dart ###
86+
### Dart
9387

9488
* [json_schema](https://github.com/patefacio/json_schema)
9589

96-
### Elixir ###
90+
### Elixir
9791

9892
* [ex_json_schema](https://github.com/jonasschmidt/ex_json_schema)
9993

100-
### Erlang ###
94+
### Erlang
10195

10296
* [jesse](https://github.com/for-GET/jesse)
10397

104-
### Go ###
98+
### Go
10599

106100
* [gojsonschema](https://github.com/sigu-399/gojsonschema)
107101
* [validate-json](https://github.com/cesanta/validate-json)
108102

109-
### Haskell ###
103+
### Haskell
110104

111105
* [aeson-schema](https://github.com/timjb/aeson-schema)
112106
* [hjsonschema](https://github.com/seagreen/hjsonschema)
113107

114-
### Java ###
108+
### Java
115109

116110
* [json-schema-validator](https://github.com/daveclayton/json-schema-validator)
117111
* [everit-org/json-schema](https://github.com/everit-org/json-schema)
118112
* [networknt/json-schema-validator](https://github.com/networknt/json-schema-validator)
119113
* [Justify](https://github.com/leadpony/justify)
120114

121-
### JavaScript ###
115+
### JavaScript
122116

123117
* [json-schema-benchmark](https://github.com/Muscula/json-schema-benchmark)
124118
* [direct-schema](https://github.com/IreneKnapp/direct-schema)
@@ -136,7 +130,7 @@ This suite is being used by:
136130
* [ajv](https://github.com/epoberezkin/ajv)
137131
* [djv](https://github.com/korzio/djv)
138132

139-
### Node.js ###
133+
### Node.js
140134

141135
For node.js developers, the suite is also available as an
142136
[npm](https://www.npmjs.com/package/@json-schema-org/tests) package.
@@ -145,49 +139,48 @@ Node-specific support is maintained in a [separate
145139
repository](https://github.com/json-schema-org/json-schema-test-suite-npm)
146140
which also welcomes your contributions!
147141

148-
### .NET ###
142+
### .NET
149143

150144
* [Newtonsoft.Json.Schema](https://github.com/JamesNK/Newtonsoft.Json.Schema)
151145
* [Manatee.Json](https://github.com/gregsdennis/Manatee.Json)
152146

153-
### PHP ###
147+
### PHP
154148

155149
* [json-schema](https://github.com/justinrainbow/json-schema)
156150
* [json-guard](https://github.com/thephpleague/json-guard)
157151

158-
### PostgreSQL ###
152+
### PostgreSQL
159153

160154
* [postgres-json-schema](https://github.com/gavinwahl/postgres-json-schema)
161155
* [is_jsonb_valid](https://github.com/furstenheim/is_jsonb_valid)
162156

163-
### Python ###
157+
### Python
164158

165159
* [jsonschema](https://github.com/Julian/jsonschema)
166160
* [fastjsonschema](https://github.com/seznam/python-fastjsonschema)
167161
* [hypothesis-jsonschema](https://github.com/Zac-HD/hypothesis-jsonschema)
168162

169-
### Ruby ###
163+
### Ruby
170164

171165
* [json-schema](https://github.com/hoxworth/json-schema)
172166
* [json_schemer](https://github.com/davishmcclurg/json_schemer)
173167

174-
### Rust ###
168+
### Rust
175169

176170
* [valico](https://github.com/rustless/valico)
177171

178-
### Swift ###
172+
### Swift
179173

180174
* [JSONSchema](https://github.com/kylef/JSONSchema.swift)
181175

182176
If you use it as well, please fork and send a pull request adding yourself to
183177
the list :).
184178

185-
Contributing
186-
------------
179+
## Contributing
187180

188181
If you see something missing or incorrect, a pull request is most welcome!
189182

190-
There are some sanity checks in place for testing the test suite. You
191-
can run them with `bin/jsonschema_suite check` or `tox`. They will be
192-
run automatically by [GitHub Actions](https://github.com/json-schema-org/JSON-Schema-Test-Suite/actions?query=workflow%3A%22Test+Suite+Sanity+Checking%22)
183+
There are some sanity checks in place for testing the test suite. You can run
184+
them with `bin/jsonschema_suite check` or `tox`. They will be run automatically
185+
by [GitHub Actions](https://github.com/json-schema-org/JSON-Schema-Test-Suite/actions?query=workflow%3A%22Test+Suite+Sanity+Checking%22)
193186
as well.

0 commit comments

Comments
 (0)