@aneuhold/core-ts-lib 1.0.8 → 1.0.10

package/lib/utils/CurrentEnv.js

@@ -1,133 +1,137 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TerminalType = exports.OperatingSystemType = exports.ShellType = void 0;
-const promises_1 = require("fs/promises");
-const path_1 = __importDefault(require("path"));
-const CLIService_1 = __importDefault(require("../services/CLIService"));
-const Logger_1 = __importDefault(require("./Logger"));
-/**
- * The type of shell that the current environment is running.
- */
-var ShellType;
-(function (ShellType) {
-    ShellType[ShellType["PowerShellCore"] = 0] = "PowerShellCore";
-    ShellType[ShellType["PowerShellDesktop"] = 1] = "PowerShellDesktop";
-    ShellType[ShellType["Bash"] = 2] = "Bash";
-    ShellType[ShellType["Zsh"] = 3] = "Zsh";
-    ShellType[ShellType["CommandPrompt"] = 4] = "CommandPrompt";
-    ShellType[ShellType["Unknown"] = 5] = "Unknown";
-})(ShellType = exports.ShellType || (exports.ShellType = {}));
-var OperatingSystemType;
-(function (OperatingSystemType) {
-    OperatingSystemType[OperatingSystemType["Windows"] = 0] = "Windows";
-    OperatingSystemType[OperatingSystemType["MacOSX"] = 1] = "MacOSX";
-    OperatingSystemType[OperatingSystemType["Linux"] = 2] = "Linux";
-    OperatingSystemType[OperatingSystemType["Unknown"] = 3] = "Unknown";
-})(OperatingSystemType = exports.OperatingSystemType || (exports.OperatingSystemType = {}));
-/**
- * The type of terminal that the current enviornment is running.
- */
-var TerminalType;
-(function (TerminalType) {
-    TerminalType[TerminalType["WindowsTerminal"] = 0] = "WindowsTerminal";
-    TerminalType[TerminalType["Unknown"] = 1] = "Unknown";
-})(TerminalType = exports.TerminalType || (exports.TerminalType = {}));
-/**
- * Provides information relevant to the current environment this script is
- * running in.
- */
-class CurrentEnv {
-    /**
-     * Returns the type of terminal the current environment is using.
-     */
-    static terminal() {
-        // See https://stackoverflow.com/questions/59733731/how-to-detect-if-running-in-the-new-windows-terminal
-        // for information on why this method was chosen.
-        if (process.env.WT_SESSION) {
-            return TerminalType.WindowsTerminal;
-        }
-        return TerminalType.Unknown;
-    }
-    /**
-     * Returns the type of shell the current environment is using.
-     *
-     * This might be arbitrary because it seems that the exec command will use
-     * whatever the default shell is or whatever is specified as the shell
-     * option.
-     */
-    static async shell() {
-        const currentOs = CurrentEnv.os;
-        if (currentOs === OperatingSystemType.Windows) {
-            // Command comes from: https://stackoverflow.com/questions/34471956/how-to-determine-if-im-in-powershell-or-cmd
-            const { output } = await CLIService_1.default.execCmd('(dir 2>&1 *`|echo CMD);&<# rem #>echo ($PSVersionTable).PSEdition');
-            switch (output) {
-                case 'CMD':
-                    return ShellType.CommandPrompt;
-                case 'Desktop':
-                    return ShellType.PowerShellDesktop;
-                case 'Core':
-                    return ShellType.PowerShellCore;
-                default:
-                    Logger_1.default.verbose.failure(`No recognizable shell returned for Windows environment.`);
-            }
-        }
-        else if (currentOs === OperatingSystemType.MacOSX) {
-            // Mighbt want to use process.env.SHELL for Linux environments
-        }
-        return ShellType.Unknown;
-    }
-    /**
-     * Gets all file names in the current directory.
-     */
-    static async fileNamesInDir() {
-        return (0, promises_1.readdir)(path_1.default.resolve('.'));
-    }
-    /**
-     * Runs the startup script for the current system. This command exits the
-     * package.
-     *
-     * The startup scripts are defined in the
-     * [dotfiles repo](https://github.com/aneuhold/dotfiles).
-     */
-    static async runStartupScript() {
-        let cmd = '';
-        if (CurrentEnv.os === OperatingSystemType.Windows) {
-            // & says to powershell that you actually want to run the script in the
-            // quotes afterwards
-            // Also just running the startup script for now because of some infinite
-            // loop issues with specifying arguments
-            cmd = `& "$Home\\startup.ps1"`;
-        }
-        else {
-            cmd = 'zsh';
-            const args = ['startup.sh'];
-            await CLIService_1.default.spawnCmd(cmd, args, process.env.HOME);
-            return;
-        }
-        Logger_1.default.info(`Executing the following command: "${cmd}"`);
-        const { output } = await CLIService_1.default.execCmd(cmd);
-        Logger_1.default.info(output);
-        process.exit();
-    }
-    /**
-     * Determines the type of operating system in the current environment.
-     *
-     * This looks to be O(1) complexity.
-     */
-    static get os() {
-        if (process.platform === 'win32') {
-            return OperatingSystemType.Windows;
-        }
-        if (process.platform === 'darwin') {
-            return OperatingSystemType.MacOSX;
-        }
-        return OperatingSystemType.Unknown;
-    }
-    static folderName() {
-        return path_1.default.basename(path_1.default.resolve('.'));
-    }
-}
-exports.default = CurrentEnv;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TerminalType = exports.OperatingSystemType = exports.ShellType = void 0;
+const promises_1 = require("fs/promises");
+const path_1 = __importDefault(require("path"));
+const CLIService_1 = __importDefault(require("../services/CLIService"));
+const Logger_1 = __importDefault(require("./Logger"));
+/**
+ * The type of shell that the current environment is running.
+ */
+var ShellType;
+(function (ShellType) {
+    ShellType[ShellType["PowerShellCore"] = 0] = "PowerShellCore";
+    ShellType[ShellType["PowerShellDesktop"] = 1] = "PowerShellDesktop";
+    ShellType[ShellType["Bash"] = 2] = "Bash";
+    ShellType[ShellType["Zsh"] = 3] = "Zsh";
+    ShellType[ShellType["CommandPrompt"] = 4] = "CommandPrompt";
+    ShellType[ShellType["Unknown"] = 5] = "Unknown";
+})(ShellType = exports.ShellType || (exports.ShellType = {}));
+var OperatingSystemType;
+(function (OperatingSystemType) {
+    OperatingSystemType[OperatingSystemType["Windows"] = 0] = "Windows";
+    OperatingSystemType[OperatingSystemType["MacOSX"] = 1] = "MacOSX";
+    OperatingSystemType[OperatingSystemType["Linux"] = 2] = "Linux";
+    OperatingSystemType[OperatingSystemType["Unknown"] = 3] = "Unknown";
+})(OperatingSystemType = exports.OperatingSystemType || (exports.OperatingSystemType = {}));
+/**
+ * The type of terminal that the current enviornment is running.
+ */
+var TerminalType;
+(function (TerminalType) {
+    TerminalType[TerminalType["WindowsTerminal"] = 0] = "WindowsTerminal";
+    TerminalType[TerminalType["ITerm2"] = 1] = "ITerm2";
+    TerminalType[TerminalType["Unknown"] = 2] = "Unknown";
+})(TerminalType = exports.TerminalType || (exports.TerminalType = {}));
+/**
+ * Provides information relevant to the current environment this script is
+ * running in.
+ */
+class CurrentEnv {
+    /**
+     * Returns the type of terminal the current environment is using.
+     */
+    static terminal() {
+        // See https://stackoverflow.com/questions/59733731/how-to-detect-if-running-in-the-new-windows-terminal
+        // for information on why this method was chosen.
+        if (process.env.WT_SESSION) {
+            return TerminalType.WindowsTerminal;
+        }
+        if (process.env.TERM_PROGRAM && process.env.TERM_PROGRAM === 'iTerm.app') {
+            return TerminalType.ITerm2;
+        }
+        return TerminalType.Unknown;
+    }
+    /**
+     * Returns the type of shell the current environment is using.
+     *
+     * This might be arbitrary because it seems that the exec command will use
+     * whatever the default shell is or whatever is specified as the shell
+     * option.
+     */
+    static async shell() {
+        const currentOs = CurrentEnv.os;
+        if (currentOs === OperatingSystemType.Windows) {
+            // Command comes from: https://stackoverflow.com/questions/34471956/how-to-determine-if-im-in-powershell-or-cmd
+            const { output } = await CLIService_1.default.execCmd('(dir 2>&1 *`|echo CMD);&<# rem #>echo ($PSVersionTable).PSEdition');
+            switch (output) {
+                case 'CMD':
+                    return ShellType.CommandPrompt;
+                case 'Desktop':
+                    return ShellType.PowerShellDesktop;
+                case 'Core':
+                    return ShellType.PowerShellCore;
+                default:
+                    Logger_1.default.verbose.failure(`No recognizable shell returned for Windows environment.`);
+            }
+        }
+        else if (currentOs === OperatingSystemType.MacOSX) {
+            // Mighbt want to use process.env.SHELL for Linux environments
+        }
+        return ShellType.Unknown;
+    }
+    /**
+     * Gets all file names in the current directory.
+     */
+    static async fileNamesInDir() {
+        return (0, promises_1.readdir)(path_1.default.resolve('.'));
+    }
+    /**
+     * Runs the startup script for the current system. This command exits the
+     * package.
+     *
+     * The startup scripts are defined in the
+     * [dotfiles repo](https://github.com/aneuhold/dotfiles).
+     */
+    static async runStartupScript() {
+        let cmd = '';
+        if (CurrentEnv.os === OperatingSystemType.Windows) {
+            // & says to powershell that you actually want to run the script in the
+            // quotes afterwards
+            // Also just running the startup script for now because of some infinite
+            // loop issues with specifying arguments
+            cmd = `& "$Home\\startup.ps1"`;
+        }
+        else {
+            cmd = 'zsh';
+            const args = ['startup.sh'];
+            await CLIService_1.default.spawnCmd(cmd, args, process.env.HOME);
+            return;
+        }
+        Logger_1.default.info(`Executing the following command: "${cmd}"`);
+        const { output } = await CLIService_1.default.execCmd(cmd);
+        Logger_1.default.info(output);
+        process.exit();
+    }
+    /**
+     * Determines the type of operating system in the current environment.
+     *
+     * This looks to be O(1) complexity.
+     */
+    static get os() {
+        if (process.platform === 'win32') {
+            return OperatingSystemType.Windows;
+        }
+        if (process.platform === 'darwin') {
+            return OperatingSystemType.MacOSX;
+        }
+        return OperatingSystemType.Unknown;
+    }
+    static folderName() {
+        return path_1.default.basename(path_1.default.resolve('.'));
+    }
+}
+exports.default = CurrentEnv;

package/lib/utils/Logger.d.ts

@@ -1,68 +1,68 @@
-export default class Logger {
-    static verboseLoggingEnabled: boolean;
-    /**
-     * Private variable that sets if any logging on this instance of the Log
-     * should only log if the `verboseLoggingEnabled` is set to true.
-     */
-    private logOnlyIfVerbose;
-    constructor(logOnlyIfVerbose?: boolean);
-    /**
-     * Sets the logging of the next chained function to only be activated
-     * if verbose logging is turned on.
-     */
-    static get verbose(): Logger;
-    /**
-     * Logs info to the console. Prepends `ℹ️` to each message.
-     */
-    info(msg: string, skipNewline?: boolean): void;
-    /**
-     * Static version of {@link Logger.prototype.info}.
-     *
-     * @see Logger.prototype.info
-     */
-    static info(msg: string, skipNewline?: boolean): void;
-    /**
-     * Logs a success message to the console. Prepends `✅` to each message.
-     *
-     * @param msg
-     */
-    success(msg: string): void;
-    /**
-     * Static version of {@link Logger.prototype.success}.
-     *
-     * @see Logger.prototype.success
-     */
-    static success(msg: string): void;
-    /**
-     * Logs a failure message to the console. Prepends `🔴` to each message.
-     *
-     * See {@link error} for logging errors.
-     *
-     * This doesn't use a `console.error` entry. Just a `console.log` entry.
-     * @param msg
-     */
-    failure(msg: string): void;
-    /**
-     * Static version of {@link Logger.prototype.failure}.
-     *
-     * @see Logger.prototype.failure
-     */
-    static failure(msg: string): void;
-    /**
-     * Logs an error message to the console. Only use this for errors that will
-     * likely stop execution. Prepends `💀` to each message and uses `console.error`.
-     *
-     * See {@link failure} for logging simple failures.
-     *
-     * @param msg
-     */
-    error(msg: string): void;
-    /**
-     * Static version of {@link Logger.prototype.error}.
-     *
-     * @see Logger.prototype.error
-     */
-    static error(msg: string): void;
-    private shouldLog;
-}
+export default class Logger {
+    static verboseLoggingEnabled: boolean;
+    /**
+     * Private variable that sets if any logging on this instance of the Log
+     * should only log if the `verboseLoggingEnabled` is set to true.
+     */
+    private logOnlyIfVerbose;
+    constructor(logOnlyIfVerbose?: boolean);
+    /**
+     * Sets the logging of the next chained function to only be activated
+     * if verbose logging is turned on.
+     */
+    static get verbose(): Logger;
+    /**
+     * Logs info to the console. Prepends `ℹ️` to each message.
+     */
+    info(msg: string, skipNewline?: boolean): void;
+    /**
+     * Static version of {@link Logger.prototype.info}.
+     *
+     * @see Logger.prototype.info
+     */
+    static info(msg: string, skipNewline?: boolean): void;
+    /**
+     * Logs a success message to the console. Prepends `✅` to each message.
+     *
+     * @param msg
+     */
+    success(msg: string): void;
+    /**
+     * Static version of {@link Logger.prototype.success}.
+     *
+     * @see Logger.prototype.success
+     */
+    static success(msg: string): void;
+    /**
+     * Logs a failure message to the console. Prepends `🔴` to each message.
+     *
+     * See {@link error} for logging errors.
+     *
+     * This doesn't use a `console.error` entry. Just a `console.log` entry.
+     * @param msg
+     */
+    failure(msg: string): void;
+    /**
+     * Static version of {@link Logger.prototype.failure}.
+     *
+     * @see Logger.prototype.failure
+     */
+    static failure(msg: string): void;
+    /**
+     * Logs an error message to the console. Only use this for errors that will
+     * likely stop execution. Prepends `💀` to each message and uses `console.error`.
+     *
+     * See {@link failure} for logging simple failures.
+     *
+     * @param msg
+     */
+    error(msg: string): void;
+    /**
+     * Static version of {@link Logger.prototype.error}.
+     *
+     * @see Logger.prototype.error
+     */
+    static error(msg: string): void;
+    private shouldLog;
+}
 //# sourceMappingURL=Logger.d.ts.map

package/lib/utils/Logger.js

@@ -1,112 +1,112 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Logger {
-    static verboseLoggingEnabled = false;
-    /**
-     * Private variable that sets if any logging on this instance of the Log
-     * should only log if the `verboseLoggingEnabled` is set to true.
-     */
-    logOnlyIfVerbose = false;
-    constructor(logOnlyIfVerbose) {
-        if (logOnlyIfVerbose) {
-            this.logOnlyIfVerbose = logOnlyIfVerbose;
-        }
-    }
-    /**
-     * Sets the logging of the next chained function to only be activated
-     * if verbose logging is turned on.
-     */
-    static get verbose() {
-        return new Logger(true);
-    }
-    /**
-     * Logs info to the console. Prepends `ℹ️` to each message.
-     */
-    info(msg, skipNewline) {
-        if (this.shouldLog()) {
-            const printMessage = `ℹ️  ${msg}`;
-            if (skipNewline) {
-                process.stdout.write(printMessage);
-            }
-            else {
-                console.log(printMessage);
-            }
-        }
-    }
-    /**
-     * Static version of {@link Logger.prototype.info}.
-     *
-     * @see Logger.prototype.info
-     */
-    static info(msg, skipNewline) {
-        new Logger().info(msg, skipNewline);
-    }
-    /**
-     * Logs a success message to the console. Prepends `✅` to each message.
-     *
-     * @param msg
-     */
-    success(msg) {
-        if (this.shouldLog()) {
-            console.log(`✅ ${msg}`);
-        }
-    }
-    /**
-     * Static version of {@link Logger.prototype.success}.
-     *
-     * @see Logger.prototype.success
-     */
-    static success(msg) {
-        new Logger().success(msg);
-    }
-    /**
-     * Logs a failure message to the console. Prepends `🔴` to each message.
-     *
-     * See {@link error} for logging errors.
-     *
-     * This doesn't use a `console.error` entry. Just a `console.log` entry.
-     * @param msg
-     */
-    failure(msg) {
-        if (this.shouldLog()) {
-            console.log(`🔴 ${msg}`);
-        }
-    }
-    /**
-     * Static version of {@link Logger.prototype.failure}.
-     *
-     * @see Logger.prototype.failure
-     */
-    static failure(msg) {
-        new Logger().failure(msg);
-    }
-    /**
-     * Logs an error message to the console. Only use this for errors that will
-     * likely stop execution. Prepends `💀` to each message and uses `console.error`.
-     *
-     * See {@link failure} for logging simple failures.
-     *
-     * @param msg
-     */
-    error(msg) {
-        if (this.shouldLog()) {
-            console.error(`💀 ${msg}`);
-        }
-    }
-    /**
-     * Static version of {@link Logger.prototype.error}.
-     *
-     * @see Logger.prototype.error
-     */
-    static error(msg) {
-        new Logger().error(msg);
-    }
-    shouldLog() {
-        if (!this.logOnlyIfVerbose ||
-            (this.logOnlyIfVerbose && Logger.verboseLoggingEnabled)) {
-            return true;
-        }
-        return false;
-    }
-}
-exports.default = Logger;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Logger {
+    static verboseLoggingEnabled = false;
+    /**
+     * Private variable that sets if any logging on this instance of the Log
+     * should only log if the `verboseLoggingEnabled` is set to true.
+     */
+    logOnlyIfVerbose = false;
+    constructor(logOnlyIfVerbose) {
+        if (logOnlyIfVerbose) {
+            this.logOnlyIfVerbose = logOnlyIfVerbose;
+        }
+    }
+    /**
+     * Sets the logging of the next chained function to only be activated
+     * if verbose logging is turned on.
+     */
+    static get verbose() {
+        return new Logger(true);
+    }
+    /**
+     * Logs info to the console. Prepends `ℹ️` to each message.
+     */
+    info(msg, skipNewline) {
+        if (this.shouldLog()) {
+            const printMessage = `ℹ️  ${msg}`;
+            if (skipNewline) {
+                process.stdout.write(printMessage);
+            }
+            else {
+                console.log(printMessage);
+            }
+        }
+    }
+    /**
+     * Static version of {@link Logger.prototype.info}.
+     *
+     * @see Logger.prototype.info
+     */
+    static info(msg, skipNewline) {
+        new Logger().info(msg, skipNewline);
+    }
+    /**
+     * Logs a success message to the console. Prepends `✅` to each message.
+     *
+     * @param msg
+     */
+    success(msg) {
+        if (this.shouldLog()) {
+            console.log(`✅ ${msg}`);
+        }
+    }
+    /**
+     * Static version of {@link Logger.prototype.success}.
+     *
+     * @see Logger.prototype.success
+     */
+    static success(msg) {
+        new Logger().success(msg);
+    }
+    /**
+     * Logs a failure message to the console. Prepends `🔴` to each message.
+     *
+     * See {@link error} for logging errors.
+     *
+     * This doesn't use a `console.error` entry. Just a `console.log` entry.
+     * @param msg
+     */
+    failure(msg) {
+        if (this.shouldLog()) {
+            console.log(`🔴 ${msg}`);
+        }
+    }
+    /**
+     * Static version of {@link Logger.prototype.failure}.
+     *
+     * @see Logger.prototype.failure
+     */
+    static failure(msg) {
+        new Logger().failure(msg);
+    }
+    /**
+     * Logs an error message to the console. Only use this for errors that will
+     * likely stop execution. Prepends `💀` to each message and uses `console.error`.
+     *
+     * See {@link failure} for logging simple failures.
+     *
+     * @param msg
+     */
+    error(msg) {
+        if (this.shouldLog()) {
+            console.error(`💀 ${msg}`);
+        }
+    }
+    /**
+     * Static version of {@link Logger.prototype.error}.
+     *
+     * @see Logger.prototype.error
+     */
+    static error(msg) {
+        new Logger().error(msg);
+    }
+    shouldLog() {
+        if (!this.logOnlyIfVerbose ||
+            (this.logOnlyIfVerbose && Logger.verboseLoggingEnabled)) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.default = Logger;