takedown/dist/cjs/source/config/defaults.js

Customizable markdown parser

'use strict';

Object.defineProperty(exports, '__esModule', { value: true });

var commonChars = require('../data/common-chars.json.js');
var htmlEntities = require('../data/html-entities.json.js');
var reparts = require('../lib/reparts.js');

var defaults = {    
    convert:
    {
        autolink: '<a href="{url}">{value}</a>',
        code: '<code>{value}</code>',
        codeblock: '<pre><code>{value}</code></pre>\n',
        divide: '<hr />\n',
        email: '<a href="mailto:{email}">{value}</a>',
        emphasis: '<em>{value}</em>',
        fenceblock: e =>
        {
            e.lang = e.info?.match(/^\s*([^\s]+).*$/s)?.[1];
            return '<pre><code{? class="language-{lang}"?}>{value}</code></pre>\n'
        },
        header: '<h{level}>{value}</h{level}>\n',
        html: '{value}',
        htmlblock: '{value}',
        image: e =>
        {
            e.alt = e.value.replace(/<[^>]+?(?:alt="(.*?)"[^>]+?>|>)/ig, '$1');
            return `<img src="{href}" alt="{alt}"{? title="{title}"?} />`;
        },
        linebreak: '<br />\n',
        link: '<a href="{href??}"{? title="{title}"?}>{value}</a>',
        listitem: e =>
        {
            e.nl = e.child.count && (!e.tight || e.child.first !== 'paragraph') ? '\n' : '';
            return '<li>{nl}{value}</li>\n';
        },
        olist: e => `<ol${e.start !== 1 ? ` start="${e.start}"` : ''}>\n{value}</ol>\n`,
        paragraph: ({ parent: p, index }) => 
            p.tight ? '{value}' + (p.child.count - 1 === index ? '' : '\n') : '<p>{value}</p>\n',
        quotation: '<blockquote>\n{value}</blockquote>\n',
        root: '{value}',
        setext: '<h{level}>{value}</h{level}>\n',
        strong: '<strong>{value}</strong>',
        ulist: '<ul>\n{value}</ul>\n'
    },
    
    convertTabsAfter: 
    [
        '^',
        // listitem 
        '[*+-]', '\\d+[.)]',
        // quotation
        '>',
    ],

    delouse:
    {
        autolink:
        {
            value: [ 'htmlEntsToChars', 'commonHtmlEnts' ],
            url: [ 'htmlEntsToChars', 'encodeUriChars', 'commonHtmlEnts' ]
        },
        code: [ 'lineEndToSpace', 'trimEncSpace', 'commonHtmlEnts' ],
        codeblock: [ 'commonHtmlEnts' ],
        fenceblock:
        {
            value: [ 'commonHtmlEnts' ],
            info: [ 'common' ]
        },
        email:
        {
            value: [ 'commonHtmlEnts' ],
            email: [ 'commonHtmlEnts' ]
        },
        emphasis: [ 'common' ],
        header: [ 'common' ],
        image:
        {
            value: [ 'common' ],
            href: [ 'uri' ],
            title: [ 'common' ]
        },
        link:
        {
            value: [ 'common' ],
            href: [ 'uri' ],
            title: [ 'common' ]
        },
        paragraph: [ 'trimAroundNewline', 'common' ],
        quotation: [ 'trimEnd' ],
        setext: [ 'trimAroundNewline', 'common' ],
        strong: [ 'common' ],
    },

    delousers:
    {
        ampersandToEnt: { search: [ `${reparts.default.ne}&(?!(amp|quot|gt|lt);)`, 'g' ], replace: '&amp;' },
        commonCharToEnt: { search: [ '(?<cap>[<>"])', 'g' ], replace: g => commonChars.default[g.cap] },
        unescapePunct: { search: [ `\\\\(?<cap>[${reparts.default.apc}])`, 'g' ], replace: '{cap}' },
        namedEntToChar: 
        { 
            search: [ `${reparts.default.ne}(?<cap>&[a-zA-Z0-9]+?;)`, 'g' ], 
            replace: g => htmlEntities.default[g.cap]?.characters || g.match 
        },
        decimalEntToChar: 
        { 
            search: [ `${reparts.default.ne}&#(?<cap>[0-9]{1,7});`, 'g' ], 
            replace: g => String.fromCharCode(g.cap) 
        },
        hexEntToChar: 
        {
            search: [ `${reparts.default.ne}&#x(?<cap>[a-f0-9]{1,4});`, 'gi' ], 
            replace: g => String.fromCharCode(`0x${g.cap}`) 
        },
        lineEndToSpace: { search: [ `[${reparts.default.le}]`, 'g' ], replace: ' ' },
        encodeUriChars: { search: [ '(?<cap>[^%\\w]+)', 'g' ], replace: g => encodeURI(g.cap) },
        trimEnd: { search: '\\s*\\n$', replace: '' },
        trimEncSpace: { search: [ '^ (?<cap>\\s*[^\\s].*) $' ], replace: '{cap}' },
        trimAroundNewline: { search: [ '\\s*\\n\\s*', 'g' ], replace: '\n' },
        // combo-delousers
        common: [ 'htmlEntsToChars', 'unescapePunct', 'commonHtmlEnts' ],
        commonHtmlEnts: [ 'ampersandToEnt', 'commonCharToEnt' ],
        htmlEntsToChars: [ 'namedEntToChar', 'decimalEntToChar', 'hexEntToChar' ],
        uri: [ 'htmlEntsToChars', 'unescapePunct', 'encodeUriChars', 'commonHtmlEnts' ]
    },

    fm:
    {
        enabled: false,
        capture: /^---\s*\n(?<fm>.*?)\n---\s*/s,
        parser: source => JSON.parse(source),
        useConfig: 'takedown',
        varsOnly: false
    },

    interpolation:
    {
        variables: /\{([\w.]+)(?:\?\?(.*?))?\}/g,
        segments: /\{\?(((?!\{\?).)+?)\?\}/g
    },

    nestable:
    {
        emphasis: [ 'autolink', 'code', 'email', 'emphasis', 'image', 'linebreak', 'link' ],
        header: [ 'autolink', 'code', 'email', 'emphasis', 'html', 'link' ],    
        image: [ 'autolink', 'code', 'email', 'emphasis', 'html', 'image', 'link' ],
        link: [ 'autolink', 'code', 'email', 'emphasis', 'html', 'image', 'link' ],
        listitem:
        [ 
            'arbitag', 'autolink', 'code', 'codeblock', 'codefence', 
            'divide', 'email', 'emphasis', 'header', 'html',
            'htmlblock', 'image', 'linebreak', 'link', 'list',
            'paragraph', 'quotation', 'reference', 'setext'
        ],
        paragraph: [ 'autolink', 'code', 'email', 'emphasis', 'html', 'image', 'linebreak', 'link' ],
        quotation:
        [ 
            'codeblock', 'codefence', 
            'divide', 'header',
            'htmlblock', 'list',
            'paragraph', 'quotation', 'reference', 'setext',
        ],
        root:
        [ 
            'arbitag', 'autolink', 'code', 'codeblock', 'codefence', 
            'divide', 'email', 'emphasis', 'header', 'html',
            'htmlblock', 'image', 'linebreak', 'link', 'list',
            'paragraph', 'quotation', 'reference', 'setext',
        ],
        setext: [ 'autolink', 'code', 'emphasis', 'html', 'image', 'linebreak', 'link' ]
    },

    onAction: null,
    
    onConvert: null,

    tabSize: 4,

    vars: {}
};

exports.default = defaults;