Skip to content

Commit 37c0312

Browse files
committed
Document limitations
1 parent bffa9e5 commit 37c0312

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,21 @@ All files | 81.81 | 66.66 | 80 | 88.88 |
2424
- **Branches** = true/false branches for each keyword
2525
- **Functions** = Subschemas
2626

27+
## Limitations
28+
29+
The following are know limitations I'm hopeful can be addressed.
30+
31+
- Coverage can only be reported for `**/*.schema.json` and `**/schema.json`
32+
files.
33+
- Coverage can't be reported for embedded schemas.
34+
- Schemas in YAML aren't supported.
35+
- Custom vocabularies aren't supported.
36+
- There's no way to load schemas.
37+
- Invalid schemas cause an error to be thrown.
38+
- Coverage maps are generated in the order they're loaded from the filesystem.
39+
If one references a schema that hasn't been generated yet, an error will be
40+
thrown.
41+
2742
## Vitest
2843

2944
Integration with vitest is provided. You'll need a vitest config specifically

0 commit comments

Comments
 (0)