Skip to content

fix: fix strikethrough flanking rules#3882

Open
UziTech wants to merge 2 commits intomarkedjs:masterfrom
UziTech:del-flanking
Open

fix: fix strikethrough flanking rules#3882
UziTech wants to merge 2 commits intomarkedjs:masterfrom
UziTech:del-flanking

Conversation

@UziTech
Copy link
Member

@UziTech UziTech commented Feb 1, 2026

Marked version: 17.0.1

Markdown flavor: GitHub Flavored Markdown

Description

Copy asterisk (*) emStrong flanking rules for tilde (~) strikethrough

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

@vercel
Copy link

vercel bot commented Feb 1, 2026

@UziTech is attempting to deploy a commit to the MarkedJS Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Feb 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
marked-website Ready Ready Preview, Comment Feb 1, 2026 7:53pm

Request Review

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @UziTech, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses an issue where strikethrough parsing was overly permissive, leading to unintended rendering in specific text patterns. It overhauls the strikethrough tokenization process to strictly adhere to GitHub Flavored Markdown's flanking rules, ensuring that tilde characters are only interpreted as strikethrough delimiters when properly positioned and surrounded by appropriate characters. This change improves the accuracy and consistency of Markdown rendering, particularly for content that might contain tildes in non-strikethrough contexts.

Highlights

  • Strikethrough Flanking Rules: The strikethrough (~) tokenization logic has been refactored to correctly apply GitHub Flavored Markdown (GFM) flanking rules, preventing incorrect rendering of tildes in contexts like numbers or mathematical expressions.
  • Tokenizer Logic Update: The del method in the Tokenizer has been completely rewritten to use a more robust delimiter-matching algorithm, similar to how emphasis and strong text are handled, considering surrounding characters and delimiter lengths.
  • New Regular Expressions: New GFM-specific regular expressions (_punctuationGfmDel, _punctuationOrSpaceGfmDel, _notPunctuationOrSpaceGfmDel, delLDelim, delRDelim) have been introduced to precisely define the left and right delimiters for strikethrough.
  • Test Coverage: New test cases (del_flanking.md and del_flanking.html) have been added to validate the correct application of the strikethrough flanking rules and prevent regressions.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request implements GFM-style flanking rules for tilde-based strikethrough, mirroring the existing logic for asterisks in emphasis and strong tags. A security audit found no high or critical severity vulnerabilities, covering ReDoS, data flow, Unicode handling, and flanking rule logic. The overall approach is sound, but there are minor improvements needed in the new del tokenizer method in src/Tokenizer.ts, specifically regarding some dead code, a misleading comment, and a line that can be simplified for readability. After these minor changes, the PR should be in great shape.

@UziTech
Copy link
Member Author

UziTech commented Feb 1, 2026

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly implements the GFM flanking rules for strikethrough by adapting the existing logic from emphasis/strong. This is a great step towards better GFM compliance. However, this has been achieved by duplicating a significant amount of complex code and regular expressions. My review focuses on suggesting refactoring opportunities to remove this duplication, which will improve the long-term maintainability and robustness of the codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tilde/strikethrough is not rendered the same way as GitHub

1 participant