Add crude dfns patching mechanism #1159
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Trusted Types has this weird IDL block where it defines DOMParser but does not seem to mean it: https://w3c.github.io/trusted-types/dist/spec/#integration-with-dom-parsing The IDL block has an `exclude` class and is thus ignored by the IDL extraction logic. This update completes the dfns extraction logic to also ignore terms defined in such an IDL block. This avoids ending up with duplicated terms.
This creates a crude patching mechanism to patch dfns directly after crawling a spec. This can be used to drop some well-known duplicates that cause referencing issues. The module needs to be maintained over time, so goal is to only hardcode rules when really needed, e.g. because the re-definition of a term causes actual referencing issues. The module runs at the spec level for simplicity. A more complete version could run at the crawl level, detect duplicates and try to act on them. That would require investing more energy into it :)
dontcallmedom
approved these changes
Dec 16, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This completes dfns extraction rules to ignore IDL terms defined in "exclude" blocks (for Trusted Types), and introduces a post-processing module to patch problematic dfns. The post-processing module only patches two specs for the time being:
orientation-eventwhich redefinesPermissionStateandportals, which redefinesMessageEventSource.Goal is to only add dfn patches when the dfns create actual referencing issues, not to solve all dfns issues, as that would be hard to maintain on a day to day basis.
(Webref's crawling job will need to be updated to call the new module for this to affect Webref data)
For additional context, see w3c/webref#306 and speced/bikeshed#2426 (comment)