beautifier/js-beautify

HTML <!-- comments --> placed within text alters whitespace

Open

#1.301 aberto em 11 de dez. de 2017

Ver no GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (8.342 stars) (1.460 forks)batch import
good first issuelanguage: htmltype: bug

Description

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.

Guia do colaborador

Pilha de tecnologia
javascripthtml
Domain
tooling
Tipo Issue
bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
understanding of HTML parser in js beautifyfamiliarity with beautifier options
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50
Direção de pesquisa
Investigate the HTML beautifier module in js beautify, specifically how HTML comments are tokenized and reformed. Look at the handling of whitespace around comments in the tokenizer or beautifier code. Consider adding an option (e.g., `preserve comments`) to keep comments inline without altering surrounding whitespace. The existing `content unformatted` workaround suggests the issue is in how inline elements are treated. Review the issue comments for any proposed solutions or discussions.