spec-up-t 0.11.12 → 0.11.13

package/assets/compiled/body.js

@@ -50,7 +50,7 @@ window.FontAwesomeKitConfig={asyncLoading:{enabled:!0},autoA11y:{enabled:!0},bas
  * @license MIT
  * @since 2024-06-09
  */
-function editTermButtons(){const t=document.querySelector(".terms-and-definitions-list");const e=((s=specConfig.spec_directory).startsWith("./")?s=s.substring(2):s.startsWith("/")&&(s=s.substring(1)),s.endsWith("/")&&(s=s.slice(0,-1)),s);var s;t.querySelectorAll("dt").forEach(t=>{const s=t.querySelector("span").getAttribute("id").split(":")[1];t.innerHTML+=`<sup class="edit-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/ctwg-main-glossary/blob/main/${e}/${specConfig.spec_terms_directory}/${s}.md" class="edit-term-button">Edit</a></sup><sup class="history-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/ctwg-main-glossary/commits/main/${e}/${specConfig.spec_terms_directory}/${s}.md" class="history-term-button">History</a></sup>`})}document.addEventListener("DOMContentLoaded",(function(){editTermButtons()}));
+function editTermButtons(){document.querySelector(".terms-and-definitions-list");const t=((e=specConfig.spec_directory).startsWith("./")?e=e.substring(2):e.startsWith("/")&&(e=e.substring(1)),e.endsWith("/")&&(e=e.slice(0,-1)),e);var e;document.querySelectorAll('span[id^="term:"]').forEach(e=>{const s=e.getAttribute("id").split(":")[1];e.innerHTML+=`<sup class="edit-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/${specConfig.source.repo}/blob/main/${t}/${specConfig.spec_terms_directory}/${s}.md" class="edit-term-button">Edit</a></sup><sup class="history-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/${specConfig.source.repo}/commits/main/${t}/${specConfig.spec_terms_directory}/${s}.md" class="history-term-button">History</a></sup>`})}document.addEventListener("DOMContentLoaded",(function(){editTermButtons()}));
 function inPageSearch(){const e=document.querySelector("span[issue-count]"),t=specConfig.searchHighlightStyle||"ssi",n="search-h7vc6omi2hr2880",i=document.querySelector("main article");let c=document.createElement("div");c.setAttribute("id","container-"+n),c.setAttribute("class","container-"+n),e.after(c);let o=document.createElement("input");o.setAttribute("type","text"),o.setAttribute("id",n),o.setAttribute("placeholder","🔍"),c.appendChild(o),setTimeout(()=>{o.focus()},1e3);const r=document.createElement("div");r.setAttribute("id","back-and-forth-buttons-container-"+n);const a=document.createElement("button");a.setAttribute("id","one-match-backward-"+n),a.setAttribute("disabled","disabled"),a.setAttribute("title","Go to previous match. Shortcut key: Left Arrow"),a.textContent="▲",r.appendChild(a);const s=document.createElement("button");s.setAttribute("id","one-match-forward-"+n),s.setAttribute("disabled","disabled"),s.setAttribute("title","Go to next match. Shortcut key: Right Arrow"),s.textContent="▼",r.appendChild(s),c.appendChild(r);const d=document.createElement("span");d.setAttribute("id","total-matches-"+n),d.innerHTML="0 matches",c.appendChild(d),o.addEventListener("input",(function(){f(o.value)}));const h="highlight-matches-"+n,l={dif:"highlight-matches-DIF-search-h7vc6omi2hr2880",toip:"highlight-matches-ToIP-search-h7vc6omi2hr2880",btc:"highlight-matches-BTC-search-h7vc6omi2hr2880",keri:"highlight-matches-KERI-search-h7vc6omi2hr2880",ssi:"highlight-matches-SSI-search-h7vc6omi2hr2880",gleif:"highlight-matches-GLEIF-search-h7vc6omi2hr2880"}[t.toLowerCase()];let u=0,m=-1;function b(e){e.scrollIntoView({behavior:"smooth",block:"start"});const t=e.getBoundingClientRect(),n=t.top+window.pageYOffset-(window.innerHeight-t.height)/2;window.scrollTo({top:n,behavior:"smooth"})}function p(){m<=0?document.getElementById("one-match-backward-"+n).setAttribute("disabled","disabled"):document.getElementById("one-match-backward-"+n).removeAttribute("disabled"),m>=u-1?document.getElementById("one-match-forward-"+n).setAttribute("disabled","disabled"):document.getElementById("one-match-forward-"+n).removeAttribute("disabled")}function g(){d.innerHTML=u+" matches"}const f=function(e,t){let n;return function(){const i=this,c=arguments;clearTimeout(n),n=setTimeout(()=>e.apply(i,c),t)}}((function(e){if(function(){document.querySelectorAll("span."+h).forEach(e=>{Array.from(e.childNodes).forEach(t=>{t.nodeType===Node.ELEMENT_NODE&&e.removeChild(t)}),e.classList.contains(h)&&(e.outerHTML=e.innerHTML)})}(),u=0,m=-1,""===e)return void g();let t=0;!function i(c){if(3===c.nodeType){const i=function(i){const c=i.nodeValue,o=new RegExp(e,"gi");let r,a=0,s=document.createDocumentFragment();for(;null!==(r=o.exec(c));){s.appendChild(document.createTextNode(c.substring(a,r.index)));const e=document.createElement("span");e.textContent=r[0],e.classList.add(h),e.classList.add(l),e.setAttribute("id",n+"-"+t),s.appendChild(e),u=t+1,t++,a=r.index+r[0].length}return s.appendChild(document.createTextNode(c.substring(a))),s}(c);i.childNodes.length>1&&c.parentNode.replaceChild(i,c)}else 1===c.nodeType&&Array.from(c.childNodes).forEach(i)}(i);let c=document.querySelector("."+l);null!==c&&b(c);g(),p(),m=-1}),600);a.addEventListener("click",(function(){m--;const e=document.querySelector("#"+n+"-"+m);e&&b(e),e.classList.add("active"),setTimeout(()=>{e.classList.remove("active")},3e3),p()})),s.addEventListener("click",(function(){m++;const e=document.querySelector("#"+n+"-"+m);e&&b(e),e.classList.add("active"),setTimeout(()=>{e.classList.remove("active")},3e3),p()})),document.addEventListener("keyup",e=>{switch(e.key){case"ArrowRight":s.click();break;case"ArrowLeft":a.click()}})}document.addEventListener("DOMContentLoaded",(function(){inPageSearch()}));
 function highlightMenuItems(){let t=null;function e(t){document.querySelectorAll("#toc_list a").forEach(t=>{t.classList.remove("highlight-cfib41dyhcd99sm")});const e=document.querySelector(`#toc_list a[href="#${t.id}"]`);e&&(e.classList.add("highlight-cfib41dyhcd99sm"),e.scrollIntoView({behavior:"smooth",block:"center"}))}const o=new IntersectionObserver((o,n)=>{const c=o.filter(t=>t.isIntersecting).map(t=>t.target);c.length>0?(t=c[0],e(t)):t&&e(t)},{root:null,rootMargin:"0px",threshold:.1});document.querySelectorAll("h2, h3, h4, h5, h6").forEach(t=>o.observe(t))}document.addEventListener("DOMContentLoaded",(function(){highlightMenuItems()}));
 function backToTop(){const n=document.createElement("a");n.id="back-to-top-a1zncgtqfpzsig8",n.href="#content",n.innerHTML="↑",document.body.appendChild(n);const t=function(n,t){let e;return function(){const o=this,c=arguments;clearTimeout(e),e=setTimeout(()=>n.apply(o,c),t)}}((function(){window.scrollY>300?n.style.display="flex":n.style.display="none"}),600);window.addEventListener("scroll",(function(){t()}))}document.addEventListener("DOMContentLoaded",(function(){backToTop()}));

package/assets/js/edit-term-buttons.js

@@ -7,8 +7,8 @@
  */
 
 function editTermButtons() {
-   // find the definition list that is the next sibling of #terms-definitions
-   const termsDefinitions = document.querySelector('.terms-and-definitions-list');
+   // Find the definition list. This does not work ok. Disabled for now.
+   // const termsDefinitions = document.querySelector('.terms-and-definitions-list');
 
    // Remove "./" or "/" from the beginning of a string and "/" at the end of the string
    function cleanPath(path) {
@@ -30,15 +30,15 @@ function editTermButtons() {
    // Example usage with the string from the file
 
    const cleanedSpecDir = cleanPath(specConfig.spec_directory);
-
-   termsDefinitions.querySelectorAll('dt').forEach(term => {
-      const url = term.querySelector('span').getAttribute('id');
+   
+   document.querySelectorAll('span[id^="term:"]').forEach(term => {
+      const url = term.getAttribute('id');
 
       // cut “url” on the “:” and keep the second part
       const fileName = url.split(":")[1];
 
       // add edit and history buttons to term
-      term.innerHTML += `<sup class="edit-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/ctwg-main-glossary/blob/main/${cleanedSpecDir}/${specConfig.spec_terms_directory}/${fileName}.md" class="edit-term-button">Edit</a></sup><sup class="history-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/ctwg-main-glossary/commits/main/${cleanedSpecDir}/${specConfig.spec_terms_directory}/${fileName}.md" class="history-term-button">History</a></sup>`;
+      term.innerHTML += `<sup class="edit-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/${specConfig.source.repo}/blob/main/${cleanedSpecDir}/${specConfig.spec_terms_directory}/${fileName}.md" class="edit-term-button">Edit</a></sup><sup class="history-term-button-sup"><a target="_blank" rel="noopener" href="https://github.com/${specConfig.source.account}/${specConfig.source.repo}/commits/main/${cleanedSpecDir}/${specConfig.spec_terms_directory}/${fileName}.md" class="history-term-button">History</a></sup>`;
    });
 }
 

package/index.js

@@ -6,7 +6,6 @@ module.exports = function(options = {}) {
     validateReferences,
     findExternalSpecByKey
   } = require('./references.js');
-  const {getXrefsData} = require('./src/get-xrefs-data.js');
   const gulp = require('gulp');
   const fs = require('fs-extra');
   const path = require('path');
@@ -31,11 +30,8 @@ module.exports = function(options = {}) {
     }
   ];
 
-  // Test if xrefs-data.js exists
-  // Get the current working directory:
-  const projectRoot = process.cwd();
-  // Create a path for the output file in the project root:
-  const inputPath = path.join(projectRoot, 'output/xrefs-data.js');
+  // Test if xrefs-data.js exists, else make it an empty string
+  const inputPath = 'output/xrefs-data.js';
   let xrefsData = "";
 
   try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "0.11.12",
+  "version": "0.11.13",
   "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/readme.md

@@ -1,24 +1,46 @@
+# Spec-Up-T
 
-
-<p align="center">
+<div align="center">
 
 <img src="./specup_logo.png">
 
-<h3 style="display: block; margin: 0 auto; text-align: center;">Markdown » Spec-Up</h3>
+<h2 style="display: block; margin: 0 auto; text-align: center;">Markdown » Spec-Up</h2>
+</div>
+
+## Intro
 
-</p>
+Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.
 
+Spec-Up-T is an expansion of [DIF's Spec-Up](https://github.com/decentralized-identity/spec-up) specifically for the needs of the Trust-over-IP foundation. Read more in the elaborate motivation in this technical article [Spec-Up-T, the ToIP Terms extension of Spec-Up](https://hackmd.io/s1TEBBluQBSL10ZT5yRVPw)
 
+## Extension
 
-Spec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.
+Spec-Up-T stays in sync with Spec-Up, and currently adds the following extra functionality:
+1. Search & Find
+2. Splitter for Terms and Definition section following the [Termininology Governance Guide](https://trustoverip.github.io/ctwg-terminology-governance-guide/) and various meeting report since [CTWG April 2024](https://wiki.trustoverip.org/display/HOME/2024-04-22+CTWG+Meeting+Notes).
 
 ## Setup
 
-Installing Spec-Up is easy peasy lemon squeezy:
+Install Spec-Up-T as follows:
+
+- Open your terminal and go to the target directory
+- Run `npx create-spec-up-starterpack@latest`
+This will create a working Spec-Up-T installation in a new directory called `spec-up-t-starter-pack`
+
+- Rename this directory to your liking, for example `my-new-specification`
+- Go into this dir:
+`cd my-new-specification`
+You are now in this dir.
+
+- Install all dependencies:
+`npm run install`
+
+Now you have a basic Spec-Up-T install with the following content:
+- a `specs.json` file
+- a `spec/` directory with a sample markdown files
+- (and more)
 
-0. Node.JS, i.e. `nvm` and its package manager `npm`, are required to run spec-up. WSL2 users should look [here](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl#install-nvm-nodejs-and-npm) for specific instructions. 
-1. Run `npm install spec-up` in the root directory of the repo to install all dependencies.
-2. Create a `specs.json` file **in the root folder of your repository** to specify configuration values used in the generation of your spec documents. The values in your `specs.json` file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the `specs.json` config file:
+The`specs.json` file **in the root folder of your repository** specifies configuration values used in the generation of your spec documents. The values in your `specs.json` file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the `specs.json` config file:
 
     - **`public_root`** _(PATH STRING, optional)_ - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the `public_root` property to specify the insertion of a path segment to account for the different in pathing between your local renders and wherever you publish your spec to.
     - **`specs`** _(ARRAY, required)_ - the `specs` array contains descriptor objects for each of the specs you are generating in your project, and are composed of the following required and optional properties:
@@ -38,9 +60,8 @@ Installing Spec-Up is easy peasy lemon squeezy:
                 "repo": "sidetree"
             }
             ```
-3. In your main node.js file, or as a package.json script entry, use this invocation call: `require('spec-up')()`
 
-Boom! That's it. You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate.
+You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate.
 
 ## Running the scripts locally
 

package/src/get-xrefs-data.js

@@ -6,19 +6,18 @@
  */
 
 // Get the current working directory
-const projectRoot = process.cwd();
-const path = require('path');
+
 const fs = require('fs-extra');
-const config = fs.readJsonSync(path.join(projectRoot, '/', 'specs.json'));
+const config = fs.readJsonSync('specs.json');
 const specDirectories = config.specs.map(spec => spec.spec_directory + '/' + spec.spec_terms_directory);
 
 // Create directory named “output” in the project root if it does not yet exist
-if (!fs.existsSync(path.join(projectRoot, '/output'))) {
-    fs.mkdirSync(path.join(projectRoot, '/output'));
+if (!fs.existsSync('output')) {
+    fs.mkdirSync('output');
 }
 
 // Create a path for the output file in the project root
-const outputPath = path.join(projectRoot, '/output/xrefs-data.js');
+const outputPath = 'output/xrefs-data.js';
 
 function getXrefsData() {
     let allXrefs = {};
@@ -55,39 +54,47 @@ function getXrefsData() {
                 throw new Error(`HTTP error! status: ${response.status}`);
             }
 
+            console.log(`Github API request for the term “${match.term}” was successful`);
+
             // Extract JSON data from the response
             const data = await response.json();
 
             // Check if there are any commits
             if (data.length === 0) {
-                console.log("no CommitHash");
+                console.log(`No commit hash found for the term “${match.term}”`);
 
                 return;
             }
 
             // Process the last ten commits
             const commits = data.slice(0, 1); // Get only the last commit
-
-            return commits.map(commit => commit.sha);
+            const commitHash = commits.map(commit => commit.sha);
+            
+            console.log(`Commit hash found for the term “${match.term}”: `, commitHash);
+            return commitHash;
 
             // return;
         } catch (error) {
-            console.error('Failed to fetch commit hash:', error);
+            console.error(`Failed to fetch commit hash for the term “${match.term}”:`, error);
         }
     }
 
     // Go through all directories that contain files with a term and definition
+    console.log('All “spec_directory” found in specs.json: ', specDirectories);
     specDirectories.forEach(specDirectory => {
+        console.log(`Current spec_directory: `, specDirectory);
         // read directory
         fs.readdirSync(specDirectory).forEach(file => {
             // read file
             if (file.endsWith('.md')) {
+                console.log(`Markdown file referenced in spec_directory: `, file);
                 const markdown = fs.readFileSync(`${specDirectory}/${file}`, 'utf8');
                 // create regex that finds “[[xref:.*]]”
                 const regex = /\[\[xref:.*?\]\]/g;
                 if (regex.test(markdown)) {
                     const xrefs = markdown.match(regex);
                     xrefs.forEach(xref => {
+                        console.log(`Xref found in ${file}: `, xref);
                         // example of xref: [[xref: PE, Holder]]
                         allXrefs.xrefs.add(xref);
                     });