Export an ArchiMate diagram to Markdown format. #jarchi

Export to Markdown.ajs

/*
 * Export View to Markdown
 * 
 * Requires jArchi - https://www.archimatetool.com/blog/2018/07/02/jarchi/
 * 
 * Markdown - https://www.markdownguide.org/
 * 
 * Version 2:   Updated to support Diagram Groups
 * Version 2.1: Add check for Selected View
 * Version 2.2: Change to regex, added date of export
 * Version 2.3: Include notes in documentation
 * Version 3:   Updated to include Relationships
 * Version 3.1: Include name and description
 * Version 3.2: Support repeated elements
 * Version 3.3: Fix for relationships table
 * Version 3.4: Fix for connected notes,
 *              Quotes in documenation,
 *              Embed view (experimental)
 * Version 3.5: Added support for jArchi 4.4 (additional attributes)
 * Version 3.6: Added support for Label Values and fixed issue with CR/LF in tables.
 * Version 3.7: Added support for multiple views to be exported & fix for comments
 * Version 3.8: Added support for specializations, refactored to improve code.
 * Version 3.9: Added support for Index and ViewTypes
 * 
 * (c) 2018 Steven Mileham
 *
 */

const debug = true;
const embed = false;

console.show();
console.clear();
console.log("Export to Markdown");

const theViews = $(selection).filter("archimate-diagram-model");

if (!theViews || theViews.length==0) {
    console.log("> Please Select a View");
}

const multiMode = theViews.length>1;

const theIndexMap = new Map();

theViews.each(function(theView){

    console.log("Exporting View:"+theView);

    theDocument = "";
   
    let markdownContent = generateMarkdown(theView);
    let theFilename = saveMarkdownToFile(theView, markdownContent);

    if (multiMode) {
        theIndexMap.set(theView.name,theFilename);
    }
});

if (multiMode) {
    const theIndex = generateIndex(theIndexMap);
    saveIndexToFile(theIndex);
}

function generateIndex(theIndexMap) {
    theIndexMarkdown = `# ${model.name} Export[^1]\n`;
    theIndexMap.forEach(function (value, key, map) {
        theIndexMarkdown += `* [${escapeMD(key)}](${generateIndexLink(value)})\n`;
    })
    theIndexMarkdown+=`\n[^1]: Generated: ${new Date().toLocaleString()}\n`;
    return theIndexMarkdown;
}

function convertToText(type) {
    return type.replaceAll("-", " ").split(" ").map(word => word.charAt(0).toUpperCase() + word.slice(1)).join(" ").trim();
}

function escapeMD(str) {
    return str.replaceAll("<", "&lt;").replaceAll("\n>", "\n~QUOTE~").substring(0, 1) + str.substring(1).replaceAll(">", "&gt;").replaceAll("~QUOTE~", ">");
}

function generateLink(str) {
    return `#${str.toLowerCase().replace(/[\[\]\(\)\#\\\/\"]/gi, "").replaceAll(" ", "-").replaceAll("\<", "lt").replaceAll("\>", "gt")}`;
}

function generateIndexLink(str) {
    return str.replaceAll(" ","%20");
}

function generateToc(element, depth, tocMap, tocContentWrapper) {
    $(element).children().not("relationship").each(function (e) {
        if (e.name) {
            let headerDepth = "  ".repeat(depth);
            const conceptText = convertToText(`${e.type}`);
            let theHash = generateLink(`${e.name} (${conceptText})`);
            tocMap[theHash] = (tocMap[theHash] || 0) + 1;
            const linkNum = tocMap[theHash] > 1 ? `-${tocMap[theHash]}` : "";
            tocContentWrapper.str += `\n${headerDepth}* [${escapeMD(e.name)} (${conceptText})${linkNum.replace("\-", " ")}](${theHash}${linkNum})`;

            if ($(e).children().not("relationship").length > 0) {
                generateToc(e, depth + 1, tocMap, tocContentWrapper);
            }
        }
    });
}

function generatePropertiesTable(element) {
    const props = element.prop();
    const sortedProperties = [...props].sort();

    let header = "|", line = "|", body = "|";

    if (element.specialization) {
        header += "Specialization|";
        line += "---|";
        body += `${element.specialization}|`;
    }
    for (const prop of sortedProperties) {
        header += `${prop}|`;
        line += "---|";
        body += `${element.prop(prop)}|`;
    }
    return `**Properties**\n\n${header}\n${line}\n${body}\n`;
}


function generateRelationshipsTable(element) {
    let table = "|From|Relationship|To|Name/Label|Description|\n|---|---|---|---|---|\n";
    $(element).outRels().each(function (r) {
        if (r.type !== "diagram-model-connection") {
            let row = `|${r.source.name}|${convertToText(r.type)}`;
            if (r.concept.accessType) row += ` (${r.concept.accessType})`;
            if (r.concept.influenceStrength) row += ` (${r.concept.influenceStrength})`;
            if (r.concept.specialization) row += ` (${r.concept.specialization})`;
            row += `|[${escapeMD(r.target.name)} (${convertToText(r.target.type)})](${generateLink(`${r.target.name} (${convertToText(r.target.type)})`)})|${r.labelValue ? r.labelValue.replaceAll("\\n", " ").replaceAll("\\r", " ") : r.name}|${r.documentation.replaceAll("\n", " ").replaceAll("\r", " ")}|\n`;
            table += row;
        }
    });
    return `**Relationships**\n\n${table}`;
}

function generateNestedDocumentation(element, depth, bodyMap, documentContentWrapper) {
    $(element).children().not("relationship").each(function (e) {
        if (e.name) {
            const headerDepth = "#".repeat(depth + 2);
            const conceptText = convertToText(`${e.type}`);
            let theHash = generateLink(`${e.name} (${conceptText})`);
            bodyMap[theHash] = (bodyMap[theHash] || 0) + 1;
            const linkNum = bodyMap[theHash] > 1 ? ` ${bodyMap[theHash]}` : "";
            documentContentWrapper.str += `\n${headerDepth} ${escapeMD(e.name)} (${conceptText})${linkNum}\n`;

            if (e.prop().length > 0 || e.specialization) {
                documentContentWrapper.str += `\n${escapeMD(generatePropertiesTable(e))}`;
            }
            if ($(e).outRels().length > 0) {
                documentContentWrapper.str += `\n${escapeMD(generateRelationshipsTable(e))}`;
            }
            if (e.documentation) {
                documentContentWrapper.str += `\n${escapeMD(e.documentation)}\n`;
            }
            $(e).rels().ends().each(function (r) {
                if (r.text) {
                    documentContentWrapper.str += `\n> ${escapeMD(r.text).replaceAll("\n", "\n> ")}\n`;
                }
            });

            if ($(e).children().length > 0) {
                generateNestedDocumentation(e, depth + 1, bodyMap, documentContentWrapper);
            }
        }
    });
}

function generateMarkdown(view) {
    let bodyMap = {};
    let documentContentWrapper = {str: `# ${view.name}[^1]\n`};

    // Javascript will pass an object reference!
    let tocContentWrapper = {str:"* [Introduction](#introduction)"};

    //toc(0,theView);

    let tocMap = {};
    generateToc(view,0,tocMap,tocContentWrapper);

    documentContentWrapper.str += `\n${tocContentWrapper.str}\n\n## Introduction\n`;

    if (embed) {
        const bytes = $.model.renderViewAsBase64(view, "PNG", { scale: 2, margin: 10 });
        documentContentWrapper.str += `\n![${view.name}](data:image/png;base64,${bytes})\n`;
    } else {
        documentContentWrapper.str += `\n![${view.name}][embedView]\n`;
    }

    if (view.documentation) {
        documentContentWrapper.str += `\n${escapeMD(view.documentation)}\n`;
    }

    if (view.viewpoint && view.viewpoint.name!="None") {
        documentContentWrapper.str+= `Viewpoint: ${view.viewpoint.name}\n`;
    }

    // Notes with no relationships
    $(view).find().not("element").not("relationship").each(function (c) {
        if (c.text && $(c).rels().length === 0) {
            documentContentWrapper.str += `\n> ${escapeMD(c.text).replaceAll("\n", "\n> ")}\n`;
        }
    });

    generateNestedDocumentation(view, 0, bodyMap, documentContentWrapper);

    documentContentWrapper.str+=`\n[^1]: Generated: ${new Date().toLocaleString()}\n`;

    return documentContentWrapper.str;
}

function saveMarkdownToFile(view, markdownContent) {
    const defaultFileName = view.name ? `${model.name}-${view.name}.md` : "Exported View.md";
    const exportFile = window.promptSaveFile({ title: "Export to Markdown", filterExtensions: ["*.md"], fileName: defaultFileName });

    if(exportFile) {
        if (!embed) {
            const imageURL = exportFile.substring(0,exportFile.length-3).replaceAll(" ","%20")+".png";
            const relativeURL = imageURL.split("\\");
            var bytes = $.model.renderViewAsBase64(view, "PNG", {scale: 2, margin: 10});
            $.fs.writeFile(exportFile.substring(0,exportFile.length-3) +".png", bytes, "BASE64");    
            markdownContent+=`\n[embedView]: ${relativeURL[relativeURL.length-1]}`;
        }
        $.fs.writeFile(exportFile, markdownContent);
        console.log("> Export done");
        return exportFile;
    }
    else {
        console.log("> Export cancelled");
    }
}

function saveIndexToFile(markdownContent) {
    const defaultFileName = "index.md";
    const exportFile = window.promptSaveFile({ title: "Export to Markdown", filterExtensions: ["*.md"], fileName: defaultFileName });

    if(exportFile) {
        $.fs.writeFile(exportFile, markdownContent);
        console.log("> Export done");
        return exportFile;
    }
    else {
        console.log("> Export cancelled");
    }
}

Thanks for this example

Very useful. Thanks.