@aneuhold/core-ts-lib 1.0.3

package/lib/helperFunctions/applications/applications.d.ts

@@ -0,0 +1,21 @@
+export type Application = {
+    defaultCall: () => Promise<void>;
+    [functionName: string]: unknown;
+};
+/**
+ * The list of app names that are possible. These can be aliases to specific
+ * operations as well. This is the single source of truth.
+ */
+export declare enum AppName {
+    chrome = "chrome",
+    nugetCache = "nugetCache"
+}
+/**
+ * Holds logic pertaining to running and using individual applications on the
+ * current system.
+ */
+declare const applications: {
+    [appName in AppName]: Application;
+};
+export default applications;
+//# sourceMappingURL=applications.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"applications.d.ts","sourceRoot":"","sources":["../../../src/helperFunctions/applications/applications.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC,CAAC;AAEF;;;GAGG;AACH,oBAAY,OAAO;IACjB,MAAM,WAAW;IACjB,UAAU,eAAe;CAC1B;AAED;;;GAGG;AACH,QAAA,MAAM,YAAY,EAAE;KAAG,OAAO,IAAI,OAAO,GAAG,WAAW;CAGtD,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/lib/helperFunctions/applications/applications.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppName = void 0;
+const chromeApplication_1 = __importDefault(require("./chromeApplication"));
+const fileSystemApplication_1 = __importDefault(require("./fileSystemApplication"));
+/**
+ * The list of app names that are possible. These can be aliases to specific
+ * operations as well. This is the single source of truth.
+ */
+var AppName;
+(function (AppName) {
+    AppName["chrome"] = "chrome";
+    AppName["nugetCache"] = "nugetCache";
+})(AppName = exports.AppName || (exports.AppName = {}));
+/**
+ * Holds logic pertaining to running and using individual applications on the
+ * current system.
+ */
+const applications = {
+    chrome: chromeApplication_1.default,
+    nugetCache: fileSystemApplication_1.default
+};
+exports.default = applications;

package/lib/helperFunctions/applications/chromeApplication.d.ts

@@ -0,0 +1,8 @@
+import { Application } from './applications';
+/**
+ * Holds the logic pertaining to interacting with the Chrome application,
+ * regardless of which platform it is on.
+ */
+declare const chromeApplication: Application;
+export default chromeApplication;
+//# sourceMappingURL=chromeApplication.d.ts.map

package/lib/helperFunctions/applications/chromeApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chromeApplication.d.ts","sourceRoot":"","sources":["../../../src/helperFunctions/applications/chromeApplication.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AA+B7C;;;GAGG;AACH,QAAA,MAAM,iBAAiB,EAAE,WAIxB,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/lib/helperFunctions/applications/chromeApplication.js

@@ -0,0 +1,63 @@
+"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 cmd_1 = __importDefault(require("../cmd"));
+/**
+ * Gets the path to the chrome application for the current system given the
+ * operating system type.
+ *
+ * This does include the quotes
+ */
+function 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.
+ */
+async function openAndSetPinnedTabs() {
+    await (0, cmd_1.default)(`${getChromePath(CurrentEnv_1.default.os)} --pinned-tab-count=2 https://google.com https://tonyneuhold.com`);
+}
+/**
+ * Holds the logic pertaining to interacting with the Chrome application,
+ * regardless of which platform it is on.
+ */
+const chromeApplication = {
+    async defaultCall() {
+        openAndSetPinnedTabs();
+    }
+};
+exports.default = chromeApplication;

package/lib/helperFunctions/applications/fileSystemApplication.d.ts

@@ -0,0 +1,8 @@
+import { Application } from './applications';
+/**
+ * Holds the logic pertaining to interacting with the Chrome application,
+ * regardless of which platform it is on.
+ */
+declare const fileSystemApplication: Application;
+export default fileSystemApplication;
+//# sourceMappingURL=fileSystemApplication.d.ts.map

package/lib/helperFunctions/applications/fileSystemApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileSystemApplication.d.ts","sourceRoot":"","sources":["../../../src/helperFunctions/applications/fileSystemApplication.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAe7C;;;GAGG;AACH,QAAA,MAAM,qBAAqB,EAAE,WAI5B,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/lib/helperFunctions/applications/fileSystemApplication.js

@@ -0,0 +1,51 @@
+"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 cmd_1 = __importDefault(require("../cmd"));
+async function openWindowsNugetCache() {
+    await Promise.all([
+        (0, cmd_1.default)(`ii $HOME/localNuget`),
+        (0, cmd_1.default)(`ii $HOME/.nuget/packages`)
+    ]);
+}
+async function openNugetCache() {
+    if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows) {
+        await openWindowsNugetCache();
+    }
+}
+/**
+ * Holds the logic pertaining to interacting with the Chrome application,
+ * regardless of which platform it is on.
+ */
+const fileSystemApplication = {
+    async defaultCall() {
+        await openNugetCache();
+    }
+};
+exports.default = fileSystemApplication;

package/lib/helperFunctions/cmd.d.ts

@@ -0,0 +1,51 @@
+export declare const variousCommands: {
+    pwshExectuablePath: string;
+};
+type ExecCmdReturnType = {
+    didComplete: boolean;
+    output: string;
+};
+export type ExecCmdCommandArgument = string | {
+    command: string;
+    args?: string[];
+};
+/**
+ * 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.
+ *
+ * @returns an object that holds the output and the true if the command comlpleted
+ * successfully or false if it did not
+ */
+export default function execCmd(cmd: ExecCmdCommandArgument, logError?: boolean, cwd?: string): Promise<ExecCmdReturnType>;
+/**
+ * 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.
+ */
+export declare function execCmdWithTimeout(command: string, ms?: number): Promise<ExecCmdReturnType>;
+export {};
+//# sourceMappingURL=cmd.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cmd.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/cmd.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,eAAe;;CAG3B,CAAC;AAEF,KAAK,iBAAiB,GAAG;IAAE,WAAW,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAClE,MAAM,MAAM,sBAAsB,GAC9B,MAAM,GACN;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AA6EzC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAA8B,OAAO,CACnC,GAAG,EAAE,sBAAsB,EAC3B,QAAQ,UAAQ,EAChB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,iBAAiB,CAAC,CAoB5B;AAED;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,MAAM,EACf,EAAE,SAAO,GACR,OAAO,CAAC,iBAAiB,CAAC,CAQ5B"}

package/lib/helperFunctions/cmd.js

@@ -0,0 +1,170 @@
+"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'
+};
+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.
+ *
+ * @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
+    };
+    // Use powershell core if it is windows
+    if (CurrentEnv_1.default.os === CurrentEnv_1.OperatingSystemType.Windows) {
+        execOptions.shell = 'pwsh';
+    }
+    if (typeof cmd === 'string') {
+        Log_1.default.verbose.info('Command type provided to "execCmd" was a string, so executing "exec" promise...');
+        return helperExec(cmd, execOptions, logError);
+    }
+    Log_1.default.verbose.info('Command type provided to "execCmd" was an object, so executing "spawn" promise...');
+    return helperSpawn(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/dateFunctions.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Determines if the dates are on the same day.
+ *
+ * @param first the first date
+ * @param second the second date
+ * @returns true if they are on the same day
+ */
+declare function datesAreOnSameDay(first: Date, second: Date): boolean;
+export default datesAreOnSameDay;
+//# sourceMappingURL=dateFunctions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dateFunctions.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/dateFunctions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO,CAM7D;AAED,eAAe,iBAAiB,CAAC"}

package/lib/helperFunctions/dateFunctions.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Determines if the dates are on the same day.
+ *
+ * @param first the first date
+ * @param second the second date
+ * @returns true if they are on the same day
+ */
+function datesAreOnSameDay(first, second) {
+    return (first.getFullYear() === second.getFullYear() &&
+        first.getMonth() === second.getMonth() &&
+        first.getDate() === second.getDate());
+}
+exports.default = datesAreOnSameDay;

package/lib/helperFunctions/fileFunctions.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,43 @@
+"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

@@ -0,0 +1,8 @@
+/**
+ * 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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,48 @@
+"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/helperFunctions/sleep.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sleeps for the given amount of milliseconds, and resolves once finished.
+ *
+ * @param ms the number of milliseconds to sleep
+ * @returns
+ */
+export default function sleep(ms: number): Promise<void>;
+//# sourceMappingURL=sleep.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/sleep.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvD"}

package/lib/helperFunctions/sleep.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Sleeps for the given amount of milliseconds, and resolves once finished.
+ *
+ * @param ms the number of milliseconds to sleep
+ * @returns
+ */
+function sleep(ms) {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+}
+exports.default = sleep;

package/lib/helperFunctions/stringFunctions.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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
+ */
+export default function getFileNameExtension(fileName: string): string | undefined;
+//# sourceMappingURL=stringFunctions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"stringFunctions.d.ts","sourceRoot":"","sources":["../../src/helperFunctions/stringFunctions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,oBAAoB,CAC1C,QAAQ,EAAE,MAAM,GACf,MAAM,GAAG,SAAS,CAEpB"}

package/lib/helperFunctions/stringFunctions.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * 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
+ */
+function getFileNameExtension(fileName) {
+    return fileName.split('.').pop();
+}
+exports.default = getFileNameExtension;

package/lib/index.d.ts

@@ -0,0 +1,24 @@
+import execCmd, { execCmdWithTimeout } from './helperFunctions/cmd';
+import datesAreOnSameDay from './helperFunctions/dateFunctions';
+import findAndInsertText from './helperFunctions/fileFunctions';
+import getUserInput from './helperFunctions/input';
+import sleep from './helperFunctions/sleep';
+import getFileNameExtension from './helperFunctions/stringFunctions';
+import CurrentEnv, { OperatingSystemType, ShellType, TerminalType } from './utils/CurrentEnv';
+import Log from './utils/Log';
+declare const _default: {
+    execCmd: typeof execCmd;
+    execCmdWithTimeout: typeof execCmdWithTimeout;
+    CurrentEnv: typeof CurrentEnv;
+    Log: typeof Log;
+    sleep: typeof sleep;
+    getUserInput: typeof getUserInput;
+    findAndInsertText: typeof findAndInsertText;
+    OperatingSystemType: typeof OperatingSystemType;
+    ShellType: typeof ShellType;
+    TerminalType: typeof TerminalType;
+    datesAreOnSameDay: typeof datesAreOnSameDay;
+    getFileNameExtension: typeof getFileNameExtension;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,iBAAiB,MAAM,iCAAiC,CAAC;AAChE,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,MAAM,yBAAyB,CAAC;AAC5C,OAAO,oBAAoB,MAAM,mCAAmC,CAAC;AACrE,OAAO,UAAU,EAAE,EACjB,mBAAmB,EACnB,SAAS,EACT,YAAY,EACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,GAAG,MAAM,aAAa,CAAC;;;;;;;;;;;;;;;AAG9B,wBAaE"}

package/lib/index.js

@@ -0,0 +1,51 @@
+"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 cmd_1 = __importStar(require("./helperFunctions/cmd"));
+const dateFunctions_1 = __importDefault(require("./helperFunctions/dateFunctions"));
+const fileFunctions_1 = __importDefault(require("./helperFunctions/fileFunctions"));
+const input_1 = __importDefault(require("./helperFunctions/input"));
+const sleep_1 = __importDefault(require("./helperFunctions/sleep"));
+const stringFunctions_1 = __importDefault(require("./helperFunctions/stringFunctions"));
+const CurrentEnv_1 = __importStar(require("./utils/CurrentEnv"));
+const Log_1 = __importDefault(require("./utils/Log"));
+// Export all the functions and classes from this library
+exports.default = {
+    execCmd: cmd_1.default,
+    execCmdWithTimeout: cmd_1.execCmdWithTimeout,
+    CurrentEnv: CurrentEnv_1.default,
+    Log: Log_1.default,
+    sleep: sleep_1.default,
+    getUserInput: input_1.default,
+    findAndInsertText: fileFunctions_1.default,
+    OperatingSystemType: CurrentEnv_1.OperatingSystemType,
+    ShellType: CurrentEnv_1.ShellType,
+    TerminalType: CurrentEnv_1.TerminalType,
+    datesAreOnSameDay: dateFunctions_1.default,
+    getFileNameExtension: stringFunctions_1.default
+};

package/lib/utils/CurrentEnv.d.ts

@@ -0,0 +1,65 @@
+/**
+ * The type of shell that the current environment is running.
+ */
+export declare enum ShellType {
+    PowerShellCore = 0,
+    PowerShellDesktop = 1,
+    Bash = 2,
+    Zsh = 3,
+    CommandPrompt = 4,
+    Unknown = 5
+}
+export declare enum OperatingSystemType {
+    Windows = 0,
+    MacOSX = 1,
+    Linux = 2,
+    Unknown = 3
+}
+/**
+ * The type of terminal that the current enviornment is running.
+ */
+export declare enum TerminalType {
+    WindowsTerminal = 0,
+    Unknown = 1
+}
+/**
+ * Provides information relevant to the current environment this script is
+ * running in.
+ */
+export default class CurrentEnv {
+    /**
+     * Returns the type of terminal the current environment is using.
+     */
+    static terminal(): TerminalType;
+    /**
+     * 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 shell(): Promise<ShellType>;
+    /**
+     * Gets all file names in the current directory.
+     */
+    static fileNamesInDir(): Promise<string[]>;
+    /**
+     * 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).
+     *
+     * @param args are the arguements that should be provided to the startup
+     * script as a string[]. This can be empty.
+     */
+    static runStartupScript(args?: string[]): Promise<void>;
+    /**
+     * Determines the type of operating system in the current environment.
+     *
+     * This looks to be O(1) complexity.
+     */
+    static get os(): OperatingSystemType;
+    static folderName(): string;
+}
+//# sourceMappingURL=CurrentEnv.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CurrentEnv.d.ts","sourceRoot":"","sources":["../../src/utils/CurrentEnv.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,oBAAY,SAAS;IACnB,cAAc,IAAA;IACd,iBAAiB,IAAA;IACjB,IAAI,IAAA;IACJ,GAAG,IAAA;IACH,aAAa,IAAA;IACb,OAAO,IAAA;CACR;AAED,oBAAY,mBAAmB;IAC7B,OAAO,IAAA;IACP,MAAM,IAAA;IACN,KAAK,IAAA;IACL,OAAO,IAAA;CACR;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,eAAe,IAAA;IACf,OAAO,IAAA;CACR;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;OAEG;WACW,QAAQ,IAAI,YAAY;IAStC;;;;;;OAMG;WACiB,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC;IAyB/C;;OAEG;WACiB,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIvD;;;;;;;;;OASG;WACiB,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BpE;;;;OAIG;IACH,WAAkB,EAAE,IAAI,mBAAmB,CAQ1C;WAEa,UAAU,IAAI,MAAM;CAGnC"}

package/lib/utils/CurrentEnv.js

@@ -0,0 +1,143 @@
+"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 cmd_1 = __importDefault(require("../helperFunctions/cmd"));
+const Log_1 = __importDefault(require("./Log"));
+/**
+ * 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 (0, cmd_1.default)('(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:
+                    Log_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).
+     *
+     * @param args are the arguements that should be provided to the startup
+     * script as a string[]. This can be empty.
+     */
+    static async runStartupScript(args) {
+        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 = { command: 'zsh' };
+            const tmpArgs = ['startup.sh'];
+            // Add additional arguments
+            if (args) {
+                args.forEach((arg) => {
+                    tmpArgs.push(arg);
+                });
+            }
+            cmd.args = tmpArgs;
+            await (0, cmd_1.default)(cmd, true, process.env.HOME);
+            return;
+        }
+        Log_1.default.info(`Executing the following command: "${cmd}"`);
+        const { output } = await (0, cmd_1.default)(cmd);
+        Log_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/Log.d.ts

@@ -0,0 +1,69 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,112 @@
+"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;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@aneuhold/core-ts-lib",
+  "version": "1.0.3",
+  "description": "A core library for all of my TypeScript projects",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "pushpub": "npm run build && npm version patch && git push && npm publish --access public",
+    "build": "tsc"
+  },
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aneuhold/core-ts-lib.git"
+  },
+  "keywords": [
+    "Scripting",
+    "Node.js"
+  ],
+  "author": "Anton G. Neuhold Jr.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/aneuhold/core-ts-lib/issues"
+  },
+  "homepage": "https://github.com/aneuhold/core-ts-lib#readme",
+  "files": [
+    "lib/**/*"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@types/node": "^16.10.2",
+    "@typescript-eslint/eslint-plugin": "^4.32.0",
+    "@typescript-eslint/parser": "^4.32.0",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.4.1",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.4.3"
+  }
+}

package/readme.md

@@ -0,0 +1,3 @@
+# core-ts-lib
+
+This is a library containing TypeScript that I am sharing among a few different projects.