water-plant-uml/water-uml.js

CLI tool for live-reloading and/or exporting PlantUML diagrams using the default PlantUML server or a local Docker server.

#!/usr/bin/env node
const yargs = require('yargs/yargs');
const { terminalWidth } = require('yargs');
const { OUTPUT_FILES } = require('./src/constants');
const path = require('path');

process.env.SCRIPT_PATH = process.cwd();

yargs(process.argv.slice(2))
  .scriptName('water-uml')
  .usage('Usage: $0 <command> <filename.puml> [options]')
  .command(
    'live',
    'Start live reload server on <reload-port> for filename.puml',
    () => {},
    (args) => {
      if (!args.root) {
        args.root = process.cwd();
      }
      // Set yarg args to globals on process.env
      overwriteEnvs({
        FILE_NAME: args._[1],
        OUTPUT_FILE_TYPE: args.fileType,
        LIVE_RELOAD_PORT: args.livePort,
        USE_LOCAL_SERVER: args.local,
        LOCAL_SERVER_PORT: args.localPort,
        OUTPUT_OVERRIDE: 'undefined',
        OPEN: args.open,
        ROOT: path.isAbsolute(args.root)
          ? args.root
          : path.join(process.cwd(), args.root),
      });
      require('./src/server');
    }
  )
  .command(
    'export',
    'Export filename.puml to filename.<file-type>',
    () => {},
    async (args) => {
      if (!args.root) {
        args.root = process.cwd();
      }
      // Set yarg args to globals on process.env
      overwriteEnvs({
        FILE_NAME: args._[1],
        OUTPUT_FILE_TYPE: args.fileType,
        USE_LOCAL_SERVER: args.local,
        LOCAL_SERVER_PORT: args.localPort,
        REMOTE_PUML_SERVER: args.remoteServer,
        OUTPUT_OVERRIDE: args.output,
        ROOT: path.isAbsolute(args.root)
          ? args.root
          : path.join(process.cwd(), args.root),
      });
      return require('./src/export');
    }
  )
  .example(
    '$0 live example.puml -p 8085',
    'Run live reload server on localhost:8085'
  )
  .example(
    '$0 live example.puml -l -d 8675',
    'Runs live reload server on localhost:8088 (default) using local PlantUML server on localhost:8675 to render images.'
  )
  .example('$0 export example.puml', 'Exports example.puml to example.svg')
  .example(
    '$0 export example.puml -t md',
    'Exports example.puml as an embeded image in example.md'
  )
  .example(
    '$0 export example.puml -o ~/Diagrams/example.txt',
    'Exports example.puml as an ASCII txt diagram in ~/Diagrams/example.txt'
  )
  .options({
    p: {
      alias: 'live-port',
      type: 'string',
      describe: 'Port live reload server should run on',
      nargs: 1,
      default: 8088,
    },
    l: {
      alias: 'local',
      type: 'boolean',
      describe: 'Use local PlantUML server running on localhost:<live-port>',
      nargs: 0,
      default: false,
    },
    d: {
      alias: 'local-port',
      type: 'string',
      describe: 'Port local PlantUML server is running on',
      nargs: 1,
      default: 8792,
    },
    f: {
      alias: 'file-type',
      type: 'string',
      describe: 'Output filetype of PlantUML diagram export',
      nargs: 1,
      default: 'svg',
      choices: OUTPUT_FILES,
    },
    r: {
      alias: 'remote-server',
      type: 'string',
      describe: 'Server used for rendering images.',
      nargs: 1,
      default: 'http://www.plantuml.com/plantuml',
    },
    o: {
      alias: 'output',
      type: 'string',
      describe:
        'Output path of export. Defaults to input-file-path.<file-type>',
      nargs: 1,
    },
    O: {
      alias: 'open',
      type: 'string',
      describe:
        'Automatically open a browser window in live-reload',
      nargs: 1,
      default: true,
    },
    R: {
      alias: 'root',
      type: 'string',
      describe: 'Root of your UML files. Defaults to current dir',
      nargs: 1,
    },
  })
  .wrap(Math.min(120, terminalWidth()))
  .help('h')
  .alias('h', 'help')
  .version()
  // Check that command and .puml filename are passed
  .check((argv) => {
    const commands = ['live', 'export'];
    const filePaths = argv._;
    if (filePaths.length < 1) {
      throw new Error('Please specify a valid command. "live" or "export"');
    } else if (filePaths.length < 2) {
      if (commands.includes(filePaths[0])) {
        throw new Error('Please pass a PlantUML (.puml) file path.');
      } else {
        throw new Error('Please specify a valid command. "live" or "export"');
      }
    } else {
      return true;
    }
  }).argv;

// Apply yarg args to globals in process.env
function overwriteEnvs(optMap) {
  Object.entries(optMap).forEach((entry) => {
    process.env[entry[0]] = entry[1];
  });
}