Fix smart quotes at the start of paragraphs #87
Merged
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
rwblickhan
commented
Jul 8, 2024
| "`); | ||
| }); | ||
|
|
||
| it("at end before another paragraph", async () => { |
There was a problem hiding this comment.
The ending quotes actually work fine without this change, but we might as well test them while we're at it!
| @@ -78,4 +89,10 @@ function isLiteral(node: Node): node is Literal { | |||
| return "value" in node && typeof node.value === "string"; | |||
| } | |||
|
|
|||
| interface Paragraph extends Node {} | |||
There was a problem hiding this comment.
This interface doesn't feel strictly necessary, but it is nice to use the type nodes: (Literal | Paragraph)[] above instead of broadening it to nodes: Node[].
silvenon
approved these changes
Jul 8, 2024
|
Released in v3.0.2 🚀 |
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.
Summary
v2.1.0 fixed smart quotes around links and inline code by concatenating all text into one string (
allText) and converting that withretext-smartypants.That introduced a small regression. Quotes at the start of a paragraph may be merged with another paragraph, which
retext-smartypantswill no longer recognize as opening quotes. For instance:is incorrectly converted to:
where the first quote on "Some quote" is being treated as a closing quote.
This PR fixes that by inserting a space into
allTextevery time we see aparagraphnode, then skipping over the inserted spaces when we need to keep track of indexes. That feels slightly clumsy, but it's a targeted way to fix this bug without changing the other behavior of this plugin.Test Plan