[lexical-markdown] Bug Fix: preserve the order of markdown tags for markdown combinations, and close the tags when the outmost tag is closed

[yhw5]

Issue: #2303, #2632
Related PR: #2304

This PR aims to fix the following:
Closing tags were applied in a different order than opening tags.
Unclosed tags remain in the markdown for complex markdown combinations.

And this change should not add any unnecessary duplicate markdown tags

Examples:
Note: underline is a custom markdown here, the tag is "++". You can imagine it as strikethrough "~~"

1. bold, italic and underline combination + italic
   
   markdown:
   before: ++***BoldplusItalicplusUnderline**++Italic* (unclosed italic inside the first block)
   after: ***++BoldplusItalicplusUnderline++****Italic* (properly closed all the opening tags if the outmost one is closed)

2. bold + underline and bold combination
   
   markdown output:
   before: **bold++underline**++ (markdown tag order is wrong)
   after: **bold++underline++**

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
lexical	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 16, 2024 1:26am
lexical-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 16, 2024 1:26am

[facebook-github-bot]

Hi @yhw5!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[yhw5]

Hi @fantactuka I noticed that you have mainly been involved in the referenced issues and PRs above. Could you please take a look at this proposed change? If this could be merged, that would be really great! Thanks

[yhw5]

I changed the expected markdown here because I rearranged the order of tags in the markdownExport. The order change was to address edge cases, such as the one from L146-148, where the very first opening tag needs to be closed as the last one.

[yhw5]

The unit tests and integrity should be OK now. Please help review, thanks

[yhw5]

@ivailop7 @fantactuka @acywatson @zurfyx @Fetz May I get review for this one? Appreciate your time 🙏

[yhw5]

QVQ any concerns regarding the fix? Really like to get the issue fixed especially for the current broken markdown combinations

[SaintPepsi]

Does this also fix cases where multiple formats are being added/removed?
Github doesn't support it natively (first line is adding bold, then italic, and then removing bold from the word "that":

**Example _Text **that** is wrapped in_ bold**
**Example _Text _**that**_ is wrapped in_ bold**
**Example _Text_** _that_ **_is wrapped in_ bold**

Example Text that is wrapped in bold
Example Text that is wrapped in bold
Example Text that is wrapped in bold

[yhw5]

Does this also fix cases where multiple formats are being added/removed? Github doesn't support it natively (first line is adding bold, then italic, and then removing bold from the word "that":

**Example _Text **that** is wrapped in_ bold**
**Example _Text _**that**_ is wrapped in_ bold**
**Example _Text_** _that_ **_is wrapped in_ bold**

Example Text that is wrapped in bold Example Text that is wrapped in bold Example Text that is wrapped in bold

yes exactly!

[github-actions]

size-limit report 📦

Path	Size
lexical - cjs	31.29 KB (0%)
lexical - esm	31.11 KB (0%)
@lexical/rich-text - cjs	40.34 KB (0%)
@lexical/rich-text - esm	33.04 KB (0%)
@lexical/plain-text - cjs	38.88 KB (0%)
@lexical/plain-text - esm	30.3 KB (0%)
@lexical/react - cjs	42.12 KB (0%)
@lexical/react - esm	34.29 KB (0%)

[etrepum]

I think this looks good, not sure how it fell off the radar! Will approve and merge if the test suite is still in a good state.