@mermaid-js/mermaid-cli 9.2.2 → 9.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mermaid-js/mermaid-cli",
-  "version": "9.2.2",
+  "version": "9.4.0",
   "description": "Command-line interface for mermaid",
   "license": "MIT",
   "repository": "git@github.com:mermaid-js/mermaid-cli.git",
@@ -10,7 +10,7 @@
     "mmdc": "./src/cli.js"
   },
   "engines": {
-    "node": ">=14.1.0"
+    "node": "^14.13 || >=16.0"
   },
   "exports": "./src/index.js",
   "scripts": {
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "chalk": "^5.0.1",
-    "commander": "^9.0.0",
+    "commander": "^10.0.0",
     "puppeteer": "^19.0.0"
   },
   "devDependencies": {
@@ -31,9 +31,9 @@
     "mermaid": "^9.2.2",
     "jest": "^29.0.1",
     "standard": "^17.0.0",
-    "vite": "^3.2.3",
+    "vite": "^4.0.3",
     "vite-plugin-singlefile": "^0.13.1",
-    "vite-svg-loader": "^3.6.0",
+    "vite-svg-loader": "^4.0.0",
     "yarn-upgrade-all": "^0.7.0"
   },
   "files": [

package/src/index.js

@@ -1,4 +1,4 @@
-import { Command } from 'commander'
+import { Command, Option, InvalidArgumentError } from 'commander'
 import chalk from 'chalk'
 import fs from 'fs'
 import path from 'path'
@@ -18,7 +18,7 @@ const error = message => {
 }
 
 const warn = message => {
-  console.log(chalk.yellow(`\n${message}\n`))
+  console.warn(chalk.yellow(`\n${message}\n`))
 }
 
 const checkConfigFile = file => {
@@ -27,8 +27,6 @@ const checkConfigFile = file => {
   }
 }
 
-const inputPipedFromStdin = () => fs.fstatSync(0).isFIFO()
-
 const getInputData = async inputFile => new Promise((resolve, reject) => {
   // if an input file has been specified using '-i', it takes precedence over
   // piping from stdin
@@ -60,23 +58,40 @@ const getInputData = async inputFile => new Promise((resolve, reject) => {
   })
 })
 
+/**
+ * Commander parser that converts a string to an integer.
+ *
+ * @param {string} value - The value from commander.
+ * @param {*} _unused - Unused.
+ * @returns {number} The value parsed as a number.
+ * @throws {InvalidArgumentError} If the arg is not valid.
+ * @see https://github.com/tj/commander.js/wiki/Class:-Option#argparserfn
+ */
+function parseCommanderInt (value, _unused) {
+  const parsedValue = parseInt(value, 10)
+  if (isNaN(parsedValue) || parsedValue < 1) {
+    throw new InvalidArgumentError('Not an positive integer.')
+  }
+  return parsedValue
+}
+
 async function cli () {
   const commander = new Command()
   commander
     .version(pkg.version)
-    .option('-t, --theme [theme]', 'Theme of the chart, could be default, forest, dark or neutral. Optional. Default: default', /^default|forest|dark|neutral$/, 'default')
-    .option('-w, --width [width]', 'Width of the page. Optional. Default: 800', /^\d+$/, '800')
-    .option('-H, --height [height]', 'Height of the page. Optional. Default: 600', /^\d+$/, '600')
-    .option('-i, --input <input>', 'Input mermaid file. Files ending in .md will be treated as Markdown and all charts (e.g. ```mermaid (...)```) will be extracted and generated. Required.')
+    .addOption(new Option('-t, --theme [theme]', 'Theme of the chart').choices(['default', 'forest', 'dark', 'neutral']).default('default'))
+    .addOption(new Option('-w, --width [width]', 'Width of the page').argParser(parseCommanderInt).default(800))
+    .addOption(new Option('-H, --height [height]', 'Height of the page').argParser(parseCommanderInt).default(600))
+    .option('-i, --input <input>', 'Input mermaid file. Files ending in .md will be treated as Markdown and all charts (e.g. ```mermaid (...)```) will be extracted and generated. Use `-` to read from stdin.')
     .option('-o, --output [output]', 'Output file. It should be either md, svg, png or pdf. Optional. Default: input + ".svg"')
-    .option('-e, --outputFormat <format>', 'Output format for the generated image. It should be either svg, png or pdf. Optional. Default: output file extension')
-    .option('-b, --backgroundColor [backgroundColor]', 'Background color for pngs/svgs (not pdfs). Example: transparent, red, \'#F0F0F0\'. Optional. Default: white')
-    .option('-c, --configFile [configFile]', 'JSON configuration file for mermaid. Optional')
-    .option('-C, --cssFile [cssFile]', 'CSS file for the page. Optional')
-    .option('-s, --scale [scale]', 'Puppeteer scale factor, default 1. Optional')
+    .addOption(new Option('-e, --outputFormat [format]', 'Output format for the generated image.').choices(['svg', 'png', 'pdf']).default(null, 'Loaded from the output file extension'))
+    .addOption(new Option('-b, --backgroundColor [backgroundColor]', 'Background color for pngs/svgs (not pdfs). Example: transparent, red, \'#F0F0F0\'.').default('white'))
+    .option('-c, --configFile [configFile]', 'JSON configuration file for mermaid.')
+    .option('-C, --cssFile [cssFile]', 'CSS file for the page.')
+    .addOption(new Option('-s, --scale [scale]', 'Puppeteer scale factor').argParser(parseCommanderInt).default(1))
     .option('-f, --pdfFit [pdfFit]', 'Scale PDF to fit chart')
     .option('-q, --quiet', 'Suppress log output')
-    .option('-p --puppeteerConfigFile [puppeteerConfigFile]', 'JSON configuration file for puppeteer. Optional')
+    .option('-p --puppeteerConfigFile [puppeteerConfigFile]', 'JSON configuration file for puppeteer.')
     .parse(process.argv)
 
   const options = commander.opts()
@@ -84,12 +99,15 @@ async function cli () {
   let { theme, width, height, input, output, outputFormat, backgroundColor, configFile, cssFile, puppeteerConfigFile, scale, pdfFit, quiet } = options
 
   // check input file
-  if (!(input || inputPipedFromStdin())) {
-    console.error(chalk.red('\nPlease specify input file: -i <input>\n'))
-    // Log to stderr, and return with error exitCode
-    commander.help({ error: true })
-  }
-  if (input && !fs.existsSync(input)) {
+  if (!input) {
+    warn('No input file specfied, reading from stdin. ' +
+      'If you want to specify an input file, please use `-i <input>.` ' +
+      'You can use `-i -` to read from stdin and to suppress this warning.'
+    )
+  } else if (input === '-') {
+    // `--input -` means read from stdin, but suppress the above warning
+    input = undefined
+  } else if (!fs.existsSync(input)) {
     error(`Input file "${input}" doesn't exist`)
   }
 
@@ -104,8 +122,8 @@ async function cli () {
       output = input ? (`${input}.svg`) : 'out.svg'
     }
   }
-  if (!/\.(?:svg|png|pdf|md)$/.test(output)) {
-    error('Output file must end with ".md", ".svg", ".png" or ".pdf"')
+  if (!/\.(?:svg|png|pdf|md|markdown)$/.test(output)) {
+    error('Output file must end with ".md"/".markdown", ".svg", ".png" or ".pdf"')
   }
   const outputDir = path.dirname(output)
   if (!fs.existsSync(outputDir)) {
@@ -133,19 +151,13 @@ async function cli () {
     myCSS = fs.readFileSync(cssFile, 'utf-8')
   }
 
-  // normalize args
-  width = parseInt(width)
-  height = parseInt(height)
-  backgroundColor = backgroundColor || 'white'
-  const deviceScaleFactor = parseInt(scale || 1, 10)
-
   await run(
     input, output, {
       puppeteerConfig,
       quiet,
       outputFormat,
       parseMMDOptions: {
-        mermaidConfig, backgroundColor, myCSS, pdfFit, viewport: { width, height, deviceScaleFactor }
+        mermaidConfig, backgroundColor, myCSS, pdfFit, viewport: { width, height, deviceScaleFactor: scale }
       }
     }
   )
@@ -335,10 +347,11 @@ function markdownImage ({ url, title, alt }) {
 /**
  * Renders a mermaid diagram or mermaid markdown file.
  *
- * @param {`${string}.md` | string} [input] - If this ends with `.md`, path to a markdown file containing mermaid.
+ * @param {`${string}.${"md" | "markdown"}` | string} [input] - If this ends with `.md`/`.markdown`,
+ * path to a markdown file containing mermaid.
  * If this is a string, loads the mermaid definition from the given file.
  * If this is `undefined`, loads the mermaid definition from stdin.
- * @param {`${string}.${"md" | "svg" | "png" | "pdf"}`} output - Path to the output file.
+ * @param {`${string}.${"md" | "markdown" | "svg" | "png" | "pdf"}`} output - Path to the output file.
  * @param {Object} [opts] - Options
  * @param {puppeteer.LaunchOptions} [opts.puppeteerConfig] - Puppeteer launch options.
  * @param {boolean} [opts.quiet] - If set, suppress log output.
@@ -353,14 +366,15 @@ async function run (input, output, { puppeteerConfig = {}, quiet = false, output
     }
   }
 
-  const mermaidChartsInMarkdown = /^\s*```(?:mermaid)(\r?\n([\s\S]*?))```\s*$/
+  // TODO: should we use a Markdown parser like remark instead of rolling our own parser?
+  const mermaidChartsInMarkdown = /^[^\S\n]*```(?:mermaid)(\r?\n([\s\S]*?))```[^\S\n]*$/
   const mermaidChartsInMarkdownRegexGlobal = new RegExp(mermaidChartsInMarkdown, 'gm')
   const browser = await puppeteer.launch(puppeteerConfig)
   try {
     if (!outputFormat) {
       outputFormat = path.extname(output).replace('.', '')
     }
-    if (outputFormat === 'md') {
+    if (outputFormat === 'md' || outputFormat === 'markdown') {
       // fallback to svg in case no outputFormat is given and output file is MD
       outputFormat = 'svg'
     }
@@ -369,7 +383,7 @@ async function run (input, output, { puppeteerConfig = {}, quiet = false, output
     }
 
     const definition = await getInputData(input)
-    if (/\.md$/.test(input)) {
+    if (/\.(md|markdown)$/.test(input)) {
       const imagePromises = []
       for (const mermaidCodeblockMatch of definition.matchAll(mermaidChartsInMarkdownRegexGlobal)) {
         const mermaidDefinition = mermaidCodeblockMatch[1]
@@ -379,7 +393,10 @@ async function run (input, output, { puppeteerConfig = {}, quiet = false, output
         //     I.e. if "out.png", use "out-1.png", "out-2.png", etc
         //   If it is an output `.md` file, use that to base .svg numbered diagrams on
         //     I.e. if "out.md". use "out-1.svg", "out-2.svg", etc
-        const outputFile = output.replace(/(\.(md|png|svg|pdf))$/, `-${imagePromises.length + 1}$1`).replace(/(\.md)$/, `.${outputFormat}`)
+        const outputFile = output.replace(
+          /(\.(md|markdown|png|svg|pdf))$/,
+          `-${imagePromises.length + 1}$1`
+        ).replace(/\.(md|markdown)$/, `.${outputFormat}`)
         const outputFileRelative = `./${path.relative(path.dirname(path.resolve(output)), path.resolve(outputFile))}`
 
         const imagePromise = (async () => {
@@ -404,7 +421,7 @@ async function run (input, output, { puppeteerConfig = {}, quiet = false, output
 
       const images = await Promise.all(imagePromises)
 
-      if (/\.md$/.test(output)) {
+      if (/\.(md|markdown)$/.test(output)) {
         const outDefinition = definition.replace(mermaidChartsInMarkdownRegexGlobal, (_mermaidMd) => {
           // pop first image from front of array
           const { url, title, alt } = images.shift()