spec-up-t 1.1.11 → 1.1.12

package/assets/js/show-commit-hashes.js

@@ -100,13 +100,13 @@ function fetchCommitHashes() {
          .then(response => {
             if (response.status === 403 && response.headers.get('X-RateLimit-Remaining') === '0') {
                const resetTime = new Date(response.headers.get('X-RateLimit-Reset') * 1000);
-               console.error(`\n   SPEC-UP-T: Github API rate limit exceeded. Try again after ${resetTime}. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
+               console.error(`\n❌ Github API rate limit exceeded. Try again after ${resetTime}. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
 
                // Call the debounced error function
                debouncedError();
                return true;
             } else {
-               console.log(`\n   SPEC-UP-T: Github API rate limit: ${response.headers.get('X-RateLimit-Remaining')} requests remaining. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
+               console.log(`\nℹ️ Github API rate limit: ${response.headers.get('X-RateLimit-Remaining')} requests remaining. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
             }
 
             return response.json();
@@ -174,12 +174,12 @@ function fetchCommitHashes() {
 
          if (response.status === 403 && response.headers.get('X-RateLimit-Remaining') === '0') {
             const resetTime = new Date(response.headers.get('X-RateLimit-Reset') * 1000);
-            console.error(`\n   SPEC-UP-T: Github API rate limit exceeded. Try again after ${resetTime}. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
+            console.error(`❌ Github API rate limit exceeded. Try again after ${resetTime}. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
 
             debouncedError();
             return true;
          } else {
-            console.log(`\n   SPEC-UP-T: Github API rate limit: ${response.headers.get('X-RateLimit-Remaining')} requests remaining. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
+            console.log(`ℹ️ Github API rate limit: ${response.headers.get('X-RateLimit-Remaining')} requests remaining. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.` + "\n");
          }
 
          const data = await response.json();

package/index.js

@@ -246,7 +246,7 @@ module.exports = async function (options = {}) {
         try {
           noticeTitles = {};
           specGroups = {};
-          console.log('\n   SPEC-UP-T: Rendering: ' + spec.title + "\n");
+          console.log('\nℹ️ Rendering: ' + spec.title + "\n");
 
           function interpolate(template, variables) {
             return template.replace(/\${(.*?)}/g, (match, p1) => variables[p1.trim()]);
@@ -314,7 +314,7 @@ module.exports = async function (options = {}) {
           });
         }
         catch (e) {
-          console.error("\n   SPEC-UP-T: " + e + "\n");
+          console.error("\n❌ " + e + "\n");
         }
       }
 

package/package.json

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

@@ -20,22 +20,22 @@ function collectExternalReferences(options = {}) {
     const GITHUB_API_TOKEN = process.env.GITHUB_API_TOKEN;
 
     const explanationPAT =
-`\n   SPEC-UP-T: No GitHub Personal Access Token (PAT) was found.
+`❌ No GitHub Personal Access Token (PAT) was found.
 
-GitHub requires you to set up a PAT to retrieve external references.
+   GitHub requires you to set up a PAT to retrieve external references.
 
-There is no point in continuing without a PAT, so we stop here.
+   There is no point in continuing without a PAT, so we stop here.
 
-Find instructions on how to get a PAT at https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token
+   Find instructions on how to get a PAT at https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token
 
  `;
 
     const explanationNoExternalReferences =
-`\n   SPEC-UP-T: No external references were found in the specs.json file.
+`\n❌ No external references were found in the specs.json file.
 
-There is no point in continuing without external references, so we stop here.
+   There is no point in continuing without external references, so we stop here.
 
-Please add external references to the specs.json file that you will find at the root of your project.
+   Please add external references to the specs.json file that you will find at the root of your project.
 
 `;
     
@@ -45,11 +45,11 @@ Please add external references to the specs.json file that you will find at the
     // Do not run the script if the GitHub API token is not set
     if (!GITHUB_API_TOKEN) {
         console.log(explanationPAT);
-        const userInput = readlineSync.question('Press any key');
+        const userInput = readlineSync.question('ℹ️ Press any key');
 
         // React to user pressing any key
         if (userInput.trim() !== '') {
-            console.log('Stopping...');
+            console.log('ℹ️ Stopping...');
             return;
         }
     }
@@ -61,7 +61,7 @@ Please add external references to the specs.json file that you will find at the
 
         // React to user pressing any key
         if (userInput.trim() !== '') {
-            console.log('Stopping...');
+            console.log('ℹ️ Stopping...');
             return;
         }
     } else {
@@ -77,7 +77,8 @@ Please add external references to the specs.json file that you will find at the
             doesUrlExist(repo.url).then(exists => {
                 if (!exists) {
                     const userInput = readlineSync.question(
-`   SPEC-UP-T: This external reference is not a valid URL:
+`❌ This external reference is not a valid URL:
+
    Repository: ${repo.url},
    
    Terms directory: ${repo.terms_dir}
@@ -86,12 +87,12 @@ Please add external references to the specs.json file that you will find at the
 
    Do you want to stop? (yes/no): `);
                     if (userInput.toLowerCase() === 'yes' || userInput.toLowerCase() === 'y') {
-                        console.log('Stopping...');
+                        console.log('ℹ️ Stopping...');
                         process.exit(1);
                     }
                 }
             }).catch(error => {
-                console.error('\n   SPEC-UP-T:Error checking URL existence:', error);
+                console.error('❌ Error checking URL existence:', error);
             });
         });
 
@@ -118,7 +119,7 @@ Please add external references to the specs.json file that you will find at the
         // Function to extend xtref objects with additional information, such as repository URL and directory information.
         function extendXTrefs(config, xtrefs) {
             if (config.specs[0].external_specs_repos) {
-                console.log("\n   SPEC-UP-T: PLEASE NOTE: Your specs.json file is outdated (not your fault, we changed something). Use this one: https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/specs.json or e-mail kor@dwarshuis.com for help. \n");
+                console.log("ℹ️ PLEASE NOTE: Your specs.json file is outdated (not your fault, we changed something). Use this one: https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/specs.json or e-mail kor@dwarshuis.com for help. \n");
                 return;
             }
 

package/src/collectExternalReferences/checkRateLimit.js

@@ -5,12 +5,12 @@ function checkRateLimit(response) {
 
     if (response.status === 403 && remaining === '0') {
         const resetTime = new Date(reset * 1000);
-        console.error(`\n   SPEC-UP-T: Github API rate limit exceeded. Try again after ${resetTime}. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.\n`);
+        console.error(`❌ Github API rate limit exceeded. Try again after ${resetTime}. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.\n`);
         return true;
     } else if (remaining !== null) {
-        console.log(`\n   SPEC-UP-T: Github API rate limit: ${remaining} requests remaining. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.\n`);
+        console.log(`ℹ️ Github API rate limit: ${remaining} requests remaining. See https://trustoverip.github.io/spec-up-t-website/docs/getting-started/github-token for more info.\n`);
     } else {
-        console.warn(`\n   SPEC-UP-T: Unable to determine rate limit status. Check your GitHub API token and network connection.\n`);
+        console.warn(`ℹ️ Unable to determine rate limit status. Check your GitHub API token and network connection.\n`);
     }
     return false;
 }

package/src/collectExternalReferences/processXTrefsData.js

@@ -30,11 +30,11 @@ async function processXTrefsData(allXTrefs, GITHUB_API_TOKEN, outputPathJSON, ou
                 xtref.commitHash = item.sha;
                 xtref.content = item.content;
                 xtref.avatarUrl = item.repository.owner.avatar_url;
-                console.log(`\n   SPEC-UP-T: Match found for term: ${xtref.term} in ${xtref.externalSpec};`);
+                console.log(`✅ Match found for term: ${xtref.term} in ${xtref.externalSpec};`);
             } else {
                 xtref.commitHash = "not found";
                 xtref.content = "This term was not found in the external repository.";
-                console.log(`\n   SPEC-UP-T: No match found for term: ${xtref.term} in ${xtref.externalSpec};`);
+                console.log(`ℹ️ No match found for term: ${xtref.term} in ${xtref.externalSpec};`);
             }
         }
 

package/src/collectExternalReferences/setupFetchHeaders.js

@@ -6,7 +6,7 @@ function setupFetchHeaders(GITHUB_API_TOKEN) {
     if (GITHUB_API_TOKEN) {
         fetchHeaders['Authorization'] = `token ${GITHUB_API_TOKEN}`;
     } else {
-        console.log('\n   SPEC-UP-T: There is no GitHub token set up. Therefore, you are more likely to be at your limit of GitHub API requests. If you run into the limit, create a token and search the documentation on this topic.\n');
+        console.log('ℹ️ There is no GitHub token set up. Therefore, you are more likely to be at your limit of GitHub API requests. If you run into the limit, create a token and search the documentation on this topic.\n');
     }
 
     return fetchHeaders;

package/src/create-pdf.js

@@ -197,8 +197,8 @@ const pdfLib = require('pdf-lib');
         const optimizedPdfBytes = await pdfDoc.save();
         fs.writeFileSync('docs/index.pdf', optimizedPdfBytes);
 
-        console.log('\n   SPEC-UP-T: PDF generated successfully! Find the PDF in the same directory as the index.html file.' + "\n");
+        console.log('✅ PDF generated successfully! Find the PDF in the same directory as the index.html file.' + "\n");
     } catch (error) {
-        console.error('SPEC-UP-T: Error generating PDF:', error + "\n");
+        console.error('❌ Error generating PDF:', error + "\n");
     }
 })();

package/src/create-term-index.js

@@ -33,7 +33,7 @@ function createTermIndex() {
 
     fs.writeJsonSync(outputPathJSON, filePaths, { spaces: 2 });
     
-    console.log(`\n   SPEC-UP-T: The new terms were added. All done.` + "\n");
+    console.log(`✅ The new terms were added. All done.` + "\n");
 }
 
 module.exports = {

package/src/create-versions-index.js

@@ -71,9 +71,9 @@ function createVersionsIndex(outputPath) {
     const indexPath = path.join(versionsDir, 'index.html');
     fs.writeFile(indexPath, htmlContent, (err) => {
         if (err) {
-            console.error(`\n   SPEC-UP-T: Error writing index file: ${err}\n`);
+            console.error(`❌ Error writing index file: ${err}\n`);
         } else {
-            console.log(`\n   SPEC-UP-T: Index file created at ${indexPath}\n`);
+            console.log(`✅ Index file created at ${indexPath}\n`);
         }
     });
 }

package/src/fix-markdown-files.js

@@ -77,12 +77,12 @@ function fixMarkdownFiles(directory) {
                             fs.writeFileSync(itemPath, data, 'utf8');
                         }
                     } catch (err) {
-                        console.error(`\n   SPEC-UP-T: Error while trying to fix the markdown in file ${item.name}: ${err}` + "\n");
+                        console.error(`❌ Error while trying to fix the markdown in file ${item.name}: ${err}` + "\n");
                     }
                 }
             });
         } catch (err) {
-            console.error(`\n   SPEC-UP-T: Error reading directory: ${err}` + "\n");
+            console.error(`❌ Error reading directory: ${err}` + "\n");
         }
     }
 

package/src/freeze.js

@@ -87,4 +87,4 @@ const destFile = path.join(newVersionDir, 'index.html');
 fs.copyFileSync(sourceFile, destFile);
 
 // Log a message indicating the file has been copied
-console.log(`\n   SPEC-UP-T: Created a freezed specification version in ${destFile}\n`);
+console.log(`✅ Created a freezed specification version in ${destFile}\n`);

package/src/install-from-boilerplate/menu.sh

@@ -27,7 +27,7 @@ function handle_choice() {
         echo "  Goodbye! You chose to exit."
         echo -e "  ************************************\n\n"
     fi
-    echo -e "\n\n\n   SPEC-UP-T: Type 'npm run menu' to return to the main menu.\n"
+    echo -e "\n\n\nℹ️ Type 'npm run menu' to return to the main menu.\n"
 }
 
 # Function to display the introduction text

package/src/json-key-validator.js

@@ -34,7 +34,7 @@ function checkKeysSync(object, expectedKeys, parentKey = '') {
         } else if (typeof object === 'object') {
             // If the key is missing from the object, log an error
             if (!(key in object)) {
-                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/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/specs.json` + "\n");
+                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/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/specs.json` + "\n");
                 errorFound = true;
                 pauseForEnterSync(); // Pause synchronously to allow user to acknowledge the error
             }
@@ -85,7 +85,7 @@ function runJsonKeyValidatorSync() {
 
     // Iterate over each spec entry in the specs array from the JSON file
     for (let [index, spec] of data.specs.entries()) {
-        console.log(`\n   SPEC-UP-T: Checking spec #${index + 1}` + "\n");
+        console.log(`ℹ️ Checking spec #${index + 1}` + "\n");
 
         // Check for keys defined in expectedKeys.specs
         checkKeysSync(spec, expectedKeys.specs, `specs[${index}]`);
@@ -108,7 +108,7 @@ function runJsonKeyValidatorSync() {
 
     // If no errors were found, print a success message
     if (!errorFound) {
-        console.log('\n   SPEC-UP-T: All keys are present. No errors found. Continuing…' + "\n");
+        console.log('✅ All keys are present. No errors found. Continuing…' + "\n");
     }
 }
 

package/src/prepare-tref.js

@@ -111,12 +111,12 @@ ${localXTrefContent.content}
                         }
                     } catch (err) {
                         fs.writeFileSync(itemPath, match[0] + '\n\n' + '<!-- This is a copy of the saved remote text. Remove it if you like. It is automatically (re)generated -->\n\nNothing found, so nothing to show.', 'utf8');
-                        // console.error(`\n   SPEC-UP-T: Error reading or writing file ${item.name}: ${err}` + "\n");
+                        // console.error(`❌ Error reading or writing file ${item.name}: ${err}` + "\n");
                     }
                 }
             });
         } catch (err) {
-            console.error(`\n   SPEC-UP-T: Error reading directory: ${err}` + "\n");
+            console.error(`❌ Error reading directory: ${err}` + "\n");
         }
     }
 

package/src/references.js

@@ -16,7 +16,7 @@ function validateReferences(references, definitions, render) {
     }
   );
   if (unresolvedRefs.length > 0 ) {
-    console.log('\n   SPEC-UP-T: Unresolved References: ', unresolvedRefs + "\n")
+    console.log('ℹ️ Unresolved References: ', unresolvedRefs + "\n")
   }
   
   const danglingDefs = [];
@@ -27,7 +27,7 @@ function validateReferences(references, definitions, render) {
     }
   })
   if(danglingDefs.length > 0) {
-    console.log('\n   SPEC-UP-T: Dangling Definitions: ', danglingDefs + "\n")
+    console.log('ℹ️ Dangling Definitions: ', danglingDefs + "\n")
   }
 }
 
@@ -65,7 +65,7 @@ async function fetchExternalSpecs(spec) {
       createNewDLWithTerms(Object.keys(r)[0], Object.values(r)[0])
     );
   } catch (e) {
-    console.log("\n   SPEC-UP-T: " + e + "\n");
+    console.log("❌ " + e + "\n");
     return []; // Return an empty array in case of errors
   }
 }