solidity-docgen/dist/page.js

Solidity API documentation automatic generator.

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
    result["default"] = mod;
    return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const path_1 = __importDefault(require("path"));
const handlebars = __importStar(require("./handlebars"));
const lodash_1 = require("lodash");
class Page {
    constructor(sitemap) {
        this.sitemap = sitemap;
    }
    render(preludeTemplate) {
        const links = this.sitemap.links(this);
        const prelude = preludeTemplate({ links });
        return addPrelude(this.contents, prelude);
    }
}
exports.Page = Page;
class DefaultPage extends Page {
    constructor(sitemap, ext, contracts) {
        super(sitemap);
        this.ext = ext;
        this.contracts = contracts;
    }
    get contents() {
        return this.contracts.map(c => c.toString()).join('\n\n');
    }
    get path() {
        return path_1.default.format({
            name: 'index',
            ext: '.' + this.ext,
        });
    }
}
exports.DefaultPage = DefaultPage;
class ReadmePage extends Page {
    constructor(sitemap, readme, contracts) {
        super(sitemap);
        this.readme = readme;
        this.contracts = contracts;
        lodash_1.defaults(this, lodash_1.keyBy(this.contracts, c => c.name));
    }
    get contents() {
        return this.template(this);
    }
    get template() {
        return handlebars.compile(this.readme.contents);
    }
    get location() {
        return path_1.default.dirname(this.readme.path);
    }
    get path() {
        const { dir, ext } = path_1.default.parse(this.readme.path);
        return path_1.default.normalize(path_1.default.format({
            dir: path_1.default.dirname(dir),
            name: path_1.default.basename(dir) || 'index',
            ext,
        }));
    }
}
exports.ReadmePage = ReadmePage;
class ContractPage extends Page {
    constructor(sitemap, contract, ext) {
        super(sitemap);
        this.contract = contract;
        this.ext = ext;
    }
    get contents() {
        return this.contract.toString();
    }
    get contracts() {
        return [this.contract];
    }
    get path() {
        const { dir, name } = path_1.default.parse(this.contract.file.path);
        return path_1.default.format({ dir, name, ext: '.' + this.ext });
    }
}
exports.ContractPage = ContractPage;
function addPrelude(contents, prelude) {
    const preludeRegex = /^(---\n([^]*?\n)?---\n)?/;
    return contents.replace(preludeRegex, (_, frontmatter) => frontmatter ? frontmatter + prelude : prelude);
}
//# sourceMappingURL=page.js.map