hdoc-tools 0.8.45 → 0.8.48

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hornbill Docs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/hdoc-build-pdf.js

@@ -64,7 +64,20 @@
         }).get();
         imgs.push(...srcs);
         for (let i = 0; i < imgs.length; i++) {
-            if (hdoc.valid_url(imgs[i])) {
+            if (!hdoc.valid_url(imgs[i])) {
+                 // Internal link
+                 const image_path = path.join(book_work_root, imgs[i].replace('_books/', ''));
+                 try {
+                     const image_buffer = fs.readFileSync(image_path);
+                     const mime_type = mime.lookup(image_path);
+                     let image_b64 = image_buffer.toString("base64");
+                     image_b64 = `data:${mime_type};base64,${image_b64}`;
+                     html_source = html_source.replace(imgs[i], image_b64);
+                 } catch (err) {
+                     console.log('Error reading image from HTML source [', image_path, '] -', err);
+                     return null;
+                 }
+            } else {
                 // External Link
                 try {
                     const file_response = await axios.get(imgs[i]);
@@ -80,19 +93,6 @@
                 } catch (err) {
                     console.log(`Error downloading external source [${imgs[i]}] - ${err}`);
                 }
-            } else {
-                // Internal link
-                const image_path = path.join(book_work_root, imgs[i].replace('_books/', ''));
-                try {
-                    const image_buffer = fs.readFileSync(image_path);
-                    const mime_type = mime.lookup(image_path);
-                    let image_b64 = image_buffer.toString("base64");
-                    image_b64 = `data:${mime_type};base64,${image_b64}`;
-                    html_source = html_source.replace(imgs[i], image_b64);
-                } catch (err) {
-                    console.log('Error reading image from HTML source [', image_path, '] -', err);
-                    return null;
-                }
             }
         }
 

package/hdoc-build.js

@@ -12,7 +12,9 @@
         hdoc_build_db = require(path.join(__dirname, 'hdoc-build-db.js')),
         hdoc_build_pdf = require(path.join(__dirname, 'hdoc-build-pdf.js')),
         hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
-        {zip} = require('zip-a-folder');
+        {
+            zip
+        } = require('zip-a-folder');
 
     const h_tags_to_search = ['h1', 'h2', 'h3'],
         doc_header_template_path = path.join(__dirname, 'templates', 'doc-header.html'),
@@ -47,7 +49,7 @@
         work_path_content = '',
         verbose = false;
 
-    const pdf_path_excluded = function(relative_path) {
+    const pdf_path_excluded = function (relative_path) {
         if (!hdocbook_project.pdfGeneration || hdocbook_project.pdfGeneration.exclude_paths === undefined) {
             return false;
         }
@@ -231,7 +233,7 @@
             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}`;
-                
+
                 // Generate PDF file from HTML
                 const pdf_file_path = file_path.path.replace(path.extname(file_path.path), '.pdf');
                 pdf_size = await hdoc_build_pdf.generate_pdf(pdf_template_path, pdf_template, hdocbook_config, pdf_txt, pdf_file_path, verbose);
@@ -280,7 +282,11 @@
                 linkify: true,
                 typographer: true
             });
-            md.linkify.set({ fuzzyEmail: false, fuzzyLink: false, fuzzyIP: false });
+            md.linkify.set({
+                fuzzyEmail: false,
+                fuzzyLink: false,
+                fuzzyIP: false
+            });
 
             // Process Frontmatter tags
             let frontmatter_content = "";
@@ -310,7 +316,7 @@
                 fm_content.forEach(function (fm_prop) {
                     const fm_id = fm_prop.slice(0, fm_prop.indexOf(':'));
                     const fm_val = fm_prop.slice(fm_prop.indexOf(':') + 1);
-                    
+
                     if (fm_id && fm_id.trim().length > 0 && fm_val && fm_val.trim().length > 0) {
                         fm_headers.push({
                             id: fm_id.trim(),
@@ -430,17 +436,17 @@
                 doc_header = process_doc_header(fm_headers, file_path.relativePath, doc_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);
             }
-            
+
             let pdf_size = 0;
             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}`;
-                
+
                 // Generate PDF file from HTML
                 const pdf_file_path = file_path.path.replace(path.extname(file_path.path), '.pdf');
                 pdf_size = await hdoc_build_pdf.generate_pdf(pdf_template_path, pdf_template, hdocbook_config, pdf_txt, pdf_file_path, verbose);
             }
-            
+
             html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
 
             // Save HTML into HTML file
@@ -820,7 +826,7 @@
             console.log(`\nZIP Creation Success: ${zip_path}\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-module.js

@@ -1,10 +1,10 @@
 (function () {
     'use strict';
 
-    const   axios = require('axios'),
-            cheerio = require('cheerio'),
-            html2text = require('html-to-text'),
-            wordsCount = require('words-count').default;
+    const axios = require('axios'),
+        cheerio = require('cheerio'),
+        html2text = require('html-to-text'),
+        wordsCount = require('words-count').default;
 
     let includesCache = {};
 
@@ -58,12 +58,12 @@
 
         const stringIsAValidUrl = (s) => {
             try {
-              new URL(s);
-              return true;
+                const url_obj = new URL(s);
+                return url_obj;
             } catch (err) {
-              return false;
+                return false;
             }
-          };
+        };
         return stringIsAValidUrl(url);
     };
 
@@ -156,19 +156,21 @@
             }).get();
             if (heading.length > 0) {
                 return heading[0];
-            } 
+            }
         }
         return false;
     };
 
-    exports.getHTMLFrontmatterHeader = function(html_body) {
+    exports.getHTMLFrontmatterHeader = function (html_body) {
         let response = {
             fm_header: '',
             fm_properties: {}
         };
-        const $ = cheerio.load(html_body, { decodeEntities: false });
+        const $ = cheerio.load(html_body, {
+            decodeEntities: false
+        });
         if ($._root && $._root.children && $._root.children instanceof Array && $._root.children.length > 0) {
-            $._root.children.forEach(function(child){
+            $._root.children.forEach(function (child) {
                 if (child.type === 'comment' && child.data && child.data.startsWith('[[FRONTMATTER')) {
                     // We have a Frontmatter header - return each property in an array
                     const fm_properties = child.data.split(/\r?\n/);
@@ -193,13 +195,15 @@
         return response;
     };
 
-    exports.truncate_string = function( str, n, useWordBoundary ){
-        if (str.length <= n) { return str; }
-        const subString = str.slice(0, n-1);
+    exports.truncate_string = function (str, n, useWordBoundary) {
+        if (str.length <= n) {
+            return str;
+        }
+        const subString = str.slice(0, n - 1);
         return (useWordBoundary ? subString.slice(0, subString.lastIndexOf(" ")) : subString) + '…';
     };
 
-    exports.get_html_read_time = function(html) {
+    exports.get_html_read_time = function (html) {
         // Get word count
         const text = html2text.convert(html, {
             wordwrap: null
@@ -213,7 +217,7 @@
         return read_time;
     };
 
-    exports.get_github_api_path = function(repo, relative_path) {
+    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/');
@@ -222,13 +226,13 @@
         return github_paths;
     };
 
-    exports.get_github_contributors = async function(github_url, github_api_token) {
+    exports.get_github_contributors = async function (github_url, github_api_token) {
         let response = {
             success: false,
             error: '',
             contributors: [],
             contributor_count: 0,
-            last_commit_date:''
+            last_commit_date: ''
         };
 
         let contributors = {};
@@ -255,7 +259,7 @@
         if (github_response.status === 200) {
             response.success = true;
             let commits = github_response.data;
-            commits.forEach(function(commit){
+            commits.forEach(function (commit) {
                 if (commit.committer && commit.committer.type && commit.committer.type.toLowerCase() === 'user' && commit.committer.login.toLowerCase() !== 'web-flow') {
                     if (!contributors[commit.committer.id]) {
                         response.contributor_count++;

package/hdoc-validate.js

@@ -25,7 +25,8 @@
         for (let i = 0; i < links.length; i++) {
 
             // Validate that link is a valid URL first
-            if (!hdoc.valid_url(links[i])) {
+            const valid_url = hdoc.valid_url(links[i]);
+            if (!valid_url) {
                 // Could be a relative path, check
                 isRelativePath(source_path, htmlFile, links[i]);
             } else {
@@ -36,6 +37,9 @@
                     continue;
                 }
 
+                if (valid_url.protocol === 'mailto:') {
+                    continue;
+                }
                 // Skip if the link is excluded in the project config
                 if (exclude_links[links[i]]) {
                     continue;

package/package.json

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

package/templates/init/.github/workflows/hdocbuild_onpull.yml

@@ -0,0 +1,54 @@
+name: HDocBuildPull
+on:
+  # Triggers the workflow on pull request opened or reopened events
+  pull_request_target:
+    types: [opened, reopened]
+    paths-ignore:
+      - '.github/**'
+
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the relevant content for pull_request_target
+      - name: Checkout For Pull Request Target
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      
+      # Setup NodeJS LTS (18 currently)
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      # Install hdoc-tools globally
+      - name: Install hdoc-tools
+        run: npm install hdoc-tools -g
+     
+     # Run hdoc build against checked-out content
+      - name: Perform Validation
+        id: hdocbuild
+        run: |
+          if result=`hdoc build 2>&1`; then
+              printf "Build Success!\n\n"
+              printf "$result"
+              exit 0
+          else
+            valout=$(echo "$result" | awk '/Validation Output/,0')
+            printf "Build Failed!\n\n-----------------------\n"
+            printf "$valout"
+            exit 1
+          fi
+          
+      # If build validation fails, and event trigger was a pull request  then close the pull request
+      - name: Reject Pull Request
+        if: failure()
+        uses: superbrothers/close-pull-request@v3
+        with:
+          comment: "Your pull request has been rejected as build validation has failed. See the Perform Validation step of the build job for more information: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+      
+      # If build validation is successful, echo message
+      - name: Build Success
+        if: success()
+        run: echo "::notice::Build validation passed successfully."

package/templates/init/.github/workflows/hdocbuild_onpush.yml

@@ -0,0 +1,50 @@
+name: HDocBuildPush
+on:
+  # Triggers the workflow on push requests
+  push:
+    paths-ignore:
+      - '.github/**'
+  
+  # Allows us to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    
+      # Checkout the relevant content for push or workflow_dispatch
+      - name: Checkout For Push or Workflow Dispatch
+        uses: actions/checkout@v2
+        with:
+           ref: ${{ github.event.inputs.branch }}
+           fetch-depth: 0    
+      
+      # Setup NodeJS LTS (18 currently)
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      # Install hdoc-tools globally
+      - name: Install hdoc-tools
+        run: npm install hdoc-tools -g
+     
+     # Run hdoc build against checked-out content
+      - name: Perform Validation
+        id: hdocbuild
+        run: |
+          if result=`hdoc build 2>&1`; then
+              printf "Build Success!\n\n"
+              printf "$result"
+              exit 0
+          else
+            valout=$(echo "$result" | awk '/Validation Output/,0')
+            printf "Build Failed!\n\n-----------------------\n"
+            printf "$valout"
+            exit 1
+          fi
+  
+      # If build validation is successful, echo message
+      - name: Build Success
+        if: success()
+        run: echo "::notice::Build validation passed successfully."

package/ui/index.html

@@ -280,13 +280,13 @@
             "css/theme-default/styles/components/content.css",
             "css/theme-default/styles/components/custom-block.css",
 
-            "js/highlightJS/styles/vs2015.css"
+            "js/highlightjs/styles/vs2015.css"
         ],  function()
         {
             //-- required js + 3rd party libs
             setTimeout(function()
             {
-                loadJS(["js/doc.hornbill.js","js/highlightJs/highlight.pack.js","js/highlightjs-badge.js"],function()
+                loadJS(["js/doc.hornbill.js","js/highlightjs/highlight.pack.js","js/highlightjs-badge.js"],function()
                 {
                     intialiseApp();
                 });