@aneuhold/core-ts-lib 1.0.8 → 1.0.9

package/lib/services/CLIService.js

@@ -1,194 +1,194 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const child_process_1 = require("child_process");
-const rl = __importStar(require("readline"));
-const util_1 = __importDefault(require("util"));
-const sleep_1 = __importDefault(require("../helperFunctions/sleep"));
-const CurrentEnv_1 = __importStar(require("../utils/CurrentEnv"));
-const Logger_1 = __importDefault(require("../utils/Logger"));
-/**
- * The promisified version of the {@link normalExec} function.
- */
-const execute = util_1.default.promisify(child_process_1.exec);
-/**
- * A service which can be used to interact with the command line on the current
- * system.
- */
-class CLIService {
-    static POWERSHELL_PREFIX = `pwsh -NoProfile -Command `;
-    /**
-     * Executes the given command in a shell environment. Spins up a separate
-     * process to execute the command and returns a promise once it is completely
-     * finished.
-     *
-     * The shell environment chosen is determined by the `CurrentEnv` class.
-     *
-     * @param cmd the command to run. This is ran as a normal execution where the
-     * output is all returned at once after completion. For example this could be
-     * `ls -a`.
-     *
-     * @param logError if set to false, it will not output a log if an error
-     * occurs in `stderr` when executing the function. This can be useful if
-     * a command regularly outputs an error even when it succeeds. This  only
-     * applies to commands ran with normal execution.
-     *
-     * @param cwd the current working directory to run the command in. If not
-     * provided, it will use the current working directory of the process.
-     *
-     * @param useProfile if set to true will use the current profile or zshrc of
-     * the shell environment. By default this is false.
-     *
-     * @returns an object that holds the output and true if the command completed
-     * successfully or false if it did not.
-     */
-    static async execCmd(cmd, logError = false, cwd, useProfile = false) {
-        const execOptions = {};
-        if (cwd) {
-            execOptions.cwd = cwd;
-        }
-        let commandToExecute = cmd;
-        // Set the powershell prefix if the current OS is Windows so that
-        // the profile is not ran before the command.
-        if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows && !useProfile) {
-            commandToExecute = `${CLIService.POWERSHELL_PREFIX}${cmd}`;
-        }
-        else if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows && useProfile) {
-            execOptions.shell = 'pwsh';
-        }
-        Logger_1.default.verbose.info(`Executing command: ${commandToExecute}`);
-        try {
-            const { stdout, stderr } = await execute(commandToExecute, execOptions);
-            if (stderr) {
-                if (logError) {
-                    Logger_1.default.error(`There was an error executing ${cmd}. Details are printed below:
-            ${stderr}`);
-                }
-                return {
-                    didComplete: false,
-                    output: stderr
-                };
-            }
-            Logger_1.default.verbose.info(`Output from stdout is: ${stdout}`);
-            return {
-                didComplete: true,
-                output: stdout
-            };
-        }
-        catch (err) {
-            Logger_1.default.verbose
-                .error(`There was an error executing the "exec" function. Details are printed below:
-        ${err}`);
-            return {
-                didComplete: false,
-                output: err
-            };
-        }
-    }
-    /**
-     * Executes the given command but fulfills the
-     * promise when either the command completes, or the given number of ms have
-     * passed. Whichever comes first.
-     *
-     * @param command the command to execute
-     * @param ms the number of milliseconds to wait. This is 5 seconds by default.
-     */
-    static async execCmdWithTimeout(command, ms = 5000) {
-        const sleepPromise = (0, sleep_1.default)(ms).then(() => {
-            return {
-                didComplete: false,
-                output: `Command ended after ${ms} ms.`
-            };
-        });
-        return Promise.any([sleepPromise, CLIService.execCmd(command)]);
-    }
-    /**
-     * Spawns a new process where the command is ran as a stream where all
-     *  output is streamed to the console.
-     * This is helpful for long-running commands or commands
-     * that output a lot of data. For example `yarn` or `npm install`.
-     * All of the output from this is logged by default because of the listeners
-     * involved. This could be changed in the future though.
-     *
-     * @param cmd the command to run. This is the the first argument passed to the
-     * `spawn` function. For example this could be `npm`.
-     * @param args the arguments to pass to the command. For example this could be
-     * `['install', 'react']`.
-     */
-    static async spawnCmd(cmd, args, currentWorkingDirectory) {
-        return new Promise((resolve) => {
-            let output = '';
-            const execOptions = {
-                cwd: currentWorkingDirectory
-            };
-            const spawnedCmd = (0, child_process_1.spawn)(cmd, args, execOptions);
-            spawnedCmd.on('error', (err) => {
-                Logger_1.default.error(`There was an error executing the "spawn" function. Details are printed below:
-      ${err}`);
-                resolve({
-                    didComplete: false,
-                    output: err.toString()
-                });
-            });
-            spawnedCmd.stdout.on('data', (data) => {
-                output += data;
-                Logger_1.default.info(data, true);
-            });
-            spawnedCmd.stderr.on('data', (data) => {
-                output += data;
-                Logger_1.default.info(data, true);
-            });
-            spawnedCmd.on('close', (exitCode) => {
-                Logger_1.default.info(`Command "${cmd}" exited with code ${exitCode}`);
-                resolve({
-                    didComplete: true,
-                    output
-                });
-            });
-        });
-    }
-    /**
-     * Gets input from the user on command line.
-     *
-     * @param promptToUser the prompt that should be provided to the user. Include
-     * a newline at the end if you want there to be one.
-     */
-    static async getUserInput(promptToUser) {
-        const readline = rl.createInterface({
-            input: process.stdin,
-            output: process.stdout
-        });
-        return new Promise((resolve) => {
-            readline.question(promptToUser, (input) => {
-                readline.close();
-                resolve(input);
-            });
-        });
-    }
-}
-exports.default = CLIService;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const rl = __importStar(require("readline"));
+const util_1 = __importDefault(require("util"));
+const sleep_1 = __importDefault(require("../helperFunctions/sleep"));
+const CurrentEnv_1 = __importStar(require("../utils/CurrentEnv"));
+const Logger_1 = __importDefault(require("../utils/Logger"));
+/**
+ * The promisified version of the {@link normalExec} function.
+ */
+const execute = util_1.default.promisify(child_process_1.exec);
+/**
+ * A service which can be used to interact with the command line on the current
+ * system.
+ */
+class CLIService {
+    static POWERSHELL_PREFIX = `pwsh -NoProfile -Command `;
+    /**
+     * Executes the given command in a shell environment. Spins up a separate
+     * process to execute the command and returns a promise once it is completely
+     * finished.
+     *
+     * The shell environment chosen is determined by the `CurrentEnv` class.
+     *
+     * @param cmd the command to run. This is ran as a normal execution where the
+     * output is all returned at once after completion. For example this could be
+     * `ls -a`.
+     *
+     * @param logError if set to false, it will not output a log if an error
+     * occurs in `stderr` when executing the function. This can be useful if
+     * a command regularly outputs an error even when it succeeds. This  only
+     * applies to commands ran with normal execution.
+     *
+     * @param cwd the current working directory to run the command in. If not
+     * provided, it will use the current working directory of the process.
+     *
+     * @param useProfile if set to true will use the current profile or zshrc of
+     * the shell environment. By default this is false.
+     *
+     * @returns an object that holds the output and true if the command completed
+     * successfully or false if it did not.
+     */
+    static async execCmd(cmd, logError = false, cwd, useProfile = false) {
+        const execOptions = {};
+        if (cwd) {
+            execOptions.cwd = cwd;
+        }
+        let commandToExecute = cmd;
+        // Set the powershell prefix if the current OS is Windows so that
+        // the profile is not ran before the command.
+        if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows && !useProfile) {
+            commandToExecute = `${CLIService.POWERSHELL_PREFIX}${cmd}`;
+        }
+        else if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows && useProfile) {
+            execOptions.shell = 'pwsh';
+        }
+        Logger_1.default.verbose.info(`Executing command: ${commandToExecute}`);
+        try {
+            const { stdout, stderr } = await execute(commandToExecute, execOptions);
+            if (stderr) {
+                if (logError) {
+                    Logger_1.default.error(`There was an error executing ${cmd}. Details are printed below:
+            ${stderr}`);
+                }
+                return {
+                    didComplete: false,
+                    output: stderr
+                };
+            }
+            Logger_1.default.verbose.info(`Output from stdout is: ${stdout}`);
+            return {
+                didComplete: true,
+                output: stdout
+            };
+        }
+        catch (err) {
+            Logger_1.default.verbose
+                .error(`There was an error executing the "exec" function. Details are printed below:
+        ${err}`);
+            return {
+                didComplete: false,
+                output: err
+            };
+        }
+    }
+    /**
+     * Executes the given command but fulfills the
+     * promise when either the command completes, or the given number of ms have
+     * passed. Whichever comes first.
+     *
+     * @param command the command to execute
+     * @param ms the number of milliseconds to wait. This is 5 seconds by default.
+     */
+    static async execCmdWithTimeout(command, ms = 5000) {
+        const sleepPromise = (0, sleep_1.default)(ms).then(() => {
+            return {
+                didComplete: false,
+                output: `Command ended after ${ms} ms.`
+            };
+        });
+        return Promise.any([sleepPromise, CLIService.execCmd(command)]);
+    }
+    /**
+     * Spawns a new process where the command is ran as a stream where all
+     *  output is streamed to the console.
+     * This is helpful for long-running commands or commands
+     * that output a lot of data. For example `yarn` or `npm install`.
+     * All of the output from this is logged by default because of the listeners
+     * involved. This could be changed in the future though.
+     *
+     * @param cmd the command to run. This is the the first argument passed to the
+     * `spawn` function. For example this could be `npm`.
+     * @param args the arguments to pass to the command. For example this could be
+     * `['install', 'react']`.
+     */
+    static async spawnCmd(cmd, args, currentWorkingDirectory) {
+        return new Promise((resolve) => {
+            let output = '';
+            const execOptions = {
+                cwd: currentWorkingDirectory
+            };
+            const spawnedCmd = (0, child_process_1.spawn)(cmd, args, execOptions);
+            spawnedCmd.on('error', (err) => {
+                Logger_1.default.error(`There was an error executing the "spawn" function. Details are printed below:
+      ${err}`);
+                resolve({
+                    didComplete: false,
+                    output: err.toString()
+                });
+            });
+            spawnedCmd.stdout.on('data', (data) => {
+                output += data;
+                Logger_1.default.info(data, true);
+            });
+            spawnedCmd.stderr.on('data', (data) => {
+                output += data;
+                Logger_1.default.info(data, true);
+            });
+            spawnedCmd.on('close', (exitCode) => {
+                Logger_1.default.info(`Command "${cmd}" exited with code ${exitCode}`);
+                resolve({
+                    didComplete: true,
+                    output
+                });
+            });
+        });
+    }
+    /**
+     * Gets input from the user on command line.
+     *
+     * @param promptToUser the prompt that should be provided to the user. Include
+     * a newline at the end if you want there to be one.
+     */
+    static async getUserInput(promptToUser) {
+        const readline = rl.createInterface({
+            input: process.stdin,
+            output: process.stdout
+        });
+        return new Promise((resolve) => {
+            readline.question(promptToUser, (input) => {
+                readline.close();
+                resolve(input);
+            });
+        });
+    }
+}
+exports.default = CLIService;

package/lib/services/StringService.d.ts

@@ -1,14 +1,14 @@
-/**
- * A service which can be used to interact with strings.
- */
-export default class StringService {
-    /**
-     * Gets the file extension of the provided file name.
-     *
-     * @param fileName the full name of the file or the entire file path
-     * @returns a string containing the extension of the file name or undefined
-     * if there is no extension
-     */
-    static getFileNameExtension(fileName: string): string | undefined;
-}
+/**
+ * A service which can be used to interact with strings.
+ */
+export default class StringService {
+    /**
+     * Gets the file extension of the provided file name.
+     *
+     * @param fileName the full name of the file or the entire file path
+     * @returns a string containing the extension of the file name or undefined
+     * if there is no extension
+     */
+    static getFileNameExtension(fileName: string): string | undefined;
+}
 //# sourceMappingURL=StringService.d.ts.map

package/lib/services/StringService.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * A service which can be used to interact with strings.
- */
-class StringService {
-    /**
-     * Gets the file extension of the provided file name.
-     *
-     * @param fileName the full name of the file or the entire file path
-     * @returns a string containing the extension of the file name or undefined
-     * if there is no extension
-     */
-    static getFileNameExtension(fileName) {
-        return fileName.split('.').pop();
-    }
-}
-exports.default = StringService;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A service which can be used to interact with strings.
+ */
+class StringService {
+    /**
+     * Gets the file extension of the provided file name.
+     *
+     * @param fileName the full name of the file or the entire file path
+     * @returns a string containing the extension of the file name or undefined
+     * if there is no extension
+     */
+    static getFileNameExtension(fileName) {
+        return fileName.split('.').pop();
+    }
+}
+exports.default = StringService;

package/lib/services/applications/ChromeService.d.ts

@@ -1,20 +1,20 @@
-import { OperatingSystemType } from '../../utils/CurrentEnv';
-/**
- * A service that provides functionality for interacting with the Chrome
- * browser.
- */
-export default class ChromeService {
-    /**
-     * Gets the path to the chrome application for the current system given the
-     * operating system type.
-     *
-     * This does include the quotes
-     */
-    static getChromePath(os: OperatingSystemType): string | null;
-    /**
-     * Opens and sets pinned tabs in chrome. Still trying to figure out
-     * how to get this to work.
-     */
-    static openAndSetPinnedTabs(): Promise<void>;
-}
+import { OperatingSystemType } from '../../utils/CurrentEnv';
+/**
+ * A service that provides functionality for interacting with the Chrome
+ * browser.
+ */
+export default class ChromeService {
+    /**
+     * Gets the path to the chrome application for the current system given the
+     * operating system type.
+     *
+     * This does include the quotes
+     */
+    static getChromePath(os: OperatingSystemType): string | null;
+    /**
+     * Opens and sets pinned tabs in chrome. Still trying to figure out
+     * how to get this to work.
+     */
+    static openAndSetPinnedTabs(): Promise<void>;
+}
 //# sourceMappingURL=ChromeService.d.ts.map

package/lib/services/applications/ChromeService.js

@@ -1,60 +1,60 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const CurrentEnv_1 = __importStar(require("../../utils/CurrentEnv"));
-const CLIService_1 = __importDefault(require("../CLIService"));
-/**
- * A service that provides functionality for interacting with the Chrome
- * browser.
- */
-class ChromeService {
-    /**
-     * Gets the path to the chrome application for the current system given the
-     * operating system type.
-     *
-     * This does include the quotes
-     */
-    static getChromePath(os) {
-        switch (os) {
-            case CurrentEnv_1.OperatingSystemType.MacOSX:
-                return `"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"`;
-            case CurrentEnv_1.OperatingSystemType.Windows:
-                return `& "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe"`;
-            default:
-                return null;
-        }
-    }
-    /**
-     * Opens and sets pinned tabs in chrome. Still trying to figure out
-     * how to get this to work.
-     */
-    static async openAndSetPinnedTabs() {
-        await CLIService_1.default.execCmd(`${ChromeService.getChromePath(CurrentEnv_1.default.os)} --pinned-tab-count=2 https://google.com https://tonyneuhold.com`);
-    }
-}
-exports.default = ChromeService;
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CurrentEnv_1 = __importStar(require("../../utils/CurrentEnv"));
+const CLIService_1 = __importDefault(require("../CLIService"));
+/**
+ * A service that provides functionality for interacting with the Chrome
+ * browser.
+ */
+class ChromeService {
+    /**
+     * Gets the path to the chrome application for the current system given the
+     * operating system type.
+     *
+     * This does include the quotes
+     */
+    static getChromePath(os) {
+        switch (os) {
+            case CurrentEnv_1.OperatingSystemType.MacOSX:
+                return `"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"`;
+            case CurrentEnv_1.OperatingSystemType.Windows:
+                return `& "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe"`;
+            default:
+                return null;
+        }
+    }
+    /**
+     * Opens and sets pinned tabs in chrome. Still trying to figure out
+     * how to get this to work.
+     */
+    static async openAndSetPinnedTabs() {
+        await CLIService_1.default.execCmd(`${ChromeService.getChromePath(CurrentEnv_1.default.os)} --pinned-tab-count=2 https://google.com https://tonyneuhold.com`);
+    }
+}
+exports.default = ChromeService;

package/lib/services/applications/DockerService.d.ts

@@ -1,21 +1,21 @@
-import { OperatingSystemType } from '../../utils/CurrentEnv';
-/**
- * A service that provides functionality for interacting with the Docker
- * application.
- */
-export default class DockerService {
-    /**
-     * Starts the Docker Desktop application. If it is already running, it doesn't
-     * do anything.
-     */
-    static startDockerDesktop(): Promise<void>;
-    static checkIfDockerDesktopIsRunning(): Promise<boolean>;
-    /**
-     * Gets the path to the docker application for the current system given the
-     * operating system type.
-     *
-     * This does include the quotes
-     */
-    static getDockerPath(os: OperatingSystemType): string | null;
-}
+import { OperatingSystemType } from '../../utils/CurrentEnv';
+/**
+ * A service that provides functionality for interacting with the Docker
+ * application.
+ */
+export default class DockerService {
+    /**
+     * Starts the Docker Desktop application. If it is already running, it doesn't
+     * do anything.
+     */
+    static startDockerDesktop(): Promise<void>;
+    static checkIfDockerDesktopIsRunning(): Promise<boolean>;
+    /**
+     * Gets the path to the docker application for the current system given the
+     * operating system type.
+     *
+     * This does include the quotes
+     */
+    static getDockerPath(os: OperatingSystemType): string | null;
+}
 //# sourceMappingURL=DockerService.d.ts.map