prettier/prettier

HTML comments in markdown get endlessly indented

Open

#18.066 aberto em 13 de out. de 2025

Ver no GitHub
 (2 comments) (0 reactions) (1 assignee)JavaScript (51.868 stars) (4.716 forks)batch import
help wantedlang:markdown

Description

Prettier 3.6.2 Playground link

--parser markdown

Input:

- Something:
  - [ ] Foo
  - [ ] Bar
        <!--
          Something else
        -->

Output:

- Something:
  - [ ] Foo
  - [ ] Bar
        <!--
              Something else
            -->

Second Output:

- Something:
  - [ ] Foo
  - [ ] Bar
        <!--
                  Something else
                -->

Expected output:

- Something:
  - [ ] Foo
  - [ ] Bar
        <!--
          Something else
        -->

Why?

IMO, the comment is hanging under the "Bar" item, so it should be indented one level more than it. <!-- and --> should be at the same level. And a re-format should not keep pushing the contents ever to the right.

Guia do colaborador

Pilha de tecnologia
javascriptnodejs
Domain
toolingdeveloper experience
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.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
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 Prettier's markdown parserBasic knowledge of AST traversal
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
The issue is about HTML comments inside list items in markdown being indented incorrectly. Start by locating the markdown printer in Prettier's source, likely in `src/language markdown/printer markdown.js`. Focus on the logic that handles indentation of HTML comments within list items. Look for how comments are treated in the context of list item indentation. The playground link shows the problem; replicate it and trace the indentation calculations. Check if there is an existing test for similar cases. The fix likely involves adjusting the indentation level for comment nodes relative to their parent list item.