Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style: enable prettier for mdx files #1907

Open
wants to merge 6 commits into
base: source
Choose a base branch
from

Conversation

saihaj
Copy link
Member

@saihaj saihaj commented Dec 23, 2024

Not sure why we disabled prettier for .mdx files. I was working on some other PR and saw it wasn't working so decided to enable for everything.

@saihaj saihaj requested a review from dimaMachina December 23, 2024 15:31
Copy link

vercel bot commented Dec 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
graphql-github-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 4:02pm

Copy link
Contributor

@dimaMachina dimaMachina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@benjie should we disable proseWrap for mdx?

"proseWrap": "always",

@benjie
Copy link
Member

benjie commented Dec 23, 2024

Hold fire on this.

@benjie
Copy link
Member

benjie commented Dec 23, 2024

Okay I dug up the bug with proseWrap in MDX / bug report.

Yes, we must disable proseWrap in MDX if we enable prettier; generally I don't trust it with MDX files. I've taken to just un-ignoring each new MDX file I add - perhaps we should ignore certain problematic files but enable?

@benjie
Copy link
Member

benjie commented Dec 23, 2024

@saihaj is it possible to generate the static website before and after this change and assert that there are no differences in the generated output?

@saihaj
Copy link
Member Author

saihaj commented Dec 26, 2024

@saihaj is it possible to generate the static website before and after this change and assert that there are no differences in the generated output?

yes. The deploy preview we see on this PR is a version we can compare that with prod. We can build this branch and then try to diff between source branch build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants