spec-up-t 1.0.73 → 1.0.74

package/package.json

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

@@ -106,7 +106,7 @@ async function fetchFileContentFromCommit(GITHUB_API_TOKEN, owner, repo, commitH
     return null;
 }
 
-function updateXrefs(GITHUB_API_TOKEN) {
+function updateXrefs(GITHUB_API_TOKEN, skipExisting) {
     // Function to extend xref objects with additional information, such as repository URL and directory information.
     function extendXrefs(config, xrefs) {
         if (config.specs[0].external_specs_repos) {
@@ -211,20 +211,19 @@ function updateXrefs(GITHUB_API_TOKEN) {
 
         It checks if the xref object already has a commitHash and content.If both are present, it skips fetching the term information from GitHub. This ensures that existing commit hashes are not overwritten.
     */
-    async function fetchAllTermsInfoFromGithub() {
+    async function fetchAllTermsInfoFromGithub(skipExisting) {
         for (let xref of allXrefs.xrefs) {
-            if (!xref.commitHash || !xref.content) {
+            if (!skipExisting || (!xref.commitHash || !xref.content)) {
                 const fetchedData = await fetchTermInfoFromGithub(GITHUB_API_TOKEN, xref);
                 if (fetchedData) {
                     xref.commitHash = fetchedData.commitHash;
                     xref.content = fetchedData.content;
                 }
-            }
-        }
+            }        }
     }
 
     // Fetch all term information, then write the results to JSON and JS files.
-    fetchAllTermsInfoFromGithub().then(() => {
+    fetchAllTermsInfoFromGithub(skipExisting).then(() => {
         const allXrefsStr = JSON.stringify(allXrefs, null, 2);
         fs.writeFileSync(outputPathJSON, allXrefsStr, 'utf8');
         const stringReadyForFileWrite = `const allXrefs = ${allXrefsStr};`;
@@ -238,96 +237,7 @@ function updateXrefs(GITHUB_API_TOKEN) {
     });
 }
 
-// Function to remove a specific xref from the JSON file, based on term and externalSpec.
-function removeXref(term, externalSpec) {
-    let messages = [];
-
-    try {
-        // Read the JSON file
-        let currentXrefs = fs.readJsonSync(outputPathJSON);
-
-        // Check if the term and externalSpec exist
-        const entryExists = currentXrefs.xrefs.some(xref => 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;
-        }
-
-        // Remove the entry from the JSON file
-        currentXrefs.xrefs = currentXrefs.xrefs.filter(xref => {
-            return !(xref.term === term && xref.externalSpec === externalSpec);
-        });
-
-        // Convert the JSON object back to a JSON string
-        const currentXrefsStr = JSON.stringify(currentXrefs, null, 2);
-
-        // Write the JSON code to a .json file
-        fs.writeFileSync(outputPathJSON, currentXrefsStr, 'utf8');
-
-        // Create the JS code for the assignment
-        const stringReadyForFileWrite = `const allXrefs = ${currentXrefsStr};`;
-
-        // 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`);
-
-        // 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`);
-    }
-
-    // TODO: messages are not used at the moment, since they apparently are not returned to the calling script. Fix this.
-
-    return messages;
-}
-
-function addXref(term, externalSpec) {
-    let messages = [];
-
-    try {
-        // Read the JSON file
-        let currentXrefs = fs.readJsonSync(outputPathJSON);
-
-        // Check if the term and externalSpec exist
-        const entryExists = currentXrefs.xrefs.some(xref => xref.term === term && xref.externalSpec === externalSpec);
-
-        if (entryExists) {
-            messages.push(`\n   SPEC-UP-T: Entry with term "${term}" and externalSpec "${externalSpec}" already exists.\n`);
-            return messages;
-        }
-
-        // Add the entry to the JSON file
-        currentXrefs.xrefs.push({ term, externalSpec });
-
-        // Convert the JSON object back to a JSON string
-        const currentXrefsStr = JSON.stringify(currentXrefs, null, 2);
-
-        // Write the JSON code to a .json file
-        fs.writeFileSync(outputPathJSON, currentXrefsStr, 'utf8');
-
-        // Create the JS code for the assignment
-        const stringReadyForFileWrite = `const allXrefs = ${currentXrefsStr};`;
-
-        // 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}" added.\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`);
-    }
-}
-
 // Export the updateXrefs and removeXref functions for use in other modules.
 module.exports = {
-    updateXrefs,
-    removeXref,
-    addXref
+    updateXrefs
 }