spec-up-t 1.0.1 → 1.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "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/get-xrefs-data.js

@@ -285,37 +285,47 @@ function getXrefsData() {
 
 // Write function that removes an entry from xrefs-data.json and xrefs-data.js based on the term and externalSpec
 function removeXref(term, externalSpec) {
-    // Read the JSON file
-    let currentXrefs = fs.readJsonSync(outputPathJSON);
+    let messages = [];
 
-    // Check if the term and externalSpec exist
-    const entryExists = currentXrefs.xrefs.some(xref => xref.term === term && xref.externalSpec === externalSpec);
+    try {
+        // Read the JSON file
+        let currentXrefs = fs.readJsonSync(outputPathJSON);
 
-    if (!entryExists) {
-        console.log(`\n   SPEC-UP-T: Entry with term "${term}" and externalSpec "${externalSpec}" not found.\n`);
-        return;
-    }
+        // Check if the term and externalSpec exist
+        const entryExists = currentXrefs.xrefs.some(xref => xref.term === term && xref.externalSpec === externalSpec);
 
-    // Remove the entry from the JSON file
-    currentXrefs.xrefs = currentXrefs.xrefs.filter(xref => {
-        return !(xref.term === term && xref.externalSpec === externalSpec);
-    });
+        if (!entryExists) {
+            messages.push(`\n   SPEC-UP-T: Entry with term "${term}" and externalSpec "${externalSpec}" not found.\n`);
+            return messages;
+        }
 
-    // Convert the JSON object back to a JSON string
-    const currentXrefsStr = JSON.stringify(currentXrefs, null, 2);
+        // Remove the entry from the JSON file
+        currentXrefs.xrefs = currentXrefs.xrefs.filter(xref => {
+            return !(xref.term === term && xref.externalSpec === externalSpec);
+        });
 
-    // Write the JSON code to a .json file
-    fs.writeFileSync(outputPathJSON, currentXrefsStr, 'utf8');
+        // Convert the JSON object back to a JSON string
+        const currentXrefsStr = JSON.stringify(currentXrefs, null, 2);
 
-    // Create the JS code for the assignment
-    const stringReadyForFileWrite = `const allXrefs = ${currentXrefsStr};`;
+        // Write the JSON code to a .json file
+        fs.writeFileSync(outputPathJSON, currentXrefsStr, 'utf8');
 
-    // Write the JS code to a .js file
-    fs.writeFileSync(outputPathJS, stringReadyForFileWrite, 'utf8');
+        // Create the JS code for the assignment
+        const stringReadyForFileWrite = `const allXrefs = ${currentXrefsStr};`;
 
-    console.log(`\n   SPEC-UP-T: Entry with term "${term}" and externalSpec "${externalSpec}" removed.\n`);
+        // Write the JS code to a .js file
+        fs.writeFileSync(outputPathJS, stringReadyForFileWrite, 'utf8');
+
+        messages.push(`\n   SPEC-UP-T: Entry with term "${term}" and externalSpec "${externalSpec}" removed.\n`);
+    } catch (error) {
+        messages.push(`\n   SPEC-UP-T: An error occurred - ${error.message}\n`);
+    }
+
+    // TODO: messages are not used at the moment, since they apparently are not returned to the calling script. Fix this.
+    return messages;
 }
 
+
 module.exports = {
     getXrefsData,
     removeXref