hdoc-tools 0.8.26 → 0.8.28

package/hdoc-build.js

@@ -30,6 +30,7 @@
         conversion_failed = 0,
         doc_header_template = '',
         doc_header_template_non_git = '',
+        pdf_enable = false,
         pdf_header_template = '',
         pdf_header_template_non_git = '',
         pdf_template = '',
@@ -43,9 +44,29 @@
         index_records = [],
         md_files = [],
         static_html_files = [],
-        work_path_content = '';
+        work_path_content = '',
+        verbose = false;
 
-    const transform_static_html = async function (file_path, verbose, no_pdf) {
+    const pdf_path_excluded = function(relative_path) {
+        if (!hdocbook_project.pdfGeneration || hdocbook_project.pdfGeneration.exclude_paths === undefined) {
+            return false;
+        }
+        if (relative_path.startsWith('/')) {
+            relative_path = relative_path.slice(1, relative_path.length);
+        }
+        for (let i = 0; i < hdocbook_project.pdfGeneration.exclude_paths.length; i++) {
+            const exclude_path = hdocbook_project.pdfGeneration.exclude_paths[i];
+            if (relative_path === exclude_path) return true;
+            if (exclude_path.at(-1) === '*') {
+                if (relative_path.startsWith(exclude_path.slice(0, -1))) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    };
+
+    const transform_static_html = async function (file_path) {
         if (fs.existsSync(file_path.path)) {
             // Load HTML file
             let html_txt = fs.readFileSync(file_path.path, 'utf8');
@@ -141,11 +162,12 @@
 
             let metadata = {};
 
+            // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
+            html_txt = html_txt.replace(/(<h1.*?>)\s*.*\s*(.*<\/h1>)/, '');
+
             // Get contributor data from Github, if exists
             let contribs = [];
             if (hdocbook_config.publicSource && hdocbook_config.publicSource !== '' && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
-                // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
-                html_txt = html_txt.replace(/(<h1.*?>)\s*.*\s*(.*<\/h1>)/, '');
 
                 const github_paths = hdoc.get_github_api_path(hdocbook_config.publicSource, file_path.relativePath);
                 const contributors = hdoc.get_github_contributors(github_paths.api_path, git_token);
@@ -199,13 +221,13 @@
             if (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 (!no_pdf) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
             } else {
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
-                if (!no_pdf) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
             }
 
-            if (!no_pdf) {
+            if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
                 let pdf_txt = await hdoc_build_pdf.process_images(file_path, html_txt);
                 pdf_txt = `${pdf_header}\n${pdf_txt}`;
                 
@@ -231,7 +253,7 @@
         }
     };
 
-    const transform_markdown_and_save_html = async function (file_path, verbose, no_pdf) {
+    const transform_markdown_and_save_html = async function (file_path) {
         conversion_attempted++;
         if (fs.existsSync(file_path.path)) {
             // Load markdown file
@@ -340,11 +362,12 @@
             }
             let metadata = {};
 
+            // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
+            html_txt = html_txt.replace(/(<h1.*?>)\s*.*\s*(.*<\/h1>)/, '');
+
             // Get contributor data from Github, if exists
             let contribs = [];
             if (hdocbook_config.publicSource && hdocbook_config.publicSource !== '' && hdocbook_config.publicSource.includes('github.com/Hornbill-Docs')) {
-                // Remove the first <h1>title</h1> from the HTML as we'll add that in the document header
-                html_txt = html_txt.replace(/(<h1.*?>)\s*.*\s*(.*<\/h1>)/, '');
 
                 const github_paths = hdoc.get_github_api_path(hdocbook_config.publicSource, file_path.relativePath);
                 const contributors = hdoc.get_github_contributors(github_paths.api_path, git_token);
@@ -396,14 +419,14 @@
             if (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 (!no_pdf) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template);
             } else {
                 // Build doc header from template and frontmatter tags
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_header_template_non_git);
-                if (!no_pdf) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
+                if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) pdf_header = process_doc_header(fm_headers, file_path.relativePath, pdf_header_template_non_git);
             }
 
-            if (!no_pdf) {
+            if (pdf_enable && !pdf_path_excluded(file_path.relativePath)) {
                 let pdf_txt = await hdoc_build_pdf.process_images(file_path, html_txt);
                 pdf_txt = `${pdf_header}\n${pdf_txt}`;
                 
@@ -483,7 +506,9 @@
                 bc_tags += `\t\t\t\t<li class="mt-0 nav-bar-item"><a href="${bc_for_path[i].link}" class="ps-0 pe-0 text-decoration-none">${bc_for_path[i].text}</a></li>\n`;
             }
         } else {
-            console.log(`[WARNING] Path is not present in navigation items: ${logical_path}`);
+            if (verbose) {
+                console.log(`[WARNING] Path is not present in navigation items: ${logical_path}`);
+            }
         }
         bc_tags += '\t\t\t';
         wip_doc_header = wip_doc_header.replaceAll('{{breadcrumbs}}', bc_tags);
@@ -632,11 +657,11 @@
         //console.log(JSON.stringify(bc, null, 2));
     };
 
-    exports.run = async function (source_path, verbose, github_api_token, no_pdf) {
+    exports.run = async function (source_path, verbose_output, github_api_token) {
         if (github_api_token !== '') {
             git_token = github_api_token;
         }
-
+        verbose = verbose_output;
         // GERRY: The purpose of this function is to create a zip file containing the hdocbook content, 
         // * Create a _work folder 
         // * copy the hdocbook content to the work folder
@@ -649,12 +674,16 @@
 
         console.log('Hornbill HDocBook Build', '\n');
         console.log('  Document Path:', source_path, '\n');
+        const build_start_dt = new Date().toLocaleString();
 
         // Load the hdocbook-project.json file to get the docId
         // use the docId to get the book config
         const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
         hdocbook_project = require(hdocbook_project_config_path);
         doc_id = hdocbook_project.docId;
+        if (hdocbook_project.pdfGeneration !== undefined && hdocbook_project.pdfGeneration.enable !== undefined) {
+            pdf_enable = hdocbook_project.pdfGeneration.enable;
+        }
 
         const book_path = path.join(source_path, doc_id),
             hdocbook_path = path.join(book_path, 'hdocbook.json'),
@@ -694,7 +723,7 @@
             process.exit(1);
         }
 
-        if (!no_pdf) {
+        if (pdf_enable) {
             // Load PDF templates
             try {
                 pdf_template = fs.readFileSync(pdf_template_file_path, 'utf8');
@@ -712,12 +741,12 @@
 
         // Work through MD files and convert to HTML
         for (let i = 0; i < md_files.length; i++) {
-            await transform_markdown_and_save_html(md_files[i], verbose, no_pdf);
+            await transform_markdown_and_save_html(md_files[i]);
         }
 
         // Work through Static HTML files and add Frontmatter tags
         for (let i = 0; i < static_html_files.length; i++) {
-            await transform_static_html(static_html_files[i], verbose, no_pdf);
+            await transform_static_html(static_html_files[i]);
         }
 
         // Output to console
@@ -785,7 +814,9 @@
             const zip_path = path.join(work_path, doc_id + '.zip');
             zipper.sync.zip(work_path_content).compress().save(zip_path);
             console.log(`\nZIP Creation Success: ${zip_path}\n`);
-            console.log('Build Complete\n');
+            console.log('  Build Started:', build_start_dt);
+            console.log(`Build Completed: ${new Date().toLocaleString()}\n`);
+            
         } catch (e) {
             console.log('\nError creating ZIP: ' + e);
         }

package/hdoc.js

@@ -27,8 +27,7 @@
    let ui_path = path.join(__dirname, 'ui');
    let git_token = '';
    let command = '', // Our command to run
-      verbose = false,
-      no_pdf = false;
+      verbose = false;
 
    // Get options from command args
    for (let x = 0; x < process.argv.length; x++) {
@@ -43,8 +42,6 @@
 
       if (process.argv[x] === '-v') {
          verbose = true;
-      } else if (process.argv[x] === '-no-pdf') {
-         no_pdf = true;
       } else if (process.argv[x] == '-path') {
          x++;
          if (x < process.argv.length) {
@@ -72,7 +69,7 @@
       server.run(ui_path, source_path);
    } else if (command == 'build') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      await builder.run(source_path, verbose, git_token, no_pdf);
+      await builder.run(source_path, verbose, git_token);
    } else if (command == 'stats') {
       const stats = require(path.join(__dirname, 'hdoc-stats.js'));
       stats.run(ui_path, source_path, verbose);

package/package.json

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