spec-up-t 1.1.43 → 1.1.44

package/index.js

@@ -35,8 +35,7 @@ module.exports = async function (options = {}) {
 
     const { fixMarkdownFiles } = require('./src/fix-markdown-files.js');
 
-    // This is now done at the client side
-    // const { prepareTref } = require('./src/prepare-tref.js');
+    const { prepareTref } = require('./src/prepare-tref.js');
 
     let template = fs.readFileSync(path.join(modulePath, 'templates/template.html'), 'utf8');
     let assets = fs.readJsonSync(modulePath + '/src/asset-map.json');
@@ -57,8 +56,7 @@ module.exports = async function (options = {}) {
       }
     ];
 
-    // This is now done at the client side
-    // prepareTref(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
+    prepareTref(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
 
     // Synchronously process markdown files
     fixMarkdownFiles(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.1.43",
+  "version": "1.1.44",
   "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/prepare-tref.js

@@ -1,24 +1,3 @@
-/**
- * @file prepare-tref.js
- * @description This module provides functionality to process markdown files in a directory recursively, 
- * searching for specific `[[tref:]]` references, and replacing them with detailed information 
- * fetched from a local JSON file (`xtrefs-data.json`). The information includes metadata such as 
- * owner, repository, commit hash, and content. If no matching reference is found, a placeholder 
- * message is written to the file.
- * 
- * The module includes:
- * - A helper function `getLocalXTrefContent` to retrieve reference data from the JSON file.
- * - A main function `prepareTref` to process directories and markdown files, replacing tref references.
- * 
- * This is useful for dynamically enriching markdown documentation with external reference details.
- * 
- * @requires fs - Node.js file system module for reading and writing files.
- * @requires path - Node.js path module for handling file paths.
- * @requires dedent - A utility for removing indentation from multi-line strings.
- * 
- * @module prepareTref
- */
-
 const fs = require('fs');
 const path = require('path');
 const dedent = require('dedent');
@@ -68,7 +47,8 @@ function prepareTref(directory) {
 
                         // Variable to store content after the span or tref line
                         let contentAfterSpan = '';
-                        const spanMarker = '<span style="display: none;">End of included external content. Add your optional custom content below.</span>';
+
+                        const spanMarker = '- - -';
                         const spanIndex = data.indexOf(spanMarker);
 
                         if (spanIndex !== -1) {
@@ -101,16 +81,9 @@ function prepareTref(directory) {
 
                                     const readyForWrite = dedent`
 ${match[0]}
-| Property | Value |
-| -------- | ----- |
-| Owner | ![avatar](${localXTrefContent.avatarUrl}) ${localXTrefContent.owner} |
-| Repo | [${localXTrefContent.repo}](${localXTrefContent.repoUrl}) |
-| Commit hash | ${localXTrefContent.commitHash} |
 
-${localXTrefContent.content}
 ${spanMarker}
 
-${contentAfterSpan}
 
 `;