hdoc-tools 0.9.54 → 0.9.56

package/hdoc-build.js

@@ -203,7 +203,7 @@
                     delete contributors.success;
                     delete contributors.error;
                     contributors.editPath = github_paths.edit_path;
-                     
+
                 }
                 fm_headers.push({
                     id: 'edit-path',
@@ -225,7 +225,7 @@
 
             let doc_header = '';
             let pdf_header = '';
-            if (hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
+            if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
@@ -435,7 +435,7 @@
 
             let doc_header = '';
             let pdf_header = '';
-            if (hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
+            if (hdocbook_config.publicSource && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template);
                 if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
@@ -629,7 +629,7 @@
             process.exit(1);
         }
 
-        if (hdocbook_config.publicSource.endsWith('.git')) hdocbook_config.publicSource = hdocbook_config.publicSource.substring(0, hdocbook_config.publicSource.length - 4);
+        if (hdocbook_config.publicSource && hdocbook_config.publicSource.endsWith('.git')) hdocbook_config.publicSource = hdocbook_config.publicSource.substring(0, hdocbook_config.publicSource.length - 4);
 
         console.log(`Loading product families...`);
         const prods = await hdoc.load_product_families();

package/hdoc-module.js

@@ -222,12 +222,15 @@
     };
 
     exports.get_github_api_path = function (repo, relative_path) {
-        repo = repo.endsWith('/') ? repo.slice(0, -1) : repo;
-        let github_paths = {};
-        github_paths.api_path = repo.replace('https://github.com/', 'https://api.github.com/repos/');
-        github_paths.api_path += '/commits?path=/' + relative_path.replace('\\\\', '/').replace('\\', '/');
-        github_paths.edit_path = repo + '/blob/main/' + relative_path.replace('\\\\', '/').replace('\\', '/');
-        return github_paths;
+        if (repo) {
+            repo = repo.endsWith('/') ? repo.slice(0, -1) : repo;
+            let github_paths = {};
+            github_paths.api_path = repo.replace('https://github.com/', 'https://api.github.com/repos/');
+            github_paths.api_path += '/commits?path=/' + relative_path.replace('\\\\', '/').replace('\\', '/');
+            github_paths.edit_path = repo + '/blob/main/' + relative_path.replace('\\\\', '/').replace('\\', '/');
+            return github_paths;
+        }
+        return '';
     };
 
     exports.get_github_contributors = async function (github_url, github_api_token) {

package/hdoc-stats.js

@@ -1,31 +1,31 @@
 
 (function () {
     'use strict';
-    
+
     // Required modules
     // /const { STATUS_CODES } = require('http');
     const fs = require('fs'),
-    path = require('path'),
-    dree = require('dree'),
-    html2text = require('html-to-text'),
-    wordsCount = require('words-count').default;  
-    
+        path = require('path'),
+        dree = require('dree'),
+        html2text = require('html-to-text'),
+        wordsCount = require('words-count').default;
+
     // Regex to remove Hornbill-specific tags 
     const hbMDTagRegex = /(:{3}[ ]note)|(:{3}[ ]tip)|(:{3}[ ]important)|(:{3}[ ]caution)|(:{3}[ ]warning)|(:{3})/g;
-    
+
     let stats = {
         totalMDFiles: 0,
         totalStaticHTMLFiles: 0,
         totalWordCount: 0,
         mdFiles: {},
-        staticHTMLFiles: {} 
+        staticHTMLFiles: {}
     };
 
     let markdownFiles = [];
 
     // File callback for scan 
-    const fileCallback = function(element) {
-        if (element.extension === 'md' ) {
+    const fileCallback = function (element) {
+        if (element.extension === 'md') {
             markdownFiles.push(element);
             stats.totalMDFiles++;
         } else {
@@ -51,7 +51,7 @@
     const dreeOptions = {
         descendants: true,
         depth: 10,
-        extensions: ['md','html','htm'],
+        extensions: ['md', 'html', 'htm'],
         hash: false,
         normalize: true,
         size: true,
@@ -60,8 +60,8 @@
         symbolicLinks: false
     };
 
-    exports.run = function(ui_path, source_path, verbose = false) {
-        
+    exports.run = function (ui_path, source_path, verbose = false) {
+
         // GERRY: The stats here are needed to support content development. The idea is to count all of the ]
         // words in a HDocBook so we know the size of the book, this helps with 3rd party involvement where
         // we generally need to know the word count of the content in order to get a quote for things like
@@ -69,12 +69,12 @@
         //
         // For each .md file, and for each static .HTML file (that is html files that we have not generated) we
         // should do a word count, excluding MD or HTML tags
-        
+
         // STEVE: Get the docId (book root) from the hdocbook-project.json
         // From there, loop through looking for:
         // * HTML files without a matching MD, and word count those
         // * MD files, and word count those
-        
+
 
         console.log('Hornbill HDocBook Stats : verbose=' + verbose, '\r\n');
 
@@ -112,7 +112,7 @@
 
             // Scan content path directory, send file info to callback for processing
             dree.scan(bookPath, dreeOptions, fileCallback);
-            markdownFiles.forEach(function(element){
+            markdownFiles.forEach(function (element) {
                 // Load markdown file
                 let md_txt = fs.readFileSync(element.path, 'utf8');
 
@@ -120,7 +120,7 @@
                 const text = html2text.convert(html_txt, {
                     wordwrap: null
                 });
-                
+
                 // Do the wordcount and add to status
                 const wordCount = wordsCount(text);
                 stats.totalWordCount += wordCount;

package/hdoc-validate.js

@@ -181,7 +181,7 @@
                 messages[htmlFile.relativePath].push(`Link is a properly formatted external URL: ${links[i]}`);
 
                 // Skip if it's the auto-generated edit url, as these could be part of a private repo which would return a 404
-                if (links[i] === hdoc.get_github_api_path(hdocbook_config.publicSource, htmlFile.relativePath).edit_path.replace(path.extname(htmlFile.relativePath), '.md')) {
+                if (hdocbook_config.publicSource !== undefined && links[i] === hdoc.get_github_api_path(hdocbook_config.publicSource, htmlFile.relativePath).edit_path.replace(path.extname(htmlFile.relativePath), '.md')) {
                     continue;
                 }
 
@@ -384,11 +384,12 @@
                 // Check URL exists
                 if (!hdocbook_config.publicSource.startsWith('https://github.com') && !hdocbook_config.publicSource.startsWith('https://api.github.com')) {
                     meta_errors.push(`Value for publicSource in book metadata is not a recognised GitHub URL: ${hdocbook_config.publicSource}`);
-                } else {
-                    // 
                 }
             }
+        }
 
+        if (!hdocbook_config.audience || !(hdocbook_config.audience instanceof Array) || hdocbook_config.audience.length === 0) {
+            meta_errors.push(`Property audience of type array in book metadata is mandatory.`);
         }
 
         // Check navigation spellings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.9.54",
+  "version": "0.9.56",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {