typedoc/dist/lib/output/renderer.js

"use strict";
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
    return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var Renderer_1;
Object.defineProperty(exports, "__esModule", { value: true });
const Path = require("path");
const FS = require("fs-extra");
const ProgressBar = require('progress');
const events_1 = require("./events");
const fs_1 = require("../utils/fs");
const DefaultTheme_1 = require("./themes/DefaultTheme");
const components_1 = require("./components");
const component_1 = require("../utils/component");
const utils_1 = require("../utils");
let Renderer = Renderer_1 = class Renderer extends component_1.ChildableComponent {
    initialize() {
    }
    render(project, outputDirectory) {
        if (!this.prepareTheme() || !this.prepareOutputDirectory(outputDirectory)) {
            return;
        }
        const output = new events_1.RendererEvent(events_1.RendererEvent.BEGIN, outputDirectory, project);
        output.settings = this.application.options.getRawValues();
        output.urls = this.theme.getUrls(project);
        const bar = new ProgressBar('Rendering [:bar] :percent', {
            total: output.urls.length,
            width: 40
        });
        this.trigger(output);
        if (!output.isDefaultPrevented) {
            output.urls.forEach((mapping) => {
                this.renderDocument(output.createPageEvent(mapping));
                bar.tick();
            });
            this.trigger(events_1.RendererEvent.END, output);
        }
    }
    renderDocument(page) {
        this.trigger(events_1.PageEvent.BEGIN, page);
        if (page.isDefaultPrevented) {
            return false;
        }
        page.template = page.template || this.theme.resources.templates.getResource(page.templateName).getTemplate();
        page.contents = page.template(page, { allowProtoMethodsByDefault: true, allowProtoPropertiesByDefault: true });
        this.trigger(events_1.PageEvent.END, page);
        if (page.isDefaultPrevented) {
            return false;
        }
        try {
            fs_1.writeFile(page.filename, page.contents, false);
        }
        catch (error) {
            this.application.logger.error('Could not write %s', page.filename);
            return false;
        }
        return true;
    }
    prepareTheme() {
        if (!this.theme) {
            const themeName = this.themeName;
            let path = Path.resolve(themeName);
            if (!FS.existsSync(path)) {
                path = Path.join(Renderer_1.getThemeDirectory(), themeName);
                if (!FS.existsSync(path)) {
                    this.application.logger.error('The theme %s could not be found.', themeName);
                    return false;
                }
            }
            const filename = Path.join(path, 'theme.js');
            if (!FS.existsSync(filename)) {
                this.theme = this.addComponent('theme', new DefaultTheme_1.DefaultTheme(this, path));
            }
            else {
                try {
                    const themeClass = typeof require(filename) === 'function' ? require(filename) : require(filename).default;
                    this.theme = this.addComponent('theme', new (themeClass)(this, path));
                }
                catch (err) {
                    throw new Error(`Exception while loading "${filename}". You must export a \`new Theme(renderer, basePath)\` compatible class.\n` +
                        err);
                }
            }
        }
        this.theme.resources.activate();
        return true;
    }
    prepareOutputDirectory(directory) {
        if (FS.existsSync(directory)) {
            if (!FS.statSync(directory).isDirectory()) {
                this.application.logger.error('The output target "%s" exists but it is not a directory.', directory);
                return false;
            }
            if (this.disableOutputCheck) {
                return true;
            }
            if (FS.readdirSync(directory).length === 0) {
                return true;
            }
            if (!this.theme.isOutputDirectory(directory)) {
                this.application.logger.error('The output directory "%s" exists but does not seem to be a documentation generated by TypeDoc.\n' +
                    'Make sure this is the right target directory, delete the folder and rerun TypeDoc.', directory);
                return false;
            }
            try {
                FS.removeSync(directory);
            }
            catch (error) {
                this.application.logger.warn('Could not empty the output directory.');
            }
        }
        if (!FS.existsSync(directory)) {
            try {
                FS.mkdirpSync(directory);
            }
            catch (error) {
                this.application.logger.error('Could not create output directory %s', directory);
                return false;
            }
        }
        return true;
    }
    static getThemeDirectory() {
        return Path.dirname(require.resolve('typedoc-default-themes'));
    }
    static getDefaultTheme() {
        return Path.join(Renderer_1.getThemeDirectory(), 'default');
    }
};
__decorate([
    utils_1.BindOption('theme')
], Renderer.prototype, "themeName", void 0);
__decorate([
    utils_1.BindOption('disableOutputCheck')
], Renderer.prototype, "disableOutputCheck", void 0);
__decorate([
    utils_1.BindOption('gaID')
], Renderer.prototype, "gaID", void 0);
__decorate([
    utils_1.BindOption('gaSite')
], Renderer.prototype, "gaSite", void 0);
__decorate([
    utils_1.BindOption('hideGenerator')
], Renderer.prototype, "hideGenerator", void 0);
__decorate([
    utils_1.BindOption('entryPoint')
], Renderer.prototype, "entryPoint", void 0);
__decorate([
    utils_1.BindOption('toc')
], Renderer.prototype, "toc", void 0);
Renderer = Renderer_1 = __decorate([
    component_1.Component({ name: 'renderer', internal: true, childClass: components_1.RendererComponent })
], Renderer);
exports.Renderer = Renderer;
require("./plugins");
//# sourceMappingURL=renderer.js.map