Fix the parser behavior for texts containing curly-braces when the Attributes extension is enabled#1040
Merged
colinodell merged 5 commits intothephpleague:2.5from Aug 14, 2024
Conversation
colinodell
approved these changes
Aug 14, 2024
Member
colinodell
left a comment
There was a problem hiding this comment.
Thank you for the PR!
While I do like the simplicity of allowing {attribute}, I think it's entirely reasonable to revert that feature in favor of the more explicit approach that is less likely to collide with other user input.
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
2 participants
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.
The issue
As stated in #1035 (comment), the PR #986 , which introduced the ability to create valueless attributes using the Attributes extension, causes issues when a markdown document includes text strings that contain curly braces.
For example, the following markdown text
Elastic{ON} Tour San Franciscois rendered by the official commonmark dingus as:
The
league/commonmarklibrary with the "Attributes" extension enabled was used to render such markdown the same way until the commit 2138460. Since then, it renders this markdown as:which is obviously something we do not want.
What does this PR
This PR reverts the changes introduced in #986 and #1035 and adds more test cases, to show how to create valid boolean-attributes.
A section has also been added in the documentation to show how to write attributes that will be rendered as empty-value attributes in HTML.