@storm-software/config-tools 1.37.0 → 1.38.1

package/src/utilities/logger.ts

@@ -1,239 +0,0 @@
-import { LogLevel, LogLevelLabel } from "../types";
-import type { StormConfig } from "@storm-software/config";
-import { getLogLevel } from "./get-log-level";
-import { getChalk } from "./chalk";
-
-/**
- * Get the log function for a log level
- *
- * @param config - The Storm configuration
- * @param logLevel - The log level
- * @returns The log function
- */
-export const getLogFn = (
-  config: Partial<StormConfig> = {},
-  logLevel: number | LogLevel = LogLevel.INFO
-): ((message?: string) => void) => {
-  let _chalk = getChalk();
-
-  const configLogLevel = (config.logLevel ??
-    process.env?.STORM_LOG_LEVEL ??
-    LogLevelLabel.INFO) as LogLevelLabel;
-
-  if (
-    (typeof logLevel === "number" &&
-      (logLevel >= getLogLevel(configLogLevel) ||
-        logLevel <= LogLevel.SILENT)) ||
-    (typeof logLevel === "string" &&
-      getLogLevel(logLevel) >= getLogLevel(configLogLevel))
-  ) {
-    return (_: string) => {
-      /* noop */
-    };
-  }
-
-  if (
-    (typeof logLevel === "number" && LogLevel.FATAL >= logLevel) ||
-    (typeof logLevel === "string" && LogLevel.FATAL >= getLogLevel(logLevel))
-  ) {
-    return (message?: string) => {
-      console.error(
-        `
-${_chalk.bold.hex(config?.colors?.error ? config.colors.error : "#7d1a1a")(">")} ${_chalk.bold
-          .bgHex(config?.colors?.fatal ? config.colors.fatal : "#7d1a1a")
-          .whiteBright(" 💀 Fatal ")}  ${_chalk.hex(
-          config?.colors?.error ? config.colors.error : "#1fb2a6"
-        )(message)}
-
-`
-      );
-    };
-  }
-
-  if (
-    (typeof logLevel === "number" && LogLevel.ERROR >= logLevel) ||
-    (typeof logLevel === "string" && LogLevel.ERROR >= getLogLevel(logLevel))
-  ) {
-    return (message?: string) => {
-      console.error(
-        `
-${_chalk.bold.hex(config?.colors?.error ? config.colors.error : "#7d1a1a")(">")} ${_chalk.bold
-          .bgHex(config?.colors?.error ? config.colors.error : "#7d1a1a")
-          .whiteBright(" ✘ Error ")}  ${_chalk.hex(
-          config?.colors?.error ? config.colors.error : "#7d1a1a"
-        )(message)}
-`
-      );
-    };
-  }
-
-  if (
-    (typeof logLevel === "number" && LogLevel.WARN >= logLevel) ||
-    (typeof logLevel === "string" && LogLevel.WARN >= getLogLevel(logLevel))
-  ) {
-    return (message?: string) => {
-      console.warn(
-        `
-${_chalk.bold.hex(config?.colors?.warning ? config.colors.warning : "#fcc419")("> ")} ${_chalk.bold
-          .bgHex(config?.colors?.warning ? config.colors.warning : "#fcc419")
-          .whiteBright("  ⚠ Warn  ")}  ${_chalk.hex(
-          config?.colors?.warning ? config.colors.warning : "#fcc419"
-        )(message)}
-`
-      );
-    };
-  }
-
-  if (
-    (typeof logLevel === "number" && LogLevel.SUCCESS >= logLevel) ||
-    (typeof logLevel === "string" && LogLevel.SUCCESS >= getLogLevel(logLevel))
-  ) {
-    return (message?: string) => {
-      console.info(
-        `
-${_chalk.bold.hex(config?.colors?.success ? config.colors.success : "#087f5b")(">")} ${_chalk.bold
-          .bgHex(config?.colors?.success ? config.colors.success : "#087f5b")
-          .whiteBright(" ✓ Success ")}  ${_chalk.hex(
-          config?.colors?.success ? config.colors.success : "#087f5b"
-        )(message)}
-`
-      );
-    };
-  }
-
-  if (
-    (typeof logLevel === "number" && LogLevel.INFO >= logLevel) ||
-    (typeof logLevel === "string" && LogLevel.INFO >= getLogLevel(logLevel))
-  ) {
-    return (message?: string) => {
-      console.info(
-        `
-${_chalk.bold.hex(config?.colors?.info ? config.colors.info : "#0ea5e9")(">")} ${_chalk.bold
-          .bgHex(config?.colors?.info ? config.colors.info : "#0ea5e9")
-          .whiteBright("  ℹ Info  ")}  ${_chalk.hex(
-          config?.colors?.info ? config.colors.info : "#0ea5e9"
-        )(message)}
-`
-      );
-    };
-  }
-
-  if (
-    (typeof logLevel === "number" && LogLevel.DEBUG >= logLevel) ||
-    (typeof logLevel === "string" && LogLevel.DEBUG >= getLogLevel(logLevel))
-  ) {
-    return (message?: string) => {
-      console.debug(
-        `
-${_chalk.bold.hex(config?.colors?.primary ? config.colors.primary : "#1fb2a6")(">")} ${_chalk.bold
-          .bgHex(config?.colors?.primary ? config.colors.primary : "#1fb2a6")
-          .whiteBright(" 🛠  Debug ")}  ${_chalk.hex(
-          config?.colors?.primary ? config.colors.primary : "#1fb2a6"
-        )(message)}
-`
-      );
-    };
-  }
-
-  return (message?: string) => {
-    console.log(
-      `
-${_chalk.bold.hex(config?.colors?.primary ? config.colors.primary : "#1fb2a6")(">")} ${_chalk.bold
-        .bgHex(config?.colors?.primary ? config.colors.primary : "#1fb2a6")
-        .whiteBright(" ✉ System ")}  ${_chalk.hex(
-        config?.colors?.primary ? config.colors.primary : "#1fb2a6"
-      )(message)}
-`
-    );
-  };
-};
-
-/**
- * Write a message to the console at the `fatal` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeFatal = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.FATAL)(message);
-
-/**
- * Write a message to the console at the `error` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeError = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.ERROR)(message);
-
-/**
- * Write a message to the console at the `warning` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeWarning = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.WARN)(message);
-
-/**
- * Write a message to the console at the `info` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeInfo = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.INFO)(message);
-
-/**
- * Write a message to the console at the `success` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeSuccess = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.SUCCESS)(message);
-
-/**
- * Write a message to the console at the `debug` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeDebug = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.DEBUG)(message);
-
-/**
- * Write a message to the console at the `trace` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeTrace = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.TRACE)(message);
-
-/**
- * Write a message to the console at the `all` log level
- *
- * @param config - The Storm configuration
- * @param message - The message to write
- */
-export const writeSystem = (config?: Partial<StormConfig>, message?: string) =>
-  getLogFn(config, LogLevel.ALL)(message);
-
-/**
- * Get a stopwatch function
- *
- * @param name - The name of the process
- * @returns The stopwatch function
- */
-export const getStopwatch = (name: string) => {
-  const start = process.hrtime();
-  return () => {
-    const end = process.hrtime(start);
-    console.info(
-      `\n>  ⏱️  The${name ? ` ${name}` : ""} process took ${Math.round(
-        end[0] * 1000 + end[1] / 1000000
-      )}ms to complete\n\n`
-    );
-  };
-};

package/src/utilities/process-handler.ts

@@ -1,44 +0,0 @@
-import type { StormConfig } from "@storm-software/config";
-import { writeError, writeFatal, writeSuccess, writeTrace } from "./logger";
-
-export const exitWithError = (config: Partial<StormConfig>) => {
-  writeFatal(config, "Exiting script with an error status...");
-  process.exit(1);
-};
-
-export const exitWithSuccess = (config: Partial<StormConfig>) => {
-  writeSuccess(config, "Script completed successfully. Exiting...");
-  process.exit(0);
-};
-
-export const handleProcess = (config: Partial<StormConfig>) => {
-  writeTrace(
-    config,
-    `Using the following arguments to process the script: ${process.argv.join(", ")}`
-  );
-
-  process.on("unhandledRejection", (error) => {
-    writeError(config, `An Unhandled Rejection occurred while running the program: ${error}`);
-    exitWithError(config);
-  });
-  process.on("uncaughtException", (error) => {
-    writeError(
-      config,
-      `An Uncaught Exception occurred while running the program: ${error.message} \nStacktrace: ${error.stack}`
-    );
-    exitWithError(config);
-  });
-
-  process.on("SIGTERM", (signal: NodeJS.Signals) => {
-    writeError(config, `The program terminated with signal code: ${signal}`);
-    exitWithError(config);
-  });
-  process.on("SIGINT", (signal: NodeJS.Signals) => {
-    writeError(config, `The program terminated with signal code: ${signal}`);
-    exitWithError(config);
-  });
-  process.on("SIGHUP", (signal: NodeJS.Signals) => {
-    writeError(config, `The program terminated with signal code: ${signal}`);
-    exitWithError(config);
-  });
-};

package/src/utilities/run.ts

@@ -1,37 +0,0 @@
-import type { StormConfig } from "@storm-software/config";
-import { execSync } from "node:child_process";
-
-export const LARGE_BUFFER = 1024 * 1000000;
-export type IOType = "overlapped" | "pipe" | "ignore" | "inherit";
-export type StdioOptions =
-  | IOType
-  | Array<IOType | "ipc" | number | null | undefined>;
-
-/**
- *  Run a command line process
- *
- * @remarks
- * A wrapper around execSync to run our command line processes
- *
- * @param config - The Storm configuration object
- * @param command - The command to run
- * @param cwd - The current working directory
- * @returns The result of the command
- */
-export const run = (
-  config: StormConfig,
-  command: string,
-  cwd: string = config.workspaceRoot ?? process.cwd(),
-  stdio: StdioOptions = "inherit"
-) => {
-  return execSync(command, {
-    cwd,
-    env: {
-      ...process.env,
-      FORCE_COLOR: "true"
-    },
-    stdio,
-    maxBuffer: LARGE_BUFFER,
-    killSignal: "SIGTERM"
-  });
-};

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "module": "commonjs"
-  },
-  "include": [
-    "**/*"
-  ],
-  "exclude": [
-    "jest.config.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.ts"
-  ]
-}

package/tsconfig.spec.json

@@ -1,16 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "types": [
-      "jest",
-      "node"
-    ]
-  },
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts"
-  ]
-}