Use our prettier config on the `packages/mermaid/src/config.type.ts` file #4715

aloisklink · 2023-08-10T00:12:34Z

📑 Summary

Currently, the packages/mermaid/src/config.type.ts types file (auto-generated via pnpm run --filter mermaid types:build-config) uses the default prettier config.

Instead, we should use the prettier config in the Mermaid repo, as it's slightly different from the default prettier config.

Resolves the following comment by @sidharthv96 in #4413 (comment).

📏 Design Decisions

I've split this up into two commits to make this easier to remove:

7742a6c, which updates the build script
0b9f6d1, which just runs pnpm run --filter mermaid types:build-config to regenerate the packages/mermaid/src/config.type.ts file.

Notes to reviewers

Is it worth deleting the packages/mermaid/src/config.type.ts file from this repo and .gitignore-ing it?

It's automatically generated by running pnpm run --filter mermaid types:build-config, so we could set it up to automatically be created when running pnpm install.

📋 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.
- Not applicable.
🔖 targeted develop branch

Currently, the `packages/mermaid/src/config.type.ts` types file (auto-generated via `pnpm run --filter mermaid types:build-config`) uses the default prettier config. Instead, we should use the prettier config in the Mermaid repo, as it's slightly different from the default prettier config.

Run `pnpm run --filter mermaid types:build-config` to format the `packages/mermaid/src/config.type.ts` file with the new prettier config.

codecov · 2023-08-10T00:18:39Z

Codecov Report

Merging #4715 (0b9f6d1) into develop (85a988c) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4715   +/-   ##
========================================
  Coverage    77.14%   77.15%           
========================================
  Files          146      146           
  Lines        14675    14675           
  Branches       563      563           
========================================
+ Hits         11321    11322    +1     
+ Misses        3245     3244    -1     
  Partials       109      109

Flag	Coverage Δ
e2e	`83.91% <ø> (+<0.01%)`	⬆️
unit	`46.03% <ø> (ø)`

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

see 1 file with indirect coverage changes

sidharthv96 · 2023-08-10T14:14:52Z

Is it worth deleting the packages/mermaid/src/config.type.ts file from this repo and .gitignore-ing it?

As this is a core file, which doesn't change much, I think it should be kept in the repo.

[![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.3.0` -> `10.3.1`](https://renovatebot.com/diffs/npm/mermaid/10.3.0/10.3.1) | [![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.3.0/10.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.3.0/10.3.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.3.1`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.3.1) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.3.0...v10.3.1) #### What's Changed #### Bugfixes - fix style in contributors section of intro by [@keer4n](https://togithub.com/keer4n) in [mermaid-js/mermaid#4670 - fix: [#4676](https://togithub.com/mermaid-js/mermaid/issues/4676) redirect fix by [@sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4693 - [#2139](https://togithub.com/mermaid-js/mermaid/issues/2139) Applying user defined classes properly when calculating shape width by [@knsv](https://togithub.com/knsv) in [mermaid-js/mermaid#4722 - Bug/4645 graph node containing keyword by [@ibrahimWassouf](https://togithub.com/ibrahimWassouf) in [mermaid-js/mermaid#4657 - fix: Remove triple parsing of diagrams by [@sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4697 - resolve info `HTML` and `Document` assignment by [@Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4514 - fix!(deps): fix zenuml style leakage. by [@danshuitaihejie](https://togithub.com/danshuitaihejie) in [mermaid-js/mermaid#4705 - Use our prettier config on the `packages/mermaid/src/config.type.ts` file by [@aloisklink](https://togithub.com/aloisklink) in [mermaid-js/mermaid#4715 - create `ParserDefinition` type by [@Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4719 - standardized `error` diagram by [@Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4718 #### Documentation - Docs: Directives not needed in new diagrams as yaml formatter does this for all new diagrams by [@Incognito](https://togithub.com/Incognito) in [mermaid-js/mermaid#4688 - Docs: add latest blog post by [@huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4668 - Lychee config by [@mmorel-35](https://togithub.com/mmorel-35) in [mermaid-js/mermaid#4699 - Syntax Update CONTRIBUTING.md by [@soomrozaid](https://togithub.com/soomrozaid) in [mermaid-js/mermaid#4713 #### Chores - chore(deps): update all minor dependencies (minor) by [@renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4682 - build(deps-dev): bump json5 from 2.2.1 to 2.2.3 by [@dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4685 - build(deps): bump [@braintree/sanitize-url](https://togithub.com/braintree/sanitize-url) from 6.0.0 to 6.0.1 by [@dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4686 - build(deps-dev): bump vite from 4.3.3 to 4.3.9 by [@dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4687 - chore(deps): update all patch dependencies (patch) by [@renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4681 - chore: ts-ignore comment was misleading, JISON doesn't support types by [@Incognito](https://togithub.com/Incognito) in [mermaid-js/mermaid#4689 - chore(deps): unpin the dompurify dependency by [@djadmin](https://togithub.com/djadmin) in [mermaid-js/mermaid#4677 - build(deps-dev): bump pnpm from 8.3.1 to 8.6.8 by [@dependabot](https://togithub.com/dependabot) in [mermaid-js/mermaid#4692 #### New Contributors - [@keer4n](https://togithub.com/keer4n) made their first contribution in [mermaid-js/mermaid#4670 - [@djadmin](https://togithub.com/djadmin) made their first contribution in [mermaid-js/mermaid#4677 - [@danshuitaihejie](https://togithub.com/danshuitaihejie) made their first contribution in [mermaid-js/mermaid#4705 - [@soomrozaid](https://togithub.com/soomrozaid) made their first contribution in [mermaid-js/mermaid#4713 **Full Changelog**: mermaid-js/mermaid@v10.3.0...v10.3.1 </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. --- - [ ] 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).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

aloisklink added 2 commits August 9, 2023 19:15

style: format packages/mermaid/src/config.type.ts

0b9f6d1

Run `pnpm run --filter mermaid types:build-config` to format the `packages/mermaid/src/config.type.ts` file with the new prettier config.

github-actions bot added the chore label Aug 10, 2023

aloisklink mentioned this pull request Aug 10, 2023

Add new chart xychart #4413

Merged

4 tasks

sidharthv96 approved these changes Aug 10, 2023

View reviewed changes

sidharthv96 added this pull request to the merge queue Aug 10, 2023

Merged via the queue into mermaid-js:develop with commit 66b579c Aug 10, 2023
14 checks passed

aloisklink deleted the chore/use-our-prettier-config-for-types branch August 10, 2023 14:48

renovate bot mentioned this pull request Sep 22, 2023

chore(deps): update dependencies (minor/patch) turtton/volglass#50

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use our prettier config on the `packages/mermaid/src/config.type.ts` file #4715

Use our prettier config on the `packages/mermaid/src/config.type.ts` file #4715

aloisklink commented Aug 10, 2023

codecov bot commented Aug 10, 2023 •

edited

sidharthv96 commented Aug 10, 2023

Use our prettier config on the packages/mermaid/src/config.type.ts file #4715

Use our prettier config on the packages/mermaid/src/config.type.ts file #4715

Conversation

aloisklink commented Aug 10, 2023

📑 Summary

📏 Design Decisions

Notes to reviewers

📋 Tasks

codecov bot commented Aug 10, 2023 • edited

Codecov Report

sidharthv96 commented Aug 10, 2023

Use our prettier config on the `packages/mermaid/src/config.type.ts` file #4715

Use our prettier config on the `packages/mermaid/src/config.type.ts` file #4715

codecov bot commented Aug 10, 2023 •

edited