marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-23 17:29:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge from develop

Browse Source
This commit is contained in:
Ashish Jain
2024-09-09 11:15:42 +02:00
parent 9467735fab cc61629a8c
commit 0ade03c4de
14 changed files with 96 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
.github/workflows/release-preview.yml vendored Normal file
View File

@@ -0,0 +1,42 @@
name: Preview release
on:
pull_request:
branches: [develop]
concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}
cancel-in-progress: true
permissions:
contents: read
actions: write
jobs:
preview:
if: ${{ github.repository_owner == 'mermaid-js' }}
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
issues: write
pull-requests: write
name: Publish preview release
timeout-minutes: 5
steps:
- name: Checkout Repo
uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
- uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0
- name: Setup Node.js
uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
with:
cache: pnpm
node-version-file: '.node-version'
- name: Install Packages
run: pnpm install --frozen-lockfile
- name: Publish packages
run: pnpx pkg-pr-new publish --pnpm './packages/*'

3
Dockerfile
View File

@@ -5,6 +5,9 @@ USER 0:0
RUN corepack enable \ RUN corepack enable \
&& corepack enable pnpm && corepack enable pnpm
RUN apk add --no-cache git~=2.43.4 \
&& git config --add --system safe.directory /mermaid
ENV NODE_OPTIONS="--max_old_space_size=8192" ENV NODE_OPTIONS="--max_old_space_size=8192"
EXPOSE 9000 3333 EXPOSE 9000 3333

8
docs/config/setup/interfaces/mermaid.LayoutData.md
View File

@@ -16,11 +16,11 @@
### config ### config
• **config**: `MermaidConfig` • **config**: [`MermaidConfig`](mermaid.MermaidConfig.md)
#### Defined in #### Defined in
[packages/mermaid/src/rendering-util/types.d.ts:118](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.d.ts#L118) [packages/mermaid/src/rendering-util/types.ts:117](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L117)
--- ---
@@ -30,7 +30,7 @@
#### Defined in #### Defined in
[packages/mermaid/src/rendering-util/types.d.ts:117](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.d.ts#L117) [packages/mermaid/src/rendering-util/types.ts:116](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L116)
--- ---
@@ -40,4 +40,4 @@
#### Defined in #### Defined in
[packages/mermaid/src/rendering-util/types.d.ts:116](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.d.ts#L116) [packages/mermaid/src/rendering-util/types.ts:115](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/types.ts#L115)

2
docs/ecosystem/integrations-community.md
View File

@@ -145,7 +145,7 @@ Communication tools and platforms
- [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid) - [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid)
- [PmWiki](https://www.pmwiki.org) - [PmWiki](https://www.pmwiki.org)
- [MermaidJs Cookbook recipe](https://www.pmwiki.org/wiki/Cookbook/MermaidJs) - [MermaidJs Cookbook recipe](https://www.pmwiki.org/wiki/Cookbook/MermaidJs)
- [Semantic Media Wiki](https://semantic-mediawiki.org) - [Semantic Media Wiki](https://www.semantic-mediawiki.org)
- [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid) - [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid)
- [TiddlyWiki](https://tiddlywiki.com/) - [TiddlyWiki](https://tiddlywiki.com/)
- [mermaid-tw5: wrapper for Mermaid Live](https://github.com/efurlanm/mermaid-tw5) - [mermaid-tw5: wrapper for Mermaid Live](https://github.com/efurlanm/mermaid-tw5)

6
docs/news/blog.md
View File

@@ -6,6 +6,12 @@
# Blog # Blog
## [Introducing Architecture Diagrams in Mermaid](https://www.mermaidchart.com/blog/posts/mermaid-supports-architecture-diagrams/)
2 September 2024 · 2 mins
Discover the fresh new and unique Neo and Hand-Drawn looks for Mermaid Diagrams, while still offering the classic look you love.
## [Mermaid v11 is out!](https://www.mermaidchart.com/blog/posts/mermaid-v11/) ## [Mermaid v11 is out!](https://www.mermaidchart.com/blog/posts/mermaid-v11/)
23 August 2024 · 2 mins 23 August 2024 · 2 mins

1
eslint.config.js
View File

@@ -23,6 +23,7 @@ export default tseslint.config(
'**/generated/', '**/generated/',
'**/coverage/', '**/coverage/',
'packages/mermaid/src/config.type.ts', 'packages/mermaid/src/config.type.ts',
'packages/mermaid/src/docs/.vitepress/components.d.ts',
], ],
}, },
{ {

2
package.json
View File

@@ -96,7 +96,7 @@
"eslint-plugin-cypress": "^3.3.0", "eslint-plugin-cypress": "^3.3.0",
"eslint-plugin-html": "^8.1.1", "eslint-plugin-html": "^8.1.1",
"eslint-plugin-jest": "^28.6.0", "eslint-plugin-jest": "^28.6.0",
"eslint-plugin-jsdoc": "^48.2.9", "eslint-plugin-jsdoc": "^50.0.0",
"eslint-plugin-json": "^4.0.0", "eslint-plugin-json": "^4.0.0",
"eslint-plugin-lodash": "^8.0.0", "eslint-plugin-lodash": "^8.0.0",
"eslint-plugin-markdown": "^5.0.0", "eslint-plugin-markdown": "^5.0.0",

12
packages/mermaid-layout-elk/src/render.ts
View File

@@ -224,7 +224,7 @@ export const render = async (
* Add edges to graph based on parsed graph definition * Add edges to graph based on parsed graph definition
*/ */
const addEdges = async function ( const addEdges = async function (
dataForLayout: { edges: any; direction: string }, dataForLayout: { edges: any; direction?: string },
graph: { graph: {
id?: string; id?: string;
layoutOptions?: { layoutOptions?: {
@@ -749,12 +749,12 @@ export const render = async (
layoutOptions: { layoutOptions: {
'elk.hierarchyHandling': 'INCLUDE_CHILDREN', 'elk.hierarchyHandling': 'INCLUDE_CHILDREN',
'elk.algorithm': algorithm, 'elk.algorithm': algorithm,
'nodePlacement.strategy': data4Layout.config.elk.nodePlacementStrategy, 'nodePlacement.strategy': data4Layout.config.elk?.nodePlacementStrategy,
'elk.layered.mergeEdges': data4Layout.config.elk.mergeEdges, 'elk.layered.mergeEdges': data4Layout.config.elk?.mergeEdges,
'elk.direction': 'DOWN', 'elk.direction': 'DOWN',
'spacing.baseValue': 35, 'spacing.baseValue': 35,
'elk.layered.unnecessaryBendpoints': true, 'elk.layered.unnecessaryBendpoints': true,
'elk.layered.cycleBreaking.strategy': data4Layout.config.elk.cycleBreakingStrategy, 'elk.layered.cycleBreaking.strategy': data4Layout.config.elk?.cycleBreakingStrategy,
// 'spacing.nodeNode': 20, // 'spacing.nodeNode': 20,
// 'spacing.nodeNodeBetweenLayers': 25, // 'spacing.nodeNodeBetweenLayers': 25,
// 'spacing.edgeNode': 20, // 'spacing.edgeNode': 20,
@@ -837,8 +837,8 @@ export const render = async (
...node.layoutOptions, ...node.layoutOptions,
'elk.algorithm': algorithm, 'elk.algorithm': algorithm,
'elk.direction': dir2ElkDirection(node.dir), 'elk.direction': dir2ElkDirection(node.dir),
'nodePlacement.strategy': data4Layout.config['elk.nodePlacement.strategy'], 'nodePlacement.strategy': data4Layout.config.elk?.nodePlacementStrategy,
'elk.layered.mergeEdges': data4Layout.config['elk.mergeEdges'], 'elk.layered.mergeEdges': data4Layout.config.elk?.mergeEdges,
'elk.hierarchyHandling': 'SEPARATE_CHILDREN', 'elk.hierarchyHandling': 'SEPARATE_CHILDREN',
}; };
} }

6
packages/mermaid/CHANGELOG.md
View File

@@ -1,5 +1,11 @@
# mermaid # mermaid
## 11.1.1
### Patch Changes
- [#5828](https://github.com/mermaid-js/mermaid/pull/5828) [`4c43d21`](https://github.com/mermaid-js/mermaid/commit/4c43d21196f784b6f483ae635fc462329f3d176f) Thanks [@knsv](https://github.com/knsv)! - fix: Fix for issue where self-loops in the root of diagrams break the rendering
## 11.1.0 ## 11.1.0
### Minor Changes ### Minor Changes

2
packages/mermaid/package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "mermaid", "name": "mermaid",
"version": "11.1.0", "version": "11.1.1",
"description": "Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graphs and more.", "description": "Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graphs and more.",
"type": "module", "type": "module",
"module": "./dist/mermaid.core.mjs", "module": "./dist/mermaid.core.mjs",

2
packages/mermaid/src/docs/ecosystem/integrations-community.md
View File

@@ -140,7 +140,7 @@ Communication tools and platforms
- [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid) - [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid)
- [PmWiki](https://www.pmwiki.org) - [PmWiki](https://www.pmwiki.org)
- [MermaidJs Cookbook recipe](https://www.pmwiki.org/wiki/Cookbook/MermaidJs) - [MermaidJs Cookbook recipe](https://www.pmwiki.org/wiki/Cookbook/MermaidJs)
- [Semantic Media Wiki](https://semantic-mediawiki.org) - [Semantic Media Wiki](https://www.semantic-mediawiki.org)
- [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid) - [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid)
- [TiddlyWiki](https://tiddlywiki.com/) - [TiddlyWiki](https://tiddlywiki.com/)
- [mermaid-tw5: wrapper for Mermaid Live](https://github.com/efurlanm/mermaid-tw5) - [mermaid-tw5: wrapper for Mermaid Live](https://github.com/efurlanm/mermaid-tw5)

6
packages/mermaid/src/docs/news/blog.md
View File

@@ -1,5 +1,11 @@
# Blog # Blog
## [Introducing Architecture Diagrams in Mermaid](https://www.mermaidchart.com/blog/posts/mermaid-supports-architecture-diagrams/)
2 September 2024 · 2 mins
Discover the fresh new and unique Neo and Hand-Drawn looks for Mermaid Diagrams, while still offering the classic look you love.
## [Mermaid v11 is out!](https://www.mermaidchart.com/blog/posts/mermaid-v11/) ## [Mermaid v11 is out!](https://www.mermaidchart.com/blog/posts/mermaid-v11/)
23 August 2024 · 2 mins 23 August 2024 · 2 mins

11
packages/mermaid/src/rendering-util/types.d.ts → packages/mermaid/src/rendering-util/types.ts
View File

@@ -1,5 +1,5 @@
export type MarkdownWordType = 'normal' | 'strong' | 'em'; export type MarkdownWordType = 'normal' | 'strong' | 'em';
import type { MermaidConfig } from '../../dist/config.type'; import type { MermaidConfig } from '../config.type.js';
export interface MarkdownWord { export interface MarkdownWord {
content: string; content: string;
type: MarkdownWordType; type: MarkdownWordType;
@@ -9,7 +9,7 @@ export type MarkdownLine = MarkdownWord[];
export type CheckFitFunction = (text: MarkdownLine) => boolean; export type CheckFitFunction = (text: MarkdownLine) => boolean;
// Common properties for any node in the system // Common properties for any node in the system
interface Node { export interface Node {
id: string; id: string;
label?: string; label?: string;
description?: string[]; description?: string[];
@@ -38,7 +38,6 @@ interface Node {
tooltip?: string; tooltip?: string;
padding?: number; //REMOVE?, use from LayoutData.config - Keep, this could be shape specific padding?: number; //REMOVE?, use from LayoutData.config - Keep, this could be shape specific
shape?: string; shape?: string;
tooltip?: string;
isGroup: boolean; isGroup: boolean;
width?: number; width?: number;
height?: number; height?: number;
@@ -68,7 +67,7 @@ interface Node {
} }
// Common properties for any edge in the system // Common properties for any edge in the system
interface Edge { export interface Edge {
id: string; id: string;
label?: string; label?: string;
classes?: string; classes?: string;
@@ -98,7 +97,7 @@ interface Edge {
look?: string; look?: string;
} }
interface RectOptions { export interface RectOptions {
rx: number; rx: number;
ry: number; ry: number;
labelPaddingX: number; labelPaddingX: number;
@@ -107,7 +106,7 @@ interface RectOptions {
} }
// Extending the Node interface for specific types if needed // Extending the Node interface for specific types if needed
interface ClassDiagramNode extends Node { export interface ClassDiagramNode extends Node {
memberData: any; // Specific property for class diagram nodes memberData: any; // Specific property for class diagram nodes
} }

26
pnpm-lock.yaml generated
View File

@@ -111,8 +111,8 @@ importers:
specifier: ^28.6.0 specifier: ^28.6.0
version: 28.7.0(@typescript-eslint/eslint-plugin@8.0.1(@typescript-eslint/parser@8.0.1(eslint@9.8.0)(typescript@5.4.5))(eslint@9.8.0)(typescript@5.4.5))(eslint@9.8.0)(jest@29.7.0(@types/node@20.16.2))(typescript@5.4.5) version: 28.7.0(@typescript-eslint/eslint-plugin@8.0.1(@typescript-eslint/parser@8.0.1(eslint@9.8.0)(typescript@5.4.5))(eslint@9.8.0)(typescript@5.4.5))(eslint@9.8.0)(jest@29.7.0(@types/node@20.16.2))(typescript@5.4.5)
eslint-plugin-jsdoc: eslint-plugin-jsdoc:
specifier: ^48.2.9 specifier: ^50.0.0
version: 48.11.0(eslint@9.8.0) version: 50.2.2(eslint@9.8.0)
eslint-plugin-json: eslint-plugin-json:
specifier: ^4.0.0 specifier: ^4.0.0
version: 4.0.1 version: 4.0.1
@@ -1810,8 +1810,8 @@ packages:
'@emnapi/runtime@1.2.0': '@emnapi/runtime@1.2.0':
resolution: {integrity: sha512-bV21/9LQmcQeCPEg3BDFtvwL6cwiTMksYNWQQ4KOxCZikEGalWtenoZ0wCiukJINlGCIi2KXx01g4FoH/LxpzQ==} resolution: {integrity: sha512-bV21/9LQmcQeCPEg3BDFtvwL6cwiTMksYNWQQ4KOxCZikEGalWtenoZ0wCiukJINlGCIi2KXx01g4FoH/LxpzQ==}
'@es-joy/jsdoccomment@0.46.0': '@es-joy/jsdoccomment@0.48.0':
resolution: {integrity: sha512-C3Axuq1xd/9VqFZpW4YAzOx5O9q/LP46uIQy/iNDpHG3fmPa6TBtvfglMCs3RBiBxAIi0Go97r8+jvTt55XMyQ==} resolution: {integrity: sha512-G6QUWIcC+KvSwXNsJyDTHvqUdNoAVJPPgkc3+Uk4WBKqZvoXhlvazOgm9aL0HwihJLQf0l+tOE2UFzXBqCqgDw==}
engines: {node: '>=16'} engines: {node: '>=16'}
'@esbuild/aix-ppc64@0.21.5': '@esbuild/aix-ppc64@0.21.5':
@@ -4952,8 +4952,8 @@ packages:
jest: jest:
optional: true optional: true
eslint-plugin-jsdoc@48.11.0: eslint-plugin-jsdoc@50.2.2:
resolution: {integrity: sha512-d12JHJDPNo7IFwTOAItCeJY1hcqoIxE0lHA8infQByLilQ9xkqrRa6laWCnsuCrf+8rUnvxXY1XuTbibRBNylA==} resolution: {integrity: sha512-i0ZMWA199DG7sjxlzXn5AeYZxpRfMJjDPUl7lL9eJJX8TPRoIaxJU4ys/joP5faM5AXE1eqW/dslCj3uj4Nqpg==}
engines: {node: '>=18'} engines: {node: '>=18'}
peerDependencies: peerDependencies:
eslint: ^7.0.0 || ^8.0.0 || ^9.0.0 eslint: ^7.0.0 || ^8.0.0 || ^9.0.0
@@ -6268,8 +6268,8 @@ packages:
jsbn@0.1.1: jsbn@0.1.1:
resolution: {integrity: sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==} resolution: {integrity: sha512-UVU9dibq2JcFWxQPA6KCqj5O42VOmAY3zQUfEKxU0KpTGXwNoCjkX1e13eHNvw/xPynt6pU0rZ1htjWTNTSXsg==}
jsdoc-type-pratt-parser@4.0.0: jsdoc-type-pratt-parser@4.1.0:
resolution: {integrity: sha512-YtOli5Cmzy3q4dP26GraSOeAhqecewG04hoO8DY56CH4KJ9Fvv5qKWUCCo3HZob7esJQHCv6/+bnTy72xZZaVQ==} resolution: {integrity: sha512-Hicd6JK5Njt2QB6XYFS7ok9e37O8AYk3jTcppG4YVQnYjOemymvTcmc7OWsmq/Qqj5TdRFO5/x/tIPmBeRtGHg==}
engines: {node: '>=12.0.0'} engines: {node: '>=12.0.0'}
jsdom@24.1.3: jsdom@24.1.3:
@@ -11011,11 +11011,11 @@ snapshots:
tslib: 2.7.0 tslib: 2.7.0
optional: true optional: true
'@es-joy/jsdoccomment@0.46.0': '@es-joy/jsdoccomment@0.48.0':
dependencies: dependencies:
comment-parser: 1.4.1 comment-parser: 1.4.1
esquery: 1.6.0 esquery: 1.6.0
jsdoc-type-pratt-parser: 4.0.0 jsdoc-type-pratt-parser: 4.1.0
'@esbuild/aix-ppc64@0.21.5': '@esbuild/aix-ppc64@0.21.5':
optional: true optional: true
@@ -14589,9 +14589,9 @@ snapshots:
- supports-color - supports-color
- typescript - typescript
eslint-plugin-jsdoc@48.11.0(eslint@9.8.0): eslint-plugin-jsdoc@50.2.2(eslint@9.8.0):
dependencies: dependencies:
'@es-joy/jsdoccomment': 0.46.0 '@es-joy/jsdoccomment': 0.48.0
are-docs-informative: 0.0.2 are-docs-informative: 0.0.2
comment-parser: 1.4.1 comment-parser: 1.4.1
debug: 4.3.6(supports-color@8.1.1) debug: 4.3.6(supports-color@8.1.1)
@@ -16242,7 +16242,7 @@ snapshots:
jsbn@0.1.1: {} jsbn@0.1.1: {}
jsdoc-type-pratt-parser@4.0.0: {} jsdoc-type-pratt-parser@4.1.0: {}
jsdom@24.1.3: jsdom@24.1.3:
dependencies: dependencies: