Standardize sequence definitions #4795
Draft
+568
−19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
❌ Deploy Preview for mermaid-js failed.
|
Yokozuna59
reviewed
Sep 2, 2023
| @@ -1087,7 +1087,7 @@ export interface SequenceDiagramConfig extends BaseDiagramConfig { | |||
| */ | |||
| diagramMarginX?: number; | |||
| /** | |||
| * Margin to the over and under the sequence diagram | |||
| * Margin to the top and bottom of the sequence diagram | |||
There was a problem hiding this comment.
This is a generated file, please modify the original one: packages/mermaid/src/schemas/config.schema.yaml
There was a problem hiding this comment.
Oop rookie mistake
This allows for a conceptual and type splitting between texts which appear in many places in the diagram (messages, notes, actor descriptions, etc) and messages between participants. I believe it makes more sense to call parseText rather than parseMessage when used in context of working with other components in the diagram which will help with developer experience. A notable change when implementing this is changing all wrap fields in relevant interfaces to optional. This is done so that if left undefined, we will resolt to an autoWrap function which references the diagram config. This will allow for an implementation of a diagram wide default of either wrap or nowrap that's left to the user to decide, instead of a hard-coded default.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| // JSON.parse the text | ||
| try { | ||
| let sanitizedText = sanitizeText(text.text, commonGetConfig()); | ||
| sanitizedText = sanitizedText.replace(/&/g, '&'); |
Check failure
Code scanning / CodeQL
Double escaping or unescaping High
| const links: Record<string, string> = {}; | ||
| let sanitizedText = sanitizeText(text.text, commonGetConfig()); | ||
| const sep = sanitizedText.indexOf('@'); | ||
| sanitizedText = sanitizedText.replace(/&/g, '&'); |
Check failure
Code scanning / CodeQL
Double escaping or unescaping High
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Migrates the Sequence Diagram to Typescript
Resolves #
📏 Design Decisions
Will follow the the guidelines and design choices made in #4501, #4486, and #4499 to maintain cohesiveness across the codebase as much as possible. I will attempt to refactor the code without changing functionality as much as possible. In a scenario where that may not be possible, I will maintain the old code and leave refactoring/optimizing to another issue/ticket.
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch