editorial: [aria.js] generate roleInfo after respec runs #2769
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,153 @@ | ||
| import fs from "node:fs"; | ||
| import path from "node:path"; | ||
|
|
||
| import { parseHTML } from "linkedom"; | ||
| const __dirname = import.meta.dirname; | ||
|
|
||
| // NOTE: this script expects compiled respec output (e.g. gh-pages branch). | ||
| // If you are working on this file, you will need to run, e.g. get a copy from gh-pages or | ||
| // run `$ npx respec --src index.html --out index.html` | ||
| const inputFilename = path.resolve('index.html'); | ||
|
daniel-montalvo marked this conversation as resolved.
|
||
| const outputFilename = path.join(__dirname, "roleInfo.js"); | ||
|
|
||
| const { document } = parseHTML(fs.readFileSync(inputFilename).toString()) | ||
| const roleTypeProps = document.querySelector('#roletype .role-properties'); | ||
| const statesAndProps = {} | ||
|
|
||
| document.querySelectorAll('#states_and_properties :is(.state, .property)').forEach( | ||
| spSection => { | ||
| const key = spSection.id; | ||
| const value = {}; | ||
| statesAndProps[key] = value; | ||
| value.is = spSection.classList.contains('state') ? 'state' : 'property'; | ||
| value.name = key; | ||
| value.required = false; | ||
| value.disallowed = false; | ||
| value.deprecated = roleTypeProps.querySelector(`[data-deprecated="${key}"]`) ? true : false; | ||
| // TODO: consider adding value information | ||
| } | ||
| ) | ||
|
|
||
| const roleInfo = {}; | ||
|
|
||
|
|
||
| // TODO: remove this HACK (which reproduces most of the current broken state, cf. its use below) | ||
| const currentyBroken = [ | ||
| "alertdialog", | ||
| "application", | ||
| "banner", | ||
| "blockquote", | ||
| "button", | ||
| "caption", | ||
| "code", | ||
| "columnheader", | ||
| "combobox", | ||
| "comment", | ||
| "complementary", | ||
| "contentinfo", | ||
| "definition", | ||
| "deletion", | ||
| "directory", | ||
| "emphasis", | ||
| "feed", | ||
| "figure", | ||
| "form", | ||
| "generic", | ||
| "heading", | ||
| "image", | ||
| "img", | ||
| "insertion", | ||
| "link", | ||
| "listbox", | ||
| "log", | ||
| "main", | ||
| "mark", | ||
| "marquee", | ||
| "math", | ||
| "menubar", | ||
| "menuitemcheckbox", | ||
| "menuitemradio", | ||
| "meter", | ||
| "navigation", | ||
| "none", | ||
| "note", | ||
| "paragraph", | ||
| "presentation", | ||
| "progressbar", | ||
| "radio", | ||
| "radiogroup", | ||
| "region", | ||
| "row", | ||
| "rowgroup", | ||
| "rowheader", | ||
| "scrollbar", | ||
| "search", | ||
| "searchbox", | ||
| "sectionfooter", | ||
| "sectionheader", | ||
| "separator", | ||
| "slider", | ||
| "spinbutton", | ||
| "strong", | ||
| "subscript", | ||
| "suggestion", | ||
| "superscript", | ||
| "switch", | ||
| "tab", | ||
| "tablist", | ||
| "tabpanel", | ||
| "term", | ||
| "time", | ||
| "timer", | ||
| "toolbar", | ||
| "tooltip", | ||
| "treegrid", | ||
| "treeitem" | ||
| ] | ||
|
|
||
| const generateRoleInfoEntry = (roleSection) => { | ||
| const key = roleSection.id; | ||
| const value = {}; | ||
| roleInfo[key] = value; | ||
| value.name = key; | ||
| value.fragID = key; //TODO: [minor] is this duplication really worth it? Role names should be valid IDREFS, no? | ||
| value.parentRoles = []; | ||
| roleSection.querySelectorAll('.role-parent .role-reference').forEach(node => value.parentRoles.push(node.textContent)); | ||
| value.localprops = []; | ||
|
|
||
| roleSection.querySelectorAll(':is(.role-required-properties, .role-properties, .role-disallowed) :is(.property-reference, .state-reference)').forEach( | ||
| link => { | ||
| const name = link.textContent.split(' ')[0]; //TODO: hack because roletype has (state) inside link (as the only role to have that), cf. TODO: in ariaPreprocessing.js | ||
| const prop = structuredClone(statesAndProps[name]); | ||
| if (key !== 'roletype') prop.deprecated = false; // TODO: should roletype have deprecated=true when the spec lists everything as supported? | ||
| if (link.closest('.role-disallowed')) prop["disallowed"] = true; | ||
| if (link.closest('.role-required-properties')) prop["required"] = true; | ||
| value.localprops.push(prop); | ||
| } | ||
| ) | ||
| // TODO: why localprops separately? (localprops are duplicated in allprops; maybe property) | ||
|
|
||
| value.localprops.sort((a, b) => a.name < b.name); | ||
|
|
||
| const localPropNames = value.localprops.map(prop => prop.name); | ||
|
|
||
| if (currentyBroken.indexOf(key) > -1) return; //TODO: remove this HACK (cf. above) | ||
|
|
||
| value.allprops = structuredClone(value.localprops); //TODO: why do we duplicate them? Does ariaChild.js need this duplication? (I understand its "allprops" but just "inherited" seems cleaner.) | ||
| roleSection.querySelectorAll('.role-inherited :is(.property-reference, .state-reference)').forEach( | ||
| link => { | ||
| const name = link.textContent.split(' ')[0]; //TODO: hack because roletype has (state) inside link (as the only role to have that), cf. TODO: in ariaPreprocessing.js | ||
| const prop = structuredClone(statesAndProps[name]); | ||
| if (localPropNames.indexOf(prop.name) > -1) prop.deprecated = false; // NOTE: ignores the fact that localProps may be disallowed (which is ok at time of writing) | ||
| if (link.closest('.role-disallowed')) prop["disallowed"] = true; | ||
| value.allprops.push(prop); | ||
| } | ||
| ) | ||
| // TODO: sort value.allprops | ||
| } | ||
|
|
||
| document.querySelectorAll('#role_definitions .role').forEach(generateRoleInfoEntry); | ||
|
|
||
| // sort keys | ||
| const sortKeys = o => Object.keys(o).sort().reduce((r, k) => (r[k] = o[k], r), {}); | ||
| fs.writeFileSync(outputFilename, "/* This file is generated - do not modify */ var roleInfo = " + JSON.stringify(sortKeys(roleInfo), null, 2)); | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know how to test this without merging. Also, this may help with or may be blocked by #2768.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only way would be through setting up a fork
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought this is the cleanest way: when a version is published to github, we update roleinfo.