spec-up-t 0.11.39 → 0.11.40

package/index.js

@@ -16,12 +16,15 @@ module.exports = function(options = {}) {
   const { createTermRelations } = require('./src/create-term-relations.js');
   createTermRelations();
 
+  const { insertTermIndex } = require('./src/insert-term-index.js');
+  insertTermIndex();
+
   const gulp = require('gulp');
   const fs = require('fs-extra');
   const path = require('path');
   const findPkgDir = require('find-pkg-dir');
   const modulePath = findPkgDir(__dirname);
-  let config = fs.readJsonSync('./specs.json');
+  let config = fs.readJsonSync('./output/specs-generated.json');
   let assets = fs.readJsonSync(modulePath + '/src/asset-map.json');
   let externalReferences;
   let references = [];
@@ -49,7 +52,7 @@ module.exports = function(options = {}) {
       xrefsData = '<script>' + fs.readFileSync(inputPath, 'utf8') + '</script>';
     }
   } catch (error) {
-    console.error(error);
+    console.error("\n   SPEC-UP-T: " + error + "\n");
   }
 
   function applyReplacers(doc) {
@@ -228,7 +231,7 @@ module.exports = function(options = {}) {
       try {
         noticeTitles = {};
         specGroups = {};
-        console.log('Rendering: ' + spec.title);
+        console.log('\n   SPEC-UP-T: Rendering: ' + spec.title + "\n");
         return new Promise(async (resolve, reject) => {
           Promise.all((spec.markdown_paths || ['spec.md']).map(_path => {
             return fs.readFile(spec.spec_directory + _path, 'utf8').catch(e => reject(e))
@@ -325,7 +328,7 @@ module.exports = function(options = {}) {
         });
       }
       catch(e) {
-        console.error(e);
+        console.error("\n   SPEC-UP-T: " + e + "\n");
       }
     }
 
@@ -397,7 +400,7 @@ module.exports = function(options = {}) {
 
   }
   catch(e) {
-    console.error(e);
+    console.error("\n   SPEC-UP-T: " + e + "\n");
   }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "0.11.39",
+  "version": "0.11.40",
   "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/references.js

@@ -16,7 +16,7 @@ function validateReferences(references, definitions, render) {
     }
   );
   if (unresolvedRefs.length > 0 ) {
-    console.log('Unresolved References: ', unresolvedRefs)
+    console.log('\n   SPEC-UP-T: Unresolved References: ', unresolvedRefs + "\n")
   }
   
   const danglingDefs = [];
@@ -27,7 +27,7 @@ function validateReferences(references, definitions, render) {
     }
   })
   if(danglingDefs.length > 0) {
-    console.log('Dangling Definitions: ', danglingDefs)
+    console.log('\n   SPEC-UP-T: Dangling Definitions: ', danglingDefs + "\n")
   }
 }
 
@@ -55,7 +55,7 @@ async function fetchExternalSpecs(spec){
     results = results.map((r, index) => (r.status === 200 ? { [Object.keys(spec.external_specs[index])[0]]: r.data } : null)).filter(r_1 => r_1);
     return results.map(r_2 => createNewDLWithTerms(Object.keys(r_2)[0], Object.values(r_2)[0]));
   } catch (e) {
-    return console.log(e);
+    return console.log("\n   SPEC-UP-T: " + e + "\n");
   }
 }
 

package/src/create-pdf.js

@@ -38,8 +38,8 @@ const path = require('path');
         // Close the browser instance
         await browser.close();
 
-        console.log('PDF generated successfully! Find the PDF in the same directory as the index.html file.');
+        console.log('\n   SPEC-UP-T: PDF generated successfully! Find the PDF in the same directory as the index.html file.' + "\n");
     } catch (error) {
-        console.error('Error generating PDF:', error);
+        console.error('SPEC-UP-T: Error generating PDF:', error + "\n");
     }
 })();

package/src/create-term-index.js

@@ -0,0 +1,41 @@
+/**
+ * Creates a term index by reading specifications from a JSON file and generating a list of file paths.
+ * The list of file paths is then written to a JSON file in the project root directory.
+ *
+ * Steps:
+ * 1. Reads the configuration from 'specs.json'.
+ * 2. Extracts the directories containing the specifications and terms.
+ * 3. Lists all file names in the specified terms directory.
+ * 4. Joins each file name with the terms directory path.
+ * 5. Creates an 'output' directory in the project root if it does not exist.
+ * 6. Writes the list of file paths to 'term-index.json' in the project root.
+ *
+ * @requires fs-extra - File system operations with extra methods.
+ * @requires path - Utilities for working with file and directory paths.
+ * @file src/create-term-index.js
+ * @author Kor Dwarshuis
+ * @version 1.0.0
+ * @since 2024-09-02
+ */
+
+function createTermIndex() {
+    const fs = require('fs-extra');
+    const path = require('path');
+    const config = fs.readJsonSync('specs.json');
+    const specDirectories = config.specs.map(spec => spec.spec_directory);
+    const specTermDirectoryName = config.specs.map(spec => spec.spec_terms_directory);
+    const outputPathJSON = './term-index.json';
+    const files = fs.readdirSync(path.join(specDirectories[0], specTermDirectoryName[0]));
+
+    const filePaths = files.map(file => specTermDirectoryName[0] + '/' + file);
+
+    if (!fs.existsSync('output')) {
+        fs.mkdirSync('output');
+    }
+
+    fs.writeJsonSync(outputPathJSON, filePaths, { spaces: 2 });
+}
+
+module.exports = {
+    createTermIndex
+}

package/src/create-term-relations.js

@@ -7,7 +7,8 @@
 
 const fs = require('fs-extra');
 const config = fs.readJsonSync('specs.json');
-const specDirectories = config.specs.map(spec => spec.spec_directory + '/' + spec.spec_terms_directory);
+
+const specTermDirectoryName = config.specs.map(spec => spec.spec_directory + '/' + spec.spec_terms_directory);
 
 
 // Create a path for the output file in the project root
@@ -35,8 +36,7 @@ function createTermRelations() {
     allDefs.defs = new Set();
 
     // Go through all directories that contain files with a term and definition
-    console.log('All “spec_directory” found in specs.json: ', specDirectories);
-    specDirectories.forEach(specDirectory => {
+    specTermDirectoryName.forEach(specDirectory => {
         // read directory
         fs.readdirSync(specDirectory).forEach(file => {
             // read file

package/src/fix-markdown-files.js

@@ -15,7 +15,7 @@ function processMarkdownFiles(directory) {
         // Read the contents of the directory
         fs.readdir(directory, { withFileTypes: true }, (err, items) => {
             if (err) {
-                console.error(`Error reading directory: ${err}`);
+                console.error(`\n   SPEC-UP-T: Error reading directory: ${err}` + "\n");
                 return;
             }
 
@@ -29,7 +29,7 @@ function processMarkdownFiles(directory) {
                     // If the item is a markdown file, process it
                     fs.readFile(itemPath, 'utf8', (err, data) => {
                         if (err) {
-                            console.error(`Error reading file ${item.name}: ${err}`);
+                            console.error(`\n   SPEC-UP-T: Error reading file ${item.name}: ${err}` + "\n");
                             return;
                         }
 
@@ -40,9 +40,9 @@ function processMarkdownFiles(directory) {
                             // Write the modified content back to the file
                             fs.writeFile(itemPath, data, 'utf8', err => {
                                 if (err) {
-                                    console.error(`Error writing file ${item.name}: ${err}`);
+                                    console.error(`\n   SPEC-UP-T: Error writing file ${item.name}: ${err}` + "\n");
                                 } else {
-                                    console.log(`Added blank line to ${item.name}`);
+                                    console.log(`\n   SPEC-UP-T: Added blank line to ${item.name}` + "\n");
                                 }
                             });
                         }

package/src/get-xrefs-data.js

@@ -51,7 +51,7 @@ function getXrefsData() {
         try {
 
             if (match.repoUrl === undefined) {
-                console.log('match.repoUrl is undefined');
+                console.log('\n   SPEC-UP-T: match.repoUrl is undefined' + "\n");
                 return;
             }
 
@@ -68,7 +68,7 @@ function getXrefsData() {
             // Check for rate limit before proceeding
             if (response.status === 403 && response.headers.get('X-RateLimit-Remaining') === '0') {
                 const resetTime = new Date(response.headers.get('X-RateLimit-Reset') * 1000);
-                console.error(`Github API rate limit exceeded. Try again after ${resetTime}`);
+                console.error(`\n   SPEC-UP-T: Github API rate limit exceeded. Try again after ${resetTime}` + "\n");
                 return;
             }
 
@@ -77,14 +77,14 @@ function getXrefsData() {
                 throw new Error(`HTTP error! status: ${response.status}`);
             }
 
-            console.log(`\nGithub API request for:\n  Term ${match.term},\n  Name: ${match.externalSpec}\n  Owner ${match.owner}\n  Repo ${match.repo}\nwas successful`);
+            console.log(`\n   SPEC-UP-T: Github API request for:\n   Term ${match.term},\n   Name: ${match.externalSpec}\n   Owner ${match.owner}\n   Repo ${match.repo}\n   was successful` + "\n");
 
             // 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();
 
             // Check if there are any commits
             if (data.length === 0) {
-                console.log(`No commit hash found for the term “${match.term}”`);
+                console.log(`\n   SPEC-UP-T: No commit hash found for the term “${match.term}”` + "\n");
 
                 return;
             }
@@ -94,7 +94,7 @@ function getXrefsData() {
             // Assign the fetched commit hash to the variable commitHash
             let commitHash = commits.map(commit => commit.sha);
             
-            console.log(`\nCommit hash found for the term “${match.term}”: `, commitHash);
+            console.log(`\n   SPEC-UP-T: Commit hash found for the term “${match.term}”: `, commitHash + "\n");
 
 
             //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.
@@ -108,20 +108,20 @@ function getXrefsData() {
                     // 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.
-                        `)
+                        console.log(`\n   SPEC-UP-T: This external reference:\n Term: ${match.term}\n Name: ${match.externalSpec}\n Owner: ${match.owner}\n Repo: ${match.repo}\nis already referenced.
+                        ` + "\n")
 
                         // Give the commitHash from the JSON file to the commitHash variable
                         commitHash = xref.commitHash;
                     }
                 });
             } else {
-                console.log(`File not found at this point: ${outputPathJSON}. Don't worry, it will be created later.`);
+                console.log(`\n   SPEC-UP-T: File not found at this point: ${outputPathJSON}. Don't worry, it will be created later.` + "\n");
             }
 
             return commitHash;
         } catch (error) {
-            console.error(`Failed to fetch commit hash for the term “${match.term}”:`, error);
+            console.error(`\n   SPEC-UP-T: Failed to fetch commit hash for the term “${match.term}”:`, error + "\n");
         }
     }
 
@@ -132,21 +132,20 @@ function getXrefsData() {
     }
 
     // Go through all directories that contain files with a term and definition
-    console.log("All “spec_directory”'s found in specs.json: ", specTermsDirectories);
     specTermsDirectories.forEach(specDirectory => {
-        console.log(`Current spec_directory: `, specDirectory);
+        console.log(`\n   SPEC-UP-T: Current spec_directory: `, specDirectory + "\n");
         // read directory
         fs.readdirSync(specDirectory).forEach(file => {
             // read file
             if (file.endsWith('.md')) {
-                console.log(`Markdown file referenced in spec_directory: `, file);
+                console.log(`\n   SPEC-UP-T: Markdown file referenced in spec_directory: `, file + "\n");
                 const markdown = fs.readFileSync(`${specDirectory}/${file}`, 'utf8');
                 // create regex that finds “[[xref:.*]]”
                 const regex = /\[\[xref:.*?\]\]/g;
                 if (regex.test(markdown)) {
                     const xrefs = markdown.match(regex);
                     xrefs.forEach(xref => {
-                        console.log(`Xref found in ${file}: `, xref);
+                        console.log(`\n   SPEC-UP-T: Xref found in ${file}: `, xref + "\n");
                         // example of xref: [xref: test-1, Aal]
                         allXrefs.xrefs.add(xref);
                     });
@@ -220,7 +219,7 @@ function getXrefsData() {
     // Step 6: add the owner and repo to the xref object
     allXrefs.xrefs.forEach(xref => {
         if (xref.repoUrl === undefined) {
-            console.log('match.repoUrl is undefined');
+            console.log('\n   SPEC-UP-T: match.repoUrl is undefined' + "\n");
             return;
         }
 

package/src/insert-term-index.js

@@ -0,0 +1,44 @@
+/**
+ * Inserts term index into the specification.
+ *
+ * This function inserts the entries in term-index.json 
+ * term directories, and updates the specification with the term index.
+ *
+ * @function
+ * @name insertTermIndex
+ * @returns {void}
+ * @file src/insert-term-index.js
+ * @author Kor Dwarshuis
+ * @version 1.0.0
+ * @since 2024-09-02
+ */
+
+function insertTermIndex() {
+    const fs = require('fs-extra');
+    const path = require('path');
+    const config = fs.readJsonSync('./specs.json');
+    const terms = fs.readJsonSync('./term-index.json');
+    const outputPathJSON = path.join('output', 'specs-generated.json');
+    let specGenerated = config;
+    let markdownPaths = specGenerated.specs[0].markdown_paths;
+
+    const index = markdownPaths.indexOf('terms-and-definitions-intro.md');
+    if (index !== -1) {
+        // Insert the items of the "terms" array after the found index
+        markdownPaths.splice(index + 1, 0, ...terms);
+    }
+
+    // Save the updated specGenerated object back to the JSON file
+    fs.writeJsonSync(outputPathJSON, specGenerated, { spaces: 2 });
+
+    // Create directory named “output” in the project root if it does not yet exist
+    if (!fs.existsSync('output')) {
+        fs.mkdirSync('output');
+    }
+
+    fs.writeJsonSync(outputPathJSON, specGenerated, { spaces: 2 });
+}
+
+module.exports = {
+    insertTermIndex
+}

package/src/json-key-validator.js

@@ -20,7 +20,7 @@ function checkKeysSync(object, expectedKeys, parentKey = '') {
             }
         } else if (typeof object === 'object') {
             if (!(key in object)) {
-                console.error(`   Error: Missing key '${key}' in ${parentKey}\n   We cannot guarantee that Spec-Up-T will work properly.\n   Here is an example specs.json file:\n   https://github.com/blockchainbird/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/specs.json`);
+                console.error(`\n   SPEC-UP-T: Error: Missing key '${key}' in ${parentKey}\n   We cannot guarantee that Spec-Up-T will work properly.\n   Here is an example specs.json file:\n   https://github.com/blockchainbird/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/specs.json` + "\n");
                 errorFound = true;
                 pauseForEnterSync(); // Pause synchronously
             }
@@ -67,7 +67,7 @@ function runJsonKeyValidatorSync() {
     };
 
     for (let [index, spec] of data.specs.entries()) {
-        console.log(`   Checking spec #${index + 1}`);
+        console.log(`\n   SPEC-UP-T: Checking spec #${index + 1}` + "\n");
         checkKeysSync(spec, expectedKeys.specs, `specs[${index}]`);
 
         if (spec.source) {
@@ -84,7 +84,7 @@ function runJsonKeyValidatorSync() {
     }
 
     if (!errorFound) {
-        console.log('   All keys are present. No errors found. Continue…');
+        console.log('\n   SPEC-UP-T: All keys are present. No errors found. Continuing…' + "\n");
     }
 }