@storm-software/config-tools 1.35.5 → 1.35.6

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.35.6 (2024-04-08)
+
+
+### 🩹 Fixes
+
+- **config-tools:** Export `getChalk` function so that it can be used in other packages ([2ca2241a](https://github.com/storm-software/storm-ops/commit/2ca2241a))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
 ## 1.35.5 (2024-04-08)
 
 

package/declarations.d.ts

@@ -267,3 +267,29 @@ declare function applyWorkspaceTokens<
   tokenizerFn: (option: string, config: TConfig) => string | Promise<string>
 ): Promise<Record<string, any>>;
 export { applyWorkspaceTokens };
+
+export type GetChalkReturn = {
+  hex: (_: string) => (message?: string) => string | undefined;
+  bgHex: (_: string) => {
+    whiteBright: (message?: string) => string | undefined;
+  };
+  whiteBright: (message?: string) => string | undefined;
+  bold: {
+    hex: (_: string) => (message?: string) => string | undefined;
+    bgHex: (_: string) => {
+      whiteBright: (message?: string) => string | undefined;
+    };
+    whiteBright: (message?: string) => string | undefined;
+  };
+};
+
+/**
+ * Get the chalk instance
+ *
+ * @remarks
+ * Annoying polyfill to temporarily fix the issue with the `chalk` import
+ *
+ * @returns The chalk instance
+ */
+declare function getChalk(): GetChalkReturn;
+export { getChalk };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/config-tools",
-  "version": "1.35.5",
+  "version": "1.35.6",
   "private": false,
   "description": "⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.",
   "repository": {

package/project.json

@@ -11,6 +11,7 @@
         "main": "packages/config-tools/src/index.ts",
         "additionalEntryPoints": [
           "packages/config-tools/src/utilities/find-workspace-root.ts",
+          "packages/config-tools/src/utilities/chalk.ts",
           "packages/config-tools/src/utilities/logger.ts"
         ],
         "outputPath": "dist/packages/config-tools",

package/src/utilities/chalk.ts

@@ -0,0 +1,53 @@
+import chalk from "chalk";
+
+export type GetChalkReturn = {
+  hex: (_: string) => (message?: string) => string | undefined;
+  bgHex: (_: string) => {
+    whiteBright: (message?: string) => string | undefined;
+  };
+  whiteBright: (message?: string) => string | undefined;
+  bold: {
+    hex: (_: string) => (message?: string) => string | undefined;
+    bgHex: (_: string) => {
+      whiteBright: (message?: string) => string | undefined;
+    };
+    whiteBright: (message?: string) => string | undefined;
+  };
+};
+
+const chalkDefault: GetChalkReturn = {
+  hex: (_: string) => (message?: string) => message,
+  bgHex: (_: string) => ({
+    whiteBright: (message?: string) => message
+  }),
+  whiteBright: (message?: string) => message,
+  bold: {
+    hex: (_: string) => (message?: string) => message,
+    bgHex: (_: string) => ({
+      whiteBright: (message?: string) => message
+    }),
+    whiteBright: (message?: string) => message
+  }
+};
+
+/**
+ * Get the chalk instance
+ *
+ * @remarks
+ * Annoying polyfill to temporarily fix the issue with the `chalk` import
+ *
+ * @returns The chalk instance
+ */
+export const getChalk = (): GetChalkReturn => {
+  let _chalk = chalk as GetChalkReturn;
+  if (
+    !_chalk?.hex ||
+    !_chalk?.bold?.hex ||
+    !_chalk?.bgHex ||
+    !_chalk?.whiteBright
+  ) {
+    _chalk = chalkDefault;
+  }
+
+  return _chalk;
+};

package/src/utilities/index.ts

@@ -7,3 +7,4 @@ export * from "./run";
 export * from "./correct-paths";
 export * from "./file-path-utils";
 export * from "./apply-workspace-tokens";
+export * from "./chalk";

package/src/utilities/logger.ts

@@ -1,24 +1,7 @@
 import { LogLevel, LogLevelLabel } from "../types";
 import type { StormConfig } from "@storm-software/config";
 import { getLogLevel } from "./get-log-level";
-import chalk from "chalk";
-
-// Annoying chalk polyfill to temporarily fix the issue with the `chalk` import
-const chalkDefault = {
-  hex: (_: string) => (message?: string) => message,
-  bgHex: (_: string) => ({
-    whiteBright: (message?: string) => message
-  }),
-  whiteBright: (message?: string) => message,
-  bold: {
-    hex: (_: string) => (message?: string) => message,
-    bgHex: (_: string) => ({
-      whiteBright: (message?: string) => message
-    }),
-    whiteBright: (message?: string) => message
-  }
-} as any;
-// const chalk = chalkDefault;
+import { getChalk } from "./chalk";
 
 /**
  * Get the log function for a log level
@@ -31,10 +14,7 @@ export const getLogFn = (
   config: Partial<StormConfig> = {},
   logLevel: number | LogLevel = LogLevel.INFO
 ): ((message?: string) => void) => {
-  let _chalk = chalk;
-  if (!_chalk?.hex || !_chalk?.bold?.hex || !_chalk?.bgHex || !_chalk?.whiteBright) {
-    _chalk = chalkDefault;
-  }
+  let _chalk = getChalk();
 
   const configLogLevel = (config.logLevel ??
     process.env?.STORM_LOG_LEVEL ??
@@ -42,8 +22,10 @@ export const getLogFn = (
 
   if (
     (typeof logLevel === "number" &&
-      (logLevel >= getLogLevel(configLogLevel) || logLevel <= LogLevel.SILENT)) ||
-    (typeof logLevel === "string" && getLogLevel(logLevel) >= getLogLevel(configLogLevel))
+      (logLevel >= getLogLevel(configLogLevel) ||
+        logLevel <= LogLevel.SILENT)) ||
+    (typeof logLevel === "string" &&
+      getLogLevel(logLevel) >= getLogLevel(configLogLevel))
   ) {
     return (_: string) => {
       /* noop */