Needlessly Provoking Marsupials

    preserve-comment-whitespace

    0.0.3 • Public • Published

    preserve-comment-whitespace

    Preserves the presence or lack thereof of whitespace surrounding HTML comments.

    codecov npm package Twitter Follow

    HTML formatters don't always properly handle HTML comments. This package attempts to properly maintain the whitespace around the HTML comments.

    Some known issues:

    Install

    $ npm install preserve-comment-whitespace
    

    Usage

    const { preserve, restore } = require('preserve-comment-whitespace');
    const beautify = require('js-beautify').html;
    
    const html = `<div><div><!-- my html comment --></div></div>`
    
    const comments = preserve(html);
    const formatted = beautify(html);
    //=> <div>\n    <div>\n        <!-- my html comment -->\n    </div>\n</div>
    const formattedAndRestored = restore(formatted, comments)
    //=> <div>\n    <div><!-- my html comment --></div>\n</div>

    API

    preserve(html)

    Returns an Array containing the objects descripting the HTML comments.

    restore(html, comments, options)

    Returns a string where the whitespace around the HTML comments is restored.

    Note: the processing between preserve and restore should add or remove any comments. If the number of comments given don't match the number of comments found in the given HTML, restore will return the given string, unprocessed.

    html

    String | required

    String of HTML after any formatting that would have affected the whitespace.

    comments

    Array | defaults to []

    The Array returned from preserve.

    options

    Object | defaults to { restoreInline: true }

    Configuration for how to restore the comment whitespace.

    Accept restoreInline. If true, comments that were originally inline (i.e. not on their own lines) will be restored to be inline. Otherwise, it will accept the new line placement.

    Related

    Install

    npm i preserve-comment-whitespace

    DownloadsWeekly Downloads

    34

    Version

    0.0.3

    License

    MIT

    Unpacked Size

    15.2 kB

    Total Files

    6

    Last publish

    Collaborators

    • avigoldman