refactor!(git): default to useMaxWidth true

[aloisklink]

📑 Summary

Change the default value for gitGraphs.useMaxWidth to true, as all mermaid diagrams default to useMaxWidth as true, with the exception of Sankey diagrams and git graphs.

The documentation currently says it defaults to true, so changing this matches the documentation. See:

mermaid/packages/mermaid/src/schemas/config.schema.yaml

Lines 306 to 312 in d4d7ca7

	useMaxWidth:
	description: |
	When this flag is set to `true`, the height and width is set to 100%
	and is then scaled with the available space.
	If set to `false`, the absolute space required is used.
	type: boolean
	default: true

BREAKING CHANGE: Changes the default value of useMaxWidth for gitgraphs to true. This is technically a breaking change, but considering that most of the other diagrams default to true, I think this is unlikely to impact anybody.

However, if anybody does want the old behavior, they can always explicitly set { gitGraph: { useMaxWidth: false } }.

📏 Design Decisions

N/A

📋 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.
  • Aligns the code with the existing documentation at https://mermaid.js.org/config/schema-docs/config-defs-base-diagram-config.html#usemaxwidth
• 🔖 targeted develop branch

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	6b5286e
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/66c469d203851b0008ec7407
😎 Deploy Preview	https://deploy-preview-5723--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

All modified and coverable lines are covered by tests ✅

Project coverage is 5.21%. Comparing base (04c29e2) to head (6b5286e).
Report is 18 commits behind head on develop.

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #5723      +/-   ##
==========================================
- Coverage     5.22%   5.21%   -0.02%     
==========================================
  Files          323     323              
  Lines        46212   46205       -7     
  Branches       537     537              
==========================================
- Hits          2415    2408       -7     
  Misses       43797   43797              

Flag	Coverage Δ
unit	5.21% <ø> (-0.02%)	⬇️

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

Files	Coverage Δ
packages/mermaid/src/defaultConfig.ts	45.78% <ø> (-1.36%)	⬇️

[argos-ci]

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	⚠️ Changes detected (Review)	84 changed	Aug 20, 2024, 10:15 AM