editorial: [aria.js] generate roleInfo after respec runs

.github/workflows/roleInfo.yml

@@ -3,7 +3,7 @@ name: roleInfo update
 on:
   push:
     branches:
-      - main
+      - gh-pages
 
 jobs:
   roleInfo:
@@ -12,15 +12,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v6
         with:
+          ref: main
           fetch-depth: 0  # Needed to compare with origin/main
           token: ${{ secrets.W3CGRUNTBOT_TOKEN }}
       - name: Use Node.js
         uses: actions/setup-node@v6
         with:
           node-version: "latest"
       - run: npm i linkedom prettier@3.6.0
-      - run: node ./common/script/buildRoleInfo.js > ./common/script/roleInfo.js
+      - run: git checkout gh-pages index.html # checkout (respec'ed) aria spec from gh-pages (WARNING: changes get staged!)
+      - run: node ./common/script/buildRoleInfo.js  # build roleInfo.js
       - run: npx prettier --write --print-width 200 ./common/script/roleInfo.js
+      - run: git reset index.html # reset spec source (to avoid comittting, cf. wanrning above)
       - run: git config user.name "github-actions[bot]"
       - run: git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
       - run: git add ./common/script/roleInfo.js

.github/workflows/roleInfoCheck.yml

@@ -16,7 +16,9 @@ jobs:
         uses: actions/setup-node@v6
         with:
           node-version: "latest"
-      - run: npm i linkedom prettier@3.6.0
-      - run: node ./common/script/buildRoleInfo.js > ./common/script/roleInfo.js
+      - run: npm i linkedom prettier@3.6.0 respec
+      - run: npx respec --src index.html --out index.html
+      - run: node ./common/script/buildRoleInfo.js
       - run: npx prettier --write --print-width 200 ./common/script/roleInfo.js
+      - run: git checkout index.html
       - run: git diff --exit-code

common/script/ariaPreprocessing.js

@@ -15,7 +15,7 @@ const buildGlobalStatesAndPropertiesLists = (globalStatesPlaceholder, roletypePr
   if (!(isDefault || isProhibited || isDeprecated)) return;
   const isState = def.tagName === "SDEF";
   const refTagName = isState ? "sref" : "pref";
-  const htmlString = `<li><${refTagName} ${isProhibited ? "data-prohibited " : ""}${isDeprecated ? "data-deprecated " : ""}${
+  const htmlString = `<li${isProhibited ? ` data-prohibited="${def.innerHTML}"` : ""}${isDeprecated ? ` data-deprecated="${def.innerHTML}"` : ""}><${refTagName} ${isProhibited ? "data-prohibited " : ""}${isDeprecated ? "data-deprecated " : ""}${
     isState ? `title="${def.innerHTML}"` : ""
   }>${def.innerHTML}${isState ? " (state)" : ""}</${refTagName}>${
     // TODO: consider moving "(state)" out of sref/pref tag; then maybe remove title attr for sref (after checking resolveReferences interference)

common/script/buildRoleInfo.js

@@ -1,17 +1,74 @@
-import * as fs from "node:fs";
+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 respec first.
+// E.g. get a copy from gh-pages or run `$ npx respec --src index.html --out index.html`
+const inputFilename = path.resolve('index.html');
+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 = {};
+
+
+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 = [];
 
-const { document } = parseHTML(fs.readFileSync("../aria/index.html").toString());
+    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)
 
-// mock functions for aria.js
-let updateReferences = () => {};
-document.URL = "";
+    value.localprops.sort((a, b) => a.name < b.name);
 
-const script = fs.readFileSync("./common/script/aria.js").toString();
-const prescript = fs.readFileSync("./common/script/ariaPreprocessing.js").toString();
+    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 (link.closest('.role-disallowed')) prop["disallowed"] = true;
+            value.allprops.push(prop);
+        }
+    )
+    // TODO: sort value.allprops
+}
 
-// HACK call ariaPreprocessing(), ariaAttributeReferences(), and log out roleInfo with prefix
-const scriptAddition = 'ariaPreprocessing();ariaAttributeReferences();console.log("/* This file is generated - do not modify */ var roleInfo = "+JSON.stringify(roleInfo, null, 2));';
+document.querySelectorAll('#role_definitions .role').forEach(generateRoleInfoEntry);
 
-// HACK: eval!
-eval(prescript + script + scriptAddition);
+// 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));