reffy 20.0.13 → 20.0.14

package/src/browserlib/extract-webidl.mjs

@@ -1,90 +1,90 @@
-import getGenerator from './get-generator.mjs';
-import getCodeElements from './get-code-elements.mjs';
-import trimSpaces from './trim-spaces.mjs';
-
-/**
- * Extract the list of WebIDL definitions in the current spec
- *
- * @function
- * @public 
- * @return {String} A dump of the IDL definitions, or an empty string if the
- * spec does not contain any IDL.
- */
-export default function () {
-    const generator = getGenerator();
-    let idl = '';
-    if (generator === 'bikeshed') {
-        idl = extractBikeshedIdl();
-    }
-    else if (document.title.startsWith('Web IDL')) {
-        // IDL content in the Web IDL spec are... examples,
-        // not real definitions
-    }
-    else {
-        // Most non-ReSpec specs still follow the ReSpec conventions
-        // for IDL definitions
-        idl = extractRespecIdl();
-    }
-
-    if (idl) {
-        // Remove trailing spaces and use spaces throughout
-        idl = idl
-            .replace(/\s+$/gm, '\n')
-            .replace(/\t/g, '  ')
-            .trim();
-    }
-    return idl;
-}
-
-
-/**
- * Extract IDL definitions from a Bikeshed spec
- *
- * Note Bikeshed summarizes IDL definitions in an appendix. This is
- * what the code uses.
- */
-function extractBikeshedIdl() {
-    const idlHeading = document.getElementById('idl-index');
-    if (idlHeading) {
-        const nextEl = idlHeading.nextElementSibling;
-        if (nextEl) {
-            return nextEl.textContent;
-        }
-        else {
-            throw new Error('Could not find IDL in IDL index');
-        }
-    }
-    else {
-        // the document may have been generated with "omit idl-index"
-        // in which case, we try the simple way
-        return extractRespecIdl();
-    }
-}
-
-
-/**
- * Extract IDL definitions from a ReSpec spec, and in practice from
- * most other specs as well.
- *
- * The function tries all known patterns used to define IDL content, making
- * sure that it only extracts elements once.
- */
-function extractRespecIdl() {
-    const idlSelectors = [
-        'pre.idl:not(.exclude):not(.extract):not(#actual-idl-index)',
-        'pre:not(.exclude):not(.extract) > code.idl-code:not(.exclude):not(.extract)',
-        'pre:not(.exclude):not(.extract) > code.idl:not(.exclude):not(.extract)',
-        'div.idl-code:not(.exclude):not(.extract) > pre:not(.exclude):not(.extract)',
-        'pre.widl:not(.exclude):not(.extract)'
-    ];
-
-    const excludeSelectors = [
-        '#idl-index',
-        '.chapter-idl'
-    ];
-
-    const idlElements = getCodeElements(idlSelectors, { excludeSelectors });
-    return idlElements
-        .map(el => trimSpaces(el.textContent))
-        .join('\n\n');
+import getGenerator from './get-generator.mjs';
+import getCodeElements from './get-code-elements.mjs';
+import trimSpaces from './trim-spaces.mjs';
+
+/**
+ * Extract the list of WebIDL definitions in the current spec
+ *
+ * @function
+ * @public 
+ * @return {String} A dump of the IDL definitions, or an empty string if the
+ * spec does not contain any IDL.
+ */
+export default function () {
+    const generator = getGenerator();
+    let idl = '';
+    if (generator === 'bikeshed') {
+        idl = extractBikeshedIdl();
+    }
+    else if (document.title.startsWith('Web IDL')) {
+        // IDL content in the Web IDL spec are... examples,
+        // not real definitions
+    }
+    else {
+        // Most non-ReSpec specs still follow the ReSpec conventions
+        // for IDL definitions
+        idl = extractRespecIdl();
+    }
+
+    if (idl) {
+        // Remove trailing spaces and use spaces throughout
+        idl = idl
+            .replace(/\s+$/gm, '\n')
+            .replace(/\t/g, '  ')
+            .trim();
+    }
+    return idl;
+}
+
+
+/**
+ * Extract IDL definitions from a Bikeshed spec
+ *
+ * Note Bikeshed summarizes IDL definitions in an appendix. This is
+ * what the code uses.
+ */
+function extractBikeshedIdl() {
+    const idlHeading = document.getElementById('idl-index');
+    if (idlHeading) {
+        const nextEl = idlHeading.nextElementSibling;
+        if (nextEl) {
+            return nextEl.textContent;
+        }
+        else {
+            throw new Error('Could not find IDL in IDL index');
+        }
+    }
+    else {
+        // the document may have been generated with "omit idl-index"
+        // in which case, we try the simple way
+        return extractRespecIdl();
+    }
+}
+
+
+/**
+ * Extract IDL definitions from a ReSpec spec, and in practice from
+ * most other specs as well.
+ *
+ * The function tries all known patterns used to define IDL content, making
+ * sure that it only extracts elements once.
+ */
+function extractRespecIdl() {
+    const idlSelectors = [
+        'pre.idl:not(.exclude):not(.extract):not(#actual-idl-index)',
+        'pre:not(.exclude):not(.extract) > code.idl-code:not(.exclude):not(.extract)',
+        'pre:not(.exclude):not(.extract) > code.idl:not(.exclude):not(.extract)',
+        'div.idl-code:not(.exclude):not(.extract) > pre:not(.exclude):not(.extract)',
+        'pre.widl:not(.exclude):not(.extract)'
+    ];
+
+    const excludeSelectors = [
+        '#idl-index',
+        '.chapter-idl'
+    ];
+
+    const idlElements = getCodeElements(idlSelectors, { excludeSelectors });
+    return idlElements
+        .map(el => trimSpaces(el.textContent))
+        .join('\n\n');
 }

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

@@ -1,29 +1,29 @@
-/**
- * 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);
-  const hashid = node.getAttribute(attribute);
-  if (hashid) {
-    let fragment = hashid;
-    if (hashid.match(/^#/) && attribute === 'href') {
-      // Function is called to turn a fragment ref into an absolute URL
-      fragment = hashid.substring(1);
-    }
-    url.hash = '#' + encodeURIComponent(fragment);
-  }
-  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);
+  const hashid = node.getAttribute(attribute);
+  if (hashid) {
+    let fragment = hashid;
+    if (hashid.match(/^#/) && attribute === 'href') {
+      // Function is called to turn a fragment ref into an absolute URL
+      fragment = hashid.substring(1);
+    }
+    url.hash = '#' + encodeURIComponent(fragment);
+  }
+  return url.toString();
+}

package/src/browserlib/get-code-elements.mjs

@@ -1,21 +1,21 @@
-import informativeSelector from './informative-selector.mjs';
-import cloneAndClean from './clone-and-clean.mjs';
-
-/**
- * Helper function that returns a set of code elements in document order based
- * on a given set of selectors, excluding elements that are within an index.
- *
- * The function excludes elements defined in informative sections.
- *
- * The code elements are cloned and cleaned before they are returned to strip
- * annotations and other asides.
- */
-export default function getCodeElements(codeSelectors, { excludeSelectors = [] }) {
-    return [...document.querySelectorAll(codeSelectors.join(', '))]
-        // Skip excluded and elements and those in informative content
-        .filter(el => !el.closest(excludeSelectors.join(', ')))
-        .filter(el => !el.closest(informativeSelector))
-
-        // Clone and clean the elements
-        .map(cloneAndClean);
+import informativeSelector from './informative-selector.mjs';
+import cloneAndClean from './clone-and-clean.mjs';
+
+/**
+ * Helper function that returns a set of code elements in document order based
+ * on a given set of selectors, excluding elements that are within an index.
+ *
+ * The function excludes elements defined in informative sections.
+ *
+ * The code elements are cloned and cleaned before they are returned to strip
+ * annotations and other asides.
+ */
+export default function getCodeElements(codeSelectors, { excludeSelectors = [] }) {
+    return [...document.querySelectorAll(codeSelectors.join(', '))]
+        // Skip excluded and elements and those in informative content
+        .filter(el => !el.closest(excludeSelectors.join(', ')))
+        .filter(el => !el.closest(informativeSelector))
+
+        // Clone and clean the elements
+        .map(cloneAndClean);
 }

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-revision.mjs

@@ -1,12 +1,12 @@
-export default function () {
-  // bikeshed uses 'document-revision'
-  // but the documented convention in https://wiki.whatwg.org/wiki/MetaExtensions
-  // is just 'revision' per https://github.com/krallin/meta-revision
-  const meta = document.querySelector('meta[name="document-revision"], meta[name="revision"]');
-  const revision = meta?.content.trim();
-  // git commit shas are 40 hexadecimal characters
-  if (revision?.match(/[0-9a-f]{40}/)) {
-    return revision;
-  }
-  return null;
-}
+export default function () {
+  // bikeshed uses 'document-revision'
+  // but the documented convention in https://wiki.whatwg.org/wiki/MetaExtensions
+  // is just 'revision' per https://github.com/krallin/meta-revision
+  const meta = document.querySelector('meta[name="document-revision"], meta[name="revision"]');
+  const revision = meta?.content.trim();
+  // git commit shas are 40 hexadecimal characters
+  if (revision?.match(/[0-9a-f]{40}/)) {
+    return revision;
+  }
+  return null;
+}

package/src/browserlib/get-title.mjs

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

package/src/browserlib/informative-selector.mjs

@@ -1,25 +1,25 @@
-/**
- * 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',
-  '.informative-bg',
-  '.note',
-  '.issue',
-  '.example',
-  '.ednote',
-  '.annotation',
-  '.practice',
-  '.introductory',
-  '.non-normative',
-  'aside',
-  '.idlHeader',
-  '[id^=dfn-panel-]',
-  '.mdn-anno',
-  '.wpt-tests-block',
-  'details.respec-tests-details'
+/**
+ * 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',
+  '.informative-bg',
+  '.note',
+  '.issue',
+  '.example',
+  '.ednote',
+  '.annotation',
+  '.practice',
+  '.introductory',
+  '.non-normative',
+  'aside',
+  '.idlHeader',
+  '[id^=dfn-panel-]',
+  '.mdn-anno',
+  '.wpt-tests-block',
+  'details.respec-tests-details'
 ].join(',');