feat: extend prettier plugin to preserve <Steps /> component#29819
Draft
mvvmm wants to merge 1 commit intoproductionfrom
Draft
feat: extend prettier plugin to preserve <Steps /> component#29819mvvmm wants to merge 1 commit intoproductionfrom
mvvmm wants to merge 1 commit intoproductionfrom
Conversation
github-actions
bot
added
product:bots
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
mvvmm
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Extends the custom prettier plugin (from #29770) to also handle
<Steps>blocks, and renames it fromprettier-plugin-mdx-inlinetoprettier-plugin-cloudflare-docssince it now covers more than inline elements.New capability —
mdxPreserveElements: Prettier's MDX formatter destroys markdown list structure inside JSX block elements like<Steps>— it collapses numbered lists into a single paragraph and strips indentation from nested JSX children like<DashButton>. The plugin now supports amdxPreserveElementsoption that makes prettier ignore configured components completely, preserving their content verbatim. This works by replacing matched regions with same-length HTML comment placeholders before parsing (so AST positions stay valid), then restoring the original content in the AST before the printer outputs it.Renamed plugin:
prettier-plugin-mdx-inline→prettier-plugin-cloudflare-docs, parsermdx-inline→mdx-cloudflare-docs. This is the repo's general-purpose prettier customization plugin.Removed 18
prettier-ignorecomments from 12 files that were guarding<Steps>blocks — the plugin now handles this automatically.