diff --git a/README.md b/README.md index 0e49ea4da..5852ed763 100644 --- a/README.md +++ b/README.md @@ -21,14 +21,14 @@ Mermaid is a JavaScript based diagramming and charting tool that uses Markdown-i Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning.
-Mermaid addresses this problem by enabling users to create easily modifiable diagrams, it can also be made part of production scripts (and other pieces of code).
+Mermaid addresses this problem by enabling users to create easily modifiable diagrams. It can also be made part of production scripts (and other pieces of code).

Mermaid allows even non-programmers to easily create detailed diagrams through the [Mermaid Live Editor](https://mermaid.live/).
[Tutorials](./docs/Tutorials.md) has video tutorials. Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md). -You can also use Mermaid within [GitHub](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) as well many of your other favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md). +You can also use Mermaid within [GitHub](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) as well many of your other favorite applications—check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md). For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/n00b-overview.md), [Usage](./docs/usage.md) and [Tutorials](./docs/Tutorials.md). @@ -48,7 +48,7 @@ In our release process we rely heavily on visual regression tests using [applito ## Examples -__The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__ +__The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here to jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__ ### Flowchart [docs - live editor] @@ -125,7 +125,7 @@ gantt classDiagram Class01 <|-- AveryLongClass : Cool <> Class01 -Class09 --> C2 : Where am i? +Class09 --> C2 : Where am I? Class09 --* C3 Class09 --|> Class07 Class07 : equals() @@ -143,7 +143,7 @@ class Class10 { classDiagram Class01 <|-- AveryLongClass : Cool <> Class01 -Class09 --> C2 : Where am i? +Class09 --> C2 : Where am I? Class09 --* C3 Class09 --|> Class07 Class07 : equals() diff --git a/README.zh-CN.md b/README.zh-CN.md index 3042304d9..2139541c7 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -106,7 +106,7 @@ gantt classDiagram Class01 <|-- AveryLongClass : Cool <> Class01 -Class09 --> C2 : Where am i? +Class09 --> C2 : Where am I? Class09 --* C3 Class09 --|> Class07 Class07 : equals() @@ -124,7 +124,7 @@ class Class10 { classDiagram Class01 <|-- AveryLongClass : Cool <> Class01 -Class09 --> C2 : Where am i? +Class09 --> C2 : Where am I? Class09 --* C3 Class09 --|> Class07 Class07 : equals() diff --git a/docs/8.6.0_docs.md b/docs/8.6.0_docs.md index 99435b7e8..9a60711b7 100644 --- a/docs/8.6.0_docs.md +++ b/docs/8.6.0_docs.md @@ -31,28 +31,28 @@ The three levels of are Configuration, Global, Site and Current. The modifiable parts of the Configuration are limited by the secure array, which is an array of immutable parameters, this array can be expanded by site owners. -**Notes**: secure arrays work like nesting dolls, with the Global Configurations’ secure array being the default and immutable list of immutable parameters, or the smallest doll, to which site owners may add to, but implementors may not modify it. +**Notes**: secure arrays work like nesting dolls, with the Global Configurations’ secure array holding the default and immutable list of immutable parameters, or the smallest doll, to which site owners may add to, but implementors may not modify it. # Secure Arrays Site owners can add to the **secure** array using this command: mermaidAPI.initialize( { startOnLoad: true, secure: ['parameter1', 'parameter2'] } ); -default values for the `secure array` consists of: ['secure', 'securityLevel', 'startOnLoad', 'maxTextSize']. These default values are immutable. +Default values for the `secure array` consists of: ['secure', 'securityLevel', 'startOnLoad', 'maxTextSize']. These default values are immutable. -Implementors can only modify configurations using directives, but cannot change the `secure` array. +Implementors can only modify configurations using directives, and cannot change the `secure` array. # Modifying Configurations and directives: -The Two types of directives: are `init` or `initialize` and `wrap`. +The Two types of directives: are `init` (or `initialize`) and `wrap`. ```note All directives are enclosed in `%%{ }%%` ``` -Older versions of mermaid will not parse directives because `%%` will comment out the directive. This makes the update backward compatible. +Older versions of mermaid will not parse directives because `%%` will comment out the directive. This makes the update backwards-compatible. # Init -`init`, or `initialize`: the init or initialize directive gives the user the ability to overwrite and change the values for configuration parameters, with respect to the secure array that is in effect. +`init`, or `initialize`: this directive gives the user the ability to overwrite and change the values for any configuration parameters not set in the secure array. | Parameter | Description |Type | Required | Values| | --- | --- | --- | --- | --- | @@ -67,7 +67,7 @@ The json object that is passed as {**argument** } must be valid, quoted json or `%%{init: {"theme": "default", "logLevel": 1 }}%%` -Configurations that are passed through init cannot change the parameters in secure arrays of higher levels. In the event of a conflict, mermaid will give priority to secure arrays and parse the request, without changing the values of the parameters in conflict. +Configurations that are passed through init cannot change the parameters in a secure array at a higher level. In the event of a collision, mermaid will give priority to secure arrays and parse the request without changing the values of those parameters in conflict. When deployed within code, init is called before the graph/diagram description. ``` @@ -93,14 +93,14 @@ When deployed within code, init is called before the graph/diagram description. ```note Wrap is a function that is currently only deployable for sequence diagrams. -wrap respects manually added so if the user wants to break up their text, they have full control over those breaks by adding their own tags. +Wrap respects a manually added , so if the user wants to break up their text, they have full control over line breaks by adding tags. It is a non-argument directive and can be executed thusly: `%%{wrap}%%` . ``` -**an example of text wrapping in a sequence diagram**: +**An example of text wrapping in a sequence diagram**: ![Image showing wrapped text](img/wrapped%20text.png) @@ -108,16 +108,16 @@ It is a non-argument directive and can be executed thusly: # Resetting Configurations: There are two more functions in the mermaidAPI that can be called by site owners: **reset** and **globalReset**. -**reset**: resets the configuration to whatever the last configuration was. This can be done to undo more recent changes to the last mermaidAPI.initialize({...}) configuration. +**reset**: resets the configuration to whatever the last configuration was. This can be done to undo more recent changes set from the last mermaidAPI.initialize({...}) configuration. **globalReset** will reset both the current configuration AND the site configuration back to the global defaults. -**Notes**: both reset and globalReset are only available to site owners, as such implementors would have to edit their configs with init. +**Notes**: Both `reset` and `globalReset` are only available to site owners, and as such implementors have to edit their configs using `init`. # Additional Utils to mermaid -• **memoize**: simple caching for computationally expensive functions. It reduces the rendering time for computationally intensive diagrams by about 90%. +• **memoize**: simple caching for computationally expensive functions, reducing rendering time by about 90%. -• **assignWithDepth** - this is an improvement on previous functions with config.js and Object.assign. The purpose of this function is to provide a sane mechanism for merging objects, similar to object.assign, but with depth. +• **assignWithDepth** - an improvement on previous functions with config.js and `Object.assign`. The purpose of this function is to provide a sane mechanism for merging objects, similar to `object.assign`, but with depth. Example of **assignWithDepth**: @@ -128,9 +128,9 @@ Example of **object.Assign**: ![Image showing object.assign without depth](img/object.assign%20without%20depth.png) -• **calculateTextDimensions, calculateTextWidth,** and **calculateTextHeight** - for measuring text dimensions, width and height. +• **calculateTextDimensions**, **calculateTextWidth**， and **calculateTextHeight** - for measuring text dimensions, width and height. -**Notes**:For more information on usage, parameters, and return info for these new functions take a look at the jsdocs for them in the utils package. +**Notes**: For more information on usage, parameters, and return info for these new functions take a look at the jsdocs for them in the utils package. # New API Requests Introduced in Version 8.6.0 @@ -139,21 +139,21 @@ Example of **object.Assign**: | Function | Description | Type | Values |Parameters|Returns| | --------- | ------------------- | ------- | ------------------ | ------------------ | ------------------ | -| setSiteConfig|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array|conf|siteConfig| +| `setSiteConfig`|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array|conf|siteConfig| ```note Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig) will reset siteConfig and currentConfig to the defaultConfig -Note: currentConfig is set in this function -Default value: At default, will mirror Global Config +Note: currentConfig is set in this function。 +Default value: will mirror Global Config ``` ## getSiteConfig | Function | Description | Type | Values | | --------- | ------------------- | ------- | ------------------ | -| setSiteConfig|Returns the current siteConfig base configuration | Get Request | Returns Any Values in siteConfig| +| `getSiteConfig`|Returns the current `siteConfig` base configuration | Get Request | Returns Any Values in `siteConfig`| ```note Returns any values in siteConfig. @@ -163,7 +163,7 @@ Returns any values in siteConfig. | Function | Description | Type | Values |Parameters|Returns| | --------- | ------------------- | ------- | ------------------ |----------|-------| -| setSiteConfig|Sets the siteConfig to desired values | Put Request| Any Values, those in secure array|conf|currentConfig merged with the sanitized conf| +| `setConfig`|Sets the `currentConfig` to desired values | Put Request| Any Values, those in secure array|conf|`currentConfig` merged with the sanitized conf| ```note Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure keys. Any @@ -175,7 +175,7 @@ siteConfig value. | Function | Description | Type | Return Values | | --------- | ------------------- | ------- | ------------------ | -| getConfig |Obtains the currentConfig | Get Request | Any Values from currentConfig| +| `getConfig` |Obtains the `currentConfig` | Get Request | Any Values from `currentConfig`| ```note @@ -186,7 +186,7 @@ Returns any values in currentConfig. | Function | Description | Type | Values | | --------- | ------------------- | ------- | ------------------ | -| sanitize |Sets the siteConfig to desired values. | Put Request(?) |None| +| `sanitize` |Sets the `siteConfig` to desired values. | Put Request(?) |None| ```note modifies options in-place @@ -197,13 +197,13 @@ Ensures options parameter does not attempt to override siteConfig secure keys. | Function | Description | Type | Required | Values |Parameter| | --------- | -------------------| ------- | -------- | ------------------ |---------| -| reset|Resets currentConfig to conf| Put Request | Required | None| conf| +| `reset`|Resets `currentConfig` to conf| Put Request | Required | None| conf| ## conf | Parameter | Description |Type | Required | Values| | --- | --- | --- | --- | --- | -| conf| base set of values, which currentConfig could be reset to.| Dictionary | Required | Any Values, with respect to the secure Array| +| `conf`| base set of values, which `currentConfig` could be reset to.| Dictionary | Required | Any Values, with respect to the secure Array| ```note default: current siteConfig (optional, default `getSiteConfig()`) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 7b993fd2b..408d1587b 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,6 +1,6 @@ # Change Log -Here is the list of the newest versions in Descending Order, beginning from the latest version. +All changes are in descending order, beginning with the newest (latest) version. ## Unreleased diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 09a0fc022..0a8b44995 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -6,7 +6,7 @@ - 📊 Diagram Syntax - [Flowchart](flowchart.md) - - [Sequence diagram](sequenceDiagram.md) + - [Sequence Diagram](sequenceDiagram.md) - [Class Diagram](classDiagram.md) - [State Diagram](stateDiagram.md) - [Entity Relationship Diagram](entityRelationshipDiagram.md) diff --git a/docs/breakingChanges.md b/docs/breakingChanges.md index 8fadbfb2b..7b94bf442 100644 --- a/docs/breakingChanges.md +++ b/docs/breakingChanges.md @@ -24,7 +24,7 @@ mermaid.initialize({ ## #2 -In old versions you need to add CSS file to your HTML: +In old versions you needed to reference a CSS file in your HTML: ```html @@ -36,9 +36,9 @@ or ``` -Now it is not needed to do so. And there are no more CSS files in distribution files. +Now it is not needed, and there are no more CSS files in the distribution files. -You just +You just: ```javascript mermaid.initialize({ @@ -46,6 +46,4 @@ mermaid.initialize({ }) ``` -and it works like a charm. - -This is because now the CSS is inline with SVG for portability. +and it works like a charm because now the CSS is inline with the SVG to allow simpler portability. diff --git a/docs/classDiagram.md b/docs/classDiagram.md index 8ac8b243b..8bb8f2c40 100644 --- a/docs/classDiagram.md +++ b/docs/classDiagram.md @@ -3,7 +3,7 @@ > "In software engineering, a class diagram in the Unified Modeling Language (UML) is a type of static structure diagram that describes the structure of a system by showing the system's classes, their attributes, operations (or methods), and the relationships among objects." > Wikipedia -The class diagram is the main building block of object-oriented modeling. It is used for general conceptual modeling of the structure of the application, and for detailed modeling translating the models into programming code. Class diagrams can also be used for data modeling. The classes in a class diagram represent both the main elements, interactions in the application, and the classes to be programmed. +The class diagram is the main building block of object-oriented modeling. It is used for general conceptual modeling of the structure of the application, and for detailed modeling to translate the models into programming code. Class diagrams can also be used for data modeling. The classes in a class diagram represent both the main elements, interactions in the application, and the classes to be programmed. Mermaid can render class diagrams. @@ -56,8 +56,8 @@ classDiagram There are two ways to define a class: -- Explicitly defining a class using keyword **class** like `class Animal`. This defines the Animal class -- Define two classes via a **relationship** between them `Vehicle <|-- Car`. This defines two classes Vehicle and Car along with their relationship. +- Explicitly using keyword **class** like `class Animal` which would define the Animal class. +- Via a **relationship** which defines two classes at a time along with their relationship. For instance, `Vehicle <|-- Car`. ```mermaid-example classDiagram @@ -65,13 +65,13 @@ classDiagram Vehicle <|-- Car ``` -Naming convention: a class name should be composed of alphanumeric (unicode allowed) and underscore characters. +Naming convention: a class name should be composed only of alphanumeric characters (including unicode), and underscores. ## Defining Members of a class -UML provides mechanisms to represent class members, such as attributes and methods, and additional information about them. +UML provides mechanisms to represent class members such as attributes and methods, as well as additional information about them. -Mermaid distinguishes between attributes and functions/methods based on if the **parenthesis** `()` are present or not. The ones with `()` are treated as functions/methods, and others as attributes. +Mermaid distinguishes between attributes and functions/methods based on if the **parenthesis** `()` are present or not. The ones with `()` are treated as functions/methods, and all others as attributes. There are two ways to define the members of a class, and regardless of whichever syntax is used to define the members, the output will still be same. The two different ways are : @@ -100,8 +100,7 @@ class BankAccount{ #### Return Type -Optionally you can end the method/function definition with the data type that will be returned (note: there must be a space between the final `)` of the method definition and return type -example: +Optionally you can end a method/function definition with the data type that will be returned (note: there must be a space between the final `)` and the return type). An example: ```mermaid-example classDiagram @@ -115,9 +114,9 @@ class BankAccount{ #### Generic Types -Members can be defined using generic types, such as `List`, for fields, parameters and return types by enclosing the type within `~` (**tilde**). Note: **nested** type declarations (such as `List>`) are not currently supported +Members can be defined using generic types, such as `List`, for fields, parameters, and return types by enclosing the type within `~` (**tilde**). Note: **nested** type declarations such as `List>` are not currently supported. -This can be done as part of either class definition method: +Generics can be represented as part of a class definition and also in the parameters or the return value of a method/function: ```mermaid-example classDiagram @@ -135,26 +134,25 @@ Square : +getMessages() List~string~ #### Return Type -Optionally you can end the method/function definition with the data type that will be returned +Optionally you can end the method/function definition with the data type that will be returned. #### Visibility -To specify the visibility of a class member (i.e. any attribute or method), these notations may be placed before the member's name, but it is optional: +To describe the visibility (or encapsulation) of an attribute or method/function that is a part of a class (i.e. a class member), optional notation may be placed before that members' name: - `+` Public - `-` Private - `#` Protected - `~` Package/Internal -> _note_ you can also include additional _classifiers_ to a method definition by adding the following notations to the end of the method, i.e.: after the `()`: +> _note_ you can also include additional _classifiers_ to a method definition by adding the following notation to the _end_ of the method, i.e.: after the `()`: > - `*` Abstract e.g.: `someAbstractMethod()*` > - `$` Static e.g.: `someStaticMethod()$` -> _note_ you can also include additional _classifiers_ to a field definition by adding the following notations to the end of the field name: +> _note_ you can also include additional _classifiers_ to a field definition by adding the following notation to the end of its name: > - `$` Static e.g.: `String someField$` - ## Defining Relationship A relationship is a general term covering the specific types of logical connections found on class and object diagrams. @@ -163,7 +161,7 @@ A relationship is a general term covering the specific types of logical connecti [classA][Arrow][ClassB] ``` -There are different types of relations defined for classes under UML which are currently supported: +There are eight different types of relations defined for classes under UML which are currently supported: | Type | Description | | ----- | ------------- | @@ -189,7 +187,7 @@ classO .. classP ``` -We can use the labels to describe nature of relation between two classes. Also, arrowheads can be used in opposite directions as well : +We can use the labels to describe the nature of the relation between two classes. Also, arrowheads can be used in the opposite direction as well: ```mermaid-example classDiagram @@ -206,7 +204,7 @@ classO .. classP : Link(Dashed) ### Labels on Relations -It is possible to add a label text to a relation: +It is possible to add label text to a relation: ``` [classA][Arrow][ClassB]:LabelText @@ -221,7 +219,7 @@ classE o-- classF : aggregation ### Two-way relations -Relations can go in multiple ways: +Relations can logically represent an N:M association: ```mmd classDiagram @@ -255,9 +253,9 @@ And `Link` can be one of: ## Cardinality / Multiplicity on relations -Multiplicity or cardinality in class diagrams indicates the number of instances of one class linked to one instance of the other class. For example, one company will have one or more employees, but each employee works for just one company. +Multiplicity or cardinality in class diagrams indicates the number of instances of one class that can be linked to an instance of the other class. For example, each company will have one or more employees (not zero), and each employee currently works for zero or one companies. -Multiplicity notations are placed near the ends of an association. +Multiplicity notations are placed near the end of an association. The different cardinality options are : @@ -269,7 +267,7 @@ The different cardinality options are : - `0..n` zero to n {where n>1} - `1..n` one to n {where n>1} -Cardinality can be easily defined by placing cardinality text within quotes `"` before(optional) and after(optional) a given arrow. +Cardinality can be easily defined by placing the text option within quotes `"` before or after a given arrow. For example: ``` [classA] "cardinality1" [Arrow] "cardinality2" [ClassB]:LabelText @@ -284,16 +282,16 @@ classDiagram ## Annotations on classes -It is possible to annotate classes with a specific marker text which is like meta-data for the class, giving a clear indication about its nature. Some common annotations examples could be: +It is possible to annotate classes with markers to provide additional metadata about the class. This can give a clearer indication about its nature. Some common annotations include: - `<>` To represent an Interface class -- `<>` To represent an abstract class +- `<>` To represent an abstract class - `<>` To represent a service class -- `<>` To represent an enum +- `<>` To represent an enum -Annotations are defined within the opening `<<` and closing `>>`. There are two ways to add an annotation to a class and regardless of the syntax used output will be same. The two ways are : +Annotations are defined within the opening `<<` and closing `>>`. There are two ways to add an annotation to a class, and either way the output will be same: -- In a **_separate line_** after a class is defined. For example: +- In a **_separate line_** after a class is defined: ```mermaid-example classDiagram @@ -303,7 +301,7 @@ Shape : noOfVertices Shape : draw() ``` -- In a **_nested structure_** along with class definition. For example: +- In a **_nested structure_** along with the class definition: ```mermaid-example classDiagram @@ -325,7 +323,7 @@ class Color{ ## Comments -Comments can be entered within a class diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any class diagram syntax +Comments can be entered within a class diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text until the next newline will be treated as a comment, including any class diagram syntax. ```mmd classDiagram @@ -335,12 +333,11 @@ class Shape{ noOfVertices draw() } - ``` ## Setting the direction of the diagram -With class diagrams you can use the direction statement to set the direction which the diagram will render like in this example. +With class diagrams you can use the direction statement to set the direction in which the diagram will render: ```mermaid-example classDiagram @@ -362,7 +359,7 @@ classDiagram ## Interaction -It is possible to bind a click event to a node, the click can lead to either a javascript callback or to a link which will be opened in a new browser tab. **Note**: This functionality is disabled when using `securityLevel='strict'` and enabled when using `securityLevel='loose'`. +It is possible to bind a click event to a node. The click can lead to either a javascript callback or to a link which will be opened in a new browser tab. **Note**: This functionality is disabled when using `securityLevel='strict'` and enabled when using `securityLevel='loose'`. You would define these actions on a separate line after all classes have been declared. @@ -421,7 +418,7 @@ classDiagram > **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2. -Beginners tip, a full example using interactive links in an html context: +Beginner's tip—a full example using interactive links in an HTML page: ```html @@ -469,8 +466,7 @@ Beginners tip, a full example using interactive links in an html context: ### Styling a node -It is possible to apply specific styles such as a thicker border or a different background color to individual nodes. This is done by predefining classes in css styles that can be applied from the graph definition as in the example -below: +It is possible to apply specific styles such as a thicker border or a different background color to individual nodes. This is done by predefining classes in css styles that can be applied from the graph definition: ```html ``` -Then attaching that class to a specific node as per below: +Then attaching that class to a specific node: ``` cssClass "nodeId1" cssClass; @@ -494,7 +490,7 @@ It is also possible to attach a class to a list of nodes in one statement: cssClass "nodeId1,nodeId2" cssClass; ``` -A shorter form of adding a class is to attach the classname to the node using the `:::` operator as per below: +A shorter form of adding a class is to attach the classname to the node using the `:::` operator: ```mmd classDiagram diff --git a/docs/developer-docs/configuration.md b/docs/developer-docs/configuration.md index 9a41a2ecf..300df178d 100644 --- a/docs/developer-docs/configuration.md +++ b/docs/developer-docs/configuration.md @@ -1,10 +1,10 @@ # Configuration -When mermaid starts configuration is extracted to a configuration to be used for a diagram. There are 3 sources for configuration: +When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration: * The default configuration -* Overrides on the site level is set by the initialize call and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**. -* Directives - diagram authors can update select configuration parameters directly in the diagram code via directives and these are applied to the render config. +* Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**. +* Directives - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config. **The render config** is configuration that is used when rendering by applying these configurations. @@ -21,8 +21,8 @@ sequenceDiagram ## Initialize -Initialize call is called **only once**. It is called by the site integrator in order to override the default configuration on a site level. +The initialize call is applied **only once**. It is called by the site integrator in order to override the default configuration at a site level. ## configApi.reset -This method resets the configuration for a diagram to the site configuration, the configuration provided by the site integrator. Before each rendering of a diagram reset is called in the very beginning of render. +This method resets the configuration for a diagram to the overall site configuration, which is the configuration provided by the site integrator. Before each rendering of a diagram, reset is called at the very beginning. diff --git a/docs/diagrams-and-syntax-and-examples/flowchart.md b/docs/diagrams-and-syntax-and-examples/flowchart.md index fd8427eda..a33927803 100644 --- a/docs/diagrams-and-syntax-and-examples/flowchart.md +++ b/docs/diagrams-and-syntax-and-examples/flowchart.md @@ -7,16 +7,14 @@ title: Flowchart ## Graph -This statement declares the direction of the Flowchart. - -This declares the graph is oriented from top to bottom (`TD` or `TB`). +This statement declares the direction of the flowchart, either from top to bottom (`TD` or `TB`): ```mermaid-example graph TD Start --> Stop ``` -This declares the graph is oriented from left to right (`LR`). +or left to right (`LR`): ```mermaid-example graph LR @@ -28,22 +26,21 @@ graph LR Possible FlowChart orientations are: * TB - top to bottom -* TD - top-down/ same as top to bottom +* TD - top-down (same as top to bottom) * BT - bottom to top * RL - right to left * LR - left to right - ## Flowcharts This renders a flowchart that allows for features such as: more arrow types, multi directional arrows, and linking to and from subgraphs. -Apart from the graph type, the syntax is the same. This is currently experimental but when the beta period is over, both the graph and flowchart keywords will render in the new way. This means it is ok to start beta testing flowcharts. +Apart from the graph type, the syntax is the same. This is currently experimental. When the beta period is over, both the graph and flowchart keywords will render in this new way. At this point it is OK to start beta testing flowcharts. > **Important note** Do not type the word "end" as a Flowchart node. Capitalize all or any one the letters to keep the flowchart from breaking, i.e, "End" or "END". Or you can apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897).** -## Nodes & shapes +## Nodes and shapes ### A node (default) @@ -56,9 +53,9 @@ graph LR ### A node with text -It is also possible to set text in the box that differs from the id. If this is done several times, it is the last text -found for the node that will be used. Also if you define edges for the node later on, you can omit text definitions. The -one previously defined will be used when rendering the box. +It is also possible to set text in the box that differs from the id. If this is done several times, only the last text +found for the node will be rendered. Also if you define edges for the node later on, you can omit text definitions. The +text previously defined will be used when rendering the box. ```mermaid-example graph LR @@ -108,7 +105,7 @@ graph LR graph LR id1>This is the text in the box] ``` -Currently only the shape above is possible and not its mirror. *This might change with future releases.* +Currently it is only possible to render the shape above, and not its mirror. *This might change with future releases.* ### A node (rhombus) @@ -117,7 +114,7 @@ graph LR id1{This is the text in the box} ``` -### A hexagon node +### A hexagonal node ```mermaid-example graph LR @@ -152,16 +149,16 @@ graph TD ## Links between nodes -Nodes can be connected with links/edges. It is possible to have different types of links or attach a text string to a link. +Nodes can be connected with links/edges. It is possible to have different types of links, or attach a text string on a link. -### A link with arrow head +### Link with arrow head ```mermaid-example graph LR A-->B ``` -### An open link +### Open link ```mermaid-example graph LR @@ -182,7 +179,7 @@ graph LR A---|This is the text|B ``` -### A link with arrow head and text +### Link with arrow head and text ```mermaid-example graph LR @@ -226,7 +223,7 @@ graph LR ### Chaining of links -It is possible to declare many links in the same line as per below: +It is possible to declare many links on the same line as per below: ```mermaid-example graph LR A -- text --> B -- text2 --> C @@ -243,10 +240,7 @@ You can then describe dependencies in a very expressive way. Like the one-liner graph TB A & B--> C & D ``` -If you describe the same diagram using the the basic syntax, it will take four lines. A -word of warning, one could go overboard with this making the graph harder to read in -markdown form. The Swedish word `lagom` comes to mind. It means, not too much and not too little. -This goes for expressive syntaxes as well. +If you describe the same diagram using the the basic syntax, it will take four lines: ```mmd graph TB A --> C @@ -254,6 +248,9 @@ graph TB B --> C B --> D ``` +A word of warning, one could go overboard with this, making the graph harder to read in +markdown form. The Swedish word `lagom` comes to mind. It means, not too much and not too little. +This goes for expressive syntaxes as well. ### New arrow types @@ -265,7 +262,6 @@ flowchart LR B --x C ``` - ### Multi directional arrows When using flowchart instead of graph there is the possibility to use multidirectional arrows. @@ -297,8 +293,8 @@ graph TD B ---->|No| E[End]; ``` -> **Note** Links may still be made longer than the requested number of ranks -> by the rendering engine to accommodate other requests. +> **Note** The rendering engine may cause some links to be longer than +> the number of ranks requested in order to accommodate the overall topology. When the link label is written in the middle of the link, the extra dashes must be added on the right side of the link. The following example is equivalent to @@ -327,7 +323,7 @@ as summed up in the following table: ## Special characters that break syntax -It is possible to put text within quotes in order to render more troublesome characters. As in the example below: +Use quotes around text in order to render more troublesome characters, as in the example below: ```mermaid-example graph LR @@ -336,7 +332,7 @@ graph LR ### Entity codes to escape characters -It is possible to escape characters using the syntax exemplified here. +Special characters (including Unicode) can be included by using HTML escaping syntax: ```mermaid-example graph LR @@ -351,7 +347,7 @@ subgraph title end ``` -An example below: +An example: ```mermaid-example graph TB @@ -367,7 +363,7 @@ graph TB end ``` - You can also set an explicit id for the subgraph. +You can also set an explicit id for the subgraph: ```mermaid-example graph TB @@ -377,9 +373,9 @@ graph TB end ``` -## flowcharts +## Flowcharts -With the graphtype flowchart it is also possible to set edges to and from subgraphs as in the graph below. +With the graphtype `flowchart` it is also possible to set edges to and from subgraphs: ```mermaid-example flowchart TB @@ -400,7 +396,7 @@ flowchart TB ## Interaction -It is possible to bind a click event to a node, the click can lead to either a JavaScript callback or to a link which will be opened in a new browser tab. **Note**: This functionality is disabled when using `securityLevel='strict'` and enabled when using `securityLevel='loose'`. +A node can have click events bound that lead to either a JavaScript callback or to open a new browser tab. **Note**: This functionality is disabled when using `securityLevel='strict'` and enabled when using `securityLevel='loose'`. ``` click nodeId callback @@ -408,18 +404,18 @@ click nodeId call callback() ``` * nodeId is the id of the node -* callback is the name of a JavaScript function defined on the page displaying the graph, the function will be called with the nodeId as parameter. - -Examples of tooltip usage below: +* `callback` is the name of a JavaScript function defined on the page displaying the graph. The function will be called with the nodeId as an incoming parameter. ```html ``` +Examples of tooltip usage: + The tooltip text is surrounded in double quotes. The styles of the tooltip are set by the class .mermaidTooltip. ```mermaid-example @@ -449,7 +445,7 @@ graph LR; click D href "https://www.github.com" "Open this in a new tab" _blank ``` -Beginners tip, a full example using interactive links in a html context: +Beginner's tip—here's a full example of using interactive links in HTML: ```html @@ -484,7 +480,7 @@ Beginners tip, a full example using interactive links in a html context: ### Comments -Comments can be entered within a flow diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any flow syntax +Comments can be entered within a flow diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text until the next newline will be treated as a comment, including all punctuation and any flow syntax. ```mmd graph LR @@ -496,16 +492,15 @@ graph LR ### Styling links -It is possible to style links. For instance you might want to style a link that is going backwards in the flow. As links -have no ids in the same way as nodes, some other way of deciding what style the links should be attached to is required. -Instead of ids, the order number of when the link was defined in the graph is used. In the example below the style -defined in the linkStyle statement will belong to the fourth link in the graph: +It is possible to style links. For instance, you might want to style a link that is going backwards in the flow. As links +have no ids in the same way as nodes, some other way of attaching style is required. +So instead of ids, the order number of when the link was defined in the graph is used, starting with zero. Here's a linkStyle statement that would apply style to the fourth link in the graph: ``` linkStyle 3 stroke:#ff3,stroke-width:4px,color:red; ``` -You can specify default to apply to all links, or you can give a list of link order numbers separated by a comma. +You can specify a `default` to apply to all links, or you can give a comma-separated list of link order numbers. Instead of giving a styles option, you can also use custom d3 curve types with the following syntax: @@ -513,14 +508,14 @@ Instead of giving a styles option, you can also use custom d3 curve types with t linkStyle default|numList|num interpolate curveType ``` -If you want to add style options too, instead of writing: +If you want to add both D3 and style options, instead of writing: ``` linkStyle default interpolate cardinal linkStyle default stroke:#ff3,stroke-width:4px,color:red; ``` -You can combine them into: +You can combine them: ``` linkStyle default interpolate cardinal stroke:#ff3,stroke-width:4px,color:red; @@ -540,29 +535,27 @@ graph LR #### Classes -More convenient then defining the style every time is to define a class of styles and attach this class to the nodes that -should have a different look. - -a class definition looks like the example below: +More convenient than defining the style every time is to define a class of styles and attach this class reference to multiple nodes. +here's a class definition: ``` classDef className fill:#f9f,stroke:#333,stroke-width:4px; ``` -Attachment of a class to a node is done as per below: +and then attaching this class to a node is simply: ``` class nodeId1 className; ``` -It is also possible to attach a class to a list of nodes in one statement: +It is also possible to attach a class to multiple nodes in one statement: ``` class nodeId1,nodeId2 className; ``` -A shorter form of adding a class is to attach the classname to the node using the `:::`operator as per below: +An even shorter form of adding a class is to attach the classname to the node using the `:::`operator: ```mermaid-example graph LR @@ -573,8 +566,7 @@ graph LR ### Css classes -It is also possible to predefine classes in css styles that can be applied from the graph definition as in the example -below: +It is also possible to predefine classes in css styles that can be applied from the graph definition: **Example style** @@ -598,7 +590,7 @@ graph LR; ### Default class -If a class is named default it will be assigned to all classes without specific class definitions. +If a class is named `default` it will be assigned to all nodes that do not have a specific class definition. ``` classDef default fill:#f9f,stroke:#333,stroke-width:4px; @@ -607,9 +599,7 @@ If a class is named default it will be assigned to all classes without specific ## Basic support for fontawesome -It is possible to add icons from fontawesome. - -The icons are accessed via the syntax fa:#icon class name#. +It is possible to add icons from fontawesome. These are accessed via the syntax fa:#icon-class-name#. ```mermaid-example graph TD @@ -622,11 +612,11 @@ graph TD ## Graph declarations with spaces between vertices and link and without semicolon -* In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph. +* After release 0.2.16, graph declaration statements do not need to end with a semicolon. (And they can continue to have the ending semicolon—it has now just become optional.) So the below graph declaration is valid along with the old declarations. -* A single space is allowed between vertices and the link. However there should not be any space between a vertex and its text and a link and its text. The old syntax of graph declaration will also work and hence this new feature is optional and is introduce to improve readability. +* A single space is allowed between vertices and the link, however there should not be any space between a vertex and its text, or a link and its text. The old syntax of graph declarations will also work, so this new feature is optional and is introduced to improve readability. -Below is the new declaration of the graph edges which is also valid along with the old declaration of the graph edges. +Below is an example of the new way to declare graph edges. This is valid alongside any old-style declarations of graph edges. ```mermaid-example graph LR @@ -641,9 +631,8 @@ graph LR Is it possible to adjust the width of the rendered flowchart. -This is done by defining **mermaid.flowchartConfig** or by the CLI to use a json file with the configuration. How to use -the CLI is described in the mermaidCLI page. -mermaid.flowchartConfig can be set to a JSON string with config parameters or the corresponding object. +This is done by defining **mermaid.flowchartConfig**, or by the CLI to use a json file with the configuration (which is described in the mermaidCLI page). +In Javascript config parameters can be set by using `mermaid.flowchartConfig`: ```javascript mermaid.flowchartConfig = { diff --git a/docs/flowchart.md b/docs/flowchart.md index dfa9a1af6..7631a7f46 100644 --- a/docs/flowchart.md +++ b/docs/flowchart.md @@ -471,7 +471,7 @@ flowchart LR click D href "https://www.github.com" "Open this in a new tab" _blank ``` -Beginners tip, a full example using interactive links in a html context: +Beginner's tip—a full example using interactive links in a html context: ```html
@@ -513,7 +513,7 @@ flowchart LR ### Styling links -It is possible to style links. For instance you might want to style a link that is going backwards in the flow. As links +It is possible to style links. For instance, you might want to style a link that is going backwards in the flow. As links have no ids in the same way as nodes, some other way of deciding what style the links should be attached to is required. Instead of ids, the order number of when the link was defined in the graph is used, or use default to apply to all links. In the example below the style defined in the linkStyle statement will belong to the fourth link in the graph: diff --git a/docs/gantt.md b/docs/gantt.md index 2dca82325..0207412c0 100644 --- a/docs/gantt.md +++ b/docs/gantt.md @@ -313,7 +313,7 @@ click taskId href URL * taskId is the id of the task * callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the taskId as the parameter if no other arguments are specified. -Beginners tip, a full example using interactive links in an html context: +Beginner's tip—a full example using interactive links in an html context: ```html
diff --git a/docs/n00b-syntaxReference.md b/docs/n00b-syntaxReference.md index 9cd9a9025..d10918be2 100644 --- a/docs/n00b-syntaxReference.md +++ b/docs/n00b-syntaxReference.md @@ -8,7 +8,7 @@ Diagram Examples can be found in the [Mermaid Live Editor](https://mermaid-js.gi ## Syntax Structure One would notice that all **Diagrams definitions begin** with a declaration of the **diagram type**, followed by the definitions of the diagram and its contents. This declaration notifies the parser which kind of diagram the code is supposed to generate. -**Example** : The code below is for an Entity Relationship Diagram, specified by the `erDiagram` declaration. What follows is the definition of the different `Entities` represented in it. +**Example** : The code below is for an Entity Relationship Diagram, specified by the `erDiagram` declaration. What follows is the definition of the different `Entities` represented in it. ```mermaid-example erDiagram diff --git a/docs/theming.md b/docs/theming.md index e64432445..d61f02bdc 100644 --- a/docs/theming.md +++ b/docs/theming.md @@ -64,7 +64,7 @@ Here is an example of how `%%init%%` can set the theme to 'base', this assumes t ``` # List of Themes -# Customizing Themes with `themeVariables` +# Customizing Themes with `themeVariables` The easiest way to make a custom theme is to start with the base theme, and just modify theme variables through `themeVariables`, via `%%init%%`. diff --git a/src/dagre-wrapper/mermaid-graphlib.spec.js b/src/dagre-wrapper/mermaid-graphlib.spec.js index 2c502cbc3..8155bbf70 100644 --- a/src/dagre-wrapper/mermaid-graphlib.spec.js +++ b/src/dagre-wrapper/mermaid-graphlib.spec.js @@ -471,7 +471,7 @@ describe('sortNodesByHierarchy', function () { return {}; }); }); - it('it should sort proper en nodes are in reverse order', function () { + it('should sort proper en nodes are in reverse order', function () { /* a -->b subgraph B @@ -488,7 +488,7 @@ describe('sortNodesByHierarchy', function () { g.setEdge('a', 'b', '1'); expect(sortNodesByHierarchy(g)).toEqual(['a', 'A', 'B', 'b']); }); - it('it should sort proper en nodes are in correct order', function () { + it('should sort proper en nodes are in correct order', function () { /* a -->b subgraph B diff --git a/src/diagrams/flowchart/parser/flow-interactions.spec.js b/src/diagrams/flowchart/parser/flow-interactions.spec.js index 8efffc62c..34125b153 100644 --- a/src/diagrams/flowchart/parser/flow-interactions.spec.js +++ b/src/diagrams/flowchart/parser/flow-interactions.spec.js @@ -14,7 +14,7 @@ describe('[Interactions] when parsing', () => { flow.parser.yy.clear(); }); - it('it should be possible to use click to a callback', function () { + it('should be possible to use click to a callback', function () { spyOn(flowDb, 'setClickEvent'); const res = flow.parser.parse('graph TD\nA-->B\nclick A callback'); @@ -24,7 +24,7 @@ describe('[Interactions] when parsing', () => { expect(flowDb.setClickEvent).toHaveBeenCalledWith('A', 'callback'); }); - it('it should be possible to use click to a click and call callback', function () { + it('should be possible to use click to a click and call callback', function () { spyOn(flowDb, 'setClickEvent'); const res = flow.parser.parse('graph TD\nA-->B\nclick A call callback()'); @@ -34,7 +34,7 @@ describe('[Interactions] when parsing', () => { expect(flowDb.setClickEvent).toHaveBeenCalledWith('A', 'callback'); }); - it('it should be possible to use click to a callback with toolip', function () { + it('should be possible to use click to a callback with toolip', function () { spyOn(flowDb, 'setClickEvent'); spyOn(flowDb, 'setTooltip'); const res = flow.parser.parse('graph TD\nA-->B\nclick A callback "tooltip"'); @@ -46,7 +46,7 @@ describe('[Interactions] when parsing', () => { expect(flowDb.setTooltip).toHaveBeenCalledWith('A', 'tooltip'); }); - it('it should be possible to use click to a click and call callback with toolip', function () { + it('should be possible to use click to a click and call callback with toolip', function () { spyOn(flowDb, 'setClickEvent'); spyOn(flowDb, 'setTooltip'); const res = flow.parser.parse('graph TD\nA-->B\nclick A call callback() "tooltip"'); @@ -58,7 +58,7 @@ describe('[Interactions] when parsing', () => { expect(flowDb.setTooltip).toHaveBeenCalledWith('A', 'tooltip'); }); - it('it should be possible to use click to a callback with an arbitrary number of args', function () { + it('should be possible to use click to a callback with an arbitrary number of args', function () { spyOn(flowDb, 'setClickEvent'); const res = flow.parser.parse('graph TD\nA-->B\nclick A call callback("test0", test1, test2)'); diff --git a/src/diagrams/flowchart/parser/flow-lines.spec.js b/src/diagrams/flowchart/parser/flow-lines.spec.js index 9de243556..0fd1e9e9c 100644 --- a/src/diagrams/flowchart/parser/flow-lines.spec.js +++ b/src/diagrams/flowchart/parser/flow-lines.spec.js @@ -89,7 +89,7 @@ describe('[Lines] when parsing', () => { }); describe('it should handle new line type notation', function () { - it('it should handle regular lines', function () { + it('should handle regular lines', function () { const res = flow.parser.parse('graph TD;A-->B;'); const vert = flow.parser.yy.getVertices(); @@ -98,7 +98,7 @@ describe('[Lines] when parsing', () => { expect(edges[0].stroke).toBe('normal'); }); - it('it should handle dotted lines', function () { + it('should handle dotted lines', function () { const res = flow.parser.parse('graph TD;A-.->B;'); const vert = flow.parser.yy.getVertices(); @@ -107,7 +107,7 @@ describe('[Lines] when parsing', () => { expect(edges[0].stroke).toBe('dotted'); }); - it('it should handle dotted lines', function () { + it('should handle dotted lines', function () { const res = flow.parser.parse('graph TD;A==>B;'); const vert = flow.parser.yy.getVertices(); diff --git a/src/diagrams/flowchart/parser/flow-text.spec.js b/src/diagrams/flowchart/parser/flow-text.spec.js index 41dc9d509..7e0186399 100644 --- a/src/diagrams/flowchart/parser/flow-text.spec.js +++ b/src/diagrams/flowchart/parser/flow-text.spec.js @@ -13,7 +13,7 @@ describe('[Text] when parsing', () => { }); describe('it should handle text on edges', function () { - it('it should handle text without space', function () { + it('should handle text without space', function () { const res = flow.parser.parse('graph TD;A--x|textNoSpace|B;'); const vert = flow.parser.yy.getVertices(); @@ -22,7 +22,7 @@ describe('[Text] when parsing', () => { expect(edges[0].type).toBe('arrow_cross'); }); - it('should handle with space', function () { + it('should handle with space', function () { const res = flow.parser.parse('graph TD;A--x|text including space|B;'); const vert = flow.parser.yy.getVertices(); @@ -31,7 +31,7 @@ describe('[Text] when parsing', () => { expect(edges[0].type).toBe('arrow_cross'); }); - it('it should handle text with /', function () { + it('should handle text with /', function () { const res = flow.parser.parse('graph TD;A--x|text with / should work|B;'); const vert = flow.parser.yy.getVertices(); @@ -40,7 +40,7 @@ describe('[Text] when parsing', () => { expect(edges[0].text).toBe('text with / should work'); }); - it('it should handle space and space between vertices and link', function () { + it('should handle space and space between vertices and link', function () { const res = flow.parser.parse('graph TD;A --x|textNoSpace| B;'); const vert = flow.parser.yy.getVertices(); @@ -174,7 +174,7 @@ describe('[Text] when parsing', () => { }); describe('it should handle text on lines', () => { - it('it should handle normal text on lines', function () { + it('should handle normal text on lines', function () { const res = flow.parser.parse('graph TD;A-- test text with == -->B;'); const vert = flow.parser.yy.getVertices(); @@ -182,7 +182,7 @@ describe('[Text] when parsing', () => { expect(edges[0].stroke).toBe('normal'); }); - it('it should handle dotted text on lines (TD3)', function () { + it('should handle dotted text on lines (TD3)', function () { const res = flow.parser.parse('graph TD;A-. test text with == .->B;'); const vert = flow.parser.yy.getVertices(); @@ -190,7 +190,7 @@ describe('[Text] when parsing', () => { expect(edges[0].stroke).toBe('dotted'); }); - it('it should handle thick text on lines', function () { + it('should handle thick text on lines', function () { const res = flow.parser.parse('graph TD;A== test text with - ==>B;'); const vert = flow.parser.yy.getVertices(); @@ -201,7 +201,7 @@ describe('[Text] when parsing', () => { }); describe('it should handle text on edges using the new notation', function () { - it('it should handle text without space', function () { + it('should handle text without space', function () { const res = flow.parser.parse('graph TD;A-- textNoSpace --xB;'); const vert = flow.parser.yy.getVertices(); @@ -210,7 +210,7 @@ describe('[Text] when parsing', () => { expect(edges[0].type).toBe('arrow_cross'); }); - it('it should handle text with multiple leading space', function () { + it('should handle text with multiple leading space', function () { const res = flow.parser.parse('graph TD;A-- textNoSpace --xB;'); const vert = flow.parser.yy.getVertices(); @@ -219,7 +219,7 @@ describe('[Text] when parsing', () => { expect(edges[0].type).toBe('arrow_cross'); }); - it('should handle with space', function () { + it('should handle with space', function () { const res = flow.parser.parse('graph TD;A-- text including space --xB;'); const vert = flow.parser.yy.getVertices(); @@ -228,7 +228,7 @@ describe('[Text] when parsing', () => { expect(edges[0].type).toBe('arrow_cross'); }); - it('it should handle text with /', function () { + it('should handle text with /', function () { const res = flow.parser.parse('graph TD;A -- text with / should work --x B;'); const vert = flow.parser.yy.getVertices(); @@ -237,7 +237,7 @@ describe('[Text] when parsing', () => { expect(edges[0].text).toBe('text with / should work'); }); - it('it should handle space and space between vertices and link', function () { + it('should handle space and space between vertices and link', function () { const res = flow.parser.parse('graph TD;A -- textNoSpace --x B;'); const vert = flow.parser.yy.getVertices(); @@ -302,7 +302,7 @@ describe('[Text] when parsing', () => { }); describe('it should handle text in vertices, ', function () { - it('it should handle space', function () { + it('should handle space', function () { const res = flow.parser.parse('graph TD;A-->C(Chimpansen hoppar);'); const vert = flow.parser.yy.getVertices(); @@ -311,7 +311,7 @@ describe('[Text] when parsing', () => { expect(vert['C'].type).toBe('round'); expect(vert['C'].text).toBe('Chimpansen hoppar'); }); - it('it should handle åäö and minus', function () { + it('should handle åäö and minus', function () { const res = flow.parser.parse('graph TD;A-->C{Chimpansen hoppar åäö-ÅÄÖ};'); const vert = flow.parser.yy.getVertices(); @@ -321,7 +321,7 @@ describe('[Text] when parsing', () => { expect(vert['C'].text).toBe('Chimpansen hoppar åäö-ÅÄÖ'); }); - it('it should handle with åäö, minus and space and br', function () { + it('should handle with åäö, minus and space and br', function () { const res = flow.parser.parse('graph TD;A-->C(Chimpansen hoppar åäö
- ÅÄÖ);'); const vert = flow.parser.yy.getVertices(); @@ -330,7 +330,7 @@ describe('[Text] when parsing', () => { expect(vert['C'].type).toBe('round'); expect(vert['C'].text).toBe('Chimpansen hoppar åäö
- ÅÄÖ'); }); - // xit('it should handle åäö, minus and space and br',function(){ + // xit('should handle åäö, minus and space and br',function(){ // const res = flow.parser.parse('graph TD; A[Object(foo,bar)]-->B(Thing);'); // // const vert = flow.parser.yy.getVertices(); @@ -339,21 +339,21 @@ describe('[Text] when parsing', () => { // expect(vert['C'].type).toBe('round'); // expect(vert['C'].text).toBe(' A[Object(foo,bar)]-->B(Thing);'); // }); - it('it should handle unicode chars', function () { + it('should handle unicode chars', function () { const res = flow.parser.parse('graph TD;A-->C(Начало);'); const vert = flow.parser.yy.getVertices(); expect(vert['C'].text).toBe('Начало'); }); - it('it should handle backslask', function () { + it('should handle backslask', function () { const res = flow.parser.parse('graph TD;A-->C(c:\\windows);'); const vert = flow.parser.yy.getVertices(); expect(vert['C'].text).toBe('c:\\windows'); }); - it('it should handle CAPS', function () { + it('should handle CAPS', function () { const res = flow.parser.parse('graph TD;A-->C(some CAPS);'); const vert = flow.parser.yy.getVertices(); @@ -362,7 +362,7 @@ describe('[Text] when parsing', () => { expect(vert['C'].type).toBe('round'); expect(vert['C'].text).toBe('some CAPS'); }); - it('it should handle directions', function () { + it('should handle directions', function () { const res = flow.parser.parse('graph TD;A-->C(some URL);'); const vert = flow.parser.yy.getVertices(); diff --git a/src/diagrams/git/gitGraphParser.spec b/src/diagrams/git/gitGraphParser.spec index 90e692d50..0a8256c5b 100644 --- a/src/diagrams/git/gitGraphParser.spec +++ b/src/diagrams/git/gitGraphParser.spec @@ -115,7 +115,7 @@ describe('when parsing a gitGraph', function() { expect(parser.yy.getCurrentBranch()).toBe('master'); }); - it('it should reset a branch', function() { + it('should reset a branch', function() { const str = 'gitGraph:\n' + 'commit\n' + @@ -153,7 +153,7 @@ describe('when parsing a gitGraph', function() { expect(parser.yy.getHead().id).toEqual(master.parent); }); - it('it should handle fast forwardable merges', function() { + it('should handle fast forwardable merges', function() { const str = 'gitGraph:\n' + 'commit\n' + @@ -173,7 +173,7 @@ describe('when parsing a gitGraph', function() { expect(parser.yy.getHead().id).toEqual(parser.yy.getBranches()['newbranch']); }); - it('it should handle cases when merge is a noop', function() { + it('should handle cases when merge is a noop', function() { const str = 'gitGraph:\n' + 'commit\n' + @@ -192,7 +192,7 @@ describe('when parsing a gitGraph', function() { expect(parser.yy.getHead().id).toEqual(parser.yy.getBranches()['newbranch']); }); - it('it should handle merge with 2 parents', function() { + it('should handle merge with 2 parents', function() { const str = 'gitGraph:\n' + 'commit\n' + @@ -213,7 +213,7 @@ describe('when parsing a gitGraph', function() { expect(parser.yy.getHead().id).toEqual(parser.yy.getBranches()['master']); }); - it('it should handle ff merge when history walk has two parents (merge commit)', function() { + it('should handle ff merge when history walk has two parents (merge commit)', function() { const str = 'gitGraph:\n' + 'commit\n' + @@ -239,7 +239,7 @@ describe('when parsing a gitGraph', function() { parser.yy.prettyPrint(); }); - it('it should generate a secure random ID for commits', function() { + it('should generate a secure random ID for commits', function() { const str = 'gitGraph:\n' + 'commit\n' + 'commit\n'; const EXPECTED_LENGTH = 7; const EXPECTED_CHARACTERS = '0123456789abcdef'; @@ -267,7 +267,7 @@ describe('when parsing a gitGraph', function() { }); }); - it('it should generate an array of known branches', function() { + it('should generate an array of known branches', function() { const str = 'gitGraph:\n' + 'commit\n' + diff --git a/src/diagrams/sequence/sequenceDiagram.spec.js b/src/diagrams/sequence/sequenceDiagram.spec.js index 0ee00135d..808eb567e 100644 --- a/src/diagrams/sequence/sequenceDiagram.spec.js +++ b/src/diagrams/sequence/sequenceDiagram.spec.js @@ -126,7 +126,7 @@ Bob-->Alice: I am good thanks!`; expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should not show sequence numbers per default', function () { + it('should not show sequence numbers per default', function () { const str = ` sequenceDiagram Alice->Bob:Hello Bob, how are you? @@ -137,7 +137,7 @@ Bob-->Alice: I am good thanks!`; diagram.renderer.draw(str, 'tst', '1.2.3', diagram); // needs to be rendered for the correct value of visibility autonumbers expect(diagram.db.showSequenceNumbers()).toBe(false); }); - it('it should show sequence numbers when autonumber is enabled', function () { + it('should show sequence numbers when autonumber is enabled', function () { const str = ` sequenceDiagram autonumber @@ -149,7 +149,7 @@ Bob-->Alice: I am good thanks!`; diagram.renderer.draw(str, 'tst', '1.2.3', diagram); // needs to be rendered for the correct value of visibility autonumbers expect(diagram.db.showSequenceNumbers()).toBe(true); }); - it('it should handle a sequenceDiagram definition with a title:', function () { + it('should handle a sequenceDiagram definition with a title:', function () { const str = ` sequenceDiagram title: Diagram Title @@ -172,7 +172,7 @@ Bob-->Alice: I am good thanks!`; expect(title).toBe('Diagram Title'); }); - it('it should handle a sequenceDiagram definition with a title without a :', function () { + it('should handle a sequenceDiagram definition with a title without a :', function () { const str = ` sequenceDiagram title Diagram Title @@ -195,7 +195,7 @@ Bob-->Alice: I am good thanks!`; expect(title).toBe('Diagram Title'); }); - it('it should handle a sequenceDiagram definition with a accessibility title and description (accDescr)', function () { + it('should handle a sequenceDiagram definition with a accessibility title and description (accDescr)', function () { const str = ` sequenceDiagram title: Diagram Title @@ -210,7 +210,7 @@ Alice->Bob:Hello Bob, how are you? expect(diagram.db.getAccDescription()).toBe('Accessibility Description'); const messages = diagram.db.getMessages(); }); - it('it should handle a sequenceDiagram definition with a accessibility title and multiline description (accDescr)', function () { + it('should handle a sequenceDiagram definition with a accessibility title and multiline description (accDescr)', function () { const str = ` sequenceDiagram accTitle: This is the title @@ -227,7 +227,7 @@ Alice->Bob:Hello Bob, how are you? const messages = diagram.db.getMessages(); }); - it('it should space in actor names', function () { + it('should space in actor names', function () { const str = ` sequenceDiagram Alice->Bob:Hello Bob, how are - you? @@ -244,7 +244,7 @@ Bob-->Alice: I am good thanks!`; expect(messages[0].from).toBe('Alice'); expect(messages[1].from).toBe('Bob'); }); - it('it should handle dashes in actor names', function () { + it('should handle dashes in actor names', function () { const str = ` sequenceDiagram Alice-in-Wonderland->Bob:Hello Bob, how are - you? @@ -261,7 +261,7 @@ Bob-->Alice-in-Wonderland:I am good thanks!`; expect(messages[0].from).toBe('Alice-in-Wonderland'); expect(messages[1].from).toBe('Bob'); }); - it('it should alias participants', function () { + it('should alias participants', function () { const str = ` sequenceDiagram participant A as Alice @@ -282,7 +282,7 @@ B-->A: I am good thanks!`; expect(messages[0].from).toBe('A'); expect(messages[1].from).toBe('B'); }); - it('it should alias a mix of actors and participants apa12', function () { + it('should alias a mix of actors and participants apa12', function () { const str = ` sequenceDiagram actor Alice as Alice2 @@ -310,7 +310,7 @@ sequenceDiagram expect(messages[0].from).toBe('Alice'); expect(messages[4].to).toBe('Joan'); }); - it('it should alias actors apa13', function () { + it('should alias actors apa13', function () { const str = ` sequenceDiagram actor A as Alice @@ -330,7 +330,7 @@ B-->A: I am good thanks!`; expect(messages[0].from).toBe('A'); expect(messages[1].from).toBe('B'); }); - it('it should handle in async messages', function () { + it('should handle in async messages', function () { const str = ` sequenceDiagram Alice-xBob:Hello Bob, how are you?`; @@ -345,7 +345,7 @@ Alice-xBob:Hello Bob, how are you?`; expect(messages.length).toBe(1); expect(messages[0].type).toBe(diagram.db.LINETYPE.SOLID_CROSS); }); - it('it should handle in async dotted messages', function () { + it('should handle in async dotted messages', function () { const str = ` sequenceDiagram Alice--xBob:Hello Bob, how are you?`; @@ -360,7 +360,7 @@ Alice--xBob:Hello Bob, how are you?`; expect(messages.length).toBe(1); expect(messages[0].type).toBe(diagram.db.LINETYPE.DOTTED_CROSS); }); - it('it should handle in sync messages', function () { + it('should handle in sync messages', function () { const str = ` sequenceDiagram Alice-)Bob:Hello Bob, how are you?`; @@ -375,7 +375,7 @@ Alice-)Bob:Hello Bob, how are you?`; expect(messages.length).toBe(1); expect(messages[0].type).toBe(diagram.db.LINETYPE.SOLID_POINT); }); - it('it should handle in sync dotted messages', function () { + it('should handle in sync dotted messages', function () { const str = ` sequenceDiagram Alice--)Bob:Hello Bob, how are you?`; @@ -390,7 +390,7 @@ Alice--)Bob:Hello Bob, how are you?`; expect(messages.length).toBe(1); expect(messages[0].type).toBe(diagram.db.LINETYPE.DOTTED_POINT); }); - it('it should handle in arrow messages', function () { + it('should handle in arrow messages', function () { const str = ` sequenceDiagram Alice->>Bob:Hello Bob, how are you?`; @@ -405,7 +405,7 @@ Alice->>Bob:Hello Bob, how are you?`; expect(messages.length).toBe(1); expect(messages[0].type).toBe(diagram.db.LINETYPE.SOLID); }); - it('it should handle in arrow messages', function () { + it('should handle in arrow messages', function () { const str = 'sequenceDiagram\n' + 'Alice-->>Bob:Hello Bob, how are you?'; mermaidAPI.parse(str); @@ -418,7 +418,7 @@ Alice->>Bob:Hello Bob, how are you?`; expect(messages.length).toBe(1); expect(messages[0].type).toBe(diagram.db.LINETYPE.DOTTED); }); - it('it should handle actor activation', function () { + it('should handle actor activation', function () { const str = ` sequenceDiagram Alice-->>Bob:Hello Bob, how are you? @@ -441,7 +441,7 @@ deactivate Bob`; expect(messages[3].type).toBe(diagram.db.LINETYPE.ACTIVE_END); expect(messages[3].from.actor).toBe('Bob'); }); - it('it should handle actor one line notation activation', function () { + it('should handle actor one line notation activation', function () { const str = ` sequenceDiagram Alice-->>+Bob:Hello Bob, how are you? @@ -462,7 +462,7 @@ deactivate Bob`; expect(messages[3].type).toBe(diagram.db.LINETYPE.ACTIVE_END); expect(messages[3].from.actor).toBe('Bob'); }); - it('it should handle stacked activations', function () { + it('should handle stacked activations', function () { const str = ` sequenceDiagram Alice-->>+Bob:Hello Bob, how are you? @@ -489,7 +489,7 @@ deactivate Bob`; expect(messages[7].type).toBe(diagram.db.LINETYPE.ACTIVE_END); expect(messages[7].from.actor).toBe('Carol'); }); - it('it should handle fail parsing when activating an inactive participant', function () { + it('should handle fail parsing when activating an inactive participant', function () { const str = ` sequenceDiagram participant user as End User @@ -515,7 +515,7 @@ deactivate Bob`; expect(error).toBe(true); }); - it('it should handle comments in a sequenceDiagram', function () { + it('should handle comments in a sequenceDiagram', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -534,7 +534,7 @@ deactivate Bob`; expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should handle new lines in a sequenceDiagram', function () { + it('should handle new lines in a sequenceDiagram', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -555,7 +555,7 @@ deactivate Bob`; expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should handle semicolons', function () { + it('should handle semicolons', function () { const str = ` sequenceDiagram;Alice->Bob: Hello Bob, how are you?;Note right of Bob: Bob thinks;Bob-->Alice: I am good thanks!;`; @@ -570,7 +570,7 @@ sequenceDiagram;Alice->Bob: Hello Bob, how are you?;Note right of Bob: Bob think expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should handle one leading space in lines in a sequenceDiagram', function () { + it('should handle one leading space in lines in a sequenceDiagram', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -590,7 +590,7 @@ Bob-->Alice: I am good thanks!`; expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should handle several leading spaces in lines in a sequenceDiagram', function () { + it('should handle several leading spaces in lines in a sequenceDiagram', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -610,7 +610,7 @@ Bob-->Alice: I am good thanks!`; expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should handle several leading spaces in lines in a sequenceDiagram', function () { + it('should handle several leading spaces in lines in a sequenceDiagram', function () { const str = ` sequenceDiagram participant Alice @@ -635,7 +635,7 @@ Bob-->John: Jolly good!`; expect(messages[0].from).toBe('Alice'); expect(messages[2].from).toBe('John'); }); - it('it should handle different line breaks', function () { + it('should handle different line breaks', function () { const str = ` sequenceDiagram participant 1 as multiline
text @@ -670,7 +670,7 @@ note right of 1: multiline
text expect(messages[6].message).toBe('multiline
text'); expect(messages[7].message).toBe('multiline
text'); }); - it('it should handle notes and messages without wrap specified', function () { + it('should handle notes and messages without wrap specified', function () { const str = ` sequenceDiagram participant 1 @@ -709,7 +709,7 @@ note right of 1:nowrap: multiline
text expect(messages[6].wrap).toBe(false); expect(messages[7].wrap).toBe(false); }); - it('it should handle notes and messages with wrap specified', function () { + it('should handle notes and messages with wrap specified', function () { const str = ` sequenceDiagram participant 1 @@ -734,7 +734,7 @@ note right of 3:wrap: multiline
text expect(messages[2].wrap).toBe(true); expect(messages[3].wrap).toBe(true); }); - it('it should handle notes and messages with nowrap or line breaks', function () { + it('should handle notes and messages with nowrap or line breaks', function () { const str = ` sequenceDiagram participant 1 @@ -751,7 +751,7 @@ note right of 2: single-line text expect(messages[0].wrap).toBe(false); expect(messages[1].wrap).toBe(false); }); - it('it should handle notes over a single actor', function () { + it('should handle notes over a single actor', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -764,7 +764,7 @@ Note over Bob: Bob thinks expect(messages[1].from).toBe('Bob'); expect(messages[1].to).toBe('Bob'); }); - it('it should handle notes over multiple actors', function () { + it('should handle notes over multiple actors', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -780,7 +780,7 @@ Note over Bob,Alice: resolution expect(messages[2].from).toBe('Bob'); expect(messages[2].to).toBe('Alice'); }); - it('it should handle loop statements', function () { + it('should handle loop statements', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -803,7 +803,7 @@ end`; expect(messages[0].from).toBe('Alice'); expect(messages[1].from).toBe('Bob'); }); - it('it should add a rect around sequence', function () { + it('should add a rect around sequence', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -827,7 +827,7 @@ end`; expect(messages[4].type).toEqual(diagram.db.LINETYPE.RECT_END); }); - it('it should allow for nested rects', function () { + it('should allow for nested rects', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -854,7 +854,7 @@ end`; expect(messages[5].type).toEqual(diagram.db.LINETYPE.DOTTED_OPEN); expect(messages[6].type).toEqual(diagram.db.LINETYPE.RECT_END); }); - it('it should handle opt statements', function () { + it('should handle opt statements', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -877,7 +877,7 @@ end`; expect(messages[0].from).toBe('Alice'); expect(messages[1].from).toBe('Bob'); }); - it('it should handle alt statements', function () { + it('should handle alt statements', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -903,7 +903,7 @@ end`; expect(messages[0].from).toBe('Alice'); expect(messages[1].from).toBe('Bob'); }); - it('it should handle alt statements with multiple elses', function () { + it('should handle alt statements with multiple elses', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -930,7 +930,7 @@ end`; expect(messages[7].from).toBe('Bob'); expect(messages[8].type).toBe(diagram.db.LINETYPE.ALT_END); }); - it('it should handle critical statements without options', function () { + it('should handle critical statements without options', function () { const str = ` sequenceDiagram critical Establish a connection to the DB @@ -950,7 +950,7 @@ sequenceDiagram expect(messages[1].from).toBe('Service'); expect(messages[2].type).toBe(diagram.db.LINETYPE.CRITICAL_END); }); - it('it should handle critical statements with options', function () { + it('should handle critical statements with options', function () { const str = ` sequenceDiagram critical Establish a connection to the DB @@ -978,7 +978,7 @@ sequenceDiagram expect(messages[5].from).toBe('Service'); expect(messages[6].type).toBe(diagram.db.LINETYPE.CRITICAL_END); }); - it('it should handle break statements', function () { + it('should handle break statements', function () { const str = ` sequenceDiagram Consumer-->API: Book something @@ -1004,7 +1004,7 @@ sequenceDiagram expect(messages[4].type).toBe(diagram.db.LINETYPE.BREAK_END); expect(messages[5].from).toBe('API'); }); - it('it should handle par statements a sequenceDiagram', function () { + it('should handle par statements a sequenceDiagram', function () { const str = ` sequenceDiagram par Parallel one @@ -1031,7 +1031,7 @@ end`; expect(messages[1].from).toBe('Alice'); expect(messages[2].from).toBe('Bob'); }); - it('it should handle special characters in signals', function () { + it('should handle special characters in signals', function () { const str = 'sequenceDiagram\n' + 'Alice->Bob: -:<>,;# comment'; mermaidAPI.parse(str); @@ -1039,7 +1039,7 @@ end`; const messages = diagram.db.getMessages(); expect(messages[0].message).toBe('-:<>,'); }); - it('it should handle special characters in notes', function () { + it('should handle special characters in notes', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1050,7 +1050,7 @@ Note right of Bob: -:<>,;# comment`; const messages = diagram.db.getMessages(); expect(messages[1].message).toBe('-:<>,'); }); - it('it should handle special characters in loop', function () { + it('should handle special characters in loop', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1063,7 +1063,7 @@ end`; const messages = diagram.db.getMessages(); expect(messages[1].message).toBe('-:<>,'); }); - it('it should handle special characters in opt', function () { + it('should handle special characters in opt', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1076,7 +1076,7 @@ end`; const messages = diagram.db.getMessages(); expect(messages[1].message).toBe('-:<>,'); }); - it('it should handle special characters in alt', function () { + it('should handle special characters in alt', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1092,7 +1092,7 @@ end`; expect(messages[1].message).toBe('-:<>,'); expect(messages[3].message).toBe(',<>:-'); }); - it('it should handle special characters in par', function () { + it('should handle special characters in par', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1108,7 +1108,7 @@ end`; expect(messages[1].message).toBe('-:<>,'); expect(messages[3].message).toBe(',<>:-'); }); - it('it should handle no-label loop', function () { + it('should handle no-label loop', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1122,7 +1122,7 @@ end`; expect(messages[1].message).toBe(''); expect(messages[2].message).toBe('I am good thanks!'); }); - it('it should handle no-label opt', function () { + it('should handle no-label opt', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1136,7 +1136,7 @@ end`; expect(messages[1].message).toBe(''); expect(messages[2].message).toBe('I am good thanks!'); }); - it('it should handle no-label alt', function () { + it('should handle no-label alt', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1153,7 +1153,7 @@ end`; expect(messages[3].message).toBe(''); expect(messages[4].message).toBe('I am good thanks!'); }); - it('it should handle no-label par', function () { + it('should handle no-label par', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1171,7 +1171,7 @@ end`; expect(messages[4].message).toBe('I am good thanks!'); }); - it('it should handle links', function () { + it('should handle links', function () { const str = ` sequenceDiagram participant a as Alice @@ -1198,7 +1198,7 @@ link a: Tests @ https://tests.contoso.com/?svc=alice@contoso.com expect(actors.a.links['Tests']).toBe('https://tests.contoso.com/?svc=alice@contoso.com'); }); - it('it should handle properties EXPERIMENTAL: USE WITH CAUTION', function () { + it('should handle properties EXPERIMENTAL: USE WITH CAUTION', function () { //Be aware that the syntax for "properties" is likely to be changed. const str = ` sequenceDiagram @@ -1245,7 +1245,7 @@ describe('when checking the bounds in a sequenceDiagram', function () { diagram.renderer.bounds.init(); conf = diagram.db.getConfig(); }); - it('it should handle a simple bound call', function () { + it('should handle a simple bound call', function () { diagram.renderer.bounds.insert(100, 100, 200, 200); const { bounds } = diagram.renderer.bounds.getBounds(); @@ -1254,7 +1254,7 @@ describe('when checking the bounds in a sequenceDiagram', function () { expect(bounds.stopx).toBe(200); expect(bounds.stopy).toBe(200); }); - it('it should handle an expanding bound', function () { + it('should handle an expanding bound', function () { diagram.renderer.bounds.insert(100, 100, 200, 200); diagram.renderer.bounds.insert(25, 50, 300, 400); @@ -1264,7 +1264,7 @@ describe('when checking the bounds in a sequenceDiagram', function () { expect(bounds.stopx).toBe(300); expect(bounds.stopy).toBe(400); }); - it('it should handle inserts within the bound without changing the outer bounds', function () { + it('should handle inserts within the bound without changing the outer bounds', function () { diagram.renderer.bounds.insert(100, 100, 200, 200); diagram.renderer.bounds.insert(25, 50, 300, 400); diagram.renderer.bounds.insert(125, 150, 150, 200); @@ -1275,7 +1275,7 @@ describe('when checking the bounds in a sequenceDiagram', function () { expect(bounds.stopx).toBe(300); expect(bounds.stopy).toBe(400); }); - it('it should handle a loop without expanding the area', function () { + it('should handle a loop without expanding the area', function () { diagram.renderer.bounds.insert(25, 50, 300, 400); diagram.renderer.bounds.verticalPos = 150; diagram.renderer.bounds.newLoop(); @@ -1296,7 +1296,7 @@ describe('when checking the bounds in a sequenceDiagram', function () { expect(bounds.stopx).toBe(300); expect(bounds.stopy).toBe(400); }); - it('it should handle multiple loops withtout expanding the bounds', function () { + it('should handle multiple loops withtout expanding the bounds', function () { diagram.renderer.bounds.insert(100, 100, 1000, 1000); diagram.renderer.bounds.verticalPos = 200; diagram.renderer.bounds.newLoop(); @@ -1327,7 +1327,7 @@ describe('when checking the bounds in a sequenceDiagram', function () { expect(bounds.stopx).toBe(1000); expect(bounds.stopy).toBe(1000); }); - it('it should handle a loop that expands the area', function () { + it('should handle a loop that expands the area', function () { diagram.renderer.bounds.insert(100, 100, 200, 200); diagram.renderer.bounds.verticalPos = 200; diagram.renderer.bounds.newLoop(); @@ -1414,7 +1414,7 @@ participant Alice`; expect(bounds.stopy).toBe(conf.height); }); }); - it('it should handle same actor with different whitespace properly', function () { + it('should handle same actor with different whitespace properly', function () { const str = ` sequenceDiagram participant Alice @@ -1427,7 +1427,7 @@ participant Alice const actors = diagram.db.getActors(); expect(Object.keys(actors)).toEqual(['Alice']); }); - it('it should handle one actor and a centered note', function () { + it('should handle one actor and a centered note', function () { const str = ` sequenceDiagram participant Alice @@ -1445,7 +1445,7 @@ Note over Alice: Alice thinks // 10 comes from mock of text height expect(bounds.stopy).toBe(models.lastNote().stopy); }); - it('it should handle one actor and a note to the left', function () { + it('should handle one actor and a note to the left', function () { const str = ` sequenceDiagram participant Alice @@ -1461,7 +1461,7 @@ Note left of Alice: Alice thinks`; // 10 comes from mock of text height expect(bounds.stopy).toBe(models.lastNote().stopy); }); - it('it should handle one actor and a note to the right', function () { + it('should handle one actor and a note to the right', function () { const str = ` sequenceDiagram participant Alice @@ -1477,7 +1477,7 @@ Note right of Alice: Alice thinks`; // 10 comes from mock of text height expect(bounds.stopy).toBe(models.lastNote().stopy); }); - it('it should handle two actors', function () { + it('should handle two actors', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you?`; @@ -1491,7 +1491,7 @@ Alice->Bob: Hello Bob, how are you?`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should handle two actors with init directive', function () { + it('should handle two actors with init directive', function () { const str = ` %%{init: {'logLevel': 0}}%% sequenceDiagram @@ -1508,7 +1508,7 @@ Alice->Bob: Hello Bob, how are you?`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should handle two actors with init directive with multiline directive', function () { + it('should handle two actors with init directive with multiline directive', function () { const str = ` %%{init: { 'logLevel': 0}}%% sequenceDiagram @@ -1530,7 +1530,7 @@ Alice->Bob: Hello Bob, how are you?`; expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); expect(msgs.every((v) => v.wrap)).toBe(true); }); - it('it should handle two actors and two centered shared notes', function () { + it('should handle two actors and two centered shared notes', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1547,7 +1547,7 @@ Note over Bob,Alice: Looks back expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastNote().stopy); }); - it('it should draw two actors and two messages', function () { + it('should draw two actors and two messages', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1562,7 +1562,7 @@ Bob->Alice: Fine!`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two actors notes to the right', function () { + it('should draw two actors notes to the right', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1581,7 +1581,7 @@ Bob->Alice: Fine!`; expect(bounds.stopx).toBe(expStopX); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two actors notes to the left', function () { + it('should draw two actors notes to the left', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1598,7 +1598,7 @@ Bob->Alice: Fine!`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two actors notes to the left with text wrapped (inline)', function () { + it('should draw two actors notes to the left with text wrapped (inline)', function () { const str = ` sequenceDiagram Alice->>Bob:wrap: Hello Bob, how are you? If you are not available right now, I can leave you a message. Please get back to me as soon as you can! @@ -1617,7 +1617,7 @@ Bob->>Alice: Fine!`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two actors notes to the left with text wrapped (directive)', function () { + it('should draw two actors notes to the left with text wrapped (directive)', function () { const str = ` %%{init: { 'theme': 'dark' } }%% sequenceDiagram @@ -1640,7 +1640,7 @@ Bob->>Alice: Fine!`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two actors notes to the left with text wrapped and the init directive sets the theme to dark', function () { + it('should draw two actors notes to the left with text wrapped and the init directive sets the theme to dark', function () { const str = ` %%{init:{'theme':'dark'}}%% sequenceDiagram @@ -1663,7 +1663,7 @@ Bob->>Alice: Fine!`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two actors, notes to the left with text wrapped and the init directive sets the theme to dark and fontFamily to Menlo, fontSize to 18, and fontWeight to 800', function () { + it('should draw two actors, notes to the left with text wrapped and the init directive sets the theme to dark and fontFamily to Menlo, fontSize to 18, and fontWeight to 800', function () { const str = ` %%{init: { "theme": "dark", 'config': { "fontFamily": "Menlo", "fontSize": 18, "messageFontWeight": 400, "wrap": true }}}%% sequenceDiagram @@ -1688,7 +1688,7 @@ Bob->>Alice: Fine!`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastMessage().stopy + 10); }); - it('it should draw two loops', function () { + it('should draw two loops', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, how are you? @@ -1705,7 +1705,7 @@ end`; expect(bounds.stopx).toBe(conf.width * 2 + conf.actorMargin); expect(bounds.stopy).toBe(models.lastLoop().stopy); }); - it('it should draw background rect', function () { + it('should draw background rect', function () { const str = ` sequenceDiagram Alice->Bob: Hello Bob, are you alright? @@ -1755,7 +1755,7 @@ describe('when rendering a sequenceDiagram with actor mirror activated', functio diagram.renderer.bounds.init(); }); ['tspan', 'fo', 'old', undefined].forEach(function (textPlacement) { - it('it should handle one actor, when textPlacement is' + textPlacement, function () { + it('should handle one actor, when textPlacement is' + textPlacement, function () { mermaidAPI.initialize(addConf(conf, 'textPlacement', textPlacement)); diagram.renderer.bounds.init(); const str = ` @@ -1799,7 +1799,7 @@ describe('when rendering a sequenceDiagram with directives', function () { diagram.renderer.bounds.init(); }); - it('it should handle one actor, when theme is dark and logLevel is 1 DX1', function () { + it('should handle one actor, when theme is dark and logLevel is 1 DX1', function () { const str = ` %%{init: { "theme": "dark", "logLevel": 1 } }%% sequenceDiagram @@ -1823,7 +1823,7 @@ participant Alice models.lastActor().y + models.lastActor().height + mermaid.sequence.boxMargin ); }); - it('it should handle one actor, when logLevel is 3', function () { + it('should handle one actor, when logLevel is 3', function () { const str = ` %%{initialize: { "logLevel": 3 }}%% sequenceDiagram @@ -1843,7 +1843,7 @@ participant Alice models.lastActor().y + models.lastActor().height + mermaid.sequence.boxMargin ); }); - it('it should hide sequence numbers when autonumber is removed when autonumber is enabled', function () { + it('should hide sequence numbers when autonumber is removed when autonumber is enabled', function () { const str1 = ` sequenceDiagram autonumber diff --git a/src/diagrams/sequence/svgDraw.spec.js b/src/diagrams/sequence/svgDraw.spec.js index b9e7ced4a..14dd9a202 100644 --- a/src/diagrams/sequence/svgDraw.spec.js +++ b/src/diagrams/sequence/svgDraw.spec.js @@ -3,7 +3,7 @@ const { MockD3 } = require('d3'); describe('svgDraw', function () { describe('drawRect', function () { - it('it should append a rectangle', function () { + it('should append a rectangle', function () { const svg = MockD3('svg'); svgDraw.drawRect(svg, { x: 10, @@ -29,7 +29,7 @@ describe('svgDraw', function () { expect(rect.attr).toHaveBeenCalledWith('ry', '10'); expect(rect.attr).toHaveBeenCalledWith('class', 'unitTestRectangleClass'); }); - it('it should not add the class attribute if a class isn`t provided', () => { + it('should not add the class attribute if a class isn`t provided', () => { const svg = MockD3('svg'); svgDraw.drawRect(svg, { x: 10, @@ -49,7 +49,7 @@ describe('svgDraw', function () { }); }); describe('drawText', function () { - it('it should append a single element', function () { + it('should append a single element', function () { const svg = MockD3('svg'); svgDraw.drawText(svg, { x: 10, @@ -73,7 +73,7 @@ describe('svgDraw', function () { expect(text.style).toHaveBeenCalledWith('font-size', '10px'); expect(text.style).toHaveBeenCalledWith('font-weight', '500'); }); - it('it should append a multiple elements', function () { + it('should append a multiple elements', function () { const svg = MockD3('svg'); svgDraw.drawText(svg, { x: 10, @@ -101,7 +101,7 @@ describe('svgDraw', function () { }); }); describe('drawBackgroundRect', function () { - it('it should append a rect before the previous element within a given bound', function () { + it('should append a rect before the previous element within a given bound', function () { const svg = MockD3('svg'); const boundingRect = { startx: 50, @@ -125,12 +125,12 @@ describe('svgDraw', function () { }); }); describe('sanitizeUrl', function () { - it('it should sanitize malicious urls', function () { + it('should sanitize malicious urls', function () { const maliciousStr = 'javascript:script:alert(1)'; const result = svgDraw.sanitizeUrl(maliciousStr); expect(result).not.toContain('javascript:alert(1)'); }); - it('it should not sanitize non dangerous urls', function () { + it('should not sanitize non dangerous urls', function () { const maliciousStr = 'javajavascript:script:alert(1)'; const result = svgDraw.sanitizeUrl(maliciousStr); expect(result).not.toContain('javascript:alert(1)'); diff --git a/src/diagrams/user-journey/parser/journey.spec.js b/src/diagrams/user-journey/parser/journey.spec.js index 2454c1d16..cc54d9f78 100644 --- a/src/diagrams/user-journey/parser/journey.spec.js +++ b/src/diagrams/user-journey/parser/journey.spec.js @@ -19,7 +19,7 @@ describe('when parsing a journey diagram it', function () { expect(parserFnConstructor(str)).not.toThrow(); }); - it('it should handle an accessibility description (accDescr)', function () { + it('should handle an accessibility description (accDescr)', function () { const str = 'journey\n' + 'accDescr: A user journey for family shopping\n' + @@ -28,7 +28,7 @@ describe('when parsing a journey diagram it', function () { expect(parserFnConstructor(str)).not.toThrow(); }); - it('it should handle an accessibility multiline description (accDescr)', function () { + it('should handle an accessibility multiline description (accDescr)', function () { const str = 'journey\n' + `accDescr { @@ -44,7 +44,7 @@ describe('when parsing a journey diagram it', function () { expect(journeyDb.getDiagramTitle()).toBe('Adding journey diagram functionality to mermaid'); expect(journeyDb.getAccTitle()).toBe('Adding acc journey diagram functionality to mermaid'); }); - it('it should handle an accessibility title (accDescr)', function () { + it('should handle an accessibility title (accDescr)', function () { const str = `journey accTitle: The title section Order from website`; diff --git a/src/mermaid.spec.js b/src/mermaid.spec.js index 3ca5c77fd..81cf980ba 100644 --- a/src/mermaid.spec.js +++ b/src/mermaid.spec.js @@ -46,7 +46,7 @@ describe('when using mermaid and ', function () { flowDb.clear(); flowDb.setGen('gen-2'); }); - it('it should handle edges with text', function () { + it('should handle edges with text', function () { const diag = new Diagram('graph TD;A-->|text ex|B;'); diag.db.getVertices(); const edges = diag.db.getEdges(); @@ -189,18 +189,18 @@ describe('when using mermaid and ', function () { flowDb.clear(); flowDb.setGen('gen-2'); }); - it('it should throw for an invalid definition', function () { + it('should throw for an invalid definition', function () { expect(() => mermaid.parse('this is not a mermaid diagram definition')).toThrow(); }); - it('it should not throw for a valid flow definition', function () { + it('should not throw for a valid flow definition', function () { expect(() => mermaid.parse('graph TD;A--x|text including URL space|B;')).not.toThrow(); }); - it('it should throw for an invalid flow definition', function () { + it('should throw for an invalid flow definition', function () { expect(() => mermaid.parse('graph TQ;A--x|text including URL space|B;')).toThrow(); }); - it('it should not throw for a valid sequenceDiagram definition', function () { + it('should not throw for a valid sequenceDiagram definition', function () { const text = 'sequenceDiagram\n' + 'Alice->Bob: Hello Bob, how are you?\n\n' + @@ -214,7 +214,7 @@ describe('when using mermaid and ', function () { expect(() => mermaid.parse(text)).not.toThrow(); }); - it('it should throw for an invalid sequenceDiagram definition', function () { + it('should throw for an invalid sequenceDiagram definition', function () { const text = 'sequenceDiagram\n' + 'Alice:->Bob: Hello Bob, how are you?\n\n' + diff --git a/src/mermaidAPI.spec.js b/src/mermaidAPI.spec.js index e4c2d168d..80ea8a56c 100644 --- a/src/mermaidAPI.spec.js +++ b/src/mermaidAPI.spec.js @@ -122,14 +122,14 @@ describe('when using mermaidAPI and ', function () { }); describe('test mermaidApi.parse() for checking validity of input ', function () { mermaid.parseError = undefined; // ensure it parseError undefined - it('it should throw for an invalid definition (with no mermaid.parseError() defined)', function () { + it('should throw for an invalid definition (with no mermaid.parseError() defined)', function () { expect(mermaid.parseError).toEqual(undefined); expect(() => mermaidAPI.parse('this is not a mermaid diagram definition')).toThrow(); }); - it('it should not throw for a valid definition', function () { + it('should not throw for a valid definition', function () { expect(() => mermaidAPI.parse('graph TD;A--x|text including URL space|B;')).not.toThrow(); }); - it('it should return false for invalid definition WITH a parseError() callback defined', function () { + it('should return false for invalid definition WITH a parseError() callback defined', function () { var parseErrorWasCalled = false; // also test setParseErrorHandler() call working to set mermaid.parseError mermaid.setParseErrorHandler(function (error, hash) { @@ -140,7 +140,7 @@ describe('when using mermaidAPI and ', function () { expect(mermaidAPI.parse('this is not a mermaid diagram definition')).toEqual(false); expect(parseErrorWasCalled).toEqual(true); }); - it('it should return true for valid definition', function () { + it('should return true for valid definition', function () { expect(mermaidAPI.parse('graph TD;A--x|text including URL space|B;')).toEqual(true); }); });