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

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

Conversation

aloisklink
Copy link
Member

📑 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

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.
@github-actions github-actions bot added the chore label Aug 10, 2023
@aloisklink aloisklink mentioned this pull request Aug 10, 2023
4 tasks
@codecov
Copy link

codecov bot commented Aug 10, 2023

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

Impacted file tree graph

@@           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
Copy link
Member

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.

@sidharthv96 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 aloisklink deleted the chore/use-our-prettier-config-for-types branch August 10, 2023 14:48
fuxingloh referenced this pull request in fuxingloh/contented Aug 15, 2023
[![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
[@&#8203;keer4n](https://togithub.com/keer4n) in
[https://github.com/mermaid-js/mermaid/pull/4670](https://togithub.com/mermaid-js/mermaid/pull/4670)
- fix:
[#&#8203;4676](https://togithub.com/mermaid-js/mermaid/issues/4676)
redirect fix by [@&#8203;sidharthv96](https://togithub.com/sidharthv96)
in
[https://github.com/mermaid-js/mermaid/pull/4693](https://togithub.com/mermaid-js/mermaid/pull/4693)
- [#&#8203;2139](https://togithub.com/mermaid-js/mermaid/issues/2139)
Applying user defined classes properly when calculating shape width by
[@&#8203;knsv](https://togithub.com/knsv) in
[https://github.com/mermaid-js/mermaid/pull/4722](https://togithub.com/mermaid-js/mermaid/pull/4722)
- Bug/4645 graph node containing keyword by
[@&#8203;ibrahimWassouf](https://togithub.com/ibrahimWassouf) in
[https://github.com/mermaid-js/mermaid/pull/4657](https://togithub.com/mermaid-js/mermaid/pull/4657)
- fix: Remove triple parsing of diagrams by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[https://github.com/mermaid-js/mermaid/pull/4697](https://togithub.com/mermaid-js/mermaid/pull/4697)
- resolve info `HTML` and `Document` assignment by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[https://github.com/mermaid-js/mermaid/pull/4514](https://togithub.com/mermaid-js/mermaid/pull/4514)
- fix!(deps): fix zenuml style leakage. by
[@&#8203;danshuitaihejie](https://togithub.com/danshuitaihejie) in
[https://github.com/mermaid-js/mermaid/pull/4705](https://togithub.com/mermaid-js/mermaid/pull/4705)
- Use our prettier config on the `packages/mermaid/src/config.type.ts`
file by [@&#8203;aloisklink](https://togithub.com/aloisklink) in
[https://github.com/mermaid-js/mermaid/pull/4715](https://togithub.com/mermaid-js/mermaid/pull/4715)
- create `ParserDefinition` type by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[https://github.com/mermaid-js/mermaid/pull/4719](https://togithub.com/mermaid-js/mermaid/pull/4719)
- standardized `error` diagram by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[https://github.com/mermaid-js/mermaid/pull/4718](https://togithub.com/mermaid-js/mermaid/pull/4718)

#### Documentation

- Docs: Directives not needed in new diagrams as yaml formatter does
this for all new diagrams by
[@&#8203;Incognito](https://togithub.com/Incognito) in
[https://github.com/mermaid-js/mermaid/pull/4688](https://togithub.com/mermaid-js/mermaid/pull/4688)
- Docs: add latest blog post by
[@&#8203;huynhicode](https://togithub.com/huynhicode) in
[https://github.com/mermaid-js/mermaid/pull/4668](https://togithub.com/mermaid-js/mermaid/pull/4668)
- Lychee config by [@&#8203;mmorel-35](https://togithub.com/mmorel-35)
in
[https://github.com/mermaid-js/mermaid/pull/4699](https://togithub.com/mermaid-js/mermaid/pull/4699)
- Syntax Update CONTRIBUTING.md by
[@&#8203;soomrozaid](https://togithub.com/soomrozaid) in
[https://github.com/mermaid-js/mermaid/pull/4713](https://togithub.com/mermaid-js/mermaid/pull/4713)

#### Chores

- chore(deps): update all minor dependencies (minor) by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/mermaid-js/mermaid/pull/4682](https://togithub.com/mermaid-js/mermaid/pull/4682)
- build(deps-dev): bump json5 from 2.2.1 to 2.2.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/4685](https://togithub.com/mermaid-js/mermaid/pull/4685)
- build(deps): bump
[@&#8203;braintree/sanitize-url](https://togithub.com/braintree/sanitize-url)
from 6.0.0 to 6.0.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/4686](https://togithub.com/mermaid-js/mermaid/pull/4686)
- build(deps-dev): bump vite from 4.3.3 to 4.3.9 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/4687](https://togithub.com/mermaid-js/mermaid/pull/4687)
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[https://github.com/mermaid-js/mermaid/pull/4681](https://togithub.com/mermaid-js/mermaid/pull/4681)
- chore: ts-ignore comment was misleading, JISON doesn't support types
by [@&#8203;Incognito](https://togithub.com/Incognito) in
[https://github.com/mermaid-js/mermaid/pull/4689](https://togithub.com/mermaid-js/mermaid/pull/4689)
- chore(deps): unpin the dompurify dependency by
[@&#8203;djadmin](https://togithub.com/djadmin) in
[https://github.com/mermaid-js/mermaid/pull/4677](https://togithub.com/mermaid-js/mermaid/pull/4677)
- build(deps-dev): bump pnpm from 8.3.1 to 8.6.8 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/mermaid-js/mermaid/pull/4692](https://togithub.com/mermaid-js/mermaid/pull/4692)

#### New Contributors

- [@&#8203;keer4n](https://togithub.com/keer4n) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/4670](https://togithub.com/mermaid-js/mermaid/pull/4670)
- [@&#8203;djadmin](https://togithub.com/djadmin) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/4677](https://togithub.com/mermaid-js/mermaid/pull/4677)
- [@&#8203;danshuitaihejie](https://togithub.com/danshuitaihejie) made
their first contribution in
[https://github.com/mermaid-js/mermaid/pull/4705](https://togithub.com/mermaid-js/mermaid/pull/4705)
- [@&#8203;soomrozaid](https://togithub.com/soomrozaid) made their first
contribution in
[https://github.com/mermaid-js/mermaid/pull/4713](https://togithub.com/mermaid-js/mermaid/pull/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.

---

- [ ] <!-- 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:eyJjcmVhdGVkSW5WZXIiOiIzNi40MC4zIiwidXBkYXRlZEluVmVyIjoiMzYuNDMuMiIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

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

Successfully merging this pull request may close these issues.

2 participants