@mermaid-js/mermaid-cli 8.12.1 → 8.13.4

package/README.md

@@ -99,6 +99,7 @@ it installs (`mmdc`).  `npx -p @mermaid-js/mermaid-cli mmdc -h`
 ## Known issues
 
 1. [Linux sandbox issue](docs/linux-sandbox-issue.md)
+2. [Docker permission denied issue](docs/docker-permission-denied.md)
 
 ## For contributors
 

package/index.bundle.js

@@ -1,13 +1,20 @@
 #!/usr/bin/env node
-'use strict';
+"use strict";
 
-function _asyncToGenerator(fn) { return function () { var gen = fn.apply(this, arguments); return new Promise(function (resolve, reject) { function step(key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { return Promise.resolve(value).then(function (value) { step("next", value); }, function (err) { step("throw", err); }); } } return step("next"); }); }; }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 
 process.title = "mmdc";
+
 const commander = require('commander');
+
 const chalk = require('chalk');
+
 const fs = require('fs');
+
 const path = require('path');
+
 const puppeteer = require('puppeteer');
 
 const pkg = require('./package.json');
@@ -25,13 +32,13 @@ const checkConfigFile = file => {
 
 const inputPipedFromStdin = () => fs.fstatSync(0).isFIFO();
 
-const getInputData = (() => {
+const getInputData = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(function* (inputFile) {
-    return new Promise(function (resolve, reject) {
+    return new Promise((resolve, reject) => {
       // if an input file has been specified using '-i', it takes precedence over
       // piping from stdin
       if (typeof inputFile !== 'undefined') {
-        return fs.readFile(inputFile, 'utf-8', function (err, data) {
+        return fs.readFile(inputFile, 'utf-8', (err, data) => {
           if (err) {
             return reject(err);
           }
@@ -48,11 +55,9 @@ const getInputData = (() => {
           data += chunk;
         }
       });
-
       process.stdin.on('error', function (err) {
         reject(err);
       });
-
       process.stdin.on('end', function () {
         resolve(data);
       });
@@ -62,124 +67,179 @@ const getInputData = (() => {
   return function getInputData(_x) {
     return _ref.apply(this, arguments);
   };
-})();
+}();
 
 const convertToValidXML = html => {
-  var xml = html;
-
   // <br> tags in valid HTML (from innerHTML) look like <br>, but they must look like <br/> to be valid XML (such as SVG)
-  xml.replace(/<br>/gi, '<br/>');
-
-  return xml;
+  return html.replace(/<br>/gi, '<br/>');
 };
 
-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. Required.').option('-o, --output [output]', 'Output file. It should be either svg, png or pdf. Optional. Default: input + ".svg"').option('-b, --backgroundColor [backgroundColor]', 'Background color. 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').option('-f, --pdfFit [pdfFit]', 'Scale PDF to fit chart').option('-p --puppeteerConfigFile [puppeteerConfigFile]', 'JSON configuration file for puppeteer. Optional').parse(process.argv);
-
+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.').option('-o, --output [output]', 'Output file. It should be either svg, png or pdf. Optional. Default: input + ".svg"').option('-b, --backgroundColor [backgroundColor]', 'Background color. 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').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').parse(process.argv);
 const options = commander.opts();
+let {
+  theme,
+  width,
+  height,
+  input,
+  output,
+  backgroundColor,
+  configFile,
+  cssFile,
+  puppeteerConfigFile,
+  scale,
+  pdfFit,
+  quiet
+} = options; // check input file
 
-let { theme, width, height, input, output, backgroundColor, configFile, cssFile, puppeteerConfigFile, scale, pdfFit } = options;
-
-// check input file
 if (!(input || inputPipedFromStdin())) {
-  error('Please specify input file: -i <input>');
+  console.log(chalk.red(`\nPlease specify input file: -i <input>\n`));
+  commander.help();
+  process.exit(1);
 }
+
 if (input && !fs.existsSync(input)) {
   error(`Input file "${input}" doesn't exist`);
-}
+} // check output file
+
 
-// check output file
 if (!output) {
   // if an input file is defined, it should take precedence, otherwise, input is
   // coming from stdin and just name the file out.svg, if it hasn't been
   // specified with the '-o' option
   output = input ? input + '.svg' : 'out.svg';
 }
+
 if (!/\.(?:svg|png|pdf)$/.test(output)) {
   error(`Output file must end with ".svg", ".png" or ".pdf"`);
 }
+
 const outputDir = path.dirname(output);
+
 if (!fs.existsSync(outputDir)) {
   error(`Output directory "${outputDir}/" doesn't exist`);
-}
+} // check config files
+
+
+let mermaidConfig = {
+  theme
+};
 
-// check config files
-let mermaidConfig = { theme };
 if (configFile) {
   checkConfigFile(configFile);
   mermaidConfig = Object.assign(mermaidConfig, JSON.parse(fs.readFileSync(configFile, 'utf-8')));
 }
+
 let puppeteerConfig = {};
+
 if (puppeteerConfigFile) {
   checkConfigFile(puppeteerConfigFile);
   puppeteerConfig = JSON.parse(fs.readFileSync(puppeteerConfigFile, 'utf-8'));
-}
+} // check cssFile
+
 
-// check cssFile
 let myCSS;
+
 if (cssFile) {
   if (!fs.existsSync(cssFile)) {
     error(`CSS file "${cssFile}" doesn't exist`);
   }
+
   myCSS = fs.readFileSync(cssFile, 'utf-8');
 }
 
-// normalize args
+const info = message => {
+  if (!quiet) {
+    console.info(message);
+  }
+}; // normalize args
+
+
 width = parseInt(width);
 height = parseInt(height);
 backgroundColor = backgroundColor || 'white';
 const deviceScaleFactor = parseInt(scale || 1, 10);
 
-const parseMMD = (() => {
+const parseMMD = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator(function* (browser, definition, output) {
     const page = yield browser.newPage();
-    page.setViewport({ width, height, deviceScaleFactor });
+    page.setViewport({
+      width,
+      height,
+      deviceScaleFactor
+    });
     yield page.goto(`file://${path.join(__dirname, 'index.html')}`);
     yield page.evaluate(`document.body.style.background = '${backgroundColor}'`);
-    const result = yield page.$eval('#container', function (container, definition, mermaidConfig, myCSS) {
+    const result = yield page.$eval('#container', (container, definition, mermaidConfig, myCSS) => {
       container.textContent = definition;
       window.mermaid.initialize(mermaidConfig);
+
       if (myCSS) {
         const head = window.document.head || window.document.getElementsByTagName('head')[0];
         const style = document.createElement('style');
         style.type = 'text/css';
+
         if (style.styleSheet) {
           style.styleSheet.cssText = myCSS;
         } else {
           style.appendChild(document.createTextNode(myCSS));
         }
+
         head.appendChild(style);
       }
 
       try {
         window.mermaid.init(undefined, container);
-        return { status: 'success' };
+        return {
+          status: 'success'
+        };
       } catch (error) {
-        return { status: 'error', error, message: error.message };
+        return {
+          status: 'error',
+          error,
+          message: error.message
+        };
       }
     }, definition, mermaidConfig, myCSS);
+
     if (result.status === 'error') {
       error(result.message);
     }
 
     if (output.endsWith('svg')) {
-      const svg = yield page.$eval('#container', function (container) {
-        return container.innerHTML;
-      });
+      const svg = yield page.$eval('#container', container => container.innerHTML);
       const svg_xml = convertToValidXML(svg);
       fs.writeFileSync(output, svg_xml);
     } else if (output.endsWith('png')) {
-      const clip = yield page.$eval('svg', function (svg) {
+      const clip = yield page.$eval('svg', svg => {
         const react = svg.getBoundingClientRect();
-        return { x: Math.floor(react.left), y: Math.floor(react.top), width: Math.ceil(react.width), height: Math.ceil(react.height) };
+        return {
+          x: Math.floor(react.left),
+          y: Math.floor(react.top),
+          width: Math.ceil(react.width),
+          height: Math.ceil(react.height)
+        };
+      });
+      yield page.setViewport({
+        width: clip.x + clip.width,
+        height: clip.y + clip.height,
+        deviceScaleFactor
+      });
+      yield page.screenshot({
+        path: output,
+        clip,
+        omitBackground: backgroundColor === 'transparent'
       });
-      yield page.setViewport({ width: clip.x + clip.width, height: clip.y + clip.height, deviceScaleFactor });
-      yield page.screenshot({ path: output, clip, omitBackground: backgroundColor === 'transparent' });
     } else {
       // pdf
       if (pdfFit) {
-        const clip = yield page.$eval('svg', function (svg) {
+        const clip = yield page.$eval('svg', svg => {
           const react = svg.getBoundingClientRect();
-          return { x: react.left, y: react.top, width: react.width, height: react.height };
+          return {
+            x: react.left,
+            y: react.top,
+            width: react.width,
+            height: react.height
+          };
         });
         yield page.pdf({
           path: output,
@@ -200,22 +260,28 @@ const parseMMD = (() => {
   return function parseMMD(_x2, _x3, _x4) {
     return _ref2.apply(this, arguments);
   };
-})();
+}();
 
 _asyncToGenerator(function* () {
   const browser = yield puppeteer.launch(puppeteerConfig);
   const definition = yield getInputData(input);
+
   if (/\.md$/.test(input)) {
     const matches = definition.match(/^```(?:mermaid)(\n([\s\S]*?))```$/gm);
-    if (matches.length > 0) {
-      const mmdStrings = matches.map(function (str) {
-        return str.replace(/^```(?:mermaid)(\n([\s\S]*?))```$/, '$1').trim();
-      });
-      yield Promise.all(mmdStrings.map(function (mmdString, index) {
-        return parseMMD(browser, mmdString, output.replace(/(\..*)$/, `-${index + 1}$1`));
+
+    if (matches !== null) {
+      info(`Found ${matches.length} mermaid charts in Markdown input`);
+      const mmdStrings = matches.map(str => str.replace(/^```(?:mermaid)(\n([\s\S]*?))```$/, '$1').trim());
+      yield Promise.all(mmdStrings.map((mmdString, index) => {
+        const output_file = output.replace(/(\..*)$/, `-${index + 1}$1`);
+        info(` - ${output_file}`);
+        return parseMMD(browser, mmdString, output_file);
       }));
+    } else {
+      info(`No mermaid charts found in Markdown input`);
     }
   } else {
+    info(`Generating single mermaid chart`);
     yield parseMMD(browser, definition, output);
   }