generator-pyhipster/cli/utils.js

Python (Flask) + Angular/React/Vue in one handy generator

/**
 * Copyright 2013-2022 the original author or authors from the JHipster project.
 *
 * This file is part of the JHipster project, see https://www.jhipster.tech/
 * for more information.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/* eslint-disable no-console */
const chalk = require('chalk');
const _ = require('lodash');

const CLI_NAME = 'pyhipster';
const GENERATOR_NAME = 'generator-phipster';

const SUCCESS_MESSAGE = 'Congratulations, PyHipster execution is complete!';
const SPONSOR_MESSAGE = 'Show us some ❤️  by sponsoring us.';

const debug = function (msg) {
  if (this.debugEnabled) {
    console.log(`${chalk.blue('DEBUG!')}  ${msg}`);
  }
};

const info = function (msg) {
  console.info(`${chalk.green.bold('INFO!')} ${msg}`);
};

const log = function (msg) {
  console.log(msg);
};

const error = function (msg, trace) {
  console.error(`${chalk.red(msg)}`);
  if (trace) {
    console.log(trace);
  }
  process.exitCode = 1;
};

/**
 *  Use with caution.
 *  process.exit is not recommended by Node.js.
 *  Refer to https://nodejs.org/api/process.html#process_process_exit_code.
 */
const fatal = function (msg, trace) {
  console.error(`${chalk.red(msg)}`);
  if (trace) {
    console.log(trace);
  }
  process.exit(1);
};

const init = function (program) {
  program.option('-d, --debug', 'enable debugger');

  this.debugEnabled = process.argv.includes('-d') || process.argv.includes('--debug'); // Need this early
  if (this.debugEnabled) {
    info('Debug logging is on');
  }
};

const logger = {
  init,
  debug,
  info,
  log,
  error,
  fatal,
};

const toString = item => {
  if (typeof item == 'object') {
    if (Array.isArray(item)) {
      return item.map(it => toString(it)).join(', ');
    }
    return Object.keys(item)
      .map(k => `${k}: ${typeof item[k] != 'function' && typeof item[k] != 'object' ? toString(item[k]) : 'Object'}`)
      .join(', ');
  }
  return item ? item.toString() : item;
};

/* Convert option objects to command line args */
const getOptionAsArgs = (options = {}) => {
  options = Object.fromEntries(
    Object.entries(options).map(([key, value]) => {
      return [_.kebabCase(key), value];
    })
  );
  const args = Object.entries(options)
    .map(([key, value]) => {
      const prefix = key.length === 1 ? '-' : '--';
      if (value === true) {
        return `${prefix}${key}`;
      }
      if (value === false) {
        return `${prefix}no-${key}`;
      }
      return value !== undefined ? [`${prefix}${key}`, `${value}`] : undefined;
    })
    .filter(arg => arg !== undefined);
  logger.debug(`converted options: ${args}`);
  return args.flat();
};

/**
 *  Get options for the command
 */
const getCommand = (cmd, args = []) => {
  let cmdArgs;
  if (args.length > 0) {
    logger.debug('Arguments found');
    args = args.flat();
    cmdArgs = args.join(' ').trim();
    logger.debug(`cmdArgs: ${cmdArgs}`);
  }
  return `${cmd}${cmdArgs ? ` ${cmdArgs}` : ''}`;
};

const doneFactory = (successMsg, sponsorMsg) => {
  return errorOrMsg => {
    if (errorOrMsg instanceof Error) {
      logger.error(`ERROR! ${errorOrMsg.message}`, errorOrMsg);
    } else if (errorOrMsg) {
      logger.error(`ERROR! ${errorOrMsg}`);
    } else if (successMsg) {
      logger.log(chalk.green.bold(successMsg));
      logger.log(chalk.cyan.bold(sponsorMsg));
    }
  };
};

const printSuccess = () => {
  if (process.exitCode === undefined || process.exitCode === 0) {
    logger.log(chalk.green.bold(SUCCESS_MESSAGE));
    logger.log(chalk.cyan.bold(SPONSOR_MESSAGE));
  } else {
    logger.error(`ERROR! PyHipster finished with code ${process.exitCode}`);
  }
};

module.exports = {
  CLI_NAME,
  GENERATOR_NAME,
  toString,
  logger,
  getCommand,
  doneFactory,
  done: doneFactory(SUCCESS_MESSAGE, SPONSOR_MESSAGE),
  printSuccess,
  getOptionAsArgs,
};