Merge branch 'command-line-3.0' into prettier

# Conflicts:
#	src/GenerateTemplateFiles.ts
#	src/utilities/CheckUtility.test.ts
#	src/utilities/CheckUtility.ts

Author: codeBelt

src/GenerateTemplateFiles.ts

@@ -10,10 +10,13 @@ import IReplacer from './models/IReplacer';
 import IResults from './models/IResults';
 import IDefaultCaseConverter from './models/IDefaultCaseConverter';
 import {
-  errorIfNoConfigItems,
-  errorIfOptionNameIsNotFound,
-  errorIfNoStringOrDynamicReplacers,
-  errorIfStringReplacersDoNotMatch,
+  throwErrorIfNoConfigItems,
+  throwErrorIfOptionNameIsNotFound,
+  throwErrorIfNoStringOrDynamicReplacers,
+  throwErrorIfStringReplacersDoNotMatch,
+  displayError,
+  displayWarning,
+  displaySuccess,
 } from './utilities/CheckUtility';
 import IReplacerSlotQuestion from './models/IReplacerSlotQuestion';
 import yargs from 'yargs';
@@ -25,13 +28,17 @@ export default class GenerateTemplateFiles {
    * Main method to create your template files. Accepts an array of `IConfigItem` items.
    */
   public async generate(options: IConfigItem[]): Promise<void> {
-    errorIfNoConfigItems(options);
-    errorIfNoStringOrDynamicReplacers(options);
+    try {
+      throwErrorIfNoConfigItems(options);
+      throwErrorIfNoStringOrDynamicReplacers(options);
 
-    const selectedConfigItem: IConfigItem = await this._getSelectedItem(options);
-    const answeredReplacers: IReplacer[] = await this._getReplacerSlotValues(selectedConfigItem);
+      const selectedConfigItem: IConfigItem = await this._getSelectedItem(options);
+      const answeredReplacers: IReplacer[] = await this._getReplacerSlotValues(selectedConfigItem);
 
-    await this._outputFiles(selectedConfigItem, answeredReplacers);
+      await this._outputFiles(selectedConfigItem, answeredReplacers);
+    } catch (error) {
+      displayError(error.message);
+    }
   }
 
   /**
@@ -40,39 +47,45 @@ export default class GenerateTemplateFiles {
   public async commandLine(options: IConfigItem[]): Promise<void> {
     this._isCommandLine = true;
 
-    errorIfNoConfigItems(options);
-    errorIfNoStringOrDynamicReplacers(options);
+    try {
+      throwErrorIfNoConfigItems(options);
+      throwErrorIfNoStringOrDynamicReplacers(options);
+
+      const [templateName = '', ...replacers] = yargs.argv._;
+      const selectedConfigItem: IConfigItem | undefined = options.find(
+        (configItem: IConfigItem) => {
+          return (
+            StringUtility.toCase(configItem.option, CaseConverterEnum.KebabCase) ===
+            StringUtility.toCase(templateName, CaseConverterEnum.KebabCase)
+          );
+        }
+      );
 
-    const [templateName = '', ...replacers] = yargs.argv._;
-    const selectedConfigItem: IConfigItem | undefined = options.find((configItem: IConfigItem) => {
-      return (
-        StringUtility.toCase(configItem.option, CaseConverterEnum.KebabCase) ===
+      throwErrorIfOptionNameIsNotFound(
+        selectedConfigItem,
         StringUtility.toCase(templateName, CaseConverterEnum.KebabCase)
       );
-    });
-
-    errorIfOptionNameIsNotFound(
-      selectedConfigItem,
-      StringUtility.toCase(templateName, CaseConverterEnum.KebabCase)
-    );
 
-    const commandLineStringReplacers: IReplacer[] = replacers.map((str: string) => {
-      const [slot, slotValue] = str.split('=');
+      const commandLineStringReplacers: IReplacer[] = replacers.map((str: string) => {
+        const [slot, slotValue] = str.split('=');
 
-      return {
-        slot,
-        slotValue,
-      };
-    });
+        return {
+          slot,
+          slotValue,
+        };
+      });
 
-    errorIfStringReplacersDoNotMatch(selectedConfigItem, commandLineStringReplacers);
+      throwErrorIfStringReplacersDoNotMatch(selectedConfigItem, commandLineStringReplacers);
 
-    const dynamicReplacers: IReplacer[] = selectedConfigItem?.dynamicReplacers || [];
+      const dynamicReplacers: IReplacer[] = selectedConfigItem?.dynamicReplacers || [];
 
-    await this._outputFiles(selectedConfigItem!, [
-      ...commandLineStringReplacers,
-      ...dynamicReplacers,
-    ]);
+      await this._outputFiles(selectedConfigItem!, [
+        ...commandLineStringReplacers,
+        ...dynamicReplacers,
+      ]);
+    } catch (error) {
+      displayError(error.message);
+    }
   }
 
   private async _outputFiles(
@@ -86,10 +99,10 @@ export default class GenerateTemplateFiles {
     const shouldWriteFiles: boolean = await this._shouldWriteFiles(outputPath, selectedConfigItem);
 
     if (shouldWriteFiles === false) {
-      console.info('No new files created');
+      displayWarning('No new files created');
 
       if (this._isCommandLine) {
-        console.info('Use --overwrite option to overwrite existing files');
+        displayWarning('Use --overwrite option to overwrite existing files');
       }
 
       return;
@@ -314,11 +327,11 @@ export default class GenerateTemplateFiles {
     try {
       await recursiveCopy(entryFolderPath, outputPath, recursiveCopyOptions);
 
-      console.info(`Files saved to: '${outputPath}'`);
+      displaySuccess(`Files saved to: '${outputPath}'`);
 
       return outputtedFilesAndFolders.filter(Boolean);
     } catch (error) {
-      console.error(`Copy failed: ${error}`);
+      displayError(`Copy failed: ${error}`);
 
       return [`Copy failed: ${error}`];
     }

src/utilities/CheckUtility.test.ts

@@ -7,7 +7,7 @@ describe('displayError', () => {
   test('should throw an error if condition is false', () => {
     console.info = jest.fn();
 
-    displayError(true, errorString);
+    displayError(errorString);
 
     expect(console.info).toHaveBeenCalledWith(
       colors.bold.red(`[Error in generate-template-files]: ${colors.red(errorString)}`)

src/utilities/CheckUtility.ts

@@ -4,45 +4,44 @@ import StringUtility from './StringUtility';
 import IReplacerSlotQuestion from '../models/IReplacerSlotQuestion';
 import colors from 'colors';
 
-export const isBooleanType = (value: unknown): value is boolean => {
-  return typeof value === 'boolean';
+export const displayError = (message: string): Error | void => {
+  console.info(colors.bold.red(`[Error in generate-template-files]: ${colors.red(message)}`));
 };
 
-export const displayError = (isError: boolean, errorMessage: string): Error | void => {
-  if (isError) {
-    try {
-      throw new Error(errorMessage);
-    } catch (error) {
-      console.info(
-        colors.bold.red(`[Error in generate-template-files]: ${colors.red(error.message)}`)
-      );
-    }
-  }
+export const displayWarning = (message: string): Error | void => {
+  console.info(colors.bold.yellow(colors.yellow(message)));
+};
+
+export const displaySuccess = (message: string): Error | void => {
+  console.info(colors.bold.green(colors.green(message)));
 };
 
-export const errorIfNoConfigItems = (options: IConfigItem[]) => {
+export const throwErrorIfNoConfigItems = (options: IConfigItem[]) => {
   const hasAtLeastOneItem = Boolean(options?.length);
 
-  displayError(!hasAtLeastOneItem, 'There was no IConfigItem items found.');
+  if (!hasAtLeastOneItem) {
+    throw new Error('There was no IConfigItem items found.');
+  }
 };
 
-export const errorIfOptionNameIsNotFound = (
+export const throwErrorIfOptionNameIsNotFound = (
   item: IConfigItem | undefined,
   templateName: string
 ) => {
-  displayError(!item, `No IConfigItem found for ${templateName}`);
+  if (!item) {
+    throw new Error(`No IConfigItem found for ${templateName}`);
+  }
 };
 
-export const errorIfStringReplacersDoNotMatch = (
+export const throwErrorIfStringReplacersDoNotMatch = (
   item: IConfigItem | undefined,
   commandLineStringReplacers: IReplacer[]
 ) => {
   const configItemStringReplacers: (string | IReplacerSlotQuestion)[] = item?.stringReplacers ?? [];
 
-  displayError(
-    commandLineStringReplacers.length !== configItemStringReplacers.length,
-    'IConfigItem stringReplacers do not match the command line arguments.'
-  );
+  if (commandLineStringReplacers.length !== configItemStringReplacers.length) {
+    throw new Error('IConfigItem stringReplacers do not match the command line arguments.');
+  }
 
   const configItemStringReplacersKeys = configItemStringReplacers
     .map((replacer: string | IReplacerSlotQuestion) => {
@@ -56,20 +55,20 @@ export const errorIfStringReplacersDoNotMatch = (
     .sort()
     .join(', ');
 
-  displayError(
-    configItemStringReplacersKeys !== commandLineStringReplacersKeys,
-    `${configItemStringReplacersKeys} does not match ${commandLineStringReplacersKeys}.`
-  );
+  if (configItemStringReplacersKeys !== commandLineStringReplacersKeys) {
+    throw new Error(
+      `${configItemStringReplacersKeys} does not match ${commandLineStringReplacersKeys}.`
+    );
+  }
 };
 
-export const errorIfNoStringOrDynamicReplacers = (options: IConfigItem[]) => {
+export const throwErrorIfNoStringOrDynamicReplacers = (options: IConfigItem[]) => {
   const hasStringOrDynamicReplacers =
     options.every((item: IConfigItem) => {
       return Boolean(item?.stringReplacers?.length) || Boolean(item?.dynamicReplacers?.length);
     }) && options.length > 0;
 
-  displayError(
-    !hasStringOrDynamicReplacers,
-    'IConfigItem needs to have a stringReplacers or dynamicReplacers.'
-  );
+  if (!hasStringOrDynamicReplacers) {
+    throw new Error('IConfigItem needs to have a stringReplacers or dynamicReplacers.');
+  }
 };