docgen-tool 3.3.0 → 3.4.0

package/dist/package.json

@@ -0,0 +1,72 @@
+{
+    "name": "docgen-tool",
+    "version": "3.4.0",
+    "description": "A tool for creating HTML and PDF documentation",
+    "main": "dist/docgen.ts",
+    "bin": {
+        "docgen": "dist/docgen.ts"
+    },
+    "files": [
+        "dist/*"
+    ],
+    "scripts": {
+        "copy:files": "ncp src/include dist/include",
+        "dev": "ts-node src/docgen.ts run",
+        "build": "rimraf dist && tsc -p tsconfig.json && yarn copy:files",
+        "run:build": "dist/docgen.ts",
+        "build:docs": "ts-node src/docgen.ts run -m -n -r -p -d 40000 -i src/docs -o ./docs",
+        "build:docs:nopdf": "ts-node src/docgen.ts run -m -n -r -i src/docs -o ./docs",
+        "build:styles": "sass --no-source-map src/styles/main.scss src/include/require/styles/framework.css",
+        "test": "npm run prettier:check",
+        "test:run": "rimraf src/__test__/test-run-output && ts-node src/docgen.ts run -i src/__test__/test-run -o src/__test__/test-run-output -p -m -n -d 40000",
+        "test:scaffold": "rimraf src/__test__/test-run-output && ts-node src/docgen.ts scaffold -o src/__test__/test-run-output",
+        "test:prod:run": "rimraf src/__test__/test-run-output && ./dist/docgen.js run -i src/__test__/test-run -o ../source/__test__/test-run-output -p -m -n -d 40000",
+        "prettier:check": "prettier --check 'src/docgen.ts' '*.{ts,js,json,css,less}'",
+        "prettier:fix": "prettier --write 'src/docgen.ts' '*.{ts,js,json,css,less}'"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "lint-staged"
+        }
+    },
+    "lint-staged": {
+        "*.{js,json,css,less}": "prettier --write",
+        "docgen": "prettier --write"
+    },
+    "dependencies": {
+        "chalk": "^4.1.0",
+        "cheerio": "^1.0.0-rc.12",
+        "cli-spinner": "^0.2.10",
+        "commander": "^11.0.0",
+        "fs-extra": "^11.1.1",
+        "husky": "^4.3.0",
+        "image-size": "^1.0.2",
+        "lint-staged": "^10.5.1",
+        "markdown-it": "^13.0.1",
+        "moment": "^2.29.4",
+        "spawn-args": "^0.2.0",
+        "z-schema": "^6.0.1"
+    },
+    "devDependencies": {
+        "@types/node": "^20.3.1",
+        "eslint": "^8.43.0",
+        "eslint-config-prettier": "^8.8.0",
+        "ncp": "^2.0.0",
+        "prettier": "^2.1.2",
+        "rimraf": "^5.0.1",
+        "sass": "^1.66.1",
+        "ts-node": "^10.9.1",
+        "tslib": "^2.5.3",
+        "typescript": "^5.1.3"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/mtmacdonald/docgen"
+    },
+    "author": "Inkit Inc. and contributors",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/mtmacdonald/docgen/issues"
+    },
+    "homepage": "https://mtmacdonald.github.io/docgen/docs/index.html"
+}

package/dist/src/docgen/docgen.js

@@ -0,0 +1,198 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocGen = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var path_1 = __importDefault(require("path"));
+var fs_1 = require("./fs/fs");
+var meta_1 = require("./fs/meta");
+var templates_1 = require("./fs/templates");
+var markdown_1 = require("./fs/markdown");
+var wkhtmltopdf_1 = require("./pdf/wkhtmltopdf/wkhtmltopdf");
+var scaffold_1 = require("./scaffold/scaffold");
+var sort_pages_1 = require("./meta/sort-pages");
+var web_table_of_contents_1 = require("./html/web-table-of-contents");
+var process_pages_1 = require("./html/process-pages");
+var write_pages_1 = require("./fs/write-pages");
+var redirect_1 = require("./html/redirect");
+var package_json_1 = require("../../package.json");
+function DocGen(process) {
+    var _this = this;
+    var mainProcess = process;
+    var options;
+    var templates = {
+        main: '',
+        redirect: '',
+        webCover: '',
+        pdfCover: '',
+        pdfHeader: '',
+        pdfFooter: '',
+    };
+    var meta = {};
+    var pages = {};
+    var sortedPages = {};
+    this.getVersion = function () {
+        return package_json_1.version;
+    };
+    this.setOptions = function (userOptions) {
+        options = userOptions;
+        //all user-specified paths must be normalized
+        if (options.input) {
+            options.input = path_1.default.normalize(options.input + '/');
+        }
+        if (options.output) {
+            options.output = path_1.default.normalize(options.output + '/');
+        }
+        //wkhtmltopdf path does not need a trailing slash
+        if (options.wkhtmltopdfPath && options.wkhtmltopdfPath !== '') {
+            options.wkhtmltopdfPath = path_1.default.normalize(options.wkhtmltopdfPath);
+        }
+    };
+    /*
+      copy the example src files (template) to any directory, when scaffold command is invoked
+    */
+    this.scaffold = function () { return __awaiter(_this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, (0, scaffold_1.scaffold)({
+                    outputDirectory: options.output,
+                    verbose: options.verbose === true,
+                })];
+        });
+    }); };
+    this.run = function () { return __awaiter(_this, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    console.log(chalk_1.default.green.bold('DocGen version ' + package_json_1.version));
+                    //delete and recreate the output directory
+                    return [4 /*yield*/, (0, fs_1.cleanDirectory)(options.output, options.verbose)];
+                case 1:
+                    //delete and recreate the output directory
+                    _b.sent();
+                    return [4 /*yield*/, (0, templates_1.loadTemplates)({
+                            verbose: options.verbose,
+                            mainProcess: mainProcess,
+                        })];
+                case 2:
+                    templates = _b.sent();
+                    return [4 /*yield*/, (0, meta_1.loadMeta)({
+                            inputPath: options.input,
+                            verbose: options.verbose,
+                            mainProcess: mainProcess,
+                        })];
+                case 3:
+                    meta = _b.sent();
+                    sortedPages = (0, sort_pages_1.sortPages)({ tableOfContents: meta.contents });
+                    return [4 /*yield*/, (0, markdown_1.loadMarkdown)({
+                            verbose: options.verbose,
+                            contents: meta.contents,
+                            inputPath: options.input,
+                            mainProcess: mainProcess,
+                        })];
+                case 4:
+                    pages = _b.sent();
+                    templates.main = (0, web_table_of_contents_1.generateWebTableOfContents)({
+                        sortedPages: sortedPages,
+                        name: meta.parameters.name,
+                        mainTemplate: templates.main,
+                        pdfEnabled: options.pdf,
+                    });
+                    (0, process_pages_1.insertParameters)({
+                        inputPath: options.input,
+                        parameters: meta.parameters,
+                        setVersion: options.setVersion,
+                        setReleaseDate: options.setReleaseDate,
+                        templates: templates,
+                        mathMathjax: options.mathMathjax,
+                        mathKatex: options.mathKatex,
+                        version: package_json_1.version,
+                        homeLink: meta.contents[0].pages[0],
+                    });
+                    _a = templates;
+                    return [4 /*yield*/, (0, process_pages_1.processPages)({
+                            pages: pages,
+                            pageTableOfContentsEnabled: options.pageToc,
+                            tableOfContents: meta.contents,
+                            mainTemplate: templates.main,
+                            webCover: templates.webCover,
+                        })];
+                case 5:
+                    _a.webCover = _b.sent();
+                    return [4 /*yield*/, (0, write_pages_1.writePages)({
+                            inputPath: options.input,
+                            outputPath: options.output,
+                            contents: meta.contents,
+                            templates: templates,
+                            pages: pages,
+                            pdfEnabled: options.pdf,
+                            mathKatex: options.mathKatex,
+                            verbose: options.verbose,
+                            mainProcess: mainProcess,
+                        })];
+                case 6:
+                    _b.sent();
+                    return [4 /*yield*/, (0, redirect_1.createRedirect)({
+                            isRedirectEnabled: options.redirect,
+                            outputDirectory: options.output,
+                            redirectTemplate: templates.redirect,
+                            homePage: meta.contents[0].pages[0],
+                            verbose: options.verbose,
+                        })];
+                case 7:
+                    _b.sent();
+                    if (!(options.pdf === true)) return [3 /*break*/, 10];
+                    return [4 /*yield*/, (0, wkhtmltopdf_1.checkPdfVersion)({ options: options, mainProcess: mainProcess })];
+                case 8:
+                    _b.sent();
+                    return [4 /*yield*/, (0, wkhtmltopdf_1.generatePdf)({ options: options, meta: meta, sortedPages: sortedPages, mainProcess: mainProcess })];
+                case 9:
+                    _b.sent();
+                    return [3 /*break*/, 11];
+                case 10:
+                    console.log(chalk_1.default.green.bold('Done!'));
+                    _b.label = 11;
+                case 11: return [2 /*return*/];
+            }
+        });
+    }); };
+}
+exports.DocGen = DocGen;

package/dist/src/docgen/execute/execute.js

@@ -0,0 +1,63 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execute = void 0;
+var util_1 = require("util");
+var child_process_1 = require("child_process");
+var execPromise = (0, util_1.promisify)(child_process_1.exec);
+function execute(command) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _a, stdout, stderr, e_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, execPromise(command)];
+                case 1:
+                    _a = _b.sent(), stdout = _a.stdout, stderr = _a.stderr;
+                    return [2 /*return*/, { stdout: stdout, stderr: stderr }];
+                case 2:
+                    e_1 = _b.sent();
+                    console.error(e_1);
+                    return [3 /*break*/, 3];
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.execute = execute;

package/dist/src/docgen/fs/markdown.js

@@ -0,0 +1,115 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadMarkdown = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var fs_1 = require("./fs");
+var markdown_it_1 = __importDefault(require("markdown-it"));
+var markdown = new markdown_it_1.default('commonmark').enable('table');
+//Allow CommonMark links that use other protocols, such as file:///
+//The markdown-it implementation is more restrictive than the CommonMark spec
+//See https://github.com/markdown-it/markdown-it/issues/108
+markdown.validateLink = function () {
+    return true;
+};
+var loadMarkdown = function (_a) {
+    var contents = _a.contents, inputPath = _a.inputPath, verbose = _a.verbose, mainProcess = _a.mainProcess;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var pages, keys_1, files_1, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    console.log(chalk_1.default.green('Loading src files'));
+                    pages = {};
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    keys_1 = [];
+                    files_1 = [];
+                    contents.forEach(function (section) {
+                        section.pages.forEach(function (page) {
+                            keys_1.push(page);
+                            files_1.push(inputPath + '/' + page.source);
+                        });
+                    });
+                    //add the release notes page
+                    keys_1.push('ownership');
+                    files_1.push(inputPath + '/release-notes.md');
+                    return [4 /*yield*/, Promise.all(files_1.map(function (f) { return (0, fs_1.readFile)(f); }))];
+                case 2:
+                    files_1 = _b.sent();
+                    files_1.forEach(function (page, index) {
+                        var key = keys_1[index];
+                        try {
+                            if (key.html === true) {
+                                //allow raw HTML input pages
+                                pages[key.source] = page;
+                            }
+                            else {
+                                //otherwise parse input from Markdown into HTML
+                                var html = markdown.render(page);
+                                pages[key.source] = html;
+                            }
+                        }
+                        catch (error) {
+                            console.log(chalk_1.default.red('Error parsing Markdown file: ' + key.source));
+                            if (verbose === true) {
+                                console.log(chalk_1.default.red(error));
+                            }
+                            mainProcess.exit(1);
+                        }
+                    });
+                    return [2 /*return*/, pages];
+                case 3:
+                    error_1 = _b.sent();
+                    console.log(error_1);
+                    console.log(chalk_1.default.red('Error loading src files'));
+                    if (verbose === true) {
+                        console.log(chalk_1.default.red(error_1));
+                    }
+                    mainProcess.exit(1);
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.loadMarkdown = loadMarkdown;

package/dist/src/docgen/fs/meta.js

@@ -0,0 +1,110 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadMeta = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var fs_1 = require("./fs");
+var validation_1 = require("../validation/validation");
+var loadMeta = function (_a) {
+    var inputPath = _a.inputPath, verbose = _a.verbose, mainProcess = _a.mainProcess;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var meta, files, key, file, extra, error_1;
+        var _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    meta = {
+                        parameters: null,
+                        contents: null,
+                    };
+                    console.log(chalk_1.default.green('Loading required JSON metadata files'));
+                    _c.label = 1;
+                case 1:
+                    _c.trys.push([1, 4, , 5]);
+                    _b = {};
+                    return [4 /*yield*/, (0, fs_1.readFile)(inputPath + '/parameters.json')];
+                case 2:
+                    _b.parameters = _c.sent();
+                    return [4 /*yield*/, (0, fs_1.readFile)(inputPath + '/contents.json')];
+                case 3:
+                    files = (_b.contents = _c.sent(),
+                        _b);
+                    for (key in files) {
+                        if (files.hasOwnProperty(key)) {
+                            try {
+                                file = JSON.parse(files[key]);
+                                if ((0, validation_1.validateJSON)({ key: key, data: file, verbose: verbose })) {
+                                    meta[key] = file;
+                                }
+                                else {
+                                    mainProcess.exit(1);
+                                }
+                            }
+                            catch (error) {
+                                console.log(chalk_1.default.red('Error parsing required file: ' + key + '.json (invalid JSON)'));
+                                if (verbose === true) {
+                                    console.log(chalk_1.default.red(error));
+                                }
+                                mainProcess.exit(1);
+                            }
+                        }
+                    }
+                    extra = {
+                        heading: 'Extra',
+                        column: 5,
+                        pages: [{ title: 'Release notes', source: 'release-notes.md' }],
+                    };
+                    meta.contents.push(extra);
+                    return [2 /*return*/, meta];
+                case 4:
+                    error_1 = _c.sent();
+                    console.log(chalk_1.default.red('Error loading required JSON metadata files'));
+                    if (verbose === true) {
+                        console.log(chalk_1.default.red(error_1));
+                    }
+                    mainProcess.exit(1);
+                    return [3 /*break*/, 5];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.loadMeta = loadMeta;

package/dist/src/docgen/fs/templates.js

@@ -0,0 +1,100 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadTemplates = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var cheerio_1 = __importDefault(require("cheerio"));
+var fs_1 = require("./fs");
+var loadTemplates = function (_a) {
+    var verbose = _a.verbose, mainProcess = _a.mainProcess;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var templates, files, key, file, dom, error_1;
+        var _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    templates = {};
+                    console.log(chalk_1.default.green('Loading templates'));
+                    _c.label = 1;
+                case 1:
+                    _c.trys.push([1, 8, , 9]);
+                    _b = {};
+                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../../include/templates/main.html')];
+                case 2:
+                    _b.main = _c.sent();
+                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../../include/templates/redirect.html')];
+                case 3:
+                    _b.redirect = _c.sent();
+                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../../include/templates/webCover.html')];
+                case 4:
+                    _b.webCover = _c.sent();
+                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../../include/templates/pdfCover.html')];
+                case 5:
+                    _b.pdfCover = _c.sent();
+                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../../include/templates/pdfHeader.html')];
+                case 6:
+                    _b.pdfHeader = _c.sent();
+                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../../include/templates/pdfFooter.html')];
+                case 7:
+                    files = (_b.pdfFooter = _c.sent(),
+                        _b);
+                    for (key in files) {
+                        if (files.hasOwnProperty(key)) {
+                            file = files[key];
+                            dom = cheerio_1.default.load(file);
+                            templates[key] = dom;
+                        }
+                    }
+                    return [2 /*return*/, templates];
+                case 8:
+                    error_1 = _c.sent();
+                    console.log(chalk_1.default.red('Error loading templates'));
+                    if (verbose === true) {
+                        console.log(chalk_1.default.red(error_1));
+                    }
+                    mainProcess.exit(1);
+                    return [3 /*break*/, 9];
+                case 9: return [2 /*return*/];
+            }
+        });
+    });
+};
+exports.loadTemplates = loadTemplates;