cli.js

#!/usr/bin/env node

const meow = require('meow');
const path = require('path');
const {
  join: joinPath,
  delimiter: pathDelimiter
} = path;
const chalk = require('chalk');

const error = chalk.bold.red;

const {
  convertAll
} = require('./');


const cli = meow(`
  Usage

    $ bpmn-to-image <diagramFile>${pathDelimiter}<outputConfig> ...

  Options

    diagramFile                    Path to BPMN diagram
    outputConfig                   List of extension or output file paths

    --min-dimensions=<dimensions>  Minimum size in pixels (<width>x<height>)

    --title=<title>                Add explicit <title> to exported image
    --no-title                     Don't display title on exported image

    --no-footer                    Strip title and logo from image

    --scale                        Scale factor for images (1)

    --zoom-to-element              Zoom to an Element by its ID

    --zoom                         Diagram zoom factor

    --size                         The size of the image in pixels (<width>x<height>)

  Examples

    # export to diagram.png
    $ bpmn-to-image diagram.bpmn${pathDelimiter}diagram.png

    # export diagram.png and /tmp/diagram.pdf
    $ bpmn-to-image diagram.bpmn${pathDelimiter}diagram.png,/tmp/diagram.pdf

    # export with minimum size of 500x300 pixels
    $ bpmn-to-image --min-dimensions=500x300 diagram.bpmn${pathDelimiter}png

    # export with zoom on Task_0l0q2kz
    $ bpmn-to-image --zoom-to-element=Task_0l0q2kz diagram.bpmn${pathDelimiter}png

    # export with 350% zoom on Task_0l0q2kz
    $ bpmn-to-image --zoom-to-element=Task_0l0q2kz diagram.bpmn${pathDelimiter}png --zoom 3.5

    # export with an image size of 200x200
    $ bpmn-to-image diagram.bpmn${pathDelimiter}png --size 200x200
`, {
  flags: {
    minDimensions: {
      type: 'string',
      default: '400x300'
    },
    title: {
      default: true
    },
    footer: {
      default: true
    },
    scale: {
      default: 1
    },
    zoomToElement: {
      type: 'string',
      default: undefined
    },
    zoom: {
      default: 1
    },
    size: {
      type: 'string',
      default: '',
    }
  }
});

if (cli.input.length === 0) {
  cli.showHelp(1);
}

const conversions = cli.input.map(function(conversion) {

  const hasDelimiter = conversion.includes(pathDelimiter);
  if (!hasDelimiter) {
     console.error(error(`  Error: no <diagramFile>${pathDelimiter}<outputConfig> param provided`));
     cli.showHelp(1);
  }

  const [
    input,
    output
  ] = conversion.split(pathDelimiter);

  const outputs = output.split(',').reduce(function(outputs, file, idx) {

    // just extension
    if (file.indexOf('.') === -1) {
      const baseName = path.basename(idx === 0 ? input : outputs[idx - 1]);

      const name = baseName.substring(0, baseName.lastIndexOf('.'));

      return [ ...outputs, `${name}.${file}` ];
    }

    return [ ...outputs, file ];
  }, []);

  return {
    input,
    outputs
  }
});

const footer = cli.flags.footer;

const title = cli.flags.title === false ? false : cli.flags.title;

const scale = cli.flags.scale !== undefined ? cli.flags.scale : 1;

const zoomToElement = cli.flags.zoomToElement?.trim() !== '' ? cli.flags.zoomToElement : undefined;

const zoom = cli.flags.zoom === true ? 1 : cli.flags.zoom;

const [ width, height ] = cli.flags.minDimensions.split('x').map(function(d) {
  return parseInt(d, 10);
});

const [ imageWidth, imageHeight ] = cli.flags.size.split('x').map(function(d) {
  return parseInt(d, 10);
});

const size = (imageWidth == null || isNaN(imageWidth)) || (imageHeight == null || isNaN(imageHeight)) ? undefined : { imageWidth, imageHeight };

convertAll(conversions, {
  minDimensions: { width, height },
  title,
  footer,
  deviceScaleFactor: scale,
  zoomToElement,
  diagramZoom: zoom,
  size: size
}).catch(function(e) {
  console.error('failed to export diagram(s)');
  console.error(e);

  process.exit(1);
});