Skip to content

Commit f2c748c

Browse files
Update README.md
1 parent 0cd9f0d commit f2c748c

File tree

1 file changed

+20
-44
lines changed

1 file changed

+20
-44
lines changed

README.md

+20-44
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,26 @@ corresponding Elm output. Likewise, representations of each of the different
3333
JSON schema types are described in the `lib/types` folder.
3434

3535
The tool aims to produce `elm-make`-like errors if something is missing,
36-
mispelled or cannot be resolved in the supplied JSON schema file(s). If you
37-
experience errors that look more like stack traces, feel free to open an issue
38-
so it can be fixed.
36+
mispelled or cannot be resolved in the supplied JSON schema file(s), e.g.
37+
38+
```
39+
--- UNKNOWN NODE TYPE -------------------------------------- all_of_example.json
40+
41+
The value of "type" at '#/allOf/0/properties/description' did not match a known node type
42+
43+
"type": "strink"
44+
^^^^^^^^
45+
46+
Was expecting one of the following types
47+
48+
["null", "boolean", "object", "array", "number", "integer", "string"]
49+
50+
Hint: See the specification section 6.25. "Validation keywords - type"
51+
<http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.25>
52+
```
53+
54+
If you experience an error that looks more like a stack trace than the above,
55+
feel free to open an issue so it can be fixed.
3956

4057
## Example
4158

@@ -277,47 +294,6 @@ encodeCircle circle =
277294
++ radius
278295
```
279296

280-
## Error reporting
281-
282-
Any errors encountered by the `js2e` tool while parsing the JSON schema files or
283-
printing the Elm code output, is reported in an Elm-like style, e.g.
284-
285-
```
286-
--- UNKNOWN NODE TYPE -------------------------------------- all_of_example.json
287-
288-
The value of "type" at '#/allOf/0/properties/description' did not match a known node type
289-
290-
"type": "strink"
291-
^^^^^^^^
292-
293-
Was expecting one of the following types
294-
295-
["null", "boolean", "object", "array", "number", "integer", "string"]
296-
297-
Hint: See the specification section 6.25. "Validation keywords - type"
298-
<http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.25>
299-
```
300-
301-
or
302-
303-
```
304-
--- UNRESOLVED REFERENCE ----------------------------------- all_of_example.json
305-
306-
307-
The following reference at `#/allOf/0/color` could not be resolved
308-
309-
"$ref": #/definitions/kolor
310-
^^^^^^^^^^^^^^^^^^^
311-
312-
313-
Hint: See the specification section 9. "Base URI and dereferencing"
314-
<http://json-schema.org/latest/json-schema-core.html#rfc.section.9>
315-
```
316-
317-
If you encounter an error while using `js2e` that does not mimic the above
318-
Elm-like style, but instead looks like an Elixir stacktrace, please report this
319-
as a bug by opening an issue and includin a JSON schema example that recreates
320-
the error.
321297

322298
## Contributing
323299

0 commit comments

Comments
 (0)