spec-up-t 1.0.61 → 1.0.72

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.0.61",
+  "version": "1.0.72",
   "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-term-relations.js

@@ -6,6 +6,7 @@
  */
 
 const fs = require('fs-extra');
+const path = require('path');
 const config = fs.readJsonSync('specs.json');
 
 const specTermDirectoryName = config.specs.map(spec => spec.spec_directory + '/' + spec.spec_terms_directory);

package/src/get-xrefs-data.js

@@ -30,12 +30,13 @@ const outputPathJS = 'output/xrefs-data.js';
 const outputPathJSTimeStamped = 'output/xrefs-history/xrefs-data-' + Date.now() + '.js';
 
 
-function getXrefsData(GITHUB_API_TOKEN) {
+function addAllXrefs(GITHUB_API_TOKEN) {
     // Set headers for GitHub API requests. Include an authorization token if provided.
     const fetchHeaders = {
         'Accept': 'application/vnd.github.v3+json'
     };
 
+    // If GITHUB_API_TOKEN is present, it adds an Authorization header to the fetchHeaders object with the value set to token ${GITHUB_API_TOKEN}. This header is used to authenticate requests to the GitHub API, allowing the user to make authenticated requests which have higher rate limits compared to unauthenticated requests.
     if (GITHUB_API_TOKEN) {
         fetchHeaders['Authorization'] = `token ${GITHUB_API_TOKEN}`;
     } else {
@@ -110,7 +111,7 @@ function getXrefsData(GITHUB_API_TOKEN) {
                 });
 
                 // Loop through "external_specs" to find the site URL for each xref
-                
+
                 xref.site = null;
                 if (spec.external_specs) {
                     spec.external_specs.forEach(externalSpec => {
@@ -204,8 +205,12 @@ function getXrefsData(GITHUB_API_TOKEN) {
         const stringReadyForFileWrite = `const allXrefs = ${allXrefsStr};`;
         fs.writeFileSync(outputPathJS, stringReadyForFileWrite, 'utf8');
         fs.writeFileSync(outputPathJSTimeStamped, stringReadyForFileWrite, 'utf8');
+
+        // Run the render function to update the HTML file
+        require('../index.js')({ nowatch: true });
+    }).catch(err => {
+        console.error('Error:', err);
     });
-    require('../index.js')({ nowatch: true });
 }
 
 // Function to remove a specific xref from the JSON file, based on term and externalSpec.
@@ -242,19 +247,21 @@ function removeXref(term, externalSpec) {
         fs.writeFileSync(outputPathJS, stringReadyForFileWrite, 'utf8');
 
         messages.push(`\n   SPEC-UP-T: Entry with term "${term}" and externalSpec "${externalSpec}" removed.\n`);
+
+        // Run the render function to update the HTML file
+        require('../index.js')({ nowatch: true });
+
     } catch (error) {
         messages.push(`\n   SPEC-UP-T: An error occurred - ${error.message}\n`);
     }
 
-    require('../index.js')({ nowatch: true });
-
     // TODO: messages are not used at the moment, since they apparently are not returned to the calling script. Fix this.
-    
+
     return messages;
 }
 
-// Export the getXrefsData and removeXref functions for use in other modules.
+// Export the addAllXrefs and removeXref functions for use in other modules.
 module.exports = {
-    getXrefsData,
+    addAllXrefs,
     removeXref
 }

package/src/json-key-validator.js

@@ -70,7 +70,7 @@ function runJsonKeyValidatorSync() {
             "repo"
         ],
         external_specs: [
-            "gh-page",
+            "gh_page",
             "external_spec",
             "url",
             "terms_dir"

package/src/references.js

@@ -48,7 +48,7 @@ async function fetchExternalSpecs(spec) {
   try {
     let results = await Promise.all(
       spec.external_specs.map(s => {
-        const url = s["gh-page"]; // Access the "gh-page" URL directly
+        const url = s["gh_page"]; // Access the "gh_page" URL directly
         return axios.get(url);
       })
     );