@adobe/ccweb-add-on-core 0.1.0

package/src/utilities/CLIProcess.ts

@@ -0,0 +1,200 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import type { ChildProcess, ExecSyncOptions, SpawnSyncReturns } from "child_process";
+import childprocess from "cross-spawn";
+import fs from "fs-extra";
+import { inject, injectable } from "inversify";
+import path from "path";
+import process from "process";
+import "reflect-metadata";
+import format from "string-template";
+import { ITypes } from "../config/inversify.types.js";
+import type { ExecutionResult } from "../models/index.js";
+import type { Logger } from "./Logger.js";
+import type { Process } from "./Process.js";
+
+/**
+ * CLI Process implementation class for managing execution of commands.
+ */
+@injectable()
+export class CLIProcess implements Process {
+    private readonly _logger: Logger;
+
+    /**
+     * Instantiate {@link CLIProcess}.
+     *
+     * @param logger - {@link Logger} reference.
+     * @returns Reference to a new {@link CLIProcess} instance.
+     */
+    constructor(@inject(ITypes.Logger) logger: Logger) {
+        this._logger = logger;
+    }
+
+    /**
+     * Execute a command asynchronously.
+     *
+     * @param command - Command to execute.
+     * @param args - Command arguments.
+     * @param options - Execution {@link ExecSyncOptions} options.
+     * @returns Promise of {@link ExecutionResult}.
+     */
+    execute(command: string, args: string[], options?: ExecSyncOptions): Promise<ExecutionResult> {
+        const commandWithArgs = args.length > 0 ? `${command} ${args.join(" ")}` : command;
+        return new Promise(resolve => {
+            let childProcess: ChildProcess;
+            if (options) {
+                childProcess = childprocess.spawn(command, args, options);
+            } else {
+                childProcess = childprocess.spawn(command, args);
+            }
+
+            childProcess.on("close", code => {
+                if (code !== 0) {
+                    resolve({
+                        command: commandWithArgs,
+                        isSuccessful: false
+                    });
+
+                    return;
+                }
+
+                resolve({
+                    command: commandWithArgs,
+                    isSuccessful: true
+                });
+            });
+        });
+    }
+
+    /**
+     * Execute a command synchronously.
+     *
+     * @param command - Command to execute.
+     * @param args - Command arguments.
+     * @param options - Execution {@link ExecSyncOptions} options.
+     * @returns {@link ExecutionResult}.
+     */
+    executeSync(command: string, args: string[], options?: ExecSyncOptions): ExecutionResult {
+        const commandWithArgs = args.length > 0 ? `${command} ${args.join(" ")}` : command;
+        try {
+            let result: SpawnSyncReturns<string | Buffer>;
+            if (options) {
+                result = childprocess.sync(command, args, options);
+            } else {
+                result = childprocess.sync(command, args);
+            }
+
+            return {
+                command: commandWithArgs,
+                isSuccessful: true,
+                data: result.output.join("")
+            };
+        } catch (error: unknown) {
+            // eslint-disable-next-line no-throw-literal -- throw the object causing the error.
+            throw {
+                command: commandWithArgs,
+                isSuccessful: false,
+                error
+            };
+        }
+    }
+
+    /**
+     * Handle any error.
+     *
+     * @param error - Any error.
+     */
+    handleError(error: unknown): void {
+        this._logger.error(LOGS.abortingInstallation, { prefix: LOGS.newLine });
+        if (!error) {
+            return;
+        }
+
+        const executionError = error as ExecutionResult;
+        if (executionError && executionError.command) {
+            this._logger.warning(format(LOGS.hasFailed, { command: executionError.command }), {
+                prefix: LOGS.tab,
+                postfix: LOGS.newLine
+            });
+        } else {
+            this._logger.error(LOGS.unexpectedError);
+            this._logger.error(error, { postfix: LOGS.newLine });
+        }
+    }
+
+    /**
+     * Remove the created Add-on.
+     *
+     * @param addOnDirectory - Directory of the Add-on.
+     * @param addOnName - Name of the Add-on.
+     */
+    removeAddOn(addOnDirectory?: string, addOnName?: string): void {
+        if (!addOnDirectory || !addOnName) {
+            return process.exit(0);
+        }
+
+        const knownGeneratedFiles = new Set<string>([
+            ".env",
+            ".prettierignore",
+            ".prettierrc.json",
+            "node_modules",
+            "package-lock.json",
+            "package.json",
+            "src",
+            "ssl"
+        ]);
+
+        const addOnDirectoryPath = path.join(addOnDirectory);
+        const currentFiles = fs.readdirSync(addOnDirectoryPath, { withFileTypes: true }).map(file => file.name);
+        let remainingFiles = currentFiles.length;
+        currentFiles.forEach(file => {
+            if (knownGeneratedFiles.has(file)) {
+                this._logger.information(format(LOGS.deletingGeneratedFileOrDirectory, { file }));
+                fs.removeSync(path.join(addOnDirectory, file));
+                remainingFiles--;
+            }
+        });
+
+        if (remainingFiles === 0) {
+            const rootDirectory = path.resolve(addOnDirectory, "..");
+            this._logger.information(format(LOGS.deletingAddOn, { addOnName, rootDirectory }));
+            process.chdir(rootDirectory);
+            fs.removeSync(addOnDirectoryPath);
+        }
+
+        this._logger.warning(LOGS.done);
+    }
+}
+
+const LOGS = {
+    newLine: "\n",
+    tab: "  ",
+    abortingInstallation: "Aborting installation.",
+    hasFailed: "{command} has failed.",
+    unexpectedError: "Unexpected error. Please report it as a bug:",
+    deletingGeneratedFileOrDirectory: "Deleting generated file/directory {file} ...",
+    deletingAddOn: "Deleting {addOnName}/ from {rootDirectory}",
+    done: "Done."
+};

package/src/utilities/ConsoleLogger.ts

@@ -0,0 +1,111 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import type { Chalk } from "chalk";
+import chalk from "chalk";
+import { injectable } from "inversify";
+import type { LoggerOptions } from "../models/index.js";
+import type { Logger } from "./Logger.js";
+
+/**
+ * Console logger implementation class to handle logging of different levels.
+ */
+@injectable()
+export class ConsoleLogger implements Logger {
+    /**
+     * Log message.
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    message(message: string, options?: LoggerOptions): void {
+        this._log(message, options);
+    }
+
+    /**
+     * Log information message.
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    information(message: string, options?: LoggerOptions): void {
+        this._log(message, options, chalk.cyan.bold);
+    }
+
+    /**
+     * Log success message.
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    success(message: string, options?: LoggerOptions): void {
+        this._log(message, options, chalk.green.bold);
+    }
+
+    /**
+     * Log warning message.
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    warning(message: string, options?: LoggerOptions): void {
+        this._log(message, options, chalk.hex("#E59400").bold);
+    }
+
+    /**
+     * Log error message.
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    error(message: unknown, options?: LoggerOptions): void {
+        this._log(message, options, chalk.red);
+    }
+
+    private _log(message: unknown, options?: LoggerOptions, color?: Chalk): void {
+        if (!this._isString(message)) {
+            if (options?.prefix) {
+                this._logWithColor(options.prefix, color);
+            }
+
+            this._logWithColor(message, color);
+
+            if (options?.postfix) {
+                this._logWithColor(options.postfix, color);
+            }
+        } else {
+            let messageToLog = options?.prefix ? `${options.prefix}${message}` : message;
+            messageToLog = options?.postfix ? `${messageToLog}${options?.postfix}` : messageToLog;
+
+            this._logWithColor(messageToLog, color);
+        }
+    }
+
+    private _isString(value: unknown) {
+        return typeof value === "string" || value instanceof String;
+    }
+
+    private _logWithColor(message: unknown, color?: Chalk) {
+        if (!color) {
+            console.log(message);
+        } else {
+            console.log(color(message));
+        }
+    }
+}

package/src/utilities/Extensions.ts

@@ -0,0 +1,98 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import fs from "fs-extra";
+import path from "path";
+
+/**
+ * Get JSON string representation of an item.
+ * @param item - Unknown input.
+ * @returns JSON string of item.
+ */
+export function getJSONString(item: unknown): string {
+    return JSON.stringify(item, undefined, 4);
+}
+
+/**
+ * Check whether a string value is null, undefined, empty or whitespace.
+ * @param value - String input.
+ * @returns Boolean value representing whether the string value is null, undefined, empty or whitespace.
+ */
+export function isNullOrWhiteSpace(value: string | null | undefined): boolean {
+    return !value || value.trim().length === 0;
+}
+
+/**
+ * Check whether a value is an object.
+ * @param value - Value to check.
+ * @returns Boolean value representing whether the value is an object.
+ */
+export function isObject(value: unknown) {
+    return typeof value === "object" && value !== null;
+}
+
+/**
+ * Recursively traverse a directory and execute an action on the underlying files.
+ * @param directory - Directory to traverse.
+ * @param action - Action to execute on the files.
+ */
+export function traverseDirectory(directory: string, action: (absolutePath: string) => unknown): void {
+    fs.readdirSync(directory, { withFileTypes: true }).forEach(file => {
+        const absolutePath = path.join(directory, file.name);
+        if (fs.lstatSync(absolutePath).isDirectory()) {
+            return traverseDirectory(absolutePath, action);
+        } else {
+            action(absolutePath);
+        }
+    });
+}
+
+/**
+ * Get Base URL.
+ * @param protocol - Protocol.
+ * @param host - Host (which is equivalent to Hostname:Port).
+ * @returns Base URL as string.
+ */
+export function getBaseUrl(protocol: string, host: string): string {
+    return new URL(`${protocol}://${host}`).href;
+}
+
+/**
+ * Remove symbols like `\n`, `\r` and `\t` from a string.
+ * @param value - Value to remove symbols from.
+ * @returns Value with symbols removed.
+ */
+export function removeSymbols(value: string): string {
+    return value.replace(/[\n\r\t]/g, "");
+}
+
+/**
+ * Check whether a path is of a file.
+ * @param path - Path to check.
+ * @returns Boolean value representing whether the path is of a file.
+ */
+export function isFile(path: string): boolean {
+    // Check if the path exists and the path is of a file, not a directory.
+    return fs.existsSync(path) && fs.lstatSync(path).isFile();
+}

package/src/utilities/Logger.ts

@@ -0,0 +1,70 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import type { LoggerOptions } from "../models/index.js";
+
+/**
+ * Logger interface to handle logging of different levels.
+ */
+export interface Logger {
+    /**
+     * Log message.
+     *
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    message(message: string, options?: LoggerOptions): void;
+
+    /**
+     * Log information message.
+     *
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    information(message: string, options?: LoggerOptions): void;
+
+    /**
+     * Log success message.
+     *
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    success(message: string, options?: LoggerOptions): void;
+
+    /**
+     * Log warning message.
+     *
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    warning(message: string, options?: LoggerOptions): void;
+
+    /**
+     * Log error message.
+     *
+     * @param message - Message to log.
+     * @param options - Logger {@link LoggerOptions} options.
+     */
+    error(message: unknown, options?: LoggerOptions): void;
+}

package/src/utilities/Preferences.ts

@@ -0,0 +1,43 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import type { PreferenceJson } from "../models/index.js";
+
+/**
+ * Preferences interface for managing preferences.
+ */
+export interface Preferences {
+    /**
+     * Get the CCWeb Add-on CLI related user preferences.
+     * @param fromCache - (Optional) Whether to return the cached user preference.
+     * @returns User preference represented as {@link PreferenceJson}.
+     */
+    get(fromCache?: boolean): PreferenceJson;
+
+    /**
+     * Set the CCWeb Add-on CLI related user preferences.
+     * @param preferenceJson - {@link PreferenceJson} reference.
+     */
+    set(preferenceJson: PreferenceJson): void;
+}

package/src/utilities/Process.ts

@@ -0,0 +1,66 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import type { ExecSyncOptions } from "child_process";
+import type { ExecutionResult } from "../models/index.js";
+
+/**
+ * Process interface for managing execution of commands.
+ */
+export interface Process {
+    /**
+     * Execute a command asynchronously.
+     *
+     * @param command - Command to execute.
+     * @param args - Command arguments.
+     * @param options - Execution {@link ExecSyncOptions} options.
+     * @returns Promise of {@link ExecutionResult}.
+     */
+    execute(command: string, args: string[], options?: ExecSyncOptions): Promise<ExecutionResult>;
+
+    /**
+     * Execute a command synchronously.
+     *
+     * @param command - Command to execute.
+     * @param args - Command arguments.
+     * @param options - Execution {@link ExecSyncOptions} options.
+     * @returns {@link ExecutionResult}.
+     */
+    executeSync(command: string, args: string[], options?: ExecSyncOptions): ExecutionResult;
+
+    /**
+     * Handle any error.
+     *
+     * @param error - Any error.
+     */
+    handleError(error: unknown): void;
+
+    /**
+     * Remove the created Add-on.
+     *
+     * @param addOnDirectory - Directory of the Add-on.
+     * @param addOnName - Name of the Add-on.
+     */
+    removeAddOn(addOnDirectory?: string, addOnName?: string): void;
+}

package/src/utilities/UncaughtExceptionHandler.ts

@@ -0,0 +1,55 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+import process from "process";
+import { IContainer, ITypes } from "../config/index.js";
+import { type Logger } from "./Logger.js";
+
+/**
+ * Uncaught exception handler.
+ */
+export class UncaughtExceptionHandler {
+    /**
+     * Register handler for catching any uncaught exception.
+     * @param programName - Program from where the exception could be thrown.
+     */
+    static registerExceptionHandler(programName: string) {
+        process.on("uncaughtException", error => this.handleUncaughtException(programName, error));
+    }
+
+    /**
+     * Handle any uncaught exception thrown during execution.
+     * @param programName - Program from where the exception could be thrown.
+     * @param error - Uncaught exception.
+     */
+    static handleUncaughtException(programName: string, error: Error): void {
+        const logger = IContainer.get<Logger>(ITypes.Logger);
+        logger.error(`${programName} failed. Reason: ${error.message}`, { postfix: LOGS.newLine });
+        return process.exit(0);
+    }
+}
+
+const LOGS = {
+    newLine: "\n"
+};

package/src/utilities/index.ts

@@ -0,0 +1,32 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+
+export * from "./CLIPreferences.js";
+export * from "./CLIProcess.js";
+export * from "./ConsoleLogger.js";
+export * from "./Extensions.js";
+export * from "./Logger.js";
+export * from "./Preferences.js";
+export * from "./Process.js";
+export * from "./UncaughtExceptionHandler.js";