npm - @mermaid-js/mermaid-cli - Versions diffs - 11.14.0 → 11.16.0 - Mend

@mermaid-js/mermaid-cli 11.14.0 → 11.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

package/README.md CHANGED Viewed

@@ -55,7 +55,8 @@ mmdc --input test-positive/flowchart1.mmd --cssFile test-positive/flowchart1.css
 <details>
   <summary>Example output: docs/animated-flowchart.svg</summary>
-  ![docs/animated-flowchart.svg](docs/animated-flowchart.svg)
+![docs/animated-flowchart.svg](docs/animated-flowchart.svg)
 </details>
 ### Transform a markdown file with mermaid diagrams
@@ -68,38 +69,44 @@ This command transforms a markdown file itself. The mermaid-cli will find the me
 This:
-~~~md
+````md
 ### Some markdown
 ```mermaid
 graph
    [....]
 ```
 ### Some more markdown
 ```mermaid
 sequenceDiagram
    [....]
 ```
 ### Mermaid with custom title/desc
 ```mermaid
 graph
    accTitle: My title here
    accDescr: My description here
    A-->B
 ```
-~~~
+````
 Becomes:
 ```md
 ### Some markdown
 ![diagram](./readme-1.svg)
 ### Some more markdown
 ![diagram](./readme-2.svg)
 ### Mermaid with custom title/desc
 ![My description here](./readme-3.svg "My title here")
 ```
@@ -167,7 +174,6 @@ restore this behaviour with the `--workdir` option:
 docker run [...] --workdir=/home/mermaidcli minlag/mermaid-cli [...]
 ```
 ## Use Node.JS API
 It's possible to call `mermaid-cli` via a Node.JS API.
@@ -175,11 +181,12 @@ Please be aware that **the NodeJS API is not covered by semver**, as `mermaid-cl
 `mermaid`'s versioning.
 ```js
-import { run } from "@mermaid-js/mermaid-cli"
+import { run } from "@mermaid-js/mermaid-cli";
 await run(
-   "input.mmd", "output.svg", // {optional options},
-)
+    "input.mmd",
+    "output.svg", // {optional options},
+);
 ```
 ## Install locally
@@ -195,10 +202,9 @@ npm install @mermaid-js/mermaid-cli
 ### Run with npx
 [`npx`](https://www.npmjs.com/package/npx) is installed by default with NPM. It
-downloads and runs commands at the same time.  To use Mermaid CLI with npx, you
+downloads and runs commands at the same time. To use Mermaid CLI with npx, you
 need to use the `-p` flag because the package name is different than the command
-it installs (`mmdc`).  `npx -p @mermaid-js/mermaid-cli mmdc -h`
+it installs (`mmdc`). `npx -p @mermaid-js/mermaid-cli mmdc -h`
 ## Install with [brew](https://brew.sh)
@@ -207,11 +213,11 @@ it installs (`mmdc`).  `npx -p @mermaid-js/mermaid-cli mmdc -h`
 > This method of installation is no longer supported.
 > For more details, see the [discussion](https://github.com/mermaid-js/mermaid-cli/issues/288).
 > An old version of mermaid-cli can be installed with brew.
+>
 > ```sh
 > brew install mermaid-cli
 > ```
 ## Known issues
 1. [Linux sandbox issue](docs/linux-sandbox-issue.md)

package/dist/index.html CHANGED Viewed

@@ -1,7 +1,5 @@
 <!doctype html>
 <html>
-  <script charset="utf-8" src="./assets/index-DxLypzbC.js"></script>
   <body>
     <div id="container"></div>
   </body>

package/dist-types/src/index.d.ts CHANGED Viewed

@@ -5,7 +5,7 @@ export type ParseMDDOptions = {
     /**
      * - Puppeteer viewport (e.g. `width`, `height`, `deviceScaleFactor`)
      */
-    viewport?: puppeteer.Viewport | undefined;
+    viewport?: import("puppeteer-core").Viewport | undefined;
     /**
      * - Background color.
      */
@@ -56,6 +56,16 @@ export type MarkdownImageProps = {
      */
     title?: string | null | undefined;
 };
+/**
+ * - Adapted from `p-limit` package.
+ */
+export type Limiter = <Arguments extends unknown[], ReturnType>(function_: (...arguments_: Arguments) => Promise<ReturnType>, ...arguments_: Arguments) => Promise<ReturnType>;
+/**
+ * @typedef {<Arguments extends unknown[], ReturnType>(
+ *  function_: (...arguments_: Arguments) => Promise<ReturnType>,
+ *    ...arguments_: Arguments
+ * ) => Promise<ReturnType>} Limiter - Adapted from `p-limit` package.
+ */
 /**
  * Renders a mermaid diagram or mermaid markdown file.
  *
@@ -70,13 +80,18 @@ export type MarkdownImageProps = {
  * @param {"svg" | "png" | "pdf"} [opts.outputFormat] - Mermaid output format.
  * @param {string} [opts.artefacts] - Path to the artefacts directory.
  * Defaults to `output` extension. Overrides `output` extension if set.
+ * @param {import("puppeteer").Browser} [opts.browser] - If set, reuses the given puppeteer browser instance instead of creating a new one.
+ * This may leak cookies/cache between runs.
+ * @param {Limiter} [opts.limiter] - If set, limiter function to avoid rendering too many diagrams in parallel.
  * @param {ParseMDDOptions} [opts.parseMMDOptions] - Options to pass to {@link parseMMDOptions}.
  */
-export function run(input: `${string}.${"md" | "markdown"}` | string | undefined, output: `${string}.${"md" | "markdown" | "svg" | "png" | "pdf"}` | "/dev/stdout", { puppeteerConfig, quiet, outputFormat, parseMMDOptions, artefacts }?: {
-    puppeteerConfig?: puppeteer.LaunchOptions | undefined;
+export function run(input: `${string}.${"md" | "markdown"}` | string | undefined, output: `${string}.${"md" | "markdown" | "svg" | "png" | "pdf"}` | "/dev/stdout", { browser: userPassedBrowser, puppeteerConfig, quiet, outputFormat, parseMMDOptions, limiter, artefacts, }?: {
+    puppeteerConfig?: import("puppeteer-core").LaunchOptions | undefined;
     quiet?: boolean | undefined;
     outputFormat?: "svg" | "png" | "pdf" | undefined;
     artefacts?: string | undefined;
+    browser?: import("puppeteer-core").Browser | undefined;
+    limiter?: Limiter | undefined;
     parseMMDOptions?: ParseMDDOptions | undefined;
 }): Promise<void>;
 /**
@@ -100,7 +115,7 @@ export function run(input: `${string}.${"md" | "markdown"}` | string | undefined
  * @returns {Promise<{title: string | null, desc: string | null, data: Uint8Array}>} The output file in bytes,
  * with optional metadata.
  */
-export function renderMermaid(browser: import("puppeteer").Browser | import("puppeteer").BrowserContext, definition: string, outputFormat: "svg" | "png" | "pdf", { viewport, backgroundColor, mermaidConfig, myCSS, pdfFit, svgId, iconPacks, iconPacksNamesAndUrls }?: ParseMDDOptions): Promise<{
+export function renderMermaid(browser: import("puppeteer").Browser | import("puppeteer").BrowserContext, definition: string, outputFormat: "svg" | "png" | "pdf", { viewport, backgroundColor, mermaidConfig, myCSS, pdfFit, svgId, iconPacks, iconPacksNamesAndUrls, }?: ParseMDDOptions): Promise<{
     title: string | null;
     desc: string | null;
     data: Uint8Array;
@@ -113,5 +128,4 @@ export function cli(): Promise<void>;
  * @returns {never} Quits Node.JS, so never returns.
  */
 export function error(message: string): never;
-import puppeteer from 'puppeteer';
 //# sourceMappingURL=index.d.ts.map

package/dist-types/src/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;~~SAoZc~~,MAAM;;;;SACN,MAAM~~;;;;;;AAqBpB;;;;;;;;;;;;;;;GAeG~~;AACH,~~2BAbW~~,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,EAAE,GAAG,MAAM,GAAG,SAAS,UAIrD,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE,GAAG,aAAa~~,yEAEhF~~;IAAiD,eAAe;IACzC,KAAK;IACS,YAAY;IAC3B,SAAS;~~IAEA~~,eAAe;CAChD,~~iBAoHA~~;~~AA1UD~~;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,uCAPW,OAAO,WAAW,EAAE,OAAO,GAAG,OAAO,WAAW,EAAE,cAAc,cAChE,MAAM,gBACN,KAAK,GAAG,KAAK,GAAG,KAAK,~~yGACrB~~,eAAe,GACb,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAC,CAAC,~~CA0JlF~~;~~AAtSD~~,~~qCAwHC~~;~~AA5MD~~;;;;;GAKG;AACH,+BAHW,MAAM,GACJ,KAAK,CAKjB~~;sBAzBqB,WAAW~~"}
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAgqBc,MAAM;;;;SACN,MAAM;;;;;;;;;sBAsBP,CAAC,SAAS,SAAS,OAAO,EAAE,EAAE,UAAU,EACjD,SAAS,EAAE,CAAC,GAAG,UAAU,EAAE,SAAS,KAAK,OAAO,CAAC,UAAU,CAAC,EAC/D,GAAQ,UAAU,EAAE,SAAS,KACtB,OAAO,CAAC,UAAU,CAAC;AAJ3B;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AACH,2BAhBW,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,EAAE,GAAG,MAAM,GAAG,SAAS,UAIrD,GAAG,MAAM,IAAI,IAAI,GAAG,UAAU,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE,GAAG,aAAa,+GAEhF;IAAiD,eAAe;IACzC,KAAK;IACS,YAAY;IAC3B,SAAS;IAEY,OAAO;IAE3B,OAAO;IACC,eAAe;CAChD,iBAiKA;AAxeD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,uCAPW,OAAO,WAAW,EAAE,OAAO,GAAG,OAAO,WAAW,EAAE,cAAc,cAChE,MAAM,gBACN,KAAK,GAAG,KAAK,GAAG,KAAK,0GACrB,eAAe,GACb,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAC,CAAC,CAiQlF;AAhfD,qCA2NC;AA/TD;;;;;GAKG;AACH,+BAHW,MAAM,GACJ,KAAK,CAKjB"}

package/dist-types/src/puppeteerIntercept.d.ts CHANGED Viewed

@@ -6,23 +6,26 @@
  */
 export class Interceptor {
     /**
-       * @param {URL | `file://${string}`} fileUrl - File URL
-       */
-    fileUrlToInterceptUrl(fileUrl: URL | `file://${string}`): Promise<string>;
+     * @param {URL | `file://${string}`} fileUrl - File URL
+     * @param {Object} [options] - Optional options.
+     * @param {number} [options.allowParentDirectoryLevel] - Number of parent directory levels to allow access to.
+     */
+    fileUrlToInterceptUrl(fileUrl: URL | `file://${string}`, { allowParentDirectoryLevel }?: {
+        allowParentDirectoryLevel?: number | undefined;
+    }): Promise<string>;
     /**
-       *
-       * @param {URL | string} interceptUrl
-       * @throws {Error} If the URL is not a valid intercept URL
-       */
+     *
+     * @param {URL | string} interceptUrl
+     * @throws {Error} If the URL is not a valid intercept URL
+     */
     interceptUrlToFileUrl(interceptUrl: URL | string): Promise<URL>;
     /**
-       * Intercepts requests to `https://mermaid-cli-intercept.invalid`
-       * and serves the corresponding file content.
-       *
-       * @return {puppeteer.Handler<puppeteer.HTTPRequest>}
-       */
-    get interceptRequestHandler(): puppeteer.Handler<puppeteer.HTTPRequest>;
+     * Intercepts requests to `https://mermaid-cli-intercept.invalid`
+     * and serves the corresponding file content.
+     *
+     * @return {import('puppeteer').Handler<import('puppeteer').HTTPRequest>}
+     */
+    get interceptRequestHandler(): import("puppeteer").Handler<import("puppeteer").HTTPRequest>;
     #private;
 }
-import type puppeteer from 'puppeteer';
 //# sourceMappingURL=puppeteerIntercept.d.ts.map

package/dist-types/src/puppeteerIntercept.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"puppeteerIntercept.d.ts","sourceRoot":"","sources":["../../src/puppeteerIntercept.js"],"names":[],"mappings":"~~AAQA~~;;;;;GAKG;AACH;IAcE~~;;SAEK~~;~~IACL~~,+~~BAFa~~,GAAG,GAAG,UAAU,MAAM,EAAE,~~mBASpC~~;IAED;;;;~~SAIK~~;~~IACL~~,~~oCAHa~~,GAAG,GAAG,MAAM,~~gBAcxB~~;~~IAyBD~~;;;;;~~SAKK~~;~~IACL~~,+~~BAFc~~,~~kBAAkB~~,~~qBAAqB~~,CAAC,~~CAIrD~~;;CACF~~;2BAzFyB,WAAW~~"}
1	+ {"version":3,"file":"puppeteerIntercept.d.ts","sourceRoot":"","sources":["../../src/puppeteerIntercept.js"],"names":[],"mappings":"AAgCA;;;;;GAKG;AACH;IAcE;;;;OAIG;IACH,+BAJW,GAAG,GAAG,UAAU,MAAM,EAAE,kCAEhC;QAAyB,yBAAyB;KACpD,mBAYA;IAED;;;;OAIG;IACH,oCAHW,GAAG,GAAG,MAAM,gBAuBtB;IAiCD;;;;;OAKG;IACH,+BAFY,OAAO,WAAW,EAAE,OAAO,CAAC,OAAO,WAAW,EAAE,WAAW,CAAC,CAIvE;;CACF"}

package/dist-types/src/version.d.ts CHANGED Viewed

@@ -1,2 +1,2 @@
-export const version: "11.14.0";
+export const version: "11.16.0";
 //# sourceMappingURL=version.d.ts.map

package/dist-types/src/version.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.js"],"names":[],"mappings":"AAAA,sBAAuB,SAAS,~~CAAA~~"}
1	+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.js"],"names":[],"mappings":"AAAA,sBAAuB,SAAS,CAAC"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@mermaid-js/mermaid-cli",
-  "version": "11.14.0",
+  "version": "11.16.0",
   "description": "Command-line interface for mermaid",
   "license": "MIT",
   "repository": "git@github.com:mermaid-js/mermaid-cli.git",
@@ -22,33 +22,43 @@
   "scripts": {
     "prepare": "tsc && vite build",
     "prepack": "tsc && vite build",
-    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest",
+    "test": "cross-env-shell NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest",
     "test:cli": "bash run-tests.sh test-positive",
     "version": "node scripts/version.js",
-    "lint": "standard",
-    "lint-fix": "standard --fix"
+    "lint": "prettier --check . && eslint .",
+    "lint-fix": "prettier --write . && eslint --fix ."
   },
   "dependencies": {
-    "@mermaid-js/layout-elk": "^0.1.2 || ^0.2.0",
+    "@fortawesome/fontawesome-free": "^6.0.0 || ^7.0.1",
+    "@mermaid-js/layout-elk": "^0.1.5 || ^0.2.0",
     "@mermaid-js/mermaid-zenuml": "^0.2.0",
     "chalk": "^5.0.1",
     "commander": "^13.1.0",
     "import-meta-resolve": "^4.1.0",
-    "mermaid": "^11.14.0"
+    "katex": "^0.16.25",
+    "mermaid": "^11.14.0",
+    "p-limit": "^6.2.0"
+  },
+  "optionalDependencies": {
+    "@mermaid-js/layout-tidy-tree": "^0.2.1"
   },
   "peerDependencies": {
-    "puppeteer": "^23 || ^24"
+    "puppeteer": "^23 || ^24 || ^25"
   },
   "devDependencies": {
-    "@fortawesome/fontawesome-free": "^7.0.1",
+    "@eslint/js": "^9.0.0",
     "@tsconfig/node18": "^18.2.4",
     "@types/node": "~18.19.31",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.0.0",
+    "globals": "^17.6.0",
     "jest": "^30.0.5",
-    "puppeteer": "^24.0.0",
-    "standard": "^17.0.0",
-    "typescript": "^5.0.1-rc",
+    "prettier": "^3.8.3",
+    "puppeteer": "^25.0.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.59.3",
     "vite": "^6.0.2",
-    "yarn-upgrade-all": "^0.7.0"
+    "yarn-upgrade-all": "^0.8.1"
   },
   "files": [
     "src/",
@@ -60,11 +70,5 @@
       "#(.*)": "<rootDir>/node_modules/$1"
     }
   },
-  "standard": {
-    "ignore": [
-      "/dist/",
-      "/dist-types/"
-    ]
-  },
   "packageManager": "npm@10.8.1"
 }

package/src/cli.js CHANGED Viewed

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
-import { cli, error } from './index.js'
+import { cli, error } from "./index.js";
-process.title = 'mmdc'
-cli().catch((exception) => error(exception instanceof Error ? exception.stack : exception))
+process.title = "mmdc";
+cli().catch((exception) =>
+  error(exception instanceof Error ? exception.stack : exception),
+);