spec-up-t 1.2.3 → 1.2.5

package/src/health-check.js

@@ -15,7 +15,7 @@ const outputGitignoreChecker = require('./health-check/output-gitignore-checker'
 const trefTermChecker = require('./health-check/tref-term-checker');
 
 // Configuration
-const OUTPUT_DIR = path.join(process.cwd(), 'output');
+const OUTPUT_DIR = path.join(process.cwd(), '.cache');
 
 // Create output directory if it doesn't exist
 if (!fs.existsSync(OUTPUT_DIR)) {
@@ -60,18 +60,15 @@ function getRepoInfo() {
 
         // Look for specs.json in the current working directory (where the command is run from)
         const specsPath = path.join(process.cwd(), 'specs.json');
-        // console.log(`Looking for specs.json at: ${specsPath}`);
         
         if (fs.existsSync(specsPath)) {
-            // console.log('specs.json found!');
             const specsContent = fs.readFileSync(specsPath, 'utf8');
             const specs = JSON.parse(specsContent);
             
             // Check if source field exists and has required properties
-            if (specs?.specs?.[0]?.source && 
-                specs.specs[0].source.host && 
-                specs.specs[0].source.account && 
-                specs.specs[0].source.repo) {
+            if (specs?.specs?.[0]?.source?.host && 
+                specs?.specs?.[0]?.source?.account && 
+                specs?.specs?.[0]?.source?.repo) {
                 
                 const sourceInfo = specs.specs[0].source;
                 
@@ -128,7 +125,6 @@ function getRepoInfo() {
     }
     
     // Return default values if specs.json doesn't exist or doesn't contain the required information
-    // console.log('Using default repository values');
     return {
         host: 'github',
         account: 'blockchain-bird',
@@ -158,13 +154,24 @@ function checkRepositoryExists(host, account, repo) {
     }
 }
 
+// Helper function to get the appropriate file open command based on platform
+function getOpenCommand() {
+    if (process.platform === 'win32') {
+        return 'start';
+    } else if (process.platform === 'darwin') {
+        return 'open';
+    } else {
+        return 'xdg-open';
+    }
+}
+
 // Helper function to format current time for the filename
 function getFormattedTimestamp() {
     const now = new Date();
     return now.toISOString()
         .replace(/[T:]/g, '-')
         .replace(/\..+/, '')
-        .replace(/[Z]/g, '');
+        .replace(/Z/g, 'Z');
 }
 
 // Helper function to generate a human-readable timestamp for display
@@ -172,6 +179,32 @@ function getHumanReadableTimestamp() {
     return new Date().toLocaleString();
 }
 
+// Helper function to determine status display parameters based on result
+function getStatusDisplay(result) {
+    if (result.status === 'warning' || result.success === 'partial') {
+        // Warning status
+        return {
+            statusClass: 'text-warning',
+            statusIcon: '<i class="bi bi-exclamation-triangle-fill"></i>',
+            statusText: 'Warning'
+        };
+    } else if (result.success) {
+        // Pass status
+        return {
+            statusClass: 'text-success',
+            statusIcon: '<i class="bi bi-check-circle-fill"></i>',
+            statusText: 'Pass'
+        };
+    } else {
+        // Fail status
+        return {
+            statusClass: 'text-danger',
+            statusIcon: '<i class="bi bi-x-circle-fill"></i>',
+            statusText: 'Fail'
+        };
+    }
+}
+
 // Main function to run all checks and generate the report
 async function runHealthCheck() {
     console.log('Running health checks...');
@@ -249,8 +282,7 @@ function generateReport(checkResults) {
 
     // Open the report in the default browser
     try {
-        const openCommand = process.platform === 'win32' ? 'start' :
-            process.platform === 'darwin' ? 'open' : 'xdg-open';
+        const openCommand = getOpenCommand();
         execSync(`${openCommand} "${reportPath}"`);
     } catch (error) {
         console.error('Failed to open the report:', error);
@@ -263,6 +295,12 @@ function generateHtmlReport(checkResults, timestamp, repoInfo) {
 
     // Add repository verification check at the beginning if needed
     if (repoInfo && repoInfo.verified === false) {
+        const failStatus = {
+            statusClass: 'text-danger',
+            statusIcon: '<i class="bi bi-x-circle-fill"></i>',
+            statusText: 'Fail'
+        };
+        
         // Create a new section at the top for repository verification
         resultsHtml += `
       <div class="card mb-4 results-card alert-danger" data-section="repository-verification">
@@ -280,8 +318,8 @@ function generateHtmlReport(checkResults, timestamp, repoInfo) {
             </thead>
             <tbody>
               <tr data-status="fail" class="check-row">
-                <td class="text-danger" style="white-space: nowrap;">
-                  <i class="bi bi-x-circle-fill"></i> <span style="vertical-align: middle;">Fail</span>
+                <td class="${failStatus.statusClass}" style="white-space: nowrap;">
+                  ${failStatus.statusIcon} <span style="vertical-align: middle;">${failStatus.statusText}</span>
                 </td>
                 <td>Repository existence check</td>
                 <td>The repository at https://${repoInfo.host}.com/${repoInfo.account}/${repoInfo.repo} does not exist or is not accessible. Please verify the repository information in specs.json.</td>
@@ -312,29 +350,7 @@ function generateHtmlReport(checkResults, timestamp, repoInfo) {
     `;
 
         section.results.forEach(result => {
-            let statusClass, statusIcon, statusText;
-
-            if (result.status === 'warning') {
-                // Warning status
-                statusClass = 'text-warning';
-                statusIcon = '<i class="bi bi-exclamation-triangle-fill"></i>';
-                statusText = 'Warning';
-            } else if (result.success === 'partial') {
-                // Partial success (warning) status
-                statusClass = 'text-warning';
-                statusIcon = '<i class="bi bi-exclamation-triangle-fill"></i>';
-                statusText = 'Warning';
-            } else if (result.success) {
-                // Pass status
-                statusClass = 'text-success';
-                statusIcon = '<i class="bi bi-check-circle-fill"></i>';
-                statusText = 'Pass';
-            } else {
-                // Fail status
-                statusClass = 'text-danger';
-                statusIcon = '<i class="bi bi-x-circle-fill"></i>';
-                statusText = 'Fail';
-            }
+            const { statusClass, statusIcon, statusText } = getStatusDisplay(result);
 
             // Add data-status attribute to identify rows by status and reorder columns to put status first
             resultsHtml += `

package/src/init.js

@@ -1,8 +1,7 @@
 const fs = require('fs-extra');
 const path = require('path');
-const outputDir = path.join(process.cwd(), 'output');
+const outputDir = path.join(process.cwd(), '.cache');
 const initFlagPath = path.join(outputDir, 'init.flag');
-const collectExternalReferences = require('./collect-external-references.js').collectExternalReferences;
 
 async function initialize() {
     try {
@@ -13,8 +12,6 @@ async function initialize() {
 
         // Place the init script here
         
-        // prepareTref(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
-
         // End of the init script
 
         // Create the init flag file

package/src/insert-term-index.js

@@ -19,8 +19,8 @@ function insertTermIndex() {
     const fs = require('fs-extra');
     const path = require('path');
     const config = fs.readJsonSync(path.join('specs.json'));
-    const terms = fs.readJsonSync(path.join('output', 'term-index.json'));
-    const outputPathJSON = path.join('output', 'specs-generated.json');
+    const terms = fs.readJsonSync(path.join('.cache', 'term-index.json'));
+    const outputPathJSON = path.join('.cache', 'specs-generated.json');
     let specGenerated = config;
     let markdownPaths = specGenerated.specs[0].markdown_paths;
 
@@ -36,9 +36,9 @@ function insertTermIndex() {
     // 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');
+    // Create directory named “.cache” in the project root if it does not yet exist
+    if (!fs.existsSync('.cache')) {
+        fs.mkdirSync('.cache');
     }
 
     fs.writeJsonSync(outputPathJSON, specGenerated, { spaces: 2 });

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

@@ -8,7 +8,9 @@ const path = require('path');
  * @param {Object} [overwriteKeys={}] - An object specifying which scripts to overwrite if they already exist.
  */
 function addScriptsKeys(scriptKeys, overwriteKeys = {}) {
-    const packageJsonPath = path.resolve(__dirname, '../../../../', 'package.json');
+    // Use process.cwd() to get the current working directory where the command is run
+    const packageJsonPath = path.resolve(process.cwd(), 'package.json');
+
 
     // Read the package.json file
     fs.readFile(packageJsonPath, 'utf8', (err, data) => {

package/src/install-from-boilerplate/boilerplate/gitignore

@@ -7,4 +7,5 @@ dist
 .env
 coverage
 build
-.history
+.history
+/.cache/

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

@@ -1,3 +1,11 @@
-const systemFiles = ['README.md', '.env.example', '.github/workflows/menu.yml', '.github/workflows/render-specs.yml', '.github/workflows/set-gh-pages.yml'];
+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',
+];
 
 module.exports = { systemFiles };

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

@@ -20,7 +20,7 @@ function copySystemFiles() {
             fs.cpSync(srcPath, destPath, { recursive: true });
             console.log(`✅ Copied ${item} to ${destPath}`);
         } catch (error) {
-            console.error(`❌ Failed to copy ${item} to ${destPath}:`);
+            console.error(`❌ Failed to copy ${item} to ${destPath}:`, error);
         }
     });