aboutsummaryrefslogtreecommitdiff
path: root/lib/writers/markdown-writer.js
blob: 5a6f5e0a33400584982d58c2baf487681a5e1127 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
function markdownElement(start, end) {
    if (end === undefined) {
        end = start;
    }
    
    return function() {
        return {start: start, end: end};
    };
}

function markdownLink(attributes) {
    var href = attributes.href || "";
    return {
        start: "[",
        end: "](" + href + ")",
        anchorPosition: "before"
    };
}

function markdownImage(attributes) {
    var src = attributes.src || "";
    var altText = attributes.alt || "";
    if (src || altText) {
        return {start: "![" + altText + "](" + src + ")"};
    } else {
        return {};
    }
}

function markdownList(attributes, list) {
    return {
        start: list.indent > 0 ? "\n" : "",
        end: list.indent > 0 ? "" : "\n"
    };
}

function markdownListItem(attributes, list) {
    list.count++;
    var start = repeatString("\t", Math.max(list.indent, 0)) +
        (list.type === "ul" ? "-" : list.count + ".") + " ";
        
    return {start: start, end: "\n"};
}

// map HTML tags to Markdown syntax
var htmlmarkdown = {
    // paragraphs elements use three line feeds to close
    // this prevents them being caught by collapsing list elements in `asString`
    // while still allowing them to be collapsed when multiple empty lines are removed
    "p": markdownElement("", "\n\n\n"),
    "br": markdownElement("", "  \n"),
    "ul": markdownList,
    "ol": markdownList,
    "li": markdownListItem,
    "strong": markdownElement("**"),
    "em": markdownElement("*"),
    "a": markdownLink,
    "img": markdownImage,
};

(function() {
    for (var i = 1; i <= 6; i++) {
        htmlmarkdown["h" + i] = markdownElement(repeatString("#", i) + " ", "\n\n\n");
    }
})();

function repeatString(value, count) {
    return new Array(count + 1).join(value);
}

function markdownWriter() {
    var fragments = [];
    var elementStack = [];
    var list = {
        indent: -1,
        type: "ul",
        count: 0
    };
    
    function isList(tagName) {
        return tagName === "ul" || tagName === "ol";
    }

    function open(tagName, attributes) {
        attributes = attributes || {};
        
        var parentElementList = list;
        
        if (isList(tagName)) {
            list = {
                type: tagName,
                indent: list.indent + 1,
                count: 0
            };
        }
        
        var idHasBeenWritten = false;
        
        var createElement = htmlmarkdown[tagName] || function() { return {}; };
        var element = createElement(attributes, list);
        elementStack.push({end: element.end, list: parentElementList});
        
        if (element.anchorPosition === "before") {
            writeAnchor(attributes);
            idHasBeenWritten = true;
        }

        fragments.push(element.start || "");
        if (!idHasBeenWritten) {
            writeAnchor(attributes);
        }
    }
    
    function writeAnchor(attributes) {
        if (attributes.id) {
            fragments.push('<a id="' + attributes.id + '"></a>');
        }
    }
    
    function close(tagName) {
        var element = elementStack.pop();
        list = element.list;
        fragments.push(element.end || "");
    }
    
    function selfClosing(tagName, attributes) {
        open(tagName, attributes);
        close(tagName);
    }
    
    function text(value) {
        fragments.push(escapeMarkdown(value));
    }
    
    function append(html) {
        fragments.push(html);
    }
    
    function asString() {
        // massage the output to collapse mulitple empty lines and empty lines between nested lists
        return fragments.join("").replace(/\n{2}(\t*)([2-9]\d*\.|- )/g, "\n$1$2").replace(/\n{3,}/g, "\n\n");
    }

    return {
        asString: asString,
        open: open,
        close: close,
        text: text,
        selfClosing: selfClosing,
        append: append
    };
}

exports.writer = markdownWriter;

function escapeMarkdown(value) {
    return value
        .replace(/\\/g, '\\\\')
        .replace(/([\`\*_\{\}\[\]\(\)\#\+\-\.\!])/g, '\\$1');
}