docgen-tool 3.3.0 → 3.4.0

package/dist/docgen/docgen.js

@@ -1,969 +0,0 @@
-"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 cheerio_1 = __importDefault(require("cheerio"));
-var rsvp_1 = __importDefault(require("rsvp"));
-var moment_1 = __importDefault(require("moment"));
-var z_schema_1 = __importDefault(require("z-schema"));
-var child_process_1 = require("child_process");
-var spawn_args_1 = __importDefault(require("spawn-args"));
-var markdown_it_1 = __importDefault(require("markdown-it"));
-var image_size_1 = __importDefault(require("image-size"));
-var cli_spinner_1 = require("cli-spinner");
-var fs_1 = require("./fs/fs");
-var package_json_1 = require("../../package.json");
-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;
-};
-function DocGen(process) {
-    var _this = this;
-    var mainProcess = process;
-    var wkhtmltopdfVersion = 'wkhtmltopdf 0.12.6 (with patched qt)'; //output from wkhtmltopdf -V
-    var options;
-    var templates = {};
-    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) {
-            switch (_a.label) {
-                case 0:
-                    console.log(chalk_1.default.green('Creating scaffold template directory'));
-                    return [4 /*yield*/, (0, fs_1.copyDirectory)(__dirname + '/../include/example', options.output, options.verbose === true)];
-                case 1:
-                    _a.sent();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-    this.run = function () { return __awaiter(_this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.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)];
-                case 1:
-                    //delete and recreate the output directory
-                    _a.sent();
-                    loadTemplates();
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-    /*
-          load all HTML template files
-      */
-    var loadTemplates = function () { return __awaiter(_this, void 0, void 0, function () {
-        var files;
-        var _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    console.log(chalk_1.default.green('Loading templates'));
-                    _a = {};
-                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../include/templates/main.html')];
-                case 1:
-                    _a.main = _b.sent();
-                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../include/templates/redirect.html')];
-                case 2:
-                    _a.redirect = _b.sent();
-                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../include/templates/webCover.html')];
-                case 3:
-                    _a.webCover = _b.sent();
-                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../include/templates/pdfCover.html')];
-                case 4:
-                    _a.pdfCover = _b.sent();
-                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../include/templates/pdfHeader.html')];
-                case 5:
-                    _a.pdfHeader = _b.sent();
-                    return [4 /*yield*/, (0, fs_1.readFile)(__dirname + '/../include/templates/pdfFooter.html')];
-                case 6:
-                    files = (_a.pdfFooter = _b.sent(),
-                        _a);
-                    rsvp_1.default
-                        .hash(files)
-                        .then(function (files) {
-                        for (var key in files) {
-                            if (files.hasOwnProperty(key)) {
-                                var file = files[key];
-                                var dom = cheerio_1.default.load(file);
-                                templates[key] = dom;
-                            }
-                        }
-                        loadMeta();
-                    })
-                        .catch(function (error) {
-                        console.log(chalk_1.default.red('Error loading templates'));
-                        if (options.verbose === true) {
-                            console.log(chalk_1.default.red(error));
-                        }
-                        mainProcess.exit(1);
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-    /*
-      JSON schema validation
-    */
-    var schemas = {
-        parameters: {
-            title: 'DocGen Parameters Schema',
-            type: 'object',
-            required: [
-                'title',
-                'name',
-                'version',
-                'date',
-                'organization',
-                'author',
-                'owner',
-                'contributors',
-                'website',
-                'module',
-                'id',
-                'summary',
-                'marking',
-                'legalese',
-            ],
-            properties: {
-                title: { type: 'string' },
-                name: { type: 'string' },
-                version: { type: 'string' },
-                date: { type: 'string' },
-                organization: {
-                    type: 'object',
-                    required: ['name', 'url'],
-                    properties: {
-                        name: { type: 'string' },
-                        url: { type: 'string' },
-                    },
-                },
-                author: {
-                    type: 'object',
-                    required: ['name', 'url'],
-                    properties: {
-                        name: { type: 'string' },
-                        url: { type: 'string' },
-                    },
-                },
-                owner: {
-                    type: 'object',
-                    required: ['name', 'url'],
-                    properties: {
-                        name: { type: 'string' },
-                        url: { type: 'string' },
-                    },
-                },
-                contributors: {
-                    type: 'array',
-                    items: {
-                        oneOf: [
-                            {
-                                type: 'object',
-                                required: ['name', 'url'],
-                                properties: {
-                                    name: { type: 'string' },
-                                    url: { type: 'string' },
-                                },
-                            },
-                        ],
-                    },
-                },
-                website: {
-                    type: 'object',
-                    required: ['name', 'url'],
-                    properties: {
-                        name: { type: 'string' },
-                        url: { type: 'string' },
-                    },
-                },
-                sponsorLink: {
-                    type: 'object',
-                    required: ['name', 'url', 'logo'],
-                    properties: {
-                        name: { type: 'string' },
-                        url: { type: 'string' },
-                        logo: { type: 'string' },
-                    },
-                },
-                backlink: {
-                    type: 'object',
-                    required: ['name', 'url'],
-                    properties: {
-                        name: { type: 'string' },
-                        url: { type: 'string' },
-                    },
-                },
-                module: { type: 'string' },
-                id: { type: 'string' },
-                summary: { type: 'string' },
-                marking: { type: 'string' },
-                legalese: { type: 'string' },
-            },
-        },
-        contents: {
-            title: 'DocGen Table of Contents Schema',
-            type: 'array',
-            items: {
-                oneOf: [
-                    {
-                        type: 'object',
-                        required: ['heading', 'column', 'pages'],
-                        properties: {
-                            name: { type: 'string' },
-                            column: { type: 'integer', minimum: 1, maximum: 4 },
-                            pages: {
-                                type: 'array',
-                                items: {
-                                    oneOf: [
-                                        {
-                                            type: 'object',
-                                            required: ['title', 'source'],
-                                            properties: {
-                                                title: { type: 'string' },
-                                                source: { type: 'string' },
-                                                html: { type: 'boolean' },
-                                            },
-                                        },
-                                    ],
-                                },
-                            },
-                        },
-                    },
-                ],
-            },
-        },
-    };
-    var validateJSON = function (key, data) {
-        var schema = schemas[key];
-        var validator = new z_schema_1.default();
-        var valid = validator.validate(data, schema);
-        if (!valid) {
-            console.log(chalk_1.default.red('Error parsing required file: ' +
-                key +
-                '.json (failed schema validation)'));
-            if (options.verbose === true) {
-                console.log(chalk_1.default.red(validator.getLastError()));
-            }
-        }
-        return valid;
-    };
-    /*
-      load all metadata files (JSON)
-    */
-    var loadMeta = function () { return __awaiter(_this, void 0, void 0, function () {
-        var files;
-        var _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    console.log(chalk_1.default.green('Loading required JSON metadata files'));
-                    _a = {};
-                    return [4 /*yield*/, (0, fs_1.readFile)(options.input + '/parameters.json')];
-                case 1:
-                    _a.parameters = _b.sent();
-                    return [4 /*yield*/, (0, fs_1.readFile)(options.input + '/contents.json')];
-                case 2:
-                    files = (_a.contents = _b.sent(),
-                        _a);
-                    rsvp_1.default
-                        .hash(files)
-                        .then(function (files) {
-                        for (var key in files) {
-                            if (files.hasOwnProperty(key)) {
-                                //ignore prototype
-                                try {
-                                    var file = JSON.parse(files[key]);
-                                    if (validateJSON(key, file)) {
-                                        meta[key] = file;
-                                    }
-                                    else {
-                                        mainProcess.exit(1);
-                                    }
-                                }
-                                catch (error) {
-                                    console.log(chalk_1.default.red('Error parsing required file: ' +
-                                        key +
-                                        '.json (invalid JSON)'));
-                                    if (options.verbose === true) {
-                                        console.log(chalk_1.default.red(error));
-                                    }
-                                    mainProcess.exit(1);
-                                }
-                            }
-                        }
-                        //add the release notes to the contents list
-                        var extra = {
-                            heading: 'Extra',
-                            column: 5,
-                            pages: [{ title: 'Release notes', source: 'release-notes.md' }],
-                        };
-                        meta.contents.push(extra);
-                        loadMarkdown();
-                    })
-                        .catch(function (error) {
-                        console.log(chalk_1.default.red('Error loading required JSON metadata files'));
-                        if (options.verbose === true) {
-                            console.log(chalk_1.default.red(error));
-                        }
-                        mainProcess.exit(1);
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-    /*
-      load all markdown files (src)
-    */
-    var loadMarkdown = function () {
-        console.log(chalk_1.default.green('Loading src files'));
-        var keys = [];
-        var files = [];
-        meta.contents.forEach(function (section) {
-            section.pages.forEach(function (page) {
-                keys.push(page);
-                files.push(options.input + '/' + page.source);
-            });
-        });
-        //add the release notes page
-        keys.push('ownership');
-        files.push(options.input + '/release-notes.md');
-        rsvp_1.default
-            .all(files.map(fs_1.readFile))
-            .then(function (files) {
-            files.forEach(function (page, index) {
-                try {
-                    var key = keys[index];
-                    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: ' + file.source));
-                    if (options.verbose === true) {
-                        console.log(chalk_1.default.red(error));
-                    }
-                    mainProcess.exit(1);
-                }
-            });
-            processContent();
-        })
-            .catch(function (error) {
-            console.log(error);
-            console.log(chalk_1.default.red('Error loading src files'));
-            if (options.verbose === true) {
-                console.log(chalk_1.default.red(error));
-            }
-            mainProcess.exit(1);
-        });
-    };
-    var sortPages = function () {
-        //sort the contents by heading
-        var headings = { 1: [], 2: [], 3: [], 4: [], 5: [] };
-        meta.contents.forEach(function (section) {
-            if (headings.hasOwnProperty(section.column)) {
-                headings[section.column].push(section);
-            }
-        });
-        sortedPages = headings;
-    };
-    /*
-      build the HTML for the table of contents
-    */
-    var webToc = function () {
-        sortPages();
-        var pdfName = meta.parameters.name.toLowerCase() + '.pdf';
-        var $ = templates.main;
-        var html = [], i = -1;
-        html[++i] = '<div><table class="unstyled"><tr>';
-        //build the contents HTML
-        for (var key in sortedPages) {
-            if (sortedPages.hasOwnProperty(key)) {
-                if (key != 5) {
-                    //skip the extra column
-                    html[++i] = '<td class="dg-tocGroup">';
-                    sortedPages[key].forEach(function (section) {
-                        html[++i] =
-                            '<ul><li class="dg-tocHeading">' + section.heading + '</li>';
-                        section.pages.forEach(function (page) {
-                            var name = page.source.substr(0, page.source.lastIndexOf('.'));
-                            var path = name + '.html';
-                            html[++i] =
-                                '<li><a href="' + path + '">' + page.title + '</a></li>';
-                        });
-                        html[++i] = '</li></ul>';
-                    });
-                    html[++i] = '</td>';
-                }
-            }
-        }
-        //fixed-width column at end
-        html[++i] = '<td class="dg-tocGroup" id="dg-tocFixedColumn"><ul>';
-        html[++i] =
-            '<li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li>';
-        html[++i] =
-            '<li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li>';
-        html[++i] = '</ul><div>';
-        if (options.pdf) {
-            html[++i] =
-                '<button class="whiteInverted" onclick="window.location=\'' +
-                    pdfName +
-                    '\';">';
-            html[++i] = '<span>PDF</span>';
-            html[++i] = '</button>';
-        }
-        html[++i] = '</div></td>';
-        html[++i] = '</tr></table></div>';
-        $('#dg-toc').html(html.join(''));
-        templates.main = $;
-    };
-    /*
-      insert the parameters into all templates
-    */
-    var insertParameters = function () {
-        //------------------------------------------------------------------------------------------------------
-        //logo dimensions
-        var hasLogo = false;
-        var logoWidth = 0;
-        var logoHeight = 0;
-        var logoPath;
-        try {
-            logoPath = 'files/images/logo.svg';
-            var logo = (0, image_size_1.default)("".concat(options.input, "/").concat(logoPath));
-            logoWidth = logo.width;
-            logoHeight = logo.height;
-            hasLogo = true;
-        }
-        catch (error) {
-            //do nothing. If logo file cannot be read, logo is simply not shown
-        }
-        if (!hasLogo) {
-            //PNG fallback
-            try {
-                logoPath = 'files/images/logo.png';
-                var logo = (0, image_size_1.default)("".concat(options.input, "/").concat(logoPath));
-                logoWidth = logo.width;
-                logoHeight = logo.height;
-                hasLogo = true;
-            }
-            catch (error) {
-                //do nothing. If logo file cannot be read, logo is simply not shown
-            }
-        }
-        //------------------------------------------------------------------------------------------------------
-        //the homepage is the first link in the first heading
-        var homelink = meta.contents[0].pages[0];
-        homelink =
-            homelink.source.substr(0, homelink.source.lastIndexOf('.')) + '.html';
-        var date = (0, moment_1.default)().format('DD/MM/YYYY');
-        var time = (0, moment_1.default)().format('HH:mm:ss');
-        var year = (0, moment_1.default)().format('YYYY');
-        var attribution = 'Created by DocGen ' + package_json_1.version + ' on ' + date + ' at ' + time + '.';
-        var releaseVersion = meta.parameters.version;
-        if (options.setVersion !== false) {
-            releaseVersion = options.setVersion;
-        }
-        var releaseDate = meta.parameters.date;
-        if (options.setReleaseDate !== false) {
-            releaseDate = options.setReleaseDate;
-        }
-        var author = '';
-        if (meta.parameters.author.url !== '') {
-            author +=
-                '<a href="' +
-                    meta.parameters.author.url +
-                    '">' +
-                    meta.parameters.author.name +
-                    '</a>';
-        }
-        else {
-            author += meta.parameters.author.name;
-        }
-        var owner = '';
-        if (meta.parameters.owner.url !== '') {
-            owner +=
-                '<a href="' +
-                    meta.parameters.owner.url +
-                    '">' +
-                    meta.parameters.owner.name +
-                    '</a>';
-        }
-        else {
-            owner += meta.parameters.owner.name;
-        }
-        var organization = '';
-        if (meta.parameters.organization.url !== '') {
-            organization +=
-                '<a href="' +
-                    meta.parameters.organization.url +
-                    '">' +
-                    meta.parameters.organization.name +
-                    '</a>';
-        }
-        else {
-            organization += meta.parameters.organization.name;
-        }
-        var website = '';
-        if (meta.parameters.website.url !== '') {
-            website +=
-                '<a href="' +
-                    meta.parameters.website.url +
-                    '">' +
-                    meta.parameters.website.name +
-                    '</a>';
-        }
-        else {
-            website += meta.parameters.website.name;
-        }
-        var backlink = '';
-        if (meta.parameters.backlink.url !== '') {
-            backlink +=
-                '<a class="button inverted" href="' +
-                    meta.parameters.backlink.url +
-                    '">' +
-                    meta.parameters.backlink.name +
-                    '</a>';
-        }
-        else {
-            backlink += meta.parameters.backlink.name;
-        }
-        var sponsorLink = '';
-        if (meta.parameters.sponsorLink) {
-            sponsorLink = "\n        <div id=\"headerSponsor\">\n          <span>".concat(meta.parameters.sponsorLink.name, "</span>\n            <a href=\"").concat(meta.parameters.sponsorLink.url, "\">\n             <img id=\"sponsorLogo\" src=\"").concat(meta.parameters.sponsorLink.logo, "\" alt=\"sponsor logo\">\n            </a>\n        </div>\n      ");
-        }
-        var contributors = '';
-        meta.parameters.contributors.forEach(function (contributor) {
-            if (contributor.url !== '') {
-                contributors +=
-                    '<a href="' + contributor.url + '">' + contributor.name + '</a>, ';
-            }
-            else {
-                contributors += contributor.name + ', ';
-            }
-        });
-        contributors = contributors.replace(/,\s*$/, ''); //remove trailing commas
-        var copyright = '&copy; ' + year + ' ' + organization;
-        var webTitle = meta.parameters.title;
-        var webFooter = 'Version ' + releaseVersion + ' released on ' + releaseDate + '.';
-        for (var key in templates) {
-            if (templates.hasOwnProperty(key)) {
-                var $ = templates[key];
-                //logo
-                if (hasLogo === true) {
-                    var logoUrl = logoPath;
-                    $('#dg-logo').css('background-image', 'url(' + logoUrl + ')');
-                    $('#dg-logo').css('height', logoHeight + 'px');
-                    $('#dg-logo').css('padding-left', logoWidth + 25 + 'px');
-                }
-                else {
-                    $('#dg-logo').css('padding-left', '0');
-                }
-                //parameters
-                $('title').text(meta.parameters.title);
-                $('.dg-homelink').attr('href', homelink);
-                $('#dg-title').text(meta.parameters.title);
-                $('#dg-owner').html(owner);
-                $('#dg-version').text(releaseVersion);
-                $('#dg-web-title-version').text('(' + releaseVersion + ')');
-                $('#dg-release-date').text(releaseDate);
-                $('#dg-web-footer').text(webFooter);
-                $('#dg-author').html(author);
-                $('#dg-contributors').html(contributors);
-                $('#dg-module').text(meta.parameters.module);
-                $('#dg-id').html(meta.parameters.id);
-                $('#dg-website').html(website);
-                $('#dg-backlink').html(backlink);
-                $('#headerLeftText').append(sponsorLink);
-                $('#dg-summary').text(meta.parameters.summary);
-                $('#dg-copyright').html(copyright);
-                $('#dg-marking').text(meta.parameters.marking);
-                $('#dg-legalese').text(meta.parameters.legalese);
-                $('#dg-attribution').text(attribution);
-            }
-        }
-        if (options.mathKatex === true) {
-            var $ = templates.main;
-            //support for KaTeX (bundled with DocGen)
-            $('head').append('<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css">');
-            $('head').append('<script type="text/javascript" src="require/katex/katex.min.js"></script>');
-            $('head').append('<script type="text/javascript" src="require/katexInjector.js"></script>');
-        }
-        if (options.mathMathjax === true) {
-            //support for MathJax (only supported via CDN due to very large size)
-            //MathJax configuration is the same as used by math.stackexchange.com
-            //Note - wkhtmlpdf //cdn urls - see https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1634
-            //Note - later than version 2 doesn't work with wkhtmltodpf
-            $('head').append("<script type=\"text/javascript\" id=\"MathJax-script\" async\n          src=\"https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML\">\n        </script>");
-        }
-    };
-    /*
-      process each input into an output
-    */
-    var processContent = function () {
-        console.log(chalk_1.default.green('Generating the static web content'));
-        webToc();
-        insertParameters();
-        meta.contents.forEach(function (section) {
-            section.pages.forEach(function (page) {
-                var $ = cheerio_1.default.load(templates.main.html()); //clone
-                var key = page.source;
-                var content = pages[key];
-                //add relevant container
-                if (page.html === true) {
-                    //raw HTML pages should not be confined to the fixed width
-                    $('#dg-content').html('<div id="dg-innerContent"></div>');
-                }
-                else {
-                    //Markdown pages should be confined to the fixed width
-                    $('#dg-content').html('<div class="w-fixed-width"><div id="dg-innerContent"></div></div>');
-                }
-                $('#dg-innerContent').html(content);
-                //------------------------------------------------------------------------------------------------------
-                //insert permalinks for every page heading
-                //when pageToc is enabled, also insert a page-level table of contents
-                var html = [], i = -1;
-                var headings = $('h1, h2, h3, h4, h5, h6');
-                if (headings.length > 0) {
-                    html[++i] = '<ul class="dg-pageToc">';
-                }
-                headings.each(function () {
-                    var label = $(this).text();
-                    var anchor = label.toLowerCase().replace(/\s+/g, '-');
-                    $(this).attr('id', anchor);
-                    html[++i] = '<li><a href="#' + anchor + '">' + label + '</a></li>';
-                });
-                if (headings.length > 0) {
-                    html[++i] = '</ul>';
-                }
-                if (options.pageToc === true && page.html !== true) {
-                    $('#dg-innerContent').prepend(html.join(''));
-                }
-                //------------------------------------------------------------------------------------------------------
-                //prepend the auto heading (which makes the PDF table of contents match the web TOC)
-                $('#dg-innerContent').prepend('<h1 id="dg-autoTitle">' + page.title + '</h1>');
-                if (page.html === true) {
-                    $('#dg-autoTitle').addClass('dg-hiddenTitle');
-                }
-                //------------------------------------------------------------------------------------------------------
-                //apply the w-table class
-                $('table:not(.unstyled)').addClass('w-table w-fixed w-stripe');
-                //------------------------------------------------------------------------------------------------------
-                pages[key] = $;
-            });
-        });
-        //add web ownership page
-        var $ = cheerio_1.default.load(templates.main.html()); //clone
-        $('#dg-content').html('<div class="w-fixed-width"><div id="dg-innerContent"></div></div>');
-        $('#dg-innerContent').html(templates.webCover.html());
-        templates.webCover = $;
-        writePages();
-    };
-    /*
-      write each html page
-    */
-    var writePages = function () { return __awaiter(_this, void 0, void 0, function () {
-        var promises, pdfTempDir;
-        var _this = this;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    console.log(chalk_1.default.green('Writing the web page files'));
-                    promises = {};
-                    meta.contents.forEach(function (section) {
-                        section.pages.forEach(function (page) {
-                            var key = page.source;
-                            var name = key.substr(0, page.source.lastIndexOf('.'));
-                            var path = options.output + name + '.html';
-                            var html = pages[key].html();
-                            promises[key] = (0, fs_1.writeFile)(path, html);
-                        });
-                    });
-                    //add extra files
-                    promises['ownership'] = (0, fs_1.writeFile)(options.output + 'ownership.html', templates.webCover.html());
-                    if (!(options.pdf === true)) return [3 /*break*/, 2];
-                    pdfTempDir = options.output + 'temp/';
-                    return [4 /*yield*/, (0, fs_1.makeDirectory)(pdfTempDir)];
-                case 1:
-                    _a.sent();
-                    promises['docgenPdfCover'] = (0, fs_1.writeFile)(pdfTempDir + 'pdfCover.html', templates.pdfCover.html());
-                    promises['docgenPdfHeader'] = (0, fs_1.writeFile)(pdfTempDir + 'pdfHeader.html', templates.pdfHeader.html());
-                    promises['docgenPdfFooter'] = (0, fs_1.writeFile)(pdfTempDir + 'pdfFooter.html', templates.pdfFooter.html());
-                    _a.label = 2;
-                case 2:
-                    rsvp_1.default
-                        .hash(promises)
-                        .then(function () { return __awaiter(_this, void 0, void 0, function () {
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0: return [4 /*yield*/, (0, fs_1.copyDirectory)(__dirname + '/../include/require', options.output + 'require', options.verbose === true)];
-                                case 1:
-                                    _a.sent(); //CSS, JavaScript
-                                    return [4 /*yield*/, (0, fs_1.copyDirectory)(options.input + '/files', options.output + 'files', options.verbose === true)];
-                                case 2:
-                                    _a.sent(); //user-attached files and images
-                                    if (!(options.mathKatex === true)) return [3 /*break*/, 4];
-                                    return [4 /*yield*/, (0, fs_1.copyDirectory)(__dirname + '/../include/optional/katex', options.output + 'require/katex', options.verbose === true)];
-                                case 3:
-                                    _a.sent();
-                                    _a.label = 4;
-                                case 4:
-                                    checkPdfVersion();
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); })
-                        .catch(function (error) {
-                        console.log(chalk_1.default.red('Error writing the web page files'));
-                        if (options.verbose === true) {
-                            console.log(chalk_1.default.red(error));
-                        }
-                        mainProcess.exit(1);
-                    });
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-    /*
-      wkthmltopdf options
-    */
-    var pdfOptions = [
-        ' --zoom 1.0',
-        ' --image-quality 100',
-        ' --print-media-type',
-        ' --orientation portrait',
-        ' --page-size A4',
-        ' --margin-top 25',
-        ' --margin-right 15',
-        ' --margin-bottom 16',
-        ' --margin-left 15',
-        ' --header-spacing 5',
-        ' --footer-spacing 5',
-        ' --no-stop-slow-scripts',
-    ];
-    var getPdfArguments = function () {
-        var pdfName = meta.parameters.name.toLowerCase() + '.pdf';
-        pdfOptions.push(' --enable-local-file-access');
-        pdfOptions.push(' --javascript-delay ' + options.pdfDelay); //code syntax highlight in wkhtmltopdf 0.12.2.1 fails without a delay (but why doesn't --no-stop-slow-scripts work?)
-        pdfOptions.push(' --user-style-sheet ' + __dirname + '/../include/pdf-stylesheet.css');
-        pdfOptions.push(' --header-html ' + options.output + 'temp/pdfHeader.html');
-        pdfOptions.push(' --footer-html ' + options.output + 'temp/pdfFooter.html');
-        pdfOptions.push(' cover ' + options.output + 'temp/pdfCover.html');
-        pdfOptions.push(' toc --xsl-style-sheet ' + __dirname + '/../include/pdf-contents.xsl');
-        var allPages = '';
-        for (var key in sortedPages) {
-            if (sortedPages.hasOwnProperty(key)) {
-                sortedPages[key].forEach(function (section) {
-                    section.pages.forEach(function (page) {
-                        var key = page.source;
-                        var name = key.substr(0, page.source.lastIndexOf('.'));
-                        var path = options.output + name + '.html';
-                        allPages += ' ' + path;
-                    });
-                });
-            }
-        }
-        var args = pdfOptions.join('');
-        args += allPages;
-        args += ' ' + options.output + pdfName;
-        return (0, spawn_args_1.default)(args);
-    };
-    var checkPdfVersion = function () {
-        if (options.pdf === true) {
-            //first check that wkhtmltopdf is installed
-            (0, child_process_1.exec)(options.wkhtmltopdfPath + ' -V', function (error, stdout, stderr) {
-                if (error) {
-                    console.log(chalk_1.default.red('Unable to call wkhtmltopdf. Is it installed and in path? See http://wkhtmltopdf.org'));
-                    if (options.verbose === true) {
-                        console.log(chalk_1.default.red(error));
-                    }
-                    mainProcess.exit(1);
-                }
-                else {
-                    //warn if the version of wkhtmltopdf is not an expected version
-                    var actualWkhtmltopdfVersion = stdout.trim();
-                    if (actualWkhtmltopdfVersion !== wkhtmltopdfVersion) {
-                        var warning = 'Warning: unexpected version of wkhtmltopdf, which may work but is not tested or supported';
-                        var expectedVersion = '   expected version: ' + wkhtmltopdfVersion;
-                        var detectedVersion = '   detected version: ' + actualWkhtmltopdfVersion;
-                        console.log(chalk_1.default.yellow(warning));
-                        console.log(chalk_1.default.yellow(expectedVersion));
-                        console.log(chalk_1.default.yellow(detectedVersion));
-                    }
-                    generatePdf();
-                }
-            });
-        }
-        else {
-            cleanUp();
-        }
-    };
-    /*
-      call wkhtmltopdf as an external executable
-    */
-    var generatePdf = function () {
-        console.log(chalk_1.default.green('Creating the PDF copy (may take some time)'));
-        var args = getPdfArguments();
-        var wkhtmltopdf = (0, child_process_1.spawn)(options.wkhtmltopdfPath, args);
-        var spinner = new cli_spinner_1.Spinner(chalk_1.default.green('   Processing... %s'));
-        spinner.setSpinnerString('|/-\\');
-        wkhtmltopdf.on('error', function (error) {
-            console.log(chalk_1.default.red('Error calling wkhtmltopdf to generate the PDF'));
-            if (options.verbose === true) {
-                console.log(chalk_1.default.red(error));
-            }
-        });
-        if (options.verbose !== true) {
-            spinner.start(); //only show spinner when verbose is off (otherwise show raw wkhtmltopdf output)
-        }
-        else {
-            //pipe the output from wkhtmltopdf back to stdout
-            //however, wkhtmltpdf outputs to stderr, not stdout. See:
-            //https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1980
-            wkhtmltopdf.stderr.pipe(mainProcess.stdout);
-        }
-        wkhtmltopdf.stdout.on('data', function (data) {
-            //do nothing
-        });
-        wkhtmltopdf.stderr.on('data', function (data) {
-            //do nothing
-        });
-        wkhtmltopdf.on('close', function (code) {
-            if (options.verbose !== true) {
-                spinner.stop();
-                console.log(''); //newline after spinner stops
-            }
-            if (code !== 0) {
-                var warning = 'wkhtmltopdf exited with a warning or error: try the -v option for details';
-                console.log(chalk_1.default.yellow(warning));
-            }
-            cleanUp();
-        });
-    };
-    var createRedirect = function () { return __awaiter(_this, void 0, void 0, function () {
-        var parent_1, homepage, redirectLink, $, file, error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    if (!options.redirect) return [3 /*break*/, 4];
-                    parent_1 = options.output.replace(/\/$/, '');
-                    parent_1 = parent_1.split(path_1.default.sep).slice(-1).pop(); //get name of final directory in the path
-                    homepage = meta.contents[0].pages[0];
-                    homepage =
-                        homepage.source.substr(0, homepage.source.lastIndexOf('.')) + '.html';
-                    redirectLink = parent_1 + '/' + homepage;
-                    $ = templates.redirect;
-                    $('a').attr('href', redirectLink);
-                    $('meta[http-equiv=REFRESH]').attr('content', '0;url=' + redirectLink);
-                    file = options.output + '../' + 'index.html';
-                    _a.label = 1;
-                case 1:
-                    _a.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, (0, fs_1.writeFile)(file, $.html())];
-                case 2:
-                    _a.sent();
-                    return [3 /*break*/, 4];
-                case 3:
-                    error_1 = _a.sent();
-                    console.log(chalk_1.default.red('Error writing redirect file: ' + file));
-                    if (options.verbose === true) {
-                        console.log(chalk_1.default.red(error_1));
-                    }
-                    return [3 /*break*/, 4];
-                case 4: return [2 /*return*/];
-            }
-        });
-    }); };
-    /*
-      cleanup
-    */
-    var cleanUp = function () { return __awaiter(_this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    createRedirect();
-                    if (!(options.pdf === true)) return [3 /*break*/, 2];
-                    return [4 /*yield*/, (0, fs_1.removeDirectory)(options.output + 'temp')];
-                case 1:
-                    _a.sent();
-                    _a.label = 2;
-                case 2:
-                    console.log(chalk_1.default.green.bold('Done!'));
-                    return [2 /*return*/];
-            }
-        });
-    }); };
-}
-exports.DocGen = DocGen;