bug: core/cddl recognises non-conformant HTML as authoring shortcut
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 806
- Forks
- 434
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 32
Description
core/cddl accepts <dfn cddl-type>name</dfn>, <dfn cddl-key for="rule">key</dfn>, and <dfn cddl-value for="rule">"value"</dfn> as authoring shortcuts. These ask spec authors to write non-conformant HTML: cddl-type, cddl-key, and cddl-value are unprefixed custom attributes (the HTML spec reserves data-* for that), and for= is only defined on <label> and <output>, not <dfn>.
ReSpec strips the attributes during processing so its output is conformant, but spec source files using these shortcuts won't validate.
Source: src/core/cddl.js#L542-L569. Tests asserting these forms work: tests/spec/core/cddl-spec.js#L654-L709.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read src/core/cddl.js#L542-L569 to understand how the three authoring shortcuts are recognized and stripped, then inspect tests/spec/core/cddl-spec.js#L654-L709 and run the relevant CDDL tests. Done means the behavior no longer depends on the listed non-conformant HTML forms and the tests document the resulting conformant behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100