@aneuhold/core-ts-lib 1.0.7 → 1.0.9

package/lib/helperFunctions/cmd.js

@@ -1,177 +0,0 @@
-"use strict";
-/* This file is meant to house helper functions for specifically executing
-command line / terminal things. */
-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 });
-exports.execCmdWithTimeout = exports.variousCommands = void 0;
-const child_process_1 = require("child_process");
-const util_1 = __importDefault(require("util"));
-const CurrentEnv_1 = __importStar(require("../utils/CurrentEnv"));
-const Log_1 = __importDefault(require("../utils/Log"));
-const sleep_1 = __importDefault(require("./sleep"));
-/**
- * The promisified version of the {@link normalExec} function.
- */
-const exec = util_1.default.promisify(child_process_1.exec);
-exports.variousCommands = {
-    pwshExectuablePath: 'Get-Command pwsh | Select-Object -ExpandProperty Definition'
-};
-const POWERSHELL_PREFIX = `pwsh -NoProfile -Command `;
-async function helperExec(cmd, execOptions, logError) {
-    try {
-        const { stdout, stderr } = await exec(cmd, execOptions);
-        if (stderr) {
-            if (logError) {
-                Log_1.default.error(`There was an error executing ${cmd}. Details are printed below:
-        ${stderr}`);
-            }
-            return {
-                didComplete: false,
-                output: stderr
-            };
-        }
-        Log_1.default.verbose.info(stdout);
-        return {
-            didComplete: true,
-            output: stdout
-        };
-    }
-    catch (err) {
-        Log_1.default.error(`There was an error executing the "exec" function. Details are printed below:
-    ${err}`);
-        return {
-            didComplete: false,
-            output: err
-        };
-    }
-}
-/**
- * Code was found from this site: https://stackabuse.com/executing-shell-commands-with-node-js/.
- *
- * This still needs to be hardened it feels like.
- *
- * @param cmd
- * @param execOptions
- */
-async function helperSpawn(cmd, args, execOptions) {
-    return new Promise((resolve) => {
-        let output = '';
-        const spawnedCmd = (0, child_process_1.spawn)(cmd, args, execOptions);
-        spawnedCmd.on('error', (err) => {
-            Log_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;
-            Log_1.default.info(data, true);
-        });
-        spawnedCmd.stderr.on('data', (data) => {
-            output += data;
-            Log_1.default.info(data, true);
-        });
-        spawnedCmd.on('close', (exitCode) => {
-            Log_1.default.info(`Command "${cmd}" exited with code ${exitCode}`);
-            resolve({
-                didComplete: true,
-                output
-            });
-        });
-    });
-}
-/**
- * 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 as either one large string or an object.
- *
- * If just a string is provided, this is ran as a normal execution where the
- * output is all returned at once after completion. For example this could be
- * `ls -a`
- *
- * If an object is provided, this 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. For example the param
- * could be `{command: "npm", args: ["install"]}`
- *
- * @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.
- *
- * @returns an object that holds the output and the true if the command comlpleted
- * successfully or false if it did not
- */
-async function execCmd(cmd, logError = false, cwd) {
-    const execOptions = {
-        cwd
-    };
-    let modifiedCmd = null;
-    if (typeof cmd === 'string') {
-        Log_1.default.verbose.info('Command type provided to "execCmd" was a string, so executing "exec" promise...');
-        if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows) {
-            modifiedCmd = POWERSHELL_PREFIX + cmd;
-        }
-        return helperExec(modifiedCmd || cmd, execOptions, logError);
-    }
-    Log_1.default.verbose.info('Command type provided to "execCmd" was an object, so executing "spawn" promise...');
-    if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows) {
-        modifiedCmd = POWERSHELL_PREFIX + cmd.command;
-    }
-    return helperSpawn(modifiedCmd || cmd.command, cmd.args, execOptions);
-}
-exports.default = execCmd;
-/**
- * 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.
- */
-async function 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, execCmd(command)]);
-}
-exports.execCmdWithTimeout = execCmdWithTimeout;

package/lib/helperFunctions/fileFunctions.d.ts

@@ -1,10 +0,0 @@
-/**
- * Tries to add the provided snippet of text to the path provided. If the file
- * doesn't exist, it creates it. If the folders to the file don't exist, it
- * creates those. If the text already exists in the file, it does nothing.
- *
- * @param folderPath the path to the folder which contains the file that should
- * be updated
- */
-export default function findAndInsertText(folderPath: string, fileName: string, textToInsert: string): Promise<void>;
-//# sourceMappingURL=fileFunctions.d.ts.map

package/lib/helperFunctions/fileFunctions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fileFunctions.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/fileFunctions.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,wBAA8B,iBAAiB,CAC7C,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CA0Bf"}

package/lib/helperFunctions/fileFunctions.js

@@ -1,43 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const promises_1 = require("fs/promises");
-const path_1 = __importDefault(require("path"));
-const Log_1 = __importDefault(require("../utils/Log"));
-/**
- * Tries to add the provided snippet of text to the path provided. If the file
- * doesn't exist, it creates it. If the folders to the file don't exist, it
- * creates those. If the text already exists in the file, it does nothing.
- *
- * @param folderPath the path to the folder which contains the file that should
- * be updated
- */
-async function findAndInsertText(folderPath, fileName, textToInsert) {
-    const filePath = path_1.default.join(folderPath, fileName);
-    try {
-        await (0, promises_1.access)(folderPath);
-    }
-    catch (e) {
-        console.log(e);
-        Log_1.default.info(`Directory "${folderPath}" does not exist. Creating it now...`);
-        await (0, promises_1.mkdir)(folderPath, { recursive: true });
-    }
-    try {
-        await (0, promises_1.access)(filePath);
-        const fileContents = await (0, promises_1.readFile)(filePath);
-        if (!fileContents.includes(textToInsert)) {
-            await (0, promises_1.appendFile)(filePath, `\n${textToInsert}`);
-            Log_1.default.info(`Added "${textToInsert}" to "${filePath}"`);
-        }
-        else {
-            Log_1.default.info(`"${textToInsert}" already exists in "${filePath}"`);
-        }
-    }
-    catch {
-        Log_1.default.info(`File at "${filePath}" didn't exist. Creating it now and adding "${textToInsert}" to it.`);
-        await (0, promises_1.writeFile)(filePath, textToInsert);
-    }
-}
-exports.default = findAndInsertText;

package/lib/helperFunctions/input.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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.
- */
-export default function getUserInput(promptToUser: string): Promise<string>;
-//# sourceMappingURL=input.d.ts.map

package/lib/helperFunctions/input.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/input.ts"],"names":[],"mappings":"AAgBA;;;;;GAKG;AACH,wBAA8B,YAAY,CACxC,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,MAAM,CAAC,CAEjB"}

package/lib/helperFunctions/input.js

@@ -1,48 +0,0 @@
-"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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const rl = __importStar(require("readline"));
-const readline = rl.createInterface({
-    input: process.stdin,
-    output: process.stdout
-});
-function ask(promptToUser) {
-    return new Promise((resolve) => {
-        readline.question(promptToUser, (input) => {
-            readline.close();
-            resolve(input);
-        });
-    });
-}
-/**
- * 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.
- */
-async function getUserInput(promptToUser) {
-    return ask(promptToUser);
-}
-exports.default = getUserInput;

package/lib/utils/Log.d.ts

@@ -1,69 +0,0 @@
-declare class Log {
-    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(): Log;
-    /**
-     * Logs info to the console. Prepends `ℹ️` to each message.
-     */
-    info(msg: string, skipNewline?: boolean): void;
-    /**
-     * Static version of {@link Log.prototype.info}.
-     *
-     * @see Log.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 Log.prototype.success}.
-     *
-     * @see Log.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 Log.prototype.failure}.
-     *
-     * @see Log.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 Log.prototype.error}.
-     *
-     * @see Log.prototype.error
-     */
-    static error(msg: string): void;
-    private shouldLog;
-}
-export default Log;
-//# sourceMappingURL=Log.d.ts.map

package/lib/utils/Log.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Log.d.ts","sourceRoot":"","sources":["../../src/utils/Log.ts"],"names":[],"mappings":"AAAA,cAAM,GAAG;IACP,OAAc,qBAAqB,UAAS;IAE5C;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CAAS;gBAErB,gBAAgB,CAAC,EAAE,OAAO;IAMtC;;;OAGG;IACH,MAAM,KAAK,OAAO,IAAI,GAAG,CAExB;IAED;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAW9C;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAIrD;;;;OAIG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAM1B;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIjC;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAM1B;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIjC;;;;;;;OAOG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMxB;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI/B,OAAO,CAAC,SAAS;CASlB;AAED,eAAe,GAAG,CAAC"}

package/lib/utils/Log.js

@@ -1,112 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Log {
-    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 Log(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 Log.prototype.info}.
-     *
-     * @see Log.prototype.info
-     */
-    static info(msg, skipNewline) {
-        new Log().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 Log.prototype.success}.
-     *
-     * @see Log.prototype.success
-     */
-    static success(msg) {
-        new Log().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 Log.prototype.failure}.
-     *
-     * @see Log.prototype.failure
-     */
-    static failure(msg) {
-        new Log().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 Log.prototype.error}.
-     *
-     * @see Log.prototype.error
-     */
-    static error(msg) {
-        new Log().error(msg);
-    }
-    shouldLog() {
-        if (!this.logOnlyIfVerbose ||
-            (this.logOnlyIfVerbose && Log.verboseLoggingEnabled)) {
-            return true;
-        }
-        return false;
-    }
-}
-exports.default = Log;