[pull]

See Commits and Changes for more details.

---

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Treat TabNode as a first-class token in editing operations by introducing $isTokenOrTab, enforcing immutability of TabNode text, updating selection and text utilities to handle TabNode correctly, and adding tests for boundary insertion behavior.

Bug Fixes:

• Fix insertion and merging behavior at TabNode boundaries when adjacent to normal TextNode ([lexical][lexical-selection] Bug Fix: Treat all TabNode as if they are in token mode facebook/lexical#7602).
• Prevent invalid TabNode mutations by overriding spliceText and setTextContent.

Enhancements:

• Add $isTokenOrTab utility and integrate TabNode handling across utilities and selection logic.
• Update RangeSelection and LexicalEvents to treat TabNode like tokens and avoid unwanted splicing.
• Refactor CollabTextNode and TextNode to use setTextContent instead of direct __text mutations.
• Export $isTokenOrTab in the public API.

Tests:

• Add unit tests for TabNode insertion at selection boundaries with surrounding text nodes.

[sourcery-ai]

Reviewer's Guide

This PR deepens TabNode’s integration into token-based handling by constraining its text mutations, exposing a new token-or-tab utility, updating selection and event logic to treat tabs as tokens, adding boundary insertion tests, and refactors text synchronization to consistently use setTextContent.

Sequence Diagram for TabNode setTextContent and spliceText Operations

sequenceDiagram
    participant C as Caller
    participant TN as TabNode

    C->>TN: setTextContent("any text")
    TN->>TN: super.setTextContent('\t') // Internally enforces '\t'
    TN-->>C: returns self

    alt Valid spliceText (e.g., delete and insert tab)
        C->>TN: spliceText(0, 1, "\t")
        TN-->>C: returns self // Constrained behavior, no actual text content change beyond ensuring it's a tab
    else Invalid spliceText (e.g., arbitrary text change)
        C->>TN: spliceText(0, 0, "a")
        TN-->>C: throws InvariantError
    end

Loading

Sequence Diagram for Text Insertion Logic with $isTokenOrTab Utility

sequenceDiagram
    actor User
    participant Editor
    participant RS as RangeSelection
    participant Node as "TextNode (e.g., TabNode)"
    participant LU as LexicalUtils

    User->>Editor: Types character "a"
    Editor->>RS: insertText("a")
    RS->>Node: getProperties()
    RS->>LU: $isTokenOrTab(Node)
    activate LU
    LU-->>RS: true (if Node is TabNode or Token)
    deactivate LU
    RS->>Node: applyTokenLikeInsertionLogic() // e.g., replace node, or disallow partial modification
    RS-->>Editor: Update EditorState
    Editor-->>User: Display updated text

Loading

File-Level Changes

Change	Details	Files
Constrain TabNode text mutations to tab-only behavior	Override setTextContent to always enforce '\t'. Implement spliceText as a no-op with invariant checks for deletion/insertion. Prevent unsupported mutations by throwing on invalid splice operations.	packages/lexical/src/nodes/LexicalTabNode.ts
Add tests for insertion around TabNode boundaries	Import caret range and selection helpers. Insert raw text containing tabs and position selection before/after TabNode. Verify post-normalization text merging and TabNode removal.	packages/lexical/src/nodes/__tests__/unit/LexicalTabNode.test.tsx
Introduce $isTokenOrTab and update selection/event utilities	Define $isTokenOrTab in LexicalUtils and export it. Replace .isToken()/isSegmented() checks with $isTokenOrTab or $isTokenOrSegmented in selection logic. Update caret insertion, splicing, and deletion guards across selection and event modules.	packages/lexical/src/LexicalUtils.ts packages/lexical/src/LexicalSelection.ts packages/lexical-selection/src/lexical-node.ts packages/lexical/src/LexicalEvents.ts packages/lexical/src/index.ts
Refactor text sync to use setTextContent	Replace direct writable.__text mutation with setTextContent in CollabTextNode. Switch TextNode part replacement to use setTextContent instead of direct property assignment.	packages/lexical-yjs/src/CollabTextNode.ts packages/lexical/src/nodes/LexicalTextNode.ts

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.