Feature: Packet diagram can use bit counts - implements #5978

[BryanCrotazGivEnergy]

📑 Summary

Resolves #5978

📏 Design Decisions

Added bit count to parser language and calculate start and end of each field on the fly

📋 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.
• 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c828867

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	c828867
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/6713e344b794ca000886f0c8
😎 Deploy Preview	https://deploy-preview-5980--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.

[pkg-pr-new]

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@5980

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@5980

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@5980

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@5980

commit: c828867

[BryanCrotazGivEnergy]

Tried to add a feature changeset but I get Error: Failed to find where HEAD diverged from master. Does master exist?

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 32 lines in your changes missing coverage. Please review.

Project coverage is 4.64%. Comparing base (d16e46a) to head (c828867).
Report is 139 commits behind head on develop.

Files with missing lines	Patch %	Lines
packages/mermaid/src/diagrams/packet/parser.ts	0.00%	32 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #5980      +/-   ##
==========================================
- Coverage     4.64%   4.64%   -0.01%     
==========================================
  Files          374     374              
  Lines        51965   51985      +20     
  Branches       613     613              
==========================================
  Hits          2414    2414              
- Misses       49551   49571      +20     

Flag	Coverage Δ
unit	4.64% <0.00%> (-0.01%)	⬇️

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

Files with missing lines	Coverage Δ
packages/mermaid/src/diagrams/packet/parser.ts	0.00% <0.00%> (ø)

---- 🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles

[argos-ci]

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

Build	Status	Details	Updated (UTC)
default (Inspect)	✅ No changes detected	-	Oct 19, 2024, 4:57 PM

[BryanCrotazGivEnergy]

@aloisklink please review this PR - I think it's ready

[BryanCrotazGivEnergy]

What's the process to get this approved?

[zanedp]

(I just copied the following to the #5978, in case that's a better location for syntax discussions.)

I was considering using the "packet" type as a way to draw a memory map, which would be byte-scale instead of bit-scale. I wonder if a different syntax that didn't "tie" the diagram to a particular unit of measure would be more flexible? Shorting to b would make it so both "bits" and "bytes" make sense. But maybe doing something like +5 to mean it's relative to the previous thing would work and be intuitive?

+16: Header
+32: Data
+4: Footer

Using + is similar to "relative time" in PlantUML's timing diagram.