Bug/4391 make markdown auto wrapping optional

[dreathed]

📑 Summary

Hi! I'm new here and would like to be part of this awesome project! I'm still getting familiar with the code, so if I overlooked something, sorry in advance!
This PR solves the issue with auto wrapping markdown strings, by making auto wrapping optional for markdown strings.

Resolves #4391

📏 Design Decisions

I created a boolean option "markdownAutoWrap". If this option is set to false, then markdown strings are preprocessed, so that every whitespace is replaced by a " ". This way only explicit line breaks are rendered.

I added a unit test for the markdownToHTML function. I needed to import the setConfig function for testing.
I did not add a e2e test. BTW: 11 of 35 e2e tests fail. Can you tell me, whether this is a known issue or a problem on my side?

I updated the documentation for the flowchart.

I'm happy to get your feedback!

📋 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

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	16db0c0
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/65feb80daf24fc000887847f
😎 Deploy Preview	https://deploy-preview-4856--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.

[codecov]

Codecov Report

Attention: Patch coverage is 1.66667% with 59 lines in your changes are missing coverage. Please review.

Project coverage is 5.74%. Comparing base (ea86697) to head (16db0c0).

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #4856      +/-   ##
==========================================
- Coverage     5.75%   5.74%   -0.01%     
==========================================
  Files          277     277              
  Lines        41726   41743      +17     
  Branches        27      27              
==========================================
  Hits          2400    2400              
- Misses       39325   39342      +17     
  Partials         1       1              

Flag	Coverage Δ
unit	5.74% <1.66%> (-0.01%)	⬇️

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

Files	Coverage Δ
packages/mermaid/src/config.ts	52.22% <100.00%> (ø)
packages/mermaid/src/dagre-wrapper/clusters.js	0.00% <0.00%> (ø)
packages/mermaid/src/diagrams/common/common.ts	52.50% <0.00%> (+0.27%)	⬆️
packages/mermaid/src/rendering-util/createText.ts	0.00% <0.00%> (ø)
packages/mermaid/src/diagrams/mindmap/svgDraw.ts	0.00% <0.00%> (ø)
...mermaid/src/rendering-util/handle-markdown-text.ts	0.00% <0.00%> (ø)
packages/mermaid/src/dagre-wrapper/edges.js	0.00% <0.00%> (ø)
packages/mermaid/src/dagre-wrapper/shapes/util.js	0.00% <0.00%> (ø)

[sidharthv96]

Nice work @dreathed !

We'll have to remove the setConfig and getConfig imports, by passing the parameter inside an options object.

    markdownToHTML(`Hello, how do you do?`, { markdownAutoWrap: false });

The e2e tests should not be failing.
Can you add an imgSnapshotTest anyway, we'll verify that here.