spec-up-t 1.0.55 → 1.0.57

package/gulpfile.js

@@ -15,7 +15,7 @@ const assets = fs.readJsonSync('./src/asset-map.json');
 
 let compileLocation = 'assets/compiled';
 
-async function fetchSpecRefs(){
+async function fetchSpecRefs() {
   return Promise.all([
     axios.get('https://raw.githubusercontent.com/tobie/specref/master/refs/ietf.json'),
     axios.get('https://raw.githubusercontent.com/tobie/specref/master/refs/w3c.json'),
@@ -26,7 +26,7 @@ async function fetchSpecRefs(){
   }).catch(e => console.log(e));
 }
 
-async function compileAssets(){
+async function compileAssets() {
   await fs.ensureDir(compileLocation);
   return new Promise(resolve => {
     mergeStreams(
@@ -42,23 +42,23 @@ async function compileAssets(){
         .pipe(terser())
         .pipe(concat('body.js'))
         .pipe(gulp.dest(compileLocation))
-    ).on('finish', function() {
+    ).on('finish', function () {
       resolve();
     })
   });
 }
 
-function runCommand(cmd){
+function runCommand(cmd) {
   return new Promise((resolve, reject) => {
     exec(cmd, {}, error => error ? reject() : resolve());
   });
 }
 
-async function bumpVersion(){
-  return runCommand(`npm version --no-git-tag-version ${ argv.v || 'patch' }`);
+async function bumpVersion() {
+  return runCommand(`npm version --no-git-tag-version ${argv.v || 'patch'}`);
 }
 
-async function renderSpecs(){
+async function renderSpecs() {
   return runCommand('npm run render');
 }
 

package/index.js

@@ -1,5 +1,5 @@
 
-module.exports = function(options = {}) {
+module.exports = function (options = {}) {
   const fs = require('fs-extra');
   const path = require('path');
 
@@ -11,18 +11,21 @@ module.exports = function(options = {}) {
 
   const { runJsonKeyValidatorSync } = require('./src/json-key-validator.js');
   runJsonKeyValidatorSync();
-  
+
   const { createTermRelations } = require('./src/create-term-relations.js');
   createTermRelations();
+
+  const { createTermIndex } = require('./src/create-term-index.js');
+  createTermIndex();
   
   const { insertTermIndex } = require('./src/insert-term-index.js');
   insertTermIndex();
-  
+
   const gulp = require('gulp');
   const findPkgDir = require('find-pkg-dir');
   const modulePath = findPkgDir(__dirname);
   let config = fs.readJsonSync('./output/specs-generated.json');
-  
+
   const createVersionsIndex = require('./src/create-versions-index.js');
   createVersionsIndex(config.specs[0].output_path);
 
@@ -38,7 +41,7 @@ module.exports = function(options = {}) {
   const replacers = [
     {
       test: 'insert',
-      transform: function(path){
+      transform: function (path) {
         if (!path) return '';
         return fs.readFileSync(path, 'utf8');
       }
@@ -46,7 +49,7 @@ module.exports = function(options = {}) {
   ];
 
   const { processMarkdownFiles } = require('./src/fix-markdown-files.js');
-  
+
   // Synchonously process markdown files
   processMarkdownFiles(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
 
@@ -64,11 +67,11 @@ module.exports = function(options = {}) {
     });
   }
 
-  function normalizePath(path){
+  function normalizePath(path) {
     return path.trim().replace(/\/$/g, '') + '/';
   }
 
-  function renderRefGroup(type){
+  function renderRefGroup(type) {
     let group = specGroups[type];
     if (!group) return '';
     let html = Object.keys(group).sort().reduce((html, name) => {
@@ -84,14 +87,14 @@ module.exports = function(options = {}) {
     return `\n${html}\n</dl>\n`;
   }
 
-  function findKatexDist(){
+  function findKatexDist() {
     const relpath = "node_modules/katex/dist";
     const paths = [
       path.join(process.cwd(), relpath),
       path.join(__dirname, relpath),
     ];
-    for(const abspath of paths) {
-      if(fs.existsSync(abspath)) {
+    for (const abspath of paths) {
+      if (fs.existsSync(abspath)) {
         return abspath
       }
     }
@@ -115,16 +118,16 @@ module.exports = function(options = {}) {
     const specCorpus = fs.readJsonSync(modulePath + '/assets/compiled/refs.json');
     const containers = require('markdown-it-container');
     const md = require('markdown-it')({
-        html: true,
-        linkify: true,
-        typographer: true
-      })
+      html: true,
+      linkify: true,
+      typographer: true
+    })
       .use(require('./src/markdown-it-extensions.js'), [
         {
           filter: type => type.match(terminologyRegex),
-          parse(token, type, primary){
+          parse(token, type, primary) {
             if (!primary) return;
-            if (type === 'def'){
+            if (type === 'def') {
               definitions.push(token.info.args);
               return token.info.args.reduce((acc, syn) => {
                 return `<span id="term:${syn.replace(spaceRegex, '-').toLowerCase()}">${acc}</span>`;
@@ -144,13 +147,13 @@ module.exports = function(options = {}) {
         },
         {
           filter: type => type.match(specNameRegex),
-          parse(token, type, name){
+          parse(token, type, name) {
             if (name) {
               let _name = name.replace(spaceRegex, '-').toUpperCase();
               let spec = specCorpus[_name] ||
-                         specCorpus[_name.toLowerCase()] || 
-                         specCorpus[name.toLowerCase()] || 
-                         specCorpus[name];
+                specCorpus[_name.toLowerCase()] ||
+                specCorpus[name.toLowerCase()] ||
+                specCorpus[name];
               if (spec) {
                 spec._name = _name;
                 let group = specGroups[type] = specGroups[type] || {};
@@ -158,8 +161,8 @@ module.exports = function(options = {}) {
               }
             }
           },
-          render(token, type, name){
-            if (name){
+          render(token, type, name) {
+            if (name) {
               let spec = token.info.spec;
               if (spec) return `[<a class="spec-reference" href="#ref:${spec._name}">${spec._name}</a>]`;
             }
@@ -179,12 +182,12 @@ module.exports = function(options = {}) {
       .use(require('markdown-it-sup'))
       .use(require('markdown-it-task-lists'))
       .use(require('markdown-it-multimd-table'), {
-        multiline:  true,
-        rowspan:    true,
+        multiline: true,
+        rowspan: true,
         headerless: true
       })
       .use(containers, 'notice', {
-        validate: function(params) {
+        validate: function (params) {
           let matches = params.match(/(\w+)\s?(.*)?/);
           return matches && noticeTypes[matches[1]];
         },
@@ -194,7 +197,7 @@ module.exports = function(options = {}) {
             let id;
             let type = matches[1];
             if (matches[2]) {
-              id = matches[2].trim().replace(/\s+/g , '-').toLowerCase();
+              id = matches[2].trim().replace(/\s+/g, '-').toLowerCase();
               if (noticeTitles[id]) id += '-' + noticeTitles[id]++;
               else noticeTitles[id] = 1;
             }
@@ -214,7 +217,7 @@ module.exports = function(options = {}) {
         anchorClassName: 'toc-anchor'
       })
       .use(require('@traptitech/markdown-it-katex'))
-    
+
     // Custom plugin to add class to <dl> and the last <dd> in each series after a <dt>
     function addClassToDefinitionList(md) {
       const originalRender = md.renderer.rules.dl_open || function (tokens, idx, options, env, self) {
@@ -272,11 +275,11 @@ module.exports = function(options = {}) {
         noticeTitles = {};
         specGroups = {};
         console.log('\n   SPEC-UP-T: Rendering: ' + spec.title + "\n");
-        
+
         function interpolate(template, variables) {
           return template.replace(/\${(.*?)}/g, (match, p1) => variables[p1.trim()]);
         }
-        
+
         return new Promise(async (resolve, reject) => {
           Promise.all((spec.markdown_paths || ['spec.md']).map(_path => {
             return fs.readFile(spec.spec_directory + _path, 'utf8').catch(e => reject(e))
@@ -301,34 +304,35 @@ module.exports = function(options = {}) {
               externalReferences: JSON.stringify(externalReferences),
               xrefsData: xrefsData,
               specLogo: spec.logo,
+              specFavicon: spec.favicon,
               specLogoLink: spec.logo_link,
               spec: JSON.stringify(spec)
             });
-            
+
             fs.writeFile(path.join(spec.destination, 'index.html'),
               templateInterpolated, 'utf8'
 
-            , function (err, data) {
-              if (err) {
-                reject(err);
-              }
-              else {
-                resolve();
-              }
-            });
+              , function (err, data) {
+                if (err) {
+                  reject(err);
+                }
+                else {
+                  resolve();
+                }
+              });
             validateReferences(references, definitions, render);
             references = [];
             definitions = [];
           });
         });
       }
-      catch(e) {
+      catch (e) {
         console.error("\n   SPEC-UP-T: " + e + "\n");
       }
     }
 
     config.specs.forEach(spec => {
-      spec.spec_directory = normalizePath(spec.spec_directory);    
+      spec.spec_directory = normalizePath(spec.spec_directory);
       spec.destination = normalizePath(spec.output_path || spec.spec_directory);
 
       fs.ensureDirSync(spec.destination);
@@ -343,40 +347,40 @@ module.exports = function(options = {}) {
           assets.css += `<link href="${asset.path}" rel="stylesheet"/>`;
         }
         if (ext === 'js') {
-          assets.js[asset.inject || 'body'] += `<script src="${asset.path}" ${ asset.module ? 'type="module"' : '' } ></script>`;
+          assets.js[asset.inject || 'body'] += `<script src="${asset.path}" ${asset.module ? 'type="module"' : ''} ></script>`;
         }
         return assets;
       }, {
         css: '',
         js: { head: '', body: '' }
-      });  
+      });
 
       if (options.dev) {
-        assetTags.head = assets.head.css.map(_path => `<link href="${_path}" rel="stylesheet"/>`).join('') + 
-                         customAssets.css +
-                         assets.head.js.map(_path =>  `<script src="${_path}"></script>`).join('') +
-                         customAssets.js.head;
-        assetTags.body = assets.body.js.map(_path => `<script src="${_path}" data-manual></script>`).join('') + 
-                         customAssets.js.body;
+        assetTags.head = assets.head.css.map(_path => `<link href="${_path}" rel="stylesheet"/>`).join('') +
+          customAssets.css +
+          assets.head.js.map(_path => `<script src="${_path}"></script>`).join('') +
+          customAssets.js.head;
+        assetTags.body = assets.body.js.map(_path => `<script src="${_path}" data-manual></script>`).join('') +
+          customAssets.js.body;
       }
       else {
         assetTags.head = `
           <style>${fs.readFileSync(modulePath + '/assets/compiled/head.css', 'utf8')}</style>
-          ${ customAssets.css }
+          ${customAssets.css}
           <script>${fs.readFileSync(modulePath + '/assets/compiled/head.js', 'utf8')}</script>
-          ${ customAssets.js.head }
+          ${customAssets.js.head}
         `;
         assetTags.body = `<script>${fs.readFileSync(modulePath + '/assets/compiled/body.js', 'utf8')}</script>
-                          ${ customAssets.js.body }`;
+          ${customAssets.js.body}`;
       }
 
       if (spec.katex) {
         const katexDist = findKatexDist();
         assetTags.body += `<script>/* katex */${fs.readFileSync(path.join(katexDist, 'katex.min.js'),
-                          'utf8')}</script>`;
+          'utf8')}</script>`;
         assetTags.body += `<style>/* katex */${fs.readFileSync(path.join(katexDist, 'katex.min.css'),
-                          'utf8')}</style>`;
-        
+          'utf8')}</style>`;
+
         fs.copySync(path.join(katexDist, 'fonts'), path.join(spec.destination, 'fonts'));
       }
 
@@ -394,7 +398,7 @@ module.exports = function(options = {}) {
     });
 
   }
-  catch(e) {
+  catch (e) {
     console.error("\n   SPEC-UP-T: " + e + "\n");
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.0.55",
+  "version": "1.0.57",
   "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": {
@@ -28,29 +28,29 @@
     "diff": "^7.0.0",
     "find-pkg-dir": "^2.0.0",
     "fs-extra": "^11.2.0",
-    "gulp": "^5.0.0",
-    "gulp-clean-css": "^4.3.0",
-    "gulp-concat": "^2.6.1",
-    "gulp-terser": "^2.1.0",
+    "gulp": "4.0.2",
+    "gulp-clean-css": "4.3.0",
+    "gulp-concat": "2.6.1",
+    "gulp-terser": "1.2.0",
     "jsdom": "^25.0.0",
     "markdown-it": "^13.0.1",
-    "markdown-it-anchor": "5.2.5",
-    "markdown-it-attrs": "4.1.4",
+    "markdown-it-anchor": "^9.2.0",
+    "markdown-it-attrs": "^4.1.4",
     "markdown-it-chart": "^0.2.0",
     "markdown-it-container": "^2.0.0",
     "markdown-it-deflist": "^2.1.0",
     "markdown-it-icons": "^0.4.1",
     "markdown-it-ins": "^2.0.0",
     "markdown-it-mark": "^2.0.0",
-    "markdown-it-modify-token": "1.0.2",
+    "markdown-it-modify-token": "^1.0.2",
     "markdown-it-multimd-table": "^4.1.3",
     "markdown-it-prism": "^2.2.0",
     "markdown-it-references": "1.0.0-alpha.10",
     "markdown-it-sub": "^1.0.0",
     "markdown-it-sup": "^1.0.0",
-    "markdown-it-task-lists": "2.1.1",
-    "markdown-it-textual-uml": "0.1.3",
-    "markdown-it-toc-and-anchor": "4.2.0",
+    "markdown-it-task-lists": "^2.1.1",
+    "markdown-it-textual-uml": "^0.1.3",
+    "markdown-it-toc-and-anchor": "^4.2.0",
     "merge-stream": "^2.0.0",
     "pdf-lib": "^1.17.1",
     "pkg-dir": "^8.0.0",

package/src/create-term-index.js

@@ -1,7 +1,4 @@
 /**
- * Creates a term index by reading specifications from a JSON file and generating a list of file paths.
- * The list of file paths is then written to a JSON file in the project root directory.
- *
  * Steps:
  * 1. Reads the configuration from 'specs.json'.
  * 2. Extracts the directories containing the specifications and terms.
@@ -25,7 +22,8 @@ function createTermIndex() {
     const specDirectories = config.specs.map(spec => spec.spec_directory);
     const specTermDirectoryName = config.specs.map(spec => spec.spec_terms_directory);
     const outputPathJSON = './term-index.json';
-    const files = fs.readdirSync(path.join(specDirectories[0], specTermDirectoryName[0]));
+    const files = fs.readdirSync(path.join(specDirectories[0], specTermDirectoryName[0]))
+        .filter(file => !file.startsWith('_'));
 
     const filePaths = files.map(file => specTermDirectoryName[0] + '/' + file);
 

package/templates/template.html

@@ -5,9 +5,9 @@
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-
+    <meta name="generator" content="Spec-Up-T" />
     <title>${title}</title>
-
+    <link rel="icon" href="${specFavicon}" type="image/x-icon">
     <link href="https://fonts.googleapis.com/css2?family=Heebo:wght@300;400&display=swap" rel="stylesheet">
 
     ${assetsHead}

package/assets/test.json

@@ -1,5 +0,0 @@
-{
-  "foo": {
-    "bar": 1
-  }
-}

package/assets/test.text

@@ -1 +0,0 @@
-Beam me in, Scotty!

package/custom-assets/custom-body.js

@@ -1,5 +0,0 @@
-import {test } from './module-test.js';
-
-console.log('Custom javascript in body')
-
-test();

package/custom-assets/custom-head.js

@@ -1 +0,0 @@
-console.log('Custom javascript in head')

package/custom-assets/custom.css

@@ -1,6 +0,0 @@
-
-body:after {
-  content: "Custom CSS in body";
-  opacity: 0;
-  pointer-events: none;
-}

package/custom-assets/module-test.js

@@ -1,8 +0,0 @@
-
-function test(){
-  console.log('module option for custom assets')
-}
-
-export {
-  test
-}

package/term-index.json

@@ -1,6 +0,0 @@
-[
-    "terms-definitions/term-1.md",
-    "terms-definitions/term-2.md",
-    "terms-definitions/term-3.md",
-    "terms-definitions/term-4.md"
-]