@aneuhold/core-ts-lib 1.0.6 → 1.0.8

package/lib/index.d.ts

@@ -2,10 +2,11 @@ import datesAreOnSameDay from './helperFunctions/dateFunctions';
 import sleep from './helperFunctions/sleep';
 import getFileNameExtension from './helperFunctions/stringFunctions';
 import ChromeService from './services/applications/ChromeService';
+import DockerService from './services/applications/DockerService';
 import FileSystemService from './services/applications/FileSystemService';
 import CLIService from './services/CLIService';
 import StringService from './services/StringService';
 import CurrentEnv, { OperatingSystemType, ShellType, TerminalType } from './utils/CurrentEnv';
 import Logger from './utils/Logger';
-export { CLIService, StringService, CurrentEnv, ChromeService, FileSystemService, sleep, OperatingSystemType, ShellType, Logger, TerminalType, datesAreOnSameDay, getFileNameExtension };
+export { CLIService, StringService, CurrentEnv, ChromeService, DockerService, FileSystemService, sleep, OperatingSystemType, ShellType, Logger, TerminalType, datesAreOnSameDay, getFileNameExtension };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAC5C,OAAO,oBAAoB,MAAM,mCAAmC,CAAC;AACrE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAC1E,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,aAAa,MAAM,0BAA0B,CAAC;AACrD,OAAO,UAAU,EAAE,EACjB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAGpC,OAAO,EACL,UAAU,EACV,aAAa,EACb,UAAU,EACV,aAAa,EACb,iBAAiB,EACjB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACrB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAC5C,OAAO,oBAAoB,MAAM,mCAAmC,CAAC;AACrE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,aAAa,MAAM,uCAAuC,CAAC;AAClE,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAC1E,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,aAAa,MAAM,0BAA0B,CAAC;AACrD,OAAO,UAAU,EAAE,EACjB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,MAAM,MAAM,gBAAgB,CAAC;AAGpC,OAAO,EACL,UAAU,EACV,aAAa,EACb,UAAU,EACV,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,KAAK,EACL,mBAAmB,EACnB,SAAS,EACT,MAAM,EACN,YAAY,EACZ,iBAAiB,EACjB,oBAAoB,EACrB,CAAC"}

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFileNameExtension = exports.datesAreOnSameDay = exports.TerminalType = exports.Logger = exports.ShellType = exports.OperatingSystemType = exports.sleep = exports.FileSystemService = exports.ChromeService = exports.CurrentEnv = exports.StringService = exports.CLIService = void 0;
+exports.getFileNameExtension = exports.datesAreOnSameDay = exports.TerminalType = exports.Logger = exports.ShellType = exports.OperatingSystemType = exports.sleep = exports.FileSystemService = exports.DockerService = exports.ChromeService = exports.CurrentEnv = exports.StringService = exports.CLIService = void 0;
 const dateFunctions_1 = __importDefault(require("./helperFunctions/dateFunctions"));
 exports.datesAreOnSameDay = dateFunctions_1.default;
 const sleep_1 = __importDefault(require("./helperFunctions/sleep"));
@@ -35,6 +35,8 @@ const stringFunctions_1 = __importDefault(require("./helperFunctions/stringFunct
 exports.getFileNameExtension = stringFunctions_1.default;
 const ChromeService_1 = __importDefault(require("./services/applications/ChromeService"));
 exports.ChromeService = ChromeService_1.default;
+const DockerService_1 = __importDefault(require("./services/applications/DockerService"));
+exports.DockerService = DockerService_1.default;
 const FileSystemService_1 = __importDefault(require("./services/applications/FileSystemService"));
 exports.FileSystemService = FileSystemService_1.default;
 const CLIService_1 = __importDefault(require("./services/CLIService"));

package/lib/services/CLIService.d.ts

@@ -17,7 +17,7 @@ export default class CLIService {
      *
      * @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`
+     * `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
@@ -27,10 +27,13 @@ export default class CLIService {
      * @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 execCmd(cmd: string, logError?: boolean, cwd?: string): Promise<ExecCmdReturnType>;
+    static execCmd(cmd: string, logError?: boolean, cwd?: string, useProfile?: boolean): Promise<ExecCmdReturnType>;
     /**
      * Executes the given command but fulfills the
      * promise when either the command completes, or the given number of ms have

package/lib/services/CLIService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CLIService.d.ts","sourceRoot":"","sources":["../../src/services/CLIService.ts"],"names":[],"mappings":"AAgBA,KAAK,iBAAiB,GAAG;IAAE,WAAW,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAElE;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA+B;IAE/D;;;;;;;;;;;;;;;;;;;;;OAqBG;WACU,OAAO,CAClB,GAAG,EAAE,MAAM,EACX,QAAQ,UAAQ,EAChB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC;IAsC7B;;;;;;;OAOG;WACU,kBAAkB,CAC7B,OAAO,EAAE,MAAM,EACf,EAAE,SAAO,GACR,OAAO,CAAC,iBAAiB,CAAC;IAU7B;;;;;;;;;;;;OAYG;WACU,QAAQ,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,EAAE,EACf,uBAAuB,CAAC,EAAE,MAAM,GAC/B,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;OAKG;WACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAQjE"}
+{"version":3,"file":"CLIService.d.ts","sourceRoot":"","sources":["../../src/services/CLIService.ts"],"names":[],"mappings":"AAYA,KAAK,iBAAiB,GAAG;IAAE,WAAW,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAElE;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAA+B;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACU,OAAO,CAClB,GAAG,EAAE,MAAM,EACX,QAAQ,UAAQ,EAChB,GAAG,CAAC,EAAE,MAAM,EACZ,UAAU,UAAQ,GACjB,OAAO,CAAC,iBAAiB,CAAC;IA6C7B;;;;;;;OAOG;WACU,kBAAkB,CAC7B,OAAO,EAAE,MAAM,EACf,EAAE,SAAO,GACR,OAAO,CAAC,iBAAiB,CAAC;IAU7B;;;;;;;;;;;;OAYG;WACU,QAAQ,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,EAAE,EACf,uBAAuB,CAAC,EAAE,MAAM,GAC/B,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;OAKG;WACU,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYjE"}

package/lib/services/CLIService.js

@@ -36,10 +36,6 @@ 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);
-const readline = rl.createInterface({
-    input: process.stdin,
-    output: process.stdout
-});
 /**
  * A service which can be used to interact with the command line on the current
  * system.
@@ -55,7 +51,7 @@ class CLIService {
      *
      * @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`
+     * `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
@@ -65,18 +61,27 @@ class CLIService {
      * @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) {
-        const execOptions = {
-            cwd
-        };
+    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
-        if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows) {
-            commandToExecute = CLIService.POWERSHELL_PREFIX + 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) {
@@ -89,14 +94,15 @@ class CLIService {
                     output: stderr
                 };
             }
-            Logger_1.default.verbose.info(stdout);
+            Logger_1.default.verbose.info(`Output from stdout is: ${stdout}`);
             return {
                 didComplete: true,
                 output: stdout
             };
         }
         catch (err) {
-            Logger_1.default.error(`There was an error executing the "exec" function. Details are printed below:
+            Logger_1.default.verbose
+                .error(`There was an error executing the "exec" function. Details are printed below:
         ${err}`);
             return {
                 didComplete: false,
@@ -173,6 +179,10 @@ class CLIService {
      * 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();

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

@@ -0,0 +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;
+}
+//# sourceMappingURL=DockerService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DockerService.d.ts","sourceRoot":"","sources":["../../../src/services/applications/DockerService.ts"],"names":[],"mappings":"AAEA,OAAmB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAIzE;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC;;;OAGG;WACU,kBAAkB;WAgBlB,6BAA6B,IAAI,OAAO,CAAC,OAAO,CAAC;IAe9D;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI;CAS7D"}

package/lib/services/applications/DockerService.js

@@ -0,0 +1,88 @@
+"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 });
+/* eslint-disable no-await-in-loop */
+const sleep_1 = __importDefault(require("../../helperFunctions/sleep"));
+const CurrentEnv_1 = __importStar(require("../../utils/CurrentEnv"));
+const Logger_1 = __importDefault(require("../../utils/Logger"));
+const CLIService_1 = __importDefault(require("../CLIService"));
+/**
+ * A service that provides functionality for interacting with the Docker
+ * application.
+ */
+class DockerService {
+    /**
+     * Starts the Docker Desktop application. If it is already running, it doesn't
+     * do anything.
+     */
+    static async startDockerDesktop() {
+        const currentOS = CurrentEnv_1.default.os;
+        const dockerPath = DockerService.getDockerPath(currentOS);
+        let dockerRunning = await DockerService.checkIfDockerDesktopIsRunning();
+        if (!dockerRunning && dockerPath) {
+            Logger_1.default.info('Docker desktop is not running. Starting it now...');
+            await CLIService_1.default.execCmdWithTimeout(dockerPath, 4000);
+            while (!dockerRunning) {
+                Logger_1.default.info('Waiting for Docker to start...');
+                await (0, sleep_1.default)(2000);
+                dockerRunning = await DockerService.checkIfDockerDesktopIsRunning();
+            }
+        }
+        Logger_1.default.info('Docker desktop is running.');
+    }
+    static async checkIfDockerDesktopIsRunning() {
+        const currentOS = CurrentEnv_1.default.os;
+        if (currentOS === CurrentEnv_1.OperatingSystemType.Windows) {
+            const { didComplete } = await CLIService_1.default.execCmd('Get-Process docker');
+            if (didComplete) {
+                Logger_1.default.verbose.info('Docker is running.');
+                return true;
+            }
+            Logger_1.default.verbose.info('Docker is not running.');
+            return false;
+        }
+        Logger_1.default.error('Docker command not defined for this OS yet.');
+        return false;
+    }
+    /**
+     * Gets the path to the docker application for the current system given the
+     * operating system type.
+     *
+     * This does include the quotes
+     */
+    static getDockerPath(os) {
+        switch (os) {
+            case CurrentEnv_1.OperatingSystemType.Windows:
+                return `& "C:\\Program Files\\Docker\\Docker\\Docker Desktop.exe"`;
+            default:
+                Logger_1.default.error('Docker path not defined for this OS yet.');
+                return null;
+        }
+    }
+}
+exports.default = DockerService;

package/lib/services/applications/FileSystemService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FileSystemService.d.ts","sourceRoot":"","sources":["../../../src/services/applications/FileSystemService.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAO5C;;;;;;;OAOG;WACU,iBAAiB,CAC5B,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC;mBA8BK,qBAAqB;CAM3C"}
+{"version":3,"file":"FileSystemService.d.ts","sourceRoot":"","sources":["../../../src/services/applications/FileSystemService.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ5C;;;;;;;OAOG;WACU,iBAAiB,CAC5B,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC;mBA8BK,qBAAqB;CAM3C"}

package/lib/services/applications/FileSystemService.js

@@ -39,6 +39,7 @@ class FileSystemService {
     static async openNugetCache() {
         if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows) {
             await FileSystemService.openWindowsNugetCache();
+            return;
         }
         Logger_1.default.error('Not implemented for this OS yet.');
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/core-ts-lib",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "A core library for all of my TypeScript projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",