prettier / prettier/prettier

Drop MDX 1 comments

Open
#11,567 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Drop MDX 1 comments (HTML-style comments) and only support MDX 2 comments(JS-style comments).

MDX 1 comments:

A <!-- HTML-style comment --> comment.

MDX 2 comments:

A {/* JS-style comment */} comment.

related: https://github.com/prettier/prettier/pull/11563#issuecomment-924926415

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

Start with the MDX 1 and MDX 2 examples in the issue, then read the related Prettier pull-request discussion. Trace how Prettier currently handles both comment styles and update the relevant coverage so HTML-style comments are dropped while JavaScript-style comments remain supported.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.