Fix wrapping on lines succeeded by unwrappable lines #228
Conversation
This file contains 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
When outputting as `commonmark` lines followed by a long, unwrappable section would wrap incorrectly. For example: ```md item that doesn't need wrapping a-long-line-that-won't-be-wrapped-because-there-is-no-character-it-can-break-on ``` When running this with the `--to commonmark` and `--width 72` options: ```sh comrak --to commonmark --width 72 some-markdown.md ``` It outputs the following: ```md item that doesn't need wrapping a-long-line-that-won't-be-wrapped-because-there-is-no-character-it-can-break-on ``` What was happening is that when a new line is needed, the algorithm resets a bunch of variables like the current column, if we're at the beginning of a line, etc. One of those variables is the position of the last place we can break a line: the last non-space character. This is stored in `CommonMarkFormatter`s `last_breakable` field. cmark-gfm [resets this][cmark-gfm-render] in `render.c`, and now so does comrak. This also adds a new `commonmark` test type that doesn't write to HTML to test commonmark specific features or bugs. [cmark-gfm-render]: https://github.com/github/cmark-gfm/blob/f26f75ce5dbfeddf8c3e3df10a6f238f65f8d6ba/src/render.c#L60
|
Wonderful — thank you so much! |
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.
When outputting as
commonmarklines followed by a long, unwrappablesection would wrap incorrectly. For example:
When running this with the
--to commonmarkand--width 72options:It outputs the following:
What was happening is that when a new line is needed, the algorithm
resets a bunch of variables like the current column, if we're at the
beginning of a line, etc. One of those variables is the position of the
last place we can break a line: the last non-space character. This is
stored in
CommonMarkFormatterslast_breakablefield.cmark-gfm resets this in
render.c, and now so does comrak.This also adds a new
commonmarktest type that doesn't write to HTMLto test commonmark specific features or bugs.
Fixes #227