fix: shift headings with commonmark AST #115
Merged
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.
This PR fixes the issue, that the current headings are shifted line wise without taking the context into account.
Leading to issues that shift single line comments in code blocks
# comment
because they look the same as# heading
We should use a real commonmark library because code blocks have multiple variants and can also be nested. I am also not sure if there are any other edge cases where a line starts with
#
and not beeing headings. Anyregex
or other self-cooked algoritms are not desireable due to complexity and maintenance overhead.Nobody noticed this issue yet; i guess. But as we progress with the migration it is rather ugly and should be fixed by now.
closes #113
Done: