Skip to content

Commit

Permalink
Add a validation guarantee to curated CDDL extracts
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
tidoust committed Dec 19, 2024
1 parent 6562be9 commit 402b7fe
Show file tree
Hide file tree
Showing 8 changed files with 196 additions and 422 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ Data curation brings the following guarantees.

### CDDL extracts

The CDDL extracts currently come with no guarantee whatsoever and may be invalid. Tracked in [#1417](https://github.com/w3c/webref/issues/1417).
- 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.

The CDDL extracts are not released in an NPM package for the time being.

## Known consumers

Expand Down
5 changes: 5 additions & 0 deletions ed/cddlpatches/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# CDDL patches

These are patches applied to the CDDL extracts scraped from specs. These patches can break as specs are updated and thus need ongoing maintenance.

For details on how to create and update patches, please see the [Web IDL patches documentation](../idlpatches/README.md)
Loading

0 comments on commit 402b7fe

Please sign in to comment.