spec-up-t 1.0.58 → 1.0.60

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.0.58",
+  "version": "1.0.60",
   "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/fix-markdown-files.js

@@ -24,47 +24,54 @@ function processMarkdownFiles(directory) {
                         let lines = data.split('\n');
                         let modified = false;
 
-                        // Iterate through the lines
+                        // Handle specific functionality for `[[def:` lines
                         for (let i = 0; i < lines.length; i++) {
-                            // Check if the line starts with [[def:
                             if (lines[i].startsWith('[[def:')) {
-                                // Check if the next line is not a blank line
+                                // Ensure a blank line immediately follows `[[def:` lines
                                 if (i + 1 < lines.length && lines[i + 1].trim() !== '') {
-                                    // Insert a blank line
-                                    lines.splice(i + 1, 0, '');
+                                    lines.splice(i + 1, 0, ''); // Insert blank line
                                     modified = true;
                                 }
                             }
                         }
 
-                        // Ensure there is an empty line between paragraphs
-                        for (let i = 0; i < lines.length - 1; i++) {
-                            if (lines[i].trim() !== '' && lines[i + 1].trim() !== '') {
-                                lines.splice(i + 1, 0, '');
-                                modified = true;
-                            }
-                        }
+                        // Ensure there is exactly one blank line between paragraphs
+                        let newLines = [];
+                        let previousLineWasEmpty = false;
 
-                        // Prepend `~ ` to lines that do not start with `[[def:` and are not blank lines, and do not already start with `~ `
                         for (let i = 0; i < lines.length; i++) {
-                            if (!lines[i].startsWith('[[def:') && lines[i].trim() !== '' && !lines[i].startsWith('~ ')) {
-                                lines[i] = `~ ${lines[i]}`;
-                                modified = true;
+                            const isCurrentLineEmpty = lines[i].trim() === '';
+
+                            if (!isCurrentLineEmpty) {
+                                newLines.push(lines[i]); // Add non-empty lines
+                                previousLineWasEmpty = false;
+                            } else if (!previousLineWasEmpty) {
+                                newLines.push(''); // Add exactly one blank line
+                                previousLineWasEmpty = true;
+                            } else {
+                                modified = true; // Skip additional blank lines
                             }
                         }
 
-                        // Join the lines back into a single string
-                        if (modified) {
-                            data = lines.join('\n');
+                        // Prepend `~ ` to lines that do not start with `[[def:` and are not blank, and do not already start with `~ `
+                        for (let i = 0; i < newLines.length; i++) {
+                            if (!newLines[i].startsWith('[[def:') && newLines[i].trim() !== '' && !newLines[i].startsWith('~ ')) {
+                                newLines[i] = `~ ${newLines[i]}`;
+                                modified = true;
+                            }
                         }
 
                         // Ensure there is exactly one blank line at the end of the file
-                        let trimmedData = data.trimEnd() + '\n';
-                        if (data !== trimmedData) {
-                            data = trimmedData;
+                        if (newLines[newLines.length - 1] !== '') {
+                            newLines.push('');
                             modified = true;
                         }
 
+                        // Join the lines back into a single string
+                        if (modified) {
+                            data = newLines.join('\n');
+                        }
+
                         // Write the modified content back to the file synchronously if there were any changes
                         if (modified) {
                             fs.writeFileSync(itemPath, data, 'utf8');
@@ -86,4 +93,4 @@ function processMarkdownFiles(directory) {
 
 module.exports = {
     processMarkdownFiles
-};
+};

package/src/get-xrefs-data.js

@@ -86,15 +86,20 @@ function getXrefsData(GITHUB_API_TOKEN) {
 
     // Function to extend xref objects with additional information, such as repository URL and directory information.
     function extendXrefs(config, xrefs) {
+        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-starterpack/specs.json or e-mail kor@dwarshuis.com for help. \n");
+            return;
+        }
+
         xrefs.forEach(xref => {
             config.specs.forEach(spec => {
-                // Loop through "external_specs_repos" to find the repository URL for each xref
+                // Loop through "external_specs" to find the repository URL for each xref
                 xref.repoUrl = null;
                 xref.terms_dir = null;
                 xref.owner = null;
                 xref.repo = null;
 
-                spec.external_specs_repos.forEach(repo => {
+                spec.external_specs.forEach(repo => {
                     if (repo.external_spec === xref.externalSpec) {
                         xref.repoUrl = repo.url;
                         xref.terms_dir = repo.terms_dir;

package/src/json-key-validator.js

@@ -61,8 +61,7 @@ function runJsonKeyValidatorSync() {
             "logo",
             "logo_link",
             "source",
-            "external_specs",
-            "external_specs_repos",
+            "external_specs"
             // "assets"  // Commented out: We no longer check for 'assets' in the specs object
         ],
         source: [
@@ -70,7 +69,8 @@ function runJsonKeyValidatorSync() {
             "account",
             "repo"
         ],
-        external_specs_repos: [
+        external_specs: [
+            "gh-page",
             "external_spec",
             "url",
             "terms_dir"
@@ -95,9 +95,9 @@ function runJsonKeyValidatorSync() {
             checkKeysSync(spec.source, expectedKeys.source, `specs[${index}].source`);
         }
 
-        // Check for keys inside the 'external_specs_repos' array, if present
-        if (spec.external_specs_repos) {
-            checkKeysSync(spec.external_specs_repos, expectedKeys.external_specs_repos, `specs[${index}].external_specs_repos`);
+        // Check for keys inside the 'external_specs' array, if present
+        if (spec.external_specs) {
+            checkKeysSync(spec.external_specs, expectedKeys.external_specs, `specs[${index}].external_specs`);
         }
 
         // The assets check is no longer necessary and has been commented out

package/src/references.js

@@ -35,8 +35,8 @@ function findExternalSpecByKey(config, key) {
   for (const spec of config.specs) {
     if (spec.external_specs) {
       for (const externalSpec of spec.external_specs) {
-        if (externalSpec[key]) {
-          return externalSpec[key];
+        if (externalSpec.external_spec === key) {
+          return externalSpec;
         }
       }
     }
@@ -44,21 +44,33 @@ function findExternalSpecByKey(config, key) {
   return null;
 }
 
-async function fetchExternalSpecs(spec){
+async function fetchExternalSpecs(spec) {
   try {
     let results = await Promise.all(
       spec.external_specs.map(s => {
-        const url = Object.values(s)[0];
+        const url = s["gh-page"]; // Access the "gh-page" URL directly
         return axios.get(url);
       })
     );
-    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]));
+
+    results = results
+      .map((r, index) =>
+        r.status === 200
+          ? { [spec.external_specs[index].external_spec]: r.data }
+          : null
+      )
+      .filter(r => r); // Remove null values
+
+    return results.map(r =>
+      createNewDLWithTerms(Object.keys(r)[0], Object.values(r)[0])
+    );
   } catch (e) {
-    return console.log("\n   SPEC-UP-T: " + e + "\n");
+    console.log("\n   SPEC-UP-T: " + e + "\n");
+    return []; // Return an empty array in case of errors
   }
 }
 
+
 function createNewDLWithTerms(title, html) {
   const dom = new JSDOM(html);
   const document = dom.window.document;