@storm-software/config-tools 1.75.0 → 1.77.0

package/package.json

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

package/src/config-file/get-config-file.d.ts

@@ -0,0 +1,16 @@
+import type { StormConfigInput } from "@storm-software/config";
+import { ResolvedConfig, type LoadConfigOptions } from "c12";
+/**
+ * Get the config file for the current Storm workspace
+ *
+ * @param fileName - The name of the config file to search for
+ * @param filePath - The path to search for the config file in
+ * @returns The config file for the current Storm workspace
+ */
+export declare const getConfigFileByName: (fileName: string, filePath?: string, options?: LoadConfigOptions<Partial<StormConfigInput>>) => Promise<ResolvedConfig<Partial<StormConfigInput>>>;
+/**
+ * Get the config file for the current Storm workspace
+ *
+ * @returns The config file for the current Storm workspace
+ */
+export declare const getConfigFile: (filePath?: string, additionalFileNames?: string[]) => Promise<Partial<StormConfigInput> | undefined>;

package/src/config-file/index.d.ts

@@ -0,0 +1 @@
+export * from "./get-config-file";

package/src/create-storm-config.d.ts

@@ -0,0 +1,26 @@
+import type { StormConfig } from "@storm-software/config";
+import type { ZodTypeAny } from "zod";
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace
+ */
+export declare const createConfig: (workspaceRoot?: string) => StormConfig;
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace
+ */
+export declare const createStormConfig: <TExtensionName extends keyof StormConfig["extensions"] = string, TExtensionConfig = any, TExtensionSchema extends ZodTypeAny = ZodTypeAny>(extensionName?: TExtensionName, schema?: TExtensionSchema, workspaceRoot?: string) => StormConfig<TExtensionName, TExtensionConfig>;
+/**
+ * Get the config for a specific Storm config Extension
+ *
+ * @param extensionName - The name of the config extension
+ * @param options - The options for the config extension
+ * @returns The config for the specified Storm config extension. If the extension does not exist, `undefined` is returned.
+ */
+export declare const createConfigExtension: <TExtensionName extends keyof StormConfig["extensions"] = string, TExtensionConfig = any, TExtensionSchema extends ZodTypeAny = ZodTypeAny>(extensionName: TExtensionName, schema: TExtensionSchema) => TExtensionConfig;
+/**
+ * Load the config file values for the current Storm workspace into environment variables
+ */
+export declare const loadStormConfig: (workspaceRoot?: string) => Promise<StormConfig>;

package/src/env/get-env.d.ts

@@ -0,0 +1,15 @@
+import { type StormConfig } from "@storm-software/config";
+import type { DeepPartial } from "../../declarations.d";
+/**
+ * Get the config for an extension module of Storm workspace from environment variables
+ *
+ * @param extensionName - The name of the extension module
+ * @returns The config for the specified Storm extension module. If the module does not exist, `undefined` is returned.
+ */
+export declare const getExtensionEnv: <TConfig extends Record<string, any> = Record<string, any>>(extensionName: string) => TConfig | undefined;
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace from environment variables
+ */
+export declare const getConfigEnv: () => DeepPartial<StormConfig>;

package/src/env/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./get-env";
+export * from "./set-env";

package/src/env/set-env.d.ts

@@ -0,0 +1,14 @@
+import type { StormConfig } from "@storm-software/config";
+/**
+ * Get the config for an extension module of Storm workspace from environment variables
+ *
+ * @param extensionName - The name of the extension module
+ * @returns The config for the specified Storm extension module. If the module does not exist, `undefined` is returned.
+ */
+export declare const setExtensionEnv: <TConfig extends Record<string, any> = Record<string, any>>(extensionName: string, extension: TConfig) => void;
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace from environment variables
+ */
+export declare const setConfigEnv: (config: StormConfig) => void;

package/src/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The config-tools library used by Storm Software for building TypeScript applications.
+ *
+ * @remarks
+ * A package containing various utilities to support custom workspace configurations
+ *
+ * @packageDocumentation
+ */
+export * from "./config-file";
+export * from "./create-storm-config";
+export * from "./env";
+export * from "./types";
+export * from "./utilities";

package/src/types.d.ts

@@ -0,0 +1,33 @@
+import type { StormConfig } from "@storm-software/config";
+export type LogLevel = 0 | 10 | 20 | 30 | 35 | 40 | 60 | 70 | 100;
+export declare const LogLevel: {
+    readonly SILENT: LogLevel;
+    readonly FATAL: LogLevel;
+    readonly ERROR: LogLevel;
+    readonly WARN: LogLevel;
+    readonly SUCCESS: LogLevel;
+    readonly INFO: LogLevel;
+    readonly DEBUG: LogLevel;
+    readonly TRACE: LogLevel;
+    readonly ALL: LogLevel;
+};
+export type LogLevelLabel = "silent" | "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "all";
+export declare const LogLevelLabel: {
+    readonly SILENT: LogLevelLabel;
+    readonly FATAL: LogLevelLabel;
+    readonly ERROR: LogLevelLabel;
+    readonly WARN: LogLevelLabel;
+    readonly INFO: LogLevelLabel;
+    readonly DEBUG: LogLevelLabel;
+    readonly TRACE: LogLevelLabel;
+    readonly ALL: LogLevelLabel;
+};
+export interface BaseTokenizerOptions {
+    workspaceRoot?: string;
+    config?: StormConfig;
+}
+export interface ProjectTokenizerOptions extends BaseTokenizerOptions {
+    projectRoot?: string;
+    projectName?: string;
+    sourceRoot?: string;
+}

package/src/utilities/apply-workspace-tokens.d.ts

@@ -0,0 +1,4 @@
+import type { BaseTokenizerOptions, ProjectTokenizerOptions } from "../../declarations";
+export declare const applyWorkspaceBaseTokens: (option: string, tokenizerOptions: BaseTokenizerOptions) => Promise<string>;
+export declare const applyWorkspaceProjectTokens: (option: string, tokenizerOptions: ProjectTokenizerOptions) => Promise<string>;
+export declare const applyWorkspaceTokens: <TConfig extends BaseTokenizerOptions = BaseTokenizerOptions>(options: Record<string, any>, config: TConfig, tokenizerFn: (option: string, config: TConfig) => string | Promise<string>) => Promise<Record<string, any>>;

package/src/utilities/chalk.d.ts

@@ -0,0 +1,23 @@
+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
+ */
+export declare const getChalk: () => GetChalkReturn;

package/src/utilities/correct-paths.d.ts

@@ -0,0 +1 @@
+export declare const correctPaths: (path?: string) => string;

package/src/utilities/file-path-utils.d.ts

@@ -0,0 +1,2 @@
+export declare const removeExtension: (filePath?: string) => string;
+export declare function findFileName(filePath: string): string;

package/src/utilities/find-up.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Gets the nearest "node_modules" folder by walking up from start path.
+ */
+export declare function findFolderUp(startPath: string, endFileNames: string[]): string | undefined;

package/src/utilities/find-workspace-root.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Find the monorepo root directory, searching upwards from `path`.
+ *
+ * @param pathInsideMonorepo - The path inside the monorepo to start searching from
+ * @returns The monorepo root directory
+ */
+export declare function findWorkspaceRootSafe(pathInsideMonorepo?: string): string | undefined;
+/**
+ * Find the monorepo root directory, searching upwards from `path`.
+ *
+ * @param pathInsideMonorepo - The path inside the monorepo to start searching from
+ * @returns The monorepo root directory
+ */
+export declare function findWorkspaceRoot(pathInsideMonorepo?: string): string;

package/src/utilities/get-default-config.d.ts

@@ -0,0 +1,15 @@
+import { type ColorConfig, type StormConfig } from "@storm-software/config";
+/**
+ * Storm theme config values used for styling various workspace elements
+ */
+export declare const DEFAULT_COLOR_CONFIG: ColorConfig;
+/**
+ * Storm Workspace config values used during various dev-ops processes
+ */
+export declare const DEFAULT_STORM_CONFIG: any;
+/**
+ * Get the default Storm config values used during various dev-ops processes
+ *
+ * @returns The default Storm config values
+ */
+export declare const getDefaultConfig: (config?: Partial<StormConfig>, root?: string) => StormConfig;

package/src/utilities/get-log-level.d.ts

@@ -0,0 +1,15 @@
+import { LogLevel, LogLevelLabel } from "../types";
+/**
+ * Convert the log level label to a log level
+ *
+ * @param label - The log level label to convert
+ * @returns The log level
+ */
+export declare const getLogLevel: (label?: string) => LogLevel;
+/**
+ * Convert the log level to a log level label
+ *
+ * @param logLevel - The log level to convert
+ * @returns The log level label
+ */
+export declare const getLogLevelLabel: (logLevel?: number) => LogLevelLabel;

package/src/utilities/index.d.ts

@@ -0,0 +1,10 @@
+export * from "./apply-workspace-tokens";
+export * from "./chalk";
+export * from "./correct-paths";
+export * from "./file-path-utils";
+export * from "./find-workspace-root";
+export * from "./get-default-config";
+export * from "./get-log-level";
+export * from "./logger";
+export * from "./process-handler";
+export * from "./run";

package/src/utilities/logger.d.ts

@@ -0,0 +1,74 @@
+import type { StormConfig } from "@storm-software/config";
+import { LogLevel } from "../types";
+/**
+ * Get the log function for a log level
+ *
+ * @param logLevel - The log level
+ * @param config - The Storm configuration
+ * @returns The log function
+ */
+export declare const getLogFn: (logLevel?: number | LogLevel, config?: Partial<StormConfig>) => ((message?: any) => void);
+/**
+ * Write a message to the console at the `fatal` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeFatal: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `error` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeError: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `warning` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeWarning: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `info` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeInfo: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `success` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeSuccess: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `debug` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeDebug: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `trace` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeTrace: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Write a message to the console at the `all` log level
+ *
+ * @param message - The message to write
+ * @param config - The Storm configuration
+ */
+export declare const writeSystem: (message?: any, config?: Partial<StormConfig>) => void;
+/**
+ * Get a stopwatch function
+ *
+ * @param name - The name of the process
+ * @returns The stopwatch function
+ */
+export declare const getStopwatch: (name: string) => () => void;
+export declare const formatLogMessage: (message?: any, prefix?: string) => string;

package/src/utilities/process-handler.d.ts

@@ -0,0 +1,4 @@
+import type { StormConfig } from "@storm-software/config";
+export declare const exitWithError: (config?: Partial<StormConfig>) => never;
+export declare const exitWithSuccess: (config?: Partial<StormConfig>) => never;
+export declare const handleProcess: (config?: Partial<StormConfig>) => void;

package/src/utilities/run.d.ts

@@ -0,0 +1,18 @@
+import type { StormConfig } from "@storm-software/config";
+export declare const LARGE_BUFFER: number;
+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
+ * @param stdio - The standard input/output options
+ * @param env - The environment variables
+ * @returns The result of the command
+ */
+export declare const run: (config: StormConfig, command: string, cwd?: string, stdio?: StdioOptions, env?: NodeJS.ProcessEnv) => Buffer;