prettier / prettier/prettier

HTML comment in markdown, descendant of a task list item, is not idempotent

Open
#18,067 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
52.3k
Forks
5k
Avg merge
19h 2m
Merged PRs (30d)
117

Description

Prettier 3.6.2
Playground link

--parser markdown

Input:

- [ ] Foo

    <!--
      Something
    -->

Output:

- [ ] Foo

  <!--
    Something
  -->

Second Output:

- [ ] Foo

<!--
  Something
-->

Expected output:

- [ ] Foo

  <!--
    Something
  -->

Why?

I think that one makes more sense as it hangs off the list item

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the linked Playground case with --parser markdown, comparing the first and second outputs for the HTML comment under the task-list item. Trace the Markdown formatter behavior for descendant comments, then add regression coverage showing that formatting the input repeatedly preserves the expected indented output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.