hdoc-tools 0.15.3 → 0.17.0

package/hdoc-build.js

@@ -15,7 +15,8 @@
         hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
         {
             zip
-        } = require('zip-a-folder');
+        } = require('zip-a-folder'),
+        xmlFormat = require('xml-formatter');
 
     const h_tags_to_search = ['h1', 'h2', 'h3'],
         doc_header_template_path = path.join(__dirname, 'templates', 'doc-header.html'),
@@ -302,7 +303,7 @@
 
             // Pull in external includes
             const includes_processed = await hdoc.process_includes(file_path.path, md_txt);
-            md_txt = includes_processed.body;
+            md_txt = includes_processed.body.toString();
             includes_found += includes_processed.found;
             includes_success += includes_processed.success;
             includes_failed += includes_processed.failed;
@@ -337,8 +338,13 @@
                 links: true
             });
 
+            // Tidy up ```json and ```xml code tags
+
+            if (md_txt.includes('```json') || md_txt.includes('```xml'))
+                md_txt = tidy_code_tags(md_txt, file_path.relativePath);
+
             // Render markdown into HTML
-            let html_txt = md.render(md_txt.toString());
+            let html_txt = md.render(md_txt);
 
             // Prepare frontmatter headers
             let fm_headers = [];
@@ -541,6 +547,44 @@
         return false;
     };
 
+    const tidy_code_tags = function (markdown, file) {
+        const json_to_tidy = markdown.match(/```json(\s|.)*?```/g);
+        if (json_to_tidy && json_to_tidy.length > 0) {
+            for (let i = 0; i < json_to_tidy.length; i++) {
+                if (json_to_tidy[i] !== '') {
+                    let json_tidy = json_to_tidy[i].replace('```json', '').replace('```', '');
+                    try {
+                        json_tidy = JSON.stringify(JSON.parse(json_tidy), null, 2);
+                    } catch (e) {
+                        console.log(`[WARNING] Could not tidy JSON in file [${file}]: ${e}`);
+                    }
+                    markdown = markdown.replace(json_to_tidy[i], '```json\n' + json_tidy + '\n```');
+                }
+            }
+        }
+
+        const xml_to_tidy = markdown.match(/```xml(\s|.)*?```/g);
+        if (xml_to_tidy && xml_to_tidy.length > 0) {
+            for (let i = 0; i < xml_to_tidy.length; i++) {
+                if (xml_to_tidy[i] !== '') {
+                    const xml_tidy = xml_to_tidy[i].replace('```xml', '').replace('```', '');
+                    let new_xml_string = xml_tidy;
+                    try {
+                        new_xml_string = xmlFormat(xml_tidy, {
+                            indentation: '  ',
+                            collapseContent: true,
+                            lineSeparator: '\n'
+                        });
+                    } catch (e) {
+                        console.log(`[WARNING] Could not tidy XML in file [${file}]: ${e}`);
+                    }
+                    markdown = markdown.replace(xml_to_tidy[i], '```xml\n' + new_xml_string + '\n```');
+                }
+            }
+        }
+        return markdown;
+    };
+
     const process_doc_header = function (fm_headers, doc_path, template, h1) {
         let wip_doc_header = template;
         let used_h1 = false;

package/hdoc-validate.js

@@ -194,6 +194,32 @@
         return nav_errors;
     };
 
+    const checkRedirects = async function (source_path) {
+        let errors = [];
+        for (const key in redirects) {
+            if (redirects.hasOwnProperty(key)) {
+                let redir_locations = [
+                    path.join(source_path, redirects[key].location + '.md'),
+                    path.join(source_path, redirects[key].location, 'index.md'),
+                    path.join(source_path, redirects[key].location + '.html'),
+                    path.join(source_path, redirects[key].location + '.htm'),
+                    path.join(source_path, redirects[key].location, 'index.html'),
+                    path.join(source_path, redirects[key].location, 'index.htm')
+                ];
+                let redir_location_ok = false;
+                for (let i = 0; i < redir_locations.length; i++) {
+                    if (fs.existsSync(redir_locations[i])) {
+                        redir_location_ok = true;
+                        break;
+                    }
+                }
+                if (!redir_location_ok)
+                    errors.push(`Redirect location does not exist: ${redirects[key].location}`);
+            }
+        }
+        return errors;
+    };
+
     const checkRedirect = function (source_path, nav_path) {
         let response = {
             exists: false,
@@ -484,6 +510,10 @@
         const nav_errors = await checkNavigation(source_path, nav_items, exclude_spellcheck);
         if (nav_errors.length > 0) meta_errors.push(...nav_errors);
 
+        // Check redirects
+        const redirect_errors = await checkRedirects(source_path);
+        if (redirect_errors.length > 0) meta_errors.push(...redirect_errors);
+
         if (meta_errors.length > 0) {
             console.log('\r\n-----------------------');
             console.log('   Validation Output   ');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.15.3",
+  "version": "0.17.0",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -58,6 +58,7 @@
     "stream": "0.0.2",
     "true-case-path": "^2.2.1",
     "words-count": "^2.0.2",
+    "xml-formatter": "^3.6.0",
     "zip-a-folder": "^1.1.5"
   }
 }