@rockcarver/frodo-cli 0.14.0 → 0.15.0

package/src/utils/Console.ts

@@ -1,483 +0,0 @@
-import { SingleBar, Presets } from 'cli-progress';
-import { createSpinner } from 'nanospinner';
-import Table from 'cli-table3';
-import { state } from '@rockcarver/frodo-lib';
-import Color from 'colors';
-
-Color.enable();
-
-/**
- * Output a data message
- * @param {Object} message the message
- */
-function data(message) {
-  switch (typeof message) {
-    case 'object':
-      console.dir(message, { depth: 3 });
-      break;
-    default:
-      console.log(message);
-  }
-}
-
-/**
- * Output a text message
- * @param {Object} message the message
- */
-function text(message) {
-  switch (typeof message) {
-    case 'object':
-      console.dir(message, { depth: 3 });
-      break;
-    default:
-      console.error(message);
-  }
-}
-
-/**
- * Output an info message
- * @param {Object} message the message
- */
-function info(message) {
-  switch (typeof message) {
-    case 'object':
-      console.dir(message, { depth: 3 });
-      break;
-    default:
-      console.error(message.brightCyan);
-  }
-}
-
-/**
- * Output a warn message
- * @param {Object} message the message
- */
-function warn(message) {
-  switch (typeof message) {
-    case 'object':
-      console.dir(message, { depth: 3 });
-      break;
-    default:
-      console.error(message.yellow);
-  }
-}
-
-/**
- * Output an error message
- * @param {Object} message the message
- */
-function error(message) {
-  switch (typeof message) {
-    case 'object':
-      console.dir(message, { depth: 4 });
-      break;
-    default:
-      console.error(message.brightRed);
-  }
-}
-
-/**
- * Prints a string message to console
- *
- * @param {string} message The string message to print
- * @param {string} [type=text] "text", "info", "warn", "error" or "data". All but
- * type="data" will be written to stderr.
- * @param {boolean} [newline=true] Whether to add a new at the end of message
- *
- */
-export function printMessage(message, type = 'text', newline = true) {
-  //   if (state.default.session.getItem('scriptFriendly')) {
-  switch (type) {
-    case 'data':
-      if (newline) {
-        data(message);
-      } else {
-        process.stdout.write(message);
-      }
-      break;
-    case 'text':
-      if (newline) {
-        text(message);
-      } else {
-        process.stderr.write(message);
-      }
-      break;
-    case 'info':
-      if (newline) {
-        info(message);
-      } else {
-        process.stderr.write(message['brightCyan']);
-      }
-      break;
-    case 'warn':
-      if (newline) {
-        warn(message);
-      } else {
-        process.stderr.write(message.yellow);
-      }
-      break;
-    case 'error':
-      if (newline) {
-        error(message);
-      } else {
-        process.stderr.write(message['brightRed']);
-      }
-      break;
-    default:
-      if (newline) {
-        error(message);
-      } else {
-        process.stderr.write(message['bgBrightRed']);
-      }
-  }
-}
-
-/**
- * Creates a progress bar on stderr
- *
- * Example:
- * [========================================] 100% | 49/49 | Analyzing journey - transactional_auth
- *
- * @param {Number} total The total number of entries to track progress for
- * @param {String} message optional progress bar message
- * @param {Object} options progress bar configuration options
- *
- */
-export function createProgressBar(
-  total,
-  message = null,
-  options = {
-    format: '[{bar}] {percentage}% | {value}/{total} | {data}',
-    noTTYOutput: true,
-  }
-) {
-  let opt = options;
-  if (message == null) {
-    opt = {
-      format: '[{bar}] {percentage}% | {value}/{total}',
-      noTTYOutput: true,
-    };
-  }
-  let pBar = state.default.session.getItem('progressBar');
-  if (!pBar) pBar = new SingleBar(opt, Presets.legacy); // create only when needed
-  pBar.start(total, 0, {
-    data: message,
-  });
-  state.default.session.setItem('progressBar', pBar);
-}
-
-/**
- * Updates the progress bar by 1
- * @param {string} message optional message to update the progress bar
- *
- */
-export function updateProgressBar(message = null) {
-  const pBar = state.default.session.getItem('progressBar');
-  if (message)
-    pBar.increment({
-      data: message,
-    });
-  else pBar.increment();
-}
-
-/**
- * Stop and hide the progress bar
- * @param {*} message optional message to update the progress bar
- */
-export function stopProgressBar(message = null) {
-  const pBar = state.default.session.getItem('progressBar');
-  if (message)
-    pBar.update({
-      data: message,
-    });
-  pBar.stop();
-}
-
-/**
- * Create the spinner
- * @param {String} message optional spinner message
- */
-export function showSpinner(message) {
-  const spinner = createSpinner(message).start();
-  state.default.session.setItem('Spinner', spinner);
-}
-
-/**
- * Stop the spinner
- * @param {String} message optional message to update the spinner
- */
-export function stopSpinner(message = null) {
-  const spinner = state.default.session.getItem('Spinner');
-  if (spinner) {
-    let options = {};
-    if (message) options = { text: message };
-    spinner.stop(options);
-  }
-}
-
-/**
- * Succeed the spinner. Stop and render success checkmark with optional message.
- * @param {String} message optional message to update the spinner
- */
-export function succeedSpinner(message = null) {
-  const spinner = state.default.session.getItem('Spinner');
-  if (spinner) {
-    let options = {};
-    if (message) options = { text: message };
-    spinner.success(options);
-  }
-}
-
-/**
- * Warn the spinner
- * @param {String} message optional message to update the spinner
- */
-export function warnSpinner(message = null) {
-  const spinner = state.default.session.getItem('Spinner');
-  if (spinner) {
-    let options = {};
-    if (message) options = { text: message };
-    spinner.warn(options);
-  }
-}
-
-/**
- * Fail the spinner
- * @param {String} message optional message to update the spinner
- */
-export function failSpinner(message = null) {
-  const spinner = state.default.session.getItem('Spinner');
-  if (spinner) {
-    let options = {};
-    if (message) options = { text: message };
-    spinner.error(options);
-  }
-}
-
-/**
- * Spin the spinner
- * @param {String} message optional message to update the spinner
- */
-export function spinSpinner(message = null) {
-  const spinner = state.default.session.getItem('Spinner');
-  if (spinner) {
-    let options = {};
-    if (message) options = { text: message };
-    spinner.update(options);
-    spinner.spin();
-  }
-}
-
-export function createProgressIndicator(
-  type = 'determinate',
-  total = 0,
-  message = null
-) {
-  if (type === 'determinate') {
-    createProgressBar(total, message);
-  } else {
-    showSpinner(message);
-  }
-}
-
-export function updateProgressIndicator(message) {
-  const progressBar = state.default.session.getItem('progressBar');
-  if (!progressBar) {
-    spinSpinner(message);
-  } else {
-    updateProgressBar(message);
-  }
-}
-
-export function stopProgressIndicator(message, status = 'none') {
-  const progressBar = state.default.session.getItem('progressBar');
-  if (!progressBar) {
-    switch (status) {
-      case 'none':
-        stopSpinner(message);
-        break;
-      case 'success':
-        succeedSpinner(message);
-        break;
-      case 'warn':
-        warnSpinner(message);
-        break;
-      case 'fail':
-        failSpinner(message);
-        break;
-      default:
-        stopSpinner(message);
-        break;
-    }
-  } else {
-    stopProgressBar(message);
-  }
-}
-
-/**
- * Create an empty table
- * @param {string[]} head header row as an array of strings
- * @returns {any} an empty table
- */
-export function createTable(head) {
-  const table = new Table({
-    head,
-    chars: {
-      top: '',
-      'top-mid': '',
-      'top-left': '',
-      'top-right': '',
-      bottom: '',
-      'bottom-mid': '',
-      'bottom-left': '',
-      'bottom-right': '',
-      left: '',
-      'left-mid': '',
-      mid: '',
-      'mid-mid': '',
-      right: '',
-      'right-mid': '',
-    },
-    style: { 'padding-left': 0, 'padding-right': 0, head: ['brightCyan'] },
-  });
-  return table;
-}
-
-/**
- * Create a new key/value table
- * @returns {any} an empty key/value table
- */
-export function createKeyValueTable() {
-  const table = new Table({
-    chars: {
-      top: '',
-      'top-mid': '',
-      'top-left': '',
-      'top-right': '',
-      bottom: '',
-      'bottom-mid': '',
-      'bottom-left': '',
-      'bottom-right': '',
-      left: '',
-      'left-mid': '',
-      mid: '',
-      'mid-mid': '',
-      right: '',
-      'right-mid': '',
-    },
-    style: { 'padding-left': 0, 'padding-right': 0 },
-    wordWrap: true,
-  });
-  return table;
-}
-
-/**
- * Helper function to determine the total depth of an object
- * @param {Object} object input object
- * @returns {Number} total depth of the input object
- */
-function getObjectDepth(object) {
-  return Object(object) === object
-    ? 1 + Math.max(-1, ...Object.values(object).map(getObjectDepth))
-    : 0;
-}
-
-/**
- * Helper function to determine if an object has values
- * @param {Object} object input object
- * @returns {boolean} true of the object or any of its sub-objects contain values, false otherwise
- */
-function hasValues(object) {
-  let has = false;
-  const keys = Object.keys(object);
-  for (const key of keys) {
-    if (Object(object[key]) !== object[key]) {
-      return true;
-    }
-    has = has || hasValues(object[key]);
-  }
-  return has;
-}
-
-/**
- * Helper function (recursive) to add rows to an object table
- * @param {object} object object to render
- * @param {number} depth total depth of initial object
- * @param {number} level current level
- * @param {any} table the object table to add the rows to
- * @returns the updated object table
- */
-function addRows(object, depth, level, table, keyMap) {
-  const space = '  ';
-  const keys = Object.keys(object);
-  for (const key of keys) {
-    if (Object(object[key]) !== object[key]) {
-      if (level === 1) {
-        table.push([
-          keyMap[key] ? keyMap[key].brightCyan : key['brightCyan'],
-          object[key],
-        ]);
-      } else {
-        table.push([
-          {
-            hAlign: 'right',
-            content: keyMap[key] ? keyMap[key].gray : key.gray,
-          },
-          object[key],
-        ]);
-      }
-    }
-  }
-  for (const key of keys) {
-    if (Object(object[key]) === object[key]) {
-      // only print header if there are any values below
-      if (hasValues(object[key])) {
-        let indention = new Array(level).fill(space).join('');
-        if (level < 3) indention = `\n${indention}`;
-        table.push([
-          indention.concat(
-            keyMap[key] ? keyMap[key].brightCyan : key['brightCyan']
-          ),
-          '',
-        ]);
-      }
-      // eslint-disable-next-line no-param-reassign
-      table = addRows(object[key], depth, level + 1, table, keyMap);
-    }
-  }
-  return table;
-}
-
-/**
- * Create and populate an object table from any JSON object. Use for describe commands.
- * @param {Object} object JSON object to create
- * @returns {any} a table that can be printed to the console
- */
-export function createObjectTable(object, keyMap = {}) {
-  // eslint-disable-next-line no-param-reassign
-  const depth = getObjectDepth(object);
-  // eslint-disable-next-line no-param-reassign
-  const level = 0;
-  // eslint-disable-next-line no-param-reassign
-  const table = new Table({
-    chars: {
-      top: '',
-      'top-mid': '',
-      'top-left': '',
-      'top-right': '',
-      bottom: '',
-      'bottom-mid': '',
-      'bottom-left': '',
-      'bottom-right': '',
-      left: '',
-      'left-mid': '',
-      mid: '',
-      'mid-mid': '',
-      right: '',
-      'right-mid': '',
-    },
-    style: { 'padding-left': 0, 'padding-right': 0, head: ['brightCyan'] },
-  });
-  addRows(object, depth, level + 1, table, keyMap);
-  return table;
-}

package/tsconfig.json

@@ -1,106 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-
-    /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true /* Opt a project out of multi-project reference checking when editing. */,
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-    /* Language and Environment */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "module": "ESNext",
-    "target": "ESNext",
-    // "outDir": "./types",
-    "rootDir": "./src" /* Specify the root folder within your source files. */,
-    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": []                                   /* Specify multiple folders that act like './node_modules/@types'. */,
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
-    // "checkJs": true /* Enable error reporting in type-checked JavaScript files. */,
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
-    /* Emit */
-    // "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
-    // "declarationMap": true /* Create sourcemaps for d.ts files. */,
-    // "emitDeclarationOnly": true /* Only output d.ts files and not JavaScript files. */,
-    "sourceMap": true /* Create source map files for emitted JavaScript files. */,
-    // "outFile": "./types/index.d.ts"                                     /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */,
-    // "removeComments": true,                           /* Disable emitting comments. */
-    "noEmit": true /* Disable emitting files from a compilation. */,
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* Interop Constraints */
-    "isolatedModules": false /* Ensure that each file can be safely transpiled without relying on other imports. */,
-    "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
-    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-
-    /* Type Checking */
-    "strict": true /* Enable all strict type-checking options. */,
-    "noImplicitAny": false /* Enable error reporting for expressions and declarations with an implied 'any' type. */,
-    "strictNullChecks": false /* When type checking, take into account 'null' and 'undefined'. */,
-    // "strictFunctionTypes": true                       /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */,
-    // "strictBindCallApply": true                       /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */,
-    // "strictPropertyInitialization": true              /* Check for class properties that are declared but not set in the constructor. */,
-    // "noImplicitThis": true                            /* Enable error reporting when 'this' is given the type 'any'. */,
-    "useUnknownInCatchVariables": false /* Default catch clause variables as 'unknown' instead of 'any'. */,
-    // "alwaysStrict": true                              /* Ensure 'use strict' is always emitted. */,
-    "noUnusedLocals": false /* Enable error reporting when local variables aren't read. */,
-    "noUnusedParameters": true /* Raise an error when a function parameter isn't read. */,
-    "exactOptionalPropertyTypes": false /* Interpret optional property types as written, rather than adding 'undefined'. */,
-    "noImplicitReturns": false /* Enable error reporting for codepaths that do not explicitly return in a function. */,
-    "noFallthroughCasesInSwitch": false /* Enable error reporting for fallthrough cases in switch statements. */,
-    "noUncheckedIndexedAccess": false /* Add 'undefined' to a type when accessed using an index. */,
-    "noImplicitOverride": false /* Ensure overriding members in derived classes are marked with an override modifier. */,
-    "noPropertyAccessFromIndexSignature": false /* Enforces using indexed accessors for keys declared using an indexed type. */,
-    // "allowUnusedLabels": false                        /* Disable error reporting for unused labels. */,
-    // "allowUnreachableCode": false                     /* Disable error reporting for unreachable code. */,
-
-    /* Completeness */
-    "skipDefaultLibCheck": true /* Skip type checking .d.ts files that are included with TypeScript. */,
-    "skipLibCheck": true /* Skip type checking all .d.ts files. */
-  },
-  "files": ["src/app.ts"],
-  "include": ["src/**/*.ts"],
-  "exclude": ["src/**/*.test.ts", "src/**/*.test_.ts"]
-}