spec-up-t 0.11.31 → 0.11.33

package/package.json

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

@@ -20,6 +20,10 @@ const specDirectories = config.specs.map(spec => spec.spec_directory + '/' + spe
 const outputPathJSON = path.join('output', 'term-relations-data.json');
 const outputPathJS = path.join('output', 'term-relations-data.js');
 
+// Create directory named “output” in the project root if it does not yet exist
+if (!fs.existsSync('output')) {
+    fs.mkdirSync('output');
+}
 
 // Create directory named “output” in the project root if it does not yet exist
 if (!fs.existsSync(config.specs[0].output_path)) {

package/src/get-xrefs-data.js

@@ -32,6 +32,22 @@ function getXrefsData() {
 
     // Function to fetch the latest commit hash of the file
     async function fetchLatestCommitHash(match) {
+        /* Example
+            console.log('match: ', match); ->
+            
+            match:  {
+                externalSpec: 'test-1',
+                term: 'Aal',
+                repoUrl: 'https://github.com/blockchainbird/spec-up-xref-test-1',
+                terms_dir: 'spec/term-definitions',
+                owner: 'blockchainbird',
+                repo: 'spec-up-xref-test-1',
+                site: 'https://blockchainbird.github.io/spec-up-xref-test-1/'
+            }
+        */
+
+        
+        
         try {
 
             if (match.repoUrl === undefined) {
@@ -61,7 +77,7 @@ function getXrefsData() {
                 throw new Error(`HTTP error! status: ${response.status}`);
             }
 
-            console.log(`Github API request for the term “${match.term}” was successful`);
+            console.log(`\nGithub API request for:\n  Term ${match.term},\n  Name: ${match.externalSpec}\n  Owner ${match.owner}\n  Repo ${match.repo}\nwas successful`);
 
             // Extract JSON data from the response, see https://blockchainbird.github.io/spec-up-t-website/docs/various-roles/developers-guide/#example-of-api-response for example response
             const data = await response.json();
@@ -73,14 +89,37 @@ function getXrefsData() {
                 return;
             }
 
-            // Process the last ten commits
-            const commits = data.slice(0, 1); // Get only the last commit
+            // Get only the last commit
+            const commits = data.slice(0, 1);
+            // Assign the fetched commit hash to the variable commitHash
             const commitHash = commits.map(commit => commit.sha);
             
-            console.log(`Commit hash found for the term “${match.term}”: `, commitHash);
-            return commitHash;
+            console.log(`\nCommit hash found for the term “${match.term}”: `, commitHash);
+
+
+            //TODO: Check if a term is in the JSON file and not in the markdown file. If so, remove the term from the JSON file.
+
+            // Check if the file exists
+            if (fs.existsSync(outputPathJSON)) {
+                // Read the JSON file
+                let currentXrefs = fs.readJsonSync(outputPathJSON);
+                // Check if the term is in the JSON file
+                currentXrefs.xrefs.forEach(xref => {
+                    // Check if the term is in the JSON file
+                    if (xref.term === match.term) {
+                        // If the term is in the JSON file, get the commit hash from the file and assign it to the variable commitHash. This is done to prevent the commit hash from being overwritten by the fetched commit hash. We want to keep the commit hash that was fetched at the time that the author looked it up.
+                        console.log(`\nThis external reference:\n Term: ${match.term}\n Name: ${match.externalSpec}\n Owner: ${match.owner}\n Repo: ${match.repo}\nis already referenced.
+                        `)
+
+                        // Give the commitHash from the JSON file to the commitHash variable
+                        commitHash = xref.commitHash;
+                    }
+                });
+            } else {
+                console.error(`File not found: ${outputPathJSON}`);
+            }
 
-            // return;
+            return commitHash;
         } catch (error) {
             console.error(`Failed to fetch commit hash for the term “${match.term}”:`, error);
         }
@@ -245,6 +284,30 @@ 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);
+
+    // 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');
+}
+
 module.exports = {
-    getXrefsData
+    getXrefsData,
+    removeXref
 }