Merge branch 'develop' into sidv/eslintCleanup

* develop:
  chore: Add lodash-eslint rule
  chore: Add lodash-eslint rule
  feat: Spellcheck docs when building
  fix: Enable extending lintstagedrc.
  fix: lintstagedrc `lint:jison`

.lintstagedrc.mjs

@@ -0,0 +1,5 @@
+export default {
+  '!(docs/**/*)*.{ts,js,json,html,md,mts}': ['eslint --fix', 'prettier --write'],
+  'cSpell.json': ['ts-node-esm scripts/fixCSpell.ts'],
+  '**/*.jison': ['pnpm -w run lint:jison'],
+};

cSpell.json

@@ -13,6 +13,7 @@
     "bbox",
     "bilkent",
     "bisheng",
+    "braintree",
     "brolin",
     "brotli",
     "classdef",
@@ -34,18 +35,21 @@
     "gantt",
     "gitea",
     "gitgraph",
+    "globby",
     "graphlib",
     "grav",
     "greywolf",
     "inkdrop",
     "jaoude",
     "jison",
     "kaufmann",
+    "khroma",
     "klemm",
     "klink",
     "knsv",
     "knut",
     "laganeckas",
+    "lintstagedrc",
     "lucida",
     "matthieu",
     "mdbook",
@@ -75,6 +79,7 @@
     "treemap",
     "ts-nocheck",
     "tuleap",
+    "unist",
     "verdana",
     "viewports",
     "vinod",

packages/mermaid/.lintstagedrc.mjs

@@ -0,0 +1,7 @@
+import baseConfig from '../../.lintstagedrc.mjs';
+export default {
+  ...baseConfig,
+  'src/docs/**': ['pnpm --filter mermaid run docs:build --git'],
+  'src/docs.mts': ['pnpm --filter mermaid run docs:build --git'],
+  'src/(defaultConfig|config|mermaidAPI).ts': ['pnpm --filter mermaid run docs:build --git'],
+};

packages/mermaid/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mermaid",
   "version": "9.2.2",
-  "description": "Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.",
+  "description": "Markdown-ish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.",
   "main": "./dist/mermaid.min.js",
   "module": "./dist/mermaid.core.mjs",
   "types": "./dist/mermaid.d.ts",
@@ -26,12 +26,13 @@
   "scripts": {
     "clean": "rimraf dist",
     "docs:code": "typedoc src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup",
-    "docs:build": "rimraf ../../docs && pnpm docs:code && ts-node-esm src/docs.mts",
-    "docs:verify": "pnpm docs:code && ts-node-esm src/docs.mts --verify",
+    "docs:build": "rimraf ../../docs && pnpm docs:spellcheck && pnpm docs:code && ts-node-esm src/docs.mts",
+    "docs:verify": "pnpm docs:spellcheck && pnpm docs:code && ts-node-esm src/docs.mts --verify",
     "docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress",
     "docs:build:vitepress": "pnpm docs:pre:vitepress && vitepress build src/vitepress",
     "docs:dev": "pnpm docs:pre:vitepress && concurrently \"vitepress dev src/vitepress\" \"ts-node-esm src/docs.mts --watch --vitepress\"",
     "docs:serve": "pnpm docs:build:vitepress && vitepress serve src/vitepress",
+    "docs:spellcheck": "cspell --config ../../cSpell.json \"src/docs/**/*.md\"",
     "release": "pnpm build",
     "prepublishOnly": "pnpm -w run build"
   },
@@ -79,6 +80,7 @@
     "chokidar": "^3.5.3",
     "concurrently": "^7.5.0",
     "coveralls": "^3.1.1",
+    "cspell": "^6.14.3",
     "globby": "^13.1.2",
     "identity-obj-proxy": "^3.0.0",
     "jison": "^0.4.18",