@zombie-mermaid/mermaid-parser 4.1.0 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zombie-mermaid/mermaid-parser",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "license": "MIT",
   "description": "Parsers for class, ER, sequence, and XY chart diagrams — the per-type parse functions both svg-renderer and ascii-renderer import directly.",
   "repository": {
@@ -35,6 +35,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@zombie-mermaid/core": "4.1.0"
+    "@zombie-mermaid/core": "4.2.0"
   }
 }

package/src/__tests__/flowchart-edge-label-space-before-pipe.test.ts

@@ -0,0 +1,54 @@
+import { describe, it, expect } from 'vitest'
+import { parseMermaid } from '../flowchart-parser.ts'
+
+// Upstream lukilabs/beautiful-mermaid#156: `A --> |label| B` (space before the
+// label pipe) used to drop the target and label.
+describe('edge label with a space before the pipe', () => {
+  const cases = [
+    ['-->', 'solid', true],
+    ['---', 'solid', false],
+    ['-.->', 'dotted', true],
+    ['==>', 'thick', true],
+  ] as const
+
+  for (const [op, style, hasArrowEnd] of cases) {
+    it(`parses A ${op} |deploy| B`, () => {
+      const g = parseMermaid(`graph LR\n  A ${op} |deploy| B`)
+      expect(g.edges).toHaveLength(1)
+      expect(g.edges[0]).toMatchObject({
+        source: 'A',
+        target: 'B',
+        label: 'deploy',
+        style,
+        hasArrowEnd,
+      })
+    })
+
+    it(`parses A ${op}  |deploy| B identically to the no-space form`, () => {
+      const spaced = parseMermaid(`graph LR\n  A ${op}  |deploy| B`)
+      const tight = parseMermaid(`graph LR\n  A ${op}|deploy| B`)
+      expect(spaced.edges).toEqual(tight.edges)
+    })
+  }
+
+  it('still parses the no-space form', () => {
+    const g = parseMermaid('graph LR\n  A -->|deploy| B')
+    expect(g.edges[0]).toMatchObject({ target: 'B', label: 'deploy' })
+  })
+
+  it('does not treat an unmarked `--`/`==` before a pipe as an arrow', () => {
+    // `--`/`==` unmarked is the text-label opener, so this must not become a
+    // labelled link with target B and label `x`.
+    for (const src of ['graph LR\n  A -- |x| B', 'graph LR\n  A == |x| B']) {
+      const g = parseMermaid(src)
+      expect(g.edges.some((e) => e.label === 'x' && e.target === 'B')).toBe(
+        false,
+      )
+    }
+  })
+
+  it('keeps text-embedded labels working', () => {
+    const g = parseMermaid('graph LR\n  A -- Yes --> B')
+    expect(g.edges[0]).toMatchObject({ target: 'B', label: 'Yes' })
+  })
+})

package/src/__tests__/pie-mermaid-spec.test.ts

@@ -0,0 +1,308 @@
+import { describe, it, expect } from 'vitest'
+import { parsePieChart } from '../index.ts'
+
+// Fixtures ported from Mermaid's own pie tests (mermaid-js/mermaid, MIT):
+//   - packages/mermaid/src/diagrams/pie/pie.spec.ts (parser + pieDb)
+//   - packages/parser/tests/pie.test.ts (the Langium grammar)
+// Inputs are copied verbatim; assertions are translated from Mermaid's
+// `db.getSections()` Map / AST shape to this package's `PieChart`. The two
+// `config` cases in pie.spec.ts (`it.todo` setConfig/resetConfig, and
+// getConfig defaults) test Mermaid's diagram config, not parsing, and are
+// left for the follow-up that adds `%%{init: {"pie": …}}%%` support.
+
+/** `db.getSections()` equivalent: label → value, in source order. */
+const sections = (text: string): Map<string, number> =>
+  new Map(parsePieChart(text).slices.map((s) => [s.label, s.value]))
+
+describe('mermaid pie.spec.ts: parse', () => {
+  it('should handle very simple pie', () => {
+    expect(
+      sections(`pie
+      "ash": 100
+      `).get('ash'),
+    ).toBe(100)
+  })
+
+  it('should handle simple pie', () => {
+    const s = sections(`pie
+      "ash" : 60
+      "bat" : 40
+      `)
+    expect(s.get('ash')).toBe(60)
+    expect(s.get('bat')).toBe(40)
+  })
+
+  it('should handle simple pie with showData', () => {
+    const chart = parsePieChart(`pie showData
+      "ash" : 60
+      "bat" : 40
+      `)
+    expect(chart.showData).toBe(true)
+    expect(chart.slices).toEqual([
+      { label: 'ash', value: 60 },
+      { label: 'bat', value: 40 },
+    ])
+  })
+
+  it('should handle simple pie with comments', () => {
+    const s = sections(`pie
+      %% comments
+      "ash" : 60
+      "bat" : 40
+      `)
+    expect(s.get('ash')).toBe(60)
+    expect(s.get('bat')).toBe(40)
+  })
+
+  it('should handle simple pie with a title', () => {
+    const chart = parsePieChart(`pie title a 60/40 pie
+      "ash" : 60
+      "bat" : 40
+      `)
+    expect(chart.title).toBe('a 60/40 pie')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle simple pie with an acc title (accTitle)', () => {
+    const chart = parsePieChart(`pie title a neat chart
+      accTitle: a neat acc title
+      "ash" : 60
+      "bat" : 40
+      `)
+    expect(chart.title).toBe('a neat chart')
+    expect(chart.accTitle).toBe('a neat acc title')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle simple pie with an acc description (accDescr)', () => {
+    const chart = parsePieChart(`pie title a neat chart
+      accDescr: a neat description
+      "ash" : 60
+      "bat" : 40
+      `)
+    expect(chart.title).toBe('a neat chart')
+    expect(chart.accDescr).toBe('a neat description')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle simple pie with a multiline acc description (accDescr)', () => {
+    const chart = parsePieChart(`pie title a neat chart
+      accDescr {
+        a neat description
+        on multiple lines
+      }
+      "ash" : 60
+      "bat" : 40
+    `)
+    expect(chart.title).toBe('a neat chart')
+    expect(chart.accDescr).toBe('a neat description\non multiple lines')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle simple pie with positive decimal', () => {
+    const s = sections(`pie
+      "ash" : 60.67
+      "bat" : 40
+      `)
+    expect(s.get('ash')).toBe(60.67)
+    expect(s.get('bat')).toBe(40)
+  })
+
+  it('should handle simple pie with negative decimal', () => {
+    expect(() =>
+      parsePieChart(`pie
+        "ash" : -60.67
+        "bat" : 40.12
+        `),
+    ).toThrow()
+  })
+
+  it('should handle simple pie with zero slice value', () => {
+    const s = sections(`pie title Default text position: Animal adoption
+        accTitle: simple pie char demo
+        accDescr: pie chart with 3 sections: dogs, cats, rats. Most are dogs.
+         "dogs" : 0
+        "rats" : 40.12
+      `)
+    expect(s.get('dogs')).toBe(0)
+    expect(s.get('rats')).toBe(40.12)
+  })
+
+  it('should handle simple pie with negative slice value', () => {
+    expect(() =>
+      parsePieChart(`pie title Default text position: Animal adoption
+        accTitle: simple pie char demo
+        accDescr: pie chart with 3 sections: dogs, cats, rats. Most are dogs.
+         "dogs" : -60.67
+        "rats" : 40.12
+    `),
+    ).toThrow(
+      '"dogs" has invalid value: -60.67. Negative values are not allowed in pie charts. All slice values must be >= 0.',
+    )
+  })
+
+  it('should handle unsafe properties', () => {
+    const chart = parsePieChart(`pie title Unsafe props test
+        "__proto__" : 386
+        "constructor" : 85
+        "prototype" : 15`)
+    expect(chart.slices.map((s) => s.label)).toEqual([
+      '__proto__',
+      'constructor',
+      'prototype',
+    ])
+  })
+})
+
+describe('mermaid parser/tests/pie.test.ts: header with or without showData', () => {
+  it.each([
+    `pie`,
+    `  pie  `,
+    `\tpie\t`,
+    `
+    \tpie
+    `,
+  ])('should handle regular pie: %j', (context) => {
+    const chart = parsePieChart(context)
+    expect(chart.showData).toBe(false)
+    expect(chart.slices).toEqual([])
+  })
+
+  it.each([
+    `pie showData`,
+    `  pie  showData  `,
+    `\tpie\tshowData\t`,
+    `
+    pie\tshowData
+    `,
+  ])('should handle regular showData: %j', (context) => {
+    expect(parsePieChart(context).showData).toBe(true)
+  })
+})
+
+describe('mermaid parser/tests/pie.test.ts: TitleAndAccessibilities', () => {
+  it.each([
+    `pie title sample title`,
+    `  pie  title sample title  `,
+    `\tpie\ttitle sample title\t`,
+    `pie
+        \ttitle sample title
+        `,
+  ])('should handle regular pie + title in same line: %j', (context) => {
+    expect(parsePieChart(context).title).toBe('sample title')
+  })
+
+  it.each([
+    `pie
+        title sample title`,
+    `pie
+        title sample title
+        `,
+  ])('should handle regular pie + title in different line: %j', (context) => {
+    expect(parsePieChart(context).title).toBe('sample title')
+  })
+
+  it.each([
+    `pie showData title sample title`,
+    `pie showData title sample title
+        `,
+  ])('should handle regular pie + showData + title: %j', (context) => {
+    const chart = parsePieChart(context)
+    expect(chart.showData).toBe(true)
+    expect(chart.title).toBe('sample title')
+  })
+
+  it.each([
+    `pie showData
+        title sample title`,
+    `pie showData
+        title sample title
+        `,
+  ])(
+    'should handle regular showData + title in different line: %j',
+    (context) => {
+      const chart = parsePieChart(context)
+      expect(chart.showData).toBe(true)
+      expect(chart.title).toBe('sample title')
+    },
+  )
+})
+
+describe('mermaid parser/tests/pie.test.ts: sections', () => {
+  it.each([
+    `pie
+        "GitHub":100
+        "GitLab":50`,
+    `pie
+        "GitHub"   :   100
+        "GitLab"   :   50`,
+    `pie
+        "GitHub"\t:\t100
+        "GitLab"\t:\t50`,
+    `pie
+        \t"GitHub" \t : \t 100
+        \t"GitLab" \t : \t  50
+        `,
+  ])('should handle regular sections: %j', (context) => {
+    expect(parsePieChart(context).slices).toEqual([
+      { label: 'GitHub', value: 100 },
+      { label: 'GitLab', value: 50 },
+    ])
+  })
+
+  it('should handle sections with showData', () => {
+    const chart = parsePieChart(`pie showData
+        "GitHub": 100
+        "GitLab": 50`)
+    expect(chart.showData).toBe(true)
+    expect(chart.slices).toEqual([
+      { label: 'GitHub', value: 100 },
+      { label: 'GitLab', value: 50 },
+    ])
+  })
+
+  it('should handle sections with title', () => {
+    const chart = parsePieChart(`pie title sample wow
+        "GitHub": 100
+        "GitLab": 50`)
+    expect(chart.title).toBe('sample wow')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle value with positive decimal', () => {
+    expect(
+      parsePieChart(`pie
+        "ash": 60.67
+        "bat": 40`).slices,
+    ).toEqual([
+      { label: 'ash', value: 60.67 },
+      { label: 'bat', value: 40 },
+    ])
+  })
+
+  it('should handle sections with accTitle', () => {
+    const chart = parsePieChart(`pie accTitle: sample wow
+        "GitHub": 100
+        "GitLab": 50`)
+    expect(chart.accTitle).toBe('sample wow')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle sections with single line accDescr', () => {
+    const chart = parsePieChart(`pie accDescr: sample wow
+        "GitHub": 100
+        "GitLab": 50`)
+    expect(chart.accDescr).toBe('sample wow')
+    expect(chart.slices).toHaveLength(2)
+  })
+
+  it('should handle sections with multi line accDescr', () => {
+    const chart = parsePieChart(`pie accDescr {
+            sample wow
+        }
+        "GitHub": 100
+        "GitLab": 50`)
+    expect(chart.accDescr).toBe('sample wow')
+    expect(chart.slices).toHaveLength(2)
+  })
+})