@shell-shock/plugin-help 0.1.2

package/dist/components/display.cjs

@@ -0,0 +1,260 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+const require_kebab_case = require('../node_modules/.pnpm/@stryke_string-format@0.17.4/node_modules/@stryke/string-format/dist/kebab-case.cjs');
+const require_snake_case = require('../node_modules/.pnpm/@stryke_string-format@0.17.4/node_modules/@stryke/string-format/dist/snake-case.cjs');
+let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let _alloy_js_core = require("@alloy-js/core");
+let _shell_shock_core_plugin_utils = require("@shell-shock/core/plugin-utils");
+let _powerlines_plugin_alloy_core_components_spacing = require("@powerlines/plugin-alloy/core/components/spacing");
+let _powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
+let _shell_shock_core = require("@shell-shock/core");
+let _shell_shock_plugin_theme_contexts_theme = require("@shell-shock/plugin-theme/contexts/theme");
+
+//#region src/components/display.tsx
+/**
+* A component that generates the usage display for a command.
+*/
+function HelpUsageDisplay(props) {
+	const { command, indent = 2 } = props;
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	const theme = (0, _shell_shock_plugin_theme_contexts_theme.useTheme)();
+	return [(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
+		get each() {
+			return Object.keys(context.config.bin);
+		},
+		hardline: true,
+		children: (bin) => [(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`
+      writeLine(
+        colors.text.body.secondary(\`\$ \${colors.text.usage.bin("${bin}")}${command.segments.length > 0 ? ` ${command.segments.map((segment) => `\${colors.text.usage.${(0, _shell_shock_core_plugin_utils.isDynamicPathSegment)(segment) ? "dynamic" : "command"}("${(0, _shell_shock_core_plugin_utils.isDynamicPathSegment)(segment) ? `[${require_snake_case.snakeCase((0, _shell_shock_core_plugin_utils.getDynamicPathSegmentName)(segment))}]` : segment}")}`).join(" ")}` : ""}${Object.values(command.children).length > 0 ? ` \${colors.text.usage.dynamic("[command]")}` : ""}${command.args.length > 0 ? ` ${command.args.map((arg) => `\${colors.text.usage.args("<${require_snake_case.snakeCase((arg.kind === _shell_shock_core.CommandParameterKinds.string || arg.kind === _shell_shock_core.CommandParameterKinds.number) && arg.choices && arg.choices.length > 0 ? arg.choices.join("|") : arg.kind === _shell_shock_core.CommandParameterKinds.string && arg.format ? arg.format : arg.name)}${(arg.kind === _shell_shock_core.CommandParameterKinds.string || arg.kind === _shell_shock_core.CommandParameterKinds.number) && arg.variadic ? "..." : ""}>")}`).join(" ")}` : ""} \${colors.text.usage.options("[options]")}\`), { padding: ${theme.padding.app * indent} }
+      );`), (0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})]
+	}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+		get when() {
+			return command.args.length > 0;
+		},
+		get children() {
+			return [(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
+				get each() {
+					return Object.keys(context.config.bin);
+				},
+				hardline: true,
+				children: (bin) => [(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`
+      writeLine(
+        colors.text.body.secondary(\`\$ \${colors.text.usage.bin("${bin}")}${command.segments.length > 0 ? ` ${command.segments.map((segment) => `\${colors.text.usage.${(0, _shell_shock_core_plugin_utils.isDynamicPathSegment)(segment) ? "dynamic" : "command"}("${(0, _shell_shock_core_plugin_utils.isDynamicPathSegment)(segment) ? `[${require_snake_case.snakeCase((0, _shell_shock_core_plugin_utils.getDynamicPathSegmentName)(segment))}]` : segment}")}`).join(" ")}` : ""}${Object.values(command.children).length > 0 ? ` \${colors.text.usage.dynamic("[command]")}` : ""} \${colors.text.usage.options("[options]")}${command.args.length > 0 ? ` ${command.args.map((arg) => `\${colors.text.usage.args("<${require_snake_case.snakeCase((arg.kind === _shell_shock_core.CommandParameterKinds.string || arg.kind === _shell_shock_core.CommandParameterKinds.number) && arg.choices && arg.choices.length > 0 ? arg.choices.join("|") : arg.kind === _shell_shock_core.CommandParameterKinds.string && arg.format ? arg.format : arg.name)}${(arg.kind === _shell_shock_core.CommandParameterKinds.string || arg.kind === _shell_shock_core.CommandParameterKinds.number) && arg.variadic ? "..." : ""}>")}`).join(" ")}` : ""}\`), { padding: ${theme.padding.app * indent} }
+      );`), (0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})]
+			})];
+		}
+	})];
+}
+/**
+* A component that generates the options table display for a command.
+*/
+function HelpOptionsDisplay(props) {
+	const { options } = props;
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [
+		_alloy_js_core.code`table([ `,
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
+			get each() {
+				return (0, _shell_shock_core_plugin_utils.sortOptions)(options);
+			},
+			hardline: true,
+			children: (option) => {
+				const flags = [];
+				const names = [];
+				if (option.name.length === 1) flags.push(`-${option.name}`);
+				else names.push(`--${require_kebab_case.kebabCase(option.name)}`);
+				option.alias.forEach((alias) => {
+					if (alias.length === 1) flags.push(`-${alias}`);
+					else names.push(`--${require_kebab_case.kebabCase(alias)}`);
+				});
+				return _alloy_js_core.code`[{ value: colors.text.body.primary("${flags.length > 0 ? `${flags.sort().join(", ")}${names.length > 0 ? ", " : ""}` : ""}${names.length > 0 ? names.sort().join(", ") : ""}${option.kind === _shell_shock_core.CommandParameterKinds.string ? ` <${require_snake_case.snakeCase(option.choices && option.choices.length > 0 ? option.choices.join("|") : option.format ? option.format : option.name)}${option.variadic ? "..." : ""}>` : option.kind === _shell_shock_core.CommandParameterKinds.number ? ` <${require_snake_case.snakeCase(option.choices && option.choices.length > 0 ? option.choices.join("|") : option.name)}${option.variadic ? "..." : ""}>` : ""}"), align: "right", border: "none", maxWidth: "1/3" }, { value: colors.text.body.tertiary(\`${(0, _shell_shock_core_plugin_utils.formatShortDescription)(option.description).replace(/\.+$/, "").trim()}${option.env || option.default !== void 0 ? ` (${option.env ? `env: ${context.config.appSpecificEnvPrefix}_${option.env}${option.default !== void 0 ? ", " : ""}` : ""}${option.default !== void 0 ? `default: ${JSON.stringify(option.default).replace(/"/g, "\\\"")}` : ""})` : ""}.\`), align: "left", border: "none" }], `;
+			}
+		}),
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		_alloy_js_core.code` ]); `
+	];
+}
+/**
+* A component that generates the commands table display for a command.
+*/
+function HelpCommandsDisplay(props) {
+	const { commands } = props;
+	return [
+		_alloy_js_core.code`table([ `,
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
+			get each() {
+				return Object.values(commands);
+			},
+			hardline: true,
+			children: (child) => _alloy_js_core.code`[{ value: colors.text.body.primary("${child.name}"), align: "right", border: "none" }, { value: colors.text.body.tertiary(\`${(0, _shell_shock_core_plugin_utils.formatShortDescription)(child.description).replace(/\.+$/, "").trim()}.\`), align: "left", border: "none" }], `
+		}),
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		_alloy_js_core.code` ]); `
+	];
+}
+/**
+* A component that generates the `help` function declaration for a command.
+*/
+function BaseHelpDisplay(props) {
+	const { command, indent = 1, filterGlobalOptions = false } = props;
+	const theme = (0, _shell_shock_plugin_theme_contexts_theme.useTheme)();
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	const options = (0, _alloy_js_core.computed)(() => filterGlobalOptions ? Object.values(command.options).filter((option) => !context.options.some((globalOption) => globalOption.name === option.name || option.alias.includes(globalOption.name) || globalOption.alias?.includes(option.name) || globalOption.alias?.some((alias) => option.alias.includes(alias)))) : Object.values(command.options));
+	return [
+		(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`writeLine(colors.bold(colors.text.heading.secondary("Usage:"))${indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : ""});`),
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(HelpUsageDisplay, {
+			command,
+			indent
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			get when() {
+				return options.value.length > 0;
+			},
+			get children() {
+				return [
+					(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`writeLine("");
+      writeLine(colors.bold(colors.text.heading.secondary("Options:"))${indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : ""});`),
+					(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(HelpOptionsDisplay, { get options() {
+						return options.value;
+					} }),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {})
+				];
+			}
+		}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			get when() {
+				return Object.keys(command.children).length > 0;
+			},
+			get children() {
+				return [
+					(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`writeLine("");
+      writeLine(colors.bold(colors.text.heading.secondary("Commands:"))${indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : ""});`),
+					(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(HelpCommandsDisplay, { get commands() {
+						return command.children;
+					} }),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {})
+				];
+			}
+		})
+	];
+}
+/**
+* A component that generates the invocation of the `help` function for a command.
+*/
+function VirtualCommandHelpDisplay(props) {
+	const { options, segments, commands } = props;
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		_alloy_js_core.code`writeLine(colors.bold(colors.text.heading.secondary("Global Options:")));`,
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(HelpOptionsDisplay, { options }),
+		_alloy_js_core.code`writeLine(""); `,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			get when() {
+				return Object.keys(commands).length > 0;
+			},
+			get children() {
+				return [
+					(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`writeLine(colors.text.body.secondary("The following commands are available through the ${(0, _shell_shock_core_plugin_utils.getAppTitle)(context, true)} command-line interface:"));
+        writeLine(""); `),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
+						get each() {
+							return Object.values(commands);
+						},
+						doubleHardline: true,
+						joiner: _alloy_js_core.code`writeLine(""); `,
+						ender: _alloy_js_core.code`writeLine(""); `,
+						children: (child) => [
+							(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`
+                writeLine(colors.text.heading.primary(${child.icon ? `(isUnicodeSupported ? " ${child.icon}  " : "") + ` : ""}"${child.title} ${child.isVirtual ? "" : "Command"}"));
+                writeLine("");
+                writeLine(colors.text.body.secondary(splitText(\`${(0, _shell_shock_core_plugin_utils.formatDescription)(child.description).replace(/\.+$/, "").trim()}.\`)));
+                writeLine("");
+                `),
+							(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+							(0, _alloy_js_core_jsx_runtime.createComponent)(BaseHelpDisplay, {
+								command: child,
+								indent: 2,
+								filterGlobalOptions: true
+							}),
+							(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+						]
+					}),
+					(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`help("Running a specific command with the help flag (via: '${(0, _shell_shock_core_plugin_utils.getAppBin)(context)}${segments && segments.length > 0 ? ` ${segments.join(" ")}` : ""} <specific command> --help') will provide additional information that is specific to that command.");
+        writeLine("");`)
+				];
+			}
+		})
+	];
+}
+/**
+* A component that generates the invocation of the `help` function for a command.
+*/
+function CommandHelpDisplay(props) {
+	const { command } = props;
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [
+		_alloy_js_core.code`writeLine(""); `,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(BaseHelpDisplay, {
+			command,
+			filterGlobalOptions: false
+		}),
+		_alloy_js_core.code`writeLine(""); `,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			get when() {
+				return Object.keys(command.children).length > 0;
+			},
+			get children() {
+				return [
+					_alloy_js_core.code`writeLine(colors.text.body.secondary("The following sub-commands are available:"));
+        writeLine(""); `,
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
+						get each() {
+							return Object.values(command.children);
+						},
+						doubleHardline: true,
+						joiner: _alloy_js_core.code`writeLine(""); `,
+						ender: _alloy_js_core.code`writeLine(""); `,
+						children: (child) => [
+							(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`
+                writeLine(colors.text.heading.primary(${child.icon ? `(isUnicodeSupported ? " ${child.icon}  " : "") + ` : ""}"${child.title} ${child.isVirtual ? "" : "Command"}"));
+                writeLine("");
+                writeLine(colors.text.body.secondary(splitText(\`${(0, _shell_shock_core_plugin_utils.formatDescription)(child.description).replace(/\.+$/, "").trim()}.\`)));
+                writeLine("");
+                `),
+							(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+							(0, _alloy_js_core_jsx_runtime.createComponent)(BaseHelpDisplay, {
+								command: child,
+								indent: 2,
+								filterGlobalOptions: true
+							}),
+							(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+						]
+					}),
+					(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`help("Running a specific command with the help flag (via: '${(0, _shell_shock_core_plugin_utils.getAppBin)(context)} ${command.segments.join(" ")} <specific command> --help') will provide additional information that is specific to that command.");
+        writeLine("");`)
+				];
+			}
+		})
+	];
+}
+
+//#endregion
+exports.BaseHelpDisplay = BaseHelpDisplay;
+exports.CommandHelpDisplay = CommandHelpDisplay;
+exports.HelpCommandsDisplay = HelpCommandsDisplay;
+exports.HelpOptionsDisplay = HelpOptionsDisplay;
+exports.HelpUsageDisplay = HelpUsageDisplay;
+exports.VirtualCommandHelpDisplay = VirtualCommandHelpDisplay;

package/dist/components/display.d.cts

@@ -0,0 +1,105 @@
+import * as _alloy_js_core0 from "@alloy-js/core";
+import { CommandOption, CommandTree } from "@shell-shock/core";
+
+//#region src/components/display.d.ts
+interface HelpUsageDisplayProps {
+  /**
+   * The command to generate help for.
+   */
+  command: CommandTree;
+  /**
+   * The padding scale to apply to the help display headings.
+   *
+   * @remarks
+   * This value is multiplied by the theme's app padding to determine the final padding.
+   *
+   * @defaultValue 2
+   */
+  indent?: number;
+}
+/**
+ * A component that generates the usage display for a command.
+ */
+declare function HelpUsageDisplay(props: HelpUsageDisplayProps): _alloy_js_core0.Children;
+interface HelpOptionsDisplayProps {
+  /**
+   * The options to display help for.
+   */
+  options: CommandOption[];
+}
+/**
+ * A component that generates the options table display for a command.
+ */
+declare function HelpOptionsDisplay(props: HelpOptionsDisplayProps): _alloy_js_core0.Children;
+interface HelpCommandsDisplayProps {
+  /**
+   * A mapping of command names to their command definitions.
+   */
+  commands: Record<string, CommandTree>;
+}
+/**
+ * A component that generates the commands table display for a command.
+ */
+declare function HelpCommandsDisplay(props: HelpCommandsDisplayProps): _alloy_js_core0.Children;
+interface BaseHelpDisplayProps {
+  /**
+   * The command to generate help for.
+   */
+  command: CommandTree;
+  /**
+   * Whether to filter out global options from the help display.
+   *
+   * @remarks
+   * When enabled, any options that are present in the global options context will be filtered out from the help display. This is useful for sub-commands to avoid displaying global options that are not relevant to the specific command.
+   *
+   * @defaultValue false
+   */
+  filterGlobalOptions?: boolean;
+  /**
+   * The padding scale to apply to the help display headings.
+   *
+   * @remarks
+   * This value is multiplied by the theme's app padding to determine the final padding.
+   *
+   * @defaultValue 1
+   */
+  indent?: number;
+}
+/**
+ * A component that generates the `help` function declaration for a command.
+ */
+declare function BaseHelpDisplay(props: BaseHelpDisplayProps): _alloy_js_core0.Children;
+interface VirtualCommandHelpDisplayProps {
+  /**
+   * The options to display help for.
+   */
+  options: CommandOption[];
+  /**
+   * A mapping of command names to their command definitions.
+   */
+  commands: Record<string, CommandTree>;
+  /**
+   * The command path to generate help for, used for generating the help invocation instructions.
+   *
+   * @remarks
+   * This is optional since the virtual command entry component can be used for both the global binary executable and virtual commands (there will be no command definition for the binary executable).
+   */
+  segments?: string[];
+}
+/**
+ * A component that generates the invocation of the `help` function for a command.
+ */
+declare function VirtualCommandHelpDisplay(props: VirtualCommandHelpDisplayProps): _alloy_js_core0.Children;
+interface CommandHelpDisplayProps {
+  /**
+   * A mapping of command names to their command definitions.
+   */
+  command: CommandTree;
+}
+/**
+ * A component that generates the invocation of the `help` function for a command.
+ */
+declare function CommandHelpDisplay(props: CommandHelpDisplayProps): _alloy_js_core0.Children;
+//#endregion
+export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
+//# sourceMappingURL=display.d.cts.map

package/dist/components/display.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"display.d.cts","names":[],"sources":["../../src/components/display.tsx"],"mappings":";;;;UAqCiB,qBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;;;;;;;;AAgBX;EANE,MAAA;AAAA;;;;iBAMc,gBAAA,CAAiB,KAAA,EAAO,qBAAA,GAAqB,eAAA,CAAA,QAAA;AAAA,UAiH5C,uBAAA;EAjH4C;AAiH7D;;EAIE,OAAA,EAAS,aAAA;AAAA;;AAMX;;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,eAAA,CAAA,QAAA;AAAA,UA0EhD,wBAAA;EA1EyB;;;EA8ExC,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAJ3B;;;AAAA,iBAUgB,mBAAA,CAAoB,KAAA,EAAO,wBAAA,GAAwB,eAAA,CAAA,QAAA;AAAA,UAwBlD,oBAAA;EA9BL;;;EAkCV,OAAA,EAAS,WAAA;EA5BK;;;;;;;;EAsCd,mBAAA;EAde;;;;;;;;EAwBf,MAAA;AAAA;AAMF;;;AAAA,iBAAgB,eAAA,CAAgB,KAAA,EAAO,oBAAA,GAAoB,eAAA,CAAA,QAAA;AAAA,UAmD1C,8BAAA;EAnDe;;;EAuD9B,OAAA,EAAS,aAAA;EAJM;;;EASf,QAAA,EAAU,MAAA,SAAe,WAAA;EAAA;;;;;;EAQzB,QAAA;AAAA;;;;iBAMc,yBAAA,CACd,KAAA,EAAO,8BAAA,GAA8B,eAAA,CAAA,QAAA;AAAA,UA2DtB,uBAAA;EA5DwB;;;EAgEvC,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,eAAA,CAAA,QAAA"}

package/dist/components/display.d.mts

@@ -0,0 +1,105 @@
+import * as _alloy_js_core0 from "@alloy-js/core";
+import { CommandOption, CommandTree } from "@shell-shock/core";
+
+//#region src/components/display.d.ts
+interface HelpUsageDisplayProps {
+  /**
+   * The command to generate help for.
+   */
+  command: CommandTree;
+  /**
+   * The padding scale to apply to the help display headings.
+   *
+   * @remarks
+   * This value is multiplied by the theme's app padding to determine the final padding.
+   *
+   * @defaultValue 2
+   */
+  indent?: number;
+}
+/**
+ * A component that generates the usage display for a command.
+ */
+declare function HelpUsageDisplay(props: HelpUsageDisplayProps): _alloy_js_core0.Children;
+interface HelpOptionsDisplayProps {
+  /**
+   * The options to display help for.
+   */
+  options: CommandOption[];
+}
+/**
+ * A component that generates the options table display for a command.
+ */
+declare function HelpOptionsDisplay(props: HelpOptionsDisplayProps): _alloy_js_core0.Children;
+interface HelpCommandsDisplayProps {
+  /**
+   * A mapping of command names to their command definitions.
+   */
+  commands: Record<string, CommandTree>;
+}
+/**
+ * A component that generates the commands table display for a command.
+ */
+declare function HelpCommandsDisplay(props: HelpCommandsDisplayProps): _alloy_js_core0.Children;
+interface BaseHelpDisplayProps {
+  /**
+   * The command to generate help for.
+   */
+  command: CommandTree;
+  /**
+   * Whether to filter out global options from the help display.
+   *
+   * @remarks
+   * When enabled, any options that are present in the global options context will be filtered out from the help display. This is useful for sub-commands to avoid displaying global options that are not relevant to the specific command.
+   *
+   * @defaultValue false
+   */
+  filterGlobalOptions?: boolean;
+  /**
+   * The padding scale to apply to the help display headings.
+   *
+   * @remarks
+   * This value is multiplied by the theme's app padding to determine the final padding.
+   *
+   * @defaultValue 1
+   */
+  indent?: number;
+}
+/**
+ * A component that generates the `help` function declaration for a command.
+ */
+declare function BaseHelpDisplay(props: BaseHelpDisplayProps): _alloy_js_core0.Children;
+interface VirtualCommandHelpDisplayProps {
+  /**
+   * The options to display help for.
+   */
+  options: CommandOption[];
+  /**
+   * A mapping of command names to their command definitions.
+   */
+  commands: Record<string, CommandTree>;
+  /**
+   * The command path to generate help for, used for generating the help invocation instructions.
+   *
+   * @remarks
+   * This is optional since the virtual command entry component can be used for both the global binary executable and virtual commands (there will be no command definition for the binary executable).
+   */
+  segments?: string[];
+}
+/**
+ * A component that generates the invocation of the `help` function for a command.
+ */
+declare function VirtualCommandHelpDisplay(props: VirtualCommandHelpDisplayProps): _alloy_js_core0.Children;
+interface CommandHelpDisplayProps {
+  /**
+   * A mapping of command names to their command definitions.
+   */
+  command: CommandTree;
+}
+/**
+ * A component that generates the invocation of the `help` function for a command.
+ */
+declare function CommandHelpDisplay(props: CommandHelpDisplayProps): _alloy_js_core0.Children;
+//#endregion
+export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
+//# sourceMappingURL=display.d.mts.map

package/dist/components/display.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"display.d.mts","names":[],"sources":["../../src/components/display.tsx"],"mappings":";;;;UAqCiB,qBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;;;;;;;;AAgBX;EANE,MAAA;AAAA;;;;iBAMc,gBAAA,CAAiB,KAAA,EAAO,qBAAA,GAAqB,eAAA,CAAA,QAAA;AAAA,UAiH5C,uBAAA;EAjH4C;AAiH7D;;EAIE,OAAA,EAAS,aAAA;AAAA;;AAMX;;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,eAAA,CAAA,QAAA;AAAA,UA0EhD,wBAAA;EA1EyB;;;EA8ExC,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAJ3B;;;AAAA,iBAUgB,mBAAA,CAAoB,KAAA,EAAO,wBAAA,GAAwB,eAAA,CAAA,QAAA;AAAA,UAwBlD,oBAAA;EA9BL;;;EAkCV,OAAA,EAAS,WAAA;EA5BK;;;;;;;;EAsCd,mBAAA;EAde;;;;;;;;EAwBf,MAAA;AAAA;AAMF;;;AAAA,iBAAgB,eAAA,CAAgB,KAAA,EAAO,oBAAA,GAAoB,eAAA,CAAA,QAAA;AAAA,UAmD1C,8BAAA;EAnDe;;;EAuD9B,OAAA,EAAS,aAAA;EAJM;;;EASf,QAAA,EAAU,MAAA,SAAe,WAAA;EAAA;;;;;;EAQzB,QAAA;AAAA;;;;iBAMc,yBAAA,CACd,KAAA,EAAO,8BAAA,GAA8B,eAAA,CAAA,QAAA;AAAA,UA2DtB,uBAAA;EA5DwB;;;EAgEvC,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,eAAA,CAAA,QAAA"}