Js-beautify: HTML <!-- comments --> placed within text alters whitespace

Created on 11 Dec 2017  ·  1Comment  ·  Source: beautify-web/js-beautify

Description

When HTML comments are beautified, it removes the whitespace surrounding the comment. This is problematic if the HTML comments occur within text blocks such as paragraphs.

Input

When a comment exists inside a text block:

<div><p>Hello <!-- Comment -->World</p></div>

Expected

Ideally, I would like comments to always be ignored wherever they occur, like so:

<div>
    <p>Hello <!-- Comment -->World</p>
</div>

Actual

The problem with the above is the removal of the space following Hello like so:

<div>
    <p>Hello
        <!-- Comment -->World</p>
</div>

Settings

Example:

{
    "indent_size": 1,
    "indent_char": "    ",
    "wrap_line_length": 0,
    "preserve_newlines": true,
    "max_preserve_newlines": 3
}

Note

I'm aware that I could use:

{
    "content_unformatted": ["p","li","td", "...", "..."]
}

But this doesn't strike me as an ideal solution. I think it would be better if there was an option to ignore comment tags specifically.

good first issue html bug

Most helpful comment

I'm having the same issue here.

>All comments

I'm having the same issue here.

Was this page helpful?
0 / 5 - 0 ratings