feat(er): add entity name alias

[tomperr]

📑 Summary

Allow to add an alias to entity name

Resolves #4746

📏 Design Decisions

Update parser to handle alias inside square brackets
Update renderer to show the alias if it exists

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added necessary unit/e2e tests.
• 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
• 🔖 targeted develop branch

[codecov]

Codecov Report

Merging #4758 (9fa6dc2) into develop (6563a6e) will decrease coverage by 27.99%.
Report is 1 commits behind head on develop.
The diff coverage is n/a.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop    #4758       +/-   ##
============================================
- Coverage    73.53%   45.55%   -27.99%     
============================================
  Files          146       53       -93     
  Lines        14569     6629     -7940     
  Branches       592       32      -560     
============================================
- Hits         10714     3020     -7694     
+ Misses        3720     3608      -112     
+ Partials       135        1      -134     

Flag	Coverage Δ
e2e	?
unit	45.55% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 142 files with indirect coverage changes

[sidharthv96]

I think we should use the existing mermaid format to add aliases.
In class, flow, etc. id["text"] format is used.

So, in ER, that would be.

erDiagram
  cc["Credit Card"] {
    varchar(16) number
    ...
  }
  cc 1+ -- 1 account

[sidharthv96]

Wonderful!
Can you also add a test in cypress/integration/rendering/erDiagram.spec.js, so we can ensure the rendering works? Thank you!

[tomperr]

should be good now

[tomperr]

Btw, we should consider migrating ER diagram (and some others) from JS to TS. I don't know if there is already an issue about it

[sidharthv96]

Btw, we should consider migrating ER diagram (and some others) from JS to TS. I don't know if there is already an issue about it

Yes. @Yokozuna59 has been standardizing diagrams. PRs

If you can get started with ER in a different PR (this one is ready to be merged), that would be great.

[Yokozuna59]

Btw, we should consider migrating ER diagram (and some others) from JS to TS. I don't know if there is already an issue about it

There is an open issue about the structure we're following, #4499. It is not finished and kind of outdated, but you can refer to it. Feel free to give any feedback or ask for help with it.

[nirname]

Please, wait for me, I'll do a review on this ASAP

[nirname]

Something went wrong

---

Person has to be called "Customer" but is not

---
title: Not Working
---
erDiagram
  Person ||--o{ Order : "has many"
  Person["Customer"] {
    string name
  }

While changing the order of the statements does the trick

---
title: Working
---
erDiagram
  Person["Customer"] {
    string name
  }
  Person ||--o{ Order : "has many"

---

---

A couple of tests to cover the case would be nice

[tomperr]

Nice catch, I will take a look ASAP

[nirname]

@tomperr I see some commits from you addressing our comments. Please, ask re-review when it is ready

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	9fa6dc2
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/64e82fa0de0391000778c165
😎 Deploy Preview	https://deploy-preview-4758--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sidharthv96]

Some cache in netlify is preventing the generation of updated site.
Clearing cache from their dashboard built the right version. Now we can test the changes using the deploy preview link.