@shell-shock/core 0.17.21 → 0.17.23

package/dist/plugin-utils/index.d.cts

@@ -1,9 +1,273 @@
-import { computeBin } from "./compute-bin.cjs";
-import { getAppBin, getAppDescription, getAppName, getAppTitle, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases } from "./context-helpers.cjs";
-import { extractReflectionKind, extractType } from "./deepkit.cjs";
-import { FormatDescriptionOptions, FormatShortDescriptionOptions, formatDescription, formatShortDescription } from "./description-helpers.cjs";
-import { getCommandList, getCommandPaths, getCommandSegments, getCommandTree } from "./get-command-tree.cjs";
-import { sortOptions } from "./reflect.cjs";
-import { traverseCommandTree, traverseCommands } from "./traverse-command-tree.cjs";
-import { isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterType } from "./type-checks.cjs";
-export { FormatDescriptionOptions, FormatShortDescriptionOptions, computeBin, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandPaths, getCommandSegments, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterType, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+import { S as CommandTree, _ as CommandOption, b as CommandParameterConfig, d as CommandArgument, r as BaseCommandParameter, x as CommandParameterType, y as CommandParameter } from "../command-CtfR7hKM.cjs";
+import { f as Context, m as UnresolvedContext } from "../config-BIF9mEz0.cjs";
+import "../index-DYOBadKY.cjs";
+import { MaybePromise } from "@stryke/types/base";
+import { ReflectionKind, Type } from "@deepkit/type";
+//#region src/plugin-utils/compute-bin.d.ts
+/**
+ * Computes the command tree for the root binary command based on the provided context.
+ *
+ * @param context - The plugin context containing the necessary information to compute the command tree.
+ * @returns The computed command tree for the root binary command.
+ */
+declare function computeBin(context: Context): CommandTree;
+//#endregion
+//#region src/plugin-utils/context-helpers.d.ts
+/**
+ * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.
+ *
+ * @param aliases - An array of argument aliases to sort.
+ * @returns A new array of sorted aliases.
+ */
+declare function sortArgAliases(aliases: string[]): string[];
+/**
+ * Retrieves the application name from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application name in kebab-case format.
+ * @throws An error if no valid application name is found.
+ */
+declare function getAppName<TContext extends UnresolvedContext | Context>(context: TContext): string;
+/**
+ * Retrieves the application title from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @param replaceCLI - Whether to replace CLI-related terms in the title with the application name.
+ * @returns The application title in title-case format.
+ */
+declare function getAppTitle<TContext extends UnresolvedContext | Context>(context: TContext, replaceCLI?: boolean): string;
+/**
+ * Retrieves the application description from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application description.
+ */
+declare function getAppDescription<TContext extends UnresolvedContext | Context>(context: TContext): string;
+/**
+ * Retrieves the primary binary name for the application.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The primary binary name as a string.
+ */
+declare function getAppBin<TContext extends UnresolvedContext | Context>(context: TContext): string;
+/**
+ * Determines if a given command path segment is variable (enclosed in square brackets).
+ *
+ * @example
+ * ```typescript
+ * isDynamicPathSegment("[user]"); // true
+ * isDynamicPathSegment("user"); // false
+ * ```
+ *
+ * @param path - The command path segment to check.
+ * @returns True if the path is variable, false otherwise.
+ */
+declare function isDynamicPathSegment(path: string): boolean;
+/**
+ * Extracts the variable name from a command path segment by removing enclosing square brackets.
+ *
+ * @example
+ * ```typescript
+ * getDynamicPathSegmentName("[user]"); // "user"
+ * ```
+ *
+ * @param path - The command path segment.
+ * @returns The variable name without square brackets.
+ */
+declare function getDynamicPathSegmentName(path: string): string;
+/**
+ * Determines if a given command path segment is a path segment group (enclosed in parentheses).
+ *
+ * @example
+ * ```typescript
+ * isPathSegmentGroup("(user)"); // true
+ * isPathSegmentGroup("[user]"); // false
+ * isPathSegmentGroup("user"); // false
+ * ```
+ *
+ * @param path - The command path segment to check.
+ * @returns True if the path is a path segment group, false otherwise.
+ */
+declare function isPathSegmentGroup(path: string): boolean;
+/**
+ * Extracts the group name from a command path segment by removing enclosing parentheses.
+ *
+ * @example
+ * ```typescript
+ * getPathSegmentGroupName("(admin)"); // "admin"
+ * getPathSegmentGroupName("((group))"); // "group"
+ * ```
+ *
+ * @param path - The command path segment.
+ * @returns The group name without parentheses.
+ */
+declare function getPathSegmentGroupName(path: string): string;
+/**
+ * Extracts the variable name from a command path segment by removing enclosing square brackets.
+ *
+ * @example
+ * ```typescript
+ * getDynamicPathSegmentName("[user]"); // "user"
+ * ```
+ *
+ * @param path - The command path segment.
+ * @returns The variable name without square brackets.
+ */
+declare function getPathSegmentName(path: string): string;
+//#endregion
+//#region src/plugin-utils/deepkit.d.ts
+/**
+ * Extracts a {@link ReflectionKind} from a {@link BaseCommandParameter} or {@link CommandParameterType}.
+ *
+ * @param command - The command parameter or kind to extract the reflection kind from.
+ * @param checkVariadic - Whether to check for variadic parameters (arrays).
+ * @returns The extracted {@link ReflectionKind}.
+ */
+declare function extractReflectionKind(command: BaseCommandParameter | CommandParameterType, checkVariadic?: boolean): ReflectionKind;
+/**
+ * Extracts a {@link Type} from a {@link BaseCommandParameter} or {@link CommandParameterType}.
+ *
+ * @param command - The command parameter or kind to extract the type from.
+ * @param checkVariadic - Whether to check for variadic parameters (arrays).
+ * @returns The extracted {@link Type}.
+ */
+declare function extractType(command: BaseCommandParameter | CommandParameterType, checkVariadic?: boolean): Type;
+//#endregion
+//#region src/plugin-utils/description-helpers.d.ts
+interface FormatDescriptionOptions {
+  /**
+   * If true, replaces newlines in the description with spaces. This is useful for ensuring that descriptions are displayed as a single line in contexts where multiline descriptions may not be supported or may cause formatting issues.
+   *
+   * @defaultValue false
+   */
+  replaceNewlines?: boolean;
+  /**
+   * If true, collapses multiple consecutive spaces in the description into a single space. This helps to ensure that descriptions are concise and do not contain unnecessary whitespace.
+   *
+   * @defaultValue false
+   */
+  collapseWhitespace?: boolean;
+}
+/**
+ * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+ *
+ * @remarks
+ * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+ *
+ * @param description - The full description string.
+ * @returns The formatted description string.
+ */
+declare function formatDescription(description: string, options?: FormatDescriptionOptions): string;
+interface FormatShortDescriptionOptions extends FormatDescriptionOptions {
+  /**
+   * The maximum length of the short description. If the first sentence exceeds this length, it will be truncated.
+   *
+   * @defaultValue 62
+   */
+  length?: number;
+}
+/**
+ * Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.
+ *
+ * @param description - The full description string.
+ * @param options - Options for formatting the short description, including the maximum length.
+ * @returns The extracted short description.
+ */
+declare function formatShortDescription(description: string, options?: FormatShortDescriptionOptions): string;
+//#endregion
+//#region src/plugin-utils/get-command-tree.d.ts
+/**
+ * Retrieves a specific command tree based on the provided path.
+ *
+ * @param context - The build context containing the command definitions.
+ * @param path - An array of strings representing the command path.
+ * @returns The command tree at the specified path, or null if not found.
+ */
+declare function getCommandTree(context: Context, path?: string[]): CommandTree | null;
+/**
+ * Retrieves a list of all command trees defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command trees in the context.
+ */
+declare function getCommandList(context: Context): Promise<CommandTree[]>;
+/**
+ * Retrieves a list of all command paths defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command paths in the context.
+ */
+declare function getCommandPaths(context: Context): Promise<string[]>;
+/**
+ * Retrieves a list of all command segments defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command segments in the context.
+ */
+declare function getCommandSegments(context: Context): Promise<string[][]>;
+//#endregion
+//#region src/plugin-utils/reflect.d.ts
+/**
+ * Sort command options alphabetically by name, placing boolean options with negatives appropriately.
+ *
+ * @param options - The array of command options to sort.
+ * @param skipNegatives - Whether to skip negative options when sorting (default: true).
+ * @returns A new array of sorted command options.
+ */
+declare function sortOptions(options: CommandOption[], skipNegatives?: boolean): CommandOption[];
+//#endregion
+//#region src/plugin-utils/traverse-command-tree.d.ts
+/**
+ * Traverses a command tree and applies a visitor function to each node.
+ *
+ * @param commandTree - The command tree to traverse.
+ * @param visitor - The visitor function to apply to each node.
+ */
+declare function traverseCommandTree(commandTree: CommandTree, visitor: (node: CommandTree) => MaybePromise<void>): Promise<void>;
+/**
+ * Traverses all commands in the context and applies a visitor function to each command tree.
+ *
+ * @param context - The build context containing the command definitions.
+ * @param visitor - The visitor function to apply to each command tree.
+ */
+declare function traverseCommands<TContext extends Context>(context: TContext, visitor: (node: CommandTree) => MaybePromise<void>): Promise<void>;
+//#endregion
+//#region src/plugin-utils/type-checks.d.ts
+/**
+ * Type guard to check if a value is a valid {@link CommandParameterType} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandParameterType} type, false otherwise.
+ */
+declare function isCommandParameterType(obj: any): obj is CommandParameterType;
+/**
+ * Type guard to check if a value is a valid {@link CommandParameterConfig} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandParameterConfig} type, false otherwise.
+ */
+declare function isCommandParameterConfig(obj: any): obj is CommandParameterConfig;
+/**
+ * Type guard to check if a value is a valid {@link CommandParameter} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandParameter} type, false otherwise.
+ */
+declare function isCommandParameter(obj: any): obj is CommandParameter;
+/**
+ * Type guard to check if a value is a valid {@link CommandOption} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandOption} type, false otherwise.
+ */
+declare function isCommandOption(obj: any): obj is CommandOption;
+/**
+ * Type guard to check if a value is a valid {@link CommandArgument} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandArgument} type, false otherwise.
+ */
+declare function isCommandArgument(obj: any): obj is CommandArgument;
+//#endregion
+export { FormatDescriptionOptions, FormatShortDescriptionOptions, computeBin, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandPaths, getCommandSegments, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterType, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+//# sourceMappingURL=index.d.cts.map

package/dist/plugin-utils/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/plugin-utils/compute-bin.ts","../../src/plugin-utils/context-helpers.ts","../../src/plugin-utils/deepkit.ts","../../src/plugin-utils/description-helpers.ts","../../src/plugin-utils/get-command-tree.ts","../../src/plugin-utils/reflect.ts","../../src/plugin-utils/traverse-command-tree.ts","../../src/plugin-utils/type-checks.ts"],"mappings":";;;;;;;;;;;;iBA4BgB,WAAW,SAAS,UAAU;;;;;;;;;iBCE9B,eAAe;;;;;;;;iBAkBf,WAAW,iBAAiB,oBAAoB,SAC9D,SAAS;;;;;;;;iBA4BK,YAAY,iBAAiB,oBAAoB,SAC/D,SAAS,UACT;;;;;;;iBAsBc,kBAAkB,iBAAiB,oBAAoB,SACrE,SAAS;;;;;;;iBAeK,UAAU,iBAAiB,oBAAoB,SAC7D,SAAS;;;;;;;;;;;;;iBAmBK,qBAAqB;;;;;;;;;;;;iBAerB,0BAA0B;;;;;;;;;;;;;;iBAiB1B,mBAAmB;;;;;;;;;;;;;iBAgBnB,wBAAwB;;;;;;;;;;;;iBAkBxB,mBAAmB;;;;;;;;;;iBCxKnB,sBACd,SAAS,uBAAuB,sBAChC,0BACC;;;;;;;;iBAgCa,YACd,SAAS,uBAAuB,sBAChC,0BACC;;;UCvDc;;;;;;EAMf;;;;;;EAOA;;;;;;;;;;;iBAqDc,kBACd,qBACA,UAAS;UAOM,sCAAsC;;;;;;EAMrD;;;;;;;;;iBAUc,uBACd,qBACA,UAAS;;;;;;;;;;iBCjFK,eACd,SAAS,SACT,kBACC;;;;;;;iBA+BmB,eAAe,SAAS,UAAU,QAAQ;;;;;;;iBAe1C,gBAAgB,SAAS,UAAU;;;;;;;iBAiBnC,mBACpB,SAAS,UACR;;;;;;;;;;iBCvEa,YACd,SAAS,iBACT,0BACC;;;;;;;;;iBCFmB,oBACpB,aAAa,aACb,UAAU,MAAM,gBAAgB,qBAC/B;;;;;;;iBAmBmB,iBAAiB,iBAAiB,SACtD,SAAS,UACT,UAAU,MAAM,gBAAgB,qBAC/B;;;;;;;;;iBCqJa,uBAAuB,WAAW,OAAO;;;;;;;iBAUzC,yBACd,WACC,OAAO;;;;;;;iBAqBM,mBAAmB,WAAW,OAAO;;;;;;;iBA0CrC,gBAAgB,WAAW,OAAO;;;;;;;iBAkClC,kBAAkB,WAAW,OAAO"}

package/dist/plugin-utils/index.d.mts

@@ -1,9 +1,273 @@
-import { computeBin } from "./compute-bin.mjs";
-import { getAppBin, getAppDescription, getAppName, getAppTitle, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases } from "./context-helpers.mjs";
-import { extractReflectionKind, extractType } from "./deepkit.mjs";
-import { FormatDescriptionOptions, FormatShortDescriptionOptions, formatDescription, formatShortDescription } from "./description-helpers.mjs";
-import { getCommandList, getCommandPaths, getCommandSegments, getCommandTree } from "./get-command-tree.mjs";
-import { sortOptions } from "./reflect.mjs";
-import { traverseCommandTree, traverseCommands } from "./traverse-command-tree.mjs";
-import { isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterType } from "./type-checks.mjs";
-export { FormatDescriptionOptions, FormatShortDescriptionOptions, computeBin, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandPaths, getCommandSegments, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterType, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+import { S as CommandTree, _ as CommandOption, b as CommandParameterConfig, d as CommandArgument, r as BaseCommandParameter, x as CommandParameterType, y as CommandParameter } from "../command-B6KYexlV.mjs";
+import { f as Context, m as UnresolvedContext } from "../config-CnNYdfsL.mjs";
+import "../index-D4klH_pj.mjs";
+import { ReflectionKind, Type } from "@deepkit/type";
+import { MaybePromise } from "@stryke/types/base";
+//#region src/plugin-utils/compute-bin.d.ts
+/**
+ * Computes the command tree for the root binary command based on the provided context.
+ *
+ * @param context - The plugin context containing the necessary information to compute the command tree.
+ * @returns The computed command tree for the root binary command.
+ */
+declare function computeBin(context: Context): CommandTree;
+//#endregion
+//#region src/plugin-utils/context-helpers.d.ts
+/**
+ * Sorts command argument aliases, placing single-character aliases first, followed by multi-character aliases, and then sorting them alphabetically.
+ *
+ * @param aliases - An array of argument aliases to sort.
+ * @returns A new array of sorted aliases.
+ */
+declare function sortArgAliases(aliases: string[]): string[];
+/**
+ * Retrieves the application name from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application name in kebab-case format.
+ * @throws An error if no valid application name is found.
+ */
+declare function getAppName<TContext extends UnresolvedContext | Context>(context: TContext): string;
+/**
+ * Retrieves the application title from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @param replaceCLI - Whether to replace CLI-related terms in the title with the application name.
+ * @returns The application title in title-case format.
+ */
+declare function getAppTitle<TContext extends UnresolvedContext | Context>(context: TContext, replaceCLI?: boolean): string;
+/**
+ * Retrieves the application description from the context and configuration.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The application description.
+ */
+declare function getAppDescription<TContext extends UnresolvedContext | Context>(context: TContext): string;
+/**
+ * Retrieves the primary binary name for the application.
+ *
+ * @param context - The build context containing workspace and package information.
+ * @returns The primary binary name as a string.
+ */
+declare function getAppBin<TContext extends UnresolvedContext | Context>(context: TContext): string;
+/**
+ * Determines if a given command path segment is variable (enclosed in square brackets).
+ *
+ * @example
+ * ```typescript
+ * isDynamicPathSegment("[user]"); // true
+ * isDynamicPathSegment("user"); // false
+ * ```
+ *
+ * @param path - The command path segment to check.
+ * @returns True if the path is variable, false otherwise.
+ */
+declare function isDynamicPathSegment(path: string): boolean;
+/**
+ * Extracts the variable name from a command path segment by removing enclosing square brackets.
+ *
+ * @example
+ * ```typescript
+ * getDynamicPathSegmentName("[user]"); // "user"
+ * ```
+ *
+ * @param path - The command path segment.
+ * @returns The variable name without square brackets.
+ */
+declare function getDynamicPathSegmentName(path: string): string;
+/**
+ * Determines if a given command path segment is a path segment group (enclosed in parentheses).
+ *
+ * @example
+ * ```typescript
+ * isPathSegmentGroup("(user)"); // true
+ * isPathSegmentGroup("[user]"); // false
+ * isPathSegmentGroup("user"); // false
+ * ```
+ *
+ * @param path - The command path segment to check.
+ * @returns True if the path is a path segment group, false otherwise.
+ */
+declare function isPathSegmentGroup(path: string): boolean;
+/**
+ * Extracts the group name from a command path segment by removing enclosing parentheses.
+ *
+ * @example
+ * ```typescript
+ * getPathSegmentGroupName("(admin)"); // "admin"
+ * getPathSegmentGroupName("((group))"); // "group"
+ * ```
+ *
+ * @param path - The command path segment.
+ * @returns The group name without parentheses.
+ */
+declare function getPathSegmentGroupName(path: string): string;
+/**
+ * Extracts the variable name from a command path segment by removing enclosing square brackets.
+ *
+ * @example
+ * ```typescript
+ * getDynamicPathSegmentName("[user]"); // "user"
+ * ```
+ *
+ * @param path - The command path segment.
+ * @returns The variable name without square brackets.
+ */
+declare function getPathSegmentName(path: string): string;
+//#endregion
+//#region src/plugin-utils/deepkit.d.ts
+/**
+ * Extracts a {@link ReflectionKind} from a {@link BaseCommandParameter} or {@link CommandParameterType}.
+ *
+ * @param command - The command parameter or kind to extract the reflection kind from.
+ * @param checkVariadic - Whether to check for variadic parameters (arrays).
+ * @returns The extracted {@link ReflectionKind}.
+ */
+declare function extractReflectionKind(command: BaseCommandParameter | CommandParameterType, checkVariadic?: boolean): ReflectionKind;
+/**
+ * Extracts a {@link Type} from a {@link BaseCommandParameter} or {@link CommandParameterType}.
+ *
+ * @param command - The command parameter or kind to extract the type from.
+ * @param checkVariadic - Whether to check for variadic parameters (arrays).
+ * @returns The extracted {@link Type}.
+ */
+declare function extractType(command: BaseCommandParameter | CommandParameterType, checkVariadic?: boolean): Type;
+//#endregion
+//#region src/plugin-utils/description-helpers.d.ts
+interface FormatDescriptionOptions {
+  /**
+   * If true, replaces newlines in the description with spaces. This is useful for ensuring that descriptions are displayed as a single line in contexts where multiline descriptions may not be supported or may cause formatting issues.
+   *
+   * @defaultValue false
+   */
+  replaceNewlines?: boolean;
+  /**
+   * If true, collapses multiple consecutive spaces in the description into a single space. This helps to ensure that descriptions are concise and do not contain unnecessary whitespace.
+   *
+   * @defaultValue false
+   */
+  collapseWhitespace?: boolean;
+}
+/**
+ * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+ *
+ * @remarks
+ * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+ *
+ * @param description - The full description string.
+ * @returns The formatted description string.
+ */
+declare function formatDescription(description: string, options?: FormatDescriptionOptions): string;
+interface FormatShortDescriptionOptions extends FormatDescriptionOptions {
+  /**
+   * The maximum length of the short description. If the first sentence exceeds this length, it will be truncated.
+   *
+   * @defaultValue 62
+   */
+  length?: number;
+}
+/**
+ * Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.
+ *
+ * @param description - The full description string.
+ * @param options - Options for formatting the short description, including the maximum length.
+ * @returns The extracted short description.
+ */
+declare function formatShortDescription(description: string, options?: FormatShortDescriptionOptions): string;
+//#endregion
+//#region src/plugin-utils/get-command-tree.d.ts
+/**
+ * Retrieves a specific command tree based on the provided path.
+ *
+ * @param context - The build context containing the command definitions.
+ * @param path - An array of strings representing the command path.
+ * @returns The command tree at the specified path, or null if not found.
+ */
+declare function getCommandTree(context: Context, path?: string[]): CommandTree | null;
+/**
+ * Retrieves a list of all command trees defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command trees in the context.
+ */
+declare function getCommandList(context: Context): Promise<CommandTree[]>;
+/**
+ * Retrieves a list of all command paths defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command paths in the context.
+ */
+declare function getCommandPaths(context: Context): Promise<string[]>;
+/**
+ * Retrieves a list of all command segments defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command segments in the context.
+ */
+declare function getCommandSegments(context: Context): Promise<string[][]>;
+//#endregion
+//#region src/plugin-utils/reflect.d.ts
+/**
+ * Sort command options alphabetically by name, placing boolean options with negatives appropriately.
+ *
+ * @param options - The array of command options to sort.
+ * @param skipNegatives - Whether to skip negative options when sorting (default: true).
+ * @returns A new array of sorted command options.
+ */
+declare function sortOptions(options: CommandOption[], skipNegatives?: boolean): CommandOption[];
+//#endregion
+//#region src/plugin-utils/traverse-command-tree.d.ts
+/**
+ * Traverses a command tree and applies a visitor function to each node.
+ *
+ * @param commandTree - The command tree to traverse.
+ * @param visitor - The visitor function to apply to each node.
+ */
+declare function traverseCommandTree(commandTree: CommandTree, visitor: (node: CommandTree) => MaybePromise<void>): Promise<void>;
+/**
+ * Traverses all commands in the context and applies a visitor function to each command tree.
+ *
+ * @param context - The build context containing the command definitions.
+ * @param visitor - The visitor function to apply to each command tree.
+ */
+declare function traverseCommands<TContext extends Context>(context: TContext, visitor: (node: CommandTree) => MaybePromise<void>): Promise<void>;
+//#endregion
+//#region src/plugin-utils/type-checks.d.ts
+/**
+ * Type guard to check if a value is a valid {@link CommandParameterType} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandParameterType} type, false otherwise.
+ */
+declare function isCommandParameterType(obj: any): obj is CommandParameterType;
+/**
+ * Type guard to check if a value is a valid {@link CommandParameterConfig} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandParameterConfig} type, false otherwise.
+ */
+declare function isCommandParameterConfig(obj: any): obj is CommandParameterConfig;
+/**
+ * Type guard to check if a value is a valid {@link CommandParameter} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandParameter} type, false otherwise.
+ */
+declare function isCommandParameter(obj: any): obj is CommandParameter;
+/**
+ * Type guard to check if a value is a valid {@link CommandOption} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandOption} type, false otherwise.
+ */
+declare function isCommandOption(obj: any): obj is CommandOption;
+/**
+ * Type guard to check if a value is a valid {@link CommandArgument} type.
+ *
+ * @param obj - The value to check.
+ * @returns True if the value is a valid {@link CommandArgument} type, false otherwise.
+ */
+declare function isCommandArgument(obj: any): obj is CommandArgument;
+//#endregion
+export { FormatDescriptionOptions, FormatShortDescriptionOptions, computeBin, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandPaths, getCommandSegments, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterType, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+//# sourceMappingURL=index.d.mts.map

package/dist/plugin-utils/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/plugin-utils/compute-bin.ts","../../src/plugin-utils/context-helpers.ts","../../src/plugin-utils/deepkit.ts","../../src/plugin-utils/description-helpers.ts","../../src/plugin-utils/get-command-tree.ts","../../src/plugin-utils/reflect.ts","../../src/plugin-utils/traverse-command-tree.ts","../../src/plugin-utils/type-checks.ts"],"mappings":""}