Skip to content

Conversation

@byplayer
Copy link
Contributor

@byplayer byplayer commented Sep 8, 2025

Description

This is a bug fix of issue #17746.

Preserve blank lines in nested lists

Fixed an issue where prettier was removing blank lines between list items
and nested sublists in Markdown, which could change the semantic meaning
of the content. The fix detects original blank lines in the source and
preserves them when they occur before nested lists within list items.

This addresses cases where users intentionally use blank lines to create
visual separation or semantic grouping in their markdown lists.

Checklist

  • I’ve added tests to confirm my change works.
  • (If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory).
  • (If the change is user-facing) I’ve added my changes to changelog_unreleased/*/XXXX.md file following changelog_unreleased/TEMPLATE.md.
  • I’ve read the contributing guidelines.

Fixed an issue where prettier was removing blank lines between list items
and nested sublists in Markdown, which could change the semantic meaning
of the content. The fix detects original blank lines in the source and
preserves them when they occur before nested lists within list items.

This addresses cases where users intentionally use blank lines to create
visual separation or semantic grouping in their markdown lists.

Fixes prettier#17746
Add changelog entry for the fix that preserves blank lines in
nested markdown lists, addressing issue prettier#17746.

This changelog documents the bug fix that ensures markdown formatting
maintains proper spacing in nested list structures, improving output
consistency with markdown standards.
@pkg-pr-new
Copy link

pkg-pr-new bot commented Sep 8, 2025

Open in StackBlitz

yarn add https://pkg.pr.new/prettier/prettier/@prettier/plugin-hermes@17857.tgz
yarn add https://pkg.pr.new/prettier/prettier/@prettier/plugin-oxc@17857.tgz
yarn add https://pkg.pr.new/prettier/prettier@17857.tgz

commit: 0186dec

@netlify
Copy link

netlify bot commented Sep 8, 2025

Deploy Preview for prettier ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0186dec
🔍 Latest deploy log https://app.netlify.com/projects/prettier/deploys/68bfce4efd6e09000895a1e4
😎 Deploy Preview https://deploy-preview-17857--prettier.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Why is this change needed?
The test snapshots need to be updated to reflect the fix for issue prettier#17746, which preserves blank lines in nested markdown lists. The snapshots now correctly show blank lines between numbered list items and their nested sub-items.

How does it address the issue?
Updates the Jest snapshot file to match the corrected formatting behavior where blank lines are preserved in nested list structures, ensuring tests pass with the new formatting rules.

What effects does the patch have?
Test snapshots now accurately represent the expected markdown formatting output, ensuring that the markdown parser correctly maintains blank lines in nested list structures as intended by the fix.
@byplayer
Copy link
Contributor Author

byplayer commented Sep 9, 2025

I think https://github.com/prettier/prettier/actions/runs/17574300842/job/49916187236?pr=17857 will be passed when rerun the task.

@andersk
Copy link
Contributor

andersk commented Dec 9, 2025

The merge conflict with #18321 needs to be resolved.

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.

2 participants