-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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
Merged
sidharthv96
merged 2 commits into
mermaid-js:develop
from
aloisklink:chore/use-our-prettier-config-for-types
Aug 10, 2023
Merged
Use our prettier config on the packages/mermaid/src/config.type.ts
file
#4715
sidharthv96
merged 2 commits into
mermaid-js:develop
from
aloisklink:chore/use-our-prettier-config-for-types
Aug 10, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 Report
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
Flags with carried forward coverage won't be shown. Click here to find out more. |
sidharthv96
approved these changes
Aug 10, 2023
As this is a core file, which doesn't change much, I think it should be kept in the repo. |
fuxingloh
pushed a commit
to fuxingloh/contented
that referenced
this pull request
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://github.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://github.com/mermaid-js/mermaid/releases/tag/v10.3.1) [Compare Source](https://github.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://github.com/keer4n) in [mermaid-js/mermaid#4670 - fix: [#​4676](https://github.com/mermaid-js/mermaid/issues/4676) redirect fix by [@​sidharthv96](https://github.com/sidharthv96) in [mermaid-js/mermaid#4693 - [#​2139](https://github.com/mermaid-js/mermaid/issues/2139) Applying user defined classes properly when calculating shape width by [@​knsv](https://github.com/knsv) in [mermaid-js/mermaid#4722 - Bug/4645 graph node containing keyword by [@​ibrahimWassouf](https://github.com/ibrahimWassouf) in [mermaid-js/mermaid#4657 - fix: Remove triple parsing of diagrams by [@​sidharthv96](https://github.com/sidharthv96) in [mermaid-js/mermaid#4697 - resolve info `HTML` and `Document` assignment by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4514 - fix!(deps): fix zenuml style leakage. by [@​danshuitaihejie](https://github.com/danshuitaihejie) in [mermaid-js/mermaid#4705 - Use our prettier config on the `packages/mermaid/src/config.type.ts` file by [@​aloisklink](https://github.com/aloisklink) in [mermaid-js/mermaid#4715 - create `ParserDefinition` type by [@​Yokozuna59](https://github.com/Yokozuna59) in [mermaid-js/mermaid#4719 - standardized `error` diagram by [@​Yokozuna59](https://github.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://github.com/Incognito) in [mermaid-js/mermaid#4688 - Docs: add latest blog post by [@​huynhicode](https://github.com/huynhicode) in [mermaid-js/mermaid#4668 - Lychee config by [@​mmorel-35](https://github.com/mmorel-35) in [mermaid-js/mermaid#4699 - Syntax Update CONTRIBUTING.md by [@​soomrozaid](https://github.com/soomrozaid) in [mermaid-js/mermaid#4713 #### Chores - chore(deps): update all minor dependencies (minor) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4682 - build(deps-dev): bump json5 from 2.2.1 to 2.2.3 by [@​dependabot](https://github.com/dependabot) in [mermaid-js/mermaid#4685 - build(deps): bump [@​braintree/sanitize-url](https://github.com/braintree/sanitize-url) from 6.0.0 to 6.0.1 by [@​dependabot](https://github.com/dependabot) in [mermaid-js/mermaid#4686 - build(deps-dev): bump vite from 4.3.3 to 4.3.9 by [@​dependabot](https://github.com/dependabot) in [mermaid-js/mermaid#4687 - chore(deps): update all patch dependencies (patch) by [@​renovate](https://github.com/renovate) in [mermaid-js/mermaid#4681 - chore: ts-ignore comment was misleading, JISON doesn't support types by [@​Incognito](https://github.com/Incognito) in [mermaid-js/mermaid#4689 - chore(deps): unpin the dompurify dependency by [@​djadmin](https://github.com/djadmin) in [mermaid-js/mermaid#4677 - build(deps-dev): bump pnpm from 8.3.1 to 8.6.8 by [@​dependabot](https://github.com/dependabot) in [mermaid-js/mermaid#4692 #### New Contributors - [@​keer4n](https://github.com/keer4n) made their first contribution in [mermaid-js/mermaid#4670 - [@​djadmin](https://github.com/djadmin) made their first contribution in [mermaid-js/mermaid#4677 - [@​danshuitaihejie](https://github.com/danshuitaihejie) made their first contribution in [mermaid-js/mermaid#4705 - [@​soomrozaid](https://github.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. --- - [ ] <!-- 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
Currently, the
packages/mermaid/src/config.type.ts
types file (auto-generated viapnpm 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:
pnpm run --filter mermaid types:build-config
to regenerate thepackages/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 runningpnpm install
.📋 Tasks
Make sure you
MERMAID_RELEASE_VERSION
is used for all new features.develop
branch