fix: handle empty newlines before diagrams in md #455
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.
📑 Summary
Handles empty newlines before and after diagrams in Markdown.
For example, the following Markdown:
Should get converted to:
However, currently, the empty newline is removed.
We can fix this by making sure that our Regex ignores newlines outside of the Mermaid diagram code.
Fixes: 9d7b4b2 (where bug was introduced)
Fixes: #413
📏 Design Decisions
Instead of using
\s
to find all whitespace, I'm instead using[^\S\n]
to find anything that is not a non-whitespace character nor\n
(basically any\s
that is not\n
).In the future, it might be worth instead using https://github.com/remarkjs/remark to handle Markdown parsing, since there are probably a bunch of edge-cases that we can't handle using simplistic regex.
📋 Tasks
Make sure you
master
branch