reffy 6.2.0 → 6.2.1

package/src/browserlib/get-absolute-url.mjs

@@ -1,21 +1,21 @@
-/**
- * Gets the absolute URL with fragment to the given node
- *
- * @function
- * @public
- * @param {Element} node DOM node to look at. Must have an ID.
- * @param {Object} options "singlePage" asserts whether the spec is single page
- *   or whether that's unknown. Default is false for "unknown".
- *   "attribute" tells function to use value of given attribute name instead of
- *   the node's ID. Default is "id".
- * @return {String} Absolute URL ending with fragment ref
- */
-export default function (node, { singlePage, attribute } =
-                               { singlePage: false, attribute: 'id' }) {
-  attribute = attribute ?? 'id';
-  const page = singlePage ? null :
-    node.closest('[data-reffy-page]')?.getAttribute('data-reffy-page');
-  const url = new URL(page ?? window.location.href);
-  url.hash = '#' + node.getAttribute(attribute);
-  return url.toString();
-}
+/**
+ * Gets the absolute URL with fragment to the given node
+ *
+ * @function
+ * @public
+ * @param {Element} node DOM node to look at. Must have an ID.
+ * @param {Object} options "singlePage" asserts whether the spec is single page
+ *   or whether that's unknown. Default is false for "unknown".
+ *   "attribute" tells function to use value of given attribute name instead of
+ *   the node's ID. Default is "id".
+ * @return {String} Absolute URL ending with fragment ref
+ */
+export default function (node, { singlePage, attribute } =
+                               { singlePage: false, attribute: 'id' }) {
+  attribute = attribute ?? 'id';
+  const page = singlePage ? null :
+    node.closest('[data-reffy-page]')?.getAttribute('data-reffy-page');
+  const url = new URL(page ?? window.location.href);
+  url.hash = '#' + node.getAttribute(attribute);
+  return url.toString();
+}

package/src/browserlib/get-generator.mjs

@@ -1,27 +1,27 @@
-/**
- * Return the name of a well-known generator that was used to generate the
- * spec, if known.
- *
- * This function expects to run within a browser context.
- *
- * @function
- * @public
- * @param {Window} window
- * @return {Promise} The promise to get a document ready for extraction and
- *   the name of the generator (or null if generator is unknown).
- */
-export default function () {
-    const generator = window.document.querySelector('meta[name="generator"]');
-    if (generator && generator.content.match(/bikeshed/i)) {
-        return 'bikeshed';
-    }
-    else if ((generator && generator.content.match(/respec/i)) ||
-            (document.body.id === 'respecDocument') ||
-            window.respecConfig ||
-            window.eval('typeof respecConfig !== "undefined"')) {
-        return 'respec';
-    }
-    else {
-        return null;
-    }
+/**
+ * Return the name of a well-known generator that was used to generate the
+ * spec, if known.
+ *
+ * This function expects to run within a browser context.
+ *
+ * @function
+ * @public
+ * @param {Window} window
+ * @return {Promise} The promise to get a document ready for extraction and
+ *   the name of the generator (or null if generator is unknown).
+ */
+export default function () {
+    const generator = window.document.querySelector('meta[name="generator"]');
+    if (generator && generator.content.match(/bikeshed/i)) {
+        return 'bikeshed';
+    }
+    else if ((generator && generator.content.match(/respec/i)) ||
+            (document.body.id === 'respecDocument') ||
+            window.respecConfig ||
+            window.eval('typeof respecConfig !== "undefined"')) {
+        return 'respec';
+    }
+    else {
+        return null;
+    }
 }

package/src/browserlib/get-lastmodified-date.mjs

@@ -1,14 +1,14 @@
-export default function () {
-  const dateEl = document.querySelector('.head time');
-  const statusAndDate = [...document.querySelectorAll('.head h2')]
-    .map(el => el.textContent).join(' ').trim();
-  const lastModified = new Date(Date.parse(document.lastModified));
-  const date = dateEl ? dateEl.textContent.trim() :
-    (statusAndDate ? statusAndDate.split(/\s+/).slice(-3).join(' ') :
-    [
-      lastModified.toLocaleDateString('en-US', { day: 'numeric' }),
-      lastModified.toLocaleDateString('en-US', { month: 'long' }),
-      lastModified.toLocaleDateString('en-US', { year: 'numeric' })
-    ].join(' '));
-  return date;
+export default function () {
+  const dateEl = document.querySelector('.head time');
+  const statusAndDate = [...document.querySelectorAll('.head h2')]
+    .map(el => el.textContent).join(' ').trim();
+  const lastModified = new Date(Date.parse(document.lastModified));
+  const date = dateEl ? dateEl.textContent.trim() :
+    (statusAndDate ? statusAndDate.split(/\s+/).slice(-3).join(' ') :
+    [
+      lastModified.toLocaleDateString('en-US', { day: 'numeric' }),
+      lastModified.toLocaleDateString('en-US', { month: 'long' }),
+      lastModified.toLocaleDateString('en-US', { year: 'numeric' })
+    ].join(' '));
+  return date;
 }

package/src/browserlib/get-title.mjs

@@ -1,12 +1,12 @@
-/**
- * Gets the title of the document
- */
-export default function () {
-  const title = window.document.querySelector('title');
-  if (title) {
-    return title.textContent.replace(/\s+/g, ' ').trim();
-  }
-  else {
-    return '[No title found for ' + window.location.href + ']';
-  }
+/**
+ * Gets the title of the document
+ */
+export default function () {
+  const title = window.document.querySelector('title');
+  if (title) {
+    return title.textContent.replace(/\s+/g, ' ').trim();
+  }
+  else {
+    return '[No title found for ' + window.location.href + ']';
+  }
 }

package/src/browserlib/informative-selector.mjs

@@ -1,17 +1,17 @@
-/**
- * Query selector that matches informative sections
- * 
- * Based on:
- * https://github.com/w3c/respec/blob/develop/src/core/utils.js#L45
- * https://tabatkins.github.io/bikeshed/#metadata-informative-classes
- */
-export default [
-  '.informative',
-  '.note',
-  '.issue',
-  '.example',
-  '.ednote',
-  '.practice',
-  '.introductory',
-  '.non-normative'
+/**
+ * Query selector that matches informative sections
+ * 
+ * Based on:
+ * https://github.com/w3c/respec/blob/develop/src/core/utils.js#L45
+ * https://tabatkins.github.io/bikeshed/#metadata-informative-classes
+ */
+export default [
+  '.informative',
+  '.note',
+  '.issue',
+  '.example',
+  '.ednote',
+  '.practice',
+  '.introductory',
+  '.non-normative'
 ].join(',');

package/src/browserlib/map-ids-to-headings.mjs

@@ -1,136 +1,136 @@
-import createOutline from './create-outline.mjs';
-import getAbsoluteUrl from './get-absolute-url.mjs';
-
-// Regular expression to capture the numbering of a heading. The expression
-// extracts numbers such as "1.", "A.", "A.3", "13.3.4.". Note: a top-level
-// number always ends with a ".", but there may be no final "." in sublevels
-// (Bikeshed adds one, ReSpec does not).
-const reNumber = /^([A-Z0-9]\.|[A-Z](\.[0-9]+)+\.?|[0-9]+(\.[0-9]+)+\.?)\s/;
-
-/**
- * Generate a mapping between elements that have an ID and the closest heading
- * (that also has an ID) under which these elements appear in the DOM tree.
- *
- * The main difficulty is that the structure of a DOM tree does not necessarily
- * follow the structure of the outline of the document, which means that there
- * is no direct way to tell the conceptual section where an element is defined
- * just by looking at its list of ancestors in the DOM tree.
- *
- * In practice, the outline of the document needs to be prepared accordingly to
- * the HTML spec before the mapping can be done.
- *
- * @function
- * @public
- * @return {Object} A mapping table, where keys are IDs of all elements in the
- *   document, and values are IDs of the heading elements under which these
- *   elements are defined. The table only contains IDs for which there exists
- *   such a heading.
- */
-export default function () {
-  // Special-casing ecmascript specs which use special markup for sections
-  // <emu-clause>
-  if (document.querySelector("emu-clause")) {
-    return esMapIdToHeadings();
-  }
-
-
-  // Get a flat list of all conceptual sections
-  function flattenSections(outline) {
-    return outline
-      .concat(outline.flatMap(section => flattenSections(section.subSections)))
-      .concat(outline.flatMap(section => flattenSections(section.subRoots)));
-  }
-
-  const { outline, nodeToSection } = createOutline(document.body);
-  const sections = flattenSections(outline);
-
-  // Compute once whether we created a single page version out of multiple pages
-  const singlePage = !document.querySelector('[data-reffy-page]');
-
-  const mappingTable = {};
-  [...document.querySelectorAll('[id]')].forEach(node => {
-    let parentSection = nodeToSection.get(node);
-    while (parentSection) {
-      if (parentSection.heading !== '__implied') {
-        break;
-      }
-      parentSection = sections.find(section =>
-        section.subSections.includes(parentSection) ||
-        section.subRoots.includes(parentSection));
-    }
-
-    // Compute the absolute URL with fragment
-    // (Note the crawler merges pages of a multi-page spec in the first page
-    // to ease parsing logic, and we want to get back to the URL of the page)
-    const nodeid = getAbsoluteUrl(node, { singlePage });
-    let href = nodeid;
-
-    if (parentSection) {
-      const heading = parentSection.heading;
-      let id = heading.id;
-      href = getAbsoluteUrl(heading, { singlePage });
-
-      if (parentSection.root && parentSection.root.hasAttribute('id')) {
-        id = parentSection.root.id;
-        href = getAbsoluteUrl(parentSection.root, { singlePage });
-      }
-
-      const trimmedText = heading.textContent.trim();
-      const match = trimmedText.match(reNumber);
-      const number = match ? match[1] : null;
-
-      mappingTable[nodeid] = {
-        id,
-        href,
-        title: trimmedText.replace(reNumber, '').trim().replace(/\s+/g, ' ')
-      };
-
-      if (number) {
-        // Store the number without the final "."
-        mappingTable[nodeid].number = number.replace(/\.$/, '');
-      }
-    }
-  });
-
-  return mappingTable;
-}
-
-function esMapIdToHeadings() {
-  // Based on https://tc39.es/ecmarkup/
-  // and actual emu-* tags used in the ecmascript spec with ids
-  const ignoreTags = ["emu-xref"];
-  const sectionTags = ["emu-intro", "emu-clause", "emu-annex"];
-
-  // Compute once whether we created a single page version out of multiple pages
-  const singlePage = !document.querySelector('[data-reffy-page]');
-
-  let mappingTable = {};
-  [...document.querySelectorAll(`[id]:not(${ignoreTags.join(',')}`)]
-    .forEach(el => {
-      const section = el.closest(`${sectionTags.map(t => `${t}[id]`).join(',')}`);
-
-      // These are spec UI-related ids, so not a loss
-      if (!section) return;
-
-      const heading = section.querySelector("h1");
-      const trimmedText = heading.textContent.trim();
-      const nodeid = getAbsoluteUrl(el, { singlePage });
-      const href = getAbsoluteUrl(section, { singlePage });
-
-      const match = trimmedText.match(reNumber);
-      const number = match ? match[1] : null;
-
-      mappingTable[nodeid] = {
-        id: section.id,
-        href,
-        title: trimmedText.replace(reNumber, '').trim().replace(/\s+/g, ' ')
-      };
-
-      if (number) {
-        // Store the number without the final "."
-        mappingTable[nodeid].number = number.replace(/\.$/, '');
-      }
-
-    });
-  return mappingTable;
-}
+import createOutline from './create-outline.mjs';
+import getAbsoluteUrl from './get-absolute-url.mjs';
+
+// Regular expression to capture the numbering of a heading. The expression
+// extracts numbers such as "1.", "A.", "A.3", "13.3.4.". Note: a top-level
+// number always ends with a ".", but there may be no final "." in sublevels
+// (Bikeshed adds one, ReSpec does not).
+const reNumber = /^([A-Z0-9]\.|[A-Z](\.[0-9]+)+\.?|[0-9]+(\.[0-9]+)+\.?)\s/;
+
+/**
+ * Generate a mapping between elements that have an ID and the closest heading
+ * (that also has an ID) under which these elements appear in the DOM tree.
+ *
+ * The main difficulty is that the structure of a DOM tree does not necessarily
+ * follow the structure of the outline of the document, which means that there
+ * is no direct way to tell the conceptual section where an element is defined
+ * just by looking at its list of ancestors in the DOM tree.
+ *
+ * In practice, the outline of the document needs to be prepared accordingly to
+ * the HTML spec before the mapping can be done.
+ *
+ * @function
+ * @public
+ * @return {Object} A mapping table, where keys are IDs of all elements in the
+ *   document, and values are IDs of the heading elements under which these
+ *   elements are defined. The table only contains IDs for which there exists
+ *   such a heading.
+ */
+export default function () {
+  // Special-casing ecmascript specs which use special markup for sections
+  // <emu-clause>
+  if (document.querySelector("emu-clause")) {
+    return esMapIdToHeadings();
+  }
+
+
+  // Get a flat list of all conceptual sections
+  function flattenSections(outline) {
+    return outline
+      .concat(outline.flatMap(section => flattenSections(section.subSections)))
+      .concat(outline.flatMap(section => flattenSections(section.subRoots)));
+  }
+
+  const { outline, nodeToSection } = createOutline(document.body);
+  const sections = flattenSections(outline);
+
+  // Compute once whether we created a single page version out of multiple pages
+  const singlePage = !document.querySelector('[data-reffy-page]');
+
+  const mappingTable = {};
+  [...document.querySelectorAll('[id]')].forEach(node => {
+    let parentSection = nodeToSection.get(node);
+    while (parentSection) {
+      if (parentSection.heading !== '__implied') {
+        break;
+      }
+      parentSection = sections.find(section =>
+        section.subSections.includes(parentSection) ||
+        section.subRoots.includes(parentSection));
+    }
+
+    // Compute the absolute URL with fragment
+    // (Note the crawler merges pages of a multi-page spec in the first page
+    // to ease parsing logic, and we want to get back to the URL of the page)
+    const nodeid = getAbsoluteUrl(node, { singlePage });
+    let href = nodeid;
+
+    if (parentSection) {
+      const heading = parentSection.heading;
+      let id = heading.id;
+      href = getAbsoluteUrl(heading, { singlePage });
+
+      if (parentSection.root && parentSection.root.hasAttribute('id')) {
+        id = parentSection.root.id;
+        href = getAbsoluteUrl(parentSection.root, { singlePage });
+      }
+
+      const trimmedText = heading.textContent.trim();
+      const match = trimmedText.match(reNumber);
+      const number = match ? match[1] : null;
+
+      mappingTable[nodeid] = {
+        id,
+        href,
+        title: trimmedText.replace(reNumber, '').trim().replace(/\s+/g, ' ')
+      };
+
+      if (number) {
+        // Store the number without the final "."
+        mappingTable[nodeid].number = number.replace(/\.$/, '');
+      }
+    }
+  });
+
+  return mappingTable;
+}
+
+function esMapIdToHeadings() {
+  // Based on https://tc39.es/ecmarkup/
+  // and actual emu-* tags used in the ecmascript spec with ids
+  const ignoreTags = ["emu-xref"];
+  const sectionTags = ["emu-intro", "emu-clause", "emu-annex"];
+
+  // Compute once whether we created a single page version out of multiple pages
+  const singlePage = !document.querySelector('[data-reffy-page]');
+
+  let mappingTable = {};
+  [...document.querySelectorAll(`[id]:not(${ignoreTags.join(',')}`)]
+    .forEach(el => {
+      const section = el.closest(`${sectionTags.map(t => `${t}[id]`).join(',')}`);
+
+      // These are spec UI-related ids, so not a loss
+      if (!section) return;
+
+      const heading = section.querySelector("h1");
+      const trimmedText = heading.textContent.trim();
+      const nodeid = getAbsoluteUrl(el, { singlePage });
+      const href = getAbsoluteUrl(section, { singlePage });
+
+      const match = trimmedText.match(reNumber);
+      const number = match ? match[1] : null;
+
+      mappingTable[nodeid] = {
+        id: section.id,
+        href,
+        title: trimmedText.replace(reNumber, '').trim().replace(/\s+/g, ' ')
+      };
+
+      if (number) {
+        // Store the number without the final "."
+        mappingTable[nodeid].number = number.replace(/\.$/, '');
+      }
+
+    });
+  return mappingTable;
+}

package/src/browserlib/reffy.json

@@ -1,53 +1,53 @@
-[
-  {
-    "href": "./get-title.mjs",
-    "property": "title",
-    "metadata": true
-  },
-  {
-    "href": "./get-generator.mjs",
-    "property": "generator",
-    "metadata": true
-  },
-  {
-    "href": "./get-lastmodified-date.mjs",
-    "property": "date",
-    "metadata": true
-  },
-  {
-    "href": "./extract-links.mjs",
-    "property": "links"
-  },
-  {
-    "href": "./extract-references.mjs",
-    "property": "refs"
-  },
-  {
-    "href": "./extract-webidl.mjs",
-    "property": "idl",
-    "extractsPerSeries": true
-  },
-  {
-    "href": "./extract-cssdfn.mjs",
-    "property": "css",
-    "extractsPerSeries": true
-  },
-  {
-    "href": "./extract-dfns.mjs",
-    "property": "dfns",
-    "needsIdToHeadingMap": true
-  },
-  {
-    "href": "./extract-elements.mjs",
-    "property": "elements"
-  },
-  {
-    "href": "./extract-headings.mjs",
-    "property": "headings"
-  },
-  {
-    "href": "./extract-ids.mjs",
-    "property": "ids",
-    "needsIdToHeadingMap": true
-  }
-]
+[
+  {
+    "href": "./get-title.mjs",
+    "property": "title",
+    "metadata": true
+  },
+  {
+    "href": "./get-generator.mjs",
+    "property": "generator",
+    "metadata": true
+  },
+  {
+    "href": "./get-lastmodified-date.mjs",
+    "property": "date",
+    "metadata": true
+  },
+  {
+    "href": "./extract-links.mjs",
+    "property": "links"
+  },
+  {
+    "href": "./extract-references.mjs",
+    "property": "refs"
+  },
+  {
+    "href": "./extract-webidl.mjs",
+    "property": "idl",
+    "extractsPerSeries": true
+  },
+  {
+    "href": "./extract-cssdfn.mjs",
+    "property": "css",
+    "extractsPerSeries": true
+  },
+  {
+    "href": "./extract-dfns.mjs",
+    "property": "dfns",
+    "needsIdToHeadingMap": true
+  },
+  {
+    "href": "./extract-elements.mjs",
+    "property": "elements"
+  },
+  {
+    "href": "./extract-headings.mjs",
+    "property": "headings"
+  },
+  {
+    "href": "./extract-ids.mjs",
+    "property": "ids",
+    "needsIdToHeadingMap": true
+  }
+]