@storm-software/config-tools 1.190.120 → 1.190.121

package/dist/utilities/toml.d.mts

@@ -0,0 +1,192 @@
+import __tsdown_shims_path from 'node:path';
+import __tsdown_shims_url from 'node:url';
+//#region src/utilities/toml.d.ts
+interface CargoToml {
+  workspace?: {
+    members: string[];
+  };
+  package: any;
+  dependencies?: Record<string, string | {
+    version: string;
+    features?: string[];
+    optional?: boolean;
+  }>;
+  "dev-dependencies"?: Record<string, string | {
+    version: string;
+    features: string[];
+  }>;
+  [key: string]: any;
+}
+interface CargoMetadata {
+  packages: Package[];
+  workspace_members: string[];
+  resolve: Resolve;
+  target_directory: string;
+  version: number;
+  workspace_root: string;
+  metadata: Metadata2;
+}
+interface Package {
+  name: string;
+  version: string;
+  id: string;
+  license: string;
+  license_file: string;
+  description: string;
+  source: any;
+  dependencies: Dependency[];
+  targets: Target[];
+  features: Features;
+  manifest_path: string;
+  metadata: Metadata;
+  /**
+   * From the docs:
+   * "List of registries to which this package may be published.
+   * Publishing is unrestricted if null, and forbidden if an empty array."
+   *
+   * Additional observation:
+   * false can be used by the end user but it will be converted to an empty
+   * array in the cargo metadata output.
+   */
+  publish?: string[] | boolean | null;
+  authors: string[];
+  categories: string[];
+  default_run: any;
+  rust_version: string;
+  keywords: string[];
+  readme: string;
+  repository: string;
+  homepage: string;
+  documentation: string;
+  edition: string;
+  links: any;
+}
+interface Dependency {
+  name: string;
+  source: string;
+  req: string;
+  kind: any;
+  rename: any;
+  optional: boolean;
+  uses_default_features: boolean;
+  features: any[];
+  target: string;
+  path: string;
+  registry: any;
+  workspace: boolean;
+}
+interface Target {
+  kind: string[];
+  crate_types: string[];
+  name: string;
+  src_path: string;
+  edition: string;
+  "required-features": string[];
+  doc: boolean;
+  doctest: boolean;
+  test: boolean;
+}
+interface Features {
+  default: string[];
+  feat1: any[];
+  feat2: any[];
+}
+interface Metadata {
+  docs: Docs;
+}
+interface Docs {
+  rs: Rs;
+}
+interface Rs {
+  "all-features": boolean;
+}
+interface Resolve {
+  nodes: Node[];
+  root: string;
+}
+interface Node {
+  id: string;
+  dependencies: string[];
+  deps: Dep[];
+  features: string[];
+}
+interface Dep {
+  name: string;
+  pkg: string;
+  dep_kinds: DepKind[];
+}
+interface DepKind {
+  kind: any;
+  target: string;
+}
+interface Metadata2 {
+  docs: Docs2;
+}
+interface Docs2 {
+  rs: Rs2;
+}
+interface Rs2 {
+  "all-features": boolean;
+}
+/**
+ * Virtual file system tree.
+ */
+interface Tree {
+  /**
+   * Root of the workspace. All paths are relative to this.
+   */
+  root: string;
+  /**
+   * Read the contents of a file.
+   * @param filePath A path to a file.
+   */
+  read(filePath: string): Buffer | null;
+  /**
+   * Read the contents of a file as string.
+   * @param filePath A path to a file.
+   * @param encoding the encoding for the result
+   */
+  read(filePath: string, encoding: BufferEncoding): string | null;
+  /**
+   * Update the contents of a file or create a new file.
+   */
+  write(filePath: string, content: Buffer | string, options?: any): void;
+  /**
+   * Check if a file exists.
+   */
+  exists(filePath: string): boolean;
+  /**
+   * Delete the file.
+   */
+  delete(filePath: string): void;
+  /**
+   * Rename the file or the folder.
+   */
+  rename(from: string, to: string): void;
+  /**
+   * Check if this is a file or not.
+   */
+  isFile(filePath: string): boolean;
+  /**
+   * Returns the list of children of a folder.
+   */
+  children(dirPath: string): string[];
+  /**
+   * Returns the list of currently recorded changes.
+   */
+  listChanges(): any[];
+  /**
+   * Changes permissions of a file.
+   * @param filePath A path to a file.
+   * @param mode The permission to be granted on the file, given as a string (e.g `755`) or octal integer (e.g `0o755`).
+   * See https://nodejs.org/api/fs.html#fs_file_modes.
+   */
+  changePermissions(filePath: string, mode: string): void;
+}
+declare function parseCargoTomlWithTree(tree: Tree, projectRoot: string, projectName: string): CargoToml;
+declare function parseCargoToml(cargoString?: string): CargoToml;
+declare function stringifyCargoToml(cargoToml: CargoToml): string;
+declare function modifyCargoTable(toml: CargoToml, section: string, key: string, value: string | object | any[] | (() => any)): void;
+declare function modifyCargoNestedTable(toml: CargoToml, section: string, key: string, value: object): void;
+//#endregion
+export { CargoMetadata, CargoToml, Dep, DepKind, Dependency, Docs, Docs2, Features, Metadata, Metadata2, Node, Package, Resolve, Rs, Rs2, Target, Tree, modifyCargoNestedTable, modifyCargoTable, parseCargoToml, parseCargoTomlWithTree, stringifyCargoToml };

package/dist/utilities/toml.mjs

@@ -0,0 +1,33 @@
+import "node:path";
+import "node:url";
+import.meta.url;
+import { writeError } from "../logger/console.mjs";
+import TOML from "@ltd/j-toml";
+//#region src/utilities/toml.ts
+function parseCargoTomlWithTree(tree, projectRoot, projectName) {
+	const cargoTomlString = tree.read(`${projectRoot}/Cargo.toml`)?.toString();
+	if (!cargoTomlString) {
+		writeError(`Cannot find a Cargo.toml file in the ${projectName}`);
+		throw new Error();
+	}
+	return parseCargoToml(cargoTomlString);
+}
+function parseCargoToml(cargoString) {
+	if (!cargoString) throw new Error("Cargo.toml is empty");
+	return TOML.parse(cargoString, { x: { comment: true } });
+}
+function stringifyCargoToml(cargoToml) {
+	const tomlString = TOML.stringify(cargoToml, { newlineAround: "section" });
+	if (Array.isArray(tomlString)) return tomlString.join("\n");
+	return tomlString;
+}
+function modifyCargoTable(toml, section, key, value) {
+	toml[section] ??= TOML.Section({});
+	toml[section][key] = typeof value === "object" && !Array.isArray(value) ? TOML.inline(value) : typeof value === "function" ? value() : value;
+}
+function modifyCargoNestedTable(toml, section, key, value) {
+	toml[section] ??= {};
+	toml[section][key] = TOML.Section(value);
+}
+//#endregion
+export { modifyCargoNestedTable, modifyCargoTable, parseCargoToml, parseCargoTomlWithTree, stringifyCargoToml };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/config-tools",
-  "version": "1.190.120",
+  "version": "1.190.121",
   "private": false,
   "description": "A package containing various utilities to support custom workspace configurations and environment management for Storm Software projects, including configuration file handling, environment variable management, and logging utilities.",
   "keywords": [
@@ -41,178 +41,126 @@
   "sideEffects": false,
   "type": "module",
   "exports": {
-    "./package.json": "./package.json",
-    "./types": {
-      "import": { "types": "./dist/types.d.ts", "default": "./dist/types.js" },
-      "require": {
-        "types": "./dist/types.d.cts",
-        "default": "./dist/types.cjs"
-      },
-      "default": { "types": "./dist/types.d.ts", "default": "./dist/types.js" }
-    },
-    "./index": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      },
-      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
-    },
-    ".": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      },
-      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
+    ".": { "import": "./dist/index.mjs", "require": "./dist/index.cjs" },
+    "./config-file": {
+      "import": "./dist/config-file/index.mjs",
+      "require": "./dist/config-file/index.cjs"
+    },
+    "./config-file/get-config-file": {
+      "import": "./dist/config-file/get-config-file.mjs",
+      "require": "./dist/config-file/get-config-file.cjs"
     },
     "./create-storm-config": {
-      "import": {
-        "types": "./dist/create-storm-config.d.ts",
-        "default": "./dist/create-storm-config.js"
-      },
-      "require": {
-        "types": "./dist/create-storm-config.d.cts",
-        "default": "./dist/create-storm-config.cjs"
-      },
-      "default": {
-        "types": "./dist/create-storm-config.d.ts",
-        "default": "./dist/create-storm-config.js"
-      }
+      "import": "./dist/create-storm-config.mjs",
+      "require": "./dist/create-storm-config.cjs"
     },
-    "./get-config": {
-      "import": {
-        "types": "./dist/get-config.d.ts",
-        "default": "./dist/get-config.js"
-      },
-      "require": {
-        "types": "./dist/get-config.d.cts",
-        "default": "./dist/get-config.cjs"
-      },
-      "default": {
-        "types": "./dist/get-config.d.ts",
-        "default": "./dist/get-config.js"
-      }
+    "./env": {
+      "import": "./dist/env/index.mjs",
+      "require": "./dist/env/index.cjs"
     },
-    "./config-file": {
-      "import": {
-        "types": "./dist/config-file/index.d.ts",
-        "default": "./dist/config-file/index.js"
-      },
-      "require": {
-        "types": "./dist/config-file/index.d.cts",
-        "default": "./dist/config-file/index.cjs"
-      },
-      "default": {
-        "types": "./dist/config-file/index.d.ts",
-        "default": "./dist/config-file/index.js"
-      }
-    },
-    "./config-file/*": {
-      "import": {
-        "types": "./dist/config-file/*.d.ts",
-        "default": "./dist/config-file/*.js"
-      },
-      "require": {
-        "types": "./dist/config-file/*.d.cts",
-        "default": "./dist/config-file/*.cjs"
-      },
-      "default": {
-        "types": "./dist/config-file/*.d.ts",
-        "default": "./dist/config-file/*.js"
-      }
+    "./env/get-env": {
+      "import": "./dist/env/get-env.mjs",
+      "require": "./dist/env/get-env.cjs"
     },
-    "./env": {
-      "import": {
-        "types": "./dist/env/index.d.ts",
-        "default": "./dist/env/index.js"
-      },
-      "require": {
-        "types": "./dist/env/index.d.cts",
-        "default": "./dist/env/index.cjs"
-      },
-      "default": {
-        "types": "./dist/env/index.d.ts",
-        "default": "./dist/env/index.js"
-      }
-    },
-    "./env/*": {
-      "import": { "types": "./dist/env/*.d.ts", "default": "./dist/env/*.js" },
-      "require": {
-        "types": "./dist/env/*.d.cts",
-        "default": "./dist/env/*.cjs"
-      },
-      "default": { "types": "./dist/env/*.d.ts", "default": "./dist/env/*.js" }
+    "./env/set-env": {
+      "import": "./dist/env/set-env.mjs",
+      "require": "./dist/env/set-env.cjs"
+    },
+    "./get-config": {
+      "import": "./dist/get-config.mjs",
+      "require": "./dist/get-config.cjs"
     },
     "./logger": {
-      "import": {
-        "types": "./dist/logger/index.d.ts",
-        "default": "./dist/logger/index.js"
-      },
-      "require": {
-        "types": "./dist/logger/index.d.cts",
-        "default": "./dist/logger/index.cjs"
-      },
-      "default": {
-        "types": "./dist/logger/index.d.ts",
-        "default": "./dist/logger/index.js"
-      }
-    },
-    "./logger/*": {
-      "import": {
-        "types": "./dist/logger/*.d.ts",
-        "default": "./dist/logger/*.js"
-      },
-      "require": {
-        "types": "./dist/logger/*.d.cts",
-        "default": "./dist/logger/*.cjs"
-      },
-      "default": {
-        "types": "./dist/logger/*.d.ts",
-        "default": "./dist/logger/*.js"
-      }
+      "import": "./dist/logger/index.mjs",
+      "require": "./dist/logger/index.cjs"
+    },
+    "./logger/chalk": {
+      "import": "./dist/logger/chalk.mjs",
+      "require": "./dist/logger/chalk.cjs"
+    },
+    "./logger/console": {
+      "import": "./dist/logger/console.mjs",
+      "require": "./dist/logger/console.cjs"
+    },
+    "./logger/console-icons": {
+      "import": "./dist/logger/console-icons.mjs",
+      "require": "./dist/logger/console-icons.cjs"
+    },
+    "./logger/create-logger": {
+      "import": "./dist/logger/create-logger.mjs",
+      "require": "./dist/logger/create-logger.cjs"
+    },
+    "./logger/format-timestamp": {
+      "import": "./dist/logger/format-timestamp.mjs",
+      "require": "./dist/logger/format-timestamp.cjs"
+    },
+    "./logger/get-log-level": {
+      "import": "./dist/logger/get-log-level.mjs",
+      "require": "./dist/logger/get-log-level.cjs"
     },
+    "./logger/is-unicode-supported": {
+      "import": "./dist/logger/is-unicode-supported.mjs",
+      "require": "./dist/logger/is-unicode-supported.cjs"
+    },
+    "./types": { "import": "./dist/types.mjs", "require": "./dist/types.cjs" },
     "./utilities": {
-      "import": {
-        "types": "./dist/utilities/index.d.ts",
-        "default": "./dist/utilities/index.js"
-      },
-      "require": {
-        "types": "./dist/utilities/index.d.cts",
-        "default": "./dist/utilities/index.cjs"
-      },
-      "default": {
-        "types": "./dist/utilities/index.d.ts",
-        "default": "./dist/utilities/index.js"
-      }
-    },
-    "./utilities/*": {
-      "import": {
-        "types": "./dist/utilities/*.d.ts",
-        "default": "./dist/utilities/*.js"
-      },
-      "require": {
-        "types": "./dist/utilities/*.d.cts",
-        "default": "./dist/utilities/*.cjs"
-      },
-      "default": {
-        "types": "./dist/utilities/*.d.ts",
-        "default": "./dist/utilities/*.js"
-      }
-    }
+      "import": "./dist/utilities/index.mjs",
+      "require": "./dist/utilities/index.cjs"
+    },
+    "./utilities/apply-workspace-tokens": {
+      "import": "./dist/utilities/apply-workspace-tokens.mjs",
+      "require": "./dist/utilities/apply-workspace-tokens.cjs"
+    },
+    "./utilities/colors": {
+      "import": "./dist/utilities/colors.mjs",
+      "require": "./dist/utilities/colors.cjs"
+    },
+    "./utilities/correct-paths": {
+      "import": "./dist/utilities/correct-paths.mjs",
+      "require": "./dist/utilities/correct-paths.cjs"
+    },
+    "./utilities/file-path-utils": {
+      "import": "./dist/utilities/file-path-utils.mjs",
+      "require": "./dist/utilities/file-path-utils.cjs"
+    },
+    "./utilities/find-up": {
+      "import": "./dist/utilities/find-up.mjs",
+      "require": "./dist/utilities/find-up.cjs"
+    },
+    "./utilities/find-workspace-root": {
+      "import": "./dist/utilities/find-workspace-root.mjs",
+      "require": "./dist/utilities/find-workspace-root.cjs"
+    },
+    "./utilities/get-default-config": {
+      "import": "./dist/utilities/get-default-config.mjs",
+      "require": "./dist/utilities/get-default-config.cjs"
+    },
+    "./utilities/process-handler": {
+      "import": "./dist/utilities/process-handler.mjs",
+      "require": "./dist/utilities/process-handler.cjs"
+    },
+    "./utilities/run": {
+      "import": "./dist/utilities/run.mjs",
+      "require": "./dist/utilities/run.cjs"
+    },
+    "./utilities/toml": {
+      "import": "./dist/utilities/toml.mjs",
+      "require": "./dist/utilities/toml.cjs"
+    },
+    "./*": "./*"
   },
   "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
   "bin": {
     "storm-config": "./bin/config.cjs",
     "storm-config-cjs": "./bin/config.cjs",
-    "storm-config-esm": "./bin/config.js"
+    "storm-config-esm": "./bin/config.mjs"
   },
   "files": ["dist"],
   "dependencies": {
     "@ltd/j-toml": "1.38.0",
-    "@storm-software/config": "1.138.57",
+    "@storm-software/config": "1.138.58",
     "c12": "^2.0.4",
     "chalk": "^4.1.2",
     "commander": "^12.1.0",
@@ -224,11 +172,11 @@
   },
   "devDependencies": {
     "@types/node": "^25.9.5",
-    "tsup": "8.4.0",
+    "tsdown": "^0.22.14",
     "zod": "^4.4.3"
   },
   "peerDependencies": { "zod": "^3.25.0 || ^4.0.0" },
   "peerDependenciesMeta": { "zod": { "optional": false } },
   "publishConfig": { "access": "public" },
-  "gitHead": "dce519750140dbed032b5cc68e4c35edca8cb846"
+  "gitHead": "427dab3aa828075ceac234260988d77c59cc363e"
 }

package/bin/config.js

@@ -1,108 +0,0 @@
-#!/usr/bin/env node
-import chalk from "chalk";
-import { Command } from "commander";
-import { getConfig } from "../src/get-config";
-import {
-  brandIcon,
-  formatLogMessage,
-  writeError,
-  writeFatal,
-  writeInfo,
-  writeSuccess
-} from "../src/logger/console";
-import {
-  exitWithError,
-  exitWithSuccess,
-  findWorkspaceRootSafe,
-  handleProcess
-} from "../src/utilities";
-function createProgram() {
-  writeInfo(`${brandIcon()} Running Storm Configuration Tools`, {
-    logLevel: "all"
-  });
-  const root = findWorkspaceRootSafe(process.cwd());
-  process.env.STORM_WORKSPACE_ROOT ??= root;
-  process.env.NX_WORKSPACE_ROOT_PATH ??= root;
-  if (root) {
-    process.chdir(root);
-  }
-  const program = new Command("storm-config");
-  program.version("1.0.0", "-v --version", "display CLI version");
-  program.command("view", { isDefault: true }).description("View the current Storm configuration for the workspace.").option(
-    "-d --dir <path>",
-    "A directory that exists inside the workspace root",
-    process.cwd()
-  ).action(viewAction);
-  return program;
-}
-async function viewAction({ dir }) {
-  writeInfo(
-    `\u{1F50D}   Searching for Storm configuration for the workspace at "${dir}"...`,
-    {
-      logLevel: "all"
-    }
-  );
-  const config = await getConfig(findWorkspaceRootSafe(dir), true);
-  if (config) {
-    writeSuccess(
-      `The following Storm configuration values have been found for this repository:
-
-${formatLogMessage({ ...config, colors: void 0 })}
-
-${typeof config.colors.light === "string" ? formatSingleThemeColors(config.colors) : formatMultiThemeColors(config.colors)}
-`,
-      { ...config, logLevel: "all" }
-    );
-  } else {
-    writeError(
-      "No Storm config file found in the current workspace. Please ensure this is the expected behavior - you can add a `storm.json` file to the root of your workspace if it is not.\n",
-      { logLevel: "all" }
-    );
-  }
-}
-void (async () => {
-  try {
-    handleProcess();
-    const program = createProgram();
-    await program.parseAsync(process.argv);
-    exitWithSuccess();
-  } catch (error) {
-    writeFatal(
-      `A fatal error occurred while running the Storm Git tool:
-${error?.message ? error.message : JSON.stringify(error)}${error?.stack ? `
-Stack Trace: ${error.stack}` : ""}`,
-      { logLevel: "all" }
-    );
-    exitWithError();
-    process.exit(1);
-  }
-})();
-const formatSingleThemeColors = (config) => {
-  return `---- Theme Colors ----
-  ${Object.entries(config).filter(
-    ([key, value]) => key !== "gradient" && typeof value === "string" && value.length > 0
-  ).map(
-    ([key, value]) => chalk.hex(String(value))(`${key}: ${chalk.bold(value)}`)
-  ).join(" \n")}
-`;
-};
-const formatMultiThemeColors = (config) => {
-  return ` ---- Light Theme Colors ----
-${Object.entries(config.light).filter(
-    ([key, value]) => key !== "gradient" && typeof value === "string" && value.length > 0
-  ).map(
-    ([key, value]) => chalk.hex(String(value))(`${key}: ${chalk.bold(value)}`)
-  ).join(" \n")}
-
----- Dark Theme Colors ----
-${Object.entries(config.dark).filter(
-    ([key, value]) => key !== "gradient" && typeof value === "string" && value.length > 0
-  ).map(
-    ([key, value]) => chalk.hex(String(value))(`${key}: ${chalk.bold(value)}`)
-  ).join(" \n")}
-  `;
-};
-export {
-  createProgram,
-  viewAction
-};