Feature/1309 er diagram plant uml #1324
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Alters the syntax for newly implemented ER diagrams so that it is compatible with PlantUML ERD syntax
Resolves #1309
📏 Design Decisions
A fairly straight-forward change to the jison parsing logic to use different syntax for specifying relationships between entities. For example, the original syntax I implemented for an one-to-many was
EntityA !-?< EntityB : label
and the new syntax for this isEntityA ||--o{ EntityB : label
.The
: label
part is an extension to PlantUML, because it is very convenient/common to label relationships.Also PlantUML syntax allows the distinction between identifying and non-identifying relationships which I hadn't previously implemented. This is now supported by using either hyphens or dots in the middle part of the relationship specifier. Hyphens are rendered as a s solid line, whereas dots are rendered as a dashed line. The docs have been updated to give a better overview.
📋 Tasks
Make sure you
develop
branch