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

[pull] develop from mermaid-js:develop #21

Merged
merged 7 commits into from
Jan 21, 2025
Merged

Conversation

pull[bot]
Copy link

@pull pull bot commented Jan 21, 2025

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

Update the Gantt, Sankey, and User Journey diagrams to use the font family specified in the Mermaid configuration.

New Features:

  • Allow users to configure the font family for Gantt, Sankey, and User Journey diagrams.

Enhancements:

  • Standardize font selection across diagrams.

@pull pull bot added the ⤵️ pull label Jan 21, 2025
@pull pull bot merged commit eb76dfb into Stars1233:develop Jan 21, 2025
Copy link

sourcery-ai bot commented Jan 21, 2025

Reviewer's Guide by Sourcery

This pull request introduces a change that allows the Gantt, Sankey, and User Journey diagrams to pick up the font-family from the mermaid configuration. This change ensures that the font family used in these diagrams is consistent with the overall mermaid configuration, enhancing the visual consistency of the diagrams.

Class diagram showing affected diagram style modules

classDiagram
    class MermaidConfig {
        +fontFamily: string
    }

    class GanttStyles {
        +getStyles(options)
    }

    class UserJourneyStyles {
        +getStyles(options)
    }

    class SankeyStyles {
        +getStyles(options)
        +NEW
    }

    MermaidConfig --> GanttStyles: uses
    MermaidConfig --> UserJourneyStyles: uses
    MermaidConfig --> SankeyStyles: uses

    note for SankeyStyles "New styles module added"
    note for GanttStyles "Updated to use fontFamily from options"
    note for UserJourneyStyles "Updated to use fontFamily from options"
Loading

File-Level Changes

Change Details Files
The font-family for the Gantt diagram is now configurable via the mermaid config.
  • Replaced the hardcoded font-family with a variable that is read from the mermaid config.
packages/mermaid/src/diagrams/gantt/styles.js
The font-family for the User Journey diagram is now configurable via the mermaid config.
  • Replaced the hardcoded font-family with a variable that is read from the mermaid config.
packages/mermaid/src/diagrams/user-journey/styles.js
The Sankey diagram now uses a separate styles file and its font-family is configurable via the mermaid config.
  • Created a new styles file for the Sankey diagram.
  • Modified the Sankey diagram to use the new styles file.
  • Removed the hardcoded font-family from the Sankey diagram renderer.
  • Added the font-family variable to the Sankey diagram styles file.
packages/mermaid/src/diagrams/sankey/sankeyDiagram.ts
packages/mermaid/src/diagrams/sankey/sankeyRenderer.ts
packages/mermaid/src/diagrams/sankey/styles.js
Added a changeset to track the changes.
  • Added a changeset file to track the changes.
.changeset/stupid-dots-do.md

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

Copy link

coderabbitai bot commented Jan 21, 2025

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.


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.

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

Successfully merging this pull request may close these issues.

2 participants