Skip to content

Commit e595264

Browse files
tidoustdontcallmedom
authored andcommitted
Add a validation guarantee to curated CDDL extracts
This leverages CDDL validation in Strudy to provide a validation guarantee to curated CDDL extracts. A `cddlpatches` folder, which will hopefully remain empty, gets added so that we may temporarily patch CDDL extracts that become invalid.
1 parent 734ec92 commit e595264

File tree

8 files changed

+193
-419
lines changed

8 files changed

+193
-419
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,9 @@ Data curation brings the following guarantees.
9292

9393
### CDDL extracts
9494

95-
The CDDL extracts currently come with no guarantee whatsoever and may be invalid. Tracked in [#1417](https://github.com/w3c/webref/issues/1417).
95+
- All CDDL files pass CDDL analysis by the version of [Strudy](https://github.com/w3c/strudy) referenced in `package.json`. Said differently, all CDDL files can be parsed by the version of [cddlparser](https://github.com/tidoust/cddlparser) referenced by Strudy.
96+
97+
The CDDL extracts are not released in an NPM package for the time being.
9698

9799
## Known consumers
98100

ed/cddlpatches/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CDDL patches
2+
3+
These are patches applied to the CDDL extracts scraped from specs. These patches can break as specs are updated and thus need ongoing maintenance.
4+
5+
For details on how to create and update patches, please see the [Web IDL patches documentation](../idlpatches/README.md)

0 commit comments

Comments
 (0)