Fix non-idempotent setext heading whose line ends in a tab#579
Open
sarathfrancis90 wants to merge 1 commit into
Open
Fix non-idempotent setext heading whose line ends in a tab#579sarathfrancis90 wants to merge 1 commit into
sarathfrancis90 wants to merge 1 commit into
Conversation
A setext heading whose line ends in a tab kept that tab in the inline text token. When the heading was rewritten as a single-line ATX heading, the tab became a space next to the space produced for the line break, yielding two consecutive spaces. Reformatting then collapsed them to one, so formatting was not idempotent. Collapse the spaces around the converted line break so the heading is stable on a second format pass.
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
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.
I noticed mdformat isn't idempotent for a setext heading whose line ends in a tab. Formatting it once gives a heading with two spaces, and formatting that output again collapses them to one:
A line of a setext heading can end in a tab, which the parser keeps in the inline text token. When the heading is rewritten as a single-line ATX heading, that tab turns into a space right next to the space produced for the line break, so two spaces sneak in. A trailing space (rather than a tab) doesn't hit this because the parser strips trailing spaces.
The fix collapses the spaces around the converted line break so the heading renders the same way on a second pass. Added a fixture case to
default_style.md; full test suite, flake8, black, isort and mypy are green.