@storm-software/config-tools 1.32.4 → 1.33.0

package/.eslintrc.json

@@ -0,0 +1,37 @@
+{
+  "extends": ["../../.eslintrc.json", "../../.eslintrc.base.json"],
+  "ignorePatterns": ["!**/*", "node_modules/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": [
+          "error",
+          {
+            "buildTargets": ["build"],
+            "ignoredFiles": [
+              "{projectRoot}/esbuild.config.{js,ts,mjs,mts}",
+              "{projectRoot}/jest.config.ts"
+            ],
+            "checkMissingDependencies": true,
+            "checkObsoleteDependencies": true,
+            "checkVersionMismatches": false
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.33.0 (2024-03-25)
+
+
+### 🚀 Features
+
+- **workspace-tools:** Added Nx plugin to apply rust and typescript targets ([5738161f](https://github.com/storm-software/storm-ops/commit/5738161f))
+
+- **workspace-tools:** Major updates to base nx.json configuration ([06ec9a6a](https://github.com/storm-software/storm-ops/commit/06ec9a6a))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
 ## 1.32.4 (2024-03-15)
 
 

package/README.md

@@ -16,7 +16,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-1.32.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.32.4-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
 [![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 > [!IMPORTANT]

package/jest.config.ts

@@ -0,0 +1,3 @@
+import { getJestConfig } from "@storm-software/testing-tools";
+
+export default getJestConfig("packages/config-tools", true, "config-tools");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/config-tools",
-  "version": "1.32.4",
+  "version": "1.33.0",
   "private": false,
   "description": "⚡The Storm-Ops monorepo contains utility applications, tools, and various libraries to create modern and scalable web applications.",
   "repository": {
@@ -13,15 +13,15 @@
   "dependencies": {
     "chalk": "4.1.2",
     "cosmiconfig": "9.0.0",
-    "find-up": "7.0.0",
-    "fs-extra": "11.2.0",
-    "locate-path": "7.2.0",
     "zod": "3.22.4"
   },
+  "peerDependencies": {
+    "@storm-software/config": "workspace:*"
+  },
   "publishConfig": {
     "access": "public"
   },
   "devDependencies": {
-    "@types/fs-extra": "^11.0.4"
+    "@storm-software/config": "1.7.0"
   }
 }

package/project.json

@@ -0,0 +1,69 @@
+{
+  "name": "config-tools",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "packages/config-tools/src",
+  "targets": {
+    "build": {
+      "executor": "@nx/esbuild:esbuild",
+      "outputs": [
+        "{options.outputPath}"
+      ],
+      "options": {
+        "main": "packages/config-tools/src/index.ts",
+        "additionalEntryPoints": [
+          "packages/config-tools/src/utilities/find-workspace-root.ts",
+          "packages/config-tools/src/utilities/logger.ts"
+        ],
+        "outputPath": "dist/packages/config-tools",
+        "tsConfig": "packages/config-tools/tsconfig.json",
+        "project": "packages/config-tools/package.json",
+        "defaultConfiguration": "production",
+        "platform": "node",
+        "deleteOutputPath": true,
+        "bundle": true,
+        "thirdParty": true,
+        "skipTypeCheck": false,
+        "metafile": true,
+        "minify": false,
+        "format": [
+          "cjs"
+        ],
+        "esbuildOptions": {
+          "outExtension": {
+            ".js": ".js"
+          }
+        },
+        "assets": [
+          {
+            "input": "./packages/config-tools",
+            "glob": "*.md",
+            "output": "."
+          },
+          {
+            "input": "",
+            "glob": "LICENSE",
+            "output": "."
+          },
+          {
+            "input": "./packages/config-tools",
+            "glob": "declarations.d.ts",
+            "output": "."
+          }
+        ],
+        "configurations": {
+          "production": {
+            "debug": false,
+            "verbose": false
+          },
+          "development": {
+            "debug": true,
+            "verbose": true
+          }
+        }
+      }
+    },
+    "lint": {},
+    "test": {}
+  }
+}

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

@@ -0,0 +1,129 @@
+import type { CosmiconfigResult, PublicExplorer, Config } from "cosmiconfig";
+import type { StormConfigInput } from "@storm-software/config";
+import { join } from "node:path";
+import { findWorkspaceRoot } from "../utilities/find-workspace-root";
+import { readFile, stat } from "node:fs/promises";
+
+let _cosmiconfig: any = undefined;
+let defaultExplorer: PublicExplorer | undefined;
+
+/**
+ * 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 const getConfigFileExplorer = async (
+  fileName: string
+): Promise<PublicExplorer | undefined> => {
+  if (!_cosmiconfig) {
+    const mod = await import("cosmiconfig");
+    if (mod?.cosmiconfig) {
+      _cosmiconfig = mod.cosmiconfig;
+    }
+
+    if (!_cosmiconfig) {
+      return undefined;
+    }
+  }
+
+  return _cosmiconfig(fileName, { cache: true });
+};
+
+/**
+ * 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 const getConfigFileByName = async (
+  fileName: string,
+  filePath?: string
+): Promise<CosmiconfigResult | undefined> => {
+  return (await getConfigFileExplorer(fileName))?.search(filePath);
+};
+
+/**
+ * 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 const getJsonConfigFile = async (
+  fileName: string,
+  filePath?: string
+): Promise<CosmiconfigResult | undefined> => {
+  // const fse = await import("fs-extra/esm");
+
+  const jsonPath = join(
+    filePath ?? process.cwd(),
+    fileName.endsWith(".json") ? fileName : `${fileName}.json`
+  );
+  const isEmpty = !!(await stat(jsonPath).catch((_) => false));
+
+  return isEmpty
+    ? {
+        config: JSON.parse(await readFile(jsonPath, "utf-8")),
+        filepath: jsonPath,
+        isEmpty
+      }
+    : { config: {} as Config, filepath: jsonPath, isEmpty };
+};
+
+/**
+ * Get the config file for the current Storm workspace
+ *
+ * @returns The config file for the current Storm workspace
+ */
+export const getConfigFile = async (
+  filePath?: string,
+  additionalFileNames: string[] = []
+): Promise<Partial<StormConfigInput> | undefined> => {
+  const workspacePath = filePath ? filePath : findWorkspaceRoot(filePath);
+
+  // let cosmiconfigResult = await getJsonConfigFile("storm", workspacePath);
+  // if (!cosmiconfigResult || cosmiconfigResult.isEmpty) {
+  if (!defaultExplorer) {
+    defaultExplorer = await getConfigFileExplorer("storm");
+  }
+
+  let cosmiconfigResult: any = null;
+  if (defaultExplorer) {
+    cosmiconfigResult = await defaultExplorer.search(workspacePath);
+  }
+
+  if ((!cosmiconfigResult || cosmiconfigResult.isEmpty) && additionalFileNames.length > 0) {
+    for (const additionalFileName of additionalFileNames) {
+      cosmiconfigResult = await getJsonConfigFile(additionalFileName, workspacePath);
+      if (cosmiconfigResult && !cosmiconfigResult.isEmpty) {
+        break;
+      }
+
+      cosmiconfigResult = await getConfigFileByName(additionalFileName, workspacePath);
+      if (cosmiconfigResult && !cosmiconfigResult.isEmpty) {
+        break;
+      }
+    }
+  }
+  // }
+
+  if (
+    !cosmiconfigResult ||
+    Object.keys(cosmiconfigResult).length === 0 ||
+    cosmiconfigResult.isEmpty ||
+    !cosmiconfigResult.filepath
+  ) {
+    return undefined;
+  }
+
+  const config: Partial<StormConfigInput> = cosmiconfigResult.config ?? {};
+  if (cosmiconfigResult.filepath) {
+    config.configFile = cosmiconfigResult.filepath;
+  }
+  config.runtimeVersion = "0.0.1";
+
+  return config;
+};

package/src/config-file/index.ts

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

package/src/create-storm-config.ts

@@ -0,0 +1,129 @@
+import type { ZodTypeAny } from "zod";
+import { getConfigFile } from "./config-file/get-config-file";
+import { getConfigEnv, getExtensionEnv } from "./env/get-env";
+import { setConfigEnv } from "./env/set-env";
+import type { StormConfig } from "@storm-software/config";
+import { StormConfigSchema } from "@storm-software/config/schema";
+import { findWorkspaceRoot, writeWarning } from "./utilities";
+import { getDefaultConfig } from "./utilities/get-default-config";
+
+const _extension_cache = new WeakMap<{ extensionName: string }, any>();
+let _static_cache: StormConfig | undefined = undefined;
+
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace
+ */
+export const createConfig = (workspaceRoot?: string): StormConfig => {
+  return createStormConfig(undefined, undefined, workspaceRoot);
+};
+
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace
+ */
+export const createStormConfig = <
+  TExtensionName extends keyof StormConfig["extensions"] = keyof StormConfig["extensions"],
+  TExtensionConfig = any,
+  TExtensionSchema extends ZodTypeAny = ZodTypeAny
+>(
+  extensionName?: TExtensionName,
+  schema?: TExtensionSchema,
+  workspaceRoot?: string
+): StormConfig<TExtensionName, TExtensionConfig> => {
+  let result!: StormConfig<TExtensionName, TExtensionConfig>;
+  if (!_static_cache) {
+    const config = getConfigEnv() as StormConfig & {
+      [extensionName in TExtensionName]: TExtensionConfig;
+    };
+    const defaultConfig = getDefaultConfig(config, workspaceRoot);
+
+    result = StormConfigSchema.parse({
+      ...defaultConfig,
+      ...config,
+      colors: {
+        ...defaultConfig?.colors,
+        ...config.colors
+      }
+    }) as StormConfig<TExtensionName, TExtensionConfig>;
+  } else {
+    result = _static_cache as StormConfig<TExtensionName, TExtensionConfig>;
+  }
+
+  if (schema && extensionName) {
+    result.extensions = {
+      ...result.extensions,
+      [extensionName]: createConfigExtension<TExtensionName, TExtensionConfig, TExtensionSchema>(
+        extensionName,
+        schema
+      )
+    };
+  }
+
+  _static_cache = result;
+  return result;
+};
+
+/**
+ * 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 const createConfigExtension = <
+  TExtensionName extends keyof StormConfig["extensions"] = keyof StormConfig["extensions"],
+  TExtensionConfig = any,
+  TExtensionSchema extends ZodTypeAny = ZodTypeAny
+>(
+  extensionName: TExtensionName,
+  schema: TExtensionSchema
+): TExtensionConfig => {
+  const extension_cache_key = { extensionName };
+  if (_extension_cache.has(extension_cache_key)) {
+    return _extension_cache.get(extension_cache_key) as TExtensionConfig;
+  }
+
+  let extension = getExtensionEnv(extensionName);
+  if (schema) {
+    extension = schema.parse(extension);
+  }
+
+  _extension_cache.set(extension_cache_key, extension);
+  return extension as TExtensionConfig;
+};
+
+/**
+ * Load the config file values for the current Storm workspace into environment variables
+ */
+export const loadStormConfig = async (workspaceRoot?: string): Promise<StormConfig> => {
+  let config = {} as StormConfig;
+
+  let _workspaceRoot = workspaceRoot;
+  if (!_workspaceRoot) {
+    _workspaceRoot = findWorkspaceRoot();
+  }
+
+  const configFile = await getConfigFile(_workspaceRoot);
+  if (!configFile) {
+    writeWarning(
+      { logLevel: "all" },
+      "No Storm config file found in the current workspace. Please ensure this is the expected behavior - you can add a `storm.config.js` file to the root of your workspace if it is not.\n"
+    );
+  }
+
+  config = StormConfigSchema.parse(
+    await getDefaultConfig(
+      {
+        ...getConfigEnv(),
+        ...configFile
+      } as Partial<StormConfig>,
+      _workspaceRoot
+    )
+  );
+  setConfigEnv(config);
+
+  return config;
+};

package/src/env/get-env.ts

@@ -0,0 +1,125 @@
+import type { LogLevelLabel } from "../types";
+import type { StormConfig } from "@storm-software/config";
+import { getLogLevelLabel } from "../utilities";
+import type { DeepPartial } from "../../declarations.d";
+import { correctPaths } from "../utilities/correct-paths";
+
+/**
+ * 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 const getExtensionEnv = <TConfig extends Record<string, any> = Record<string, any>>(
+  extensionName: string
+): TConfig | undefined => {
+  const prefix = `STORM_EXTENSION_${extensionName.toUpperCase()}_`;
+  return Object.keys(process.env)
+    .filter((key) => key.startsWith(prefix))
+    .reduce((ret: Record<string, any>, key: string) => {
+      const name = key
+        .replace(prefix, "")
+        .split("_")
+        .map((i) => (i.length > 0 ? i.trim().charAt(0).toUpperCase() + i.trim().slice(1) : ""))
+        .join("");
+      if (name) {
+        ret[name] = process.env[key];
+      }
+
+      return ret;
+    }, {}) as TConfig;
+};
+
+/**
+ * Get the config for the current Storm workspace
+ *
+ * @returns The config for the current Storm workspace from environment variables
+ */
+export const getConfigEnv = (): DeepPartial<StormConfig> => {
+  const prefix = "STORM_";
+
+  let config: DeepPartial<StormConfig> = {
+    extends: process.env[`${prefix}EXTENDS`],
+    name: process.env[`${prefix}NAME`],
+    namespace: process.env[`${prefix}NAMESPACE`],
+    owner: process.env[`${prefix}OWNER`],
+    worker: process.env[`${prefix}WORKER`],
+    organization: process.env[`${prefix}ORGANIZATION`],
+    packageManager: process.env[`${prefix}PACKAGE_MANAGER`] as StormConfig["packageManager"],
+    license: process.env[`${prefix}LICENSE`],
+    homepage: process.env[`${prefix}HOMEPAGE`],
+    timezone: process.env[`${prefix}TIMEZONE`] ?? process.env.TZ,
+    locale: process.env[`${prefix}LOCALE`] ?? process.env.LOCALE,
+    configFile: correctPaths(process.env[`${prefix}CONFIG_FILE`]),
+    workspaceRoot: correctPaths(process.env[`${prefix}WORKSPACE_ROOT`]),
+    packageDirectory: correctPaths(process.env[`${prefix}PACKAGE_DIRECTORY`]),
+    buildDirectory: correctPaths(process.env[`${prefix}BUILD_DIRECTORY`]),
+    skipCache:
+      process.env[`${prefix}SKIP_CACHE`] !== undefined
+        ? Boolean(process.env[`${prefix}SKIP_CACHE`])
+        : undefined,
+    cacheDirectory: correctPaths(process.env[`${prefix}CACHE_DIRECTORY`]),
+    runtimeVersion: process.env[`${prefix}RUNTIME_VERSION`],
+    runtimeDirectory: correctPaths(process.env[`${prefix}RUNTIME_DIRECTORY`]),
+    env: (process.env[`${prefix}ENV`] ??
+      process.env.NODE_ENV ??
+      process.env.ENVIRONMENT) as StormConfig["env"],
+    ci:
+      process.env[`${prefix}CI`] !== undefined
+        ? Boolean(
+            process.env[`${prefix}CI`] ?? process.env.CI ?? process.env.CONTINUOUS_INTEGRATION
+          )
+        : undefined,
+    colors: {
+      primary: process.env[`${prefix}COLOR_PRIMARY`],
+      background: process.env[`${prefix}COLOR_BACKGROUND`],
+      success: process.env[`${prefix}COLOR_SUCCESS`],
+      info: process.env[`${prefix}COLOR_INFO`],
+      warning: process.env[`${prefix}COLOR_WARNING`],
+      error: process.env[`${prefix}COLOR_ERROR`],
+      fatal: process.env[`${prefix}COLOR_FATAL`]
+    },
+    repository: process.env[`${prefix}REPOSITORY`],
+    branch: process.env[`${prefix}BRANCH`],
+    preid: process.env[`${prefix}PRE_ID`],
+    externalPackagePatterns: process.env[`${prefix}EXTERNAL_PACKAGE_PATTERNS`]
+      ? JSON.parse(process.env[`${prefix}EXTERNAL_PACKAGE_PATTERNS`] as string)
+      : [],
+    logLevel:
+      process.env[`${prefix}LOG_LEVEL`] !== null && process.env[`${prefix}LOG_LEVEL`] !== undefined
+        ? process.env[`${prefix}LOG_LEVEL`] &&
+          Number.isSafeInteger(Number.parseInt(process.env[`${prefix}LOG_LEVEL`] as string))
+          ? getLogLevelLabel(Number.parseInt(process.env[`${prefix}LOG_LEVEL`] as string))
+          : (process.env[`${prefix}LOG_LEVEL`] as LogLevelLabel)
+        : undefined
+  };
+
+  const serializedConfig = process.env[`${prefix}CONFIG`];
+  if (serializedConfig) {
+    const parsed = JSON.parse(serializedConfig);
+    config = {
+      ...config,
+      ...parsed,
+      colors: { ...config.colors, ...parsed.colors },
+      extensions: { ...config.extensions, ...parsed.extensions }
+    };
+  }
+
+  return config;
+
+  /*const extensionPrefix = `${prefix}EXTENSION_`;
+  return Object.keys(process.env)
+    .filter((key) => key.startsWith(extensionPrefix))
+    .reduce((ret: StormConfig, key: string) => {
+      const extensionName = key
+        .substring(prefix.length, key.indexOf("_", prefix.length))
+        .split("_")
+        .map((i) => (i.length > 0 ? i.trim().charAt(0).toUpperCase() + i.trim().slice(1) : ""))
+        .join("");
+      if (extensionName) {
+        ret.extensions[extensionName] = getExtensionEnv(extensionName);
+      }
+
+      return ret;
+    }, config);*/
+};

package/src/env/index.ts

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