spec-up-t 1.3.0 → 1.4.0

package/src/init.js

@@ -1,5 +1,6 @@
 const fs = require('fs-extra');
 const path = require('path');
+const Logger = require('./utils/logger');
 const outputDir = path.join(process.cwd(), '.cache');
 const initFlagPath = path.join(outputDir, 'init.flag');
 
@@ -20,9 +21,9 @@ async function initialize() {
         // Create the init flag file
         await fs.writeFile(initFlagPath, 'Initialization completed.');
 
-        console.log('Initialization complete.');
+        Logger.success('Initialization complete.');
     } catch (error) {
-        console.error(`Initialization failed: ${error.message}`);
+        Logger.error(`Initialization failed: ${error.message}`);
     }
 }
 

package/src/install-from-boilerplate/add-gitignore-entries.js

@@ -1,4 +1,5 @@
 const fs = require('fs').promises;
+const Logger = require('../utils/logger');
 
 /**
  * Reads the content of a file or returns an empty string if the file does not exist.
@@ -42,9 +43,9 @@ async function updateGitignore(gitignorePath, filesToAdd) {
         // Write the updated content back to the .gitignore file
         await fs.writeFile(gitignorePath, updatedGitignoreContent, 'utf8');
 
-        console.log('✅ Updated .gitignore file');
+        Logger.success('Updated .gitignore file');
     } catch (error) {
-        console.error('❌ Error updating .gitignore:', error.message);
+        Logger.error('Error updating .gitignore:', error.message);
     }
 }
 

package/src/install-from-boilerplate/add-scripts-keys.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const Logger = require('../utils/logger');
 
 /**
  * Adds scripts to the package.json file.
@@ -15,7 +16,7 @@ function addScriptsKeys(scriptKeys, overwriteKeys = {}) {
     // Read the package.json file
     fs.readFile(packageJsonPath, 'utf8', (err, data) => {
         if (err) {
-            console.error('❌ Error reading package.json:', err);
+            Logger.error('Error reading package.json:', err);
             return;
         }
 
@@ -38,13 +39,13 @@ function addScriptsKeys(scriptKeys, overwriteKeys = {}) {
             // Write the updated package.json back to disk
             fs.writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2), 'utf8', (err) => {
                 if (err) {
-                    console.error('❌ Error writing package.json:', err);
+                    Logger.error('Error writing package.json:', err);
                 } else {
-                    console.log('✅ Scripts added to package.json successfully!');
+                    Logger.success('Scripts added to package.json successfully!');
                 }
             });
         } catch (parseError) {
-            console.error('❌ Error parsing package.json:', parseError);
+            Logger.error('Error parsing package.json:', parseError);
         }
     });
 }

package/src/install-from-boilerplate/boilerplate/.github/workflows/menu.yml

@@ -3,23 +3,27 @@ name: Run Menu
 on:
   workflow_dispatch:
     inputs:
-      script:
-        description: 'Select the script to run'
-        type: choice
+      action_type:
+        description: 'Action to perform'
         required: true
-        default: 'Render specification'
+        default: 'render'
+        type: choice
         options:
-          - Add content
-          - Render specification
-          - Export to PDF
-          - Export to DOCX
-          - Collect external references
-          - Add, remove or view xref source
-          - Configure
-          - Run health check
-          - Open documentation website
-          - Freeze specification
-          - Custom update
+          - render
+          - topdf
+          - todocx
+          - freeze
+          - custom-update
+          - collectExternalReferences
+      repository:
+        description: 'Repository'
+        required: false
+      branch:
+        description: 'Branch'
+        required: false
+      triggered_by:
+        description: 'Triggered by'
+        required: false
 
 jobs:
   build-and-deploy-spec:
@@ -58,106 +62,79 @@ jobs:
         env:
           MY_PAT: ${{ secrets.MY_PAT }} # Make the secret available as an env var
         run: |
-          case "${{ github.event.inputs.script }}" in
-            "Add content")
-              echo "You can start adding your content to the markdown files in the 'spec' directory."
-              echo "You can do this by editing local files in an editor or by going to your repository on GitHub."
-              echo "More info: https://blockchainbird.github.io/spec-up-t-website/docs/various-roles/content-authors-guide/introduction"
+          case "${{ github.event.inputs.action_type }}" in
+            render)
+              npm run render
               ;;
-            "Render specification")
-              node --no-warnings -e "require('spec-up-t/index.js')({ nowatch: true })"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Render specification: Update files" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            topdf)
+              npm run topdf
               ;;
-            # ...existing code...
-            "Export to DOCX")
-              node -e "require('spec-up-t/src/create-docx.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Export to DOCX" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            todocx)
+              npm run todocx
               ;;
-            "Collect external references")
-              node --no-warnings -e "require('spec-up-t/src/collect-external-references.js').collectExternalReferences({ pat: process.env.MY_PAT })"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Collect external references" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            freeze)
+              npm run freeze
               ;;
-            "Export to PDF")
-              node -e "require('spec-up-t/src/create-pdf.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Export to PDF" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            custom-update)
+              npm run custom-update
               ;;
-            "Freeze specification")
-              node -e "require('spec-up-t/src/freeze.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Freeze specification" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            collectExternalReferences)
+              npm run collectExternalReferences
+              ;;
+            *)
+              echo "Unknown action_type: ${{ github.event.inputs.action_type }}"
+              exit 1
+              ;;
+          esac
+
+      - name: Commit and push changes
+        if: success()
+        run: |
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
+          
+          # Add all changes
+          git add .
+          
+          # Commit with appropriate message
+          case "${{ github.event.inputs.action_type }}" in
+            render)
+              git commit -m "Render specification: Update files" || echo "No changes to commit"
               ;;
-            "Add, remove or view xref source")
-              node --no-warnings -e "require('spec-up-t/src/add-remove-xref-source.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Add, remove or view xref source" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            topdf)
+              git commit -m "Export to PDF" || echo "No changes to commit"
               ;;
-            "Configure")
-              node --no-warnings -e "require('spec-up-t/src/configure.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Configure" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            todocx)
+              git commit -m "Export to DOCX" || echo "No changes to commit"
               ;;
-            "Run health check")
-              node --no-warnings -e "require('spec-up-t/src/health-check.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
-              git commit -m "Run health check" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
+            collectExternalReferences)
+              git commit -m "Collect external references" || echo "No changes to commit"
               ;;
-            "Open documentation website")
-              echo "Opening documentation website: https://blockchainbird.github.io/spec-up-t-website/"
-              echo "Please visit the URL manually: https://blockchainbird.github.io/spec-up-t-website/"
+            freeze)
+              git commit -m "Freeze specification" || echo "No changes to commit"
               ;;
-            "Custom update")
-              npm update && node -e "require('spec-up-t/src/install-from-boilerplate/custom-update.js')"
-              git config --global user.email "actions@github.com"
-              git config --global user.name "GitHub Actions"
-              git add .
+            custom-update)
               git commit -m "Custom update: Copy files from spec-up-t" || echo "No changes to commit"
-              git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
               ;;
             *)
-              echo "Unknown script: ${{ github.event.inputs.script }}"
-              exit 1
+              git commit -m "Update files: ${{ github.event.inputs.action_type }}" || echo "No changes to commit"
               ;;
           esac
+          
+          # Push changes
+          git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
 
-      - name: Deploy to GitHub Pages
-        if: success() && github.event.inputs.script != 'Add content' && github.event.inputs.script != 'Open documentation website' && github.event.inputs.script != 'Configure' && github.event.inputs.script != 'Run health check'
-        uses: peaceiris/actions-gh-pages@v3.7.3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ${{ env.OUTPUT_PATH }}
-          allow_empty_commit: true
-          force_orphan: true
+      - name: Commit output files
+        if: success()
+        run: |
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
+          git add "$OUTPUT_PATH"
+          git commit -m "Update output files in $OUTPUT_PATH" || echo "No changes to commit in output directory"
+          git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:main
 
       - name: Clean up
         if: always()
         run: |
           echo "Cleaning up..."
-          rm -rf node_modules
+          rm -rf node_modules

package/src/install-from-boilerplate/boilerplate/README.md

@@ -1,5 +1,5 @@
 # Documentation
 
-Read more about Spec-Up-T in the [documentation](https://blockchainbird.github.io/spec-up-t-website/).
+Read more about Spec-Up-T in the [documentation](https://trustoverip.github.io/spec-up-t-website/).
 
 Written: 2025-02-27T15:38

package/src/install-from-boilerplate/boilerplate/spec/example-markup-in-markdown.md

@@ -245,7 +245,7 @@ graph TD
 ```
 </pre>
 
-```js
+```chart
 {
   "type": "pie",
   "data": {

package/src/install-from-boilerplate/boilerplate/spec/spec-head.md

@@ -2,6 +2,6 @@
 
 ## Intro
 
-This is a default Spec-Up-T installation. Find information on the [Spec-Up-T documentation website](https://blockchainbird.github.io/spec-up-t-website/).
+This is a default Spec-Up-T installation. Find information on the [Spec-Up-T documentation website](https://trustoverip.github.io/spec-up-t-website/).
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+This is a demo site for Spec-Up-T. The subject matter – gardening and related terms – is used purely as an example to demonstrate how the system works. You can replace these demo terms and definitions with your own content to suit your documentation needs.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/composability.md

@@ -0,0 +1,3 @@
+[[tref: KERISuite, composability ]]
+
+~ Note: composability is not the same as compostability.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/compost.md

@@ -0,0 +1,3 @@
+[[def: compost, composting, Compost]]
+
+~ Compost is a mixture of decayed organic matter used to fertilize soil. It is created through the process of composting, where materials like leaves, food scraps, and grass clippings break down over time. Compost improves soil structure and provides nutrients for plants. See also [[ref: Mulch]], [[ref: Soil]], [[ref: Fertilizer]], [[ref: Seedling]], [[ref: Watering]].

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/fertilizer.md

@@ -0,0 +1,3 @@
+[[def: fertilizer, fertilizing, Fertilizer]]
+
+~ Fertilizer is a substance added to soil or plants to supply essential nutrients and promote growth. Fertilizers can be organic, like compost, or synthetic. Proper fertilizing ensures healthy plant development. See also [[ref: Compost]], [[ref: Mulch]], [[ref: Soil]], [[ref: Watering]], [[ref: Seedling]].

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/mulch.md

@@ -0,0 +1,3 @@
+[[def: mulch, mulching, Mulch]]
+
+~ Mulch is a layer of material, such as wood chips or straw, spread on the surface of soil to retain moisture, suppress weeds, and regulate temperature. Mulching helps improve plant health and soil quality. Related terms: [[ref: Compost]], [[ref: Soil]], [[ref: Fertilizer]].

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/pruning.md

@@ -0,0 +1,3 @@
+[[def: pruning, Pruning]]
+
+~ Pruning is the practice of trimming plants by cutting away dead or overgrown branches or stems. Pruning encourages healthy growth and improves the shape of plants. See also [[ref: Seedling]], [[ref: Watering]].

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/seedling.md

@@ -0,0 +1,3 @@
+[[def: seedling, seedlings, Seedling]]
+
+~ A seedling is a young plant that has recently sprouted from a seed. Seedlings are delicate and require proper soil, water, and light to grow into mature plants. See also [[ref: Soil]], [[ref: Compost]], [[ref: Watering]].

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/soil.md

@@ -0,0 +1,11 @@
+[[def: soil, soils, Soil]]
+
+~ Soil is the upper layer of earth in which plants grow. It consists of a mixture of organic matter, minerals, gases, liquids, and organisms that together support life. Healthy soil is essential for gardening and agriculture.
+
+~ Refs examples: [[ref: Compost]], [[ref: Mulch]], [[ref: Fertilizer]].
+
+~ Xref example: [[xref: KERISuite, composability ]]
+
+~ This Xref example does not work: [[xref: does-not-exist, Foo]]
+
+~ Soil quality affects water retention, nutrient availability, and plant health. Amending soil with compost or mulch can improve its structure and fertility. Fertilizer may be added to supplement nutrients as needed.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/watering.md

@@ -0,0 +1,3 @@
+[[def: watering, Watering]]
+
+~ Watering is the act of supplying water to plants to help them grow. Proper watering is essential for healthy roots and overall plant development. Overwatering or underwatering can harm plants. See also [[ref: Soil]], [[ref: Seedling]], [[ref: Mulch]].

package/src/install-from-boilerplate/boilerplate/specs.json

@@ -19,23 +19,37 @@
             "source": {
                 "host": "github",
                 "account": "trustoverip",
-                "repo": "spec-up-t-starter-pack"
+                "repo": "spec-up-t-starter-pack",
+                "branch": "main"
             },
             "external_specs": [
                 {
-                    "external_spec": "test-1",
-                    "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-1/",
-                    "url": "https://github.com/blockchainbird/spec-up-xref-test-1",
-                    "terms_dir": "spec/term-definitions"
+                    "external_spec": "vLEI",
+                    "gh_page": "https://henkvancann.github.io/vlei-glossary/",
+                    "url": "https://github.com/henkvancann/vlei-glossary",
+                    "terms_dir": "spec/terms-definitions"
                 },
                 {
-                    "external_spec": "test-2",
-                    "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-2/",
-                    "url": "https://github.com/blockchainbird/spec-up-xref-test-2",
-                    "terms_dir": "spec/term-definitions"
+                    "external_spec": "KERISuite",
+                    "gh_page": "https://weboftrust.github.io/kerisuite-glossary/",
+                    "url": "https://github.com/weboftrust/kerisuite-glossary",
+                    "terms_dir": "spec/terms-definitions"
+                },
+                {
+                    "external_spec": "ToIP",
+                    "gh_page": "https://glossary.trustoverip.org/",
+                    "url": "https://github.com/trustoverip/ctwg-main-glossary",
+                    "terms_dir": "spec/terms-definitions"
+                },
+                {
+                    "external_spec": "GenIT",
+                    "gh_page": "https://trustoverip.github.io/ctwg-general-glossary/",
+                    "url": "https://github.com/trustoverip/ctwg-general-glossary",
+                    "terms_dir": "spec/terms-definitions"
                 }
             ],
-            "katex": false
+            "katex": false,
+            "anchor_symbol": "§"
         }
     ]
 }

package/src/install-from-boilerplate/config-scripts-keys.js

@@ -2,11 +2,11 @@ const configScriptsKeys = {
     "edit": "node -e \"require('spec-up-t')()\"",
     "render": "node --no-warnings -e \"require('spec-up-t/index.js')({ nowatch: true })\"",
     "dev": "node -e \"require('spec-up-t')({ dev: true })\"",
-    "collectExternalReferences": "node --no-warnings -e \"require('spec-up-t/src/collect-external-references.js').collectExternalReferences()\"",
+    "collectExternalReferences": "node --no-warnings -e \"require('spec-up-t/src/pipeline/references/collect-external-references.js').collectExternalReferences()\"",
     "topdf": "node -e \"require('spec-up-t/src/create-pdf.js')\"",
     "todocx": "node -e \"require('spec-up-t/src/create-docx.js')\"",
-    "freeze": "node -e \"require('spec-up-t/src/freeze.js')\"",
-    "references": "node -e \"require('spec-up-t/src/references.js')\"",
+    "freeze": "node -e \"require('spec-up-t/src/freeze-spec-data.js')\"",
+    "references": "node -e \"require('spec-up-t/src/pipeline/references/external-references-service.js')\"",
     "help": "cat ./node_modules/spec-up-t/src/install-from-boilerplate/help.txt",
     "menu": "bash ./node_modules/spec-up-t/src/install-from-boilerplate/menu.sh",
     "addremovexrefsource": "node --no-warnings -e \"require('spec-up-t/src/add-remove-xref-source.js')\"",

package/src/install-from-boilerplate/config-system-files.js

@@ -2,7 +2,6 @@ const systemFiles = [
     'README.md',
     '.env.example',
     '.github/workflows/menu.yml',
-    '.github/workflows/render-specs.yml',
     '.github/workflows/set-gh-pages.yml',
     'assets/test.json',
     'assets/test.text',

package/src/install-from-boilerplate/copy-boilerplate.js

@@ -1,5 +1,6 @@
 const fs = require('fs-extra');
 const path = require('path');
+const Logger = require('../utils/logger');
 
 function copyBoilerplate() {
     const sourceDir = path.join(__dirname, './', 'boilerplate');
@@ -16,7 +17,7 @@ function copyBoilerplate() {
     const gitignoreDestPath = path.join(__dirname, '../../../../', '.gitignore');
     fs.renameSync(gitignorePath, gitignoreDestPath);
 
-    console.log('✅ Copied spec-up-t-boilerplate to current directory');
+    Logger.success('Copied spec-up-t-boilerplate to current directory');
 }
 
 module.exports = copyBoilerplate;

package/src/install-from-boilerplate/copy-system-files.js

@@ -1,6 +1,7 @@
 const fs = require('fs-extra');
 const path = require('path');
 const { systemFiles } = require('./config-system-files.js');
+const Logger = require('../utils/logger');
 
 /**
  * Copies system files from the boilerplate directory to the root of the project.
@@ -18,13 +19,13 @@ function copySystemFiles() {
 
         try {
             fs.cpSync(srcPath, destPath, { recursive: true });
-            console.log(`✅ Copied ${item} to ${destPath}`);
+            Logger.success(`Copied ${item} to ${destPath}`);
         } catch (error) {
-            console.error(`❌ Failed to copy ${item} to ${destPath}:`, error);
+            Logger.error(`Failed to copy ${item} to ${destPath}:`, error);
         }
     });
 
-    console.log('✅ Copied system files to current directory');
+    Logger.success('Copied system files to current directory');
 }
 
 module.exports = copySystemFiles;

package/src/install-from-boilerplate/custom-update.js

@@ -10,4 +10,15 @@ addScriptsKeys(configScriptsKeys, configOverwriteScriptsKeys);
 copySystemFiles();
 updateGitignore(gitIgnoreEntries.gitignorePath, gitIgnoreEntries.filesToAdd);
 
-console.log("✅ Custom update done");
+const Logger = require('../utils/logger');
+
+// We can use this file to do any custom updates during post-install.
+const customUpdate = () => {
+    // Custom logic here
+    // ...
+}
+
+// Call custom update
+customUpdate();
+
+Logger.success("Custom update done");

package/src/install-from-boilerplate/help.txt

@@ -1,6 +1,6 @@
 ===
 
-For help go to: https://blockchainbird.github.io/spec-up-t-website
+For help go to: https://trustoverip.github.io/spec-up-t-website
 
 ===
 

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

@@ -21,7 +21,7 @@ function handle_choice() {
         echo "  ${options[index]}"
         echo -e "  ************************************\n\n"
         show_progress
-        ${options[index + 1]}
+        "${options[index + 1]}"
     else
         clear
         echo -e "\n\n  ************************************"
@@ -69,7 +69,7 @@ function prompt_input() {
 
 function do_add_content() {
     clear
-    echo -e "\n\n\n   ********************\n\n\n   You can start adding your content to the markdown files in the "spec" directory.\n\n   You can do this by editing local files in an editor or by going to your repository on GitHub.\n\n   More info: https://blockchainbird.github.io/spec-up-t-website/docs/various-roles/content-authors-guide/introduction\n\n\n   ********************"  
+    echo -e "\n\n\n   ********************\n\n\n   You can start adding your content to the markdown files in the "spec" directory.\n\n   You can do this by editing local files in an editor or by going to your repository on GitHub.\n\n   More info: https://trustoverip.github.io/spec-up-t-website/docs/various-roles/content-authors-guide/introduction\n\n\n   ********************"  
 }
 
 function do_render() { clear; npm run render; }
@@ -83,14 +83,14 @@ function do_freeze() { clear; npm run freeze; }
 
 function do_help() {
     clear
-    echo -e "\n\n\n   You will be redirected to the documentation website\n\n   (https://blockchainbird.github.io/spec-up-t-website/)."
+    echo -e "\n\n\n   You will be redirected to the documentation website\n\n   (https://trustoverip.github.io/spec-up-t-website/)."
     sleep 2
     if [[ "$OSTYPE" == "darwin"* ]]; then
-        open "https://blockchainbird.github.io/spec-up-t-website/"
+        open "https://trustoverip.github.io/spec-up-t-website/"
     elif [[ "$OSTYPE" == "linux-gnu"* ]]; then
-        xdg-open "https://blockchainbird.github.io/spec-up-t-website/"
+        xdg-open "https://trustoverip.github.io/spec-up-t-website/"
     elif [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" || "$OSTYPE" == "win32" ]]; then
-        start "https://blockchainbird.github.io/spec-up-t-website/"
+        start "https://trustoverip.github.io/spec-up-t-website/"
     else
         echo "Unsupported OS."
     fi

package/src/json-key-validator.js

@@ -10,6 +10,7 @@
 
 const fs = require('fs');
 const readlineSync = require('readline-sync');
+const Logger = require('./utils/logger');
 
 let errorFound = false;
 
@@ -25,6 +26,11 @@ function loadData() {
 
 // This function recursively checks if the required keys are present in the object
 function checkKeysSync(object, expectedKeys, parentKey = '') {
+    // Guard against undefined or non-iterable expected key definitions so the validator fails gracefully instead of throwing.
+    if (!Array.isArray(expectedKeys)) {
+        return;
+    }
+
     for (let key of expectedKeys) {
         if (Array.isArray(object)) {
             // If the object is an array, check each item within the array
@@ -34,7 +40,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(`❌ 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`);
+                Logger.error(`Error: Missing key '${key}'\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`);
                 errorFound = true;
                 pauseForEnterSync(); // Pause synchronously to allow user to acknowledge the error
             }
@@ -61,7 +67,7 @@ function runJsonKeyValidatorSync() {
             "logo",
             "logo_link",
             "source",
-            "external_specs"
+            // "external_specs"
             // "assets"  // Commented out: We no longer check for 'assets' in the specs object
         ],
         source: [
@@ -69,12 +75,12 @@ function runJsonKeyValidatorSync() {
             "account",
             "repo"
         ],
-        external_specs: [
-            "gh_page",
-            "external_spec",
-            "url",
-            "terms_dir"
-        ],
+        // external_specs: [
+        //     "gh_page",
+        //     "external_spec",
+        //     "url",
+        //     "terms_dir"
+        // ],
         // Removed the 'assets' block entirely, as it's no longer part of the required keys:
         // assets: [
         //     "path",
@@ -85,7 +91,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(`ℹ️ Checking spec #${index + 1}`);
+        Logger.info(`Checking spec #${index + 1}`);
 
         // Check for keys defined in expectedKeys.specs
         checkKeysSync(spec, expectedKeys.specs, `specs[${index}]`);
@@ -96,7 +102,7 @@ function runJsonKeyValidatorSync() {
         }
 
         // Check for keys inside the 'external_specs' array, if present
-        if (spec.external_specs) {
+        if (spec.external_specs && Array.isArray(expectedKeys.external_specs)) {
             checkKeysSync(spec.external_specs, expectedKeys.external_specs, `specs[${index}].external_specs`);
         }
 
@@ -108,7 +114,7 @@ function runJsonKeyValidatorSync() {
 
     // If no errors were found, print a success message
     if (!errorFound) {
-        console.log('✅ All keys are present. No errors found. Continuing…');
+        Logger.success('All keys are present. No errors found. Continuing…');
     }
 }