mermaid-js · sidharthv96 · Jan 23, 2024 · Sep 14, 2023 · Sep 14, 2023 · Sep 14, 2023
diff --git a/.build/jsonSchema.ts b/.build/jsonSchema.ts
@@ -24,6 +24,7 @@ const MERMAID_CONFIG_DIAGRAM_KEYS = [
   'gitGraph',
   'c4',
   'sankey',
+  'packet',
 ] as const;
 
 /**

diff --git a/.esbuild/build.ts b/.esbuild/build.ts
@@ -1,8 +1,8 @@
 import { build } from 'esbuild';
 import { mkdir, writeFile } from 'node:fs/promises';
-import { MermaidBuildOptions, defaultOptions, getBuildConfig } from './util.js';
 import { packageOptions } from '../.build/common.js';
 import { generateLangium } from '../.build/generateLangium.js';
+import { MermaidBuildOptions, defaultOptions, getBuildConfig } from './util.js';
 
 const shouldVisualize = process.argv.includes('--visualize');
 
@@ -56,7 +56,7 @@ const main = async () => {
   await generateLangium();
   await mkdir('stats').catch(() => {});
   const packageNames = Object.keys(packageOptions) as (keyof typeof packageOptions)[];
-  // it should build `parser` before `mermaid` because it's a dependecy
+  // it should build `parser` before `mermaid` because it's a dependency
   for (const pkg of packageNames) {
     await buildPackage(pkg).catch(handler);
   }

diff --git a/.esbuild/server.ts b/.esbuild/server.ts
@@ -9,9 +9,10 @@ import { generateLangium } from '../.build/generateLangium.js';
 const parserCtx = await context(
   getBuildConfig({ ...defaultOptions, minify: false, core: false, entryName: 'parser' })
 );
-const mermaidCtx = await context(
-  getBuildConfig({ ...defaultOptions, minify: false, core: false, entryName: 'mermaid' })
-);
+const mermaidCtx = await context({
+  ...getBuildConfig({ ...defaultOptions, minify: false, core: false, entryName: 'mermaid' }),
+  sourcemap: 'linked',
+});
 const mermaidIIFECtx = await context(
   getBuildConfig({
     ...defaultOptions,

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -14,5 +14,5 @@ Make sure you
 
 - [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
 - [ ] :computer: have added necessary unit/e2e tests.
-- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/docs/community/development.md#3-update-documentation) is used for all new features.
+- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/docs/community/code.md#3-update-documentation) is used for all new features.
 - [ ] :bookmark: targeted `develop` branch
diff --git a/__mocks__/c4Renderer.js b/__mocks__/c4Renderer.js
diff --git a/__mocks__/classRenderer-v2.js b/__mocks__/classRenderer-v2.js
diff --git a/__mocks__/classRenderer.js b/__mocks__/classRenderer.js
diff --git a/__mocks__/dagre-d3.ts b/__mocks__/dagre-d3.ts
diff --git a/__mocks__/entity-decode/browser.ts b/__mocks__/entity-decode/browser.ts
diff --git a/__mocks__/erRenderer.js b/__mocks__/erRenderer.js
diff --git a/__mocks__/flowRenderer-v2.js b/__mocks__/flowRenderer-v2.js
diff --git a/__mocks__/ganttRenderer.js b/__mocks__/ganttRenderer.js
diff --git a/__mocks__/gitGraphRenderer.js b/__mocks__/gitGraphRenderer.js
diff --git a/__mocks__/journeyRenderer.js b/__mocks__/journeyRenderer.js
diff --git a/__mocks__/pieRenderer.ts b/__mocks__/pieRenderer.ts
diff --git a/__mocks__/requirementRenderer.js b/__mocks__/requirementRenderer.js
diff --git a/__mocks__/sankeyRenderer.js b/__mocks__/sankeyRenderer.js
diff --git a/__mocks__/sequenceRenderer.js b/__mocks__/sequenceRenderer.js
diff --git a/__mocks__/stateRenderer-v2.js b/__mocks__/stateRenderer-v2.js
diff --git a/cypress/integration/rendering/packet.spec.ts b/cypress/integration/rendering/packet.spec.ts
@@ -0,0 +1,67 @@
+import { imgSnapshotTest } from '../../helpers/util';
+
+describe('packet structure', () => {
+  it('should render a simple packet diagram', () => {
+    imgSnapshotTest(
+      `packet-beta
+  title Hello world
+  0-10: "hello"
+`
+    );
+  });
+
+  it('should render a complex packet diagram', () => {
+    imgSnapshotTest(
+      `packet-beta
+        0-15: "Source Port"
+        16-31: "Destination Port"
+        32-63: "Sequence Number"
+        64-95: "Acknowledgment Number"
+        96-99: "Data Offset"
+        100-105: "Reserved"
+        106: "URG"
+        107: "ACK"
+        108: "PSH"
+        109: "RST"
+        110: "SYN"
+        111: "FIN"
+        112-127: "Window"
+        128-143: "Checksum"
+        144-159: "Urgent Pointer"
+        160-191: "(Options and Padding)"
+        192-223: "data"
+      `
+    );
+  });
+
+  it('should render a complex packet diagram with showBits false', () => {
+    imgSnapshotTest(
+      `
+      ---
+      title: "Packet Diagram"
+      config:
+        packet:
+          showBits: false
+      ---
+      packet-beta
+        0-15: "Source Port"
+        16-31: "Destination Port"
+        32-63: "Sequence Number"
+        64-95: "Acknowledgment Number"
+        96-99: "Data Offset"
+        100-105: "Reserved"
+        106: "URG"
+        107: "ACK"
+        108: "PSH"
+        109: "RST"
+        110: "SYN"
+        111: "FIN"
+        112-127: "Window"
+        128-143: "Checksum"
+        144-159: "Urgent Pointer"
+        160-191: "(Options and Padding)"
+        192-223: "data"
+      `
+    );
+  });
+});