123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
import * as denoDoc from "https://deno.land/x/deno_doc@0.51.0/lib/types.d.ts";
export interface Config{    /**     * Show the line and column where the declaration of the item can be found. Default: true.     */    displayOrigin?: boolean;
    /**     * Additional info to add to the beginning or end of the markdown file.     */    additionalInfo?: {        /**         * Content to be displayed. Markdown works.         */        content?: string;
        /**         * Where to place the content, at the start or end of the file. Default: start.         */        placement?: "start" | "end";
        /**         * What to display as the title for the additional information. Default: "Additional Information".         */        title?: string    }
    /**     * Default language for code blocks. If not provided, then it will be the language of the file being documented. Default: File Extension.     */    defaultLanguage?: string;
    /**     * Whether to automatically harden new lines or not.     */    hardenNewlines?: boolean;}
/** * Returns a parsed version of the json object returned by `deno doc --json` * @param input File to document. * @returns {Promise<denoDoc.DocNode[]>} * @example * const json = await MarkDeno.getDocumentationJSON("file.ts"); */export async function getDocumentationJSON(input: string): Promise<denoDoc.DocNode[]>{    const p = Deno.run({        cmd: ["deno","doc","--json",input],        stdout: "piped"    });
    const cmdout = new TextDecoder().decode(await p.output());
    return JSON.parse(cmdout);}
/** * Returns an unparsed version of the json object returned by `deno doc --json` * @param input File to document. * @example * const json = await MarkDeno.getDocumentationJSONString("file.ts"); */export async function getDocumentationJSONString(input: string){    const p = Deno.run({        cmd: ["deno","doc","--json",input],        stdout: "piped"    });
    return new TextDecoder().decode(await p.output());}
/** * Returns the result of `deno doc` without color. Note that `deno doc` does NOT return markdown. * @param input File to document. * @example * console.log(await MarkDeno.getDenoDocResult("file.ts")); */export async function getDenoDocResult(input: string){    const p = Deno.run({        cmd: ["deno","doc",input],        stdout: "piped"    });
    return (new TextDecoder().decode(await p.output())).replace(/\[[0-9]+(?:;[0-9]+)*?m/g,"");}
/** * Amplifies new lines so that no new lines are ignored. * @param markdown Markdown to amplify new lines in. * @example * Deno.writeFile("output.md",hardenNewlines(`## Amplified Newlines *  * > Amplifies new lines. * > So that **none** of them are ignored. * `)); */export function hardenNewlines(markdown: string){    return markdown.replace(/\n/g,"  \n");}
/** * Analyzes an input file and writes to a specified output file. * @param input Input file to analyze. * @param out Output file to write markdown too. * @param config Optional configurations for the parser. * @example * MarkDeno.writeMarkdown("file.ts","output.md"); */export async function writeMarkdown(input: string,output: string,config?: Config): Promise<void>{    const json = await getDocumentationJSON(input);        const s = input.split(".");        const con = {        displayOrigin: config?.displayOrigin ?? true,        additionalInfo: {            content: config?.additionalInfo?.content || "",            placement: config?.additionalInfo?.placement || "start",            title: config?.additionalInfo?.title || "Additional Info"        },        defaultLanguage: config?.defaultLanguage || s[s.length - 1],        hardenNewlines: config?.hardenNewlines ?? true    }
    function parseJSDOC(tag: denoDoc.JsDocTag){        let res = "";        switch(tag.kind){            case "param": {                res += `\n> @ param ${tag.type ? `{*${tag.type}*} ` : ""}**${tag.name}**${tag.doc !== undefined ? ` *${tag.doc}*` : ""}`;                break;            }
            case "example": {                if(/```.*?\n(?:.|\n)+\n```/g.test(tag.doc!)){                    res += `\n> @ example\n\n${tag.doc}\n\n`;                } else{                    res += `\n> @ example\n\n\`\`\`${con.defaultLanguage}\n${tag.doc}\n\`\`\`\n`                }                break;            }
            case "return": {                res += `\n> @ returns ${tag.type ? `{*${tag.type}*}` : ""}${tag.doc ? ` *${tag.doc}*` : ""}`;                break;            }
            default: {                res += `\n> @ ${tag.kind}`;            }        }        return res;    }
    function parseParam(param: denoDoc.ParamDef){        let res = "";        switch(param.kind){            case "identifier": {                res += `**${param.name ? param.name : param.kind}**${param.optional ? "?" : ""}: *${param.tsType !== null ? param.tsType!.repr : "any"}*`                break;            }
            case "assign": {                res += parseParam(param.left);                break;            }
            case "array": {                res += "[";                let inc = 0;                for(const elem of param.elements){                    inc++;                    res += parseParam(elem!);                    if(param.elements.length !== inc) res += ", ";                }                res += "]";                break;            }
            case "object": {                res += "{";                let inc = 0;                for(const elem of param.props){                    inc++;                    res += elem.kind === "keyValue" ? elem.key : "";                    if(param.props.length !== inc) res += ", ";                }                res += "}";            }        }        return res;    }
    let code = "# Documentation\n\n";    let increment = 0;    for(const i of json){                increment++;        switch(i.kind){            case "function": {                if("jsDoc" in i && "tags" in i.jsDoc! && i.jsDoc.tags!.map((v) => v.kind).includes("deprecated")) code += `${i.declarationKind} ${i.functionDef.isAsync ? "async" : ""}function ~~${i.name}~~(`;                else code += `${i.functionDef.isAsync ? "async " : ""}function **${i.name}**(`;
                let inc = 0;                for(const param of i.functionDef.params){                    inc++;                    code += parseParam(param);                    if(i.functionDef.params.length !== inc) code += ",";                }
                code += ")";                if("jsDoc" in i && "doc" in i.jsDoc!) code += "\n\n" + i.jsDoc.doc;                                if("jsDoc" in i && "tags" in i.jsDoc! && i.jsDoc.tags!.length > 0){                    for(const tag of i.jsDoc.tags!){                        code += parseJSDOC(tag);                    }                }                break;            }
            case "interface": {                code += `interface **${i.name}**`;
                let inc = 0;                for(const ex of i.interfaceDef.extends){                    inc++;                    if(inc === 1) code += " extends ";                    code += ex.repr;                    if(i.interfaceDef.extends.length !== inc) code += ",";                }
                code += "\n\n";
                inc = 0;                for(const method of i.interfaceDef.methods){                    inc++;                    code += "- ";                    if(method.kind === "getter") code += "*get*";                    else if(method.kind === "setter") code += "*set*";
                    code += ` **${method.name}**(`;                                        inc = 0;                    for(const param of method.params){                        inc++;                        code += parseParam(param);                        if(method.params.length !== inc) code += ",";                    }
                    code += ")";
                    if("jsDoc" in method && "doc" in method.jsDoc!) code += "\n\n    " + method.jsDoc.doc;                                    if("jsDoc" in method && "tags" in method.jsDoc! && method.jsDoc.tags!.length > 0){                        for(const tag of method.jsDoc.tags!){                            code += parseJSDOC(tag);                        }                    }
                    if(con.displayOrigin) code += `\n\n    Declared at: \`${input}:${i.location.line}:${i.location.col}\`\n`;                    if(i.interfaceDef.methods.length + i.interfaceDef.properties.length !== inc) code += "\n";                }
                for(const property of i.interfaceDef.properties){                    inc++;                    code += `- **${property.name}**: *${property.tsType?.repr || property.tsType?.kind}*`;
                    if("jsDoc" in property && "doc" in property.jsDoc!) code += "\n\n    " + property.jsDoc.doc;                                    if("jsDoc" in property && "tags" in property.jsDoc! && property.jsDoc.tags!.length > 0){                        for(const tag of property.jsDoc.tags!){                            code += parseJSDOC(tag);                        }                    }
                    if(con.displayOrigin) code += `\n\n    Declared at: \`${input}:${i.location.line}:${i.location.col}\`\n`;                    if(i.interfaceDef.methods.length + i.interfaceDef.properties.length !== inc) code += "\n";                }
                break;            }
            case "variable": {                code += `${i.variableDef.kind} **${i.name}**: *${i.variableDef.tsType?.repr}*`                            if("jsDoc" in i && "doc" in i.jsDoc!) code += "\n\n" + i.jsDoc.doc;                                if("jsDoc" in i && "tags" in i.jsDoc! && i.jsDoc.tags!.length > 0){                    for(const tag of i.jsDoc.tags!){                        code += parseJSDOC(tag);                    }                }                break;            }
            case "import": {                code += `import [**${i.importDef.src}**](${i.importDef.src})`;            }        }
        if(con.displayOrigin) code += `\nDeclared at: \`${input}:${i.location.line}:${i.location.col}\`\n`;        if(json.length !== increment) code += "\n";    }
    if(con.additionalInfo.content){        if(con.additionalInfo.placement === "start") code = `${"# " + con.additionalInfo.title}\n\n${con.additionalInfo.content}\n\n${code}`;        else code += `\n\n${"## " + con.additionalInfo.title}\n\n${con.additionalInfo.content}`;    }
    code += "\n> **Documentation Generated with [MarkDeno](https://deno.land/x/markdeno).**"
    Deno.writeFile(output,new TextEncoder().encode(        con.hardenNewlines            ? hardenNewlines(code + "\n")            : code + "\n"    ));}