[pull] develop from mermaid-js:develop

[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

New Features:

• Animate flowchart edges by assigning IDs, enabling animations, specifying animation speeds (fast, slow), and applying animations using class definitions.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request implements animation support for flowchart edges in Mermaid. It introduces a new way to attach IDs to edges, define animation properties, and apply animations using both inline properties and class definitions.

Sequence diagram for edge animation processing

sequenceDiagram
    participant Parser
    participant FlowDB
    participant Renderer

    Parser->>FlowDB: Parse edge with ID (e1@-->)
    FlowDB->>FlowDB: Extract metadata
    FlowDB->>FlowDB: Apply animation properties
    FlowDB->>Renderer: Pass edge with animation data
    Renderer->>Renderer: Apply animation styles
    Note over Renderer: Add CSS animation classes

Loading

Class diagram showing updated Edge types and metadata

classDiagram
    class FlowEdge {
        +string start
        +string end
        +string type
        +string text
        +string labelType
        +string[] classes
        +string id
        +string animation
        +boolean animate
    }

    class EdgeMetaData {
        +string animation
        +boolean animate
    }

    class Edge {
        +string id
        +string[] style
        +boolean animate
        +string animation
        +string[] cssCompiledStyles
    }

    Edge <|-- FlowEdge
    note for EdgeMetaData "New type for edge animation metadata"
    note for Edge "Updated with animation properties"

Loading

File-Level Changes

Change	Details	Files
Added support for edge IDs and animations	Added the ability to attach IDs to edges using the @ symbol. Introduced animate and animation properties for edges to control animation behavior. Implemented support for fast and slow animation speeds. Allowed animation properties to be defined within class definitions and applied to edges using the class keyword. Updated the documentation and added tests to cover the new functionality.	packages/mermaid/src/diagrams/flowchart/flowDb.ts packages/mermaid/src/diagrams/flowchart/parser/flow-edges.spec.js packages/mermaid/src/diagrams/flowchart/parser/flow.jison packages/mermaid/src/diagrams/flowchart/types.ts packages/mermaid/src/rendering-util/rendering-elements/edges.js packages/mermaid/src/rendering-util/types.ts packages/mermaid/src/styles.ts packages/mermaid/src/types.ts packages/mermaid/src/utils.ts docs/syntax/flowchart.md packages/mermaid/src/docs/syntax/flowchart.md cypress/platform/knsv2.html

---

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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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.
  • 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.