added words to cspell ignore words list, removed mywords.txt

.eslintrc.json

@@ -55,8 +55,7 @@
       {
         "checkIdentifiers": false,
         "checkStrings": false,
-        "checkStringTemplates": false,
-        "customWordListFile": { "path": "./myWords.txt" }
+        "checkStringTemplates": false
       }
     ]
   },

cSpell.json

@@ -13,7 +13,8 @@
     "sandboxed",
     "Sveidqvist",
     "verdana",
-    "Visio"
+    "Visio",
+    "mermiad"
   ],
   "ignoreWords": [
     "Adamiecki",
@@ -38,7 +39,20 @@
     "Podlite",
     "redmine",
     "sphinxcontrib",
-    "Tuleap"
+    "Tuleap",
+    "dagre",
+    "vitepress",
+    "docsify",
+    "colour",
+    "graphlib",
+    "acyclicer",
+    "ranksep",
+    "descr",
+    "substate",
+    "Ashish",
+    "bbox",
+    "techn",
+    "cytoscape"
   ],
   "patterns": [
     {

cypress/helpers/util.js

@@ -45,7 +45,6 @@ export const imgSnapshotTest = (graphStr, _options, api = false, validation) =>
     options.fontSize = '16px';
   }
   const useAppli = Cypress.env('useAppli');
-  //const useAppli = false;
   cy.log('Hello ' + useAppli ? 'Appli' : 'image-snapshot');
   const name = (options.name || cy.state('runnable').fullTitle()).replace(/\s+/g, '-');
 

cypress/platform/xss21.html

@@ -94,7 +94,7 @@
       }
 
       //       var diagram = `  graph TD
-      // A --> B["<a href='javasc`;
+      // A --> B["<a href='javascript`;
       // diagram += `ript#colon;xssAttack()'>AAA</a>"]`;
       var diagram = `  graph TD
 A --> B["<a href='javasc`;

myWords.txt

@@ -1,14 +0,0 @@
-customizability
-Gantt
-jison
-knsv
-Knut
-mindmap
-Mindmaps
-mitigations
-sandboxed
-Sveidqvist
-verdana
-Visio
-vitepress
-colour

packages/mermaid-example-diagram/src/detector.ts

@@ -2,7 +2,7 @@
 export const id = 'example-diagram';
 
 /**
- * Detector function that will be called by mermaid to determine if the diagram is this type of digram.
+ * Detector function that will be called by mermaid to determine if the diagram is this type of diagram.
  *
  * @param txt The diagram text will be passed to the detector
  * @returns True if the diagram text matches a diagram of this type

packages/mermaid-example-diagram/src/exampleDiagramRenderer.js

@@ -16,7 +16,7 @@ export const draw = (text, id, version) => {
     log.debug('Rendering example diagram\n' + text, 'Conf: ');
     const THEME_COLOR_LIMIT = getConfig().themeVariables.THEME_COLOR_LIMIT;
     const securityLevel = getConfig().securityLevel;
-    // Handle root and Document for when rendering in sanbox mode
+    // Handle root and Document for when rendering in sandbox mode
     let sandboxElement;
     if (securityLevel === 'sandbox') {
       sandboxElement = select('#i' + id);

packages/mermaid-mindmap/src/mindmapRenderer.js

@@ -11,7 +11,7 @@ cytoscape.use(coseBilkent);
 
 /**
  * @param {any} svg The svg element to draw the diagram onto
- * @param {object} mindmap The maindmap data and hierarchy
+ * @param {object} mindmap The mindmap data and hierarchy
  * @param section
  * @param {object} conf The configuration object
  */
@@ -52,7 +52,7 @@ function drawEdges(edgesEl, cy) {
 
 /**
  * @param {any} svg The svg element to draw the diagram onto
- * @param {object} mindmap The maindmap data and hierarchy
+ * @param {object} mindmap The mindmap data and hierarchy
  * @param section
  * @param cy
  * @param {object} conf The configuration object
@@ -96,7 +96,6 @@ function addNodes(mindmap, cy, conf, level) {
 /**
  * @param node
  * @param conf
- * @param cy
  */
 function layoutMindmap(node, conf) {
   return new Promise((resolve) => {
@@ -121,7 +120,7 @@ function layoutMindmap(node, conf) {
     renderEl.remove();
     addNodes(node, cy, conf, 0);
 
-    // Make cytoscape care about the dimensisions of the nodes
+    // Make cytoscape care about the dimensions of the nodes
     cy.nodes().forEach(function (n) {
       n.layoutDimensions = () => {
         const data = n.data();
@@ -143,10 +142,7 @@ function layoutMindmap(node, conf) {
   });
 }
 /**
- * @param node
  * @param cy
- * @param positionedMindmap
- * @param conf
  */
 function positionNodes(cy) {
   cy.nodes().map((node, id) => {
@@ -184,7 +180,7 @@ export const draw = async (text, id, version, diagObj) => {
   log.debug('Renering info diagram\n' + text);
 
   const securityLevel = getConfig().securityLevel;
-  // Handle root and Document for when rendering in sanbox mode
+  // Handle root and Document for when rendering in sandbox mode
   let sandboxElement;
   if (securityLevel === 'sandbox') {
     sandboxElement = select('#i' + id);

packages/mermaid/src/Diagram.ts

@@ -79,7 +79,7 @@ export const getDiagramFromText = async (txt: string, parseError?: Function) =>
     if (!loader) {
       throw new Error(`Diagram ${type} not found.`);
     }
-    // Diagram not avaiable, loading it
+    // Diagram not available, loading it
     // const path = getPathForDiagram(type);
     const { diagram } = await loader(); // eslint-disable-line @typescript-eslint/no-explicit-any
     registerDiagram(

packages/mermaid/src/config.ts

@@ -166,7 +166,7 @@ export const sanitize = (options: any) => {
     }
   });
   // Check that there no attempts of xss, there should be no tags at all in the directive
-  // blocking data urls as base64 urls can contain svgs with inline script tags
+  // blocking data urls as base64 urls can contain svg's with inline script tags
   Object.keys(options).forEach((key) => {
     if (typeof options[key] === 'string') {
       if (

packages/mermaid/src/dagre-wrapper/edges.js

@@ -310,7 +310,7 @@ const cutPathAtIntersect = (_points, boundryNode) => {
     // const node = clusterDb[edge.toCluster].node;
     log.info('abc88 checking point', point, boundryNode);
 
-    // check if point is inside the boundry rect
+    // check if point is inside the boundary rect
     if (!outsideNode(boundryNode, point) && !isInside) {
       // First point inside the rect found
       // Calc the intersection coord between the point anf the last point outside the rect
@@ -429,7 +429,7 @@ export const insertEdge = function (elem, e, edge, clusterDb, diagramType, graph
     })
     .curve(curve);
 
-  // Contruct stroke classes based on properties
+  // Construct stroke classes based on properties
   let strokeClasses;
   switch (edge.thickness) {
     case 'normal':

packages/mermaid/src/dagre-wrapper/intersect/index.js

@@ -1,5 +1,6 @@
 /*
- * Borrowed with love from from dagrge-d3. Many thanks to cpettitt!
+ // eslint-disable-next-line @cspell/spellchecker
+ * Borrowed with love from from dagre-d3. Many thanks to cpettitt!
  */
 
 import node from './intersect-node.js';

packages/mermaid/src/dagre-wrapper/intersect/intersect-line.js

@@ -7,6 +7,7 @@
  * @param q2
  */
 function intersectLine(p1, p2, q1, q2) {
+  // eslint-disable-next-line @cspell/spellchecker
   // Algorithm from J. Avro, (ed.) Graphics Gems, No 2, Morgan Kaufmann, 1994,
   // p7 and p473.
 
@@ -28,7 +29,7 @@ function intersectLine(p1, p2, q1, q2) {
   // Check signs of r3 and r4. If both point 3 and point 4 lie on
   // same side of line 1, the line segments do not intersect.
   if (r3 !== 0 && r4 !== 0 && sameSign(r3, r4)) {
-    return /*DONT_INTERSECT*/;
+    return /*DON'T_INTERSECT*/;
   }
 
   // Compute a2, b2, c2 where line joining points 3 and 4 is G(x,y) = a2 x + b2 y + c2 = 0
@@ -44,7 +45,7 @@ function intersectLine(p1, p2, q1, q2) {
   // on same side of second line segment, the line segments do
   // not intersect.
   if (r1 !== 0 && r2 !== 0 && sameSign(r1, r2)) {
-    return /*DONT_INTERSECT*/;
+    return /*DON'T_INTERSECT*/;
   }
 
   // Line segments intersect: compute intersection point.

packages/mermaid/src/dagre-wrapper/mermaid-graphlib.js

@@ -235,7 +235,7 @@ export const adjustClustersAndEdges = (graph, depth) => {
 
         // Check if any edge leaves the cluster (not the actual cluster, that's a link from the box)
         if (edge.v !== id && edge.w !== id) {
-          // Any edge where either the one of the nodes is decending to the cluster but not the other
+          // Any edge where either the one of the nodes is descending to the cluster but not the other
           // if (decendants[id].indexOf(edge.v) < 0 && decendants[id].indexOf(edge.w) < 0) {
 
           const d1 = isDecendant(edge.v, id);

packages/mermaid/src/dagre-wrapper/nodes.js

@@ -291,7 +291,7 @@ const cylinder = (parent, node) => {
         (Math.abs(x) == node.width / 2 && Math.abs(pos.y - node.y) > node.height / 2 - ry))
     ) {
       // ellipsis equation: x*x / a*a + y*y / b*b = 1
-      // solve for y to get adjustion value for pos.y
+      // solve for y to get adjusted value for pos.y
       let y = ry * ry * (1 - (x * x) / (rx * rx));
       if (y != 0) y = Math.sqrt(y);
       y = ry - y;

packages/mermaid/src/defaultConfig.ts

@@ -119,10 +119,12 @@ const config: Partial<MermaidConfig> = {
   /**
    * This option controls if the generated ids of nodes in the SVG are generated randomly or based
    * on a seed. If set to false, the IDs are generated based on the current date and thus are not
+   // eslint-disable-next-line @cspell/spellchecker
    * deterministic. This is the default behaviour.
    *
    * **Notes**:
    *
+   // eslint-disable-next-line @cspell/spellchecker
    * This matters if your files are checked into sourcecontrol e.g. git and should not change unless
    * content is changed.
    *
@@ -1168,7 +1170,7 @@ const config: Partial<MermaidConfig> = {
      * | --------------- | ----------- | ------- | -------- | ------------------ |
      * | c4BoundaryInRow | See Notes   | Integer | Required | Any Positive Value |
      *
-     * **Notes:** How many boundarys to place in each row.
+     * **Notes:** How many boundaries to place in each row.
      *
      * Default value: 2
      */

packages/mermaid/src/diagram-api/diagramAPI.ts

@@ -7,9 +7,9 @@ import { setupGraphViewbox as _setupGraphViewbox } from '../setupGraphViewbox';
 import { addStylesForDiagram } from '../styles';
 
 /*
-  Packaging and exposing resources for externa diagrams so that they can import
-  diagramAPI and have access to selct parts of mermaid common code reqiored to
-  create diagrams worling like the internal diagrams.
+  Packaging and exposing resources for external diagrams so that they can import
+  diagramAPI and have access to select parts of mermaid common code required to
+  create diagrams working like the internal diagrams.
 */
 export const log = _log;
 export const setLogLevel = _setLogLevel;

packages/mermaid/src/diagrams/c4/c4Renderer.js

@@ -441,20 +441,26 @@ export const drawRels = function (diagram, rels, getC4ShapeObj, diagObj) {
  * @param diagram
  * @param parentBoundaryAlias
  * @param parentBounds
- * @param currentBoundarys
+ * @param currentBoundaries
  * @param diagObj
  */
-function drawInsideBoundary(diagram, parentBoundaryAlias, parentBounds, currentBoundarys, diagObj) {
+function drawInsideBoundary(
+  diagram,
+  parentBoundaryAlias,
+  parentBounds,
+  currentBoundaries,
+  diagObj
+) {
   let currentBounds = new Bounds(diagObj);
-  // Calculate the width limit of the boundar.  label/type 的长度，
+  // Calculate the width limit of the boundary.  label/type 的长度，
   currentBounds.data.widthLimit =
-    parentBounds.data.widthLimit / Math.min(c4BoundaryInRow, currentBoundarys.length);
+    parentBounds.data.widthLimit / Math.min(c4BoundaryInRow, currentBoundaries.length);
   // Math.min(
   //   conf.width * conf.c4ShapeInRow + conf.c4ShapeMargin * conf.c4ShapeInRow * 2,
-  //   parentBounds.data.widthLimit / Math.min(conf.c4BoundaryInRow, currentBoundarys.length)
+  //   parentBounds.data.widthLimit / Math.min(conf.c4BoundaryInRow, currentBoundaries.length)
   // );
-  for (let i = 0; i < currentBoundarys.length; i++) {
-    let currentBoundary = currentBoundarys[i];
+  for (let i = 0; i < currentBoundaries.length; i++) {
+    let currentBoundary = currentBoundaries[i];
     let Y = 0;
     currentBoundary.image = { width: 0, height: 0, Y: 0 };
     if (currentBoundary.sprite) {
@@ -508,13 +514,13 @@ function drawInsideBoundary(diagram, parentBoundaryAlias, parentBounds, currentB
     }
 
     if (i == 0 || i % c4BoundaryInRow === 0) {
-      // Calculate the drawing start point of the currentBoundarys.
+      // Calculate the drawing start point of the currentBoundaries.
       let _x = parentBounds.data.startx + conf.diagramMarginX;
       let _y = parentBounds.data.stopy + conf.diagramMarginY + Y;
 
       currentBounds.setData(_x, _x, _y, _y);
     } else {
-      // Calculate the drawing start point of the currentBoundarys.
+      // Calculate the drawing start point of the currentBoundaries.
       let _x =
         currentBounds.data.stopx !== currentBounds.data.startx
           ? currentBounds.data.stopx + conf.diagramMarginX
@@ -540,8 +546,6 @@ function drawInsideBoundary(diagram, parentBoundaryAlias, parentBounds, currentB
 
     if (nextCurrentBoundarys.length > 0) {
       // draw boundary inside currentBoundary
-      // bounds.init();
-      // parentBoundaryWidthLimit = bounds.data.stopx - bounds.startx;
       drawInsideBoundary(
         diagram,
         parentBoundaryAlias,
@@ -576,7 +580,7 @@ function drawInsideBoundary(diagram, parentBoundaryAlias, parentBounds, currentB
 export const draw = function (_text, id, _version, diagObj) {
   conf = configApi.getConfig().c4;
   const securityLevel = configApi.getConfig().securityLevel;
-  // Handle root and Document for when rendering in sanbox mode
+  // Handle root and Document for when rendering in sandbox mode
   let sandboxElement;
   if (securityLevel === 'sandbox') {
     sandboxElement = select('#i' + id);
@@ -616,10 +620,10 @@ export const draw = function (_text, id, _version, diagObj) {
   globalBoundaryMaxY = conf.diagramMarginY;
 
   const title = diagObj.db.getTitle();
-  let currentBoundarys = diagObj.db.getBoundarys('');
+  let currentBoundaries = diagObj.db.getBoundarys('');
   // switch (c4type) {
   //   case 'C4Context':
-  drawInsideBoundary(diagram, '', screenBounds, currentBoundarys, diagObj);
+  drawInsideBoundary(diagram, '', screenBounds, currentBoundaries, diagObj);
   //     break;
   // }
 

packages/mermaid/src/diagrams/class/classDetector-V2.ts

@@ -1,7 +1,7 @@
 import type { DiagramDetector } from '../../diagram-api/detectType';
 
 export const classDetectorV2: DiagramDetector = (txt, config) => {
-  // If we have confgured to use dagre-wrapper then we should return true in this function for classDiagram code thus making it use the new class diagram
+  // If we have configured to use dagre-wrapper then we should return true in this function for classDiagram code thus making it use the new class diagram
   if (txt.match(/^\s*classDiagram/) !== null && config?.class?.defaultRenderer === 'dagre-wrapper')
     return true;
   // We have not opted to use the new renderer so we should return true if we detect a class diagram

packages/mermaid/src/diagrams/class/classDetector.ts

@@ -1,7 +1,7 @@
 import type { DiagramDetector } from '../../diagram-api/detectType';
 
 export const classDetector: DiagramDetector = (txt, config) => {
-  // If we have confgured to use dagre-wrapper then we should never return true in this function
+  // If we have configured to use dagre-wrapper then we should never return true in this function
   if (config?.class?.defaultRenderer === 'dagre-wrapper') return false;
   // We have not opted to use the new renderer so we should return true if we detect a class diagram
   return txt.match(/^\s*classDiagram/) !== null;

packages/mermaid/src/diagrams/class/classRenderer-v2.js

@@ -64,6 +64,7 @@ export const addClasses = function (classes, g, _id, diagObj) {
     // if (evaluate(getConfig().flowchart.htmlLabels)) {
     //   const node = {
     //     label: vertexText.replace(
+    // eslint-disable-next-line @cspell/spellchecker
     //       /fa[lrsb]?:fa-[\w-]+/g,
     //       s => `<i class='${s.replace(':', ' ')}'></i>`
     //     )

packages/mermaid/src/diagrams/class/classRenderer.js

@@ -148,7 +148,7 @@ export const draw = function (text, id, _version, diagObj) {
   log.info('Rendering diagram ' + text);
 
   const securityLevel = getConfig().securityLevel;
-  // Handle root and Document for when rendering in sanbox mode
+  // Handle root and Document for when rendering in sandbox mode
   let sandboxElement;
   if (securityLevel === 'sandbox') {
     sandboxElement = select('#i' + id);

packages/mermaid/src/diagrams/class/svgDraw.js

@@ -347,7 +347,7 @@ const buildMethodDisplay = function (parsedText) {
 };
 
 const buildLegacyDisplay = function (text) {
-  // if for some reason we dont have any match, use old format to parse text
+  // if for some reason we don't have any match, use old format to parse text
   let displayText = '';
   let cssStyle = '';
   let memberText = '';

packages/mermaid/src/diagrams/common/common.ts

@@ -60,7 +60,7 @@ export const sanitizeTextOrArray = (
 export const lineBreakRegex = /<br\s*\/?>/gi;
 
 /**
- * Whether or not a text has any linebreaks
+ * Whether or not a text has any line breaks
  *
  * @param {string} text The text to test
  * @returns {boolean} Whether or not the text has breaks
@@ -80,7 +80,7 @@ export const splitBreaks = (text: string): string[] => {
 };
 
 /**
- * Converts placeholders to linebreaks in HTML
+ * Converts placeholders to line breaks in HTML
  *
  * @param {string} s HTML with placeholders
  * @returns {string} HTML with breaks instead of placeholders

packages/mermaid/src/diagrams/er/erRenderer.js

@@ -644,7 +644,7 @@ export const draw = function (text, id, _version, diagObj) {
   // inserted - this represents the insertion point for relationship paths
   const firstEntity = drawEntities(svg, diagObj.db.getEntities(), g);
 
-  // TODO: externalise the addition of entities to the graph - it's a bit 'buried' in the above
+  // TODO: externalize the addition of entities to the graph - it's a bit 'buried' in the above
 
   // Add all the relationships to the graph
   const relationships = addRelationships(diagObj.db.getRelationships(), g);

packages/mermaid/src/diagrams/flowchart/flowChartShapes.js

@@ -279,7 +279,7 @@ function cylinder(parent, bbox, node) {
         (Math.abs(x) == node.width / 2 && Math.abs(pos.y - node.y) > node.height / 2 - ry))
     ) {
       // ellipsis equation: x*x / a*a + y*y / b*b = 1
-      // solve for y to get adjustion value for pos.y
+      // solve for y to get adjusted value for pos.y
       let y = ry * ry * (1 - (x * x) / (rx * rx));
       if (y != 0) y = Math.sqrt(y);
       y = ry - y;

packages/mermaid/src/diagrams/flowchart/flowDetector-v2.ts

@@ -1,7 +1,7 @@
 import type { DiagramDetector } from '../../diagram-api/detectType';
 
 export const flowDetectorV2: DiagramDetector = (txt, config) => {
-  // If we have confgured to use dagre-wrapper then we should return true in this function for graph code thus making it use the new flowchart diagram
+  // If we have configured to use dagre-wrapper then we should return true in this function for graph code thus making it use the new flowchart diagram
   if (config?.flowchart?.defaultRenderer === 'dagre-wrapper' && txt.match(/^\s*graph/) !== null)
     return true;
   return txt.match(/^\s*flowchart/) !== null;

packages/mermaid/src/diagrams/flowchart/flowDetector.ts

@@ -1,7 +1,7 @@
 import type { DiagramDetector } from '../../diagram-api/detectType';
 
 export const flowDetector: DiagramDetector = (txt, config) => {
-  // If we have confired to only use new flow charts this function shohuld always return false
+  // If we have conferred to only use new flow charts this function should always return false
   // as in not signalling true for a legacy flowchart
   if (config?.flowchart?.defaultRenderer === 'dagre-wrapper') return false;
   return txt.match(/^\s*graph/) !== null;

packages/mermaid/src/diagrams/flowchart/parser/flow-direction.spec.js

@@ -2,11 +2,7 @@ import flowDb from '../flowDb';
 import flow from './flow';
 import filter from 'lodash/filter';
 import { setConfig } from '../../../config';
-// import DOMPurify from 'dompurify';
 
-// const domPurify = DOMPurify.createDOMPurify(window);
-
-// const clean = DOMPurify.sanitize(dirty);
 setConfig({
   securityLevel: 'strict',
 });

packages/mermaid/src/diagrams/gantt/ganttDb.js

@@ -229,7 +229,7 @@ const getStartDate = function (prevTime, dateFormat, str) {
  * Parse a string as a moment duration.
  *
  * The string have to be compound by a value and a shorthand duration unit. For example `5d`
- * representes 5 days.
+ * represents 5 days.
  *
  * Shorthand unit supported are:
  *

packages/mermaid/src/diagrams/gantt/ganttDb.spec.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @cspell/spellchecker
 // @ts-nocheck TODO: Fix TS
 import moment from 'moment-mini';
 import ganttDb from './ganttDb';

packages/mermaid/src/diagrams/gantt/ganttRenderer.js

@@ -27,7 +27,7 @@ export const draw = function (text, id, version, diagObj) {
   // parser.parse(text);
 
   const securityLevel = getConfig().securityLevel;
-  // Handle root and Document for when rendering in sanbox mode
+  // Handle root and Document for when rendering in sandbox mode
   let sandboxElement;
   if (securityLevel === 'sandbox') {
     sandboxElement = select('#i' + id);
@@ -610,7 +610,7 @@ export const draw = function (text, id, version, diagObj) {
   }
 
   /**
-   * From this stackexchange question:
+   * From this stack exchange question:
    * http://stackoverflow.com/questions/1890203/unique-for-arrays-in-javascript
    *
    * @param arr
@@ -629,7 +629,7 @@ export const draw = function (text, id, version, diagObj) {
   }
 
   /**
-   * From this stackexchange question:
+   * From this stack exchange question:
    * http://stackoverflow.com/questions/14227981/count-how-many-strings-in-an-array-have-duplicates-in-the-same-array
    *
    * @param arr

packages/mermaid/src/diagrams/git/gitGraphAst.js

@@ -39,6 +39,7 @@ export const parseDirective = function (statement, context, type) {
 //  * @param currentCommit
 //  * @param otherCommit
 //  */
+// eslint-disable-next-line @cspell/spellchecker
 // function isfastforwardable(currentCommit, otherCommit) {
 //   log.debug('Entering isfastforwardable:', currentCommit.id, otherCommit.id);
 //   let cnt = 0;
@@ -384,14 +385,14 @@ export const checkout = function (branch) {
 /**
  * @param arr
  * @param key
- * @param newval
+ * @param newVal
  */
-function upsert(arr, key, newval) {
+function upsert(arr, key, newVal) {
   const index = arr.indexOf(key);
   if (index === -1) {
-    arr.push(newval);
+    arr.push(newVal);
   } else {
-    arr.splice(index, 1, newval);
+    arr.splice(index, 1, newVal);
   }
 }
 

packages/mermaid/src/diagrams/git/gitGraphRenderer-old.js

@@ -218,18 +218,18 @@ function cloneNode(svg, selector) {
 
 /**
  * @param svg
- * @param commitid
+ * @param commitId
  * @param branches
  * @param direction
  */
-function renderCommitHistory(svg, commitid, branches, direction) {
+function renderCommitHistory(svg, commitId, branches, direction) {
   let commit;
   const numCommits = Object.keys(allCommitsDict).length;
-  if (typeof commitid === 'string') {
+  if (typeof commitId === 'string') {
     do {
-      commit = allCommitsDict[commitid];
+      commit = allCommitsDict[commitId];
       logger.debug('in renderCommitHistory', commit.id, commit.seq);
-      if (svg.select('#node-' + commitid).size() > 0) {
+      if (svg.select('#node-' + commitId).size() > 0) {
         return;
       }
       svg
@@ -291,15 +291,15 @@ function renderCommitHistory(svg, commitid, branches, direction) {
           .attr('class', 'commit-msg')
           .text(', ' + commit.message);
       }
-      commitid = commit.parent;
-    } while (commitid && allCommitsDict[commitid]);
+      commitId = commit.parent;
+    } while (commitId && allCommitsDict[commitId]);
   }
 
-  if (Array.isArray(commitid)) {
-    logger.debug('found merge commmit', commitid);
-    renderCommitHistory(svg, commitid[0], branches, direction);
+  if (Array.isArray(commitId)) {
+    logger.debug('found merge commmit', commitId);
+    renderCommitHistory(svg, commitId[0], branches, direction);
     branchNum++;
-    renderCommitHistory(svg, commitid[1], branches, direction);
+    renderCommitHistory(svg, commitId[1], branches, direction);
     branchNum--;
   }
 }

packages/mermaid/src/diagrams/git/layout.js

@@ -1,6 +1,6 @@
 import { getConfig } from '../../config';
 
-export default (dir, _branches, _commits) => {
+export default (dir, _branches) => {
   const config = getConfig().gitGraph;
   const branches = [];
   const commits = [];

packages/mermaid/src/diagrams/info/infoRenderer.js

@@ -9,16 +9,15 @@ import { getConfig } from '../../config';
  * @param {any} text
  * @param {any} id
  * @param {any} version
- * @param diagObj
  */
-export const draw = (text, id, version, diagObj) => {
+export const draw = (text, id, version) => {
   try {
     // const parser = infoParser.parser;
     // parser.yy = db;
     log.debug('Rendering info diagram\n' + text);
 
     const securityLevel = getConfig().securityLevel;
-    // Handle root and Document for when rendering in sanbox mode
+    // Handle root and Document for when rendering in sandbox mode
     let sandboxElement;
     if (securityLevel === 'sandbox') {
       sandboxElement = select('#i' + id);

packages/mermaid/src/diagrams/pie/pieRenderer.js

@@ -21,7 +21,7 @@ export const draw = (txt, id, _version, diagObj) => {
     log.debug('Rendering info diagram\n' + txt);
 
     const securityLevel = configApi.getConfig().securityLevel;
-    // Handle root and Document for when rendering in sanbox mode
+    // Handle root and Document for when rendering in sandbox mode
     let sandboxElement;
     if (securityLevel === 'sandbox') {
       sandboxElement = select('#i' + id);

packages/mermaid/src/diagrams/requirement/requirementRenderer.js

@@ -311,7 +311,7 @@ export const draw = (text, id, _version, diagObj) => {
   diagObj.parser.parse(text);
 
   const securityLevel = conf.securityLevel;
-  // Handle root and Document for when rendering in sanbox mode
+  // Handle root and Document for when rendering in sandbox mode
   let sandboxElement;
   if (securityLevel === 'sandbox') {
     sandboxElement = select('#i' + id);

packages/mermaid/src/diagrams/sequence/sequenceRenderer.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @cspell/spellchecker
 // @ts-nocheck TODO: fix file
 import { select, selectAll } from 'd3';
 import svgDraw, { drawText, fixLifeLineHeights } from './svgDraw';
@@ -204,8 +205,8 @@ export const bounds = {
  * Draws an note in the diagram with the attached line
  *
  * @param {any} elem - The diagram to draw to.
- * @param {{ x: number; y: number; message: string; width: number }} noteModel - Startx: x axis
- *   start position, verticalPos: y axis position, messsage: the message to be shown, width: Set
+ * @param {{ x: number; y: number; message: string; width: number }} noteModel - startX: x axis
+ *   start position, verticalPos: y axis position, message: the message to be shown, width: Set
  *   this with a custom width to override the default configured width.
  */
 const drawNote = function (elem, noteModel) {
@@ -280,7 +281,7 @@ const actorFont = (cnf) => {
  *
  * @param {any} diagram - The parent of the message element
  * @param {any} msgModel - The model containing fields describing a message
- * @returns {number} LineStarty - The Y coordinate at which the message line starts
+ * @returns {number} lineStartY - The Y coordinate at which the message line starts
  */
 const boundMessage = function (diagram, msgModel) {
   bounds.bumpVerticalPos(10);
@@ -587,12 +588,12 @@ function adjustLoopHeightForWrap(loopWidths, msg, preMargin, postMargin, addLoop
  * @param {any} _text The text of the diagram
  * @param {any} id The id of the diagram which will be used as a DOM element id¨
  * @param {any} _version Mermaid version from package.json
- * @param {any} diagObj A stanard diagram containing the db and the text and type etc of the diagram
+ * @param {any} diagObj A standard diagram containing the db and the text and type etc of the diagram
  */
 export const draw = function (_text, id, _version, diagObj) {
   const { securityLevel, sequence } = configApi.getConfig();
   conf = sequence;
-  // Handle root and Document for when rendering in sanbox mode
+  // Handle root and Document for when rendering in sandbox mode
   let sandboxElement;
   if (securityLevel === 'sandbox') {
     sandboxElement = select('#i' + id);

packages/mermaid/src/diagrams/sequence/svgDraw.js

@@ -509,7 +509,7 @@ export const anchorElement = function (elem) {
  *
  * @param {any} elem - Element to append activation rect.
  * @param {any} bounds - Activation box bounds.
- * @param {any} verticalPos - Precise y cooridnate of bottom activation box edge.
+ * @param {any} verticalPos - Precise y coordinate of bottom activation box edge.
  * @param {any} conf - Sequence diagram config object.
  * @param {any} actorActivations - Number of activations on the actor.
  */
@@ -527,10 +527,10 @@ export const drawActivation = function (elem, bounds, verticalPos, conf, actorAc
 /**
  * Draws a loop in the diagram
  *
- * @param {any} elem - Elemenet to append the loop to.
+ * @param {any} elem - Element to append the loop to.
  * @param {any} loopModel - LoopModel of the given loop.
  * @param {any} labelText - Text within the loop.
- * @param {any} conf - Diagrom configuration
+ * @param {any} conf - Diagram configuration
  * @returns {any}
  */
 export const drawLoop = function (elem, loopModel, labelText, conf) {

packages/mermaid/src/diagrams/state/shapes.js

@@ -137,7 +137,7 @@ export const drawDescrState = (g, stateDef) => {
 
 /** Adds the creates a box around the existing content and adds a panel for the id on top of the content. */
 /**
- * Function that creates an title row and a frame around a substate for a composit state diagram.
+ * Function that creates an title row and a frame around a substate for a composite state diagram.
  * The function returns a new d3 svg object with updated width and height properties;
  *
  * @param {any} g The d3 svg object for the substate to framed
@@ -178,7 +178,7 @@ export const addTitleAndBox = (g, stateDef, altBkg) => {
   // descrLine.attr('x2', graphBox.width + getConfig().state.padding);
 
   if (stateDef.doc) {
-    // cnsole.warn(
+    // console.warn(
     //   stateDef.id,
     //   'orgX: ',
     //   orgX,

packages/mermaid/src/diagrams/state/stateDetector.ts

@@ -1,7 +1,7 @@
 import type { DiagramDetector } from '../../diagram-api/detectType';
 
 export const stateDetector: DiagramDetector = (txt, config) => {
-  // If we have confired to only use new state diagrams this function should always return false
+  // If we have confirmed to only use new state diagrams this function should always return false
   // as in not signalling true for a legacy state diagram
   if (config?.state?.defaultRenderer === 'dagre-wrapper') return false;
   return txt.match(/^\s*stateDiagram/) !== null;

packages/mermaid/src/diagrams/state/stateRenderer-v2.js

@@ -56,7 +56,7 @@ const setupNode = (g, parent, node, altFlag) => {
       };
     }
 
-    // Build of the array of description strings accordinging
+    // Build of the array of description strings according
     if (node.description) {
       if (Array.isArray(nodeDb[node.id].description)) {
         // There already is an array of strings,add to it
@@ -64,7 +64,7 @@ const setupNode = (g, parent, node, altFlag) => {
         nodeDb[node.id].description.push(node.description);
       } else {
         if (nodeDb[node.id].description.length > 0) {
-          // if there is a description already transformit to an array
+          // if there is a description already transform it to an array
           nodeDb[node.id].shape = 'rectWithTitle';
           if (nodeDb[node.id].description === node.id) {
             // If the previous description was the is, remove it

packages/mermaid/src/diagrams/user-journey/journeyRenderer.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @cspell/spellchecker
 // @ts-nocheck TODO: fix file
 import { select } from 'd3';
 import svgDraw from './svgDraw';
@@ -261,7 +262,7 @@ export const drawTasks = function (diagram, tasks, verticalPos) {
 
     // Draw the box with the attached line
     svgDraw.drawTask(diagram, task, conf);
-    bounds.insert(task.x, task.y, task.x + task.width + conf.taskMargin, 300 + 5 * 30); // stopy is the length of the descenders.
+    bounds.insert(task.x, task.y, task.x + task.width + conf.taskMargin, 300 + 5 * 30); // stopY is the length of the descenders.
   }
 };
 

packages/mermaid/src/docs.mts

@@ -39,6 +39,7 @@ import { join, dirname } from 'path';
 import prettier from 'prettier';
 import { remark } from 'remark';
 // @ts-ignore No typescript declaration file
+// eslint-disable-next-line @cspell/spellchecker
 import flatmap from 'unist-util-flatmap';
 
 // These paths are from the root of the mono-repo, not from the

packages/mermaid/src/utils.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line @cspell/spellchecker
 // @ts-nocheck : TODO Fix ts errors
 import { sanitizeUrl } from '@braintree/sanitize-url';
 import {