Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 16, 2025

Link issues

fixes #6236

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add a new IsSupportMath flag to the CherryMarkdown component for optional math support and reflect this change in the demo sample.

New Features:

  • Introduce an IsSupportMath parameter to CherryMarkdown to enable math rendering

Documentation:

  • Update the CherryMarkdown sample to demonstrate IsSupportMath usage

@bb-auto bb-auto bot added the enhancement New feature or request label Jun 16, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 16, 2025

Reviewer's Guide

This PR introduces a new IsSupportMath boolean parameter in the CherryMarkdown component to toggle math rendering support and updates the sample page to demonstrate enabling it.

Class Diagram for CherryMarkdown Component Update

classDiagram
    class CherryMarkdown {
        +string Value
        +string Html
        +bool IsSupportMath
        +string style
    }
Loading

File-Level Changes

Change Details Files
Expose IsSupportMath parameter in CherryMarkdown component
  • Add a new [Parameter] IsSupportMath property (default false)
  • Conditionally enable math plugin integration when IsSupportMath is true
src/BootstrapBlazor.Server/Components/CherryMarkdown.razor
src/BootstrapBlazor.Server/Components/CherryMarkdown.cs
Update the demo sample to showcase math support
  • Set IsSupportMath="true" in the Normal demo block
  • Ensure MarkdownString and HtmlString bindings still function when math is enabled
src/BootstrapBlazor.Server/Components/Samples/CherryMarkdowns.razor
Adjust project configuration for the new feature
  • Modify BootstrapBlazor.Server.csproj to include any new package or build settings required by IsSupportMath
src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj

Assessment against linked issues

Issue Objective Addressed Explanation
#6236 Update cherry-markdown version to support formulas.
#6236 Add IsSupportMath parameter to the CherryMarkdown component.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 16, 2025
@ArgoZhang ArgoZhang merged commit 2104888 into main Jun 16, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-markdown branch June 16, 2025 05:20
@codecov
Copy link

codecov bot commented Jun 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9b51e50) to head (396e728).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6237   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          704       704           
  Lines        31121     31121           
  Branches      4400      4400           
=========================================
  Hits         31121     31121           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

  • I don’t see any changes in the CherryMarkdown component itself to declare and use the new IsSupportMath parameter – be sure to add [Parameter] public bool IsSupportMath { get; set; } and integrate it into the rendering logic.
  • Consider lazily loading the math renderer (e.g. MathJax or KaTeX) only when IsSupportMath is true to avoid adding extra overhead for standard markdown rendering.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- I don’t see any changes in the CherryMarkdown component itself to declare and use the new IsSupportMath parameter – be sure to add `[Parameter] public bool IsSupportMath { get; set; }` and integrate it into the rendering logic.
- Consider lazily loading the math renderer (e.g. MathJax or KaTeX) only when IsSupportMath is true to avoid adding extra overhead for standard markdown rendering.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(cherry-markdown): add IsSupportMath parameter

2 participants