Revert "chore(deps-dev): bump documentation from 13.2.0 to 14.0.0"

Merge pull request #3342 from mermaid-js/dependabot/npm_and_yarn/develop/prettier-plugin-jsdoc-0.4.1
chore(deps-dev): bump prettier-plugin-jsdoc from 0.3.38 to 0.4.1
2025-08-24 10:46:50 +02:00 · 2022-08-23 18:32:20 +02:00 · 2022-08-23 17:51:44 +02:00 · 2022-08-23 17:51:31 +02:00 · 2022-08-23 17:50:49 +02:00 · 2022-08-23 17:49:10 +02:00
10 changed files with 94 additions and 103 deletions
--- a/cypress/helpers/util.js
+++ b/cypress/helpers/util.js
@@ -42,8 +42,8 @@ export const imgSnapshotTest = (graphStr, _options, api = false, validation) =>
  if (!options.fontSize) {
    options.fontSize = '16px';
  }
-  // const useAppli = Cypress.env('useAppli');
-  const useAppli = false;
+  const useAppli = Cypress.env('useAppli');
+  //const useAppli = false;
  const branch = Cypress.env('codeBranch');
  cy.log('Hello ' + useAppli ? 'Appli' : 'image-snapshot');
  const name = (options.name || cy.state('runnable').fullTitle()).replace(/\s+/g, '-');
--- a/cypress/platform/knsv.html
+++ b/cypress/platform/knsv.html
@@ -15,6 +15,8 @@
        /* font-size: 18px !important; */
        width: 100%;
        display: flex;
+        flex-direction: column;
+        margin-left: 20px;
        }
      h1 { color: grey;}
      .mermaid2,.mermaid3 {
@@ -31,26 +33,30 @@


 <div class="mermaid2" style="width: 50%;">
-journey
-    title My working day
-    section Go to work
-      Make tea: 5: Me
-      Go upstairs: 3: Me
-      Do work: 1: Me, Cat
-    section Go home
-      Go downstairs: 5: Me
-      Sit down: 5: Mee
-</div>
-<div class="mermaid2" style="width: 50%;">
-   pie
-      accTitle: My Pie Chart Accessibility Title
-      accDescr: My Pie Chart Accessibility Description
+flowchart LR
+  classDef aPID stroke:#4e4403,fill:#fdde29,color:#4e4403,rx:5px,ry:5px;
+  classDef crm stroke:#333333,fill:#DCDCDC,color:#333333,rx:5px,ry:5px;
+  classDef type stroke:#502604,fill:#FAB565,color:#502604,rx:20px,ry:20px;;

-    title Key elements in Product X
-    "Calcium" : 42.96
-    "Potassium" : 50.05
-    "Magnesium" : 10.01
-    "Iron" :  5
+  O0("Joe")
+  class O0 aPID;
+
+  O1("Person")
+  class O1 crm;
+  O0 -- has type -->O1["Person"]
+
+  O2("aat:300411314")
+  class O2 type;
+  click O2 function "Sorry the newline html tags are not being processed correctly<br/> So all of this appears on the <br/> same line."
+  O0 -- has type -->O2["Bug"]
+  click O0 function "Lots of great info about Joe<br>Lots of great info about Joe<br>burt<br>fred";
+</div>
+<div class="mermaid" style="width: 50%;">
+classDiagram-v2
+  class Shape
+  link Shape "https://www.github.com" "This is a<br/>tooltip<br>for a link"
+  class Shape2
+  click Shape2 href "https://www.github.com" "This is a tooltip for a link"
 </div>
 <div class="mermaid2" style="width: 50%;">
 gitGraph
@@ -217,7 +223,7 @@ class Class10 {
  size()
 }
      </div>
-      <div class="mermaid" style="width: 100%;">
+      <div class="mermaid2" style="width: 100%;">
 %%{init: {'config': {'wrap': true }}}%%
        sequenceDiagram
        participant A as Extremely utterly long line of longness which had previously overflown the actor box as it is much longer than what it should be
@@ -297,47 +303,15 @@ flowchart TD
        // console.error('Mermaid error: ', err);
      };
      mermaid.initialize({
-        // theme: 'dark',
-        // theme: 'forest',
-        // arrowMarkerAbsolute: true,
-        // themeCSS: '.edgePath .path {stroke: red;} .arrowheadPath {fill: red;}',
-        flowchart: {
-    nodeSpacing: 10,
-    curve: 'cardinal',
-    htmlLabels: true,
-    useMaxWidth: false,
-    // defaultRenderer: 'dagre-d3',
-  },
-  class: {
-    // defaultRenderer: 'dagre-d3',
-    htmlLabels: true,
-  },
-  sequence: {
-    // mirrorActors: false,'
-    wrap: false,
-  },
-        // gantt: { axisFormat: '%m/%d/%Y' },
-  //       sequence: {
-  //   actorFontFamily: 'courier',
-  //   actorMargin: 50,
-  //   showSequenceNumbers: false,
-  //   // hideUnusedParticipants: true,
-  //   // forceMenus: true,
-  // },
-  //       // sequenceDiagram: { actorMargin: 300, forceMenus: false }, // deprecated
-        // fontFamily: '"times", sans-serif',
-        // fontFamily: 'courier',
-        state: {
-          nodeSpacing: 50,
-          rankSpacing: 50,
-          defaultRenderer: 'dagre-d3',
-        },
+        maxTextSize: 900000,
+        startOnLoad: true,
+        securityLevel: 'loose',
        logLevel: 0,
-        fontSize: 18,
-        curve: 'cardinal',
-        // securityLevel: 'sandbox',
-        // themeVariables: {relationLabelColor: 'red'}
-        wrap: true,
+        flowchart: {
+          curve: 'basis',
+          useMaxWidth: false,
+          htmlLabels: true,
+        },
      });
      function callback() {
  alert('It worked');
--- a/docs/Setup.md
+++ b/docs/Setup.md
@@ -1471,6 +1471,21 @@ Returns **any** The currentConfig merged with the sanitized conf

 Returns **any** The currentConfig

+## sanitize
+
+## sanitize
+
+| Function | Description                            | Type        | Values |
+| -------- | -------------------------------------- | ----------- | ------ |
+| sanitize | Sets the siteConfig to desired values. | Put Request | None   |
+
+Ensures options parameter does not attempt to override siteConfig secure keys **Notes**: modifies
+options in-place
+
+### Parameters
+
+-   `options` **any** The potential setConfig parameter
+
 ## render

 Function that renders an svg with a graph from a chart definition. Usage example below.
@@ -1499,21 +1514,6 @@ $(function () {

 Returns **any** 

-## sanitize
-
-## sanitize
-
-| Function | Description                            | Type        | Values |
-| -------- | -------------------------------------- | ----------- | ------ |
-| sanitize | Sets the siteConfig to desired values. | Put Request | None   |
-
-Ensures options parameter does not attempt to override siteConfig secure keys **Notes**: modifies
-options in-place
-
-### Parameters
-
-   `options` **any** The potential setConfig parameter
-
 ## addDirective

 Pushes in a directive to the configuration
--- a/docs/index.html
+++ b/docs/index.html
@@ -18,7 +18,7 @@
    <!-- <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css"> -->
    <link rel="stylesheet" href="theme.css" />
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.9.0/css/all.min.css">
-    <script src="//cdn.jsdelivr.net/npm/mermaid@9.1.3/dist/mermaid.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/mermaid@9.1.5/dist/mermaid.min.js"></script>
    <!-- <script src="http://localhost:9000/mermaid.js"></script> -->
    <script>
      // prettier-ignore
--- a/package.json
+++ b/package.json
@@ -1,12 +1,12 @@
 {
  "name": "mermaid",
-  "version": "9.1.4",
+  "version": "9.1.5",
  "description": "Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.",
-  "main": "dist/mermaid.core.js",
+  "main": "dist/mermaid.min.js",
  "module": "dist/mermaid.esm.min.mjs",
  "exports": {
    ".": {
-      "require": "./dist/mermaid.core.js",
+      "require": "./dist/mermaid.min.js",
      "import": "./dist/mermaid.esm.min.mjs"
    },
    "./*": "./*"
@@ -65,7 +65,7 @@
    "dompurify": "2.3.10",
    "graphlib": "^2.1.8",
    "khroma": "^2.0.0",
-    "moment-mini": "^2.24.0",
+    "moment-mini": "2.24.0",
    "stylis": "^4.0.10"
  },
  "devDependencies": {
@@ -103,7 +103,7 @@
    "moment": "^2.23.0",
    "path-browserify": "^1.0.1",
    "prettier": "^2.3.2",
-    "prettier-plugin-jsdoc": "^0.3.30",
+    "prettier-plugin-jsdoc": "^0.4.1",
    "start-server-and-test": "^1.12.6",
    "terser-webpack-plugin": "^5.2.4",
    "webpack": "^5.53.0",
--- a/src/diagrams/class/classDb.js
+++ b/src/diagrams/class/classDb.js
@@ -206,7 +206,9 @@ const setTooltip = function (ids, tooltip) {
    }
  });
 };
-
+export const getTooltip = function (id) {
+  return classes[id].tooltip;
+};
 /**
 * Called by parser when a link is found. Adds the URL to the vertex data.
 *
@@ -337,6 +339,7 @@ const setupToolTips = function (element) {
        .text(el.attr('title'))
        .style('left', window.scrollX + rect.left + (rect.right - rect.left) / 2 + 'px')
        .style('top', window.scrollY + rect.top - 14 + document.body.scrollTop + 'px');
+      tooltipElem.html(tooltipElem.html().replace(/&lt;br\/&gt;/g, '<br/>'));
      el.classed('hover', true);
    })
    .on('mouseout', function () {
@@ -378,6 +381,7 @@ export default {
  setClickEvent,
  setCssClass,
  setLink,
+  getTooltip,
  setTooltip,
  lookUpDomId,
 };
--- a/src/diagrams/class/classDiagram.spec.js
+++ b/src/diagrams/class/classDiagram.spec.js
@@ -14,7 +14,16 @@ describe('class diagram, ', function () {

      parser.parse(str);
    });
+    xit('should handle a leading newline axa', function () {
+      const str = '\nclassDiagram\n' + 'class Car';

+      try {
+        parser.parse(str);
+        // Fail test if above expression doesn't throw anything.
+      } catch (e) {
+        expect(true).toBe(false);
+      }
+    });
    it('should handle relation definitions', function () {
      const str =
        'classDiagram\n' +
--- a/src/diagrams/class/classRenderer-v2.js
+++ b/src/diagrams/class/classRenderer-v2.js
@@ -29,8 +29,10 @@ let conf = {
 * >} classes
 *   Object containing the vertices.
 * @param {SVGGElement} g The graph that is to be drawn.
+ * @param _id
+ * @param diagObj
 */
-export const addClasses = function (classes, g) {
+export const addClasses = function (classes, g, _id, diagObj) {
  // const svg = select(`[id="${svgId}"]`);
  const keys = Object.keys(classes);
  log.info('keys:', keys);
@@ -108,6 +110,7 @@ export const addClasses = function (classes, g) {
      style: styles.style,
      id: vertex.id,
      domId: vertex.domId,
+      tooltip: diagObj.db.getTooltip(vertex.id) || '',
      haveCallback: vertex.haveCallback,
      link: vertex.link,
      width: vertex.type === 'group' ? 500 : undefined,
@@ -319,7 +322,7 @@ export const draw = function (text, id, _version, diagObj) {
  const relations = diagObj.db.getRelations();

  log.info(relations);
-  addClasses(classes, g, id);
+  addClasses(classes, g, id, diagObj);
  addRelations(relations, g);

  // Add custom shapes
--- a/src/diagrams/flowchart/flowDb.js
+++ b/src/diagrams/flowchart/flowDb.js
@@ -409,6 +409,7 @@ const setupToolTips = function (element) {
        .text(el.attr('title'))
        .style('left', window.scrollX + rect.left + (rect.right - rect.left) / 2 + 'px')
        .style('top', window.scrollY + rect.top - 14 + document.body.scrollTop + 'px');
+      tooltipElem.html(tooltipElem.html().replace(/&lt;br\/&gt;/g, '<br/>'));
      el.classed('hover', true);
    })
    .on('mouseout', function () {
--- a/yarn.lock
+++ b/yarn.lock
@@ -3506,9 +3506,9 @@ camelcase@^6.2.0:
  integrity sha512-c7wVvbw3f37nuobQNtgsgG9POC9qMbNuMQmTCqZv23b6MIz0fcYpBiOlv9gEN/hdLdnZTDQhg6e9Dq5M1vKvfg==

 caniuse-lite@^1.0.30001359:
-  version "1.0.30001376"
-  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001376.tgz"
-  integrity sha512-I27WhtOQ3X3v3it9gNs/oTpoE5KpwmqKR5oKPA8M0G7uMXh9Ty81Q904HpKUrM30ei7zfcL5jE7AXefgbOfMig==
+  version "1.0.30001381"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001381.tgz"
+  integrity sha512-fEnkDOKpvp6qc+olg7+NzE1SqyfiyKf4uci7fAU38M3zxs0YOyKOxW/nMZ2l9sJbt7KZHcDIxUnbI0Iime7V4w==

 caseless@~0.12.0:
  version "0.12.0"
@@ -5222,9 +5222,9 @@ eslint-plugin-html@^7.1.0:
    htmlparser2 "^8.0.1"

 eslint-plugin-jest@^26.0.0:
-  version "26.8.2"
-  resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-26.8.2.tgz#42a1248a5ade2bc589eb0f9c4e0608dd89b18cf3"
-  integrity sha512-67oh0FKaku9y48OpLzL3uK9ckrgLb83Sp5gxxTbtOGDw9lq6D8jw/Psj/9CipkbK406I2M7mvx1q+pv/MdbvxA==
+  version "26.8.7"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-jest/-/eslint-plugin-jest-26.8.7.tgz#f38f067d0a69483d64578eb43508ca7b29c8a4b7"
+  integrity sha512-nJJVv3VY6ZZvJGDMC8h1jN/TIGT4We1JkNn1lvstPURicr/eZPVnlFULQ4W2qL9ByCuCr1hPmlBOc2aZ1ktw4Q==
  dependencies:
    "@typescript-eslint/utils" "^5.10.0"

@@ -8598,10 +8598,10 @@ module-deps-sortable@^5.0.3:
    through2 "^2.0.0"
    xtend "^4.0.0"

-moment-mini@^2.24.0:
-  version "2.29.4"
-  resolved "https://registry.yarnpkg.com/moment-mini/-/moment-mini-2.29.4.tgz#cbbcdc58ce1b267506f28ea6668dbe060a32758f"
-  integrity sha512-uhXpYwHFeiTbY9KSgPPRoo1nt8OxNVdMVoTBYHfSEKeRkIkwGpO+gERmhuhBtzfaeOyTkykSrm2+noJBgqt3Hg==
+moment-mini@2.24.0:
+  version "2.24.0"
+  resolved "https://registry.yarnpkg.com/moment-mini/-/moment-mini-2.24.0.tgz#fa68d98f7fe93ae65bf1262f6abb5fb6983d8d18"
+  integrity sha512-9ARkWHBs+6YJIvrIp0Ik5tyTTtP9PoV0Ssu2Ocq5y9v8+NOOpWiRshAp8c4rZVWTOe+157on/5G+zj5pwIQFEQ==

 moment@^2.23.0:
  version "2.29.4"
@@ -9340,10 +9340,10 @@ prettier-linter-helpers@^1.0.0:
  dependencies:
    fast-diff "^1.1.2"

-prettier-plugin-jsdoc@^0.3.30:
-  version "0.3.38"
-  resolved "https://registry.yarnpkg.com/prettier-plugin-jsdoc/-/prettier-plugin-jsdoc-0.3.38.tgz#b8adbe9efc1dc11f3cc5ff0b07e0233a0fdf533d"
-  integrity sha512-h81ZV/nFk5gr3fzWMWzWoz/M/8FneAZxscT7DVSy+5jMIuWYnBFZfSswVKYZyTaZ5r6+6k4hpFTDWhRp85C1tg==
+prettier-plugin-jsdoc@^0.4.1:
+  version "0.4.1"
+  resolved "https://registry.yarnpkg.com/prettier-plugin-jsdoc/-/prettier-plugin-jsdoc-0.4.1.tgz#3ab15b8c50203b4ff3287e3df6a7034387aebede"
+  integrity sha512-wWs43HdlGoOAqD/LZQ6SpXujRkZ7YzoFC5bCfClBdrlTesZBGBB1cTAUS6ofJnkfNQyiNXNnRAo6Rl56uBTxnQ==
  dependencies:
    binary-searching "^2.0.5"
    comment-parser "^1.3.1"
@@ -10876,9 +10876,9 @@ terminal-link@^2.0.0:
    supports-hyperlinks "^2.0.0"

 terser-webpack-plugin@^5.1.3, terser-webpack-plugin@^5.2.4:
-  version "5.3.4"
-  resolved "https://registry.yarnpkg.com/terser-webpack-plugin/-/terser-webpack-plugin-5.3.4.tgz#f4d31e265883d20fda3ca9c0fc6a53f173ae62e3"
-  integrity sha512-SmnkUhBxLDcBfTIeaq+ZqJXLVEyXxSaNcCeSezECdKjfkMrTTnPvapBILylYwyEvHFZAn2cJ8dtiXel5XnfOfQ==
+  version "5.3.5"
+  resolved "https://registry.yarnpkg.com/terser-webpack-plugin/-/terser-webpack-plugin-5.3.5.tgz#f7d82286031f915a4f8fb81af4bd35d2e3c011bc"
+  integrity sha512-AOEDLDxD2zylUGf/wxHxklEkOe2/r+seuyOWujejFrIxHf11brA1/dWQNIgXa1c6/Wkxgu7zvv0JhOWfc2ELEA==
  dependencies:
    "@jridgewell/trace-mapping" "^0.3.14"
    jest-worker "^27.4.5"
Author	SHA1	Message	Date
Knut Sveidqvist	576445847c	Revert "chore(deps-dev): bump documentation from 13.2.0 to 14.0.0"	2022-08-23 18:32:20 +02:00
Knut Sveidqvist	9ef3164991	Merge pull request #3342 from mermaid-js/dependabot/npm_and_yarn/develop/prettier-plugin-jsdoc-0.4.1 chore(deps-dev): bump prettier-plugin-jsdoc from 0.3.38 to 0.4.1	2022-08-23 17:51:44 +02:00
Knut Sveidqvist	b0b54f48f9	Merge pull request #3343 from mermaid-js/dependabot/npm_and_yarn/develop/terser-webpack-plugin-5.3.5 chore(deps-dev): bump terser-webpack-plugin from 5.3.4 to 5.3.5	2022-08-23 17:51:31 +02:00
Knut Sveidqvist	35ba62bae2	Merge pull request #3344 from mermaid-js/dependabot/npm_and_yarn/develop/documentation-14.0.0 chore(deps-dev): bump documentation from 13.2.0 to 14.0.0	2022-08-23 17:50:49 +02:00
Knut Sveidqvist	ea0e9aa7f4	Merge pull request #3345 from mermaid-js/dependabot/npm_and_yarn/develop/eslint-plugin-jest-26.8.7 chore(deps-dev): bump eslint-plugin-jest from 26.8.2 to 26.8.7	2022-08-23 17:49:10 +02:00
mmorel-35	6e16369d85	chore: update browsers list	2022-08-22 07:04:25 +00:00
dependabot[bot]	8caeeccea3	chore(deps-dev): bump eslint-plugin-jest from 26.8.2 to 26.8.7 Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 26.8.2 to 26.8.7. - [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases) - [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md) - [Commits](https://github.com/jest-community/eslint-plugin-jest/compare/v26.8.2...v26.8.7) --- updated-dependencies: - dependency-name: eslint-plugin-jest dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-08-22 07:03:36 +00:00
dependabot[bot]	102542b4e7	chore(deps-dev): bump documentation from 13.2.0 to 14.0.0 Bumps [documentation](https://github.com/documentationjs/documentation) from 13.2.0 to 14.0.0. - [Release notes](https://github.com/documentationjs/documentation/releases) - [Changelog](https://github.com/documentationjs/documentation/blob/master/CHANGELOG.md) - [Commits](https://github.com/documentationjs/documentation/compare/v13.2.0...v14.0.0) --- updated-dependencies: - dependency-name: documentation dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>	2022-08-22 07:03:21 +00:00
dependabot[bot]	05d664d8d1	chore(deps-dev): bump terser-webpack-plugin from 5.3.4 to 5.3.5 Bumps [terser-webpack-plugin](https://github.com/webpack-contrib/terser-webpack-plugin) from 5.3.4 to 5.3.5. - [Release notes](https://github.com/webpack-contrib/terser-webpack-plugin/releases) - [Changelog](https://github.com/webpack-contrib/terser-webpack-plugin/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/terser-webpack-plugin/compare/v5.3.4...v5.3.5) --- updated-dependencies: - dependency-name: terser-webpack-plugin dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-08-22 07:02:55 +00:00
dependabot[bot]	8fa57b0b14	chore(deps-dev): bump prettier-plugin-jsdoc from 0.3.38 to 0.4.1 Bumps [prettier-plugin-jsdoc](https://github.com/hosseinmd/prettier-plugin-jsdoc) from 0.3.38 to 0.4.1. - [Release notes](https://github.com/hosseinmd/prettier-plugin-jsdoc/releases) - [Changelog](https://github.com/hosseinmd/prettier-plugin-jsdoc/blob/master/CHANGELOG.md) - [Commits](https://github.com/hosseinmd/prettier-plugin-jsdoc/commits) --- updated-dependencies: - dependency-name: prettier-plugin-jsdoc dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2022-08-22 07:02:42 +00:00
Knut Sveidqvist	858f2eadd4	Merge pull request #3338 from mermaid-js/fix/3009 Fix #3009 Update main in package.json	2022-08-21 11:38:51 +02:00
Sidharth Vinod	bc2b4c57c9	Fix #3009 Update main	2022-08-21 15:06:50 +05:30
Knut Sveidqvist	280c7e8da1	#3243 Adding disabled testcase for diagram with leading \n	2022-08-21 11:05:13 +02:00
Knut Sveidqvist	a89b6fd054	Merge branch 'master' into develop	2022-08-18 19:57:58 +02:00
Knut Sveidqvist	02fc68a3f6	Merge pull request #3330 from mermaid-js/3306_Fix_Gitgraph_Parsing_Issue Fix for GitGraphs not working for Mermaid Live Editor	2022-08-18 19:43:17 +02:00
Ashish Jain	b65c67ec2c	Merge pull request #3331 from mermaid-js/3308_allow_br_in_tooltips #3308 Allowing br tags in tooltips	2022-08-18 19:16:23 +02:00
Knut Sveidqvist	1befbe08ff	#3308 Allowing br tags in tooltips	2022-08-18 19:11:33 +02:00
Knut Sveidqvist	808bcb8022	Updated version for the docs	2022-08-11 20:34:26 +02:00
Knut Sveidqvist	af8a5cbbfa	Version 9.1.5	2022-08-11 20:29:15 +02:00