spec-up-t 1.1.50 → 1.1.51

package/index.js

@@ -30,6 +30,10 @@ module.exports = async function (options = {}) {
     const modulePath = findPkgDir(__dirname);
     let config = fs.readJsonSync('./output/specs-generated.json');
 
+    const createExternalSpecsList = require('./src/create-external-specs-list.js');
+
+    const externalSpecsList = createExternalSpecsList(config);
+
     const createVersionsIndex = require('./src/create-versions-index.js');
     createVersionsIndex(config.specs[0].output_path);
 
@@ -307,7 +311,8 @@ module.exports = async function (options = {}) {
             specLogo: spec.logo,
             specFavicon: spec.favicon,
             specLogoLink: spec.logo_link,
-            spec: JSON.stringify(spec)
+            spec: JSON.stringify(spec),
+            externalSpecsList: externalSpecsList,
           });
 
           const outputPath = path.join(spec.destination, 'index.html');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.1.50",
+  "version": "1.1.51",
   "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": {

package/src/create-external-specs-list.js

@@ -0,0 +1,52 @@
+/**
+ * Creates an HTML list of external specifications based on the provided configuration.
+ *
+ * @param {object} config - The configuration object containing specification details.
+ * @param {Array<object>} config.specs - An array of specification objects.
+ * @param {Array<object>} config.specs[].external_specs - An array of external specification objects.
+ * @param {string} config.specs[].external_specs[].external_spec - The name of the external specification.
+ * @param {string} config.specs[].external_specs[].url - The URL of the external specification.
+ * @param {string} config.specs[].external_specs[].gh_page - The GitHub page of the external specification.
+ *
+ * @returns {string} An HTML string representing the list of external specifications.
+ *         Returns a message indicating no specifications were found if the configuration is invalid or empty.
+ */
+
+module.exports = function createExternalSpecsList(config) {
+    if (!config || !config.specs || !Array.isArray(config.specs)) {
+        console.warn('❌ Invalid config format. Expected an object with a specs array.');
+        return '<p>No external specifications found.</p>';
+    }
+
+    let externalSpecs = [];
+    config.specs.forEach(spec => {
+        if (spec.external_specs && Array.isArray(spec.external_specs)) {
+            externalSpecs = externalSpecs.concat(spec.external_specs);
+        }
+    });
+
+    if (externalSpecs.length === 0) {
+        return '<p>No external specifications found.</p>';
+    }
+
+    let html = '<ul class="list-group">';
+
+    externalSpecs.forEach(spec => {
+        html += `
+      <li class="list-group-item border-0 p-0 ps-3">
+        <p>
+          ${spec.external_spec}:
+          <a href="${spec.url}" target="_blank" class="">
+            <i class="fa fa-link"></i> URL
+          </a>
+          <a href="${spec.gh_page}" target="_blank" class="">
+            <i class="fa fa-github"></i> GitHub Page
+          </a>
+        </p>
+      </li>
+    `;
+    });
+
+    html += '</ul>';
+    return html;
+};

package/templates/template.html

@@ -247,7 +247,9 @@
             </button>
             <!-- href added via JS -->
             <a id="snapshotLink" class="btn btn-menu-item m-0 mb-1 border-start-0 border-end-0" href="#">Snapshots</a>
-
+            <hr>
+            <p class="ps-3 pe-3">External specifications:</p>
+            ${externalSpecsList}
         </div>
     </div>