Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert Mindmap to TS #5247

Merged
merged 24 commits into from
Feb 1, 2024
Merged

Convert Mindmap to TS #5247

merged 24 commits into from
Feb 1, 2024

Conversation

sidharthv96
Copy link
Member

@sidharthv96 sidharthv96 commented Jan 28, 2024

📑 Summary

Convert mindmap and related files to TS

📏 Design Decisions

📋 Tasks

Make sure you

Copy link

netlify bot commented Jan 28, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 45f4d3d
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/65ba17dc8c792900082ccb8d
😎 Deploy Preview https://deploy-preview-5247--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

codecov bot commented Jan 28, 2024

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (7503694) 43.21% compared to head (45f4d3d) 80.08%.
Report is 3 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #5247       +/-   ##
============================================
+ Coverage    43.21%   80.08%   +36.87%     
============================================
  Files           23      167      +144     
  Lines         5033    13875     +8842     
  Branches        23      741      +718     
============================================
+ Hits          2175    11112     +8937     
+ Misses        2857     2597      -260     
- Partials         1      166      +165     
Flag Coverage Δ
e2e 86.07% <78.57%> (?)
unit 43.22% <50.00%> (+<0.01%) ⬆️

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

Files Coverage Δ
...mermaid/src/diagrams/mindmap/mindmap-definition.ts 100.00% <100.00%> (ø)
packages/mermaid/src/diagrams/mindmap/styles.ts 100.00% <100.00%> (ø)
...ages/mermaid/src/diagrams/sankey/sankeyRenderer.ts 74.19% <ø> (ø)
packages/mermaid/src/utils.ts 64.44% <50.00%> (+22.37%) ⬆️
packages/mermaid/src/diagrams/mindmap/svgDraw.ts 81.25% <85.71%> (ø)
...es/mermaid/src/diagrams/mindmap/mindmapRenderer.ts 93.10% <77.77%> (ø)
packages/mermaid/src/diagrams/mindmap/mindmapDb.ts 75.00% <73.07%> (ø)

... and 156 files with indirect coverage changes

@sidharthv96 sidharthv96 requested a review from knsv January 28, 2024 10:39
Copy link
Member

@Yokozuna59 Yokozuna59 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this refactoring! I have some small notes to be considered.

packages/mermaid/src/diagrams/mindmap/mindmapDb.ts Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/mindmapDb.ts Outdated Show resolved Hide resolved
packages/mermaid/src/config.ts Outdated Show resolved Hide resolved
patches/[email protected] Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/svgDraw.ts Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/mindmapRenderer.ts Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/mindmapRenderer.ts Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/mindmapRenderer.ts Outdated Show resolved Hide resolved
Co-authored-by: Reda Al Sulais <[email protected]>
packages/mermaid/src/diagrams/mindmap/styles.ts Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/styles.ts Outdated Show resolved Hide resolved
packages/mermaid/src/config.ts Outdated Show resolved Hide resolved
packages/mermaid/src/diagrams/mindmap/mindmapDb.ts Outdated Show resolved Hide resolved
Co-authored-by: Reda Al Sulais <[email protected]>
Copy link
Member

@Yokozuna59 Yokozuna59 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@Yokozuna59
Copy link
Member

Maybe update the PR description since it would implemented in a different PR.

* develop:
  Update container
  Update container
  Remove pnpm cache
  Use `.node-version` file in workflows
  fix: Redirect of old URLs
  Remove node version from matrix
  Update to Node v20
  Update to Node v20
  fix lint
  add latest blog post
  update discord invite link
  remove holiday promo text
@knsv knsv added this pull request to the merge queue Feb 1, 2024
Merged via the queue into develop with commit 5c9857c Feb 1, 2024
30 checks passed
@knsv knsv deleted the sidv/mindmapToTs branch February 1, 2024 13:40
fuxingloh referenced this pull request in fuxingloh/contented Feb 3, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.7.0` ->
`10.8.0`](https://renovatebot.com/diffs/npm/mermaid/10.7.0/10.8.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.7.0/10.8.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid (mermaid)</summary>

###
[`v10.8.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.8.0)

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.7.0...v10.8.0)

### v10.8.0

#### Features

<img width="375" alt="image"
src="https://github.com/mermaid-js/mermaid/assets/5837277/c17405fb-2a06-4f7c-9c77-5eaba6c76747">

- Adding new diagram type - Block Diagram by
[@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/5221](https://togithub.com/mermaid-js/mermaid/pull/5221)

- Feature/5114 add parallel commit config by
[@&#8203;mathbraga](https://togithub.com/mathbraga) in
[https://github.com/mermaid-js/mermaid/pull/5161](https://togithub.com/mermaid-js/mermaid/pull/5161)

- Changes to Gantt Parsers to allow hashes and semicolons to titles,
sections, and task data. by
[@&#8203;FutzMonitor](https://togithub.com/FutzMonitor) in
[https://github.com/mermaid-js/mermaid/pull/5095](https://togithub.com/mermaid-js/mermaid/pull/5095)

- Feature/4653 add actor-top class to sequence diagram by
[@&#8203;Ronid1](https://togithub.com/Ronid1) in
[https://github.com/mermaid-js/mermaid/pull/5241](https://togithub.com/mermaid-js/mermaid/pull/5241)

#### Documentation

- Updated gantt chart docs to show all config options by
[@&#8203;murdoa](https://togithub.com/murdoa) in
[https://github.com/mermaid-js/mermaid/pull/5192](https://togithub.com/mermaid-js/mermaid/pull/5192)
- Contribution documentation improvements by
[@&#8203;nirname](https://togithub.com/nirname) in
[https://github.com/mermaid-js/mermaid/pull/5132](https://togithub.com/mermaid-js/mermaid/pull/5132)
- Update flowchart.md - how to use font-awesome
[#&#8203;5195](https://togithub.com/mermaid-js/mermaid/issues/5195) by
[@&#8203;arukiidou](https://togithub.com/arukiidou) in
[https://github.com/mermaid-js/mermaid/pull/5196](https://togithub.com/mermaid-js/mermaid/pull/5196)
- Add more detailed docs for Gantt tasks by
[@&#8203;sorenisanerd](https://togithub.com/sorenisanerd) in
[https://github.com/mermaid-js/mermaid/pull/5194](https://togithub.com/mermaid-js/mermaid/pull/5194)
- Docs/4974 reorder integration links by
[@&#8203;Ronid1](https://togithub.com/Ronid1) in
[https://github.com/mermaid-js/mermaid/pull/5066](https://togithub.com/mermaid-js/mermaid/pull/5066)
- docs: fix swimm link by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[https://github.com/mermaid-js/mermaid/pull/5219](https://togithub.com/mermaid-js/mermaid/pull/5219)
- Update Slack community links to Discord by
[@&#8203;Olegt0rr](https://togithub.com/Olegt0rr) in
[https://github.com/mermaid-js/mermaid/pull/5225](https://togithub.com/mermaid-js/mermaid/pull/5225)
- Docs: Mermaid chart updates by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/5232](https://togithub.com/mermaid-js/mermaid/pull/5232)
- Fix typos in timeline syntax samples by
[@&#8203;sblom](https://togithub.com/sblom) in
[https://github.com/mermaid-js/mermaid/pull/5139](https://togithub.com/mermaid-js/mermaid/pull/5139)

#### Bug fixes

- Bug/5059 fix external connection after updating edges by
[@&#8203;mathbraga](https://togithub.com/mathbraga) in
[https://github.com/mermaid-js/mermaid/pull/5127](https://togithub.com/mermaid-js/mermaid/pull/5127)
- \[Fix] Sequence diagram actor menu popup by
[@&#8203;vitorsss](https://togithub.com/vitorsss) in
[https://github.com/mermaid-js/mermaid/pull/5160](https://togithub.com/mermaid-js/mermaid/pull/5160)
- fix: Dompurify Hooks by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5236](https://togithub.com/mermaid-js/mermaid/pull/5236)
- Accurate pie chart labeling for text alignment by
[@&#8203;JenningsWilliam](https://togithub.com/JenningsWilliam) in
[https://github.com/mermaid-js/mermaid/pull/5141](https://togithub.com/mermaid-js/mermaid/pull/5141)
- fix: Redirect of old URLs by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5250](https://togithub.com/mermaid-js/mermaid/pull/5250)
- Fixed Typo in ErrorRenderer.ts by
[@&#8203;FutzMonitor](https://togithub.com/FutzMonitor) in
[https://github.com/mermaid-js/mermaid/pull/5256](https://togithub.com/mermaid-js/mermaid/pull/5256)

#### Chores

- Revert "Revert 5041 feature/4935 subgraph title margin config option"
by [@&#8203;mathbraga](https://togithub.com/mathbraga) in
[https://github.com/mermaid-js/mermaid/pull/5205](https://togithub.com/mermaid-js/mermaid/pull/5205)
- build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/5200](https://togithub.com/mermaid-js/mermaid/pull/5200)
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/mermaid-js/mermaid/pull/5150](https://togithub.com/mermaid-js/mermaid/pull/5150)
- E2E Image comparison by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5208](https://togithub.com/mermaid-js/mermaid/pull/5208)
- E2E test by [@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5210](https://togithub.com/mermaid-js/mermaid/pull/5210)
- Optimise caching of test results by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5213](https://togithub.com/mermaid-js/mermaid/pull/5213)
- Update update-browserlist.yml to fix deprecation and action fails by
[@&#8203;Abrifq](https://togithub.com/Abrifq) in
[https://github.com/mermaid-js/mermaid/pull/5151](https://togithub.com/mermaid-js/mermaid/pull/5151)
- UpdateCypress by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5228](https://togithub.com/mermaid-js/mermaid/pull/5228)
- Use node v20 by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5248](https://togithub.com/mermaid-js/mermaid/pull/5248)
- Convert Mindmap to TS by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5247](https://togithub.com/mermaid-js/mermaid/pull/5247)
- chore: Add interface naming Convention by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/5254](https://togithub.com/mermaid-js/mermaid/pull/5254)

#### New Contributors

- [@&#8203;murdoa](https://togithub.com/murdoa) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/5192](https://togithub.com/mermaid-js/mermaid/pull/5192)
- [@&#8203;arukiidou](https://togithub.com/arukiidou) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/5196](https://togithub.com/mermaid-js/mermaid/pull/5196)
- [@&#8203;sorenisanerd](https://togithub.com/sorenisanerd) made their
first contribution in
[https://github.com/mermaid-js/mermaid/pull/5194](https://togithub.com/mermaid-js/mermaid/pull/5194)
- [@&#8203;Ronid1](https://togithub.com/Ronid1) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/5066](https://togithub.com/mermaid-js/mermaid/pull/5066)
- [@&#8203;Olegt0rr](https://togithub.com/Olegt0rr) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/5225](https://togithub.com/mermaid-js/mermaid/pull/5225)
- [@&#8203;vitorsss](https://togithub.com/vitorsss) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/5160](https://togithub.com/mermaid-js/mermaid/pull/5160)
- [@&#8203;sblom](https://togithub.com/sblom) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/5139](https://togithub.com/mermaid-js/mermaid/pull/5139)
- [@&#8203;JenningsWilliam](https://togithub.com/JenningsWilliam) made
their first contribution in
[https://github.com/mermaid-js/mermaid/pull/5141](https://togithub.com/mermaid-js/mermaid/pull/5141)

**Full Changelog**:
mermaid-js/mermaid@v10.7.0...v10.8.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/levaintech/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
@Yokozuna59 Yokozuna59 mentioned this pull request Feb 9, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants