errorMessageAndExit

Author: codeBelt

package.json

@@ -51,6 +51,7 @@
     "dist/"
   ],
   "dependencies": {
+    "colors": "1.4.0",
     "enquirer": "2.3.5",
     "path-exists": "4.0.0",
     "recursive-copy": "2.0.10",

src/GenerateTemplateFiles.ts

@@ -10,10 +10,10 @@ import IReplacer from './models/IReplacer';
 import IResults from './models/IResults';
 import IDefaultCaseConverter from './models/IDefaultCaseConverter';
 import {
-    throwErrorIfNoConfigItems,
-    throwErrorIfOptionNameIsNotFound,
-    throwErrorIfNoStringOrDynamicReplacers,
-    throwErrorIfStringReplacersDoNotMatch,
+    errorIfNoConfigItems,
+    errorIfOptionNameIsNotFound,
+    errorIfNoStringOrDynamicReplacers,
+    errorIfStringReplacersDoNotMatch,
 } from './utilities/CheckUtility';
 import IReplacerSlotQuestion from './models/IReplacerSlotQuestion';
 import yargs from 'yargs';
@@ -25,8 +25,8 @@ export default class GenerateTemplateFiles {
      * Main method to create your template files. Accepts an array of `IConfigItem` items.
      */
     public async generate(options: IConfigItem[]): Promise<void> {
-        throwErrorIfNoConfigItems(options);
-        throwErrorIfNoStringOrDynamicReplacers(options);
+        errorIfNoConfigItems(options);
+        errorIfNoStringOrDynamicReplacers(options);
 
         const selectedConfigItem: IConfigItem = await this._getSelectedItem(options);
         const answeredReplacers: IReplacer[] = await this._getReplacerSlotValues(selectedConfigItem);
@@ -40,8 +40,8 @@ export default class GenerateTemplateFiles {
     public async commandLine(options: IConfigItem[]): Promise<void> {
         this._isCommandLine = true;
 
-        throwErrorIfNoConfigItems(options);
-        throwErrorIfNoStringOrDynamicReplacers(options);
+        errorIfNoConfigItems(options);
+        errorIfNoStringOrDynamicReplacers(options);
 
         const [templateName = '', ...replacers] = yargs.argv._;
         const selectedConfigItem: IConfigItem | undefined = options.find((configItem: IConfigItem) => {
@@ -51,7 +51,7 @@ export default class GenerateTemplateFiles {
             );
         });
 
-        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('=');
@@ -62,7 +62,7 @@ export default class GenerateTemplateFiles {
             };
         });
 
-        throwErrorIfStringReplacersDoNotMatch(selectedConfigItem, commandLineStringReplacers);
+        errorIfStringReplacersDoNotMatch(selectedConfigItem, commandLineStringReplacers);
 
         const dynamicReplacers: IReplacer[] = selectedConfigItem?.dynamicReplacers || [];
 

src/utilities/CheckUtility.ts

@@ -2,6 +2,19 @@ import IConfigItem from '../models/IConfigItem';
 import IReplacer from '../models/IReplacer';
 import StringUtility from './StringUtility';
 import IReplacerSlotQuestion from '../models/IReplacerSlotQuestion';
+import colors from 'colors';
+
+/**
+ * https://timber.io/blog/creating-a-real-world-cli-app-with-node/#errors-and-exit-codes
+ * @param message
+ * @param isError
+ */
+export const errorMessageAndExit = (isError: boolean, message: string) => {
+    if (isError) {
+        console.error(colors.bold.red(`[Error in generate-template-files]:`), colors.red(message));
+        process.exit(1);
+    }
+};
 
 export const isBooleanType = (value: any) => {
     return typeof value === 'boolean';
@@ -22,26 +35,23 @@ export const errorIfFalse = (isError: boolean, errorMessage: string): Error | vo
     }
 };
 
-export const throwErrorIfNoConfigItems = (options: IConfigItem[]) => {
+export const errorIfNoConfigItems = (options: IConfigItem[]) => {
     const hasAtLeastOneItem = Boolean(options?.length);
 
-    if (!hasAtLeastOneItem) {
-        throw new Error('There was no IConfigItem items found.');
-    }
+    errorMessageAndExit(!hasAtLeastOneItem, 'There was no IConfigItem items found.');
 };
 
-export const throwErrorIfOptionNameIsNotFound = (item: IConfigItem | undefined, templateName: string) => {
-    if (!item) {
-        throw new Error(`No IConfigItem found for ${templateName}`);
-    }
+export const errorIfOptionNameIsNotFound = (item: IConfigItem | undefined, templateName: string) => {
+    errorMessageAndExit(!item, `No IConfigItem found for ${templateName}`);
 };
 
-export const throwErrorIfStringReplacersDoNotMatch = (item: IConfigItem | undefined, commandLineStringReplacers: IReplacer[]) => {
+export const errorIfStringReplacersDoNotMatch = (item: IConfigItem | undefined, commandLineStringReplacers: IReplacer[]) => {
     const configItemStringReplacers: (string | IReplacerSlotQuestion)[] = item?.stringReplacers ?? [];
 
-    if (commandLineStringReplacers.length !== configItemStringReplacers.length) {
-        throw new Error('IConfigItem stringReplacers do not match the command line arguments.');
-    }
+    errorMessageAndExit(
+        commandLineStringReplacers.length !== configItemStringReplacers.length,
+        'IConfigItem stringReplacers do not match the command line arguments.'
+    );
 
     const configItemStringReplacersKeys = configItemStringReplacers
         .map((replacer: string | IReplacerSlotQuestion) => {
@@ -55,20 +65,17 @@ export const throwErrorIfStringReplacersDoNotMatch = (item: IConfigItem | undefi
         .sort()
         .join(', ');
 
-    if (configItemStringReplacersKeys !== commandLineStringReplacersKeys) {
-        throw new Error(
-            ` ${configItemStringReplacersKeys} does not match ${commandLineStringReplacersKeys}. IConfigItem stringReplacers do not match the command line arguments.`
-        );
-    }
+    errorMessageAndExit(
+        configItemStringReplacersKeys !== commandLineStringReplacersKeys,
+        `${configItemStringReplacersKeys} does not match ${commandLineStringReplacersKeys}. IConfigItem stringReplacers do not match the command line arguments.`
+    );
 };
 
-export const throwErrorIfNoStringOrDynamicReplacers = (options: IConfigItem[]) => {
+export const errorIfNoStringOrDynamicReplacers = (options: IConfigItem[]) => {
     const hasStringOrDynamicReplacers =
         options.every((item: IConfigItem) => {
             return Boolean(item?.stringReplacers?.length) || Boolean(item?.dynamicReplacers?.length);
         }) && options.length > 0;
 
-    if (!hasStringOrDynamicReplacers) {
-        throw new Error('IConfigItem needs to have a stringReplacers or dynamicReplacers.');
-    }
+    errorMessageAndExit(!hasStringOrDynamicReplacers, 'IConfigItem needs to have a stringReplacers or dynamicReplacers.');
 };

yarn.lock

@@ -1880,6 +1880,11 @@ color-name@~1.1.4:
   resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
   integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==
 
+colors@1.4.0:
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/colors/-/colors-1.4.0.tgz#c50491479d4c1bdaed2c9ced32cf7c7dc2360f78"
+  integrity sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==
+
 combined-stream@^1.0.6, combined-stream@~1.0.6:
   version "1.0.8"
   resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.8.tgz#c3d45a8b34fd730631a110a8a2520682b31d5a7f"