reffy 10.2.3 → 10.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reffy",
-  "version": "10.2.3",
+  "version": "10.3.0",
   "description": "W3C/WHATWG spec dependencies exploration companion. Features a short set of tools to study spec references as well as WebIDL term definitions and references found in W3C specifications.",
   "repository": {
     "type": "git",
@@ -33,13 +33,13 @@
   "bin": "./reffy.js",
   "dependencies": {
     "abortcontroller-polyfill": "1.7.5",
-    "ajv": "8.11.0",
+    "ajv": "8.11.2",
     "ajv-formats": "2.1.1",
     "commander": "9.4.1",
     "fetch-filecache-for-crawling": "4.1.0",
-    "puppeteer": "19.2.2",
+    "puppeteer": "19.3.0",
     "semver": "^7.3.5",
-    "web-specs": "2.35.0",
+    "web-specs": "2.36.0",
     "webidl2": "24.2.2"
   },
   "devDependencies": {
@@ -48,7 +48,7 @@
     "nock": "13.2.9",
     "respec": "32.3.0",
     "respec-hljs": "2.1.1",
-    "rollup": "3.2.5"
+    "rollup": "3.5.0"
   },
   "scripts": {
     "test": "mocha --recursive tests/"

package/src/browserlib/extract-dfns.mjs

@@ -24,6 +24,13 @@ import {parse} from "../../node_modules/webidl2/index.js";
  *     "prose" (last one indicates that definition appears in the main body of
  *     the spec)
  *
+ * The extraction ignores definitions with an unknown type. A warning is issued
+ * to the console when that happens.
+ *
+ * The extraction uses the first definition it finds when it bumps into a term
+ * that is defined more than once (same "linkingText", same "type", same "for").
+ * A warning is issued to the console when that happens.
+ *
  * @function
  * @public
  * @return {Array(Object)} An Array of definitions
@@ -99,8 +106,22 @@ function hasValidType(el) {
   return isValid;
 }
 
+// Return true when definition is not already defined in the list,
+// Return false and issue a warning when it is already defined.
+function isNotAlreadyDefined(dfn, idx, list) {
+  const first = list.find(d => d === dfn ||
+      (d.type === dfn.type &&
+      d.linkingText.length === dfn.linkingText.length &&
+      d.linkingText.every(lt => dfn.linkingText.find(t => t == lt)) &&
+      d.for.length === dfn.for.length &&
+      d.for.every(lt => dfn.for.find(t => t === lt))));
+  if (first !== dfn) {
+    console.warn('[reffy]', `Duplicate dfn found for "${dfn.linkingText[0]}", type="${dfn.type}", for="${dfn.for[0]}"`);
+  }
+  return first === dfn;
+}
 
-function definitionMapper(el, idToHeading) {
+function definitionMapper(el, idToHeading, usesDfnDataModel) {
   let definedIn = 'prose';
   const enclosingEl = el.closest('dt,pre,table,h1,h2,h3,h4,h5,h6,.note,.example') || el;
   switch (enclosingEl.nodeName) {
@@ -165,8 +186,10 @@ function definitionMapper(el, idToHeading) {
       [],
 
     // Definition is public if explicitly marked as exportable or if export has
-    // not been explicitly disallowed and its type is not "dfn"
-    access: (el.hasAttribute('data-export') ||
+    // not been explicitly disallowed and its type is not "dfn", or if the spec
+    // is an old spec that does not use the "data-dfn-type" convention.
+    access: (!usesDfnDataModel ||
+             el.hasAttribute('data-export') ||
              (!el.hasAttribute('data-noexport') &&
               el.hasAttribute('data-dfn-type') &&
               el.getAttribute('data-dfn-type') !== 'dfn')) ?
@@ -200,7 +223,6 @@ export default function (spec, idToHeading = {}) {
     'h6[id][data-dfn-type]:not([data-lt=""])'
   ].join(',');
 
-  let extraDefinitions = [];
   const shortname = (typeof spec === 'string') ? spec : spec.shortname;
   switch (shortname) {
   case "html":
@@ -214,7 +236,14 @@ export default function (spec, idToHeading = {}) {
     break;
   }
 
-  return [...document.querySelectorAll(definitionsSelector)]
+  const definitions = [...document.querySelectorAll(definitionsSelector)];
+  const usesDfnDataModel = definitions.some(dfn =>
+    dfn.hasAttribute('data-dfn-type') ||
+    dfn.hasAttribute('data-dfn-for') ||
+    dfn.hasAttribute('data-export') ||
+    dfn.hasAttribute('data-noexport'));
+
+  return definitions
     .map(node => {
       // 2021-06-21: Temporary preprocessing of invalid "idl" dfn type (used for
       // internal slots) while fix for https://github.com/w3c/respec/issues/3644
@@ -237,7 +266,8 @@ export default function (spec, idToHeading = {}) {
       const link = node.querySelector('a[href^="http"]');
       return !link || (node.textContent.trim() !== link.textContent.trim());
     })
-    .map(node => definitionMapper(node, idToHeading));
+    .map(node => definitionMapper(node, idToHeading, usesDfnDataModel))
+    .filter(isNotAlreadyDefined);
 }
 
 function preProcessEcmascript() {

package/src/lib/nock-server.js

@@ -32,7 +32,7 @@ const mockSpecs = {
     html: `
       <title>WOFF2</title>
       <body>
-        <dfn id='foo'>Foo</dfn>
+        <dfn id='foo' data-dfn-type="dfn">Foo</dfn>
         <a href="https://www.w3.org/TR/bar/#baz">bar</a>
         <ul class='toc'><li><a href='page.html'>page</a></ul>`,
     pages: {