obsidian-dev-utils 18.4.2 → 19.0.0

package/dist/lib/Object.d.mts

@@ -0,0 +1,211 @@
+/**
+ * @packageDocumentation Object
+ * Contains utility functions for Objects.
+ */
+import type { UndefinedOnPartialDeep } from 'type-fest';
+/**
+ * Specifies how functions should be handled in the JSON output.
+ */
+export declare enum FunctionHandlingMode {
+    /**
+     * Excludes functions from the JSON output.
+     */
+    Exclude = "exclude",
+    /**
+     * Includes the full function definition in the JSON output.
+     */
+    Full = "full",
+    /**
+     * Includes only the function name in the JSON output.
+     */
+    NameOnly = "nameOnly"
+}
+/**
+ * Represents a constructor type for a given class `T` with arguments `Args`.
+ *
+ * @typeParam Type - The type of the instance being constructed.
+ * @typeParam Args - The types of arguments the constructor accepts.
+ */
+export type Constructor<Type, Args extends unknown[] = []> = new (...args: Args) => Type;
+/**
+ * Extracts the keys of a given type `Type` that match a specific value type `Value`.
+ *
+ * @typeParam Type - The type from which to extract the keys.
+ * @typeParam Value - The value type to match against.
+ */
+export type KeysMatching<Type, Value> = {
+    [Key in keyof Type]-?: Type[Key] extends Value ? Key : never;
+}[keyof Type];
+/**
+ * Options for converting an object to JSON.
+ */
+export interface ToJsonOptions {
+    /**
+     * Specifies how functions should be handled in the JSON output (default: `exclude`).
+     */
+    functionHandlingMode: FunctionHandlingMode;
+    /**
+     * Specifies the maximum depth of nested objects to include in the JSON output.
+     * Use `-1` for no limit.
+     * Defaults to `-1`.
+     */
+    maxDepth: number;
+    /**
+     * Specifies whether to catch errors in `toJSON()` and replace them with a placeholder.
+     * Defaults to `false`.
+     */
+    shouldCatchToJSONErrors: boolean;
+    /**
+     * Specifies whether to handle circular references in the JSON output.
+     * Defaults to `false`.
+     */
+    shouldHandleCircularReferences: boolean;
+    /**
+     * Specifies whether to handle errors in the JSON output.
+     * Defaults to `false`.
+     */
+    shouldHandleErrors: boolean;
+    /**
+     * Specifies whether to handle undefined values in the JSON output.
+     * Defaults to `false`.
+     */
+    shouldHandleUndefined: boolean;
+    /**
+     * Specifies whether to sort the keys of the JSON output.
+     * Defaults to `false`.
+     */
+    shouldSortKeys: boolean;
+    /**
+     * Specifies the indentation of the JSON output. This can be a number of spaces or a string. Defaults to `2`.
+     */
+    space: number | string;
+    /**
+     * Specifies the substitutions to use in the JSON output.
+     */
+    tokenSubstitutions: Partial<TokenSubstitutions>;
+}
+interface TokenSubstitutions {
+    circularReference: string;
+    maxDepthLimitReached: string;
+    toJSONFailed: string;
+}
+/**
+ * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
+ *
+ * @param target - The target object to assign properties to.
+ * @param source - The source object to assign properties from.
+ * @returns The target object with the assigned properties.
+ */
+export declare function assignWithNonEnumerableProperties<T extends object, U>(target: T, source: U): T & U;
+/**
+ * @param target - The target object to assign properties to.
+ * @param source1 - The first source object to assign properties from.
+ * @param source2 - The second source object to assign properties from.
+ * @returns The target object with the assigned properties.
+ */
+export declare function assignWithNonEnumerableProperties<T extends object, U, V>(target: T, source1: U, source2: V): T & U & V;
+/**
+ * Assigns properties from one or more source objects to a target object, including non-enumerable properties.
+ *
+ * @param target - The target object to assign properties to.
+ * @param source1 - The first source object to assign properties from.
+ * @param source2 - The second source object to assign properties from.
+ * @param source3 - The third source object to assign properties from.
+ * @returns The target object with the assigned properties.
+ */
+export declare function assignWithNonEnumerableProperties<T extends object, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
+/**
+ * Clones an object, including non-enumerable properties.
+ *
+ * @param obj - The object to clone.
+ * @returns A new object with the same properties as the original object, including non-enumerable properties.
+ */
+export declare function cloneWithNonEnumerableProperties<T extends object>(obj: T): T;
+/**
+ * Compares two values to determine if they are deeply equal.
+ *
+ * @param a - The first value to compare.
+ * @param b - The second value to compare.
+ * @returns `true` if the values are deeply equal, otherwise `false`.
+ */
+export declare function deepEqual(a: unknown, b: unknown): boolean;
+/**
+ * Deletes multiple properties from an object.
+ *
+ * @typeParam T - The type of the object.
+ * @param obj - The object to delete the properties from.
+ * @param propertyNames - The names of the properties to delete.
+ * @returns `true` if any of the properties were present, otherwise `false`.
+ */
+export declare function deleteProperties<T extends object>(obj: T, propertyNames: (keyof T)[]): boolean;
+/**
+ * Deletes a property from an object.
+ *
+ * @typeParam T - The type of the object.
+ * @param obj - The object to delete the property from.
+ * @param propertyName - The name of the property to delete.
+ * @returns `true` if the property was present, otherwise `false`.
+ */
+export declare function deleteProperty<T extends object>(obj: T, propertyName: keyof T): boolean;
+/**
+ * Gets the value of a nested property from an object.
+ *
+ * @param obj - The object to get the nested property value from.
+ * @param path - The path to the nested property.
+ * @returns The value of the nested property.
+ */
+export declare function getNestedPropertyValue(obj: Record<string, unknown>, path: string): unknown;
+/**
+ * Gets the prototype of the specified object.
+ *
+ * @typeParam T - The type of the object.
+ * @param instance - The object instance to retrieve the prototype of.
+ * @returns The prototype of the object.
+ */
+export declare function getPrototypeOf<T>(instance: T): T;
+/**
+ * Retrieves the name of a property of a given type `T`.
+ *
+ * @typeParam T - The type of the object containing the property.
+ * @param name - The name of the property as a string.
+ * @returns The name of the property.
+ */
+export declare function nameof<T>(name: Extract<keyof T, string>): string;
+/**
+ * Normalizes optional properties to allow `undefined` assignment in strict mode.
+ *
+ * This utility provides a workaround for the `exactOptionalPropertyTypes` TypeScript flag,
+ * which prohibits directly assigning `undefined` to optional properties when the type
+ * explicitly omits `undefined`.
+ *
+ * Example:
+ * ```typescript
+ * // With `exactOptionalPropertyTypes: true`
+ * const x: { prop?: string } = { prop: undefined }; // Compiler error
+ *
+ * // Using this utility:
+ * const y: { prop?: string } = normalizeOptionalProperties<{ prop?: string }>({ prop: undefined }); // Works
+ * ```
+ *
+ * @typeParam T - The target type with optional properties to normalize.
+ * @param obj - The object to normalize, allowing explicit `undefined` for optional properties.
+ * @returns The normalized object, compatible with `exactOptionalPropertyTypes`.
+ */
+export declare function normalizeOptionalProperties<T>(obj: UndefinedOnPartialDeep<T>): T;
+/**
+ * Sets the value of a nested property in an object.
+ *
+ * @param obj - The object to set the nested property value in.
+ * @param path - The path to the nested property.
+ * @param value - The value to set.
+ */
+export declare function setNestedPropertyValue(obj: Record<string, unknown>, path: string, value: unknown): void;
+/**
+ * Converts a given value to a JSON string.
+ *
+ * @param value - The value to be converted to JSON. This can be of any type.
+ * @param options - Options for customizing the JSON conversion process.
+ * @returns The JSON string representation of the input value.
+ */
+export declare function toJson(value: unknown, options?: Partial<ToJsonOptions>): string;
+export {};

package/dist/lib/Path.d.mts

@@ -0,0 +1,133 @@
+/**
+ * @packageDocumentation Path
+ * Contains utility functions for handling paths.
+ */
+import pathBrowserify from 'path-browserify';
+/**
+ * Provides methods for handling POSIX paths.
+ */
+export declare const posix: pathBrowserify.Path;
+/**
+ * The POSIX path delimiter.
+ */
+export declare const delimiter: string;
+/**
+ * The POSIX segment separator.
+ */
+export declare const sep: string;
+/**
+ * Returns the base name of a file, optionally removing the file extension.
+ *
+ * @param path - The path to get the base name from.
+ * @param ext - An optional extension to remove from the base name.
+ * @returns The base name of the file.
+ */
+export declare const basename: (this: void, path: string, ext?: string) => string;
+/**
+ * Returns the directory name of a path.
+ *
+ * @param path - The path to get the directory name from.
+ * @returns The directory name of the path.
+ */
+export declare const dirname: (this: void, path: string) => string;
+/**
+ * Returns the file extension of a path.
+ *
+ * @param path - The path to get the extension from.
+ * @returns The file extension of the path.
+ */
+export declare const extname: (this: void, path: string) => string;
+/**
+ * Formats a path object into a path string.
+ *
+ * @param pathObject - The path object to format.
+ * @returns The formatted path string.
+ */
+export declare const format: (this: void, pathObject: Partial<pathBrowserify.PathObject>) => string;
+/**
+ * Determines if a path is absolute.
+ *
+ * @param path - The path to check.
+ * @returns `true` if the path is absolute, `false` otherwise.
+ */
+export declare function isAbsolute(path: string): boolean;
+/**
+ * Joins multiple path segments into a single path.
+ *
+ * @param paths - The path segments to join.
+ * @returns The joined path.
+ */
+export declare const join: (this: void, ...paths: string[]) => string;
+/**
+ * Normalizes a path, resolving '..' and '.' segments.
+ *
+ * @param path - The path to normalize.
+ * @returns The normalized path.
+ */
+export declare const normalize: (this: void, path: string) => string;
+/**
+ * Parses a path string into a path object.
+ *
+ * @param path - The path string to parse.
+ * @returns The parsed path object.
+ */
+export declare const parse: (this: void, path: string) => pathBrowserify.PathObject;
+/**
+ * Returns the relative path from one path to another.
+ *
+ * @param from - The starting path.
+ * @param to - The destination path.
+ * @returns The relative path from `from` to `to`.
+ */
+export declare const relative: (this: void, from: string, to: string) => string;
+/**
+ * Gets the directory name from the `import(dot)meta(dot)url`, converting it to a POSIX-style path.
+ *
+ * @param importMetaUrl - The `import(dot)meta(dot)url` from which to extract the directory name.
+ * @returns The POSIX-style directory name.
+ */
+export declare function getDirname(importMetaUrl: string): string;
+/**
+ * Gets the filename from the `import(dot)meta(dot)url`, converting it to a POSIX-style path.
+ *
+ * @param importMetaUrl - The `import(dot)meta(dot)url` from which to extract the filename.
+ * @returns The POSIX-style filename.
+ */
+export declare function getFilename(importMetaUrl: string): string;
+/**
+ * Makes a filename by appending an extension to a given filename.
+ * If the extension is empty, the filename is returned as is.
+ *
+ * @param fileName - The filename to append the extension to.
+ * @param extension - The extension to append to the filename.
+ * @returns The filename with the extension appended.
+ */
+export declare function makeFileName(fileName: string, extension: string): string;
+/**
+ * Normalizes a given path by ensuring it is relative, adding "./" if necessary.
+ *
+ * @param path - The path to normalize.
+ * @returns The normalized path, starting with "./" if it was relative.
+ */
+export declare function normalizeIfRelative(path: string): string;
+/**
+ * Resolves a sequence of paths or path segments into an absolute path.
+ *
+ * @param pathSegments - The sequence of path segments to resolve.
+ * @returns The resolved absolute path.
+ */
+export declare function resolve(...pathSegments: string[]): string;
+/**
+ * Converts a buffer containing a path to a POSIX-style buffer by replacing backslashes with forward slashes.
+ *
+ * @param buffer - The buffer to convert.
+ * @returns A new buffer containing the POSIX-style path.
+ */
+export declare function toPosixBuffer(buffer: Buffer): Buffer;
+/**
+ * Converts a given path to a POSIX-style path by replacing backslashes with forward slashes.
+ *
+ * @param path - The path to convert.
+ * @returns The POSIX-style path.
+ */
+export declare function toPosixPath(path: string): string;

package/dist/lib/RegExp.d.mts

@@ -0,0 +1,18 @@
+/**
+ * @packageDocumentation RegExp
+ * Contains utility functions for regular expressions.
+ */
+/**
+ * Escapes special characters in a string to safely use it within a regular expression.
+ *
+ * @param str - The string to escape.
+ * @returns The escaped string with special characters prefixed with a backslash.
+ */
+export declare function escapeRegExp(str: string): string;
+/**
+ * Checks if a string is a valid regular expression.
+ *
+ * @param str - The string to check.
+ * @returns `true` if the string is a valid regular expression, `false` otherwise.
+ */
+export declare function isValidRegExp(str: string): boolean;

package/dist/lib/ScriptUtils/CliUtils.cjs

@@ -0,0 +1,161 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+(function initCjs(){const globalThisRecord=globalThis;globalThisRecord["__name"]??=name;const originalRequire=require;if(originalRequire&&!originalRequire.__isPatched){require=Object.assign(id=>requirePatched(id),originalRequire,{__isPatched:true})}const newFuncs={__extractDefault:__name(()=>extractDefault,"__extractDefault"),process:__name(()=>{const browserProcess={browser:true,cwd:__name(()=>"/","cwd"),env:{},platform:"android"};return browserProcess},"process")};for(const key of Object.keys(newFuncs)){globalThisRecord[key]??=newFuncs[key]?.()}function name(obj){return obj}__name(name,"name");function extractDefault(module){return module&&module.__esModule&&module.default?module.default:module}__name(extractDefault,"extractDefault");function requirePatched(id){const module=originalRequire?.(id);if(module){return extractDefault(module)}if(id==="process"||id==="node:process"){console.error(`Module not found: ${id}. Fake process object is returned instead.`);return globalThis.process}console.error(`Module not found: ${id}. Empty object is returned instead.`);return{}}__name(requirePatched,"requirePatched")})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var CliUtils_exports = {};
+__export(CliUtils_exports, {
+  CliTaskResult: () => CliTaskResult,
+  toCommandLine: () => toCommandLine,
+  wrapCliTask: () => wrapCliTask
+});
+module.exports = __toCommonJS(CliUtils_exports);
+var import_Debug = require('../Debug.cjs');
+var import_Error = require('../Error.cjs');
+var import_Function = require('../Function.cjs');
+var import_String = require('../String.cjs');
+var import_NodeModules = require('./NodeModules.cjs');
+class CliTaskResult {
+  /**
+   * Chains multiple tasks together, executing them sequentially until one fails.
+   *
+   * @param tasks - An array of task functions that return a `TaskResult` or `void`.
+   * @returns A promise that resolves with the first failed `TaskResult` or a success result.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+  static async chain(tasks) {
+    for (const task of tasks) {
+      const result = await wrapResult(task);
+      if (!result.isSuccessful()) {
+        return result;
+      }
+    }
+    return CliTaskResult.Success();
+  }
+  /**
+   * Creates a `TaskResult` that does not exit the process.
+   *
+   * @returns A `TaskResult` that does not exit the process.
+   */
+  static DoNotExit() {
+    return new DoNotExitTaskResult();
+  }
+  /**
+   * Represents a failure result of a CLI task.
+   *
+   * @returns The failure result.
+   */
+  static Failure() {
+    return this.Success(false);
+  }
+  /**
+   * Creates a `TaskResult` based on an exit code.
+   *
+   * @param exitCode - The exit code to represent.
+   * @returns A `TaskResult` representing the exit code.
+   */
+  static FromExitCode(exitCode) {
+    return new ExitCodeTaskResult(exitCode);
+  }
+  /**
+   * Creates a CliTaskResult representing a successful task result.
+   *
+   * @param isSuccess - A boolean indicating whether the task was successful. Default is true.
+   * @returns A CliTaskResult object representing a successful task result.
+   */
+  static Success(isSuccess = true) {
+    return new SuccessTaskResult(isSuccess);
+  }
+}
+class DoNotExitTaskResult extends CliTaskResult {
+  /**
+   * Does not exit the process.
+   */
+  exit() {
+    (0, import_Function.noop)();
+  }
+  isSuccessful() {
+    return true;
+  }
+}
+class ExitCodeTaskResult extends CliTaskResult {
+  constructor(exitCode) {
+    super();
+    this.exitCode = exitCode;
+  }
+  /**
+   * Exits the process with the specified exit code.
+   */
+  exit() {
+    import_NodeModules.process.exit(this.exitCode);
+  }
+  isSuccessful() {
+    return this.exitCode === 0;
+  }
+}
+class SuccessTaskResult extends CliTaskResult {
+  constructor(_isSuccessful) {
+    super();
+    this._isSuccessful = _isSuccessful;
+  }
+  /**
+   * Exits the process based on the success of the task.
+   */
+  exit() {
+    import_NodeModules.process.exit(this._isSuccessful ? 0 : 1);
+  }
+  isSuccessful() {
+    return this._isSuccessful;
+  }
+}
+function toCommandLine(args) {
+  return args.map((arg) => {
+    if (/[\s"\n]/.test(arg)) {
+      let escapedArg = arg;
+      escapedArg = (0, import_String.replaceAll)(escapedArg, /"/g, '\\"');
+      escapedArg = (0, import_String.replaceAll)(escapedArg, /\n/g, "\\n");
+      return `"${escapedArg}"`;
+    }
+    return arg;
+  }).join(" ");
+}
+async function wrapCliTask(taskFn) {
+  (0, import_Debug.enableLibraryDebuggers)();
+  const result = await wrapResult(taskFn);
+  result.exit();
+}
+async function wrapResult(taskFn) {
+  try {
+    return await taskFn() ?? CliTaskResult.Success();
+  } catch (error) {
+    (0, import_Error.printError)(new Error("An error occurred during task execution", { cause: error }));
+    return CliTaskResult.Failure();
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CliTaskResult,
+  toCommandLine,
+  wrapCliTask
+});
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../src/ScriptUtils/CliUtils.ts"],
  "sourcesContent": ["/**\n * @packageDocumentation cli\n * Contains utility classes and functions for managing task results, including\n * success, exit codes, and chaining multiple tasks.\n */\n\nimport type { MaybePromise } from '../Async.ts';\n\nimport { enableLibraryDebuggers } from '../Debug.ts';\nimport { printError } from '../Error.ts';\nimport { noop } from '../Function.ts';\nimport { replaceAll } from '../String.ts';\nimport { process } from './NodeModules.ts';\n\n/**\n * Abstract class representing the result of a task. Includes methods for handling success,\n * exit codes, and chaining tasks.\n */\nexport abstract class CliTaskResult {\n  /**\n   * Chains multiple tasks together, executing them sequentially until one fails.\n   *\n   * @param tasks - An array of task functions that return a `TaskResult` or `void`.\n   * @returns A promise that resolves with the first failed `TaskResult` or a success result.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-invalid-void-type\n  public static async chain(tasks: (() => MaybePromise<CliTaskResult | void>)[]): Promise<CliTaskResult> {\n    for (const task of tasks) {\n      const result = await wrapResult(task);\n      if (!result.isSuccessful()) {\n        return result;\n      }\n    }\n\n    return CliTaskResult.Success();\n  }\n\n  /**\n   * Creates a `TaskResult` that does not exit the process.\n   *\n   * @returns A `TaskResult` that does not exit the process.\n   */\n  public static DoNotExit(): CliTaskResult {\n    return new DoNotExitTaskResult();\n  }\n\n  /**\n   * Represents a failure result of a CLI task.\n   *\n   * @returns The failure result.\n   */\n  public static Failure(): CliTaskResult {\n    return this.Success(false);\n  }\n\n  /**\n   * Creates a `TaskResult` based on an exit code.\n   *\n   * @param exitCode - The exit code to represent.\n   * @returns A `TaskResult` representing the exit code.\n   */\n  public static FromExitCode(exitCode: number): CliTaskResult {\n    return new ExitCodeTaskResult(exitCode);\n  }\n\n  /**\n   * Creates a CliTaskResult representing a successful task result.\n   *\n   * @param isSuccess - A boolean indicating whether the task was successful. Default is true.\n   * @returns A CliTaskResult object representing a successful task result.\n   */\n  public static Success(isSuccess = true): CliTaskResult {\n    return new SuccessTaskResult(isSuccess);\n  }\n\n  /**\n   * Exits the process based on the task result.\n   */\n  public abstract exit(): void;\n\n  /**\n   * Determines if the task was successful.\n   *\n   * @returns `true` if the task was successful, otherwise `false`.\n   */\n  protected abstract isSuccessful(): boolean;\n}\n\n/**\n * Represents a task result that does not exit the process.\n */\nclass DoNotExitTaskResult extends CliTaskResult {\n  /**\n   * Does not exit the process.\n   */\n  public override exit(): void {\n    noop();\n  }\n\n  protected override isSuccessful(): boolean {\n    return true;\n  }\n}\n\n/**\n * Represents a task result based on an exit code.\n */\nclass ExitCodeTaskResult extends CliTaskResult {\n  public constructor(private readonly exitCode: number) {\n    super();\n  }\n\n  /**\n   * Exits the process with the specified exit code.\n   */\n  public override exit(): void {\n    process.exit(this.exitCode);\n  }\n\n  protected override isSuccessful(): boolean {\n    return this.exitCode === 0;\n  }\n}\n\n/**\n * Represents a task result based on success or failure.\n */\nclass SuccessTaskResult extends CliTaskResult {\n  public constructor(private readonly _isSuccessful: boolean) {\n    super();\n  }\n\n  /**\n   * Exits the process based on the success of the task.\n   */\n  public override exit(): void {\n    process.exit(this._isSuccessful ? 0 : 1);\n  }\n\n  protected override isSuccessful(): boolean {\n    return this._isSuccessful;\n  }\n}\n\n/**\n * Converts an array of command-line arguments into a single command-line string.\n * Handles escaping of special characters such as spaces, quotes, and newlines.\n *\n * @param args - The array of command-line arguments to convert.\n * @returns A string representing the command-line invocation.\n */\nexport function toCommandLine(args: string[]): string {\n  return args\n    .map((arg) => {\n      if (/[\\s\"\\n]/.test(arg)) {\n        let escapedArg = arg;\n        escapedArg = replaceAll(escapedArg, /\"/g, '\\\\\"');\n        escapedArg = replaceAll(escapedArg, /\\n/g, '\\\\n');\n        return `\"${escapedArg}\"`;\n      }\n      return arg;\n    })\n    .join(' ');\n}\n\n/**\n * Wraps a CLI task function to ensure it runs safely and handles its `TaskResult`.\n *\n * @param taskFn - The task function to execute, which may return a `TaskResult` or void.\n * @returns A promise that resolves when the task is completed and exits with the appropriate status.\n */\n// eslint-disable-next-line @typescript-eslint/no-invalid-void-type\nexport async function wrapCliTask(taskFn: () => MaybePromise<CliTaskResult | void>): Promise<void> {\n  enableLibraryDebuggers();\n  const result = await wrapResult(taskFn);\n  result.exit();\n}\n\n/**\n * Safely executes a task function and returns a `TaskResult`. If the task function throws an error,\n * the error is caught, and a failure `TaskResult` is returned.\n *\n * @param taskFn - The task function to execute.\n * @returns A promise that resolves with a `TaskResult` representing the outcome of the task.\n */\n// eslint-disable-next-line @typescript-eslint/no-invalid-void-type\nasync function wrapResult(taskFn: () => MaybePromise<CliTaskResult | void>): Promise<CliTaskResult> {\n  try {\n    return await taskFn() as CliTaskResult | undefined ?? CliTaskResult.Success();\n  } catch (error) {\n    printError(new Error('An error occurred during task execution', { cause: error }));\n    return CliTaskResult.Failure();\n  }\n}\n"],
  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAQA,mBAAuC;AACvC,mBAA2B;AAC3B,sBAAqB;AACrB,oBAA2B;AAC3B,yBAAwB;AAMjB,MAAe,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQlC,aAAoB,MAAM,OAA6E;AACrG,eAAW,QAAQ,OAAO;AACxB,YAAM,SAAS,MAAM,WAAW,IAAI;AACpC,UAAI,CAAC,OAAO,aAAa,GAAG;AAC1B,eAAO;AAAA,MACT;AAAA,IACF;AAEA,WAAO,cAAc,QAAQ;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAc,YAA2B;AACvC,WAAO,IAAI,oBAAoB;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAc,UAAyB;AACrC,WAAO,KAAK,QAAQ,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAc,aAAa,UAAiC;AAC1D,WAAO,IAAI,mBAAmB,QAAQ;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,OAAc,QAAQ,YAAY,MAAqB;AACrD,WAAO,IAAI,kBAAkB,SAAS;AAAA,EACxC;AAaF;AAKA,MAAM,4BAA4B,cAAc;AAAA;AAAA;AAAA;AAAA,EAI9B,OAAa;AAC3B,8BAAK;AAAA,EACP;AAAA,EAEmB,eAAwB;AACzC,WAAO;AAAA,EACT;AACF;AAKA,MAAM,2BAA2B,cAAc;AAAA,EACtC,YAA6B,UAAkB;AACpD,UAAM;AAD4B;AAAA,EAEpC;AAAA;AAAA;AAAA;AAAA,EAKgB,OAAa;AAC3B,+BAAQ,KAAK,KAAK,QAAQ;AAAA,EAC5B;AAAA,EAEmB,eAAwB;AACzC,WAAO,KAAK,aAAa;AAAA,EAC3B;AACF;AAKA,MAAM,0BAA0B,cAAc;AAAA,EACrC,YAA6B,eAAwB;AAC1D,UAAM;AAD4B;AAAA,EAEpC;AAAA;AAAA;AAAA;AAAA,EAKgB,OAAa;AAC3B,+BAAQ,KAAK,KAAK,gBAAgB,IAAI,CAAC;AAAA,EACzC;AAAA,EAEmB,eAAwB;AACzC,WAAO,KAAK;AAAA,EACd;AACF;AASO,SAAS,cAAc,MAAwB;AACpD,SAAO,KACJ,IAAI,CAAC,QAAQ;AACZ,QAAI,UAAU,KAAK,GAAG,GAAG;AACvB,UAAI,aAAa;AACjB,uBAAa,0BAAW,YAAY,MAAM,KAAK;AAC/C,uBAAa,0BAAW,YAAY,OAAO,KAAK;AAChD,aAAO,IAAI,UAAU;AAAA,IACvB;AACA,WAAO;AAAA,EACT,CAAC,EACA,KAAK,GAAG;AACb;AASA,eAAsB,YAAY,QAAiE;AACjG,2CAAuB;AACvB,QAAM,SAAS,MAAM,WAAW,MAAM;AACtC,SAAO,KAAK;AACd;AAUA,eAAe,WAAW,QAA0E;AAClG,MAAI;AACF,WAAO,MAAM,OAAO,KAAkC,cAAc,QAAQ;AAAA,EAC9E,SAAS,OAAO;AACd,iCAAW,IAAI,MAAM,2CAA2C,EAAE,OAAO,MAAM,CAAC,CAAC;AACjF,WAAO,cAAc,QAAQ;AAAA,EAC/B;AACF;",
  "names": []
}


package/dist/lib/{scripts/CliUtils.d.ts → ScriptUtils/CliUtils.d.cts}

@@ -3,7 +3,7 @@
  * Contains utility classes and functions for managing task results, including
  * success, exit codes, and chaining multiple tasks.
  */
-import type { MaybePromise } from '../Async.ts';
+import type { MaybePromise } from '../Async.cjs';
 /**
  * Abstract class representing the result of a task. Includes methods for handling success,
  * exit codes, and chaining tasks.

package/dist/lib/ScriptUtils/CliUtils.d.mts

@@ -0,0 +1,70 @@
+/**
+ * @packageDocumentation cli
+ * Contains utility classes and functions for managing task results, including
+ * success, exit codes, and chaining multiple tasks.
+ */
+import type { MaybePromise } from '../Async.mjs';
+/**
+ * Abstract class representing the result of a task. Includes methods for handling success,
+ * exit codes, and chaining tasks.
+ */
+export declare abstract class CliTaskResult {
+    /**
+     * Chains multiple tasks together, executing them sequentially until one fails.
+     *
+     * @param tasks - An array of task functions that return a `TaskResult` or `void`.
+     * @returns A promise that resolves with the first failed `TaskResult` or a success result.
+     */
+    static chain(tasks: (() => MaybePromise<CliTaskResult | void>)[]): Promise<CliTaskResult>;
+    /**
+     * Creates a `TaskResult` that does not exit the process.
+     *
+     * @returns A `TaskResult` that does not exit the process.
+     */
+    static DoNotExit(): CliTaskResult;
+    /**
+     * Represents a failure result of a CLI task.
+     *
+     * @returns The failure result.
+     */
+    static Failure(): CliTaskResult;
+    /**
+     * Creates a `TaskResult` based on an exit code.
+     *
+     * @param exitCode - The exit code to represent.
+     * @returns A `TaskResult` representing the exit code.
+     */
+    static FromExitCode(exitCode: number): CliTaskResult;
+    /**
+     * Creates a CliTaskResult representing a successful task result.
+     *
+     * @param isSuccess - A boolean indicating whether the task was successful. Default is true.
+     * @returns A CliTaskResult object representing a successful task result.
+     */
+    static Success(isSuccess?: boolean): CliTaskResult;
+    /**
+     * Exits the process based on the task result.
+     */
+    abstract exit(): void;
+    /**
+     * Determines if the task was successful.
+     *
+     * @returns `true` if the task was successful, otherwise `false`.
+     */
+    protected abstract isSuccessful(): boolean;
+}
+/**
+ * Converts an array of command-line arguments into a single command-line string.
+ * Handles escaping of special characters such as spaces, quotes, and newlines.
+ *
+ * @param args - The array of command-line arguments to convert.
+ * @returns A string representing the command-line invocation.
+ */
+export declare function toCommandLine(args: string[]): string;
+/**
+ * Wraps a CLI task function to ensure it runs safely and handles its `TaskResult`.
+ *
+ * @param taskFn - The task function to execute, which may return a `TaskResult` or void.
+ * @returns A promise that resolves when the task is completed and exits with the appropriate status.
+ */
+export declare function wrapCliTask(taskFn: () => MaybePromise<CliTaskResult | void>): Promise<void>;