11772 Commits

Author SHA1 Message Date
Alois Klink
5fabd414fb fix: error mermaid.parse on invalid shapes
Currently, invalid shapes cause an error when rendering, but not when
parsing. This confuses the Mermaid Live Editor, e.g. by not showing the
error message.

Instead, I've added an `isValidShape()` that validates if the shape is
valid at parse time. This only checks shapes using the new extended
shapes syntax. Currenlty, using `A(-this is an ellipse node-)` is broken
(see #5976) and also causes an invalid shape error at render time, but
I've ignored it in this PR, so it will continue pass at parse-time
(we have unit tests checking ellipse parsing).

See: https://github.com/mermaid-js/mermaid/issues/5976
2024-10-28 23:17:13 +09:00
Alois Klink
17e2f9e0d4 refactor: fix addVertex type parameter
I went through
`packages/mermaid/src/diagrams/flowchart/parser/flow.jison` and found
every possible value this `type` parameter could be.
2024-10-28 23:17:13 +09:00
Alois Klink
7fa8b35bdc refactor: convert if-statements to switch..case 2024-10-28 23:17:13 +09:00
Sidharth Vinod
e765007b21
Merge pull request #5974 from aloisklink/refactor/improving-rendering-shape-types
refactor: TypeScript improvements to `packages/mermaid/src/rendering-util/rendering-elements`
2024-10-28 18:22:23 +05:30
Sidharth Vinod
b5cd101d86
Merge branch 'develop' into refactor/improving-rendering-shape-types 2024-10-28 18:11:41 +05:30
Alois Klink
f8746bee04 refactor: move MaybePromise type to src/types.ts
Suggested-by: https://github.com/mermaid-js/mermaid/pull/5974#discussion_r1810562136
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2024-10-22 21:49:23 +09:00
Alois Klink
bb97fdbd1e refactor: use parseFontSize()
Handle `NaN` values by using `parseFontSize()`.

Suggested-by: https://github.com/mermaid-js/mermaid/pull/5974#discussion_r1810570967
2024-10-22 21:49:02 +09:00
Alois Klink
6cc0132e0a refactor(elk): add LabelData type for layout-elk
I don't know what exactly the type does or is for, but I've tried to
type it to what it seems to be.
2024-10-21 22:23:36 +09:00
Alois Klink
4bc70b7325 refactor: use more standard types
See: https://github.com/mermaid-js/mermaid/pull/5974#discussion_r1806473749
See: https://github.com/mermaid-js/mermaid/pull/5974#discussion_r1808511738

Co-authored-by: saurabhg772244 <saurabh@mermaidchart.com>
2024-10-21 22:23:36 +09:00
Alois Klink
d16e46a386
Merge pull request #5972 from gabeidx/zed-mermaid
docs(ecosystem): Add Zed extension zed-mermaid
2024-10-18 08:45:30 +00:00
Alois Klink
97820a50c2
Merge pull request #5918 from vorburger/patch-2
docs: Fix inconsistency in Block Diagram doc example
2024-10-18 08:42:34 +00:00
Alois Klink
df948bcf2c
Merge pull request #5968 from eitsupi/fix-ssg
docs(integrations): fix listing order
2024-10-18 08:39:31 +00:00
Alois Klink
cfd097b029
Merge pull request #5967 from yihui/patch-1
docs: bullet lists should not be code blocks
2024-10-18 08:37:12 +00:00
Alois Klink
ffc1fef599
Merge pull request #5957 from TomasHubelbauer/patch-1
Remove extraneous period
2024-10-18 08:36:31 +00:00
Alois Klink
1e8e4e4b73
Merge branch 'develop' into patch-2 2024-10-18 08:34:07 +00:00
autofix-ci[bot]
606ecf8990
[autofix.ci] apply automated fixes 2024-10-17 17:42:10 +00:00
Alois Klink
16a5fc05d6 refactor: remove some any types from render()
This let's us confirm that the types we're passing to `insertNode()` are
valid.
2024-10-18 01:51:53 +09:00
Alois Klink
62fd359c0e refactor: convert shapes/util.js to TypeScript
Convert the
`packages/mermaid/src/rendering-util/rendering-elements/shapes/util.js`
file to TypeScript at:
`packages/mermaid/src/rendering-util/rendering-elements/shapes/util.ts`.
2024-10-18 01:51:53 +09:00
Alois Klink
b0f4ace3a1 refactor: convert rendering-elements/nodes to TS
Convert the
`packages/mermaid/src/rendering-util/rendering-elements/nodes.js`
file to TypeScript at
`packages/mermaid/src/rendering-util/rendering-elements/nodes.ts`
2024-10-18 01:51:53 +09:00
Alois Klink
9afb181d06 refactor: correct shapes types
All of the shapes in
`packages/mermaid/src/rendering-util/rendering-elements/shapes/` use
`D3.Selection`s as input parameters and as return parameters.

Although, for some reason, passing them to roughjs seems to work?
2024-10-17 22:29:38 +09:00
Alois Klink
cfe7cce41d refactor: improve types of shapes
Instead of being a `Record<string, ShapeHandler>`, the type now knows
every key in the variable.
2024-10-17 18:59:43 +09:00
autofix-ci[bot]
33029c8bd2
[autofix.ci] apply automated fixes 2024-10-17 08:31:48 +00:00
Gabriel Silva
e54d10c706
docs(ecosystem): Add Zed extension zed-mermaid to community integrations 2024-10-17 10:21:15 +02:00
eitsupi
8aa87c7091
docs(integrations): fix listing order 2024-10-16 21:36:26 +09:00
autofix-ci[bot]
e1024838e8
[autofix.ci] apply automated fixes 2024-10-16 03:52:48 +00:00
Yihui Xie
4cce43f0a1
Bullet lists should not be code blocks 2024-10-15 22:45:38 -05:00
autofix-ci[bot]
c69ab34eac
[autofix.ci] apply automated fixes 2024-10-11 20:27:05 +00:00
Tomáš Hübelbauer
7353be3b16
Remove extraneous period
Other cells in the table do not end with one.
2024-10-11 22:21:23 +02:00
Sidharth Vinod
742531a2c2
Merge pull request #5951 from gbremond/docs/5949_update-icon-name-for-database
docs(architecture): update icon name for database in exemple
2024-10-11 06:12:42 +00:00
g.bremont-ext
2c31a599af docs(architecture): use right icon for database in exemple 2024-10-10 17:00:13 +02:00
autofix-ci[bot]
2655be0bad
[autofix.ci] apply automated fixes 2024-10-10 14:21:46 +00:00
g.bremont-ext
4f97c8c70e docs(architecture): update icon name for database in exemple 2024-10-10 16:15:23 +02:00
Sidharth Vinod
f85977246c
Merge pull request #5945 from mermaid-js/saurabh/doc-update
Updated doc for image and icon shapes
2024-10-10 16:46:02 +05:30
saurabhg772244
a4fd42214b Use relative URL in linking docs 2024-10-10 15:17:26 +05:30
saurabhg772244
ca885027d4 Moved position for icon config and added major version in icon docs 2024-10-10 14:15:16 +05:30
saurabhg772244
9f6f1e96e5 Added new doc for registering icon pack in mermaid 2024-10-10 13:11:54 +05:30
saurabhg772244
351ce30d8a Merge branch 'develop' of https://github.com/mermaid-js/mermaid into saurabh/doc-update 2024-10-10 12:26:14 +05:30
Sidharth Vinod
2933eb5c28
fix: Build options 2024-10-09 16:44:51 +05:30
saurabhg772244
09ecf76034 Updated doc for image and icon shapes 2024-10-09 15:34:12 +05:30
Sidharth Vinod
2b86750cb3
Merge pull request #5924 from mermaid-js/sidv/autoGenerateShapeDocs
Auto generate shape docs
2024-10-09 14:11:56 +05:30
Sidharth Vinod
b45224755e
Merge branch 'develop' into sidv/autoGenerateShapeDocs 2024-10-09 13:41:43 +05:30
Sidharth Vinod
14524e1b0e
docs: Optimise document generation
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-10-09 13:39:06 +05:30
Sidharth Vinod
efa47e3176
fix: Docs vitepress build 2024-10-09 13:18:01 +05:30
Sidharth Vinod
1bc45405e0
chore: Generate shape doc before verification 2024-10-09 13:18:01 +05:30
Sidharth Vinod
3720e1a894
docs: Auto generate shape docs
Not keen on how it's currently run, open to suggestions on better ways.
2024-10-09 13:18:00 +05:30
Sidharth Vinod
76138cf3b9
chore: Decouple build logic 2024-10-09 13:17:59 +05:30
Alois Klink
2506c29f6b
Merge pull request #5937 from mermaid-js/saurabh/icon-shape-style-fix
Fix icon shape color for colored icons.
2024-10-09 07:47:34 +00:00
Sidharth Vinod
463ba6ed6d
Merge pull request #5923 from mermaid-js/sidv/refactorShapes
Refactor shapes definition
2024-10-09 13:17:06 +05:30
saurabhg772244
17b783135f Added pnpm changeset 2024-10-09 12:55:37 +05:30
saurabhg772244
8df2729bd4 Merge branch 'saurabh/icon-shape-style-fix' of https://github.com/mermaid-js/mermaid into saurabh/icon-shape-style-fix 2024-10-09 12:16:05 +05:30