@solarity/hardhat-markup/dist/src/generator/md-generator/MDGenerator.js

Customizable markdown documentation for smart contracts

import { MDFactory } from "./MDFactory.js";
import { CONTRACT_NAME_H_SIZE, FUNCTION_NAME_H_SIZE, LICENSE_H_SIZE } from "./constants.js";
export class MDGenerator {
    capitalizeFirstLetter(str) {
        return str.charAt(0).toUpperCase() + str.slice(1);
    }
    generateContractMDStr(contractInfo) {
        const mdFactory = new MDFactory();
        mdFactory.addHeaderTag(contractInfo.name, CONTRACT_NAME_H_SIZE);
        mdFactory.addHeaderTag("Overview");
        mdFactory.addHeaderTag(`License: ${contractInfo.license}`, LICENSE_H_SIZE);
        contractInfo.documentations.forEach((blockInfos) => {
            this.generateBlockInfo(mdFactory, blockInfos);
        });
        return mdFactory.getContractTagsStr();
    }
    generateBlockInfo(mdFactory, blockInfos) {
        if (blockInfos.documentation.length === 0)
            return;
        if (blockInfos.blockName.length !== 0) {
            mdFactory.addHeaderTag(blockInfos.blockName);
        }
        blockInfos.documentation.forEach((blockInfo) => {
            this.generateBlock(mdFactory, blockInfo);
        });
        return mdFactory.getContractTagsStr();
    }
    generateBlock(mdFactory, blockInfo) {
        if (blockInfo.header) {
            mdFactory.addHeaderTag(blockInfo.header, FUNCTION_NAME_H_SIZE);
        }
        if (blockInfo.fullSign) {
            mdFactory.addCodeTag([blockInfo.fullSign]);
        }
        if (blockInfo.natSpecDocumentation) {
            this.generateDocumentationBlock(mdFactory, blockInfo.natSpecDocumentation);
        }
    }
    generateDocumentationBlock(mdFactory, documentation) {
        const res = [];
        if (documentation.author) {
            res.push(`Author: ${documentation.author}`);
        }
        if (documentation.title) {
            res.push(documentation.title);
        }
        if (documentation.notice) {
            res.push(documentation.notice);
        }
        if (documentation.dev) {
            res.push(...documentation.dev);
        }
        if (documentation.custom) {
            for (const key of Object.keys(documentation.custom)) {
                res.push(`${key}: ${documentation.custom[key]}`);
            }
        }
        mdFactory.addPlainText(res.join("\n"));
        if (documentation.params) {
            mdFactory.addParagraphTag("Parameters:");
            if (documentation.params.every((param) => param.type === undefined)) {
                this.generateEnumElementsBlock(mdFactory, documentation.params);
            }
            else {
                this.generateElementsBlock(mdFactory, documentation.params);
            }
        }
        if (documentation.returns) {
            mdFactory.addParagraphTag("Return values:");
            this.generateElementsBlock(mdFactory, documentation.returns);
        }
    }
    generateElementsBlock(mdFactory, documentation) {
        const raws = [];
        for (let i = 0; i < documentation.length; i++) {
            const element = documentation[i];
            raws.push([element.name ? element.name : `[${i}]`, element.type || "", element.description]);
        }
        mdFactory.addTableTag(["Name", "Type", "Description"], raws);
    }
    generateEnumElementsBlock(mdFactory, documentation) {
        const raws = [];
        for (let i = 0; i < documentation.length; i++) {
            const element = documentation[i];
            raws.push([element.name ? element.name : `[${i}]`, element.description]);
        }
        mdFactory.addTableTag(["Name", "Description"], raws);
    }
}
//# sourceMappingURL=MDGenerator.js.map