Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: insert formula remove extra content #231

Merged
merged 1 commit into from
Feb 25, 2025
Merged

Conversation

zzxming
Copy link
Member

@zzxming zzxming commented Feb 20, 2025

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: close #226

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the deletion functionality in math tooltips so that content elements are now removed precisely, ensuring all intended parts are cleared.
    • Improved the cursor placement after content removal, so the selection reliably reflects user actions.
    • These adjustments provide a smoother, more consistent editing experience when working with mathematical content.

Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

The changes update the save method in the MathliveTooltip class by adding a new import for the isString utility. The method now retrieves content data from the Quill editor and calculates a deletion count that considers if the content is non-string and includes a mathlive property. Additionally, the call to the delete method uses the maximum of the computed delete count and the original selection length, and the selection index is updated to use range.index.

Changes

File Path Change Summary
packages/fluent-editor/.../mathlive/tooltip.ts - Added an import for isString from ../../utils/is.
- Modified the save method: computes a custom deletion count based on content type and mathlive property; updated the deletion logic and selection index using range.index.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant MT as MathliveTooltip
    participant QE as QuillEditor
    participant D as Delta

    U->>MT: Initiate save()
    MT->>QE: Retrieve content at range.index
    QE-->>MT: Return content data
    MT->>MT: Check if content isString & contains mathlive property
    alt Content with mathlive property exists
        MT->>MT: Increment deleteCount
    end
    MT->>D: Delete(Math.max(deleteCount, range.length))
    MT->>MT: Update selection index using range.index
Loading

Poem

In a code burrow, I happily hop,
New logic unveiled, no need to stop.
With isString and mathlive in sight,
My deletion counts now set things right.
I hop along in code so spry,
A rabbit’s cheer as the changes fly! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added bug Something isn't working v3 labels Feb 20, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/fluent-editor/src/modules/mathlive/tooltip.ts (1)

68-78: LGTM! Consider adding error handling.

The changes correctly handle the replacement of existing formulas by:

  1. Checking if the current content is a mathlive formula
  2. Adjusting the deletion length accordingly
  3. Properly positioning the cursor after insertion

Consider adding error handling for the case where getContents returns unexpected data:

-    const contentData = this.quill.getContents(range.index, 1).ops[0].insert
+    const contents = this.quill.getContents(range.index, 1)
+    const contentData = contents.ops?.[0]?.insert
+    if (contentData === undefined) {
+      console.warn('Unexpected content structure at current position')
+      return
+    }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7028550 and 04e3a15.

📒 Files selected for processing (1)
  • packages/fluent-editor/src/modules/mathlive/tooltip.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (1)
packages/fluent-editor/src/modules/mathlive/tooltip.ts (1)

5-5: LGTM!

The import of the isString utility is appropriate for the type checking needed in the save method.

@kagol kagol merged commit 3ebe740 into opentiny:main Feb 25, 2025
2 of 4 checks passed
kagol pushed a commit that referenced this pull request Feb 25, 2025
kagol pushed a commit that referenced this pull request Feb 25, 2025
@zzxming zzxming deleted the fix-formula branch February 26, 2025 02:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working v3
Projects
None yet
2 participants