mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-03 20:34:20 +01:00 
			
		
		
		
	Compare commits
	
		
			1 Commits
		
	
	
		
			sidv/cttes
			...
			update-lin
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					b50eb13746 | 
@@ -1,30 +0,0 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Shared common options for both ESBuild and Vite
 | 
			
		||||
 */
 | 
			
		||||
export const packageOptions = {
 | 
			
		||||
  parser: {
 | 
			
		||||
    name: 'mermaid-parser',
 | 
			
		||||
    packageName: 'parser',
 | 
			
		||||
    file: 'index.ts',
 | 
			
		||||
  },
 | 
			
		||||
  mermaid: {
 | 
			
		||||
    name: 'mermaid',
 | 
			
		||||
    packageName: 'mermaid',
 | 
			
		||||
    file: 'mermaid.ts',
 | 
			
		||||
  },
 | 
			
		||||
  'mermaid-example-diagram': {
 | 
			
		||||
    name: 'mermaid-example-diagram',
 | 
			
		||||
    packageName: 'mermaid-example-diagram',
 | 
			
		||||
    file: 'detector.ts',
 | 
			
		||||
  },
 | 
			
		||||
  'mermaid-zenuml': {
 | 
			
		||||
    name: 'mermaid-zenuml',
 | 
			
		||||
    packageName: 'mermaid-zenuml',
 | 
			
		||||
    file: 'detector.ts',
 | 
			
		||||
  },
 | 
			
		||||
  'mermaid-layout-elk': {
 | 
			
		||||
    name: 'mermaid-layout-elk',
 | 
			
		||||
    packageName: 'mermaid-layout-elk',
 | 
			
		||||
    file: 'layouts.ts',
 | 
			
		||||
  },
 | 
			
		||||
} as const;
 | 
			
		||||
@@ -1,5 +0,0 @@
 | 
			
		||||
import { generate } from 'langium-cli';
 | 
			
		||||
 | 
			
		||||
export async function generateLangium() {
 | 
			
		||||
  await generate({ file: `./packages/parser/langium-config.json` });
 | 
			
		||||
}
 | 
			
		||||
@@ -1,124 +0,0 @@
 | 
			
		||||
import { load, JSON_SCHEMA } from 'js-yaml';
 | 
			
		||||
import assert from 'node:assert';
 | 
			
		||||
import Ajv2019, { type JSONSchemaType } from 'ajv/dist/2019.js';
 | 
			
		||||
import type { MermaidConfig, BaseDiagramConfig } from '../packages/mermaid/src/config.type.js';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * All of the keys in the mermaid config that have a mermaid diagram config.
 | 
			
		||||
 */
 | 
			
		||||
const MERMAID_CONFIG_DIAGRAM_KEYS = [
 | 
			
		||||
  'flowchart',
 | 
			
		||||
  'sequence',
 | 
			
		||||
  'gantt',
 | 
			
		||||
  'journey',
 | 
			
		||||
  'class',
 | 
			
		||||
  'state',
 | 
			
		||||
  'er',
 | 
			
		||||
  'pie',
 | 
			
		||||
  'quadrantChart',
 | 
			
		||||
  'xyChart',
 | 
			
		||||
  'requirement',
 | 
			
		||||
  'mindmap',
 | 
			
		||||
  'timeline',
 | 
			
		||||
  'gitGraph',
 | 
			
		||||
  'c4',
 | 
			
		||||
  'sankey',
 | 
			
		||||
  'block',
 | 
			
		||||
  'packet',
 | 
			
		||||
] as const;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Generate default values from the JSON Schema.
 | 
			
		||||
 *
 | 
			
		||||
 * AJV does not support nested default values yet (or default values with $ref),
 | 
			
		||||
 * so we need to manually find them (this may be fixed in ajv v9).
 | 
			
		||||
 *
 | 
			
		||||
 * @param mermaidConfigSchema - The Mermaid JSON Schema to use.
 | 
			
		||||
 * @returns The default mermaid config object.
 | 
			
		||||
 */
 | 
			
		||||
function generateDefaults(mermaidConfigSchema: JSONSchemaType<MermaidConfig>) {
 | 
			
		||||
  const ajv = new Ajv2019({
 | 
			
		||||
    useDefaults: true,
 | 
			
		||||
    allowUnionTypes: true,
 | 
			
		||||
    strict: true,
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  ajv.addKeyword({
 | 
			
		||||
    keyword: 'meta:enum', // used by jsonschema2md
 | 
			
		||||
    errors: false,
 | 
			
		||||
  });
 | 
			
		||||
  ajv.addKeyword({
 | 
			
		||||
    keyword: 'tsType', // used by json-schema-to-typescript
 | 
			
		||||
    errors: false,
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  // ajv currently doesn't support nested default values, see https://github.com/ajv-validator/ajv/issues/1718
 | 
			
		||||
  // (may be fixed in v9) so we need to manually use sub-schemas
 | 
			
		||||
  const mermaidDefaultConfig = {};
 | 
			
		||||
 | 
			
		||||
  assert.ok(mermaidConfigSchema.$defs);
 | 
			
		||||
  const baseDiagramConfig = mermaidConfigSchema.$defs.BaseDiagramConfig;
 | 
			
		||||
 | 
			
		||||
  for (const key of MERMAID_CONFIG_DIAGRAM_KEYS) {
 | 
			
		||||
    const subSchemaRef = mermaidConfigSchema.properties[key].$ref;
 | 
			
		||||
    const [root, defs, defName] = subSchemaRef.split('/');
 | 
			
		||||
    assert.strictEqual(root, '#');
 | 
			
		||||
    assert.strictEqual(defs, '$defs');
 | 
			
		||||
    const subSchema = {
 | 
			
		||||
      $schema: mermaidConfigSchema.$schema,
 | 
			
		||||
      $defs: mermaidConfigSchema.$defs,
 | 
			
		||||
      ...mermaidConfigSchema.$defs[defName],
 | 
			
		||||
    } as JSONSchemaType<BaseDiagramConfig>;
 | 
			
		||||
 | 
			
		||||
    const validate = ajv.compile(subSchema);
 | 
			
		||||
 | 
			
		||||
    mermaidDefaultConfig[key] = {};
 | 
			
		||||
 | 
			
		||||
    for (const required of subSchema.required ?? []) {
 | 
			
		||||
      if (subSchema.properties[required] === undefined && baseDiagramConfig.properties[required]) {
 | 
			
		||||
        mermaidDefaultConfig[key][required] = baseDiagramConfig.properties[required].default;
 | 
			
		||||
      }
 | 
			
		||||
    }
 | 
			
		||||
    if (!validate(mermaidDefaultConfig[key])) {
 | 
			
		||||
      throw new Error(
 | 
			
		||||
        `schema for subconfig ${key} does not have valid defaults! Errors were ${JSON.stringify(
 | 
			
		||||
          validate.errors,
 | 
			
		||||
          undefined,
 | 
			
		||||
          2
 | 
			
		||||
        )}`
 | 
			
		||||
      );
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  const validate = ajv.compile(mermaidConfigSchema);
 | 
			
		||||
 | 
			
		||||
  if (!validate(mermaidDefaultConfig)) {
 | 
			
		||||
    throw new Error(
 | 
			
		||||
      `Mermaid config JSON Schema does not have valid defaults! Errors were ${JSON.stringify(
 | 
			
		||||
        validate.errors,
 | 
			
		||||
        undefined,
 | 
			
		||||
        2
 | 
			
		||||
      )}`
 | 
			
		||||
    );
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return mermaidDefaultConfig;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export const loadSchema = (src: string, filename: string): JSONSchemaType<MermaidConfig> => {
 | 
			
		||||
  const jsonSchema = load(src, {
 | 
			
		||||
    filename,
 | 
			
		||||
    // only allow JSON types in our YAML doc (will probably be default in YAML 1.3)
 | 
			
		||||
    // e.g. `true` will be parsed a boolean `true`, `True` will be parsed as string `"True"`.
 | 
			
		||||
    schema: JSON_SCHEMA,
 | 
			
		||||
  }) as JSONSchemaType<MermaidConfig>;
 | 
			
		||||
  return jsonSchema;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const getDefaults = (schema: JSONSchemaType<MermaidConfig>) => {
 | 
			
		||||
  return `export default ${JSON.stringify(generateDefaults(schema), undefined, 2)};`;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const getSchema = (schema: JSONSchemaType<MermaidConfig>) => {
 | 
			
		||||
  return `export default ${JSON.stringify(schema, undefined, 2)};`;
 | 
			
		||||
};
 | 
			
		||||
@@ -1,25 +0,0 @@
 | 
			
		||||
/* eslint-disable no-console */
 | 
			
		||||
import { packageOptions } from './common.js';
 | 
			
		||||
import { execSync } from 'child_process';
 | 
			
		||||
 | 
			
		||||
const buildType = (packageName: string) => {
 | 
			
		||||
  console.log(`Building types for ${packageName}`);
 | 
			
		||||
  try {
 | 
			
		||||
    const out = execSync(`tsc -p ./packages/${packageName}/tsconfig.json --emitDeclarationOnly`);
 | 
			
		||||
    if (out.length > 0) {
 | 
			
		||||
      console.log(out.toString());
 | 
			
		||||
    }
 | 
			
		||||
  } catch (e) {
 | 
			
		||||
    console.error(e);
 | 
			
		||||
    if (e.stdout.length > 0) {
 | 
			
		||||
      console.error(e.stdout.toString());
 | 
			
		||||
    }
 | 
			
		||||
    if (e.stderr.length > 0) {
 | 
			
		||||
      console.error(e.stderr.toString());
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
for (const { packageName } of Object.values(packageOptions)) {
 | 
			
		||||
  buildType(packageName);
 | 
			
		||||
}
 | 
			
		||||
@@ -1,8 +0,0 @@
 | 
			
		||||
# Changesets
 | 
			
		||||
 | 
			
		||||
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
 | 
			
		||||
with multi-package repos, or single-package repos to help you version and publish your code. You can
 | 
			
		||||
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
 | 
			
		||||
 | 
			
		||||
We have a quick list of common questions to get you started engaging with this project in
 | 
			
		||||
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
 | 
			
		||||
@@ -1,12 +0,0 @@
 | 
			
		||||
{
 | 
			
		||||
  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
 | 
			
		||||
  "changelog": ["@changesets/changelog-github", { "repo": "mermaid-js/mermaid" }],
 | 
			
		||||
  "commit": false,
 | 
			
		||||
  "fixed": [],
 | 
			
		||||
  "linked": [],
 | 
			
		||||
  "access": "public",
 | 
			
		||||
  "baseBranch": "master",
 | 
			
		||||
  "updateInternalDependencies": "patch",
 | 
			
		||||
  "bumpVersionsWithWorkspaceProtocolOnly": true,
 | 
			
		||||
  "ignore": ["@mermaid-js/docs", "@mermaid-js/webpack-test", "@mermaid-js/mermaid-example-diagram"]
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										3
									
								
								.commitlintrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								.commitlintrc.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
{
 | 
			
		||||
  "extends": ["@commitlint/config-conventional"]
 | 
			
		||||
}
 | 
			
		||||
@@ -1,148 +0,0 @@
 | 
			
		||||
# This file contains coding related terms
 | 
			
		||||
ALPHANUM
 | 
			
		||||
antiscript
 | 
			
		||||
APPLYCLASS
 | 
			
		||||
ARROWHEADSTYLE
 | 
			
		||||
ARROWTYPE
 | 
			
		||||
autonumber
 | 
			
		||||
axisl-line
 | 
			
		||||
Bigdecimal
 | 
			
		||||
birel
 | 
			
		||||
BIREL
 | 
			
		||||
bqstring
 | 
			
		||||
BQUOTE
 | 
			
		||||
bramp
 | 
			
		||||
BRKT
 | 
			
		||||
brotli
 | 
			
		||||
callbackargs
 | 
			
		||||
callbackname
 | 
			
		||||
classdef
 | 
			
		||||
classdefid
 | 
			
		||||
classentity
 | 
			
		||||
classname
 | 
			
		||||
COLONSEP
 | 
			
		||||
COMPOSIT_STATE
 | 
			
		||||
concat
 | 
			
		||||
controlx
 | 
			
		||||
controly
 | 
			
		||||
CSSCLASS
 | 
			
		||||
CYLINDEREND
 | 
			
		||||
CYLINDERSTART
 | 
			
		||||
DAGA
 | 
			
		||||
datakey
 | 
			
		||||
DEND
 | 
			
		||||
descr
 | 
			
		||||
distp
 | 
			
		||||
distq
 | 
			
		||||
divs
 | 
			
		||||
docref
 | 
			
		||||
DOMID
 | 
			
		||||
doublecircle
 | 
			
		||||
DOUBLECIRCLEEND
 | 
			
		||||
DOUBLECIRCLESTART
 | 
			
		||||
DQUOTE
 | 
			
		||||
DSTART
 | 
			
		||||
edgesep
 | 
			
		||||
EMPTYSTR
 | 
			
		||||
enddate
 | 
			
		||||
ERDIAGRAM
 | 
			
		||||
flatmap
 | 
			
		||||
forwardable
 | 
			
		||||
frontmatter
 | 
			
		||||
funs
 | 
			
		||||
gantt
 | 
			
		||||
GENERICTYPE
 | 
			
		||||
getBoundarys
 | 
			
		||||
grammr
 | 
			
		||||
graphtype
 | 
			
		||||
iife
 | 
			
		||||
interp
 | 
			
		||||
introdcued
 | 
			
		||||
INVTRAPEND
 | 
			
		||||
INVTRAPSTART
 | 
			
		||||
JDBC
 | 
			
		||||
jison
 | 
			
		||||
Kaufmann
 | 
			
		||||
keyify
 | 
			
		||||
LABELPOS
 | 
			
		||||
LABELTYPE
 | 
			
		||||
lcov
 | 
			
		||||
LEFTOF
 | 
			
		||||
Lexa
 | 
			
		||||
linebreak
 | 
			
		||||
LINETYPE
 | 
			
		||||
LINKSTYLE
 | 
			
		||||
LLABEL
 | 
			
		||||
loglevel
 | 
			
		||||
LOGMSG
 | 
			
		||||
lookaheads
 | 
			
		||||
mdast
 | 
			
		||||
metafile
 | 
			
		||||
minlen
 | 
			
		||||
Mstartx
 | 
			
		||||
MULT
 | 
			
		||||
NODIR
 | 
			
		||||
NSTR
 | 
			
		||||
outdir
 | 
			
		||||
Qcontrolx
 | 
			
		||||
reinit
 | 
			
		||||
rels
 | 
			
		||||
reqs
 | 
			
		||||
rewritelinks
 | 
			
		||||
rgba
 | 
			
		||||
RIGHTOF
 | 
			
		||||
roughjs
 | 
			
		||||
sankey
 | 
			
		||||
sequencenumber
 | 
			
		||||
shrc
 | 
			
		||||
signaltype
 | 
			
		||||
someclass
 | 
			
		||||
SPACELINE
 | 
			
		||||
SPACELIST
 | 
			
		||||
STADIUMEND
 | 
			
		||||
STADIUMSTART
 | 
			
		||||
startdate
 | 
			
		||||
startx
 | 
			
		||||
starty
 | 
			
		||||
STMNT
 | 
			
		||||
stopx
 | 
			
		||||
stopy
 | 
			
		||||
strikethrough
 | 
			
		||||
stringifying
 | 
			
		||||
struct
 | 
			
		||||
STYLECLASS
 | 
			
		||||
STYLEDEF
 | 
			
		||||
STYLEOPTS
 | 
			
		||||
subcomponent
 | 
			
		||||
subcomponents
 | 
			
		||||
subconfig
 | 
			
		||||
SUBROUTINEEND
 | 
			
		||||
SUBROUTINESTART
 | 
			
		||||
Subschemas
 | 
			
		||||
substr
 | 
			
		||||
SVGG
 | 
			
		||||
SVGSVG
 | 
			
		||||
TAGEND
 | 
			
		||||
TAGSTART
 | 
			
		||||
techn
 | 
			
		||||
TESTSTR
 | 
			
		||||
TEXTDATA
 | 
			
		||||
TEXTLENGTH
 | 
			
		||||
titlevalue
 | 
			
		||||
topbar
 | 
			
		||||
TRAPEND
 | 
			
		||||
TRAPSTART
 | 
			
		||||
treemap
 | 
			
		||||
ts-nocheck
 | 
			
		||||
tsdoc
 | 
			
		||||
typeof
 | 
			
		||||
typestr
 | 
			
		||||
unshift
 | 
			
		||||
verifymethod
 | 
			
		||||
VERIFYMTHD
 | 
			
		||||
WARN_DOCSDIR_DOESNT_MATCH
 | 
			
		||||
xhost
 | 
			
		||||
yaxis
 | 
			
		||||
yfunc
 | 
			
		||||
yytext
 | 
			
		||||
zenuml
 | 
			
		||||
@@ -1,9 +0,0 @@
 | 
			
		||||
# Contributors to mermaidjs, one per line
 | 
			
		||||
Ashish Jain
 | 
			
		||||
cpettitt
 | 
			
		||||
Dong Cai
 | 
			
		||||
Nikolay Rozhkov
 | 
			
		||||
Peng Xiao
 | 
			
		||||
Per Brolin
 | 
			
		||||
subhash-halder
 | 
			
		||||
Vinod Sidharth
 | 
			
		||||
@@ -1,52 +0,0 @@
 | 
			
		||||
# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
 | 
			
		||||
 | 
			
		||||
$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
 | 
			
		||||
 | 
			
		||||
dictionaryDefinitions:
 | 
			
		||||
  - name: code-terms
 | 
			
		||||
    path: ./code-terms.txt
 | 
			
		||||
    description: A list of coding related terms.
 | 
			
		||||
    addWords: true
 | 
			
		||||
  - name: mermaid-terms
 | 
			
		||||
    path: ./mermaid-terms.txt
 | 
			
		||||
    description: A list of terms related to the mermaid project.
 | 
			
		||||
    addWords: true
 | 
			
		||||
  - name: misc-terms
 | 
			
		||||
    path: ./misc-terms.txt
 | 
			
		||||
    description: A list of miscellaneous terms.
 | 
			
		||||
  - name: 3rd-party-terms
 | 
			
		||||
    path: ./libraries.txt
 | 
			
		||||
    description: A list of 3rd party terms from dependencies.
 | 
			
		||||
    addWords: true
 | 
			
		||||
  - name: contributors
 | 
			
		||||
    path: ./contributors.txt
 | 
			
		||||
    description: A list of contributors to the mermaid project.
 | 
			
		||||
    type: 'W'
 | 
			
		||||
    addWords: true
 | 
			
		||||
 | 
			
		||||
  # cspell:disable
 | 
			
		||||
  - name: suggestions
 | 
			
		||||
    words:
 | 
			
		||||
      - none
 | 
			
		||||
    suggestWords:
 | 
			
		||||
      - seperator:separator
 | 
			
		||||
      - vertice:vertex
 | 
			
		||||
  # cspell:enable
 | 
			
		||||
 | 
			
		||||
patterns:
 | 
			
		||||
  - name: character-set-cyrillic
 | 
			
		||||
    pattern: '/\p{Script_Extensions=Cyrillic}+/gu'
 | 
			
		||||
  - name: svg-block
 | 
			
		||||
    pattern: '<svg[\S\s]+?</svg>'
 | 
			
		||||
  - name: json-property
 | 
			
		||||
    pattern: '/"[\w/@-]+":/g'
 | 
			
		||||
 | 
			
		||||
dictionaries:
 | 
			
		||||
  - mermaid-terms
 | 
			
		||||
  - suggestions
 | 
			
		||||
  - contributors
 | 
			
		||||
 | 
			
		||||
ignorePaths:
 | 
			
		||||
  - '*.txt' # do not spell check local dictionaries
 | 
			
		||||
 | 
			
		||||
# cspell:dictionary misc-terms
 | 
			
		||||
@@ -1,75 +0,0 @@
 | 
			
		||||
# Add third party library terms below
 | 
			
		||||
acyclicer
 | 
			
		||||
Antlr
 | 
			
		||||
Appli
 | 
			
		||||
applitools
 | 
			
		||||
Asciidoctor
 | 
			
		||||
Astah
 | 
			
		||||
automerge
 | 
			
		||||
bilkent
 | 
			
		||||
bisheng
 | 
			
		||||
Blazor
 | 
			
		||||
codedoc
 | 
			
		||||
Codemia
 | 
			
		||||
codepaths
 | 
			
		||||
csstree
 | 
			
		||||
cytoscape
 | 
			
		||||
cytoscape-cose-bilkent
 | 
			
		||||
dagre
 | 
			
		||||
dagre-d3
 | 
			
		||||
Deepdwn
 | 
			
		||||
Docsify
 | 
			
		||||
Docsy
 | 
			
		||||
Doctave
 | 
			
		||||
DokuWiki
 | 
			
		||||
dompurify
 | 
			
		||||
elkjs
 | 
			
		||||
fontawesome
 | 
			
		||||
Foswiki
 | 
			
		||||
Gitea
 | 
			
		||||
graphlib
 | 
			
		||||
Grav
 | 
			
		||||
iconify
 | 
			
		||||
Inkdrop
 | 
			
		||||
jiti
 | 
			
		||||
jsdocs
 | 
			
		||||
jsfiddle
 | 
			
		||||
jsonschema
 | 
			
		||||
katex
 | 
			
		||||
khroma
 | 
			
		||||
langium
 | 
			
		||||
mathml
 | 
			
		||||
matplotlib
 | 
			
		||||
mdbook
 | 
			
		||||
Mermerd
 | 
			
		||||
mkdocs
 | 
			
		||||
Nextra
 | 
			
		||||
nodenext
 | 
			
		||||
npmjs
 | 
			
		||||
pageview
 | 
			
		||||
pathe
 | 
			
		||||
phpbb
 | 
			
		||||
pixelmatch
 | 
			
		||||
Podlite
 | 
			
		||||
presetAttributify
 | 
			
		||||
pyplot
 | 
			
		||||
redmine
 | 
			
		||||
rehype
 | 
			
		||||
roughjs
 | 
			
		||||
rscratch
 | 
			
		||||
shiki
 | 
			
		||||
sparkline
 | 
			
		||||
sphinxcontrib
 | 
			
		||||
ssim
 | 
			
		||||
stylis
 | 
			
		||||
Swimm
 | 
			
		||||
tsbuildinfo
 | 
			
		||||
tseslint
 | 
			
		||||
Tuleap
 | 
			
		||||
Typora
 | 
			
		||||
unocss
 | 
			
		||||
unplugin
 | 
			
		||||
unstub
 | 
			
		||||
vite
 | 
			
		||||
vitest
 | 
			
		||||
Zune
 | 
			
		||||
@@ -1,41 +0,0 @@
 | 
			
		||||
Adamiecki
 | 
			
		||||
arrowend
 | 
			
		||||
bmatrix
 | 
			
		||||
braintree
 | 
			
		||||
catmull
 | 
			
		||||
compositTitleSize
 | 
			
		||||
doublecircle
 | 
			
		||||
elems
 | 
			
		||||
gantt
 | 
			
		||||
gitgraph
 | 
			
		||||
gzipped
 | 
			
		||||
handDrawn
 | 
			
		||||
knsv
 | 
			
		||||
Knut
 | 
			
		||||
marginx
 | 
			
		||||
marginy
 | 
			
		||||
Markdownish
 | 
			
		||||
mermaidjs
 | 
			
		||||
mindmap
 | 
			
		||||
mindmaps
 | 
			
		||||
mrtree
 | 
			
		||||
multigraph
 | 
			
		||||
nodesep
 | 
			
		||||
NOTEGROUP
 | 
			
		||||
Pinterest
 | 
			
		||||
rankdir
 | 
			
		||||
ranksep
 | 
			
		||||
rect
 | 
			
		||||
rects
 | 
			
		||||
sandboxed
 | 
			
		||||
siebling
 | 
			
		||||
statediagram
 | 
			
		||||
substate
 | 
			
		||||
Sveidqvist
 | 
			
		||||
unfixable
 | 
			
		||||
Viewbox
 | 
			
		||||
viewports
 | 
			
		||||
visio
 | 
			
		||||
vitepress
 | 
			
		||||
xlink
 | 
			
		||||
xychart
 | 
			
		||||
@@ -1,6 +0,0 @@
 | 
			
		||||
BRANDES
 | 
			
		||||
circo
 | 
			
		||||
handDrawn
 | 
			
		||||
KOEPF
 | 
			
		||||
neato
 | 
			
		||||
newbranch
 | 
			
		||||
@@ -1,67 +0,0 @@
 | 
			
		||||
import { build } from 'esbuild';
 | 
			
		||||
import { mkdir, writeFile } from 'node:fs/promises';
 | 
			
		||||
import { packageOptions } from '../.build/common.js';
 | 
			
		||||
import { generateLangium } from '../.build/generateLangium.js';
 | 
			
		||||
import type { MermaidBuildOptions } from './util.js';
 | 
			
		||||
import { defaultOptions, getBuildConfig } from './util.js';
 | 
			
		||||
 | 
			
		||||
const shouldVisualize = process.argv.includes('--visualize');
 | 
			
		||||
 | 
			
		||||
const buildPackage = async (entryName: keyof typeof packageOptions) => {
 | 
			
		||||
  const commonOptions: MermaidBuildOptions = { ...defaultOptions, entryName } as const;
 | 
			
		||||
  const buildConfigs: MermaidBuildOptions[] = [
 | 
			
		||||
    // package.mjs
 | 
			
		||||
    { ...commonOptions },
 | 
			
		||||
    // package.min.mjs
 | 
			
		||||
    {
 | 
			
		||||
      ...commonOptions,
 | 
			
		||||
      minify: true,
 | 
			
		||||
      metafile: shouldVisualize,
 | 
			
		||||
    },
 | 
			
		||||
    // package.core.mjs
 | 
			
		||||
    { ...commonOptions, core: true },
 | 
			
		||||
  ];
 | 
			
		||||
 | 
			
		||||
  if (entryName === 'mermaid') {
 | 
			
		||||
    const iifeOptions: MermaidBuildOptions = { ...commonOptions, format: 'iife' };
 | 
			
		||||
    buildConfigs.push(
 | 
			
		||||
      // mermaid.js
 | 
			
		||||
      { ...iifeOptions },
 | 
			
		||||
      // mermaid.min.js
 | 
			
		||||
      { ...iifeOptions, minify: true, metafile: shouldVisualize }
 | 
			
		||||
    );
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  const results = await Promise.all(buildConfigs.map((option) => build(getBuildConfig(option))));
 | 
			
		||||
 | 
			
		||||
  if (shouldVisualize) {
 | 
			
		||||
    for (const { metafile } of results) {
 | 
			
		||||
      if (!metafile?.outputs) {
 | 
			
		||||
        continue;
 | 
			
		||||
      }
 | 
			
		||||
      const fileName = Object.keys(metafile.outputs)
 | 
			
		||||
        .find((file) => !file.includes('chunks') && file.endsWith('js'))
 | 
			
		||||
        .replace('dist/', '');
 | 
			
		||||
      // Upload metafile into https://esbuild.github.io/analyze/
 | 
			
		||||
      await writeFile(`stats/${fileName}.meta.json`, JSON.stringify(metafile));
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const handler = (e) => {
 | 
			
		||||
  // eslint-disable-next-line no-console
 | 
			
		||||
  console.error(e);
 | 
			
		||||
  process.exit(1);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const main = async () => {
 | 
			
		||||
  await generateLangium();
 | 
			
		||||
  await mkdir('stats', { recursive: true });
 | 
			
		||||
  const packageNames = Object.keys(packageOptions) as (keyof typeof packageOptions)[];
 | 
			
		||||
  // it should build `parser` before `mermaid` because it's a dependency
 | 
			
		||||
  for (const pkg of packageNames) {
 | 
			
		||||
    await buildPackage(pkg).catch(handler);
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
void main();
 | 
			
		||||
@@ -1,15 +0,0 @@
 | 
			
		||||
import { readFile } from 'node:fs/promises';
 | 
			
		||||
import { transformJison } from '../.build/jisonTransformer.js';
 | 
			
		||||
import type { Plugin } from 'esbuild';
 | 
			
		||||
 | 
			
		||||
export const jisonPlugin: Plugin = {
 | 
			
		||||
  name: 'jison',
 | 
			
		||||
  setup(build) {
 | 
			
		||||
    build.onLoad({ filter: /\.jison$/ }, async (args) => {
 | 
			
		||||
      // Load the file from the file system
 | 
			
		||||
      const source = await readFile(args.path, 'utf8');
 | 
			
		||||
      const contents = transformJison(source);
 | 
			
		||||
      return { contents, warnings: [] };
 | 
			
		||||
    });
 | 
			
		||||
  },
 | 
			
		||||
};
 | 
			
		||||
@@ -1,35 +0,0 @@
 | 
			
		||||
import type { JSONSchemaType } from 'ajv/dist/2019.js';
 | 
			
		||||
import type { MermaidConfig } from '../packages/mermaid/src/config.type.js';
 | 
			
		||||
import { readFile } from 'node:fs/promises';
 | 
			
		||||
import { getDefaults, getSchema, loadSchema } from '../.build/jsonSchema.js';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * ESBuild plugin that handles JSON Schemas saved as a `.schema.yaml` file.
 | 
			
		||||
 *
 | 
			
		||||
 * Use `my-example.schema.yaml?only-defaults=true` to only load the default values.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
export const jsonSchemaPlugin = {
 | 
			
		||||
  name: 'json-schema-plugin',
 | 
			
		||||
  setup(build) {
 | 
			
		||||
    let schema: JSONSchemaType<MermaidConfig> | undefined = undefined;
 | 
			
		||||
    let content = '';
 | 
			
		||||
 | 
			
		||||
    build.onLoad({ filter: /config\.schema\.yaml$/ }, async (args) => {
 | 
			
		||||
      // Load the file from the file system
 | 
			
		||||
      const source = await readFile(args.path, 'utf8');
 | 
			
		||||
      const resolvedSchema: JSONSchemaType<MermaidConfig> =
 | 
			
		||||
        content === source && schema ? schema : loadSchema(source, args.path);
 | 
			
		||||
      if (content !== source) {
 | 
			
		||||
        content = source;
 | 
			
		||||
        schema = resolvedSchema;
 | 
			
		||||
      }
 | 
			
		||||
      const contents = args.suffix.includes('only-defaults')
 | 
			
		||||
        ? getDefaults(resolvedSchema)
 | 
			
		||||
        : getSchema(resolvedSchema);
 | 
			
		||||
      return { contents, warnings: [] };
 | 
			
		||||
    });
 | 
			
		||||
  },
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export default jsonSchemaPlugin;
 | 
			
		||||
@@ -1,117 +0,0 @@
 | 
			
		||||
/* eslint-disable no-console */
 | 
			
		||||
import chokidar from 'chokidar';
 | 
			
		||||
import cors from 'cors';
 | 
			
		||||
import { context } from 'esbuild';
 | 
			
		||||
import type { Request, Response } from 'express';
 | 
			
		||||
import express from 'express';
 | 
			
		||||
import { packageOptions } from '../.build/common.js';
 | 
			
		||||
import { generateLangium } from '../.build/generateLangium.js';
 | 
			
		||||
import { defaultOptions, getBuildConfig } from './util.js';
 | 
			
		||||
 | 
			
		||||
const configs = Object.values(packageOptions).map(({ packageName }) =>
 | 
			
		||||
  getBuildConfig({ ...defaultOptions, minify: false, core: false, entryName: packageName })
 | 
			
		||||
);
 | 
			
		||||
const mermaidIIFEConfig = getBuildConfig({
 | 
			
		||||
  ...defaultOptions,
 | 
			
		||||
  minify: false,
 | 
			
		||||
  core: false,
 | 
			
		||||
  entryName: 'mermaid',
 | 
			
		||||
  format: 'iife',
 | 
			
		||||
});
 | 
			
		||||
configs.push(mermaidIIFEConfig);
 | 
			
		||||
 | 
			
		||||
const contexts = await Promise.all(
 | 
			
		||||
  configs.map(async (config) => ({ config, context: await context(config) }))
 | 
			
		||||
);
 | 
			
		||||
 | 
			
		||||
let rebuildCounter = 1;
 | 
			
		||||
const rebuildAll = async () => {
 | 
			
		||||
  const buildNumber = rebuildCounter++;
 | 
			
		||||
  const timeLabel = `Rebuild ${buildNumber} Time (total)`;
 | 
			
		||||
  console.time(timeLabel);
 | 
			
		||||
  await Promise.all(
 | 
			
		||||
    contexts.map(async ({ config, context }) => {
 | 
			
		||||
      const buildVariant = `Rebuild ${buildNumber} Time (${Object.keys(config.entryPoints!)[0]} ${config.format})`;
 | 
			
		||||
      console.time(buildVariant);
 | 
			
		||||
      await context.rebuild();
 | 
			
		||||
      console.timeEnd(buildVariant);
 | 
			
		||||
    })
 | 
			
		||||
  ).catch((e) => console.error(e));
 | 
			
		||||
  console.timeEnd(timeLabel);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
let clients: { id: number; response: Response }[] = [];
 | 
			
		||||
function eventsHandler(request: Request, response: Response) {
 | 
			
		||||
  const headers = {
 | 
			
		||||
    'Content-Type': 'text/event-stream',
 | 
			
		||||
    Connection: 'keep-alive',
 | 
			
		||||
    'Cache-Control': 'no-cache',
 | 
			
		||||
  };
 | 
			
		||||
  response.writeHead(200, headers);
 | 
			
		||||
  const clientId = Date.now();
 | 
			
		||||
  clients.push({
 | 
			
		||||
    id: clientId,
 | 
			
		||||
    response,
 | 
			
		||||
  });
 | 
			
		||||
  request.on('close', () => {
 | 
			
		||||
    clients = clients.filter((client) => client.id !== clientId);
 | 
			
		||||
  });
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
let timeoutID: NodeJS.Timeout | undefined = undefined;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Debounce file change events to avoid rebuilding multiple times.
 | 
			
		||||
 */
 | 
			
		||||
function handleFileChange() {
 | 
			
		||||
  if (timeoutID !== undefined) {
 | 
			
		||||
    clearTimeout(timeoutID);
 | 
			
		||||
  }
 | 
			
		||||
  // eslint-disable-next-line @typescript-eslint/no-misused-promises
 | 
			
		||||
  timeoutID = setTimeout(async () => {
 | 
			
		||||
    await rebuildAll();
 | 
			
		||||
    sendEventsToAll();
 | 
			
		||||
    timeoutID = undefined;
 | 
			
		||||
  }, 100);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function sendEventsToAll() {
 | 
			
		||||
  clients.forEach(({ response }) => response.write(`data: ${Date.now()}\n\n`));
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
async function createServer() {
 | 
			
		||||
  await generateLangium();
 | 
			
		||||
  handleFileChange();
 | 
			
		||||
  const app = express();
 | 
			
		||||
  chokidar
 | 
			
		||||
    .watch('**/src/**/*.{js,ts,langium,yaml,json}', {
 | 
			
		||||
      ignoreInitial: true,
 | 
			
		||||
      ignored: [/node_modules/, /dist/, /docs/, /coverage/],
 | 
			
		||||
    })
 | 
			
		||||
    // eslint-disable-next-line @typescript-eslint/no-misused-promises
 | 
			
		||||
    .on('all', async (event, path) => {
 | 
			
		||||
      // Ignore other events.
 | 
			
		||||
      if (!['add', 'change'].includes(event)) {
 | 
			
		||||
        return;
 | 
			
		||||
      }
 | 
			
		||||
      console.log(`${path} changed. Rebuilding...`);
 | 
			
		||||
      if (path.endsWith('.langium')) {
 | 
			
		||||
        await generateLangium();
 | 
			
		||||
      }
 | 
			
		||||
      handleFileChange();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
  app.use(cors());
 | 
			
		||||
  app.get('/events', eventsHandler);
 | 
			
		||||
  for (const { packageName } of Object.values(packageOptions)) {
 | 
			
		||||
    app.use(express.static(`./packages/${packageName}/dist`));
 | 
			
		||||
  }
 | 
			
		||||
  app.use(express.static('demos'));
 | 
			
		||||
  app.use(express.static('cypress/platform'));
 | 
			
		||||
 | 
			
		||||
  app.listen(9000, () => {
 | 
			
		||||
    console.log(`Listening on http://localhost:9000`);
 | 
			
		||||
  });
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void createServer();
 | 
			
		||||
							
								
								
									
										101
									
								
								.esbuild/util.ts
									
									
									
									
									
								
							
							
						
						
									
										101
									
								
								.esbuild/util.ts
									
									
									
									
									
								
							@@ -1,101 +0,0 @@
 | 
			
		||||
import { resolve } from 'path';
 | 
			
		||||
import { fileURLToPath } from 'url';
 | 
			
		||||
import type { BuildOptions } from 'esbuild';
 | 
			
		||||
import { readFileSync } from 'fs';
 | 
			
		||||
import jsonSchemaPlugin from './jsonSchemaPlugin.js';
 | 
			
		||||
import { packageOptions } from '../.build/common.js';
 | 
			
		||||
import { jisonPlugin } from './jisonPlugin.js';
 | 
			
		||||
 | 
			
		||||
const __dirname = fileURLToPath(new URL('.', import.meta.url));
 | 
			
		||||
 | 
			
		||||
export interface MermaidBuildOptions extends BuildOptions {
 | 
			
		||||
  minify: boolean;
 | 
			
		||||
  core: boolean;
 | 
			
		||||
  metafile: boolean;
 | 
			
		||||
  format: 'esm' | 'iife';
 | 
			
		||||
  entryName: keyof typeof packageOptions;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export const defaultOptions: Omit<MermaidBuildOptions, 'entryName'> = {
 | 
			
		||||
  minify: false,
 | 
			
		||||
  metafile: false,
 | 
			
		||||
  core: false,
 | 
			
		||||
  format: 'esm',
 | 
			
		||||
} as const;
 | 
			
		||||
 | 
			
		||||
const buildOptions = (override: BuildOptions): BuildOptions => {
 | 
			
		||||
  return {
 | 
			
		||||
    bundle: true,
 | 
			
		||||
    minify: true,
 | 
			
		||||
    keepNames: true,
 | 
			
		||||
    platform: 'browser',
 | 
			
		||||
    tsconfig: 'tsconfig.json',
 | 
			
		||||
    resolveExtensions: ['.ts', '.js', '.json', '.jison', '.yaml'],
 | 
			
		||||
    external: ['require', 'fs', 'path'],
 | 
			
		||||
    outdir: 'dist',
 | 
			
		||||
    plugins: [jisonPlugin, jsonSchemaPlugin],
 | 
			
		||||
    sourcemap: 'external',
 | 
			
		||||
    ...override,
 | 
			
		||||
  };
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const getFileName = (fileName: string, { core, format, minify }: MermaidBuildOptions) => {
 | 
			
		||||
  if (core) {
 | 
			
		||||
    fileName += '.core';
 | 
			
		||||
  } else if (format === 'esm') {
 | 
			
		||||
    fileName += '.esm';
 | 
			
		||||
  }
 | 
			
		||||
  if (minify) {
 | 
			
		||||
    fileName += '.min';
 | 
			
		||||
  }
 | 
			
		||||
  return fileName;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const getBuildConfig = (options: MermaidBuildOptions): BuildOptions => {
 | 
			
		||||
  const { core, entryName, metafile, format, minify } = options;
 | 
			
		||||
  const external: string[] = ['require', 'fs', 'path'];
 | 
			
		||||
  const { name, file, packageName } = packageOptions[entryName];
 | 
			
		||||
  const outFileName = getFileName(name, options);
 | 
			
		||||
  const output: BuildOptions = buildOptions({
 | 
			
		||||
    absWorkingDir: resolve(__dirname, `../packages/${packageName}`),
 | 
			
		||||
    entryPoints: {
 | 
			
		||||
      [outFileName]: `src/${file}`,
 | 
			
		||||
    },
 | 
			
		||||
    metafile,
 | 
			
		||||
    minify,
 | 
			
		||||
    logLevel: 'info',
 | 
			
		||||
    chunkNames: `chunks/${outFileName}/[name]-[hash]`,
 | 
			
		||||
    define: {
 | 
			
		||||
      'import.meta.vitest': 'undefined',
 | 
			
		||||
    },
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  if (core) {
 | 
			
		||||
    const { dependencies } = JSON.parse(
 | 
			
		||||
      readFileSync(resolve(__dirname, `../packages/${packageName}/package.json`), 'utf-8')
 | 
			
		||||
    );
 | 
			
		||||
    // Core build is used to generate file without bundled dependencies.
 | 
			
		||||
    // This is used by downstream projects to bundle dependencies themselves.
 | 
			
		||||
    // Ignore dependencies and any dependencies of dependencies
 | 
			
		||||
    external.push(...Object.keys(dependencies));
 | 
			
		||||
    output.external = external;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (format === 'iife') {
 | 
			
		||||
    output.format = 'iife';
 | 
			
		||||
    output.splitting = false;
 | 
			
		||||
    output.globalName = '__esbuild_esm_mermaid';
 | 
			
		||||
    // Workaround for removing the .default access in esbuild IIFE.
 | 
			
		||||
    // https://github.com/mermaid-js/mermaid/pull/4109#discussion_r1292317396
 | 
			
		||||
    output.footer = {
 | 
			
		||||
      js: 'globalThis.mermaid = globalThis.__esbuild_esm_mermaid.default;',
 | 
			
		||||
    };
 | 
			
		||||
    output.outExtension = { '.js': '.js' };
 | 
			
		||||
  } else {
 | 
			
		||||
    output.format = 'esm';
 | 
			
		||||
    output.splitting = true;
 | 
			
		||||
    output.outExtension = { '.js': '.mjs' };
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return output;
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										8
									
								
								.eslintignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								.eslintignore
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,8 @@
 | 
			
		||||
dist/**
 | 
			
		||||
.github/**
 | 
			
		||||
docs/Setup.md
 | 
			
		||||
cypress.config.js
 | 
			
		||||
cypress/plugins/index.js
 | 
			
		||||
coverage
 | 
			
		||||
*.json
 | 
			
		||||
node_modules
 | 
			
		||||
							
								
								
									
										150
									
								
								.eslintrc.cjs
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										150
									
								
								.eslintrc.cjs
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,150 @@
 | 
			
		||||
module.exports = {
 | 
			
		||||
  env: {
 | 
			
		||||
    browser: true,
 | 
			
		||||
    es6: true,
 | 
			
		||||
    'jest/globals': true,
 | 
			
		||||
    node: true,
 | 
			
		||||
  },
 | 
			
		||||
  root: true,
 | 
			
		||||
  parser: '@typescript-eslint/parser',
 | 
			
		||||
  parserOptions: {
 | 
			
		||||
    ecmaFeatures: {
 | 
			
		||||
      experimentalObjectRestSpread: true,
 | 
			
		||||
      jsx: true,
 | 
			
		||||
    },
 | 
			
		||||
    tsconfigRootDir: __dirname,
 | 
			
		||||
    sourceType: 'module',
 | 
			
		||||
    ecmaVersion: 2020,
 | 
			
		||||
    allowAutomaticSingleRunInference: true,
 | 
			
		||||
    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
 | 
			
		||||
    parser: '@typescript-eslint/parser',
 | 
			
		||||
  },
 | 
			
		||||
  extends: [
 | 
			
		||||
    'eslint:recommended',
 | 
			
		||||
    'plugin:@typescript-eslint/recommended',
 | 
			
		||||
    'plugin:json/recommended',
 | 
			
		||||
    'plugin:markdown/recommended',
 | 
			
		||||
    'plugin:@cspell/recommended',
 | 
			
		||||
    'prettier',
 | 
			
		||||
  ],
 | 
			
		||||
  plugins: [
 | 
			
		||||
    '@typescript-eslint',
 | 
			
		||||
    'no-only-tests',
 | 
			
		||||
    'html',
 | 
			
		||||
    'jest',
 | 
			
		||||
    'jsdoc',
 | 
			
		||||
    'json',
 | 
			
		||||
    '@cspell',
 | 
			
		||||
    'lodash',
 | 
			
		||||
    'unicorn',
 | 
			
		||||
  ],
 | 
			
		||||
  rules: {
 | 
			
		||||
    curly: 'error',
 | 
			
		||||
    'no-console': 'error',
 | 
			
		||||
    'no-prototype-builtins': 'off',
 | 
			
		||||
    'no-unused-vars': 'off',
 | 
			
		||||
    'cypress/no-async-tests': 'off',
 | 
			
		||||
    '@typescript-eslint/no-floating-promises': 'error',
 | 
			
		||||
    '@typescript-eslint/no-misused-promises': 'error',
 | 
			
		||||
    '@typescript-eslint/ban-ts-comment': [
 | 
			
		||||
      'error',
 | 
			
		||||
      {
 | 
			
		||||
        'ts-expect-error': 'allow-with-description',
 | 
			
		||||
        'ts-ignore': 'allow-with-description',
 | 
			
		||||
        'ts-nocheck': 'allow-with-description',
 | 
			
		||||
        'ts-check': 'allow-with-description',
 | 
			
		||||
        minimumDescriptionLength: 10,
 | 
			
		||||
      },
 | 
			
		||||
    ],
 | 
			
		||||
    'json/*': ['error', 'allowComments'],
 | 
			
		||||
    '@cspell/spellchecker': [
 | 
			
		||||
      'error',
 | 
			
		||||
      {
 | 
			
		||||
        checkIdentifiers: false,
 | 
			
		||||
        checkStrings: false,
 | 
			
		||||
        checkStringTemplates: false,
 | 
			
		||||
      },
 | 
			
		||||
    ],
 | 
			
		||||
    'no-empty': [
 | 
			
		||||
      'error',
 | 
			
		||||
      {
 | 
			
		||||
        allowEmptyCatch: true,
 | 
			
		||||
      },
 | 
			
		||||
    ],
 | 
			
		||||
    'no-only-tests/no-only-tests': 'error',
 | 
			
		||||
    'lodash/import-scope': ['error', 'method'],
 | 
			
		||||
    'unicorn/better-regex': 'error',
 | 
			
		||||
    'unicorn/no-abusive-eslint-disable': 'error',
 | 
			
		||||
    'unicorn/no-array-push-push': 'error',
 | 
			
		||||
    'unicorn/no-for-loop': 'error',
 | 
			
		||||
    'unicorn/no-instanceof-array': 'error',
 | 
			
		||||
    'unicorn/no-typeof-undefined': 'error',
 | 
			
		||||
    'unicorn/no-unnecessary-await': 'error',
 | 
			
		||||
    'unicorn/no-unsafe-regex': 'warn',
 | 
			
		||||
    'unicorn/no-useless-promise-resolve-reject': 'error',
 | 
			
		||||
    'unicorn/prefer-array-find': 'error',
 | 
			
		||||
    'unicorn/prefer-array-flat-map': 'error',
 | 
			
		||||
    'unicorn/prefer-array-index-of': 'error',
 | 
			
		||||
    'unicorn/prefer-array-some': 'error',
 | 
			
		||||
    'unicorn/prefer-default-parameters': 'error',
 | 
			
		||||
    'unicorn/prefer-includes': 'error',
 | 
			
		||||
    'unicorn/prefer-negative-index': 'error',
 | 
			
		||||
    'unicorn/prefer-object-from-entries': 'error',
 | 
			
		||||
    'unicorn/prefer-string-starts-ends-with': 'error',
 | 
			
		||||
    'unicorn/prefer-string-trim-start-end': 'error',
 | 
			
		||||
    'unicorn/string-content': 'error',
 | 
			
		||||
    'unicorn/prefer-spread': 'error',
 | 
			
		||||
    'unicorn/no-lonely-if': 'error',
 | 
			
		||||
  },
 | 
			
		||||
  overrides: [
 | 
			
		||||
    {
 | 
			
		||||
      files: ['cypress/**', 'demos/**'],
 | 
			
		||||
      rules: {
 | 
			
		||||
        'no-console': 'off',
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      files: ['*.{js,jsx,mjs,cjs}'],
 | 
			
		||||
      extends: ['plugin:jsdoc/recommended'],
 | 
			
		||||
      rules: {
 | 
			
		||||
        'jsdoc/check-indentation': 'off',
 | 
			
		||||
        'jsdoc/check-alignment': 'off',
 | 
			
		||||
        'jsdoc/check-line-alignment': 'off',
 | 
			
		||||
        'jsdoc/multiline-blocks': 'off',
 | 
			
		||||
        'jsdoc/newline-after-description': 'off',
 | 
			
		||||
        'jsdoc/tag-lines': 'off',
 | 
			
		||||
        'jsdoc/require-param-description': 'off',
 | 
			
		||||
        'jsdoc/require-param-type': 'off',
 | 
			
		||||
        'jsdoc/require-returns': 'off',
 | 
			
		||||
        'jsdoc/require-returns-description': 'off',
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      files: ['*.{ts,tsx}'],
 | 
			
		||||
      plugins: ['tsdoc'],
 | 
			
		||||
      rules: {
 | 
			
		||||
        'tsdoc/syntax': 'error',
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      files: ['*.spec.{ts,js}', 'cypress/**', 'demos/**', '**/docs/**'],
 | 
			
		||||
      rules: {
 | 
			
		||||
        'jsdoc/require-jsdoc': 'off',
 | 
			
		||||
        '@typescript-eslint/no-unused-vars': 'off',
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      files: ['*.html', '*.md', '**/*.md/*'],
 | 
			
		||||
      rules: {
 | 
			
		||||
        'no-var': 'error',
 | 
			
		||||
        'no-undef': 'off',
 | 
			
		||||
        '@typescript-eslint/no-unused-vars': 'off',
 | 
			
		||||
        '@typescript-eslint/no-floating-promises': 'off',
 | 
			
		||||
        '@typescript-eslint/no-misused-promises': 'off',
 | 
			
		||||
      },
 | 
			
		||||
      parserOptions: {
 | 
			
		||||
        project: null,
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
  ],
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										5
									
								
								.github/ISSUE_TEMPLATE/bug_report.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.github/ISSUE_TEMPLATE/bug_report.yml
									
									
									
									
										vendored
									
									
								
							@@ -17,9 +17,6 @@ body:
 | 
			
		||||
        - Use a clear and concise title
 | 
			
		||||
        - Fill out the text fields with as much detail as possible.
 | 
			
		||||
        - Never be shy to give us screenshots and/or code samples. It will help!
 | 
			
		||||
 | 
			
		||||
        There is a chance that the bug is already fixed in the git `develop` branch, but is not released yet. 
 | 
			
		||||
        So please check in [Live Editor - Develop](https://develop.git.mermaid.live) before raising an issue.
 | 
			
		||||
  - type: textarea
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: Description
 | 
			
		||||
@@ -46,7 +43,7 @@ body:
 | 
			
		||||
    attributes:
 | 
			
		||||
      label: Code Sample
 | 
			
		||||
      description: |-
 | 
			
		||||
        If applicable, add the code sample or a link to the [Live Editor - Develop](https://develop.git.mermaid.live).
 | 
			
		||||
        If applicable, add the code sample or a link to the [Live Editor](https://mermaid.live).
 | 
			
		||||
        Any text pasted here will be rendered as a Code block.
 | 
			
		||||
      render: text
 | 
			
		||||
  - type: textarea
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										14
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										14
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
								
							@@ -3,18 +3,12 @@ contact_links:
 | 
			
		||||
  - name: GitHub Discussions
 | 
			
		||||
    url: https://github.com/mermaid-js/mermaid/discussions
 | 
			
		||||
    about: Ask the Community questions or share your own graphs in our discussions.
 | 
			
		||||
  - name: Discord
 | 
			
		||||
    url: https://discord.gg/AgrbSrBer3
 | 
			
		||||
    about: Join our Community on Discord for Help and a casual chat.
 | 
			
		||||
  - name: Slack
 | 
			
		||||
    url: https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE
 | 
			
		||||
    about: Join our Community on Slack for Help and a casual chat.
 | 
			
		||||
  - name: Documentation
 | 
			
		||||
    url: https://mermaid.js.org
 | 
			
		||||
    url: https://mermaid-js.github.io
 | 
			
		||||
    about: Read our documentation for all that Mermaid.js can offer.
 | 
			
		||||
  - name: Live Editor
 | 
			
		||||
    url: https://mermaid.live
 | 
			
		||||
    about: Try the live editor to preview graphs in no time.
 | 
			
		||||
  - name: Live Editor - Develop
 | 
			
		||||
    url: https://develop.git.mermaid.live
 | 
			
		||||
    about: Try unreleased changes in the develop branch.
 | 
			
		||||
  - name: Live Editor - Next
 | 
			
		||||
    url: https://next.git.mermaid.live
 | 
			
		||||
    about: Try unreleased changes in the next branch.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										53
									
								
								.github/lychee.toml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										53
									
								
								.github/lychee.toml
									
									
									
									
										vendored
									
									
								
							@@ -1,53 +0,0 @@
 | 
			
		||||
#############################  Display  #############################
 | 
			
		||||
 | 
			
		||||
# Verbose program output
 | 
			
		||||
# Accepts log level: "error", "warn", "info", "debug", "trace"
 | 
			
		||||
verbose = "debug"
 | 
			
		||||
 | 
			
		||||
# Don't show interactive progress bar while checking links.
 | 
			
		||||
no_progress = true
 | 
			
		||||
 | 
			
		||||
#############################  Cache  ###############################
 | 
			
		||||
 | 
			
		||||
# Enable link caching. This can be helpful to avoid checking the same links on
 | 
			
		||||
# multiple runs.
 | 
			
		||||
cache = true
 | 
			
		||||
 | 
			
		||||
# Discard all cached requests older than this duration.
 | 
			
		||||
max_cache_age = "1d"
 | 
			
		||||
 | 
			
		||||
#############################  Requests  ############################
 | 
			
		||||
 | 
			
		||||
# Comma-separated list of accepted status codes for valid links.
 | 
			
		||||
accept = [200, 429]
 | 
			
		||||
 | 
			
		||||
#############################  Exclusions  ##########################
 | 
			
		||||
 | 
			
		||||
# Exclude URLs and mail addresses from checking (supports regex).
 | 
			
		||||
exclude = [
 | 
			
		||||
# Network error: Forbidden
 | 
			
		||||
"https://codepen.io",
 | 
			
		||||
 | 
			
		||||
# Timeout error, maybe Twitter has anti-bot defenses against GitHub's CI servers?
 | 
			
		||||
"https://twitter.com/mermaidjs_",
 | 
			
		||||
 | 
			
		||||
# Don't check files that are generated during the build via `pnpm docs:code`
 | 
			
		||||
'packages/mermaid/src/docs/config/setup/*',
 | 
			
		||||
 | 
			
		||||
# Ignore Discord invite
 | 
			
		||||
"https://discord.gg",
 | 
			
		||||
 | 
			
		||||
# BundlePhobia has frequent downtime
 | 
			
		||||
"https://bundlephobia.com",
 | 
			
		||||
 | 
			
		||||
# Chrome webstore migration issue. Temporary
 | 
			
		||||
"https://chromewebstore.google.com",
 | 
			
		||||
 | 
			
		||||
# Drupal 403
 | 
			
		||||
"https://(www.)?drupal.org"
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
# Exclude all private IPs from checking.
 | 
			
		||||
# Equivalent to setting `exclude_private`, `exclude_link_local`, and
 | 
			
		||||
# `exclude_loopback` to true.
 | 
			
		||||
exclude_all_private = true
 | 
			
		||||
							
								
								
									
										25
									
								
								.github/pr-labeler.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										25
									
								
								.github/pr-labeler.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,22 +1,3 @@
 | 
			
		||||
# yaml-language-server: $schema=https://raw.githubusercontent.com/release-drafter/release-drafter/master/schema.json
 | 
			
		||||
autolabeler:
 | 
			
		||||
  - label: 'Type: Bug / Error'
 | 
			
		||||
    branch:
 | 
			
		||||
      - '/bug\/.+/'
 | 
			
		||||
      - '/fix\/.+/'
 | 
			
		||||
  - label: 'Type: Enhancement'
 | 
			
		||||
    branch:
 | 
			
		||||
      - '/feature\/.+/'
 | 
			
		||||
      - '/feat\/.+/'
 | 
			
		||||
  - label: 'Type: Other'
 | 
			
		||||
    branch:
 | 
			
		||||
      - '/other\/.+/'
 | 
			
		||||
      - '/chore\/.+/'
 | 
			
		||||
      - '/test\/.+/'
 | 
			
		||||
      - '/refactor\/.+/'
 | 
			
		||||
  - label: 'Area: Documentation'
 | 
			
		||||
    branch:
 | 
			
		||||
      - '/docs\/.+/'
 | 
			
		||||
 | 
			
		||||
template: |
 | 
			
		||||
  This field is unused, as we only use this config file for labeling PRs.
 | 
			
		||||
'Type: Bug / Error': 'bug/*'
 | 
			
		||||
'Type: Enhancement': 'feature/*'
 | 
			
		||||
'Type: Other': 'other/*'
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/pull_request_template.md
									
									
									
									
										vendored
									
									
								
							@@ -12,7 +12,7 @@ Describe the way your implementation works or what design decisions you made if
 | 
			
		||||
 | 
			
		||||
Make sure you
 | 
			
		||||
 | 
			
		||||
- [ ] :book: have read the [contribution guidelines](https://mermaid.js.org/community/contributing.html)
 | 
			
		||||
- [ ] :computer: have added necessary unit/e2e tests.
 | 
			
		||||
- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://mermaid.js.org/community/contributing.html#update-documentation) is used for all new features.
 | 
			
		||||
- [ ] :butterfly: 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:`.
 | 
			
		||||
- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
 | 
			
		||||
- [ ] :computer: have added unit/e2e tests (if appropriate)
 | 
			
		||||
- [ ] :notebook: have added documentation (if appropriate)
 | 
			
		||||
- [ ] :bookmark: targeted `develop` branch
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										25
									
								
								.github/release-drafter.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										25
									
								
								.github/release-drafter.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,25 @@
 | 
			
		||||
name-template: '$NEXT_PATCH_VERSION'
 | 
			
		||||
tag-template: '$NEXT_PATCH_VERSION'
 | 
			
		||||
categories:
 | 
			
		||||
  - title: '🚀 Features'
 | 
			
		||||
    labels:
 | 
			
		||||
      - 'Type: Enhancement'
 | 
			
		||||
  - title: '🐛 Bug Fixes'
 | 
			
		||||
    labels:
 | 
			
		||||
      - 'Type: Bug / Error'
 | 
			
		||||
  - title: '🧰 Maintenance'
 | 
			
		||||
    label: 'Type: Other'
 | 
			
		||||
change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
 | 
			
		||||
sort-by: title
 | 
			
		||||
sort-direction: ascending
 | 
			
		||||
branches:
 | 
			
		||||
  - develop
 | 
			
		||||
exclude-labels:
 | 
			
		||||
  - 'Skip changelog'
 | 
			
		||||
no-changes-template: 'This release contains minor changes and bugfixes.'
 | 
			
		||||
template: |
 | 
			
		||||
  # Release Notes
 | 
			
		||||
 | 
			
		||||
  $CHANGES
 | 
			
		||||
 | 
			
		||||
  🎉 **Thanks to all contributors helping with this release!** 🎉
 | 
			
		||||
							
								
								
									
										43
									
								
								.github/workflows/autofix.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										43
									
								
								.github/workflows/autofix.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,43 +0,0 @@
 | 
			
		||||
name: autofix.ci # needed to securely identify the workflow
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches-ignore:
 | 
			
		||||
      - 'renovate/**'
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  autofix:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: |
 | 
			
		||||
          pnpm install --frozen-lockfile
 | 
			
		||||
        env:
 | 
			
		||||
          CYPRESS_CACHE_FOLDER: .cache/Cypress
 | 
			
		||||
 | 
			
		||||
      - name: Fix Linting
 | 
			
		||||
        shell: bash
 | 
			
		||||
        run: pnpm -w run lint:fix
 | 
			
		||||
 | 
			
		||||
      - name: Sync `./src/config.type.ts` with `./src/schemas/config.schema.yaml`
 | 
			
		||||
        shell: bash
 | 
			
		||||
        run: pnpm run --filter mermaid types:build-config
 | 
			
		||||
 | 
			
		||||
      - name: Build Docs
 | 
			
		||||
        working-directory: ./packages/mermaid
 | 
			
		||||
        run: pnpm run docs:build
 | 
			
		||||
 | 
			
		||||
      - uses: autofix-ci/action@ff86a557419858bb967097bfc916833f5647fa8c
 | 
			
		||||
							
								
								
									
										20
									
								
								.github/workflows/build-docs.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/workflows/build-docs.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,37 +1,29 @@
 | 
			
		||||
name: Build Vitepress docs
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches:
 | 
			
		||||
      - master
 | 
			
		||||
      - release/*
 | 
			
		||||
  pull_request:
 | 
			
		||||
  merge_group:
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  build-docs:
 | 
			
		||||
  # Build job
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout
 | 
			
		||||
        uses: actions/checkout@v4
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: 18
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: pnpm install --frozen-lockfile
 | 
			
		||||
 | 
			
		||||
      - name: Verify release version
 | 
			
		||||
        if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release')) }}
 | 
			
		||||
        run: pnpm --filter mermaid run docs:verify-version
 | 
			
		||||
 | 
			
		||||
      - name: Run Build
 | 
			
		||||
        run: pnpm --filter mermaid run docs:build:vitepress
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										20
									
								
								.github/workflows/build.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/workflows/build.yml
									
									
									
									
										vendored
									
									
								
							@@ -2,7 +2,6 @@ name: Build
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push: {}
 | 
			
		||||
  merge_group:
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types:
 | 
			
		||||
      - opened
 | 
			
		||||
@@ -13,19 +12,22 @@ permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  build-mermaid:
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    strategy:
 | 
			
		||||
      matrix:
 | 
			
		||||
        node-version: [18.x]
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
      - name: Setup Node.js ${{ matrix.node-version }}
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: ${{ matrix.node-version }}
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: |
 | 
			
		||||
@@ -37,13 +39,13 @@ jobs:
 | 
			
		||||
        run: pnpm run build
 | 
			
		||||
 | 
			
		||||
      - name: Upload Mermaid Build as Artifact
 | 
			
		||||
        uses: actions/upload-artifact@v4
 | 
			
		||||
        uses: actions/upload-artifact@v3
 | 
			
		||||
        with:
 | 
			
		||||
          name: mermaid-build
 | 
			
		||||
          path: packages/mermaid/dist
 | 
			
		||||
 | 
			
		||||
      - name: Upload Mermaid Mindmap Build as Artifact
 | 
			
		||||
        uses: actions/upload-artifact@v4
 | 
			
		||||
        uses: actions/upload-artifact@v3
 | 
			
		||||
        with:
 | 
			
		||||
          name: mermaid-mindmap-build
 | 
			
		||||
          path: packages/mermaid-mindmap/dist
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								.github/workflows/check-readme-in-sync.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/check-readme-in-sync.yml
									
									
									
									
										vendored
									
									
								
							@@ -14,11 +14,11 @@ permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  check-readme:
 | 
			
		||||
  check:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout repository
 | 
			
		||||
        uses: actions/checkout@v4
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - name: Check for difference in README.md and docs/README.md
 | 
			
		||||
        run: |
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										9
									
								
								.github/workflows/checks.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								.github/workflows/checks.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,21 +1,20 @@
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
  merge_group:
 | 
			
		||||
  push: {}
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types:
 | 
			
		||||
      - opened
 | 
			
		||||
      - synchronize
 | 
			
		||||
      - ready_for_review
 | 
			
		||||
 | 
			
		||||
name: Static analysis on Test files
 | 
			
		||||
name: Static analysis
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  check-tests:
 | 
			
		||||
  test:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    name: check tests
 | 
			
		||||
    if: github.repository_owner == 'mermaid-js'
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
        with:
 | 
			
		||||
          fetch-depth: 0
 | 
			
		||||
      - uses: testomatio/check-tests@stable
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								.github/workflows/codeql.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/workflows/codeql.yml
									
									
									
									
										vendored
									
									
								
							@@ -29,11 +29,11 @@ jobs:
 | 
			
		||||
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout repository
 | 
			
		||||
        uses: actions/checkout@v4
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      # Initializes the CodeQL tools for scanning.
 | 
			
		||||
      - name: Initialize CodeQL
 | 
			
		||||
        uses: github/codeql-action/init@v3
 | 
			
		||||
        uses: github/codeql-action/init@v2
 | 
			
		||||
        with:
 | 
			
		||||
          config-file: ./.github/codeql/codeql-config.yml
 | 
			
		||||
          languages: ${{ matrix.language }}
 | 
			
		||||
@@ -45,7 +45,7 @@ jobs:
 | 
			
		||||
      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
 | 
			
		||||
      # If this step fails, then you should remove it and run the build manually (see below)
 | 
			
		||||
      - name: Autobuild
 | 
			
		||||
        uses: github/codeql-action/autobuild@v3
 | 
			
		||||
        uses: github/codeql-action/autobuild@v2
 | 
			
		||||
 | 
			
		||||
      # ℹ️ Command-line programs to run using the OS shell.
 | 
			
		||||
      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 | 
			
		||||
@@ -59,4 +59,4 @@ jobs:
 | 
			
		||||
      #   make release
 | 
			
		||||
 | 
			
		||||
      - name: Perform CodeQL Analysis
 | 
			
		||||
        uses: github/codeql-action/analyze@v3
 | 
			
		||||
        uses: github/codeql-action/analyze@v2
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										6
									
								
								.github/workflows/dependency-review.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6
									
								
								.github/workflows/dependency-review.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,6 +1,6 @@
 | 
			
		||||
# Dependency Review Action
 | 
			
		||||
#
 | 
			
		||||
# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
 | 
			
		||||
# This Action will scan dependency manifest files that change as part of a Pull Reqest, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
 | 
			
		||||
#
 | 
			
		||||
# Source repository: https://github.com/actions/dependency-review-action
 | 
			
		||||
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
 | 
			
		||||
@@ -15,6 +15,6 @@ jobs:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: 'Checkout Repository'
 | 
			
		||||
        uses: actions/checkout@v4
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
      - name: 'Dependency Review'
 | 
			
		||||
        uses: actions/dependency-review-action@v4
 | 
			
		||||
        uses: actions/dependency-review-action@v3
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										20
									
								
								.github/workflows/e2e-applitools.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/workflows/e2e-applitools.yml
									
									
									
									
										vendored
									
									
								
							@@ -19,26 +19,26 @@ env:
 | 
			
		||||
  USE_APPLI: ${{ secrets.APPLITOOLS_API_KEY && 'true' || '' }}
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  e2e-applitools:
 | 
			
		||||
  test:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    container:
 | 
			
		||||
      image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1
 | 
			
		||||
      options: --user 1001
 | 
			
		||||
    strategy:
 | 
			
		||||
      matrix:
 | 
			
		||||
        node-version: [18.x]
 | 
			
		||||
    steps:
 | 
			
		||||
      - if: ${{ ! env.USE_APPLI }}
 | 
			
		||||
        name: Warn if not using Applitools
 | 
			
		||||
        run: |
 | 
			
		||||
          echo "::error,title=Not using Applitools::APPLITOOLS_API_KEY is empty, disabling Applitools for this run."
 | 
			
		||||
          echo "::error,title=Not using Applitols::APPLITOOLS_API_KEY is empty, disabling Applitools for this run."
 | 
			
		||||
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
      - name: Setup Node.js ${{ matrix.node-version }}
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: ${{ matrix.node-version }}
 | 
			
		||||
 | 
			
		||||
      - if: ${{ env.USE_APPLI }}
 | 
			
		||||
        name: Notify applitools of new batch
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										132
									
								
								.github/workflows/e2e.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										132
									
								
								.github/workflows/e2e.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,149 +1,59 @@
 | 
			
		||||
name: E2E
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches-ignore:
 | 
			
		||||
      - 'gh-readonly-queue/**'
 | 
			
		||||
  pull_request:
 | 
			
		||||
  merge_group:
 | 
			
		||||
on: [push, pull_request]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
env:
 | 
			
		||||
  # For PRs and MergeQueues, the target commit is used, and for push events to non-develop branches, github.event.previous is used if available. Otherwise, 'develop' is used.
 | 
			
		||||
  targetHash: >-
 | 
			
		||||
    ${{ 
 | 
			
		||||
      github.event.pull_request.base.sha || 
 | 
			
		||||
      github.event.merge_group.base_sha || 
 | 
			
		||||
      (
 | 
			
		||||
        (
 | 
			
		||||
          (github.event_name == 'push' && github.ref == 'refs/heads/develop') || 
 | 
			
		||||
          github.event.before == '0000000000000000000000000000000000000000'
 | 
			
		||||
        ) && 'develop'
 | 
			
		||||
      ) || 
 | 
			
		||||
      github.event.before
 | 
			
		||||
    }}
 | 
			
		||||
  shouldRunParallel: ${{ secrets.CYPRESS_RECORD_KEY != '' && !(github.event_name == 'push' && github.ref == 'refs/heads/develop') }}
 | 
			
		||||
jobs:
 | 
			
		||||
  cache:
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    container:
 | 
			
		||||
      image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1
 | 
			
		||||
      options: --user 1001
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
        with:
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
      - name: Cache snapshots
 | 
			
		||||
        id: cache-snapshot
 | 
			
		||||
        uses: actions/cache@v4
 | 
			
		||||
        with:
 | 
			
		||||
          save-always: true
 | 
			
		||||
          path: ./cypress/snapshots
 | 
			
		||||
          key: ${{ runner.os }}-snapshots-${{ env.targetHash }}
 | 
			
		||||
 | 
			
		||||
      # If a snapshot for a given Hash is not found, we checkout that commit, run the tests and cache the snapshots.
 | 
			
		||||
      - name: Switch to base branch
 | 
			
		||||
        if: ${{ steps.cache-snapshot.outputs.cache-hit != 'true' }}
 | 
			
		||||
        uses: actions/checkout@v4
 | 
			
		||||
        with:
 | 
			
		||||
          ref: ${{ env.targetHash }}
 | 
			
		||||
 | 
			
		||||
      - name: Install dependencies
 | 
			
		||||
        if: ${{ steps.cache-snapshot.outputs.cache-hit != 'true' }}
 | 
			
		||||
        uses: cypress-io/github-action@v6
 | 
			
		||||
        with:
 | 
			
		||||
          # just perform install
 | 
			
		||||
          runTests: false
 | 
			
		||||
 | 
			
		||||
      - name: Calculate bundle size
 | 
			
		||||
        if: ${{ steps.cache-snapshot.outputs.cache-hit != 'true'}}
 | 
			
		||||
        run: |
 | 
			
		||||
          pnpm run build:viz
 | 
			
		||||
          mkdir -p cypress/snapshots/stats/base
 | 
			
		||||
          mv stats cypress/snapshots/stats/base
 | 
			
		||||
 | 
			
		||||
  e2e:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    container:
 | 
			
		||||
      image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1
 | 
			
		||||
      options: --user 1001
 | 
			
		||||
    needs: cache
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
      matrix:
 | 
			
		||||
        node-version: [18.x]
 | 
			
		||||
        containers: [1, 2, 3, 4]
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
      - name: Setup Node.js ${{ matrix.node-version }}
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
 | 
			
		||||
      # These cached snapshots are downloaded, providing the reference snapshots.
 | 
			
		||||
      - name: Cache snapshots
 | 
			
		||||
        id: cache-snapshot
 | 
			
		||||
        uses: actions/cache/restore@v4
 | 
			
		||||
        with:
 | 
			
		||||
          path: ./cypress/snapshots
 | 
			
		||||
          key: ${{ runner.os }}-snapshots-${{ env.targetHash }}
 | 
			
		||||
 | 
			
		||||
      - name: Install dependencies
 | 
			
		||||
        uses: cypress-io/github-action@v6
 | 
			
		||||
        with:
 | 
			
		||||
          runTests: false
 | 
			
		||||
 | 
			
		||||
      - name: Output size diff
 | 
			
		||||
        if: ${{ matrix.containers == 1 }}
 | 
			
		||||
        run: |
 | 
			
		||||
          pnpm run build:viz
 | 
			
		||||
          mv stats cypress/snapshots/stats/head
 | 
			
		||||
          echo '## Bundle size difference' >> "$GITHUB_STEP_SUMMARY"
 | 
			
		||||
          echo '' >> "$GITHUB_STEP_SUMMARY"
 | 
			
		||||
          npx tsx scripts/size.ts >> "$GITHUB_STEP_SUMMARY"
 | 
			
		||||
          node-version: ${{ matrix.node-version }}
 | 
			
		||||
 | 
			
		||||
      # Install NPM dependencies, cache them correctly
 | 
			
		||||
      # and run all Cypress tests
 | 
			
		||||
      - name: Cypress run
 | 
			
		||||
        uses: cypress-io/github-action@v6
 | 
			
		||||
        uses: cypress-io/github-action@v4
 | 
			
		||||
        id: cypress
 | 
			
		||||
        # If CYPRESS_RECORD_KEY is set, run in parallel on all containers
 | 
			
		||||
        # Otherwise (e.g. if running from fork), we run on a single container only
 | 
			
		||||
        if: ${{ env.shouldRunParallel == 'true' || ( matrix.containers == 1 ) }}
 | 
			
		||||
        if: ${{ ( env.CYPRESS_RECORD_KEY != '' ) || ( matrix.containers == 1 ) }}
 | 
			
		||||
        with:
 | 
			
		||||
          install: false
 | 
			
		||||
          start: pnpm run dev:coverage
 | 
			
		||||
          wait-on: 'http://localhost:9000'
 | 
			
		||||
          browser: chrome
 | 
			
		||||
          # Disable recording if we don't have an API key
 | 
			
		||||
          # e.g. if this action was run from a fork
 | 
			
		||||
          record: ${{ env.shouldRunParallel == 'true' }}
 | 
			
		||||
          parallel: ${{ env.shouldRunParallel == 'true' }}
 | 
			
		||||
          record: ${{ secrets.CYPRESS_RECORD_KEY != '' }}
 | 
			
		||||
          parallel: ${{ secrets.CYPRESS_RECORD_KEY != '' }}
 | 
			
		||||
        env:
 | 
			
		||||
          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
 | 
			
		||||
          VITEST_COVERAGE: true
 | 
			
		||||
          CYPRESS_COMMIT: ${{ github.sha }}
 | 
			
		||||
          ARGOS_TOKEN: ${{ secrets.ARGOS_TOKEN }}
 | 
			
		||||
          ARGOS_PARALLEL: ${{ env.shouldRunParallel == 'true' }}
 | 
			
		||||
          ARGOS_PARALLEL_TOTAL: 4
 | 
			
		||||
          ARGOS_PARALLEL_INDEX: ${{ matrix.containers }}
 | 
			
		||||
 | 
			
		||||
      - name: Upload Coverage to Codecov
 | 
			
		||||
        uses: codecov/codecov-action@v4
 | 
			
		||||
        # Run step only pushes to develop and pull_requests
 | 
			
		||||
        if: ${{ steps.cypress.conclusion == 'success' && (github.event_name == 'pull_request' || github.ref == 'refs/heads/develop')}}
 | 
			
		||||
        uses: codecov/codecov-action@v3
 | 
			
		||||
        if: steps.cypress.conclusion == 'success'
 | 
			
		||||
        with:
 | 
			
		||||
          files: coverage/cypress/lcov.info
 | 
			
		||||
          flags: e2e
 | 
			
		||||
          name: mermaid-codecov
 | 
			
		||||
          fail_ci_if_error: false
 | 
			
		||||
          fail_ci_if_error: true
 | 
			
		||||
          verbose: true
 | 
			
		||||
          token: 6845cc80-77ee-4e17-85a1-026cd95e0766
 | 
			
		||||
      - name: Upload Artifacts
 | 
			
		||||
        uses: actions/upload-artifact@v3
 | 
			
		||||
        if: ${{ failure() && steps.cypress.conclusion == 'failure' }}
 | 
			
		||||
        with:
 | 
			
		||||
          name: error-snapshots
 | 
			
		||||
          path: cypress/snapshots/**/__diff_output__/*
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										13
									
								
								.github/workflows/link-checker.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										13
									
								
								.github/workflows/link-checker.yml
									
									
									
									
										vendored
									
									
								
							@@ -20,26 +20,29 @@ on:
 | 
			
		||||
    - cron: '30 8 * * *'
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  link-checker:
 | 
			
		||||
  linkChecker:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    permissions:
 | 
			
		||||
      # lychee only uses the GITHUB_TOKEN to avoid rate-limiting
 | 
			
		||||
      contents: read
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - name: Restore lychee cache
 | 
			
		||||
        uses: actions/cache@v4
 | 
			
		||||
        uses: actions/cache@v3
 | 
			
		||||
        with:
 | 
			
		||||
          path: .lycheecache
 | 
			
		||||
          key: cache-lychee-${{ github.sha }}
 | 
			
		||||
          restore-keys: cache-lychee-
 | 
			
		||||
 | 
			
		||||
      - name: Link Checker
 | 
			
		||||
        uses: lycheeverse/lychee-action@v1.9.3
 | 
			
		||||
        uses: lycheeverse/lychee-action@v1.8.0
 | 
			
		||||
        with:
 | 
			
		||||
          args: >-
 | 
			
		||||
            --config .github/lychee.toml
 | 
			
		||||
            --verbose
 | 
			
		||||
            --no-progress
 | 
			
		||||
            --cache
 | 
			
		||||
            --max-cache-age 1d
 | 
			
		||||
            packages/mermaid/src/docs/**/*.md
 | 
			
		||||
            README.md
 | 
			
		||||
            README.zh-CN.md
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										55
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										55
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,8 +1,7 @@
 | 
			
		||||
name: Lint
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
  merge_group:
 | 
			
		||||
  push: {}
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types:
 | 
			
		||||
      - opened
 | 
			
		||||
@@ -16,17 +15,20 @@ permissions:
 | 
			
		||||
jobs:
 | 
			
		||||
  lint:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    strategy:
 | 
			
		||||
      matrix:
 | 
			
		||||
        node-version: [18.x]
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
      - name: Setup Node.js ${{ matrix.node-version }}
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: ${{ matrix.node-version }}
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: |
 | 
			
		||||
@@ -50,35 +52,20 @@ jobs:
 | 
			
		||||
              exit 1
 | 
			
		||||
          fi
 | 
			
		||||
 | 
			
		||||
      - name: Verify `./src/config.type.ts` is in sync with `./src/schemas/config.schema.yaml`
 | 
			
		||||
        shell: bash
 | 
			
		||||
        run: |
 | 
			
		||||
          if ! pnpm run --filter mermaid types:verify-config; then
 | 
			
		||||
            ERROR_MESSAGE='Running `pnpm run --filter mermaid types:verify-config` failed.'
 | 
			
		||||
            ERROR_MESSAGE+=' This should be fixed by running'
 | 
			
		||||
            ERROR_MESSAGE+=' `pnpm run --filter mermaid types:build-config`'
 | 
			
		||||
            ERROR_MESSAGE+=' on your local machine.'
 | 
			
		||||
            echo "::error title=Lint failure::${ERROR_MESSAGE}"
 | 
			
		||||
            # make sure to return an error exitcode so that GitHub actions shows a red-cross
 | 
			
		||||
            exit 1
 | 
			
		||||
          fi
 | 
			
		||||
 | 
			
		||||
      - name: Verify no circular dependencies
 | 
			
		||||
        working-directory: ./packages/mermaid
 | 
			
		||||
        shell: bash
 | 
			
		||||
        run: |
 | 
			
		||||
          if ! pnpm run --filter mermaid checkCircle; then
 | 
			
		||||
            ERROR_MESSAGE='Circular dependency detected.'
 | 
			
		||||
            ERROR_MESSAGE+=' This should be fixed by removing the circular dependency.'
 | 
			
		||||
            ERROR_MESSAGE+=' Run `pnpm run --filter mermaid checkCircle` on your local machine'
 | 
			
		||||
            ERROR_MESSAGE+=' to see the circular dependency.'
 | 
			
		||||
            echo "::error title=Lint failure::${ERROR_MESSAGE}"
 | 
			
		||||
            # make sure to return an error exitcode so that GitHub actions shows a red-cross
 | 
			
		||||
            exit 1
 | 
			
		||||
          fi
 | 
			
		||||
 | 
			
		||||
      - name: Verify Docs
 | 
			
		||||
        id: verifyDocs
 | 
			
		||||
        working-directory: ./packages/mermaid
 | 
			
		||||
        continue-on-error: ${{ github.event_name == 'push' }}
 | 
			
		||||
        run: pnpm run docs:verify
 | 
			
		||||
 | 
			
		||||
      - name: Rebuild Docs
 | 
			
		||||
        if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }}
 | 
			
		||||
        working-directory: ./packages/mermaid
 | 
			
		||||
        run: pnpm run docs:build
 | 
			
		||||
 | 
			
		||||
      - name: Commit changes
 | 
			
		||||
        uses: EndBug/add-and-commit@v9
 | 
			
		||||
        if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }}
 | 
			
		||||
        with:
 | 
			
		||||
          message: 'Update docs'
 | 
			
		||||
          add: 'docs/*'
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										19
									
								
								.github/workflows/pr-labeler-config-validator.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								.github/workflows/pr-labeler-config-validator.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,19 @@
 | 
			
		||||
name: Validate PR Labeler Configuration
 | 
			
		||||
on:
 | 
			
		||||
  push: {}
 | 
			
		||||
  pull_request:
 | 
			
		||||
    types:
 | 
			
		||||
      - opened
 | 
			
		||||
      - synchronize
 | 
			
		||||
      - ready_for_review
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  pr-labeler:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout Repository
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
      - name: Validate Configuration
 | 
			
		||||
        uses: Yash-Singh1/pr-labeler-config-validator@releases/v0.0.3
 | 
			
		||||
        with:
 | 
			
		||||
          configuration-path: .github/pr-labeler.yml
 | 
			
		||||
							
								
								
									
										22
									
								
								.github/workflows/pr-labeler.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										22
									
								
								.github/workflows/pr-labeler.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,31 +1,13 @@
 | 
			
		||||
name: Apply labels to PR
 | 
			
		||||
on:
 | 
			
		||||
  pull_request_target:
 | 
			
		||||
    # required for pr-labeler to support PRs from forks
 | 
			
		||||
    # ===================== ⛔ ☢️ 🚫 ⚠️ Warning ⚠️ 🚫 ☢️ ⛔ =======================
 | 
			
		||||
    # Be very careful what you put in this GitHub Action workflow file to avoid
 | 
			
		||||
    # malicious PRs from getting access to the Mermaid-js repo.
 | 
			
		||||
    #
 | 
			
		||||
    # Please read the following first before reviewing/merging:
 | 
			
		||||
    # - https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
 | 
			
		||||
    # - https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
 | 
			
		||||
    types: [opened, reopened, synchronize]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
    types: [opened]
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  pr-labeler:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    permissions:
 | 
			
		||||
      contents: read # read permission is required to read config file
 | 
			
		||||
      pull-requests: write # write permission is required to label PRs
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Label PR
 | 
			
		||||
        uses: release-drafter/release-drafter@v6
 | 
			
		||||
        with:
 | 
			
		||||
          config-name: pr-labeler.yml
 | 
			
		||||
          disable-autolabeler: false
 | 
			
		||||
          disable-releaser: true
 | 
			
		||||
        uses: TimonVS/pr-labeler-action@v4
 | 
			
		||||
        env:
 | 
			
		||||
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										20
									
								
								.github/workflows/publish-docs.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										20
									
								
								.github/workflows/publish-docs.yml
									
									
									
									
										vendored
									
									
								
							@@ -19,41 +19,41 @@ concurrency:
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  # Build job
 | 
			
		||||
  build-docs:
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout
 | 
			
		||||
        uses: actions/checkout@v4
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: 18
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: pnpm install --frozen-lockfile
 | 
			
		||||
 | 
			
		||||
      - name: Setup Pages
 | 
			
		||||
        uses: actions/configure-pages@v4
 | 
			
		||||
        uses: actions/configure-pages@v3
 | 
			
		||||
 | 
			
		||||
      - name: Run Build
 | 
			
		||||
        run: pnpm --filter mermaid run docs:build:vitepress
 | 
			
		||||
 | 
			
		||||
      - name: Upload artifact
 | 
			
		||||
        uses: actions/upload-pages-artifact@v3
 | 
			
		||||
        uses: actions/upload-pages-artifact@v1
 | 
			
		||||
        with:
 | 
			
		||||
          path: packages/mermaid/src/vitepress/.vitepress/dist
 | 
			
		||||
 | 
			
		||||
  # Deployment job
 | 
			
		||||
  deploy-docs:
 | 
			
		||||
  deploy:
 | 
			
		||||
    environment:
 | 
			
		||||
      name: github-pages
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    needs: build-docs
 | 
			
		||||
    needs: build
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Deploy to GitHub Pages
 | 
			
		||||
        id: deployment
 | 
			
		||||
        uses: actions/deploy-pages@v4
 | 
			
		||||
        uses: actions/deploy-pages@v2
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										15
									
								
								.github/workflows/release-draft.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								.github/workflows/release-draft.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@@ -0,0 +1,15 @@
 | 
			
		||||
name: Draft Release
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches:
 | 
			
		||||
      - develop
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  draft-release:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Draft Release
 | 
			
		||||
        uses: toolmantim/release-drafter@v5
 | 
			
		||||
        env:
 | 
			
		||||
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
							
								
								
									
										10
									
								
								.github/workflows/release-preview-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.github/workflows/release-preview-publish.yml
									
									
									
									
										vendored
									
									
								
							@@ -6,20 +6,20 @@ on:
 | 
			
		||||
      - 'release/**'
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  publish-preview:
 | 
			
		||||
  publish:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
        with:
 | 
			
		||||
          fetch-depth: 0
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: 18.x
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: |
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										10
									
								
								.github/workflows/release-publish.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.github/workflows/release-publish.yml
									
									
									
									
										vendored
									
									
								
							@@ -8,17 +8,17 @@ jobs:
 | 
			
		||||
  publish:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
      - uses: fregante/setup-git-user@v2
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
      - name: Setup Node.js v18
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: 18.x
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: |
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										37
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										37
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,37 +0,0 @@
 | 
			
		||||
name: Release
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches:
 | 
			
		||||
      - master
 | 
			
		||||
 | 
			
		||||
concurrency: ${{ github.workflow }}-${{ github.ref }}
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  release:
 | 
			
		||||
    name: Release
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - name: Checkout Repo
 | 
			
		||||
        uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: pnpm install --frozen-lockfile
 | 
			
		||||
 | 
			
		||||
      - name: Create Release Pull Request or Publish to npm
 | 
			
		||||
        id: changesets
 | 
			
		||||
        uses: changesets/action@v1
 | 
			
		||||
        with:
 | 
			
		||||
          version: pnpm changeset:version
 | 
			
		||||
          publish: pnpm changeset:publish
 | 
			
		||||
        env:
 | 
			
		||||
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 | 
			
		||||
							
								
								
									
										30
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										30
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,24 +1,27 @@
 | 
			
		||||
name: Unit Tests
 | 
			
		||||
 | 
			
		||||
on: [push, pull_request, merge_group]
 | 
			
		||||
on: [push, pull_request]
 | 
			
		||||
 | 
			
		||||
permissions:
 | 
			
		||||
  contents: read
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  unit-test:
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    strategy:
 | 
			
		||||
      matrix:
 | 
			
		||||
        node-version: [18.x]
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v2
 | 
			
		||||
        # uses version from "packageManager" field in package.json
 | 
			
		||||
 | 
			
		||||
      - name: Setup Node.js
 | 
			
		||||
        uses: actions/setup-node@v4
 | 
			
		||||
      - name: Setup Node.js ${{ matrix.node-version }}
 | 
			
		||||
        uses: actions/setup-node@v3
 | 
			
		||||
        with:
 | 
			
		||||
          cache: pnpm
 | 
			
		||||
          node-version-file: '.node-version'
 | 
			
		||||
          node-version: ${{ matrix.node-version }}
 | 
			
		||||
 | 
			
		||||
      - name: Install Packages
 | 
			
		||||
        run: |
 | 
			
		||||
@@ -39,13 +42,16 @@ jobs:
 | 
			
		||||
          pnpm exec vitest run ./packages/mermaid/src/diagrams/gantt/ganttDb.spec.ts --coverage
 | 
			
		||||
 | 
			
		||||
      - name: Upload Coverage to Codecov
 | 
			
		||||
        uses: codecov/codecov-action@v4
 | 
			
		||||
        # Run step only pushes to develop and pull_requests
 | 
			
		||||
        if: ${{ github.event_name == 'pull_request' || github.ref == 'refs/heads/develop' }}
 | 
			
		||||
        uses: codecov/codecov-action@v3
 | 
			
		||||
        with:
 | 
			
		||||
          files: ./coverage/vitest/lcov.info
 | 
			
		||||
          flags: unit
 | 
			
		||||
          name: mermaid-codecov
 | 
			
		||||
          fail_ci_if_error: false
 | 
			
		||||
          fail_ci_if_error: true
 | 
			
		||||
          verbose: true
 | 
			
		||||
          token: 6845cc80-77ee-4e17-85a1-026cd95e0766
 | 
			
		||||
      # Coveralls is throwing 500. Disabled for now.
 | 
			
		||||
      # - name: Upload Coverage to Coveralls
 | 
			
		||||
      #   uses: coverallsapp/github-action@v2
 | 
			
		||||
      #   with:
 | 
			
		||||
      #     github-token: ${{ secrets.GITHUB_TOKEN }}
 | 
			
		||||
      #     flag-name: unit
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										13
									
								
								.github/workflows/update-browserlist.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										13
									
								
								.github/workflows/update-browserlist.yml
									
									
									
									
										vendored
									
									
								
							@@ -5,21 +5,14 @@ on:
 | 
			
		||||
  workflow_dispatch:
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  update-browser-list:
 | 
			
		||||
  build:
 | 
			
		||||
    runs-on: ubuntu-latest
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: actions/checkout@v4
 | 
			
		||||
      - uses: pnpm/action-setup@v4
 | 
			
		||||
      - run: npx update-browserslist-db@latest
 | 
			
		||||
      - uses: actions/checkout@v3
 | 
			
		||||
      - run: npx browserslist@latest --update-db
 | 
			
		||||
      - name: Commit changes
 | 
			
		||||
        uses: EndBug/add-and-commit@v9
 | 
			
		||||
        with:
 | 
			
		||||
          author_name: ${{ github.actor }}
 | 
			
		||||
          author_email: ${{ github.actor }}@users.noreply.github.com
 | 
			
		||||
          message: 'chore: update browsers list'
 | 
			
		||||
          push: false
 | 
			
		||||
      - name: Create Pull Request
 | 
			
		||||
        uses: peter-evans/create-pull-request@v6
 | 
			
		||||
        with:
 | 
			
		||||
          branch: update-browserslist
 | 
			
		||||
          title: Update Browserslist
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										11
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										11
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@@ -35,7 +35,7 @@ cypress/snapshots/
 | 
			
		||||
.tsbuildinfo
 | 
			
		||||
tsconfig.tsbuildinfo
 | 
			
		||||
 | 
			
		||||
#knsv*.html
 | 
			
		||||
knsv*.html
 | 
			
		||||
local*.html
 | 
			
		||||
stats/
 | 
			
		||||
 | 
			
		||||
@@ -43,12 +43,3 @@ stats/
 | 
			
		||||
**/contributor-names.json
 | 
			
		||||
.pnpm-store
 | 
			
		||||
.nyc_output
 | 
			
		||||
 | 
			
		||||
demos/dev/**
 | 
			
		||||
!/demos/dev/example.html
 | 
			
		||||
!/demos/dev/reload.js
 | 
			
		||||
tsx-0/**
 | 
			
		||||
vite.config.ts.timestamp-*
 | 
			
		||||
 | 
			
		||||
# autogenereated by langium-cli
 | 
			
		||||
generated/
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								.husky/commit-msg
									
									
									
									
									
										Executable file
									
								
							
							
						
						
									
										4
									
								
								.husky/commit-msg
									
									
									
									
									
										Executable file
									
								
							@@ -0,0 +1,4 @@
 | 
			
		||||
#!/bin/sh
 | 
			
		||||
# . "$(dirname "$0")/_/husky.sh"
 | 
			
		||||
 | 
			
		||||
# npx --no-install commitlint --edit $1
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
#!/bin/sh
 | 
			
		||||
. "$(dirname "$0")/_/husky.sh"
 | 
			
		||||
 | 
			
		||||
NODE_OPTIONS="--max_old_space_size=8192" pnpm run pre-commit
 | 
			
		||||
pnpm run pre-commit
 | 
			
		||||
 
 | 
			
		||||
@@ -6,6 +6,6 @@ export default {
 | 
			
		||||
    // https://prettier.io/docs/en/cli.html#--cache
 | 
			
		||||
    'prettier --write',
 | 
			
		||||
  ],
 | 
			
		||||
  '.cspell/*.txt': ['tsx scripts/fixCSpell.ts'],
 | 
			
		||||
  'cSpell.json': ['ts-node-esm scripts/fixCSpell.ts'],
 | 
			
		||||
  '**/*.jison': ['pnpm -w run lint:jison'],
 | 
			
		||||
};
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										17
									
								
								.lycheeignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								.lycheeignore
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,17 @@
 | 
			
		||||
# These links are ignored by our link checker https://github.com/lycheeverse/lychee
 | 
			
		||||
# The file allows you to list multiple regular expressions for exclusion (one pattern per line).
 | 
			
		||||
 | 
			
		||||
# Network error: Forbidden
 | 
			
		||||
https://codepen.io
 | 
			
		||||
 | 
			
		||||
# Timeout error, maybe Twitter has anti-bot defenses against GitHub's CI servers?
 | 
			
		||||
https://twitter.com/mermaidjs_
 | 
			
		||||
 | 
			
		||||
# Don't check files that are generated during the build via `pnpm docs:code`
 | 
			
		||||
packages/mermaid/src/docs/config/setup/*
 | 
			
		||||
 | 
			
		||||
# Ignore localhost
 | 
			
		||||
http://localhost:3333/
 | 
			
		||||
 | 
			
		||||
# Ignore slack invite
 | 
			
		||||
https://join.slack.com/
 | 
			
		||||
@@ -1 +0,0 @@
 | 
			
		||||
20.12.2
 | 
			
		||||
							
								
								
									
										2
									
								
								.npmrc
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								.npmrc
									
									
									
									
									
								
							@@ -1,4 +1,2 @@
 | 
			
		||||
registry=https://registry.npmjs.org
 | 
			
		||||
auto-install-peers=true
 | 
			
		||||
strict-peer-dependencies=false
 | 
			
		||||
package-import-method=clone-or-copy
 | 
			
		||||
 
 | 
			
		||||
@@ -1,20 +1,9 @@
 | 
			
		||||
dist
 | 
			
		||||
cypress/platform/xss3.html
 | 
			
		||||
.cache
 | 
			
		||||
.pnpm-store
 | 
			
		||||
coverage
 | 
			
		||||
# Autogenerated by PNPM
 | 
			
		||||
pnpm-lock.yaml
 | 
			
		||||
stats
 | 
			
		||||
**/.vitepress/components.d.ts
 | 
			
		||||
**/.vitepress/cache
 | 
			
		||||
packages/mermaid/src/docs/.vitepress/components.d.ts
 | 
			
		||||
.nyc_output
 | 
			
		||||
# Autogenerated by `pnpm run --filter mermaid types:build-config`
 | 
			
		||||
packages/mermaid/src/config.type.ts
 | 
			
		||||
# autogenereated by langium-cli
 | 
			
		||||
generated/
 | 
			
		||||
# Ignore the files creates in /demos/dev except for example.html
 | 
			
		||||
demos/dev/**
 | 
			
		||||
!/demos/dev/example.html
 | 
			
		||||
# TODO: Lots of errors to fix
 | 
			
		||||
cypress/platform/state-refactor.html
 | 
			
		||||
 
 | 
			
		||||
@@ -3,6 +3,5 @@
 | 
			
		||||
  "printWidth": 100,
 | 
			
		||||
  "singleQuote": true,
 | 
			
		||||
  "useTabs": false,
 | 
			
		||||
  "tabWidth": 2,
 | 
			
		||||
  "trailingComma": "es5"
 | 
			
		||||
  "tabWidth": 2
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,15 +1,12 @@
 | 
			
		||||
import type { InlineConfig } from 'vite';
 | 
			
		||||
import { build, type PluginOption } from 'vite';
 | 
			
		||||
import { build, InlineConfig, type PluginOption } from 'vite';
 | 
			
		||||
import { resolve } from 'path';
 | 
			
		||||
import { fileURLToPath } from 'url';
 | 
			
		||||
import jisonPlugin from './jisonPlugin.js';
 | 
			
		||||
import jsonSchemaPlugin from './jsonSchemaPlugin.js';
 | 
			
		||||
import { readFileSync } from 'fs';
 | 
			
		||||
import typescript from '@rollup/plugin-typescript';
 | 
			
		||||
import { visualizer } from 'rollup-plugin-visualizer';
 | 
			
		||||
import type { TemplateType } from 'rollup-plugin-visualizer/dist/plugin/template-types.js';
 | 
			
		||||
import istanbul from 'vite-plugin-istanbul';
 | 
			
		||||
import { packageOptions } from '../.build/common.js';
 | 
			
		||||
import { generateLangium } from '../.build/generateLangium.js';
 | 
			
		||||
 | 
			
		||||
const visualize = process.argv.includes('--visualize');
 | 
			
		||||
const watch = process.argv.includes('--watch');
 | 
			
		||||
@@ -38,6 +35,24 @@ const visualizerOptions = (packageName: string, core = false): PluginOption[] =>
 | 
			
		||||
  );
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const packageOptions = {
 | 
			
		||||
  mermaid: {
 | 
			
		||||
    name: 'mermaid',
 | 
			
		||||
    packageName: 'mermaid',
 | 
			
		||||
    file: 'mermaid.ts',
 | 
			
		||||
  },
 | 
			
		||||
  'mermaid-example-diagram': {
 | 
			
		||||
    name: 'mermaid-example-diagram',
 | 
			
		||||
    packageName: 'mermaid-example-diagram',
 | 
			
		||||
    file: 'detector.ts',
 | 
			
		||||
  },
 | 
			
		||||
  'mermaid-zenuml': {
 | 
			
		||||
    name: 'mermaid-zenuml',
 | 
			
		||||
    packageName: 'mermaid-zenuml',
 | 
			
		||||
    file: 'detector.ts',
 | 
			
		||||
  },
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
interface BuildOptions {
 | 
			
		||||
  minify: boolean | 'esbuild';
 | 
			
		||||
  core?: boolean;
 | 
			
		||||
@@ -47,18 +62,43 @@ interface BuildOptions {
 | 
			
		||||
 | 
			
		||||
export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions): InlineConfig => {
 | 
			
		||||
  const external: (string | RegExp)[] = ['require', 'fs', 'path'];
 | 
			
		||||
  // eslint-disable-next-line no-console
 | 
			
		||||
  console.log(entryName, packageOptions[entryName]);
 | 
			
		||||
  const { name, file, packageName } = packageOptions[entryName];
 | 
			
		||||
  const output: OutputOptions = [
 | 
			
		||||
  let output: OutputOptions = [
 | 
			
		||||
    {
 | 
			
		||||
      name,
 | 
			
		||||
      format: 'esm',
 | 
			
		||||
      sourcemap,
 | 
			
		||||
      entryFileNames: `${name}.esm${minify ? '.min' : ''}.mjs`,
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      name,
 | 
			
		||||
      format: 'umd',
 | 
			
		||||
      sourcemap,
 | 
			
		||||
      entryFileNames: `${name}${minify ? '.min' : ''}.js`,
 | 
			
		||||
    },
 | 
			
		||||
  ];
 | 
			
		||||
 | 
			
		||||
  if (core) {
 | 
			
		||||
    const { dependencies } = JSON.parse(
 | 
			
		||||
      readFileSync(resolve(__dirname, `../packages/${packageName}/package.json`), 'utf-8')
 | 
			
		||||
    );
 | 
			
		||||
    // Core build is used to generate file without bundled dependencies.
 | 
			
		||||
    // This is used by downstream projects to bundle dependencies themselves.
 | 
			
		||||
    // Ignore dependencies and any dependencies of dependencies
 | 
			
		||||
    // Adapted from the RegEx used by `rollup-plugin-node`
 | 
			
		||||
    external.push(new RegExp('^(?:' + Object.keys(dependencies).join('|') + ')(?:/.+)?$'));
 | 
			
		||||
    // This needs to be an array. Otherwise vite will build esm & umd with same name and overwrite esm with umd.
 | 
			
		||||
    output = [
 | 
			
		||||
      {
 | 
			
		||||
        name,
 | 
			
		||||
        format: 'esm',
 | 
			
		||||
        sourcemap,
 | 
			
		||||
        entryFileNames: `${name}.core.mjs`,
 | 
			
		||||
      },
 | 
			
		||||
    ];
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  const config: InlineConfig = {
 | 
			
		||||
    configFile: false,
 | 
			
		||||
    build: {
 | 
			
		||||
@@ -76,18 +116,15 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
 | 
			
		||||
        output,
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
    define: {
 | 
			
		||||
      'import.meta.vitest': 'undefined',
 | 
			
		||||
    },
 | 
			
		||||
    resolve: {
 | 
			
		||||
      extensions: [],
 | 
			
		||||
    },
 | 
			
		||||
    plugins: [
 | 
			
		||||
      jisonPlugin(),
 | 
			
		||||
      jsonSchemaPlugin(), // handles `.schema.yaml` files
 | 
			
		||||
      // @ts-expect-error According to the type definitions, rollup plugins are incompatible with vite
 | 
			
		||||
      typescript({ compilerOptions: { declaration: false } }),
 | 
			
		||||
      istanbul({
 | 
			
		||||
        exclude: ['node_modules', 'test/', '__mocks__', 'generated'],
 | 
			
		||||
        exclude: ['node_modules', 'test/', '__mocks__'],
 | 
			
		||||
        extension: ['.js', '.ts'],
 | 
			
		||||
        requireEnv: true,
 | 
			
		||||
        forceBuildInstrument: coverage,
 | 
			
		||||
@@ -107,28 +144,24 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
 | 
			
		||||
 | 
			
		||||
const buildPackage = async (entryName: keyof typeof packageOptions) => {
 | 
			
		||||
  await build(getBuildConfig({ minify: false, entryName }));
 | 
			
		||||
  await build(getBuildConfig({ minify: 'esbuild', entryName }));
 | 
			
		||||
  await build(getBuildConfig({ minify: false, core: true, entryName }));
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const main = async () => {
 | 
			
		||||
  const packageNames = Object.keys(packageOptions) as (keyof typeof packageOptions)[];
 | 
			
		||||
  for (const pkg of packageNames.filter(
 | 
			
		||||
    (pkg) => !mermaidOnly || pkg === 'mermaid' || pkg === 'parser'
 | 
			
		||||
  )) {
 | 
			
		||||
  for (const pkg of packageNames.filter((pkg) => !mermaidOnly || pkg === 'mermaid')) {
 | 
			
		||||
    await buildPackage(pkg);
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
await generateLangium();
 | 
			
		||||
 | 
			
		||||
if (watch) {
 | 
			
		||||
  await build(getBuildConfig({ minify: false, watch, core: false, entryName: 'parser' }));
 | 
			
		||||
  void build(getBuildConfig({ minify: false, watch, core: false, entryName: 'mermaid' }));
 | 
			
		||||
  build(getBuildConfig({ minify: false, watch, core: false, entryName: 'mermaid' }));
 | 
			
		||||
  if (!mermaidOnly) {
 | 
			
		||||
    void build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-example-diagram' }));
 | 
			
		||||
    void build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-zenuml' }));
 | 
			
		||||
    build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-example-diagram' }));
 | 
			
		||||
    build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-zenuml' }));
 | 
			
		||||
  }
 | 
			
		||||
} else if (visualize) {
 | 
			
		||||
  await build(getBuildConfig({ minify: false, watch, core: false, entryName: 'parser' }));
 | 
			
		||||
  await build(getBuildConfig({ minify: false, core: true, entryName: 'mermaid' }));
 | 
			
		||||
  await build(getBuildConfig({ minify: false, core: false, entryName: 'mermaid' }));
 | 
			
		||||
} else {
 | 
			
		||||
 
 | 
			
		||||
@@ -1,10 +1,10 @@
 | 
			
		||||
import { transformJison } from '../.build/jisonTransformer.js';
 | 
			
		||||
 | 
			
		||||
import { transformJison } from './jisonTransformer.js';
 | 
			
		||||
const fileRegex = /\.(jison)$/;
 | 
			
		||||
 | 
			
		||||
export default function jison() {
 | 
			
		||||
  return {
 | 
			
		||||
    name: 'jison',
 | 
			
		||||
 | 
			
		||||
    transform(src: string, id: string) {
 | 
			
		||||
      if (fileRegex.test(id)) {
 | 
			
		||||
        return {
 | 
			
		||||
 
 | 
			
		||||
@@ -1,7 +1,6 @@
 | 
			
		||||
import jison from 'jison';
 | 
			
		||||
 | 
			
		||||
export const transformJison = (src: string): string => {
 | 
			
		||||
  // @ts-ignore - Jison is not typed properly
 | 
			
		||||
  const parser = new jison.Generator(src, {
 | 
			
		||||
    moduleType: 'js',
 | 
			
		||||
    'token-stack': true,
 | 
			
		||||
@@ -1,28 +0,0 @@
 | 
			
		||||
import type { PluginOption } from 'vite';
 | 
			
		||||
import { getDefaults, getSchema, loadSchema } from '../.build/jsonSchema.js';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Vite plugin that handles JSON Schemas saved as a `.schema.yaml` file.
 | 
			
		||||
 *
 | 
			
		||||
 * Use `my-example.schema.yaml?only-defaults=true` to only load the default values.
 | 
			
		||||
 */
 | 
			
		||||
export default function jsonSchemaPlugin(): PluginOption {
 | 
			
		||||
  return {
 | 
			
		||||
    name: 'json-schema-plugin',
 | 
			
		||||
    transform(src: string, id: string) {
 | 
			
		||||
      const idAsUrl = new URL(id, 'file:///');
 | 
			
		||||
 | 
			
		||||
      if (!idAsUrl.pathname.endsWith('schema.yaml')) {
 | 
			
		||||
        return;
 | 
			
		||||
      }
 | 
			
		||||
 | 
			
		||||
      const jsonSchema = loadSchema(src, idAsUrl.pathname);
 | 
			
		||||
      return {
 | 
			
		||||
        code: idAsUrl.searchParams.get('only-defaults')
 | 
			
		||||
          ? getDefaults(jsonSchema)
 | 
			
		||||
          : getSchema(jsonSchema),
 | 
			
		||||
        map: null, // no source map
 | 
			
		||||
      };
 | 
			
		||||
    },
 | 
			
		||||
  };
 | 
			
		||||
}
 | 
			
		||||
@@ -1,7 +1,6 @@
 | 
			
		||||
import express from 'express';
 | 
			
		||||
import cors from 'cors';
 | 
			
		||||
import { createServer as createViteServer } from 'vite';
 | 
			
		||||
import { packageOptions } from '../.build/common.js';
 | 
			
		||||
 | 
			
		||||
async function createServer() {
 | 
			
		||||
  const app = express();
 | 
			
		||||
@@ -15,17 +14,16 @@ async function createServer() {
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  app.use(cors());
 | 
			
		||||
  for (const { packageName } of Object.values(packageOptions)) {
 | 
			
		||||
    app.use(express.static(`./packages/${packageName}/dist`));
 | 
			
		||||
  }
 | 
			
		||||
  app.use(express.static('./packages/mermaid/dist'));
 | 
			
		||||
  app.use(express.static('./packages/mermaid-zenuml/dist'));
 | 
			
		||||
  app.use(express.static('./packages/mermaid-example-diagram/dist'));
 | 
			
		||||
  app.use(vite.middlewares);
 | 
			
		||||
  app.use(express.static('demos'));
 | 
			
		||||
  app.use(express.static('cypress/platform'));
 | 
			
		||||
 | 
			
		||||
  app.listen(9000, () => {
 | 
			
		||||
    // eslint-disable-next-line no-console
 | 
			
		||||
    console.log(`Listening on http://localhost:9000`);
 | 
			
		||||
  });
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void createServer();
 | 
			
		||||
createServer();
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							@@ -2,7 +2,7 @@
 | 
			
		||||
  "recommendations": [
 | 
			
		||||
    "dbaeumer.vscode-eslint",
 | 
			
		||||
    "esbenp.prettier-vscode",
 | 
			
		||||
    "vitest.explorer",
 | 
			
		||||
    "zixuanchen.vitest-explorer",
 | 
			
		||||
    "luniclynx.bison"
 | 
			
		||||
  ]
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										5
									
								
								.vscode/launch.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								.vscode/launch.json
									
									
									
									
										vendored
									
									
								
							@@ -17,9 +17,8 @@
 | 
			
		||||
      "name": "Docs generation",
 | 
			
		||||
      "type": "node",
 | 
			
		||||
      "request": "launch",
 | 
			
		||||
      "args": ["scripts/docs.cli.mts"],
 | 
			
		||||
      // we'll need to change this to --import in Node.JS v20.6.0 and up
 | 
			
		||||
      "runtimeArgs": ["--loader", "tsx/esm"],
 | 
			
		||||
      "args": ["src/docs.mts"],
 | 
			
		||||
      "runtimeArgs": ["--loader", "ts-node/esm"],
 | 
			
		||||
      "cwd": "${workspaceRoot}/packages/mermaid",
 | 
			
		||||
      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
 | 
			
		||||
      "smartStep": true,
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										14
									
								
								CHANGELOG.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								CHANGELOG.md
									
									
									
									
									
								
							@@ -68,7 +68,7 @@ try {
 | 
			
		||||
 | 
			
		||||
### Init deprecated and InitThrowsErrors removed
 | 
			
		||||
 | 
			
		||||
The config passed to `init` was not being used earlier.
 | 
			
		||||
The config passed to `init` was not being used eariler.
 | 
			
		||||
It will now be used.
 | 
			
		||||
The `init` function is deprecated and will be removed in the next major release.
 | 
			
		||||
init currently works as a wrapper to `initialize` and `run`.
 | 
			
		||||
@@ -195,7 +195,7 @@ mermaid.run({
 | 
			
		||||
- "Cannot activate" in sequenceDiagram [\#647](https://github.com/knsv/mermaid/issues/647)
 | 
			
		||||
- Link \("click" statement\) in flowchart does not work in exported SVG [\#646](https://github.com/knsv/mermaid/issues/646)
 | 
			
		||||
- How to pass styling [\#639](https://github.com/knsv/mermaid/issues/639)
 | 
			
		||||
- The live editor can't show seq diagram with notes for 8.0.0-alpha.3 [\#638](https://github.com/knsv/mermaid/issues/638)
 | 
			
		||||
- The live editor cant show seq diagram with notes for 8.0.0-alpha.3 [\#638](https://github.com/knsv/mermaid/issues/638)
 | 
			
		||||
- import mermaid.css with ES6 + NPM [\#634](https://github.com/knsv/mermaid/issues/634)
 | 
			
		||||
- Actor line cuts through other elements [\#633](https://github.com/knsv/mermaid/issues/633)
 | 
			
		||||
- Graph TD line out of the picture \(left side\) [\#630](https://github.com/knsv/mermaid/issues/630)
 | 
			
		||||
@@ -504,7 +504,7 @@ mermaid.run({
 | 
			
		||||
 | 
			
		||||
- Docs css: code hard to read [\#324](https://github.com/knsv/mermaid/issues/324)
 | 
			
		||||
- About Markpad integration [\#323](https://github.com/knsv/mermaid/issues/323)
 | 
			
		||||
- How to link backwards in flowchat? [\#321](https://github.com/knsv/mermaid/issues/321)
 | 
			
		||||
- How to link backwords in flowchat? [\#321](https://github.com/knsv/mermaid/issues/321)
 | 
			
		||||
- Help with editor [\#310](https://github.com/knsv/mermaid/issues/310)
 | 
			
		||||
- +1 [\#293](https://github.com/knsv/mermaid/issues/293)
 | 
			
		||||
- Basic chart does not render on Chome, but does in Firefox [\#290](https://github.com/knsv/mermaid/issues/290)
 | 
			
		||||
@@ -619,7 +619,7 @@ mermaid.run({
 | 
			
		||||
- render to png from the cli does not display the marker-end arrow heads [\#181](https://github.com/knsv/mermaid/issues/181)
 | 
			
		||||
- Links in sequence diagrams [\#159](https://github.com/knsv/mermaid/issues/159)
 | 
			
		||||
- comment characters `%%` cause parse error [\#141](https://github.com/knsv/mermaid/issues/141)
 | 
			
		||||
- Add a reversed asymmetric shape [\#124](https://github.com/knsv/mermaid/issues/124)
 | 
			
		||||
- Add a reversed assymetric shape [\#124](https://github.com/knsv/mermaid/issues/124)
 | 
			
		||||
- Add syntax for double headed arrows [\#123](https://github.com/knsv/mermaid/issues/123)
 | 
			
		||||
- Support for font-awesome [\#49](https://github.com/knsv/mermaid/issues/49)
 | 
			
		||||
 | 
			
		||||
@@ -659,7 +659,7 @@ mermaid.run({
 | 
			
		||||
- Auto linewrap for notes in sequence diagrams [\#178](https://github.com/knsv/mermaid/issues/178)
 | 
			
		||||
- Execute code after initialize [\#176](https://github.com/knsv/mermaid/issues/176)
 | 
			
		||||
- Autoscaling for all diagram types [\#175](https://github.com/knsv/mermaid/issues/175)
 | 
			
		||||
- Problem with click event callback [\#174](https://github.com/knsv/mermaid/issues/174)
 | 
			
		||||
- Problem wit click event callback [\#174](https://github.com/knsv/mermaid/issues/174)
 | 
			
		||||
- How to escape characters? [\#170](https://github.com/knsv/mermaid/issues/170)
 | 
			
		||||
- it can not work [\#167](https://github.com/knsv/mermaid/issues/167)
 | 
			
		||||
- UML Class diagram [\#154](https://github.com/knsv/mermaid/issues/154)
 | 
			
		||||
@@ -762,7 +762,7 @@ mermaid.run({
 | 
			
		||||
- subgraph background is black in rendered flowchart PNG via CLI [\#121](https://github.com/knsv/mermaid/issues/121)
 | 
			
		||||
- Integrate editor at https://github.com/naseer/mermaid-webapp [\#110](https://github.com/knsv/mermaid/issues/110)
 | 
			
		||||
- Internet Explorer Support [\#99](https://github.com/knsv/mermaid/issues/99)
 | 
			
		||||
- Asymmetric shapes not documented [\#82](https://github.com/knsv/mermaid/issues/82)
 | 
			
		||||
- Assymetric shapes not documented [\#82](https://github.com/knsv/mermaid/issues/82)
 | 
			
		||||
- NoModificationAllowedError [\#23](https://github.com/knsv/mermaid/issues/23)
 | 
			
		||||
- Improve arrows [\#3](https://github.com/knsv/mermaid/issues/3)
 | 
			
		||||
 | 
			
		||||
@@ -908,7 +908,7 @@ mermaid.run({
 | 
			
		||||
 | 
			
		||||
- Question marks don't render properly with /dist/mermaid.full.min.js [\#30](https://github.com/knsv/mermaid/issues/30)
 | 
			
		||||
- Error with some characters [\#25](https://github.com/knsv/mermaid/issues/25)
 | 
			
		||||
- Provide parse function in browser without `require`? [\#21](https://github.com/knsv/mermaid/issues/21)
 | 
			
		||||
- Provide parse function in browser widthout `require`? [\#21](https://github.com/knsv/mermaid/issues/21)
 | 
			
		||||
- Better label text support [\#18](https://github.com/knsv/mermaid/issues/18)
 | 
			
		||||
- Cap-cased words break parser [\#8](https://github.com/knsv/mermaid/issues/8)
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -59,8 +59,8 @@ representative at an online or offline event.
 | 
			
		||||
## Enforcement
 | 
			
		||||
 | 
			
		||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
 | 
			
		||||
reported to the community leaders responsible for enforcement at <security@mermaid.live>.
 | 
			
		||||
 | 
			
		||||
reported to the community leaders responsible for enforcement at security@mermaid.live
 | 
			
		||||
.
 | 
			
		||||
All complaints will be reviewed and investigated promptly and fairly.
 | 
			
		||||
 | 
			
		||||
All community leaders are obligated to respect the privacy and security of the
 | 
			
		||||
 
 | 
			
		||||
@@ -1 +0,0 @@
 | 
			
		||||
./packages/mermaid/src/docs/community/contributing.md
 | 
			
		||||
							
								
								
									
										71
									
								
								CONTRIBUTING.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										71
									
								
								CONTRIBUTING.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,71 @@
 | 
			
		||||
# Contributing
 | 
			
		||||
 | 
			
		||||
Please read in detail about how to contribute documentation and code on the [Mermaid documentation site.](https://mermaid-js.github.io/mermaid/#/development)
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
# Mermaid contribution cheat-sheet
 | 
			
		||||
 | 
			
		||||
## Requirements
 | 
			
		||||
 | 
			
		||||
- [volta](https://volta.sh/) to manage node versions.
 | 
			
		||||
- [Node.js](https://nodejs.org/en/). `volta install node`
 | 
			
		||||
- [pnpm](https://pnpm.io/) package manager. `volta install pnpm`
 | 
			
		||||
 | 
			
		||||
## Development Installation
 | 
			
		||||
 | 
			
		||||
If you don't have direct access to push to mermaid repositories, make a fork first. Then clone. Or clone directly from mermaid-js:
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
git clone git@github.com:mermaid-js/mermaid.git
 | 
			
		||||
cd mermaid
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Install required packages:
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
# npx is required for first install as volta support for pnpm is not added yet.
 | 
			
		||||
npx pnpm install
 | 
			
		||||
pnpm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Docker
 | 
			
		||||
 | 
			
		||||
If you are using docker and docker-compose, you have self-documented `run` bash script, which is a convenient alias for docker-compose commands:
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
./run install # npx pnpm install
 | 
			
		||||
./run test # pnpm test
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Testing
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
# Run unit test
 | 
			
		||||
pnpm test
 | 
			
		||||
# Run unit test in watch mode
 | 
			
		||||
pnpm test:watch
 | 
			
		||||
# Run E2E test
 | 
			
		||||
pnpm e2e
 | 
			
		||||
# Debug E2E tests
 | 
			
		||||
pnpm dev
 | 
			
		||||
pnpm cypress:open # in another terminal
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Branch name format:
 | 
			
		||||
 | 
			
		||||
```text
 | 
			
		||||
   [feature | bug | chore | docs]/[issue number]_[short description using dashes ('-') or underscores ('_') instead of spaces]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
eg: `feature/2945_state-diagram-new-arrow-florbs`, `bug/1123_fix_random_ugly_red_text`
 | 
			
		||||
 | 
			
		||||
## Documentation
 | 
			
		||||
 | 
			
		||||
Documentation is necessary for all non bugfix/refactoring changes.
 | 
			
		||||
 | 
			
		||||
Only make changes to files are in [`/packages/mermaid/src/docs`](packages/mermaid/src/docs)
 | 
			
		||||
 | 
			
		||||
**_DO NOT CHANGE FILES IN `/docs`_**
 | 
			
		||||
 | 
			
		||||
[Join our slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
 | 
			
		||||
@@ -1,2 +0,0 @@
 | 
			
		||||
FROM node:20.12.2-alpine3.19 AS base
 | 
			
		||||
RUN wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.shrc" SHELL="$(which sh)" sh -
 | 
			
		||||
@@ -1,7 +0,0 @@
 | 
			
		||||
{
 | 
			
		||||
  "drips": {
 | 
			
		||||
    "ethereum": {
 | 
			
		||||
      "ownedBy": "0x0831DDFe60d009d9448CC976157b539089aB821E"
 | 
			
		||||
    }
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										78
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										78
									
								
								README.md
									
									
									
									
									
								
							@@ -15,14 +15,11 @@ Generate diagrams from markdown-like text.
 | 
			
		||||
<a href="https://mermaid.live/"><b>Live Editor!</b></a>
 | 
			
		||||
</p>
 | 
			
		||||
<p align="center">
 | 
			
		||||
 <a href="https://mermaid.js.org">📖 Documentation</a> | <a href="https://mermaid.js.org/intro/">🚀 Getting Started</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://discord.gg/AgrbSrBer3" title="Discord invite">🙌 Join Us</a>
 | 
			
		||||
 <a href="https://mermaid.js.org">📖 Documentation</a> | <a href="https://mermaid.js.org/intro/">🚀 Getting Started</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE" title="Slack invite">🙌 Join Us</a>
 | 
			
		||||
</p>
 | 
			
		||||
<p align="center">
 | 
			
		||||
<a href="./README.zh-CN.md">简体中文</a>
 | 
			
		||||
</p>
 | 
			
		||||
<p align="center">
 | 
			
		||||
Try Live Editor previews of future releases: <a href="https://develop.git.mermaid.live/" title="Try the mermaid version from the develop branch.">Develop</a> | <a href="https://next.git.mermaid.live/" title="Try the mermaid version from the next branch.">Next</a>
 | 
			
		||||
</p>
 | 
			
		||||
 | 
			
		||||
<br>
 | 
			
		||||
<br>
 | 
			
		||||
@@ -33,9 +30,8 @@ Try Live Editor previews of future releases: <a href="https://develop.git.mermai
 | 
			
		||||
[](https://app.codecov.io/github/mermaid-js/mermaid/tree/develop)
 | 
			
		||||
[](https://www.jsdelivr.com/package/npm/mermaid)
 | 
			
		||||
[](https://www.npmjs.com/package/mermaid)
 | 
			
		||||
[](https://discord.gg/AgrbSrBer3)
 | 
			
		||||
[](https://twitter.com/mermaidjs_)
 | 
			
		||||
[](https://argos-ci.com)
 | 
			
		||||
[](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
 | 
			
		||||
[](https://twitter.com/mermaidjs_)
 | 
			
		||||
 | 
			
		||||
<img src="./img/header.png" alt="" />
 | 
			
		||||
 | 
			
		||||
@@ -43,23 +39,7 @@ Try Live Editor previews of future releases: <a href="https://develop.git.mermai
 | 
			
		||||
 | 
			
		||||
**Thanks to all involved, people committing pull requests, people answering questions! 🙏**
 | 
			
		||||
 | 
			
		||||
<a href="https://mermaid.js.org/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
 | 
			
		||||
 | 
			
		||||
## Table of content
 | 
			
		||||
 | 
			
		||||
<details>
 | 
			
		||||
<summary>Expand contents</summary>
 | 
			
		||||
 | 
			
		||||
- [About](#about)
 | 
			
		||||
- [Examples](#examples)
 | 
			
		||||
- [Release](#release)
 | 
			
		||||
- [Related projects](#related-projects)
 | 
			
		||||
- [Contributors](#contributors---)
 | 
			
		||||
- [Security and safe diagrams](#security-and-safe-diagrams)
 | 
			
		||||
- [Reporting vulnerabilities](#reporting-vulnerabilities)
 | 
			
		||||
- [Appreciation](#appreciation)
 | 
			
		||||
 | 
			
		||||
</details>
 | 
			
		||||
<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
 | 
			
		||||
 | 
			
		||||
## About
 | 
			
		||||
 | 
			
		||||
@@ -75,12 +55,12 @@ Mermaid addresses this problem by enabling users to create easily modifiable dia
 | 
			
		||||
<br/>
 | 
			
		||||
 | 
			
		||||
Mermaid allows even non-programmers to easily create detailed diagrams through the [Mermaid Live Editor](https://mermaid.live/).<br/>
 | 
			
		||||
For video tutorials, visit our [Tutorials](https://mermaid.js.org/ecosystem/tutorials.html) page.
 | 
			
		||||
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](https://mermaid.js.org/ecosystem/integrations-community.html).
 | 
			
		||||
[Tutorials](./docs/config/Tutorials.md) has video tutorials.
 | 
			
		||||
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/ecosystem/integrations.md).
 | 
			
		||||
 | 
			
		||||
You can also use Mermaid within [GitHub](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) as well many of your other favorite applications—check out the list of [Integrations and Usages of Mermaid](https://mermaid.js.org/ecosystem/integrations-community.html).
 | 
			
		||||
You can also use Mermaid within [GitHub](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) as well many of your other favorite applications—check out the list of [Integrations and Usages of Mermaid](./docs/ecosystem/integrations.md).
 | 
			
		||||
 | 
			
		||||
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](https://mermaid.js.org/intro/getting-started.html), [Usage](https://mermaid.js.org/config/usage.html) and [Tutorials](https://mermaid.js.org/ecosystem/tutorials.html).
 | 
			
		||||
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/community/n00b-overview.md), [Usage](./docs/config/usage.md) and [Tutorials](./docs/config/Tutorials.md).
 | 
			
		||||
 | 
			
		||||
In our release process we rely heavily on visual regression tests using [applitools](https://applitools.com/). Applitools is a great service which has been easy to use and integrate with our tests.
 | 
			
		||||
 | 
			
		||||
@@ -92,11 +72,11 @@ In our release process we rely heavily on visual regression tests using [applito
 | 
			
		||||
 | 
			
		||||
## Examples
 | 
			
		||||
 | 
			
		||||
**The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here to jump into the [text syntax](https://mermaid.js.org/intro/syntax-reference.html).**
 | 
			
		||||
**The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here to jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).**
 | 
			
		||||
 | 
			
		||||
<!-- <Flowchart> -->
 | 
			
		||||
 | 
			
		||||
### Flowchart [<a href="https://mermaid.js.org/syntax/flowchart.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNpNkMtqwzAQRX9FzKqFJK7t1km8KDQP6KJQSLOLvZhIY1tgS0GWmgbb_165IaFaiXvOFTPqgGtBkEJR6zOv0Fj2scsU8-ft8I5G5Gw6fe339GN7tnrYaafE45WvRsLW3Ya4bKVWwzVe_xU-FfVsc9hR62rLwvw_2591z7Y3FuUwgYZMg1L4ObrRzMBW1FAGqb8KKtCLGWRq8Ko7CbS0FdJqA2mBdUsTQGf110VxSK1xdJM2EkuDzd2qNQrypQ7s5TQuXcrW-ie5VoUsx9yZ2seVtac2DYIRz0ppK3eccd0ErRTjD1XfyyRIomSBUUzJPMaXOBb8GC4XRfQcFmL-FEYIwzD8AggvcHE">live editor</a>]
 | 
			
		||||
### Flowchart [<a href="https://mermaid-js.github.io/mermaid/#/flowchart">docs</a> - <a href="https://mermaid.live/edit#pako:eNpNkMtqwzAQRX9FzKqFJK7t1km8KDQP6KJQSLOLvZhIY1tgS0GWmgbb_165IaFaiXvOFTPqgGtBkEJR6zOv0Fj2scsU8-ft8I5G5Gw6fe339GN7tnrYaafE45WvRsLW3Ya4bKVWwzVe_xU-FfVsc9hR62rLwvw_2591z7Y3FuUwgYZMg1L4ObrRzMBW1FAGqb8KKtCLGWRq8Ko7CbS0FdJqA2mBdUsTQGf110VxSK1xdJM2EkuDzd2qNQrypQ7s5TQuXcrW-ie5VoUsx9yZ2seVtac2DYIRz0ppK3eccd0ErRTjD1XfyyRIomSBUUzJPMaXOBb8GC4XRfQcFmL-FEYIwzD8AggvcHE">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
flowchart LR
 | 
			
		||||
@@ -116,12 +96,12 @@ C -->|One| D[Result 1]
 | 
			
		||||
C -->|Two| E[Result 2]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Sequence diagram [<a href="https://mermaid.js.org/syntax/sequenceDiagram.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNo9kMluwjAQhl_F-AykQMuSA1WrbuLQQ3v1ZbAnsVXHkzrjVhHi3etQwKfRv4w-z0FqMihL2eF3wqDxyUEdoVHhwTuNk-12RzaU4g29JzHMY2HpV0BE0VO6V8ETtdkGz1Zb1F8qiPyG5LX84mrLAmpwoWNh-5a0pWCiAxUwGBXeiVHEU4oq8V_6AHYUwAu2lLLTjVQ4bc1rT2yleI0IfJG320faZ9ABbk-Jz3hZnFxBduR9L2oiM5Jj2WBswJn8-cMArSRbbFDJMo8GK0ielVThmKOpNcD4bBxTlGUFvsOxhMT02QctS44JL6HzAS-iJzCYOwfJfTscunYd542aQuXqQU_RZ9kyt11ZFIM9rR3btJ9qaorOGQuR7c9mWSznyzXMF7hcLeBusTB6P9usq_ntrDKrm9kc5PF4_AMJE56Z">live editor</a>]
 | 
			
		||||
### Sequence diagram [<a href="https://mermaid-js.github.io/mermaid/#/sequenceDiagram">docs</a> - <a href="https://mermaid.live/edit#pako:eNo9kMluwjAQhl_F-AykQMuSA1WrbuLQQ3v1ZbAnsVXHkzrjVhHi3etQwKfRv4w-z0FqMihL2eF3wqDxyUEdoVHhwTuNk-12RzaU4g29JzHMY2HpV0BE0VO6V8ETtdkGz1Zb1F8qiPyG5LX84mrLAmpwoWNh-5a0pWCiAxUwGBXeiVHEU4oq8V_6AHYUwAu2lLLTjVQ4bc1rT2yleI0IfJG320faZ9ABbk-Jz3hZnFxBduR9L2oiM5Jj2WBswJn8-cMArSRbbFDJMo8GK0ielVThmKOpNcD4bBxTlGUFvsOxhMT02QctS44JL6HzAS-iJzCYOwfJfTscunYd542aQuXqQU_RZ9kyt11ZFIM9rR3btJ9qaorOGQuR7c9mWSznyzXMF7hcLeBusTB6P9usq_ntrDKrm9kc5PF4_AMJE56Z">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
sequenceDiagram
 | 
			
		||||
Alice->>John: Hello John, how are you?
 | 
			
		||||
loop HealthCheck
 | 
			
		||||
loop Healthcheck
 | 
			
		||||
    John->>John: Fight against hypochondria
 | 
			
		||||
end
 | 
			
		||||
Note right of John: Rational thoughts!
 | 
			
		||||
@@ -133,7 +113,7 @@ Bob-->>John: Jolly good!
 | 
			
		||||
```mermaid
 | 
			
		||||
sequenceDiagram
 | 
			
		||||
Alice->>John: Hello John, how are you?
 | 
			
		||||
loop HealthCheck
 | 
			
		||||
loop Healthcheck
 | 
			
		||||
    John->>John: Fight against hypochondria
 | 
			
		||||
end
 | 
			
		||||
Note right of John: Rational thoughts!
 | 
			
		||||
@@ -142,7 +122,7 @@ John->>Bob: How about you?
 | 
			
		||||
Bob-->>John: Jolly good!
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Gantt chart [<a href="https://mermaid.js.org/syntax/gantt.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNp90cGOgyAQBuBXIZxtFbG29bbZ3fsmvXKZylhJEAyOTZrGd1_sto3xsHMBhu-HBO689hp5xS_giJQbsCbjHTv9jcp9-q63SKhZpb3DhMXSOIiE5ZkoNpnYZGXynh6U-4jBK7JnVfBYJo9QvgjtEya1cj8QwFq0TMz4lZqxTBg0hOF5m1jifI2Lf7Bc490CyxUu1rhc4GLGPOEdhg6Mjq92V44xxanFDhWv4lRjA6MlxZWbIh17DYTf2pAPvGrADphwGMmfbq7mFYURX-jLwCVA91bWg8YYunO69Y8vMgPFI2vvGnOZ-2Owsd0S9UOVpvP29mKoHc_b2nfpYHQLgdrrsUzLvDxALrHcS9hJqeuzOB6avBCN3mciBz5N0y_wxZ0J">live editor</a>]
 | 
			
		||||
### Gantt chart [<a href="https://mermaid-js.github.io/mermaid/#/gantt">docs</a> - <a href="https://mermaid.live/edit#pako:eNp90cGOgyAQBuBXIZxtFbG29bbZ3fsmvXKZylhJEAyOTZrGd1_sto3xsHMBhu-HBO689hp5xS_giJQbsCbjHTv9jcp9-q63SKhZpb3DhMXSOIiE5ZkoNpnYZGXynh6U-4jBK7JnVfBYJo9QvgjtEya1cj8QwFq0TMz4lZqxTBg0hOF5m1jifI2Lf7Bc490CyxUu1rhc4GLGPOEdhg6Mjq92V44xxanFDhWv4lRjA6MlxZWbIh17DYTf2pAPvGrADphwGMmfbq7mFYURX-jLwCVA91bWg8YYunO69Y8vMgPFI2vvGnOZ-2Owsd0S9UOVpvP29mKoHc_b2nfpYHQLgdrrsUzLvDxALrHcS9hJqeuzOB6avBCN3mciBz5N0y_wxZ0J">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
gantt
 | 
			
		||||
@@ -166,7 +146,7 @@ gantt
 | 
			
		||||
    Parallel 4   :         des6, after des4, 1d
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Class diagram [<a href="https://mermaid.js.org/syntax/classDiagram.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkTFPwzAQhf-K5QlQ2zQJJG1UBaGWDYmBgYEwXO1LYuTEwXYqlZL_jt02asXm--690zvfgTLFkWaUSTBmI6DS0BTt2lfzkKx-p1PytEO9f1FtdaQkI2ulZNGuVqK1qEtgmOfk7BitSzKdOhg59XuNGgk0RDxed-_IOr6uf8cZ6UhTZ8bvHqS5ub1mr9svZPbjk6DEBlu7AQuXyBkx4gcvDk9cUMJq0XT_YaW0kNK5j-ufAoRzcihaQvLcoN4Jv50vvVxw_xrnD3RCG9QNCO4-8OgpqK1dpoJm7smxhF7agp6kfcfB4jMXVmmalW4tnFDorXrbt4xmVvc4is53GKFUwNF5DtTuO3-sShjrJjLVlqLyvNfS4drazmRB4NuzSti6386YagIjeA3a1rtlEiRRsoAoxiSN4SGOOduGy0UZ3YclT-dhBHQYhj8dc6_I">live editor</a>]
 | 
			
		||||
### Class diagram [<a href="https://mermaid-js.github.io/mermaid/#/classDiagram">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkTFPwzAQhf-K5QlQ2zQJJG1UBaGWDYmBgYEwXO1LYuTEwXYqlZL_jt02asXm--690zvfgTLFkWaUSTBmI6DS0BTt2lfzkKx-p1PytEO9f1FtdaQkI2ulZNGuVqK1qEtgmOfk7BitSzKdOhg59XuNGgk0RDxed-_IOr6uf8cZ6UhTZ8bvHqS5ub1mr9svZPbjk6DEBlu7AQuXyBkx4gcvDk9cUMJq0XT_YaW0kNK5j-ufAoRzcihaQvLcoN4Jv50vvVxw_xrnD3RCG9QNCO4-8OgpqK1dpoJm7smxhF7agp6kfcfB4jMXVmmalW4tnFDorXrbt4xmVvc4is53GKFUwNF5DtTuO3-sShjrJjLVlqLyvNfS4drazmRB4NuzSti6386YagIjeA3a1rtlEiRRsoAoxiSN4SGOOduGy0UZ3YclT-dhBHQYhj8dc6_I">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
classDiagram
 | 
			
		||||
@@ -185,7 +165,13 @@ class Class10 {
 | 
			
		||||
  int id
 | 
			
		||||
  size()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
namespace Namespace01 {
 | 
			
		||||
  class Class11
 | 
			
		||||
  class Class12 {
 | 
			
		||||
    int id
 | 
			
		||||
    size()
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
```mermaid
 | 
			
		||||
@@ -205,10 +191,16 @@ class Class10 {
 | 
			
		||||
  int id
 | 
			
		||||
  size()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
namespace Namespace01 {
 | 
			
		||||
  class Class11
 | 
			
		||||
  class Class12 {
 | 
			
		||||
    int id
 | 
			
		||||
    size()
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### State diagram [<a href="https://mermaid.js.org/syntax/stateDiagram.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkEFvgzAMhf8K8nEqpYSNthx22Xbcqcexg0sCiZQQlDhIFeK_L8A6TfXp6fOz9ewJGssFVOAJSbwr7ByadGR1n8T6evpO0vQ1uZDSekOrXGFsPqJPO6q-2-imH8f_0TeHXm50lfelsAMjnEHFY6xpMdRAUhhRQxUlFy0GTTXU_RytYeAx-AdXZB1ULWovdoCB7OXWN1CRC-Ju-r3uz6UtchGHJqDbsPygU57iysb2reoWHpyOWBINvsqypb3vFMlw3TfWZF5xiY7keC6zkpUnZIUojwW-FAVvrvn51LLnvOXHQ84Q5nn-AVtLcwk">live editor</a>]
 | 
			
		||||
### State diagram [<a href="https://mermaid-js.github.io/mermaid/#/stateDiagram">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkEFvgzAMhf8K8nEqpYSNthx22Xbcqcexg0sCiZQQlDhIFeK_L8A6TfXp6fOz9ewJGssFVOAJSbwr7ByadGR1n8T6evpO0vQ1uZDSekOrXGFsPqJPO6q-2-imH8f_0TeHXm50lfelsAMjnEHFY6xpMdRAUhhRQxUlFy0GTTXU_RytYeAx-AdXZB1ULWovdoCB7OXWN1CRC-Ju-r3uz6UtchGHJqDbsPygU57iysb2reoWHpyOWBINvsqypb3vFMlw3TfWZF5xiY7keC6zkpUnZIUojwW-FAVvrvn51LLnvOXHQ84Q5nn-AVtLcwk">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
stateDiagram-v2
 | 
			
		||||
@@ -230,7 +222,7 @@ Moving --> Crash
 | 
			
		||||
Crash --> [*]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### Pie chart [<a href="https://mermaid.js.org/syntax/pie.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNo9jsFugzAMhl8F-VzBgEEh13Uv0F1zcYkTIpEEBadShXj3BU3dzf_n77e8wxQUgYDVkvQSbsFsEgpRtEN_5i_kvzx05XiC-xvUHVzAUXRoVe7v0heFBJ7JkQSRR0Ua08ISpD-ymlaFTN_KcoggNC4bXQATh5-Xn0BwTPSWbhZNRPdvLQEV5dIO_FrPZ43dOJ-cgtfWnDzFJeOZed1EVZ3r0lie06Ocgqs2q2aMPD_HvuqbfsCmpf7aYte2anrU46Cbz1qr60fdIBzH8QvW9lkl">live editor</a>]
 | 
			
		||||
### Pie chart [<a href="https://mermaid-js.github.io/mermaid/#/pie">docs</a> - <a href="https://mermaid.live/edit#pako:eNo9jsFugzAMhl8F-VzBgEEh13Uv0F1zcYkTIpEEBadShXj3BU3dzf_n77e8wxQUgYDVkvQSbsFsEgpRtEN_5i_kvzx05XiC-xvUHVzAUXRoVe7v0heFBJ7JkQSRR0Ua08ISpD-ymlaFTN_KcoggNC4bXQATh5-Xn0BwTPSWbhZNRPdvLQEV5dIO_FrPZ43dOJ-cgtfWnDzFJeOZed1EVZ3r0lie06Ocgqs2q2aMPD_HvuqbfsCmpf7aYte2anrU46Cbz1qr60fdIBzH8QvW9lkl">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
pie
 | 
			
		||||
@@ -248,7 +240,7 @@ pie
 | 
			
		||||
 | 
			
		||||
### Git graph [experimental - <a href="https://mermaid.live/edit#pako:eNqNkMFugzAMhl8F-VyVAR1tOW_aA-zKxSSGRCMJCk6lCvHuNZPKZdM0n-zf3_8r8QIqaIIGMqnB8kfEybQ--y4VnLP8-9RF9Mpkmm40hmlnDKmvkPiH_kfS7nFo_VN0FAf6XwocQGgxa_nGsm1bYEOOWmik1dRjGrmF1q-Cpkkj07u2HCI0PY4zHQATh8-7V9BwTPSE3iwOEd1OjQE1iWkBvk_bzQY7s0Sq4Hs7bHqKo8iGeZqbPN_WR7mpSd1RHpvPVhuMbG7XOq_L-oJlRfW5wteq0qorrpe-PBW9Pr8UJcK6rg-BLYPQ">live editor</a>]
 | 
			
		||||
 | 
			
		||||
### Bar chart (using gantt chart) [<a href="https://mermaid.js.org/syntax/gantt.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNptkU1vhCAQhv8KIenNugiI4rkf6bmXpvEyFVxJFDYyNt1u9r8X63Z7WQ9m5pknLzieaBeMpQ3dg0dsPUkPOhwteXZIXmJcbCT3xMAxkuh8Z8kIEclyMIB209fqKcwTICFvG4IvFy_oLrZ-g9F26ILfQgvNFN94VaRXQ1iWqpumZBcu1J8p1E1TXDx59eQNr5LyEqjJn6hv5QnGNlxevZJmdLLpy5xJSzut45biYCfb0iaVxvawjNjS1p-TCguG16PvaIPzYjO67e3BwX6GiTY9jPFKH43DMF_hGMDY1J4oHg-_f8hFTJFd8L3br3yZx4QHxENsdrt1nO8dDstH3oVpF50ZYMbhU6ud4qoGLqyqBJRCmO6j0HXPZdGbihUc6Pmc0QP49xD-b5X69ZQv2gjO81IwzWqhC1lKrjJ6pA3nVS7SMiVjrKirWlYp5fs3osgrWeo00lorLWvOzz8JVbXm">live editor</a>]
 | 
			
		||||
### Bar chart (using gantt chart) [<a href="https://mermaid-js.github.io/mermaid/#/gantt">docs</a> - <a href="https://mermaid.live/edit#pako:eNptkU1vhCAQhv8KIenNugiI4rkf6bmXpvEyFVxJFDYyNt1u9r8X63Z7WQ9m5pknLzieaBeMpQ3dg0dsPUkPOhwteXZIXmJcbCT3xMAxkuh8Z8kIEclyMIB209fqKcwTICFvG4IvFy_oLrZ-g9F26ILfQgvNFN94VaRXQ1iWqpumZBcu1J8p1E1TXDx59eQNr5LyEqjJn6hv5QnGNlxevZJmdLLpy5xJSzut45biYCfb0iaVxvawjNjS1p-TCguG16PvaIPzYjO67e3BwX6GiTY9jPFKH43DMF_hGMDY1J4oHg-_f8hFTJFd8L3br3yZx4QHxENsdrt1nO8dDstH3oVpF50ZYMbhU6ud4qoGLqyqBJRCmO6j0HXPZdGbihUc6Pmc0QP49xD-b5X69ZQv2gjO81IwzWqhC1lKrjJ6pA3nVS7SMiVjrKirWlYp5fs3osgrWeo00lorLWvOzz8JVbXm">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
gantt
 | 
			
		||||
@@ -286,7 +278,7 @@ gantt
 | 
			
		||||
    5    : 0, 5
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### User Journey diagram [<a href="https://mermaid.js.org/syntax/userJourney.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNplkMFuwjAQRH9l5TMiTVIC-FqqnjhxzWWJN4khsSN7XRSh_HsdKBVt97R6Mzsj-yoqq0hIAXCywRkaSwNxWHNHsB_hYt1ZmwYUfiueKtbWwIcFtjf5zgH2eCZgQgkrCXt64GgMg2fUzkvIn5Xd_V5COtMFvCH_62ht_5yk7MU8sn61HDTfxD8VYiF6cj1qFd94nWkpuKWYKWRcFdUYOi5FaaZoDYNCpnel2Toha-w8LQQGtofRVEKyC_Qw7TQ2DvsfV2dRUTy6Ch6H-UMb7TlGVtbUupl5cF3ELfPgZZLM8rLR3IbjsrJ94rVq0XH7uS2SIis2mOVUrHNc5bmqjul2U2evaa3WL2mGYpqmL2BGiho">live editor</a>]
 | 
			
		||||
### User Journey diagram [<a href="https://mermaid-js.github.io/mermaid/#/user-journey">docs</a> - <a href="https://mermaid.live/edit#pako:eNplkMFuwjAQRH9l5TMiTVIC-FqqnjhxzWWJN4khsSN7XRSh_HsdKBVt97R6Mzsj-yoqq0hIAXCywRkaSwNxWHNHsB_hYt1ZmwYUfiueKtbWwIcFtjf5zgH2eCZgQgkrCXt64GgMg2fUzkvIn5Xd_V5COtMFvCH_62ht_5yk7MU8sn61HDTfxD8VYiF6cj1qFd94nWkpuKWYKWRcFdUYOi5FaaZoDYNCpnel2Toha-w8LQQGtofRVEKyC_Qw7TQ2DvsfV2dRUTy6Ch6H-UMb7TlGVtbUupl5cF3ELfPgZZLM8rLR3IbjsrJ94rVq0XH7uS2SIis2mOVUrHNc5bmqjul2U2evaa3WL2mGYpqmL2BGiho">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
  journey
 | 
			
		||||
@@ -312,7 +304,7 @@ gantt
 | 
			
		||||
      Sit down: 3: Me
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### C4 diagram [<a href="https://mermaid.js.org/syntax/c4.html">docs</a>]
 | 
			
		||||
### C4 diagram [<a href="https://mermaid-js.github.io/mermaid/#/c4c">docs</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
C4Context
 | 
			
		||||
@@ -406,7 +398,7 @@ The above command generates files into the `dist` folder and publishes them to <
 | 
			
		||||
 | 
			
		||||
Mermaid is a growing community and is always accepting new contributors. There's a lot of different ways to help out and we're always looking for extra hands! Look at [this issue](https://github.com/mermaid-js/mermaid/issues/866) if you want to know where to start helping out.
 | 
			
		||||
 | 
			
		||||
Detailed information about how to contribute can be found in the [contribution guide](https://mermaid.js.org/community/contributing.html)
 | 
			
		||||
Detailed information about how to contribute can be found in the [contribution guide](CONTRIBUTING.md)
 | 
			
		||||
 | 
			
		||||
## Security and safe diagrams
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -12,19 +12,15 @@ Mermaid
 | 
			
		||||
<p>
 | 
			
		||||
 | 
			
		||||
<p align="center">
 | 
			
		||||
<a href="https://mermaid.live/"><b>实时编辑器!</b></a>
 | 
			
		||||
<a href="https://mermaid.live/"><b>Live Editor!</b></a>
 | 
			
		||||
</p>
 | 
			
		||||
<p align="center">
 | 
			
		||||
 <a href="https://mermaid.js.org">📖 文档</a> | <a href="https://mermaid.js.org/intro/">🚀 入门</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://discord.gg/AgrbSrBer3" title="Discord invite">🙌 加入我们</a>
 | 
			
		||||
 <a href="https://mermaid.js.org">📖 文档</a> | <a href="https://mermaid.js.org/intro/">🚀 入门</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE" title="Slack invite">🙌 加入我们</a>
 | 
			
		||||
</p>
 | 
			
		||||
<p align="center">
 | 
			
		||||
<a href="./README.md">English</a>
 | 
			
		||||
</p>
 | 
			
		||||
 | 
			
		||||
<p align="center">
 | 
			
		||||
尝试未来版本的实时编辑器预览: <a href="https://develop.git.mermaid.live/" title="尝试来自develop分支的mermaid版本。">Develop</a> | <a href="https://next.git.mermaid.live/" title="尝试来自next分支的mermaid版本。">Next</a>
 | 
			
		||||
</p>
 | 
			
		||||
 | 
			
		||||
<br>
 | 
			
		||||
<br>
 | 
			
		||||
 | 
			
		||||
@@ -34,8 +30,8 @@ Mermaid
 | 
			
		||||
[](https://app.codecov.io/github/mermaid-js/mermaid/tree/develop)
 | 
			
		||||
[](https://www.jsdelivr.com/package/npm/mermaid)
 | 
			
		||||
[](https://www.npmjs.com/package/mermaid)
 | 
			
		||||
[](https://discord.gg/AgrbSrBer3)
 | 
			
		||||
[](https://twitter.com/mermaidjs_)
 | 
			
		||||
[](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
 | 
			
		||||
[](https://twitter.com/mermaidjs_)
 | 
			
		||||
 | 
			
		||||
<img src="./img/header.png" alt="" />
 | 
			
		||||
 | 
			
		||||
@@ -43,7 +39,7 @@ Mermaid
 | 
			
		||||
 | 
			
		||||
**感谢所有参与进来提交 PR,解答疑问的人们! 🙏**
 | 
			
		||||
 | 
			
		||||
<a href="https://mermaid.js.org/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
 | 
			
		||||
<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
 | 
			
		||||
 | 
			
		||||
## 关于 Mermaid
 | 
			
		||||
 | 
			
		||||
@@ -57,20 +53,20 @@ Mermaid 是一个基于 Javascript 的图表绘制工具,通过解析类 Markd
 | 
			
		||||
Mermaid 通过允许用户创建便于修改的图表来解决这一难题,它也可以作为生产脚本(或其他代码)的一部分。<br/>
 | 
			
		||||
<br/>
 | 
			
		||||
Mermaid 甚至能让非程序员也能通过 [Mermaid Live Editor](https://mermaid.live/) 轻松创建详细的图表。<br/>
 | 
			
		||||
你可以访问 [教程](https://mermaid.js.org/ecosystem/tutorials.html) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](https://mermaid.js.org/ecosystem/integrations-community.html) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
 | 
			
		||||
你可以访问 [教程](./docs/config/Tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/ecosystem/integrations.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
 | 
			
		||||
 | 
			
		||||
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](https://mermaid.js.org/intro/getting-started.html), [用法](https://mermaid.js.org/config/usage.html) 和 [教程](https://mermaid.js.org/ecosystem/tutorials.html).
 | 
			
		||||
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/community/n00b-overview.md), [用法](./docs/config/usage.md) 和 [教程](./docs/config/Tutorials.md).
 | 
			
		||||
 | 
			
		||||
<!-- </Main description> -->
 | 
			
		||||
 | 
			
		||||
## 示例
 | 
			
		||||
 | 
			
		||||
**下面是一些可以使用 Mermaid 创建的图表示例。点击 [语法](https://mermaid.js.org/intro/syntax-reference.html) 查看详情。**
 | 
			
		||||
**下面是一些可以使用 Mermaid 创建的图表示例。点击 [语法](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference) 查看详情。**
 | 
			
		||||
 | 
			
		||||
<table>
 | 
			
		||||
<!-- <Flowchart> -->
 | 
			
		||||
 | 
			
		||||
### 流程图 [<a href="https://mermaid.js.org/syntax/flowchart.html">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0hhcmRdIC0tPnxUZXh0fCBCKFJvdW5kKVxuICAgIEIgLS0-IEN7RGVjaXNpb259XG4gICAgQyAtLT58T25lfCBEW1Jlc3VsdCAxXVxuICAgIEMgLS0-fFR3b3wgRVtSZXN1bHQgMl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
			
		||||
### 流程图 [<a href="https://mermaid-js.github.io/mermaid/#/flowchart">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0hhcmRdIC0tPnxUZXh0fCBCKFJvdW5kKVxuICAgIEIgLS0-IEN7RGVjaXNpb259XG4gICAgQyAtLT58T25lfCBEW1Jlc3VsdCAxXVxuICAgIEMgLS0-fFR3b3wgRVtSZXN1bHQgMl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
flowchart LR
 | 
			
		||||
@@ -88,12 +84,12 @@ C -->|One| D[Result 1]
 | 
			
		||||
C -->|Two| E[Result 2]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### 时序图 [<a href="https://mermaid.js.org/syntax/sequenceDiagram.html">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5BbGljZS0-PkpvaG46IEhlbGxvIEpvaG4sIGhvdyBhcmUgeW91P1xubG9vcCBIZWFsdGhjaGVja1xuICAgIEpvaG4tPj5Kb2huOiBGaWdodCBhZ2FpbnN0IGh5cG9jaG9uZHJpYVxuZW5kXG5Ob3RlIHJpZ2h0IG9mIEpvaG46IFJhdGlvbmFsIHRob3VnaHRzIVxuSm9obi0tPj5BbGljZTogR3JlYXQhXG5Kb2huLT4-Qm9iOiBIb3cgYWJvdXQgeW91P1xuQm9iLS0-PkpvaG46IEpvbGx5IGdvb2QhIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
			
		||||
### 时序图 [<a href="https://mermaid-js.github.io/mermaid/#/sequenceDiagram">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5BbGljZS0-PkpvaG46IEhlbGxvIEpvaG4sIGhvdyBhcmUgeW91P1xubG9vcCBIZWFsdGhjaGVja1xuICAgIEpvaG4tPj5Kb2huOiBGaWdodCBhZ2FpbnN0IGh5cG9jaG9uZHJpYVxuZW5kXG5Ob3RlIHJpZ2h0IG9mIEpvaG46IFJhdGlvbmFsIHRob3VnaHRzIVxuSm9obi0tPj5BbGljZTogR3JlYXQhXG5Kb2huLT4-Qm9iOiBIb3cgYWJvdXQgeW91P1xuQm9iLS0-PkpvaG46IEpvbGx5IGdvb2QhIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
sequenceDiagram
 | 
			
		||||
Alice->>John: Hello John, how are you?
 | 
			
		||||
loop HealthCheck
 | 
			
		||||
loop Healthcheck
 | 
			
		||||
    John->>John: Fight against hypochondria
 | 
			
		||||
end
 | 
			
		||||
Note right of John: Rational thoughts!
 | 
			
		||||
@@ -105,7 +101,7 @@ Bob-->>John: Jolly good!
 | 
			
		||||
```mermaid
 | 
			
		||||
sequenceDiagram
 | 
			
		||||
Alice->>John: Hello John, how are you?
 | 
			
		||||
loop HealthCheck
 | 
			
		||||
loop Healthcheck
 | 
			
		||||
    John->>John: Fight against hypochondria
 | 
			
		||||
end
 | 
			
		||||
Note right of John: Rational thoughts!
 | 
			
		||||
@@ -114,7 +110,7 @@ John->>Bob: How about you?
 | 
			
		||||
Bob-->>John: Jolly good!
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### 甘特图 [<a href="https://mermaid.js.org/syntax/gantt.html">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ2FudHRcbnNlY3Rpb24gU2VjdGlvblxuQ29tcGxldGVkIDpkb25lLCAgICBkZXMxLCAyMDE0LTAxLTA2LDIwMTQtMDEtMDhcbkFjdGl2ZSAgICAgICAgOmFjdGl2ZSwgIGRlczIsIDIwMTQtMDEtMDcsIDNkXG5QYXJhbGxlbCAxICAgOiAgICAgICAgIGRlczMsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAyICAgOiAgICAgICAgIGRlczQsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAzICAgOiAgICAgICAgIGRlczUsIGFmdGVyIGRlczMsIDFkXG5QYXJhbGxlbCA0ICAgOiAgICAgICAgIGRlczYsIGFmdGVyIGRlczQsIDFkIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
			
		||||
### 甘特图 [<a href="https://mermaid-js.github.io/mermaid/#/gantt">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ2FudHRcbnNlY3Rpb24gU2VjdGlvblxuQ29tcGxldGVkIDpkb25lLCAgICBkZXMxLCAyMDE0LTAxLTA2LDIwMTQtMDEtMDhcbkFjdGl2ZSAgICAgICAgOmFjdGl2ZSwgIGRlczIsIDIwMTQtMDEtMDcsIDNkXG5QYXJhbGxlbCAxICAgOiAgICAgICAgIGRlczMsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAyICAgOiAgICAgICAgIGRlczQsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAzICAgOiAgICAgICAgIGRlczUsIGFmdGVyIGRlczMsIDFkXG5QYXJhbGxlbCA0ICAgOiAgICAgICAgIGRlczYsIGFmdGVyIGRlczQsIDFkIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
gantt
 | 
			
		||||
@@ -138,7 +134,7 @@ gantt
 | 
			
		||||
    Parallel 4   :         des6, after des4, 1d
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### 类图 [<a href="https://mermaid.js.org/syntax/classDiagram.html">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiY2xhc3NEaWFncmFtXG5DbGFzczAxIDx8LS0gQXZlcnlMb25nQ2xhc3MgOiBDb29sXG48PGludGVyZmFjZT4-IENsYXNzMDFcbkNsYXNzMDkgLS0-IEMyIDogV2hlcmUgYW0gaT9cbkNsYXNzMDkgLS0qIEMzXG5DbGFzczA5IC0tfD4gQ2xhc3MwN1xuQ2xhc3MwNyA6IGVxdWFscygpXG5DbGFzczA3IDogT2JqZWN0W10gZWxlbWVudERhdGFcbkNsYXNzMDEgOiBzaXplKClcbkNsYXNzMDEgOiBpbnQgY2hpbXBcbkNsYXNzMDEgOiBpbnQgZ29yaWxsYVxuY2xhc3MgQ2xhc3MxMCB7XG4gID4-c2VydmljZT4-XG4gIGludCBpZFxuICBzaXplKClcbn0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
			
		||||
### 类图 [<a href="https://mermaid-js.github.io/mermaid/#/classDiagram">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiY2xhc3NEaWFncmFtXG5DbGFzczAxIDx8LS0gQXZlcnlMb25nQ2xhc3MgOiBDb29sXG48PGludGVyZmFjZT4-IENsYXNzMDFcbkNsYXNzMDkgLS0-IEMyIDogV2hlcmUgYW0gaT9cbkNsYXNzMDkgLS0qIEMzXG5DbGFzczA5IC0tfD4gQ2xhc3MwN1xuQ2xhc3MwNyA6IGVxdWFscygpXG5DbGFzczA3IDogT2JqZWN0W10gZWxlbWVudERhdGFcbkNsYXNzMDEgOiBzaXplKClcbkNsYXNzMDEgOiBpbnQgY2hpbXBcbkNsYXNzMDEgOiBpbnQgZ29yaWxsYVxuY2xhc3MgQ2xhc3MxMCB7XG4gID4-c2VydmljZT4-XG4gIGludCBpZFxuICBzaXplKClcbn0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
classDiagram
 | 
			
		||||
@@ -178,7 +174,7 @@ class Class10 {
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### 状态图 [<a href="https://mermaid.js.org/syntax/stateDiagram.html">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkLsOwjAMRX-l8ojahTEDCzB26kgYrMYtkfJAqVMJVf13QiIKqqfr44d8vUDvFYGAiZHponEMaJv5KF2V4na4V01zqjrWxhSUZYapuEetn7UbCy16P_5HzwGnR6FZfpdCDZaCRa3SWcunQQI_yJIEkaSiAaNhCdKtqRUj--7lehAcItUQn-pnBMSAZtroVWn2YYOU07b4z29Y37gJVYk">live editor</a>]
 | 
			
		||||
### 状态图 [[<a href="https://mermaid-js.github.io/mermaid/#/stateDiagram">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkLsOwjAMRX-l8ojahTEDCzB26kgYrMYtkfJAqVMJVf13QiIKqqfr44d8vUDvFYGAiZHponEMaJv5KF2V4na4V01zqjrWxhSUZYapuEetn7UbCy16P_5HzwGnR6FZfpdCDZaCRa3SWcunQQI_yJIEkaSiAaNhCdKtqRUj--7lehAcItUQn-pnBMSAZtroVWn2YYOU07b4z29Y37gJVYk">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
stateDiagram-v2
 | 
			
		||||
@@ -200,7 +196,7 @@ Moving --> Crash
 | 
			
		||||
Crash --> [*]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### 饼图 [<a href="https://mermaid.js.org/syntax/pie.html">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoicGllXG5cIkRvZ3NcIiA6IDQyLjk2XG5cIkNhdHNcIiA6IDUwLjA1XG5cIlJhdHNcIiA6IDEwLjAxIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
			
		||||
### 饼图 [<a href="https://mermaid-js.github.io/mermaid/#/pie">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoicGllXG5cIkRvZ3NcIiA6IDQyLjk2XG5cIkNhdHNcIiA6IDUwLjA1XG5cIlJhdHNcIiA6IDEwLjAxIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
pie
 | 
			
		||||
@@ -218,7 +214,7 @@ pie
 | 
			
		||||
 | 
			
		||||
### Git 图 [实验特性 - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ2l0R3JhcGg6XG5vcHRpb25zXG57XG4gICAgXCJub2RlU3BhY2luZ1wiOiAxNTAsXG4gICAgXCJub2RlUmFkaXVzXCI6IDEwXG59XG5lbmRcbmNvbW1pdFxuYnJhbmNoIG5ld2JyYW5jaFxuY2hlY2tvdXQgbmV3YnJhbmNoXG5jb21taXRcbmNvbW1pdFxuY2hlY2tvdXQgbWFzdGVyXG5jb21taXRcbmNvbW1pdFxubWVyZ2UgbmV3YnJhbmNoXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
			
		||||
 | 
			
		||||
### 用户体验旅程图 [<a href="https://mermaid.js.org/syntax/userJourney.html">文档</a> - <a href="https://mermaid.live/edit#pako:eNpljzEPgkAMhf9K05nFGJdbJXFiYmVpuKIncDVHL4QQ_ruHaILaqXnf63vpjLVYRoMAd4nB81R5SKNOO4ZiglFC6_wVLL3JwLU68XARUHnhTQcoqGVQJgMnAwV_5GSMj0HJhcHAcU_y7d7AYVUzOJP-ddyk3ydZGf0n66uldPqCPxWYYc-hJ2fTj_OqVqg3Tplo0mq5odhphZVfkpWiSjn5Go2GyBnGhyXl3NE1UI-moW7g5QkSoF5m">live editor</a>]
 | 
			
		||||
### 用户体验旅程图 [<a href="https://mermaid-js.github.io/mermaid/#/user-journey">文档</a> - <a href="https://mermaid.live/edit#pako:eNpljzEPgkAMhf9K05nFGJdbJXFiYmVpuKIncDVHL4QQ_ruHaILaqXnf63vpjLVYRoMAd4nB81R5SKNOO4ZiglFC6_wVLL3JwLU68XARUHnhTQcoqGVQJgMnAwV_5GSMj0HJhcHAcU_y7d7AYVUzOJP-ddyk3ydZGf0n66uldPqCPxWYYc-hJ2fTj_OqVqg3Tplo0mq5odhphZVfkpWiSjn5Go2GyBnGhyXl3NE1UI-moW7g5QkSoF5m">live editor</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
  journey
 | 
			
		||||
@@ -244,7 +240,7 @@ pie
 | 
			
		||||
      Sit down: 3: Me
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### C4 图 [<a href="https://mermaid.js.org/syntax/c4.html">文档</a>]
 | 
			
		||||
### C4 图 [<a href="https://mermaid-js.github.io/mermaid/#/c4c">文档</a>]
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
C4Context
 | 
			
		||||
@@ -338,7 +334,7 @@ npm publish
 | 
			
		||||
 | 
			
		||||
Mermaid 是一个不断发展中的社区,并且还在接收新的贡献者。有很多不同的方式可以参与进来,而且我们还在寻找额外的帮助。如果你想知道如何开始贡献,请查看 [这个 issue](https://github.com/mermaid-js/mermaid/issues/866)。
 | 
			
		||||
 | 
			
		||||
关于如何贡献的详细信息可以在 [贡献指南](https://mermaid.js.org/community/contributing.html) 中找到。
 | 
			
		||||
关于如何贡献的详细信息可以在 [贡献指南](CONTRIBUTING.md) 中找到。
 | 
			
		||||
 | 
			
		||||
## 安全
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										21
									
								
								__mocks__/c4Renderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								__mocks__/c4Renderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,21 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked C4Context diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const drawPersonOrSystemArray = vi.fn();
 | 
			
		||||
export const drawBoundary = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  drawPersonOrSystemArray,
 | 
			
		||||
  drawBoundary,
 | 
			
		||||
  setConf,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										16
									
								
								__mocks__/classRenderer-v2.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								__mocks__/classRenderer-v2.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,16 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked class diagram v2 renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  setConf,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										13
									
								
								__mocks__/classRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								__mocks__/classRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked class diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										1
									
								
								__mocks__/dagre-d3.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								__mocks__/dagre-d3.ts
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1 @@
 | 
			
		||||
// DO NOT delete this file. It is used by vitest to mock the dagre-d3 module.
 | 
			
		||||
							
								
								
									
										3
									
								
								__mocks__/entity-decode/browser.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								__mocks__/entity-decode/browser.ts
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,3 @@
 | 
			
		||||
module.exports = function (txt: string) {
 | 
			
		||||
  return txt;
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										16
									
								
								__mocks__/erRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								__mocks__/erRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,16 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked er diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  setConf,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										24
									
								
								__mocks__/flowRenderer-v2.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								__mocks__/flowRenderer-v2.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,24 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked flow (flowchart) diagram v2 renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
export const addVertices = vi.fn();
 | 
			
		||||
export const addEdges = vi.fn();
 | 
			
		||||
export const getClasses = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return {};
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  setConf,
 | 
			
		||||
  addVertices,
 | 
			
		||||
  addEdges,
 | 
			
		||||
  getClasses,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										16
									
								
								__mocks__/ganttRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								__mocks__/ganttRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,16 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked gantt diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  setConf,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										13
									
								
								__mocks__/gitGraphRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								__mocks__/gitGraphRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked git (graph) diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										15
									
								
								__mocks__/journeyRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								__mocks__/journeyRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,15 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked pie (picChart) diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  setConf,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										13
									
								
								__mocks__/pieRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								__mocks__/pieRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked pie (picChart) diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										13
									
								
								__mocks__/requirementRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								__mocks__/requirementRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,13 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked requirement diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										23
									
								
								__mocks__/sequenceRenderer.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								__mocks__/sequenceRenderer.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,23 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked sequence diagram renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const bounds = vi.fn();
 | 
			
		||||
export const drawActors = vi.fn();
 | 
			
		||||
export const drawActorsPopup = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  bounds,
 | 
			
		||||
  drawActors,
 | 
			
		||||
  drawActorsPopup,
 | 
			
		||||
  setConf,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										22
									
								
								__mocks__/stateRenderer-v2.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								__mocks__/stateRenderer-v2.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,22 @@
 | 
			
		||||
/**
 | 
			
		||||
 * Mocked state diagram v2 renderer
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import { vi } from 'vitest';
 | 
			
		||||
 | 
			
		||||
export const setConf = vi.fn();
 | 
			
		||||
export const getClasses = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return {};
 | 
			
		||||
});
 | 
			
		||||
export const stateDomId = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return 'mocked-stateDiagram-stateDomId';
 | 
			
		||||
});
 | 
			
		||||
export const draw = vi.fn().mockImplementation(() => {
 | 
			
		||||
  return '';
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
  setConf,
 | 
			
		||||
  getClasses,
 | 
			
		||||
  draw,
 | 
			
		||||
};
 | 
			
		||||
							
								
								
									
										19
									
								
								applitools.config.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								applitools.config.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,19 @@
 | 
			
		||||
// eslint-disable-next-line @typescript-eslint/no-var-requires
 | 
			
		||||
const { defineConfig } = require('cypress');
 | 
			
		||||
 | 
			
		||||
module.exports = defineConfig({
 | 
			
		||||
  testConcurrency: 1,
 | 
			
		||||
  browser: [
 | 
			
		||||
    // Add browsers with different viewports
 | 
			
		||||
    //   { width: 800, height: 600, name: 'chrome' },
 | 
			
		||||
    //   { width: 700, height: 500, name: 'firefox' },
 | 
			
		||||
    //   { width: 1600, height: 1200, name: 'ie11' },
 | 
			
		||||
    //   { width: 1024, height: 768, name: 'edgechromium' },
 | 
			
		||||
    //   { width: 800, height: 600, name: 'safari' },
 | 
			
		||||
    //   // Add mobile emulation devices in Portrait mode
 | 
			
		||||
    //   { deviceName: 'iPhone X', screenOrientation: 'portrait' },
 | 
			
		||||
    //   { deviceName: 'Pixel 2', screenOrientation: 'portrait' },
 | 
			
		||||
  ],
 | 
			
		||||
  // set batch name to the configuration
 | 
			
		||||
  // batchName: `Mermaid ${process.env.APPLI_BRANCH ?? "'no APPLI_BRANCH set'"}`,
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										189
									
								
								cSpell.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										189
									
								
								cSpell.json
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,189 @@
 | 
			
		||||
{
 | 
			
		||||
  "version": "0.2",
 | 
			
		||||
  "language": "en",
 | 
			
		||||
  "words": [
 | 
			
		||||
    "acyclicer",
 | 
			
		||||
    "adamiecki",
 | 
			
		||||
    "alois",
 | 
			
		||||
    "aloisklink",
 | 
			
		||||
    "antiscript",
 | 
			
		||||
    "antlr",
 | 
			
		||||
    "appli",
 | 
			
		||||
    "applitools",
 | 
			
		||||
    "asciidoctor",
 | 
			
		||||
    "ashish",
 | 
			
		||||
    "ashishjain",
 | 
			
		||||
    "astah",
 | 
			
		||||
    "bbox",
 | 
			
		||||
    "bilkent",
 | 
			
		||||
    "bisheng",
 | 
			
		||||
    "blrs",
 | 
			
		||||
    "braintree",
 | 
			
		||||
    "brkt",
 | 
			
		||||
    "brolin",
 | 
			
		||||
    "brotli",
 | 
			
		||||
    "città",
 | 
			
		||||
    "classdef",
 | 
			
		||||
    "codedoc",
 | 
			
		||||
    "colour",
 | 
			
		||||
    "commitlint",
 | 
			
		||||
    "cpettitt",
 | 
			
		||||
    "customizability",
 | 
			
		||||
    "cuzon",
 | 
			
		||||
    "cytoscape",
 | 
			
		||||
    "dagre",
 | 
			
		||||
    "deepdwn",
 | 
			
		||||
    "descr",
 | 
			
		||||
    "docsify",
 | 
			
		||||
    "docsy",
 | 
			
		||||
    "doku",
 | 
			
		||||
    "dompurify",
 | 
			
		||||
    "edgechromium",
 | 
			
		||||
    "elkjs",
 | 
			
		||||
    "elle",
 | 
			
		||||
    "faber",
 | 
			
		||||
    "flatmap",
 | 
			
		||||
    "foswiki",
 | 
			
		||||
    "ftplugin",
 | 
			
		||||
    "gantt",
 | 
			
		||||
    "gitea",
 | 
			
		||||
    "gitgraph",
 | 
			
		||||
    "globby",
 | 
			
		||||
    "graphlib",
 | 
			
		||||
    "graphviz",
 | 
			
		||||
    "grav",
 | 
			
		||||
    "greywolf",
 | 
			
		||||
    "gzipped",
 | 
			
		||||
    "huynh",
 | 
			
		||||
    "huynhicode",
 | 
			
		||||
    "inkdrop",
 | 
			
		||||
    "jaoude",
 | 
			
		||||
    "jgreywolf",
 | 
			
		||||
    "jison",
 | 
			
		||||
    "jiti",
 | 
			
		||||
    "kaufmann",
 | 
			
		||||
    "khroma",
 | 
			
		||||
    "klemm",
 | 
			
		||||
    "klink",
 | 
			
		||||
    "knsv",
 | 
			
		||||
    "knut",
 | 
			
		||||
    "knutsveidqvist",
 | 
			
		||||
    "laganeckas",
 | 
			
		||||
    "linetype",
 | 
			
		||||
    "lintstagedrc",
 | 
			
		||||
    "logmsg",
 | 
			
		||||
    "lucida",
 | 
			
		||||
    "markdownish",
 | 
			
		||||
    "matthieu",
 | 
			
		||||
    "matthieumorel",
 | 
			
		||||
    "mdast",
 | 
			
		||||
    "mdbook",
 | 
			
		||||
    "mermaidjs",
 | 
			
		||||
    "mermerd",
 | 
			
		||||
    "mindaugas",
 | 
			
		||||
    "mindmap",
 | 
			
		||||
    "mindmaps",
 | 
			
		||||
    "mitigations",
 | 
			
		||||
    "mkdocs",
 | 
			
		||||
    "mmorel",
 | 
			
		||||
    "mult",
 | 
			
		||||
    "neurodiverse",
 | 
			
		||||
    "nextra",
 | 
			
		||||
    "orlandoni",
 | 
			
		||||
    "pathe",
 | 
			
		||||
    "pbrolin",
 | 
			
		||||
    "phpbb",
 | 
			
		||||
    "plantuml",
 | 
			
		||||
    "playfair",
 | 
			
		||||
    "pnpm",
 | 
			
		||||
    "podlite",
 | 
			
		||||
    "quence",
 | 
			
		||||
    "radious",
 | 
			
		||||
    "ranksep",
 | 
			
		||||
    "rect",
 | 
			
		||||
    "rects",
 | 
			
		||||
    "redmine",
 | 
			
		||||
    "rehype",
 | 
			
		||||
    "roledescription",
 | 
			
		||||
    "sandboxed",
 | 
			
		||||
    "setupgraphviewbox",
 | 
			
		||||
    "shiki",
 | 
			
		||||
    "sidharth",
 | 
			
		||||
    "sidharthv",
 | 
			
		||||
    "sphinxcontrib",
 | 
			
		||||
    "startx",
 | 
			
		||||
    "starty",
 | 
			
		||||
    "statediagram",
 | 
			
		||||
    "steph",
 | 
			
		||||
    "stopx",
 | 
			
		||||
    "stopy",
 | 
			
		||||
    "stylis",
 | 
			
		||||
    "subhash-halder",
 | 
			
		||||
    "substate",
 | 
			
		||||
    "sveidqvist",
 | 
			
		||||
    "swimm",
 | 
			
		||||
    "techn",
 | 
			
		||||
    "teststr",
 | 
			
		||||
    "textlength",
 | 
			
		||||
    "treemap",
 | 
			
		||||
    "ts-nocheck",
 | 
			
		||||
    "tsdoc",
 | 
			
		||||
    "tuleap",
 | 
			
		||||
    "tylerlong",
 | 
			
		||||
    "ugge",
 | 
			
		||||
    "unist",
 | 
			
		||||
    "unocss",
 | 
			
		||||
    "upvoting",
 | 
			
		||||
    "valign",
 | 
			
		||||
    "verdana",
 | 
			
		||||
    "viewports",
 | 
			
		||||
    "vinod",
 | 
			
		||||
    "visio",
 | 
			
		||||
    "vitepress",
 | 
			
		||||
    "vueuse",
 | 
			
		||||
    "xlink",
 | 
			
		||||
    "yash",
 | 
			
		||||
    "zenuml"
 | 
			
		||||
  ],
 | 
			
		||||
  "patterns": [
 | 
			
		||||
    { "name": "Markdown links", "pattern": "\\((.*)\\)", "description": "" },
 | 
			
		||||
    {
 | 
			
		||||
      "name": "Markdown code blocks",
 | 
			
		||||
      "pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx",
 | 
			
		||||
      "description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions"
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
      "name": "Inline code blocks",
 | 
			
		||||
      "pattern": "\\`([^\\`\\r\\n]+?)\\`",
 | 
			
		||||
      "description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex"
 | 
			
		||||
    },
 | 
			
		||||
    { "name": "Link contents", "pattern": "\\<a(.*)\\>", "description": "" },
 | 
			
		||||
    { "name": "Snippet references", "pattern": "-- snippet:(.*)", "description": "" },
 | 
			
		||||
    {
 | 
			
		||||
      "name": "Snippet references 2",
 | 
			
		||||
      "pattern": "\\<\\[sample:(.*)",
 | 
			
		||||
      "description": "another kind of snippet reference"
 | 
			
		||||
    },
 | 
			
		||||
    { "name": "Multi-line code blocks", "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm" },
 | 
			
		||||
    {
 | 
			
		||||
      "name": "HTML Tags",
 | 
			
		||||
      "pattern": "<[^>]*>",
 | 
			
		||||
      "description": "Reference: https://stackoverflow.com/questions/11229831/regular-expression-to-remove-html-tags-from-a-string"
 | 
			
		||||
    }
 | 
			
		||||
  ],
 | 
			
		||||
  "ignoreRegExpList": [
 | 
			
		||||
    "Markdown links",
 | 
			
		||||
    "Markdown code blocks",
 | 
			
		||||
    "Inline code blocks",
 | 
			
		||||
    "Link contents",
 | 
			
		||||
    "Snippet references",
 | 
			
		||||
    "Snippet references 2",
 | 
			
		||||
    "Multi-line code blocks",
 | 
			
		||||
    "HTML Tags"
 | 
			
		||||
  ],
 | 
			
		||||
  "ignorePaths": [
 | 
			
		||||
    "packages/mermaid/src/docs/CHANGELOG.md",
 | 
			
		||||
    "packages/mermaid/src/docs/.vitepress/redirect.ts",
 | 
			
		||||
    "packages/mermaid/src/docs/.vitepress/contributor-names.json"
 | 
			
		||||
  ]
 | 
			
		||||
}
 | 
			
		||||
@@ -1,6 +1,3 @@
 | 
			
		||||
codecov:
 | 
			
		||||
  branch: develop
 | 
			
		||||
 | 
			
		||||
comment:
 | 
			
		||||
  layout: 'reach, diff, flags, files'
 | 
			
		||||
  behavior: default
 | 
			
		||||
@@ -11,8 +8,5 @@ comment:
 | 
			
		||||
coverage:
 | 
			
		||||
  status:
 | 
			
		||||
    project:
 | 
			
		||||
      off
 | 
			
		||||
      # Turing off for now as code coverage isn't stable and causes unnecessary build failures.
 | 
			
		||||
      # default:
 | 
			
		||||
      #   threshold: 2%
 | 
			
		||||
    patch: off
 | 
			
		||||
      default:
 | 
			
		||||
        threshold: 1%
 | 
			
		||||
@@ -1,45 +0,0 @@
 | 
			
		||||
# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
 | 
			
		||||
 | 
			
		||||
$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
 | 
			
		||||
version: '0.2'
 | 
			
		||||
language: en-US,en-GB
 | 
			
		||||
 | 
			
		||||
import:
 | 
			
		||||
  - ./.cspell/cspell.config.yaml
 | 
			
		||||
 | 
			
		||||
ignoreRegExpList:
 | 
			
		||||
  - character-set-cyrillic
 | 
			
		||||
  - svg-block
 | 
			
		||||
ignorePaths:
 | 
			
		||||
  - '*lock.{yaml,json}'
 | 
			
		||||
  - dist
 | 
			
		||||
  - CHANGELOG.md
 | 
			
		||||
  - packages/mermaid/src/docs/.vitepress/redirect.ts
 | 
			
		||||
  - packages/mermaid/src/docs/.vitepress/contributor-names.json
 | 
			
		||||
  - backup
 | 
			
		||||
  - '**/*.spec.{js,ts}' # checked by eslint
 | 
			
		||||
  - 'tests/webpack/src/index.js' # checked by eslint
 | 
			
		||||
  - 'cypress/**/*.js' # checked by eslint
 | 
			
		||||
  - '*.csv'
 | 
			
		||||
  - '*.patch'
 | 
			
		||||
  - 'docs/**/*.html'
 | 
			
		||||
  - 'cypress/platform/**'
 | 
			
		||||
dictionaries:
 | 
			
		||||
  - misc-terms
 | 
			
		||||
overrides:
 | 
			
		||||
  - filename:
 | 
			
		||||
      - '**/*.{jison,ts,mts,cjs,mjs,js,json,yaml,yml,md,html}'
 | 
			
		||||
      - 'run'
 | 
			
		||||
      - Dockerfile
 | 
			
		||||
    ignoreRegExpList:
 | 
			
		||||
      - js-unicode-escape
 | 
			
		||||
    dictionaries:
 | 
			
		||||
      - code-terms
 | 
			
		||||
      - 3rd-party-terms
 | 
			
		||||
      - fonts
 | 
			
		||||
      - html
 | 
			
		||||
      - lorem-ipsum
 | 
			
		||||
  - filename: '**/package.json'
 | 
			
		||||
    ignoreRegExpList:
 | 
			
		||||
      - json-property
 | 
			
		||||
# cspell:dictionaries code-terms
 | 
			
		||||
							
								
								
									
										24
									
								
								cypress.config.cjs
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								cypress.config.cjs
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,24 @@
 | 
			
		||||
/* eslint-disable @typescript-eslint/no-var-requires */
 | 
			
		||||
 | 
			
		||||
const { defineConfig } = require('cypress');
 | 
			
		||||
const { addMatchImageSnapshotPlugin } = require('cypress-image-snapshot/plugin');
 | 
			
		||||
const coverage = require('@cypress/code-coverage/task');
 | 
			
		||||
 | 
			
		||||
module.exports = defineConfig({
 | 
			
		||||
  projectId: 'n2sma2',
 | 
			
		||||
  e2e: {
 | 
			
		||||
    specPattern: 'cypress/integration/**/*.{js,jsx,ts,tsx}',
 | 
			
		||||
    setupNodeEvents(on, config) {
 | 
			
		||||
      coverage(on, config);
 | 
			
		||||
      addMatchImageSnapshotPlugin(on, config);
 | 
			
		||||
      // copy any needed variables from process.env to config.env
 | 
			
		||||
      config.env.useAppli = process.env.USE_APPLI ? true : false;
 | 
			
		||||
 | 
			
		||||
      // do not forget to return the changed config object!
 | 
			
		||||
      return config;
 | 
			
		||||
    },
 | 
			
		||||
  },
 | 
			
		||||
  video: false,
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
require('@applitools/eyes-cypress')(module);
 | 
			
		||||
@@ -1,39 +0,0 @@
 | 
			
		||||
import { defineConfig } from 'cypress';
 | 
			
		||||
import { addMatchImageSnapshotPlugin } from 'cypress-image-snapshot/plugin';
 | 
			
		||||
import coverage from '@cypress/code-coverage/task';
 | 
			
		||||
import eyesPlugin from '@applitools/eyes-cypress';
 | 
			
		||||
import { registerArgosTask } from '@argos-ci/cypress/task';
 | 
			
		||||
 | 
			
		||||
export default eyesPlugin(
 | 
			
		||||
  defineConfig({
 | 
			
		||||
    projectId: 'n2sma2',
 | 
			
		||||
    viewportWidth: 1440,
 | 
			
		||||
    viewportHeight: 1024,
 | 
			
		||||
    e2e: {
 | 
			
		||||
      specPattern: 'cypress/integration/**/*.{js,ts}',
 | 
			
		||||
      setupNodeEvents(on, config) {
 | 
			
		||||
        coverage(on, config);
 | 
			
		||||
        on('before:browser:launch', (browser, launchOptions) => {
 | 
			
		||||
          if (browser.name === 'chrome' && browser.isHeadless) {
 | 
			
		||||
            launchOptions.args.push('--window-size=1440,1024', '--force-device-scale-factor=1');
 | 
			
		||||
          }
 | 
			
		||||
          return launchOptions;
 | 
			
		||||
        });
 | 
			
		||||
        // copy any needed variables from process.env to config.env
 | 
			
		||||
        config.env.useAppli = process.env.USE_APPLI ? true : false;
 | 
			
		||||
        config.env.useArgos = !!process.env.CI;
 | 
			
		||||
 | 
			
		||||
        if (config.env.useArgos) {
 | 
			
		||||
          registerArgosTask(on, config, {
 | 
			
		||||
            token: 'fc3a35cf5200db928d65b2047861582d9444032b',
 | 
			
		||||
          });
 | 
			
		||||
        } else {
 | 
			
		||||
          addMatchImageSnapshotPlugin(on, config);
 | 
			
		||||
        }
 | 
			
		||||
        // do not forget to return the changed config object!
 | 
			
		||||
        return config;
 | 
			
		||||
      },
 | 
			
		||||
    },
 | 
			
		||||
    video: false,
 | 
			
		||||
  })
 | 
			
		||||
);
 | 
			
		||||
							
								
								
									
										93
									
								
								cypress/helpers/util.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										93
									
								
								cypress/helpers/util.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,93 @@
 | 
			
		||||
const utf8ToB64 = (str) => {
 | 
			
		||||
  return window.btoa(unescape(encodeURIComponent(str)));
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const batchId = 'mermaid-batch' + new Date().getTime();
 | 
			
		||||
 | 
			
		||||
export const mermaidUrl = (graphStr, options, api) => {
 | 
			
		||||
  const obj = {
 | 
			
		||||
    code: graphStr,
 | 
			
		||||
    mermaid: options,
 | 
			
		||||
  };
 | 
			
		||||
  const objStr = JSON.stringify(obj);
 | 
			
		||||
  let url = 'http://localhost:9000/e2e.html?graph=' + utf8ToB64(objStr);
 | 
			
		||||
  if (api) {
 | 
			
		||||
    url = 'http://localhost:9000/xss.html?graph=' + graphStr;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (options.listUrl) {
 | 
			
		||||
    cy.log(options.listId, ' ', url);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return url;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const imgSnapshotTest = (graphStr, _options = {}, api = false, validation = undefined) => {
 | 
			
		||||
  cy.log(_options);
 | 
			
		||||
  const options = Object.assign(_options);
 | 
			
		||||
  if (!options.fontFamily) {
 | 
			
		||||
    options.fontFamily = 'courier';
 | 
			
		||||
  }
 | 
			
		||||
  if (!options.sequence) {
 | 
			
		||||
    options.sequence = {};
 | 
			
		||||
  }
 | 
			
		||||
  if (!options.sequence || (options.sequence && !options.sequence.actorFontFamily)) {
 | 
			
		||||
    options.sequence.actorFontFamily = 'courier';
 | 
			
		||||
  }
 | 
			
		||||
  if (options.sequence && !options.sequence.noteFontFamily) {
 | 
			
		||||
    options.sequence.noteFontFamily = 'courier';
 | 
			
		||||
  }
 | 
			
		||||
  options.sequence.actorFontFamily = 'courier';
 | 
			
		||||
  options.sequence.noteFontFamily = 'courier';
 | 
			
		||||
  options.sequence.messageFontFamily = 'courier';
 | 
			
		||||
  if (options.sequence && !options.sequence.actorFontFamily) {
 | 
			
		||||
    options.sequence.actorFontFamily = 'courier';
 | 
			
		||||
  }
 | 
			
		||||
  if (!options.fontSize) {
 | 
			
		||||
    options.fontSize = '16px';
 | 
			
		||||
  }
 | 
			
		||||
  const url = mermaidUrl(graphStr, options, api);
 | 
			
		||||
  openURLAndVerifyRendering(url, options, validation);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const urlSnapshotTest = (url, _options, api = false, validation) => {
 | 
			
		||||
  const options = Object.assign(_options);
 | 
			
		||||
  openURLAndVerifyRendering(url, options, validation);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const renderGraph = (graphStr, options, api) => {
 | 
			
		||||
  const url = mermaidUrl(graphStr, options, api);
 | 
			
		||||
  openURLAndVerifyRendering(url, options);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const openURLAndVerifyRendering = (url, options, validation = undefined) => {
 | 
			
		||||
  const useAppli = Cypress.env('useAppli');
 | 
			
		||||
  const name = (options.name || cy.state('runnable').fullTitle()).replace(/\s+/g, '-');
 | 
			
		||||
 | 
			
		||||
  if (useAppli) {
 | 
			
		||||
    cy.log('Opening eyes ' + Cypress.spec.name + ' --- ' + name);
 | 
			
		||||
    cy.eyesOpen({
 | 
			
		||||
      appName: 'Mermaid',
 | 
			
		||||
      testName: name,
 | 
			
		||||
      batchName: Cypress.spec.name,
 | 
			
		||||
      batchId: batchId + Cypress.spec.name,
 | 
			
		||||
    });
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  cy.visit(url);
 | 
			
		||||
  cy.window().should('have.property', 'rendered', true);
 | 
			
		||||
  cy.get('svg').should('be.visible');
 | 
			
		||||
 | 
			
		||||
  if (validation) {
 | 
			
		||||
    cy.get('svg').should(validation);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (useAppli) {
 | 
			
		||||
    cy.log('Check eyes' + Cypress.spec.name);
 | 
			
		||||
    cy.eyesCheckWindow('Click!');
 | 
			
		||||
    cy.log('Closing eyes' + Cypress.spec.name);
 | 
			
		||||
    cy.eyesClose();
 | 
			
		||||
  } else {
 | 
			
		||||
    cy.matchImageSnapshot(name);
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
@@ -1,133 +0,0 @@
 | 
			
		||||
/* eslint-disable @typescript-eslint/no-explicit-any */
 | 
			
		||||
import { Buffer } from 'buffer';
 | 
			
		||||
import type { MermaidConfig } from '../../packages/mermaid/src/config.type.js';
 | 
			
		||||
 | 
			
		||||
interface CypressConfig {
 | 
			
		||||
  listUrl?: boolean;
 | 
			
		||||
  listId?: string;
 | 
			
		||||
  name?: string;
 | 
			
		||||
}
 | 
			
		||||
type CypressMermaidConfig = MermaidConfig & CypressConfig;
 | 
			
		||||
 | 
			
		||||
interface CodeObject {
 | 
			
		||||
  code: string | string[];
 | 
			
		||||
  mermaid: CypressMermaidConfig;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
const utf8ToB64 = (str: string): string => {
 | 
			
		||||
  return Buffer.from(decodeURIComponent(encodeURIComponent(str))).toString('base64');
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const batchId: string =
 | 
			
		||||
  'mermaid-batch-' +
 | 
			
		||||
  (Cypress.env('useAppli')
 | 
			
		||||
    ? Date.now().toString()
 | 
			
		||||
    : Cypress.env('CYPRESS_COMMIT') || Date.now().toString());
 | 
			
		||||
 | 
			
		||||
export const mermaidUrl = (
 | 
			
		||||
  graphStr: string | string[],
 | 
			
		||||
  options: CypressMermaidConfig,
 | 
			
		||||
  api: boolean
 | 
			
		||||
): string => {
 | 
			
		||||
  const codeObject: CodeObject = {
 | 
			
		||||
    code: graphStr,
 | 
			
		||||
    mermaid: options,
 | 
			
		||||
  };
 | 
			
		||||
  const objStr: string = JSON.stringify(codeObject);
 | 
			
		||||
  let url = `http://localhost:9000/e2e.html?graph=${utf8ToB64(objStr)}`;
 | 
			
		||||
  if (api && typeof graphStr === 'string') {
 | 
			
		||||
    url = `http://localhost:9000/xss.html?graph=${graphStr}`;
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  if (options.listUrl) {
 | 
			
		||||
    cy.log(options.listId, ' ', url);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  return url;
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const imgSnapshotTest = (
 | 
			
		||||
  graphStr: string,
 | 
			
		||||
  _options: CypressMermaidConfig = {},
 | 
			
		||||
  api = false,
 | 
			
		||||
  validation?: any
 | 
			
		||||
): void => {
 | 
			
		||||
  const options: CypressMermaidConfig = {
 | 
			
		||||
    ..._options,
 | 
			
		||||
    fontFamily: _options.fontFamily ?? 'courier',
 | 
			
		||||
    // @ts-ignore TODO: Fix type of fontSize
 | 
			
		||||
    fontSize: _options.fontSize ?? '16px',
 | 
			
		||||
    sequence: {
 | 
			
		||||
      ...(_options.sequence ?? {}),
 | 
			
		||||
      actorFontFamily: 'courier',
 | 
			
		||||
      noteFontFamily: _options.sequence?.noteFontFamily
 | 
			
		||||
        ? _options.sequence.noteFontFamily
 | 
			
		||||
        : 'courier',
 | 
			
		||||
      messageFontFamily: 'courier',
 | 
			
		||||
    },
 | 
			
		||||
  };
 | 
			
		||||
 | 
			
		||||
  const url: string = mermaidUrl(graphStr, options, api);
 | 
			
		||||
  openURLAndVerifyRendering(url, options, validation);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const urlSnapshotTest = (
 | 
			
		||||
  url: string,
 | 
			
		||||
  options: CypressMermaidConfig,
 | 
			
		||||
  _api = false,
 | 
			
		||||
  validation?: any
 | 
			
		||||
): void => {
 | 
			
		||||
  openURLAndVerifyRendering(url, options, validation);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const renderGraph = (
 | 
			
		||||
  graphStr: string | string[],
 | 
			
		||||
  options: CypressMermaidConfig = {},
 | 
			
		||||
  api = false
 | 
			
		||||
): void => {
 | 
			
		||||
  const url: string = mermaidUrl(graphStr, options, api);
 | 
			
		||||
  openURLAndVerifyRendering(url, options);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const openURLAndVerifyRendering = (
 | 
			
		||||
  url: string,
 | 
			
		||||
  options: CypressMermaidConfig,
 | 
			
		||||
  validation?: any
 | 
			
		||||
): void => {
 | 
			
		||||
  const name: string = (options.name ?? cy.state('runnable').fullTitle()).replace(/\s+/g, '-');
 | 
			
		||||
 | 
			
		||||
  cy.visit(url);
 | 
			
		||||
  cy.window().should('have.property', 'rendered', true);
 | 
			
		||||
  cy.get('svg').should('be.visible');
 | 
			
		||||
 | 
			
		||||
  if (validation) {
 | 
			
		||||
    cy.get('svg').should(validation);
 | 
			
		||||
  }
 | 
			
		||||
 | 
			
		||||
  verifyScreenshot(name);
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export const verifyScreenshot = (name: string): void => {
 | 
			
		||||
  const useAppli: boolean = Cypress.env('useAppli');
 | 
			
		||||
  const useArgos: boolean = Cypress.env('useArgos');
 | 
			
		||||
 | 
			
		||||
  if (useAppli) {
 | 
			
		||||
    cy.log(`Opening eyes ${Cypress.spec.name} --- ${name}`);
 | 
			
		||||
    cy.eyesOpen({
 | 
			
		||||
      appName: 'Mermaid',
 | 
			
		||||
      testName: name,
 | 
			
		||||
      batchName: Cypress.spec.name,
 | 
			
		||||
      batchId: batchId + Cypress.spec.name,
 | 
			
		||||
    });
 | 
			
		||||
    cy.log(`Check eyes ${Cypress.spec.name}`);
 | 
			
		||||
    cy.eyesCheckWindow('Click!');
 | 
			
		||||
    cy.log(`Closing eyes ${Cypress.spec.name}`);
 | 
			
		||||
    cy.eyesClose();
 | 
			
		||||
  } else if (useArgos) {
 | 
			
		||||
    cy.argosScreenshot(name, {
 | 
			
		||||
      threshold: 0.01,
 | 
			
		||||
    });
 | 
			
		||||
  } else {
 | 
			
		||||
    cy.matchImageSnapshot(name);
 | 
			
		||||
  }
 | 
			
		||||
};
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
import { renderGraph, verifyScreenshot } from '../../helpers/util.ts';
 | 
			
		||||
import { renderGraph } from '../../helpers/util.js';
 | 
			
		||||
describe('Configuration', () => {
 | 
			
		||||
  describe('arrowMarkerAbsolute', () => {
 | 
			
		||||
    it('should handle default value false of arrowMarkerAbsolute', () => {
 | 
			
		||||
@@ -117,53 +117,13 @@ describe('Configuration', () => {
 | 
			
		||||
    });
 | 
			
		||||
    it('should not taint the initial configuration when using multiple directives', () => {
 | 
			
		||||
      const url = 'http://localhost:9000/regression/issue-1874.html';
 | 
			
		||||
      cy.viewport(1440, 1024);
 | 
			
		||||
      cy.visit(url);
 | 
			
		||||
      cy.window().should('have.property', 'rendered', true);
 | 
			
		||||
      verifyScreenshot(
 | 
			
		||||
 | 
			
		||||
      cy.get('svg');
 | 
			
		||||
      cy.matchImageSnapshot(
 | 
			
		||||
        'configuration.spec-should-not-taint-initial-configuration-when-using-multiple-directives'
 | 
			
		||||
      );
 | 
			
		||||
    });
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  describe('suppressErrorRendering', () => {
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
      cy.on('uncaught:exception', (err, runnable) => {
 | 
			
		||||
        return !err.message.includes('Parse error on line');
 | 
			
		||||
      });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('should not render error diagram if suppressErrorRendering is set', () => {
 | 
			
		||||
      const url = 'http://localhost:9000/suppressError.html?suppressErrorRendering=true';
 | 
			
		||||
      cy.visit(url);
 | 
			
		||||
      cy.window().should('have.property', 'rendered', true);
 | 
			
		||||
      cy.get('#test')
 | 
			
		||||
        .find('svg')
 | 
			
		||||
        .should(($svg) => {
 | 
			
		||||
          // all failing diagrams should not appear!
 | 
			
		||||
          expect($svg).to.have.length(2);
 | 
			
		||||
          // none of the diagrams should be error diagrams
 | 
			
		||||
          expect($svg).to.not.contain('Syntax error');
 | 
			
		||||
        });
 | 
			
		||||
      verifyScreenshot(
 | 
			
		||||
        'configuration.spec-should-not-render-error-diagram-if-suppressErrorRendering-is-set'
 | 
			
		||||
      );
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('should render error diagram if suppressErrorRendering is not set', () => {
 | 
			
		||||
      const url = 'http://localhost:9000/suppressError.html';
 | 
			
		||||
      cy.visit(url);
 | 
			
		||||
      cy.window().should('have.property', 'rendered', true);
 | 
			
		||||
      cy.get('#test')
 | 
			
		||||
        .find('svg')
 | 
			
		||||
        .should(($svg) => {
 | 
			
		||||
          // all five diagrams should be rendered
 | 
			
		||||
          expect($svg).to.have.length(5);
 | 
			
		||||
          // some of the diagrams should be error diagrams
 | 
			
		||||
          expect($svg).to.contain('Syntax error');
 | 
			
		||||
        });
 | 
			
		||||
      verifyScreenshot(
 | 
			
		||||
        'configuration.spec-should-render-error-diagram-if-suppressErrorRendering-is-not-set'
 | 
			
		||||
      );
 | 
			
		||||
    });
 | 
			
		||||
  });
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
import { urlSnapshotTest } from '../../helpers/util.ts';
 | 
			
		||||
import { urlSnapshotTest } from '../../helpers/util.js';
 | 
			
		||||
 | 
			
		||||
describe('mermaid', () => {
 | 
			
		||||
  describe('registerDiagram', () => {
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
import { urlSnapshotTest, openURLAndVerifyRendering } from '../../helpers/util.ts';
 | 
			
		||||
import { urlSnapshotTest, openURLAndVerifyRendering } from '../../helpers/util.js';
 | 
			
		||||
 | 
			
		||||
describe('CSS injections', () => {
 | 
			
		||||
  it('should not allow CSS injections outside of the diagram', () => {
 | 
			
		||||
 
 | 
			
		||||
@@ -1,11 +0,0 @@
 | 
			
		||||
describe('IIFE', () => {
 | 
			
		||||
  beforeEach(() => {
 | 
			
		||||
    cy.visit('http://localhost:9000/iife.html');
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  it('should render when using mermaid.min.js', () => {
 | 
			
		||||
    cy.window().should('have.property', 'rendered', true);
 | 
			
		||||
    cy.get('svg').should('be.visible');
 | 
			
		||||
    cy.get('#d2').should('contain', 'Hello');
 | 
			
		||||
  });
 | 
			
		||||
});
 | 
			
		||||
@@ -1,12 +1,14 @@
 | 
			
		||||
describe('Rerendering', () => {
 | 
			
		||||
  it('should be able to render after an error has occurred', () => {
 | 
			
		||||
    const url = 'http://localhost:9000/render-after-error.html';
 | 
			
		||||
    cy.viewport(1440, 1024);
 | 
			
		||||
    cy.visit(url);
 | 
			
		||||
    cy.get('#graphDiv').should('exist');
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  it('should be able to render and rerender a graph via API', () => {
 | 
			
		||||
    const url = 'http://localhost:9000/rerender.html';
 | 
			
		||||
    cy.viewport(1440, 1024);
 | 
			
		||||
    cy.visit(url);
 | 
			
		||||
    cy.get('#graph [id^=flowchart-A]').should('have.text', 'XMas');
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										16
									
								
								cypress/integration/other/webpackUsage.spec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								cypress/integration/other/webpackUsage.spec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,16 @@
 | 
			
		||||
describe('Sequencediagram', () => {
 | 
			
		||||
  it('should render a simple sequence diagrams', () => {
 | 
			
		||||
    const url = 'http://localhost:9000/webpackUsage.html';
 | 
			
		||||
 | 
			
		||||
    cy.visit(url);
 | 
			
		||||
    cy.get('body').find('svg').should('have.length', 1);
 | 
			
		||||
  });
 | 
			
		||||
  it('should handle html escapings properly', () => {
 | 
			
		||||
    const url = 'http://localhost:9000/webpackUsage.html?test-html-escaping=true';
 | 
			
		||||
 | 
			
		||||
    cy.visit(url);
 | 
			
		||||
    cy.get('body').find('svg').should('have.length', 1);
 | 
			
		||||
 | 
			
		||||
    cy.get('g.label > foreignobject > div').should('not.contain.text', '<b>');
 | 
			
		||||
  });
 | 
			
		||||
});
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
import { mermaidUrl } from '../../helpers/util.ts';
 | 
			
		||||
import { mermaidUrl } from '../../helpers/util.js';
 | 
			
		||||
describe('XSS', () => {
 | 
			
		||||
  it('should handle xss in tags', () => {
 | 
			
		||||
    const str =
 | 
			
		||||
@@ -10,6 +10,7 @@ describe('XSS', () => {
 | 
			
		||||
    cy.wait(1000).then(() => {
 | 
			
		||||
      cy.get('.mermaid').should('exist');
 | 
			
		||||
    });
 | 
			
		||||
    cy.get('svg');
 | 
			
		||||
  });
 | 
			
		||||
 | 
			
		||||
  it('should not allow tags in the css', () => {
 | 
			
		||||
@@ -131,14 +132,4 @@ describe('XSS', () => {
 | 
			
		||||
    cy.wait(1000);
 | 
			
		||||
    cy.get('#the-malware').should('not.exist');
 | 
			
		||||
  });
 | 
			
		||||
  it('should sanitize backticks in class names properly', () => {
 | 
			
		||||
    cy.visit('http://localhost:9000/xss24.html');
 | 
			
		||||
    cy.wait(1000);
 | 
			
		||||
    cy.get('#the-malware').should('not.exist');
 | 
			
		||||
  });
 | 
			
		||||
  it('should sanitize backticks block diagram labels properly', () => {
 | 
			
		||||
    cy.visit('http://localhost:9000/xss25.html');
 | 
			
		||||
    cy.wait(1000);
 | 
			
		||||
    cy.get('#the-malware').should('not.exist');
 | 
			
		||||
  });
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,4 @@
 | 
			
		||||
import { imgSnapshotTest } from '../../helpers/util.ts';
 | 
			
		||||
import { imgSnapshotTest } from '../../helpers/util.js';
 | 
			
		||||
 | 
			
		||||
describe('Git Graph diagram', () => {
 | 
			
		||||
  it('1: should render a simple gitgraph with commit on main branch', () => {
 | 
			
		||||
@@ -11,27 +11,6 @@ describe('Git Graph diagram', () => {
 | 
			
		||||
      {}
 | 
			
		||||
    );
 | 
			
		||||
  });
 | 
			
		||||
  it('Should render subgraphs with title margins and edge labels', () => {
 | 
			
		||||
    imgSnapshotTest(
 | 
			
		||||
      `flowchart LR
 | 
			
		||||
 | 
			
		||||
          subgraph TOP
 | 
			
		||||
              direction TB
 | 
			
		||||
              subgraph B1
 | 
			
		||||
                  direction RL
 | 
			
		||||
                  i1 --lb1-->f1
 | 
			
		||||
              end
 | 
			
		||||
              subgraph B2
 | 
			
		||||
                  direction BT
 | 
			
		||||
                  i2 --lb2-->f2
 | 
			
		||||
              end
 | 
			
		||||
          end
 | 
			
		||||
          A --lb3--> TOP --lb4--> B
 | 
			
		||||
          B1 --lb5--> B2
 | 
			
		||||
        `,
 | 
			
		||||
      { flowchart: { subGraphTitleMargin: { top: 10, bottom: 5 } } }
 | 
			
		||||
    );
 | 
			
		||||
  });
 | 
			
		||||
  // it(`ultraFastTest`, function () {
 | 
			
		||||
  //   // Navigate to the url we want to test
 | 
			
		||||
  //   // ⭐️ Note to see visual bugs, run the test using the above URL for the 1st run.
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user