spec-up-t 1.3.0 → 1.4.0

package/src/collectExternalReferences/processXTrefsData.js

@@ -1,108 +0,0 @@
-const fs = require('fs');
-const { fetchTermsFromIndex, fetchAllTermsFromIndex } = require('./fetchTermsFromIndex.js');
-const { matchTerm } = require('./matchTerm.js');
-const { addPath, getPath, getAllPaths } = require('../../config/paths');
-const path = require('path');
-
-// Directory to store fetched data files
-const CACHE_DIR = getPath('githubcache');
-
-async function processXTrefsData(allXTrefs, GITHUB_API_TOKEN, outputPathJSON, outputPathJS, outputPathJSTimeStamped) {
-    try {
-        // Ensure the directory exists, so that we can store the fetched data
-        if (!fs.existsSync(CACHE_DIR)) {
-            fs.mkdirSync(CACHE_DIR, { recursive: true });
-        }
-        
-        // Filter out incomplete xtrefs that don't have proper repository information
-        allXTrefs.xtrefs = allXTrefs.xtrefs.filter(xtref => {
-            if (!xtref.owner || !xtref.repo || !xtref.repoUrl) {
-                console.log(`⚠️ Removing incomplete reference: ${xtref.externalSpec}, ${xtref.term}`);
-                return false;
-            }
-            return true;
-        });
-        
-        // Group xtrefs by repository to avoid multiple downloads of the same index.html
-        const xrefsByRepo = allXTrefs.xtrefs.reduce((groups, xtref) => {
-            const repoKey = `${xtref.owner}/${xtref.repo}`;
-            if (!groups[repoKey]) {
-                groups[repoKey] = {
-                    owner: xtref.owner,
-                    repo: xtref.repo,
-                    xtrefs: []
-                };
-            }
-            groups[repoKey].xtrefs.push(xtref);
-            return groups;
-        }, {});
-
-        console.log(`✅ Grouped ${allXTrefs.xtrefs.length} terms into ${Object.keys(xrefsByRepo).length} repositories`);
-        
-        // Process each repository once
-        for (const repoKey of Object.keys(xrefsByRepo)) {
-            const repoGroup = xrefsByRepo[repoKey];
-            console.log(`Processing repository: ${repoKey} (${repoGroup.xtrefs.length} terms)`);
-            
-            // Get the GitHub Pages URL from the first xtref in this repo group
-            const ghPageUrl = repoGroup.xtrefs[0]?.ghPageUrl;
-            
-            // First, fetch all terms from this repository
-            const allTermsData = await fetchAllTermsFromIndex(
-                GITHUB_API_TOKEN, 
-                repoGroup.owner, 
-                repoGroup.repo, 
-                { 
-                    ghPageUrl: ghPageUrl // Pass the GitHub Pages URL
-                }
-            );
-            
-            if (!allTermsData) {
-                console.log(`❌ Could not fetch terms from repository ${repoKey}`);
-                // Mark all terms from this repo as not found
-                repoGroup.xtrefs.forEach(xtref => {
-                    xtref.commitHash = "not found";
-                    xtref.content = "This term was not found in the external repository.";
-                    xtref.avatarUrl = null;
-                });
-                continue; // Skip to next repository
-            }
-            
-            // Now process each term in this repository
-            for (const xtref of repoGroup.xtrefs) {
-                // Find the term in the pre-fetched data
-                const foundTerm = allTermsData.terms.find(
-                    t => t.term.toLowerCase() === xtref.term.toLowerCase()
-                );
-                
-                if (foundTerm) {
-                    xtref.commitHash = allTermsData.sha;
-                    xtref.content = foundTerm.definition;
-                    xtref.avatarUrl = allTermsData.avatarUrl;
-                    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.";
-                    xtref.avatarUrl = null;
-                    console.log(`ℹ️ No match found for term: ${xtref.term} in ${xtref.externalSpec}`);
-                }
-            }
-            
-            console.log(`✅ Finished processing repository: ${repoKey}`);
-            console.log("============================================\n\n");
-        }
-
-        const allXTrefsStr = JSON.stringify(allXTrefs, null, 2);
-        fs.writeFileSync(outputPathJSON, allXTrefsStr, 'utf8');
-        const stringReadyForFileWrite = `const allXTrefs = ${allXTrefsStr};`;
-        fs.writeFileSync(outputPathJS, stringReadyForFileWrite, 'utf8');
-        fs.writeFileSync(outputPathJSTimeStamped, stringReadyForFileWrite, 'utf8');
-
-        // This will run index.js
-        require('../../index.js')({ nowatch: true });
-    } catch (error) {
-        console.error("An error occurred:", error);
-    }
-}
-
-module.exports.processXTrefsData = processXTrefsData;

package/src/freeze.js

@@ -1,90 +0,0 @@
-/**
- * @file freeze.js
- * @description This script reads the output path from a specs.json file, finds the highest versioned directory in the destination path, and copies the index.html file to a new versioned directory with an incremented version number.
- * 
- * @requires fs-extra - Module for file system operations with additional features.
- * @requires path - Module for handling and transforming file paths.
- * 
- * @example
- * // Assuming specs.json contains:
- * // {
- * //   "specs": [
- * //     {
- * //       "output_path": "path/to/output"
- * //     }
- * //   ]
- * // }
- * 
- * // And the directory structure is:
- * // path/to/output/versions/v1/index.html
- * // path/to/output/versions/v2/index.html
- * 
- * // Running this script will create:
- * // path/to/output/versions/v3/index.html
- * 
- * @version 1.0.0
- * @license MIT
- */
-
-const fs = require('fs-extra'); // Import the fs-extra module for file system operations
-const path = require('path'); // Import the path module for handling file paths
-
-// Read and parse the specs.json file
-const config = fs.readJsonSync('specs.json');
-
-// Extract the output_path from the specs.json file
-const outputPath = config.specs[0].output_path;
-
-// Define the source file path
-const sourceFile = path.join(outputPath, 'index.html');
-
-// Define the destination directory path
-const destDir = path.join(outputPath, 'versions');
-
-// Ensure the destination directory exists, create it if it doesn't
-if (!fs.existsSync(destDir)) {
-    fs.mkdirSync(destDir, { recursive: true });
-}
-
-// Get all directories in the destination directory
-const dirs = fs.readdirSync(destDir).filter(file => fs.statSync(path.join(destDir, file)).isDirectory());
-
-// Initialize the highest version number to 0
-let highestVersion = 0;
-
-// Define the pattern to match versioned directories
-const versionPattern = /^v(\d+)$/;
-
-// Iterate over each directory in the destination directory
-dirs.forEach(dir => {
-    // Check if the directory matches the version pattern
-    const match = dir.match(versionPattern);
-    if (match) {
-        // Extract the version number from the directory name
-        const version = parseInt(match[1], 10);
-        // Update the highest version number if the latest version is higher
-        if (version > highestVersion) {
-            highestVersion = version;
-        }
-    }
-});
-
-// Calculate the new version number
-const newVersion = highestVersion + 1;
-
-// Define the new version directory path
-const newVersionDir = path.join(destDir, `v${newVersion}`);
-
-// Ensure the new version directory exists, create it if it doesn't
-if (!fs.existsSync(newVersionDir)) {
-    fs.mkdirSync(newVersionDir, { recursive: true });
-}
-
-// Define the destination file path within the new version directory
-const destFile = path.join(newVersionDir, 'index.html');
-
-// Copy the source file to the destination file
-fs.copyFileSync(sourceFile, destFile);
-
-// Log a message indicating the file has been copied
-console.log(`✅ Created a freezed specification version in ${destFile}`);

package/src/install-from-boilerplate/boilerplate/.github/workflows/fetch-and-push-xrefs.yml.old

@@ -1,42 +0,0 @@
-
-name: fetch and push xrefs
-
-on:
-  # push:
-  #   branches:
-  #     - main
-  workflow_dispatch:
-
-jobs:
-  build-and-deploy-spec:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-
-      - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
-        run: |
-          echo "start install"
-          npm install
-          echo "end install"
-          echo "Spec-Up-T version:"
-          npm list spec-up-t
-          echo "start fetching xrefs"
-          node -e "require('spec-up-t/src/get-xrefs-data.js').updateXrefs()"
-          rm -rf node_modules
-      
-      - name: Commit and Push Changes
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          git config --local user.email "action@github.com"
-          git config --local user.name "GitHub Action"
-          git add .
-          git commit -m "Update Xrefs data via Github Action" || echo "No changes to commit"
-          git push https://x-access-token:${GITHUB_TOKEN}@github.com/${{ github.repository }} HEAD:refs/heads/main
-
-          

package/src/install-from-boilerplate/boilerplate/.github/workflows/render-specs.yml

@@ -1,47 +0,0 @@
-
-name: spec-up-t render
-
-on:
-  # push:
-  #   branches:
-  #     - main
-  workflow_dispatch:
-
-jobs:
-  build-and-deploy-spec:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v2
-        with:
-          persist-credentials: false
-      - name: Extract output_path from JSON
-        # TODO: .specs[0] is a hack to get the first spec. This should be fixed.
-        run: |
-          OUTPUT_PATH=$(jq -r '.specs[0].output_path' specs.json)
-          echo "OUTPUT_PATH=$OUTPUT_PATH" >> $GITHUB_ENV
-
-      - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
-        run: |
-          echo "start install"
-          npm install
-          echo "end install"
-          echo "Spec-Up-T version:"
-          npm list spec-up-t
-          echo "start render"
-          node -e "require('spec-up-t')({ nowatch: true })"
-          echo "end render"
-          rm -rf node_modules
-
-      # This is a GitHub Action to deploy your static files to GitHub Pages
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3.7.3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ${{ env.OUTPUT_PATH }} # Use the OUTPUT_PATH environment variable
-          allow_empty_commit: true
-          force_orphan: true
-
-          

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

@@ -1,13 +0,0 @@
-[[def: term 1, term one, Term One]]
-
-~ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum faucibus volutpat justo, sed ornare velit.
-
-~ Refs examples: [[ref: Term 2]], [[ref: Term Two]], [[ref: Term 3]].
-
-~ Xref example: [[xref: test-1, Aal]]
-
-~ This Xref example does not work: [[xref: does-not-exist, Foo]]
-
-~ Donec aliquam et ligula id congue. Sed eu urna et tellus placerat viverra. Quisque ut posuere magna, nec accumsan augue. Nullam mauris tortor, semper finibus elementum maximus, imperdiet in felis. Suspendisse quis imperdiet nibh, eget ultrices justo. Pellentesque vitae malesuada justo. Vestibulum quis scelerisque lectus, non rutrum odio. Aenean leo orci, semper non massa sed, facilisis ornare ipsum. Morbi at sem orci. Integer eros mi, faucibus sed lorem id, pharetra imperdiet nisl. Integer viverra enim vel luctus lobortis. Ut turpis tellus, consequat nec lectus et, dictum elementum nunc. Integer rhoncus venenatis molestie. Donec egestas condimentum ligula in porttitor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.
-
-~ Extra text for testing purposes.

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

@@ -1,3 +0,0 @@
-[[def: term 2, term two, Term Two]]
-
-~ Pellentesque suscipit ipsum varius, mattis diam in, elementum nunc [[ref: Term 1]], [[ref: Term Three]], [[ref: Term 3]], [[ref: Term 4]]. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec placerat, elit sed tempor viverra, magna ligula porttitor tortor, eget suscipit erat enim vel nisl. Integer vel urna in quam viverra dignissim at in orci. Aliquam erat volutpat. Nam vitae neque nibh. In sollicitudin felis vitae ex finibus, in eleifend lectus efficitur. Vestibulum enim ex, condimentum nec accumsan ut, vestibulum at lacus. Maecenas non vulputate ante. Sed porttitor et eros sit amet venenatis.

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

@@ -1,3 +0,0 @@
-[[def: term 3, term three, Term Three]]
-
-~ Nam euismod augue sed tempus imperdiet. Pellentesque ac porta ipsum, sed sodales leo. Suspendisse molestie est sit amet est porta, sit amet molestie dolor pharetra. Duis porta mollis sem vel aliquam. Maecenas laoreet turpis nunc, vitae mattis urna auctor ac. Donec mattis quis urna nec porta. Sed sit amet viverra ligula. Vivamus vitae sem sodales, malesuada dui sit amet, viverra lectus. Integer ullamcorper molestie ante, in blandit nunc tempus auctor.

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

@@ -1,3 +0,0 @@
-[[def: term 4, term four, Term Four]]
-
-~ Sed lorem nunc, ultricies nec nibh eu, bibendum sollicitudin arcu. Nullam porttitor condimentum elit ac commodo. Aenean ac augue quis arcu congue aliquam vitae in massa. Aliquam erat volutpat. Curabitur lobortis, sapien vitae mattis dignissim, risus augue iaculis risus, sed tempus sapien ex nec massa. Integer quis maximus nunc. Nunc ultrices sapien erat, at congue augue mattis sit amet. Aliquam condimentum luctus nunc, ut euismod augue commodo in.