spec-up-t 1.2.2 → 1.2.4

package/assets/js/custom-elements.js

@@ -24,17 +24,16 @@ customElements.define('slide-panels', class SidePanels extends HTMLElement {
   close (){
     this.removeAttribute('open');
   }
+
   attributeChangedCallback(attr, last, current) {
-    switch(attr) {
-      case 'open': for (let child of this.children) {
+    if (attr === 'open') {
+      for (let child of this.children) {
         if (child.id === current) child.setAttribute('open', '');
         else child.removeAttribute('open', '');
       }
-      break;
     }
   }
 });
-
 customElements.define('detail-box', class DetailBox extends HTMLElement {
   static get observedAttributes() {
     return ['open'];
@@ -60,23 +59,19 @@ customElements.define('detail-box', class DetailBox extends HTMLElement {
     this.toggleAttribute('open');
   }
   attributeChangedCallback(attr, last, current) {
-    switch(attr) {
-      case 'open':
-        for (let node of this.children) {
-          if (node.tagName === 'SECTION') {
-            if (current !== null) {
-              if (node.offsetHeight < node.scrollHeight) {
-                node.style.height = node.scrollHeight + 'px';
-              }
+    if (attr === 'open') {
+      for (let node of this.children) {
+        if (node.tagName === 'SECTION') {
+          if (current !== null) {
+            if (node.offsetHeight < node.scrollHeight) {
+              node.style.height = node.scrollHeight + 'px';
             }
-            else if (node.offsetHeight > 0) {
-              node.style.height = node.offsetHeight + 'px';
-              let scroll = this.scrollHeight;
-              node.style.height = 0;
-            }
-            break;
+          } else if (node.offsetHeight > 0) {
+            node.style.height = node.offsetHeight + 'px';
+            node.style.height = 0;
           }
         }
+      }
     }
   }
 });

package/assets/js/declare-markdown-it.js

@@ -1,5 +1,5 @@
 
-var md = window.markdownit({
+const md = window.markdownit({
    html: true, // Allow raw HTML in Markdown
    linkify: true, // Automatically convert URLs to clickable links
    typographer: true // Enable smart quotes and other typographic enhancements

package/assets/js/highlightMenuItems.js

@@ -18,7 +18,7 @@ function highlightMenuItems() {
       if (menuItem) {
          menuItem.classList.add("highlight-cfib41dyhcd99sm");
          menuItem.scrollIntoView({ behavior: "smooth", block: "center" });
-         
+
          // Dispatch custom event for the collapsible menu to handle
          document.dispatchEvent(new CustomEvent('highlight-menu-item', {
             detail: { menuItem, headingId: heading.id }
@@ -40,10 +40,10 @@ function highlightMenuItems() {
          // Update last heading in view to the first one found in the current viewport
          lastHeadingInView = headingsInView[0];
          highlightMenuItem(lastHeadingInView);
-      } else {
+      } else if (lastHeadingInView) {
          // No headings are currently in view
          // Highlight the last heading in view if it exists
-         if (lastHeadingInView) highlightMenuItem(lastHeadingInView);
+         highlightMenuItem(lastHeadingInView);
       }
    }, options);
 

package/assets/js/index.js

@@ -1,9 +1,6 @@
 
 (function(){
 
-var markdown = window.markdownit();
-
-
 /* GitHub Issues */
 
  let source = specConfig.source;
@@ -19,7 +16,7 @@ var markdown = window.markdownit();
           repo_issue_list.innerHTML = issues.map(issue => {
             return `<li class="repo-issue">
               <detail-box>
-                <section>${markdown.render(issue.body || '')}</section>
+                <section>${md.render(issue.body || '')}</section>
                 <header class="repo-issue-title">
                   <span class="repo-issue-number">${issue.number}</span>
                   <span class="repo-issue-link">
@@ -34,7 +31,6 @@ var markdown = window.markdownit();
         })
     }
   }
-  //${markdown.render(issue.body)}
 
 /* Mermaid Diagrams */
 

package/assets/js/insert-trefs.js

@@ -41,7 +41,7 @@ function insertTrefs(allXTrefs) { // Pass allXTrefs as a parameter
          const dt = termElement.closest('dt');
          if (dt) {
             const nextElement = dt.nextElementSibling;
-            if (nextElement && nextElement.classList.contains('transcluded-xref-term') &&
+            if (nextElement?.classList.contains('transcluded-xref-term') &&
                nextElement.classList.contains('meta-info-content-wrapper')) {
                return; // Already processed
             }
@@ -134,7 +134,7 @@ function insertTrefs(allXTrefs) { // Pass allXTrefs as a parameter
    }
    
 
-   if (allXTrefs && allXTrefs.xtrefs) {
+   if (allXTrefs?.xtrefs) {
       processTerms(allXTrefs);
    } else {
       console.error('allXTrefs is undefined or missing xtrefs property');

package/assets/js/modal.js

@@ -2,6 +2,9 @@
  * Displays a modal with the given content.
  *
  * @param {string} content - The HTML content to display inside the modal.
+ *
+ * Example usage:
+ * showModal('<h2>This is a Modal</h2><p>You can put any content here.</p>');
  */
 function showModal(content) {
    // Create the modal overlay
@@ -47,6 +50,3 @@ function showModal(content) {
       }
    }, { once: true });
 }
-
-// // Example usage:
-// showModal('<h2>This is a Modal</h2><p>You can put any content here.</p>');

package/assets/js/search.js

@@ -295,9 +295,9 @@ function inPageSearch() {
          */
          function hasHiddenAncestor(node) {
             while (node) {
-               if (node.classList && node.classList.contains('hidden')) {
-                  return true;
-               }
+                  if (node?.classList?.contains('hidden')) {
+                    return true;
+                  }
                node = node.parentNode;
             }
             return false;

package/assets/js/utils.js

@@ -1,4 +1,3 @@
-
 function delegateEvent(type, selector, fn, options = {}){
   return (options.container || document).addEventListener(type, e => {
     let match = e.target.closest(selector);
@@ -6,8 +5,8 @@ function delegateEvent(type, selector, fn, options = {}){
   }, options);
 }
 
-skipAnimationFrame = fn => requestAnimationFrame(() => requestAnimationFrame(fn));
+const skipAnimationFrame = fn => requestAnimationFrame(() => requestAnimationFrame(fn));
 
-var domReady = new Promise(resolve => {
+const domReady = new Promise(resolve => {
   document.addEventListener('DOMContentLoaded', e => resolve())
 });

package/index.js

@@ -1,5 +1,4 @@
 const { initialize } = require('./src/init');
-const {fetchExternalTerms} = require('./src/utils/fetch');
 
 module.exports = async function (options = {}) {
   try {
@@ -18,9 +17,6 @@ module.exports = async function (options = {}) {
     const { runJsonKeyValidatorSync } = require('./src/json-key-validator.js');
     runJsonKeyValidatorSync();
 
-    // const { createTermRelations } = require('./src/create-term-relations.js');
-    // createTermRelations();
-
     const { createTermIndex } = require('./src/create-term-index.js');
     createTermIndex();
 
@@ -31,8 +27,6 @@ module.exports = async function (options = {}) {
     const modulePath = findPkgDir(__dirname);
     let config = fs.readJsonSync('./output/specs-generated.json');
 
-    const externalTerms = fetchExternalTerms();
-
     const createExternalSpecsList = require('./src/create-external-specs-list.js');
 
     const externalSpecsList = createExternalSpecsList(config);
@@ -42,16 +36,14 @@ module.exports = async function (options = {}) {
 
     const { fixMarkdownFiles } = require('./src/fix-markdown-files.js');
 
-    // const { prepareTref } = require('./src/prepare-tref.js');
-
     let template = fs.readFileSync(path.join(modulePath, 'templates/template.html'), 'utf8');
     let assets = fs.readJsonSync(modulePath + '/src/asset-map.json');
     let externalReferences;
     let references = [];
     let definitions = [];
-    var toc;
-    var specGroups = {};
-    var noticeTitles = {};
+    let toc;
+    let specGroups = {};
+    let noticeTitles = {};
 
     const noticeTypes = {
       note: 1,
@@ -61,7 +53,7 @@ module.exports = async function (options = {}) {
       todo: 1
     };
     const spaceRegex = /\s+/g;
-    const specNameRegex = /^spec$|^spec[-]*\w+$/i;
+    const specNameRegex = /^spec$|^spec-*\w+$/i;
     const terminologyRegex = /^def$|^ref$|^xref|^tref$/i;
     const specCorpus = fs.readJsonSync(modulePath + '/assets/compiled/refs.json');
     const containers = require('markdown-it-container');
@@ -221,8 +213,6 @@ module.exports = async function (options = {}) {
       }
     ];
 
-    // prepareTref(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
-
     // Synchronously process markdown files
     fixMarkdownFiles(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
 
@@ -397,7 +387,7 @@ module.exports = async function (options = {}) {
 
       // Then filter to find the one with the terms-and-definitions-list class
       const dlElements = allDls.filter(dl => {
-        return dl.classList && dl.classList.contains('terms-and-definitions-list');
+        return dl?.classList?.contains('terms-and-definitions-list');
       });
 
       // Find any transcluded term dt elements anywhere in the document

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Technical specification drafting tool that generates rich specification documents from markdown. Forked from https://github.com/decentralized-identity/spec-up by Daniel Buchner (https://github.com/csuwildcat)",
   "main": "./index",
   "repository": {
@@ -34,7 +34,7 @@
     "gulp": "4.0.2",
     "gulp-clean-css": "4.3.0",
     "gulp-concat": "2.6.1",
-    "gulp-terser": "1.2.0",
+    "gulp-terser": "^2.1.0",
     "jsdom": "^25.0.0",
     "markdown-it": "^13.0.1",
     "markdown-it-anchor": "^9.2.0",

package/src/add-remove-xref-source.js

@@ -125,7 +125,6 @@ function updateJSON() {
         externalSpecs.push(inputs);
 
         fs.writeFileSync(JSON_FILE, JSON.stringify(data, null, 2), 'utf8');
-        // console.log(`Updated ${JSON_FILE} successfully.`);
         console.log(`Updated successfully.`);
     } catch (error) {
         console.error(`Error: Failed to update ${JSON_FILE}.`, error.message);
@@ -159,7 +158,6 @@ function removeEntry(externalSpec) {
         data.specs[0].external_specs = filteredSpecs;
 
         fs.writeFileSync(JSON_FILE, JSON.stringify(data, null, 2), 'utf8');
-        // console.log(`Removed entry with external_spec "${externalSpec}" successfully.`);
         console.log(`Removed entry successfully.`);
     } catch (error) {
         console.error(`Error: Failed to update ${JSON_FILE}.`, error.message);