@shell-shock/preset-script 0.3.2 → 0.4.0

package/dist/components/help.cjs

@@ -3,9 +3,10 @@ const require_contexts_theme = require('../contexts/theme.cjs');
 require('../contexts/index.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_context_helpers = require("@shell-shock/core/plugin-utils/context-helpers");
 let __powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
+let __shell_shock_core_plugin_utils_context_helpers = require("@shell-shock/core/plugin-utils/context-helpers");
 let __powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
+let __shell_shock_core_components_usage = require("@shell-shock/core/components/usage");
 let __shell_shock_core_plugin_utils_reflect = require("@shell-shock/core/plugin-utils/reflect");
 let __stryke_string_format_kebab_case = require("@stryke/string-format/kebab-case");
 let __stryke_string_format_snake_case = require("@stryke/string-format/snake-case");
@@ -23,12 +24,18 @@ function HelpUsage(props) {
 			return Object.keys(context.config.bin);
 		},
 		hardline: true,
-		children: (bin) => [(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`
+		children: (bin) => [
+			__alloy_js_core.code`
       writeLine(
-        colors.text.body.primary(
-          "$ npx ${bin} ${command.path.segments.map((segment) => (0, __shell_shock_core_plugin_utils_context_helpers.isVariableCommandPath)(segment) ? `<${command.path.variables[segment]?.variadic ? "..." : ""}${(0, __stryke_string_format_kebab_case.kebabCase)((0, __shell_shock_core_plugin_utils_context_helpers.getVariableCommandPathName)(segment))}>` : segment).join(" ")}${Object.values(command.children).length > 0 ? " [commands]" : ""} [options]"
-        ), { padding: ${theme.padding.app * indent} }
-      );`), (0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})]
+        colors.text.body.primary("`,
+			(0, __alloy_js_core_jsx_runtime.createComponent)(__shell_shock_core_components_usage.Usage, {
+				bin,
+				command
+			}),
+			(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`"), { padding: ${theme.padding.app * indent} }
+      );`),
+			(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+		]
 	});
 }
 /**
@@ -83,11 +90,11 @@ function HelpCommands(props) {
 /**
 * A component that generates the `help` function declaration for a command.
 */
-function Help(props) {
-	const { command, indent = 1 } = props;
+function BaseHelp(props) {
+	const { command, indent = 1, filterGlobalOptions = false } = props;
 	const theme = require_contexts_theme.useTheme();
 	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
-	const options = (0, __alloy_js_core.computed)(() => 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)))) ?? []);
+	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", {}),
@@ -133,10 +140,126 @@ function Help(props) {
 		})
 	];
 }
+/**
+* A component that generates the invocation of the `help` function for a command.
+*/
+function VirtualHelp(props) {
+	const { options, path, commands } = props;
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [
+		__alloy_js_core.code`
+      writeLine(""); `,
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(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)(HelpOptions, { options }),
+		__alloy_js_core.code`writeLine(""); `,
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return Object.keys(commands).length > 0;
+			},
+			get children() {
+				return [
+					__alloy_js_core.code`writeLine(colors.text.body.secondary("The following commands are available:"));
+        writeLine(""); `,
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(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);
+						},
+						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.title} ${child.isVirtual ? "" : "Command"}"));
+                writeLine("");
+                writeLine(colors.text.body.secondary("${child.description}"));
+                writeLine("");
+                `),
+							(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+							(0, __alloy_js_core_jsx_runtime.createComponent)(BaseHelp, {
+								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_context_helpers.getAppBin)(context)}${path?.segments && path.segments.length > 0 ? ` ${path.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 CommandHelp(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.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(BaseHelp, {
+			command,
+			filterGlobalOptions: false
+		}),
+		__alloy_js_core.code`writeLine(""); `,
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(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.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(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.title} ${child.isVirtual ? "" : "Command"}"));
+                writeLine("");
+                writeLine(colors.text.body.secondary("${child.description}"));
+                writeLine("");
+                `),
+							(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+							(0, __alloy_js_core_jsx_runtime.createComponent)(BaseHelp, {
+								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_context_helpers.getAppBin)(context)} ${command.path.segments.join(" ")} <specific command> --help') will provide additional information that is specific to that command.");
+        writeLine("");`)
+				];
+			}
+		})
+	];
+}
 
 //#endregion
-exports.Help = Help;
+exports.BaseHelp = BaseHelp;
+exports.CommandHelp = CommandHelp;
 exports.HelpCommands = HelpCommands;
 exports.HelpOptions = HelpOptions;
 exports.HelpUsage = HelpUsage;
+exports.VirtualHelp = VirtualHelp;
 //# sourceMappingURL=help.cjs.map

package/dist/components/help.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"help.cjs","names":["code","computed","For","Show","ReflectionKind","usePowerlines","getVariableCommandPathName","isVariableCommandPath","sortOptions","kebabCase","snakeCase","useTheme","HelpUsage","props","command","indent","context","theme","_$createComponent","each","Object","keys","config","bin","hardline","children","_$memo","path","segments","map","segment","variables","variadic","join","values","length","padding","app","_$createIntrinsic","HelpOptions","options","option","flags","names","name","push","alias","forEach","sort","kind","string","number","description","replace","env","default","undefined","envPrefix","JSON","stringify","HelpCommands","commands","child","Help","filter","some","globalOption","includes","when","value"],"sources":["../../src/components/help.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport { sortOptions } from \"@shell-shock/core/plugin-utils/reflect\";\nimport type {\n  CommandOption,\n  CommandTree\n} from \"@shell-shock/core/types/command\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { useTheme } from \"../contexts\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\n\nexport interface HelpUsageProps {\n  /**\n   * The command to generate help for.\n   */\n  command: CommandTree;\n\n  /**\n   * The padding scale to apply to the help display headings.\n   *\n   * @remarks\n   * This value is multiplied by the theme's app padding to determine the final padding.\n   *\n   * @defaultValue 2\n   */\n  indent?: number;\n}\n\n/**\n * A component that generates the usage display for a command.\n */\nexport function HelpUsage(props: HelpUsageProps) {\n  const { command, indent = 2 } = props;\n\n  const context = usePowerlines<ScriptPresetContext>();\n  const theme = useTheme();\n\n  return (\n    <For each={Object.keys(context.config.bin)} hardline>\n      {bin => (\n        <>\n          {code`\n      writeLine(\n        colors.text.body.primary(\n          \"$ npx ${bin} ${command.path.segments\n            .map(segment =>\n              isVariableCommandPath(segment)\n                ? `<${command.path.variables[segment]?.variadic ? \"...\" : \"\"}${kebabCase(\n                    getVariableCommandPathName(segment)\n                  )}>`\n                : segment\n            )\n            .join(\" \")}${\n            Object.values(command.children).length > 0 ? \" [commands]\" : \"\"\n          } [options]\"\n        ), { padding: ${theme.padding.app * indent} }\n      );`}\n          <hbr />\n        </>\n      )}\n    </For>\n  );\n}\n\nexport interface HelpOptionsProps {\n  /**\n   * The options to display help for.\n   */\n  options: CommandOption[];\n}\n\n/**\n * A component that generates the options table display for a command.\n */\nexport function HelpOptions(props: HelpOptionsProps) {\n  const { options } = props;\n\n  const context = usePowerlines<ScriptPresetContext>();\n\n  return (\n    <>\n      {code`table([ `}\n      <hbr />\n      <For each={sortOptions(options)} hardline>\n        {option => {\n          const flags = [] as string[];\n          const names = [] as string[];\n          if (option.name.length === 1) {\n            flags.push(`-${option.name}`);\n          } else {\n            names.push(`--${kebabCase(option.name)}`);\n          }\n\n          option.alias.forEach((alias: string) => {\n            if (alias.length === 1) {\n              flags.push(`-${alias}`);\n            } else {\n              names.push(`--${kebabCase(alias)}`);\n            }\n          });\n\n          return code`[{ value: colors.text.body.primary(\"${\n            flags.length > 0\n              ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n              : \"\"\n          }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n            option.kind === ReflectionKind.string\n              ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n              : option.kind === ReflectionKind.number\n                ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n                : \"\"\n          }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${option.description.replace(\n            /\\.+$/,\n            \"\"\n          )} ${\n            option.env || option.default !== undefined\n              ? `(${\n                  option.env\n                    ? `env: ${context.config.envPrefix}_${option.env}${\n                        option.default !== undefined ? \", \" : \"\"\n                      }`\n                    : \"\"\n                }${\n                  option.default !== undefined\n                    ? `default: ${JSON.stringify(option.default)}`\n                    : \"\"\n                })`\n              : \"\"\n          }.\"), align: \"left\", border: \"none\" }], `;\n        }}\n      </For>\n      <hbr />\n      {code` ]); `}\n    </>\n  );\n}\n\nexport interface HelpCommandsProps {\n  /**\n   * A mapping of command names to their command definitions.\n   */\n  commands: Record<string, CommandTree>;\n}\n\n/**\n * A component that generates the commands table display for a command.\n */\nexport function HelpCommands(props: HelpCommandsProps) {\n  const { commands } = props;\n\n  return (\n    <>\n      {code`table([ `}\n      <hbr />\n      <For each={Object.values(commands)} hardline>\n        {child =>\n          code`[{ value: colors.text.body.primary(\"${\n            child.name\n          }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${child.description.replace(\n            /\\.+$/,\n            \"\"\n          )}\"), align: \"left\", border: \"none\" }], `\n        }\n      </For>\n      <hbr />\n      {code` ]); `}\n    </>\n  );\n}\n\nexport interface HelpProps {\n  /**\n   * The command to generate help for.\n   */\n  command: CommandTree;\n\n  /**\n   * The padding scale to apply to the help display headings.\n   *\n   * @remarks\n   * This value is multiplied by the theme's app padding to determine the final padding.\n   *\n   * @defaultValue 1\n   */\n  indent?: number;\n}\n\n/**\n * A component that generates the `help` function declaration for a command.\n */\nexport function Help(props: HelpProps) {\n  const { command, indent = 1 } = props;\n\n  const theme = useTheme();\n  const context = usePowerlines<ScriptPresetContext>();\n\n  const options = computed(\n    () =>\n      Object.values(command.options).filter(\n        option =>\n          !context.options.some(\n            globalOption =>\n              globalOption.name === option.name ||\n              option.alias.includes(globalOption.name) ||\n              globalOption.alias?.includes(option.name) ||\n              globalOption.alias?.some(alias => option.alias.includes(alias))\n          )\n      ) ?? []\n  );\n\n  return (\n    <>\n      {code`writeLine(colors.bold(colors.text.heading.secondary(\"Usage:\"))${\n        indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n      });`}\n      <hbr />\n      <HelpUsage command={command} indent={indent} />\n      <hbr />\n      <hbr />\n      <Show when={options.value.length > 0}>\n        {code`writeLine(\"\");\n      writeLine(colors.bold(colors.text.heading.secondary(\"Options:\"))${\n        indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n      });`}\n        <hbr />\n        <HelpOptions options={options.value} />\n        <hbr />\n        <hbr />\n      </Show>\n      <Show when={Object.keys(command.children).length > 0}>\n        {code`writeLine(\"\");\n      writeLine(colors.bold(colors.text.heading.secondary(\"Commands:\"))${\n        indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n      });`}\n        <hbr />\n        <HelpCommands commands={command.children} />\n        <hbr />\n        <hbr />\n      </Show>\n    </>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAuDA,SAAgBY,UAAUC,OAAuB;CAC/C,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMG,8EAA8C;CACpD,MAAMC,QAAQN,iCAAU;AAExB,yDACGT,qBAAG;EAAA,IAACiB,OAAI;AAAA,UAAEC,OAAOC,KAAKL,QAAQM,OAAOC,IAAI;;EAAEC,UAAQ;EAAAC,WACjDF,QAAG,6CAECvB,oBAAI;;;mBAGIuB,IAAG,GAAIT,QAAQa,KAAKC,SAC1BC,KAAIC,uFACmBA,QAAQ,GAC1B,IAAIhB,QAAQa,KAAKI,UAAUD,UAAUE,WAAW,QAAQ,sIAC3BF,QAC7B,CAAC,CAAA,KACDA,QACL,CACAG,KAAK,IAAI,GACVb,OAAOc,OAAOpB,QAAQW,SAAS,CAACU,SAAS,IAAI,gBAAgB,GAAE;wBAEnDlB,MAAMmB,QAAQC,MAAMtB,OAAM;UACzC,mDAAA,OAAA,EAAA,CAAA,CAAA;EAGF,CAAA;;;;;AAeP,SAAgBwB,YAAY1B,OAAyB;CACnD,MAAM,EAAE2B,YAAY3B;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,oEAAcqB,QAAQ;;GAAEhB,UAAQ;GAAAC,WACtCgB,WAAU;IACT,MAAMC,QAAQ,EAAc;IAC5B,MAAMC,QAAQ,EAAc;AAC5B,QAAIF,OAAOG,KAAKT,WAAW,EACzBO,OAAMG,KAAK,IAAIJ,OAAOG,OAAO;QAE7BD,OAAME,KAAK,sDAAeJ,OAAOG,KAAK,GAAG;AAG3CH,WAAOK,MAAMC,SAASD,UAAkB;AACtC,SAAIA,MAAMX,WAAW,EACnBO,OAAMG,KAAK,IAAIC,QAAQ;SAEvBH,OAAME,KAAK,sDAAeC,MAAM,GAAG;MAErC;AAEF,WAAO9C,oBAAI,uCACT0C,MAAMP,SAAS,IACX,GAAGO,MAAMM,MAAM,CAACf,KAAK,KAAK,GAAGU,MAAMR,SAAS,IAAI,OAAO,OACvD,KACHQ,MAAMR,SAAS,IAAIQ,MAAMK,MAAM,CAACf,KAAK,KAAK,GAAG,KAC9CQ,OAAOQ,SAAS7C,gDAAe8C,SAC3B,sDAAeT,OAAOG,KAAK,GAAGH,OAAOT,WAAW,QAAQ,GAAE,KAC1DS,OAAOQ,SAAS7C,gDAAe+C,SAC7B,sDAAeV,OAAOG,KAAK,GAAGH,OAAOT,WAAW,QAAQ,GAAE,KAC1D,GAAE,4EACmES,OAAOW,YAAYC,QAC9F,QACA,GACD,CAAA,GACCZ,OAAOa,OAAOb,OAAOc,YAAYC,SAC7B,IACEf,OAAOa,MACH,QAAQtC,QAAQM,OAAOmC,UAAS,GAAIhB,OAAOa,MACzCb,OAAOc,YAAYC,SAAY,OAAO,OAExC,KAEJf,OAAOc,YAAYC,SACf,YAAYE,KAAKC,UAAUlB,OAAOc,QAAQ,KAC1C,GAAE,KAER,GAAE;;GAET,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGFvD,oBAAI;EAAO;;;;;AAelB,SAAgB4D,aAAa/C,OAA0B;CACrD,MAAM,EAAEgD,aAAahD;AAErB,QAAA;EAEKb,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,WAAEC,OAAOc,OAAO2B,SAAS;;GAAErC,UAAQ;GAAAC,WACzCqC,UACC9D,oBAAI,uCACF8D,MAAMlB,KAAI,4EACiEkB,MAAMV,YAAYC,QAC7F,QACA,GACD,CAAA;GAAwC,CAAA;mDAAA,OAAA,EAAA,CAAA;EAI5CrD,oBAAI;EAAO;;;;;AAyBlB,SAAgB+D,KAAKlD,OAAkB;CACrC,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMI,QAAQN,iCAAU;CACxB,MAAMK,8EAA8C;CAEpD,MAAMwB,8CAEFpB,OAAOc,OAAOpB,QAAQ0B,QAAQ,CAACwB,QAC7BvB,WACE,CAACzB,QAAQwB,QAAQyB,MACfC,iBACEA,aAAatB,SAASH,OAAOG,QAC7BH,OAAOK,MAAMqB,SAASD,aAAatB,KAAK,IACxCsB,aAAapB,OAAOqB,SAAS1B,OAAOG,KAAK,IACzCsB,aAAapB,OAAOmB,MAAKnB,UAASL,OAAOK,MAAMqB,SAASrB,MAAM,CAClE,CACJ,CAAC,IAAI,EACT,CAAC;AAED,QAAA;8CAEK9C,oBAAI,iEACHe,SAAS,IAAI,gBAAgBE,MAAMmB,QAAQC,MAAMtB,OAAM,MAAO,GAAE,IAC9D;mDAAA,OAAA,EAAA,CAAA;mDAEHH,WAAS;GAAUE;GAAiBC;GAAM,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAG1CZ,sBAAI;GAAA,IAACiE,OAAI;AAAA,WAAE5B,QAAQ6B,MAAMlC,SAAS;;GAAC,IAAAV,WAAA;AAAA,WAAA;iDACjCzB,oBAAI;wEAELe,SAAS,IAAI,gBAAgBE,MAAMmB,QAAQC,MAAMtB,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDwB,aAAW,EAAA,IAACC,UAAO;AAAA,aAAEA,QAAQ6B;QAAK,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;mDAIpClE,sBAAI;GAAA,IAACiE,OAAI;AAAA,WAAEhD,OAAOC,KAAKP,QAAQW,SAAS,CAACU,SAAS;;GAAC,IAAAV,WAAA;AAAA,WAAA;iDACjDzB,oBAAI;yEAELe,SAAS,IAAI,gBAAgBE,MAAMmB,QAAQC,MAAMtB,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAED6C,cAAY,EAAA,IAACC,WAAQ;AAAA,aAAE/C,QAAQW;QAAQ,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAA"}
+{"version":3,"file":"help.cjs","names":["code","computed","For","Show","ReflectionKind","usePowerlines","Usage","getAppBin","sortOptions","kebabCase","snakeCase","useTheme","HelpUsage","props","command","indent","context","theme","_$createComponent","each","Object","keys","config","bin","hardline","children","_$memo","padding","app","_$createIntrinsic","HelpOptions","options","option","flags","names","name","length","push","alias","forEach","sort","join","kind","string","variadic","number","description","replace","env","default","undefined","envPrefix","JSON","stringify","HelpCommands","commands","values","child","BaseHelp","filterGlobalOptions","filter","some","globalOption","includes","when","value","VirtualHelp","path","doubleHardline","joiner","ender","title","isVirtual","segments","CommandHelp"],"sources":["../../src/components/help.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { Usage } from \"@shell-shock/core/components/usage\";\nimport { getAppBin } from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport { sortOptions } from \"@shell-shock/core/plugin-utils/reflect\";\nimport type {\n  CommandOption,\n  CommandTree,\n  CommandTreePath\n} from \"@shell-shock/core/types/command\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { useTheme } from \"../contexts\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\n\nexport interface HelpUsageProps {\n  /**\n   * The command to generate help for.\n   */\n  command: CommandTree;\n\n  /**\n   * The padding scale to apply to the help display headings.\n   *\n   * @remarks\n   * This value is multiplied by the theme's app padding to determine the final padding.\n   *\n   * @defaultValue 2\n   */\n  indent?: number;\n}\n\n/**\n * A component that generates the usage display for a command.\n */\nexport function HelpUsage(props: HelpUsageProps) {\n  const { command, indent = 2 } = props;\n\n  const context = usePowerlines<ScriptPresetContext>();\n  const theme = useTheme();\n\n  return (\n    <For each={Object.keys(context.config.bin)} hardline>\n      {bin => (\n        <>\n          {code`\n      writeLine(\n        colors.text.body.primary(\"`}\n          <Usage bin={bin} command={command} />\n          {code`\"), { padding: ${theme.padding.app * indent} }\n      );`}\n          <hbr />\n        </>\n      )}\n    </For>\n  );\n}\n\nexport interface HelpOptionsProps {\n  /**\n   * The options to display help for.\n   */\n  options: CommandOption[];\n}\n\n/**\n * A component that generates the options table display for a command.\n */\nexport function HelpOptions(props: HelpOptionsProps) {\n  const { options } = props;\n\n  const context = usePowerlines<ScriptPresetContext>();\n\n  return (\n    <>\n      {code`table([ `}\n      <hbr />\n      <For each={sortOptions(options)} hardline>\n        {option => {\n          const flags = [] as string[];\n          const names = [] as string[];\n          if (option.name.length === 1) {\n            flags.push(`-${option.name}`);\n          } else {\n            names.push(`--${kebabCase(option.name)}`);\n          }\n\n          option.alias.forEach((alias: string) => {\n            if (alias.length === 1) {\n              flags.push(`-${alias}`);\n            } else {\n              names.push(`--${kebabCase(alias)}`);\n            }\n          });\n\n          return code`[{ value: colors.text.body.primary(\"${\n            flags.length > 0\n              ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n              : \"\"\n          }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n            option.kind === ReflectionKind.string\n              ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n              : option.kind === ReflectionKind.number\n                ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n                : \"\"\n          }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${option.description.replace(\n            /\\.+$/,\n            \"\"\n          )} ${\n            option.env || option.default !== undefined\n              ? `(${\n                  option.env\n                    ? `env: ${context.config.envPrefix}_${option.env}${\n                        option.default !== undefined ? \", \" : \"\"\n                      }`\n                    : \"\"\n                }${\n                  option.default !== undefined\n                    ? `default: ${JSON.stringify(option.default)}`\n                    : \"\"\n                })`\n              : \"\"\n          }.\"), align: \"left\", border: \"none\" }], `;\n        }}\n      </For>\n      <hbr />\n      {code` ]); `}\n    </>\n  );\n}\n\nexport interface HelpCommandsProps {\n  /**\n   * A mapping of command names to their command definitions.\n   */\n  commands: Record<string, CommandTree>;\n}\n\n/**\n * A component that generates the commands table display for a command.\n */\nexport function HelpCommands(props: HelpCommandsProps) {\n  const { commands } = props;\n\n  return (\n    <>\n      {code`table([ `}\n      <hbr />\n      <For each={Object.values(commands)} hardline>\n        {child =>\n          code`[{ value: colors.text.body.primary(\"${\n            child.name\n          }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${child.description.replace(\n            /\\.+$/,\n            \"\"\n          )}\"), align: \"left\", border: \"none\" }], `\n        }\n      </For>\n      <hbr />\n      {code` ]); `}\n    </>\n  );\n}\n\nexport interface BaseHelpProps {\n  /**\n   * The command to generate help for.\n   */\n  command: CommandTree;\n\n  /**\n   * Whether to filter out global options from the help display.\n   *\n   * @remarks\n   * 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.\n   *\n   * @defaultValue false\n   */\n  filterGlobalOptions?: boolean;\n\n  /**\n   * The padding scale to apply to the help display headings.\n   *\n   * @remarks\n   * This value is multiplied by the theme's app padding to determine the final padding.\n   *\n   * @defaultValue 1\n   */\n  indent?: number;\n}\n\n/**\n * A component that generates the `help` function declaration for a command.\n */\nexport function BaseHelp(props: BaseHelpProps) {\n  const { command, indent = 1, filterGlobalOptions = false } = props;\n\n  const theme = useTheme();\n  const context = usePowerlines<ScriptPresetContext>();\n\n  const options = computed(() =>\n    filterGlobalOptions\n      ? Object.values(command.options).filter(\n          option =>\n            !context.options.some(\n              globalOption =>\n                globalOption.name === option.name ||\n                option.alias.includes(globalOption.name) ||\n                globalOption.alias?.includes(option.name) ||\n                globalOption.alias?.some(alias => option.alias.includes(alias))\n            )\n        )\n      : Object.values(command.options)\n  );\n\n  return (\n    <>\n      {code`writeLine(colors.bold(colors.text.heading.secondary(\"Usage:\"))${\n        indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n      });`}\n      <hbr />\n      <HelpUsage command={command} indent={indent} />\n      <hbr />\n      <hbr />\n      <Show when={options.value.length > 0}>\n        {code`writeLine(\"\");\n      writeLine(colors.bold(colors.text.heading.secondary(\"Options:\"))${\n        indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n      });`}\n        <hbr />\n        <HelpOptions options={options.value} />\n        <hbr />\n        <hbr />\n      </Show>\n      <Show when={Object.keys(command.children).length > 0}>\n        {code`writeLine(\"\");\n      writeLine(colors.bold(colors.text.heading.secondary(\"Commands:\"))${\n        indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n      });`}\n        <hbr />\n        <HelpCommands commands={command.children} />\n        <hbr />\n        <hbr />\n      </Show>\n    </>\n  );\n}\n\nexport interface VirtualHelpProps {\n  /**\n   * The options to display help for.\n   */\n  options: CommandOption[];\n\n  /**\n   * A mapping of command names to their command definitions.\n   */\n  commands: Record<string, CommandTree>;\n\n  /**\n   * The command path to generate help for, used for generating the help invocation instructions.\n   *\n   * @remarks\n   * 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).\n   */\n  path?: CommandTreePath;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function VirtualHelp(props: VirtualHelpProps) {\n  const { options, path, commands } = props;\n\n  const context = usePowerlines<ScriptPresetContext>();\n\n  return (\n    <>\n      {code`\n      writeLine(\"\"); `}\n      <hbr />\n      <hbr />\n      {code`writeLine(colors.bold(colors.text.heading.secondary(\"Global Options:\")));`}\n      <hbr />\n      <HelpOptions options={options} />\n      {code`writeLine(\"\"); `}\n      <hbr />\n      <hbr />\n      <Show when={Object.keys(commands).length > 0}>\n        {code`writeLine(colors.text.body.secondary(\"The following commands are available:\"));\n        writeLine(\"\"); `}\n        <hbr />\n        <hbr />\n        <For\n          each={Object.values(commands)}\n          doubleHardline\n          joiner={code`writeLine(\"\"); `}\n          ender={code`writeLine(\"\"); `}>\n          {child => (\n            <>\n              {code`\n                writeLine(colors.text.heading.primary(\"${child.title} ${\n                  child.isVirtual ? \"\" : \"Command\"\n                }\"));\n                writeLine(\"\");\n                writeLine(colors.text.body.secondary(\"${child.description}\"));\n                writeLine(\"\");\n                `}\n              <hbr />\n              <BaseHelp command={child} indent={2} filterGlobalOptions />\n              <hbr />\n            </>\n          )}\n        </For>\n        {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n          context\n        )}${\n          path?.segments && path.segments.length > 0\n            ? ` ${path.segments.join(\" \")}`\n            : \"\"\n        } <specific command> --help') will provide additional information that is specific to that command.\");\n        writeLine(\"\");`}\n      </Show>\n    </>\n  );\n}\n\nexport interface CommandHelpProps {\n  /**\n   * A mapping of command names to their command definitions.\n   */\n  command: CommandTree;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function CommandHelp(props: CommandHelpProps) {\n  const { command } = props;\n\n  const context = usePowerlines<ScriptPresetContext>();\n\n  return (\n    <>\n      {code`writeLine(\"\"); `}\n      <hbr />\n      <hbr />\n      <BaseHelp command={command} filterGlobalOptions={false} />\n      {code`writeLine(\"\"); `}\n      <hbr />\n      <hbr />\n      <Show when={Object.keys(command.children).length > 0}>\n        {code`writeLine(colors.text.body.secondary(\"The following sub-commands are available:\"));\n        writeLine(\"\"); `}\n        <hbr />\n        <hbr />\n        <For\n          each={Object.values(command.children)}\n          doubleHardline\n          joiner={code`writeLine(\"\"); `}\n          ender={code`writeLine(\"\"); `}>\n          {child => (\n            <>\n              {code`\n                writeLine(colors.text.heading.primary(\"${child.title} ${\n                  child.isVirtual ? \"\" : \"Command\"\n                }\"));\n                writeLine(\"\");\n                writeLine(colors.text.body.secondary(\"${child.description}\"));\n                writeLine(\"\");\n                `}\n              <hbr />\n              <BaseHelp command={child} indent={2} filterGlobalOptions />\n              <hbr />\n            </>\n          )}\n        </For>\n        {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n          context\n        )} ${command.path.segments.join(\" \")} <specific command> --help') will provide additional information that is specific to that command.\");\n        writeLine(\"\");`}\n      </Show>\n    </>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAsDA,SAAgBY,UAAUC,OAAuB;CAC/C,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMG,8EAA8C;CACpD,MAAMC,QAAQN,iCAAU;AAExB,yDACGT,qBAAG;EAAA,IAACiB,OAAI;AAAA,UAAEC,OAAOC,KAAKL,QAAQM,OAAOC,IAAI;;EAAEC,UAAQ;EAAAC,WACjDF,QAAG;GAECvB,oBAAI;;;oDAGJM,2CAAK;IAAMiB;IAAcT;IAAO,CAAA;+CAChCd,oBAAI,kBAAkBiB,MAAMU,QAAQC,MAAMb,OAAM;UAClD;oDAAA,OAAA,EAAA,CAAA;GAAA;EAGF,CAAA;;;;;AAeP,SAAgBe,YAAYjB,OAAyB;CACnD,MAAM,EAAEkB,YAAYlB;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,oEAAcY,QAAQ;;GAAEP,UAAQ;GAAAC,WACtCO,WAAU;IACT,MAAMC,QAAQ,EAAc;IAC5B,MAAMC,QAAQ,EAAc;AAC5B,QAAIF,OAAOG,KAAKC,WAAW,EACzBH,OAAMI,KAAK,IAAIL,OAAOG,OAAO;QAE7BD,OAAMG,KAAK,sDAAeL,OAAOG,KAAK,GAAG;AAG3CH,WAAOM,MAAMC,SAASD,UAAkB;AACtC,SAAIA,MAAMF,WAAW,EACnBH,OAAMI,KAAK,IAAIC,QAAQ;SAEvBJ,OAAMG,KAAK,sDAAeC,MAAM,GAAG;MAErC;AAEF,WAAOtC,oBAAI,uCACTiC,MAAMG,SAAS,IACX,GAAGH,MAAMO,MAAM,CAACC,KAAK,KAAK,GAAGP,MAAME,SAAS,IAAI,OAAO,OACvD,KACHF,MAAME,SAAS,IAAIF,MAAMM,MAAM,CAACC,KAAK,KAAK,GAAG,KAC9CT,OAAOU,SAAStC,gDAAeuC,SAC3B,sDAAeX,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1DZ,OAAOU,SAAStC,gDAAeyC,SAC7B,sDAAeb,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1D,GAAE,4EACmEZ,OAAOc,YAAYC,QAC9F,QACA,GACD,CAAA,GACCf,OAAOgB,OAAOhB,OAAOiB,YAAYC,SAC7B,IACElB,OAAOgB,MACH,QAAQhC,QAAQM,OAAO6B,UAAS,GAAInB,OAAOgB,MACzChB,OAAOiB,YAAYC,SAAY,OAAO,OAExC,KAEJlB,OAAOiB,YAAYC,SACf,YAAYE,KAAKC,UAAUrB,OAAOiB,QAAQ,KAC1C,GAAE,KAER,GAAE;;GAET,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGFjD,oBAAI;EAAO;;;;;AAelB,SAAgBsD,aAAazC,OAA0B;CACrD,MAAM,EAAE0C,aAAa1C;AAErB,QAAA;EAEKb,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,WAAEC,OAAOoC,OAAOD,SAAS;;GAAE/B,UAAQ;GAAAC,WACzCgC,UACCzD,oBAAI,uCACFyD,MAAMtB,KAAI,4EACiEsB,MAAMX,YAAYC,QAC7F,QACA,GACD,CAAA;GAAwC,CAAA;mDAAA,OAAA,EAAA,CAAA;EAI5C/C,oBAAI;EAAO;;;;;AAmClB,SAAgB0D,SAAS7C,OAAsB;CAC7C,MAAM,EAAEC,SAASC,SAAS,GAAG4C,sBAAsB,UAAU9C;CAE7D,MAAMI,QAAQN,iCAAU;CACxB,MAAMK,8EAA8C;CAEpD,MAAMe,8CACJ4B,sBACIvC,OAAOoC,OAAO1C,QAAQiB,QAAQ,CAAC6B,QAC7B5B,WACE,CAAChB,QAAQe,QAAQ8B,MACfC,iBACEA,aAAa3B,SAASH,OAAOG,QAC7BH,OAAOM,MAAMyB,SAASD,aAAa3B,KAAK,IACxC2B,aAAaxB,OAAOyB,SAAS/B,OAAOG,KAAK,IACzC2B,aAAaxB,OAAOuB,MAAKvB,UAASN,OAAOM,MAAMyB,SAASzB,MAAM,CAClE,CACJ,CAAC,GACDlB,OAAOoC,OAAO1C,QAAQiB,QAC5B,CAAC;AAED,QAAA;8CAEK/B,oBAAI,iEACHe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;mDAAA,OAAA,EAAA,CAAA;mDAEHH,WAAS;GAAUE;GAAiBC;GAAM,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAG1CZ,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAEjC,QAAQkC,MAAM7B,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;iDACjCzB,oBAAI;wEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDe,aAAW,EAAA,IAACC,UAAO;AAAA,aAAEA,QAAQkC;QAAK,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;mDAIpC9D,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;iDACjDzB,oBAAI;yEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDuC,cAAY,EAAA,IAACC,WAAQ;AAAA,aAAEzC,QAAQW;QAAQ,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAA;;;;;AA+BhD,SAAgByC,YAAYrD,OAAyB;CACnD,MAAM,EAAEkB,SAASoC,MAAMZ,aAAa1C;CAEpC,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;;mDACW,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGfA,oBAAI;mDAA2E,OAAA,EAAA,CAAA;mDAE/E8B,aAAW,EAAUC,SAAO,CAAA;EAC5B/B,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrBG,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKkC,SAAS,CAACnB,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACzCzB,oBAAI;;sDACW,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAGfE,qBAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAOD,SAAS;;MAC7Ba,gBAAc;MACdC,QAAQrE,oBAAI;MACZsE,OAAOtE,oBAAI;MAAiByB,WAC3BgC,UAAK;mDAEDzD,oBAAI;yDACsCyD,MAAMc,MAAK,GAClDd,MAAMe,YAAY,KAAK,UAAS;;wDAGMf,MAAMX,YAAW;;kBAExD;wDAAA,OAAA,EAAA,CAAA;wDAEFY,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;wDAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;iDAEF3D,oBAAI,6HACHgB,QACD,GACCmD,MAAMM,YAAYN,KAAKM,SAASrC,SAAS,IACrC,IAAI+B,KAAKM,SAAShC,KAAK,IAAI,KAC3B,GAAE;wBAEO;KAAA;;GAAA,CAAA;EAAA;;;;;AAgBvB,SAAgBiC,YAAY7D,OAAyB;CACnD,MAAM,EAAEC,YAAYD;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrB0D,UAAQ;GAAU5C;GAAS6C,qBAAqB;GAAK,CAAA;EACrD3D,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrBG,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACjDzB,oBAAI;;sDACW,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAGfE,qBAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAO1C,QAAQW,SAAS;;MACrC2C,gBAAc;MACdC,QAAQrE,oBAAI;MACZsE,OAAOtE,oBAAI;MAAiByB,WAC3BgC,UAAK;mDAEDzD,oBAAI;yDACsCyD,MAAMc,MAAK,GAClDd,MAAMe,YAAY,KAAK,UAAS;;wDAGMf,MAAMX,YAAW;;kBAExD;wDAAA,OAAA,EAAA,CAAA;wDAEFY,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;wDAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;iDAEF3D,oBAAI,6HACHgB,QACD,CAAA,GAAIF,QAAQqD,KAAKM,SAAShC,KAAK,IAAI,CAAA;wBACrB;KAAA;;GAAA,CAAA;EAAA"}

package/dist/components/help.d.cts

@@ -1,5 +1,5 @@
-import * as _alloy_js_core16 from "@alloy-js/core";
-import { CommandOption, CommandTree } from "@shell-shock/core/types/command";
+import * as _alloy_js_core5 from "@alloy-js/core";
+import { CommandOption, CommandTree, CommandTreePath } from "@shell-shock/core/types/command";
 
 //#region src/components/help.d.ts
 interface HelpUsageProps {
@@ -20,7 +20,7 @@ interface HelpUsageProps {
 /**
  * A component that generates the usage display for a command.
  */
-declare function HelpUsage(props: HelpUsageProps): _alloy_js_core16.Children;
+declare function HelpUsage(props: HelpUsageProps): _alloy_js_core5.Children;
 interface HelpOptionsProps {
   /**
    * The options to display help for.
@@ -30,7 +30,7 @@ interface HelpOptionsProps {
 /**
  * A component that generates the options table display for a command.
  */
-declare function HelpOptions(props: HelpOptionsProps): _alloy_js_core16.Children;
+declare function HelpOptions(props: HelpOptionsProps): _alloy_js_core5.Children;
 interface HelpCommandsProps {
   /**
    * A mapping of command names to their command definitions.
@@ -40,12 +40,21 @@ interface HelpCommandsProps {
 /**
  * A component that generates the commands table display for a command.
  */
-declare function HelpCommands(props: HelpCommandsProps): _alloy_js_core16.Children;
-interface HelpProps {
+declare function HelpCommands(props: HelpCommandsProps): _alloy_js_core5.Children;
+interface BaseHelpProps {
   /**
    * 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.
    *
@@ -59,7 +68,38 @@ interface HelpProps {
 /**
  * A component that generates the `help` function declaration for a command.
  */
-declare function Help(props: HelpProps): _alloy_js_core16.Children;
+declare function BaseHelp(props: BaseHelpProps): _alloy_js_core5.Children;
+interface VirtualHelpProps {
+  /**
+   * 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).
+   */
+  path?: CommandTreePath;
+}
+/**
+ * A component that generates the invocation of the `help` function for a command.
+ */
+declare function VirtualHelp(props: VirtualHelpProps): _alloy_js_core5.Children;
+interface CommandHelpProps {
+  /**
+   * 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 CommandHelp(props: CommandHelpProps): _alloy_js_core5.Children;
 //#endregion
-export { Help, HelpCommands, HelpCommandsProps, HelpOptions, HelpOptionsProps, HelpProps, HelpUsage, HelpUsageProps };
+export { BaseHelp, BaseHelpProps, CommandHelp, CommandHelpProps, HelpCommands, HelpCommandsProps, HelpOptions, HelpOptionsProps, HelpUsage, HelpUsageProps, VirtualHelp, VirtualHelpProps };
 //# sourceMappingURL=help.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"help.d.cts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAmCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAiCR;AAUjB;AA+DA;AAUA;AAuBA;AAoBA;;;;;;;;iBA/JgB,SAAA,QAAiB,iBAAc,gBAAA,CAAA;UAiC9B,gBAAA;;;;WAIN;;;;;iBAMK,WAAA,QAAmB,mBAAgB,gBAAA,CAAA;UA+DlC,iBAAA;;;;YAIL,eAAe;;;;;iBAMX,YAAA,QAAoB,oBAAiB,gBAAA,CAAA;UAuBpC,SAAA;;;;WAIN;;;;;;;;;;;;;;iBAgBK,IAAA,QAAY,YAAS,gBAAA,CAAA"}
+{"version":3,"file":"help.d.cts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAkCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAuBR;AAUjB;AA+DA;AAUA;AAuBA;AA8BA;AAsDA;;EAS2B,MAAA,CAAA,EAAA,MAAA;;;;AAc3B;AAwDiB,iBApSD,SAAA,CAoSiB,KAItB,EAxSsB,cAwSX,CAAA,EAxSyB,eAAA,CAAA,QAwSzB;AAMN,UAvRC,gBAAA,CAuRkB;;;;WAnRxB;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA+DlC,iBAAA;;;;YAIL,eAAe;;;;;iBAMX,YAAA,QAAoB,oBAAiB,eAAA,CAAA;UAuBpC,aAAA;;;;WAIN;;;;;;;;;;;;;;;;;;;;;;;iBA0BK,QAAA,QAAgB,gBAAa,eAAA,CAAA;UAsD5B,gBAAA;;;;WAIN;;;;YAKC,eAAe;;;;;;;SAQlB;;;;;iBAMO,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UAwDlC,gBAAA;;;;WAIN;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA"}

package/dist/components/help.d.mts

@@ -1,5 +1,5 @@
-import * as _alloy_js_core7 from "@alloy-js/core";
-import { CommandOption, CommandTree } from "@shell-shock/core/types/command";
+import * as _alloy_js_core5 from "@alloy-js/core";
+import { CommandOption, CommandTree, CommandTreePath } from "@shell-shock/core/types/command";
 
 //#region src/components/help.d.ts
 interface HelpUsageProps {
@@ -20,7 +20,7 @@ interface HelpUsageProps {
 /**
  * A component that generates the usage display for a command.
  */
-declare function HelpUsage(props: HelpUsageProps): _alloy_js_core7.Children;
+declare function HelpUsage(props: HelpUsageProps): _alloy_js_core5.Children;
 interface HelpOptionsProps {
   /**
    * The options to display help for.
@@ -30,7 +30,7 @@ interface HelpOptionsProps {
 /**
  * A component that generates the options table display for a command.
  */
-declare function HelpOptions(props: HelpOptionsProps): _alloy_js_core7.Children;
+declare function HelpOptions(props: HelpOptionsProps): _alloy_js_core5.Children;
 interface HelpCommandsProps {
   /**
    * A mapping of command names to their command definitions.
@@ -40,12 +40,21 @@ interface HelpCommandsProps {
 /**
  * A component that generates the commands table display for a command.
  */
-declare function HelpCommands(props: HelpCommandsProps): _alloy_js_core7.Children;
-interface HelpProps {
+declare function HelpCommands(props: HelpCommandsProps): _alloy_js_core5.Children;
+interface BaseHelpProps {
   /**
    * 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.
    *
@@ -59,7 +68,38 @@ interface HelpProps {
 /**
  * A component that generates the `help` function declaration for a command.
  */
-declare function Help(props: HelpProps): _alloy_js_core7.Children;
+declare function BaseHelp(props: BaseHelpProps): _alloy_js_core5.Children;
+interface VirtualHelpProps {
+  /**
+   * 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).
+   */
+  path?: CommandTreePath;
+}
+/**
+ * A component that generates the invocation of the `help` function for a command.
+ */
+declare function VirtualHelp(props: VirtualHelpProps): _alloy_js_core5.Children;
+interface CommandHelpProps {
+  /**
+   * 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 CommandHelp(props: CommandHelpProps): _alloy_js_core5.Children;
 //#endregion
-export { Help, HelpCommands, HelpCommandsProps, HelpOptions, HelpOptionsProps, HelpProps, HelpUsage, HelpUsageProps };
+export { BaseHelp, BaseHelpProps, CommandHelp, CommandHelpProps, HelpCommands, HelpCommandsProps, HelpOptions, HelpOptionsProps, HelpUsage, HelpUsageProps, VirtualHelp, VirtualHelpProps };
 //# sourceMappingURL=help.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"help.d.mts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAmCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAiCR;AAUjB;AA+DA;AAUA;AAuBA;AAoBA;;;;;;;;iBA/JgB,SAAA,QAAiB,iBAAc,eAAA,CAAA;UAiC9B,gBAAA;;;;WAIN;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA+DlC,iBAAA;;;;YAIL,eAAe;;;;;iBAMX,YAAA,QAAoB,oBAAiB,eAAA,CAAA;UAuBpC,SAAA;;;;WAIN;;;;;;;;;;;;;;iBAgBK,IAAA,QAAY,YAAS,eAAA,CAAA"}
+{"version":3,"file":"help.d.mts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAkCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAuBR;AAUjB;AA+DA;AAUA;AAuBA;AA8BA;AAsDA;;EAS2B,MAAA,CAAA,EAAA,MAAA;;;;AAc3B;AAwDiB,iBApSD,SAAA,CAoSiB,KAItB,EAxSsB,cAwSX,CAAA,EAxSyB,eAAA,CAAA,QAwSzB;AAMN,UAvRC,gBAAA,CAuRkB;;;;WAnRxB;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA+DlC,iBAAA;;;;YAIL,eAAe;;;;;iBAMX,YAAA,QAAoB,oBAAiB,eAAA,CAAA;UAuBpC,aAAA;;;;WAIN;;;;;;;;;;;;;;;;;;;;;;;iBA0BK,QAAA,QAAgB,gBAAa,eAAA,CAAA;UAsD5B,gBAAA;;;;WAIN;;;;YAKC,eAAe;;;;;;;SAQlB;;;;;iBAMO,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UAwDlC,gBAAA;;;;WAIN;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA"}

package/dist/components/help.mjs

@@ -2,9 +2,10 @@ import { useTheme } from "../contexts/theme.mjs";
 import "../contexts/index.mjs";
 import { createComponent, createIntrinsic, memo } from "@alloy-js/core/jsx-runtime";
 import { For, Show, code, computed } from "@alloy-js/core";
-import { getVariableCommandPathName, isVariableCommandPath } from "@shell-shock/core/plugin-utils/context-helpers";
 import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
+import { getAppBin } from "@shell-shock/core/plugin-utils/context-helpers";
 import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { Usage } from "@shell-shock/core/components/usage";
 import { sortOptions } from "@shell-shock/core/plugin-utils/reflect";
 import { kebabCase } from "@stryke/string-format/kebab-case";
 import { snakeCase } from "@stryke/string-format/snake-case";
@@ -22,12 +23,18 @@ function HelpUsage(props) {
 			return Object.keys(context.config.bin);
 		},
 		hardline: true,
-		children: (bin) => [memo(() => code`
+		children: (bin) => [
+			code`
       writeLine(
-        colors.text.body.primary(
-          "$ npx ${bin} ${command.path.segments.map((segment) => isVariableCommandPath(segment) ? `<${command.path.variables[segment]?.variadic ? "..." : ""}${kebabCase(getVariableCommandPathName(segment))}>` : segment).join(" ")}${Object.values(command.children).length > 0 ? " [commands]" : ""} [options]"
-        ), { padding: ${theme.padding.app * indent} }
-      );`), createIntrinsic("hbr", {})]
+        colors.text.body.primary("`,
+			createComponent(Usage, {
+				bin,
+				command
+			}),
+			memo(() => code`"), { padding: ${theme.padding.app * indent} }
+      );`),
+			createIntrinsic("hbr", {})
+		]
 	});
 }
 /**
@@ -82,11 +89,11 @@ function HelpCommands(props) {
 /**
 * A component that generates the `help` function declaration for a command.
 */
-function Help(props) {
-	const { command, indent = 1 } = props;
+function BaseHelp(props) {
+	const { command, indent = 1, filterGlobalOptions = false } = props;
 	const theme = useTheme();
 	const context = usePowerlines();
-	const options = computed(() => 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)))) ?? []);
+	const options = 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 [
 		memo(() => code`writeLine(colors.bold(colors.text.heading.secondary("Usage:"))${indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : ""});`),
 		createIntrinsic("hbr", {}),
@@ -132,7 +139,121 @@ function Help(props) {
 		})
 	];
 }
+/**
+* A component that generates the invocation of the `help` function for a command.
+*/
+function VirtualHelp(props) {
+	const { options, path, commands } = props;
+	const context = usePowerlines();
+	return [
+		code`
+      writeLine(""); `,
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		code`writeLine(colors.bold(colors.text.heading.secondary("Global Options:")));`,
+		createIntrinsic("hbr", {}),
+		createComponent(HelpOptions, { options }),
+		code`writeLine(""); `,
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		createComponent(Show, {
+			get when() {
+				return Object.keys(commands).length > 0;
+			},
+			get children() {
+				return [
+					code`writeLine(colors.text.body.secondary("The following commands are available:"));
+        writeLine(""); `,
+					createIntrinsic("hbr", {}),
+					createIntrinsic("hbr", {}),
+					createComponent(For, {
+						get each() {
+							return Object.values(commands);
+						},
+						doubleHardline: true,
+						joiner: code`writeLine(""); `,
+						ender: code`writeLine(""); `,
+						children: (child) => [
+							memo(() => code`
+                writeLine(colors.text.heading.primary("${child.title} ${child.isVirtual ? "" : "Command"}"));
+                writeLine("");
+                writeLine(colors.text.body.secondary("${child.description}"));
+                writeLine("");
+                `),
+							createIntrinsic("hbr", {}),
+							createComponent(BaseHelp, {
+								command: child,
+								indent: 2,
+								filterGlobalOptions: true
+							}),
+							createIntrinsic("hbr", {})
+						]
+					}),
+					memo(() => code`help("Running a specific command with the help flag (via: '${getAppBin(context)}${path?.segments && path.segments.length > 0 ? ` ${path.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 CommandHelp(props) {
+	const { command } = props;
+	const context = usePowerlines();
+	return [
+		code`writeLine(""); `,
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		createComponent(BaseHelp, {
+			command,
+			filterGlobalOptions: false
+		}),
+		code`writeLine(""); `,
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		createComponent(Show, {
+			get when() {
+				return Object.keys(command.children).length > 0;
+			},
+			get children() {
+				return [
+					code`writeLine(colors.text.body.secondary("The following sub-commands are available:"));
+        writeLine(""); `,
+					createIntrinsic("hbr", {}),
+					createIntrinsic("hbr", {}),
+					createComponent(For, {
+						get each() {
+							return Object.values(command.children);
+						},
+						doubleHardline: true,
+						joiner: code`writeLine(""); `,
+						ender: code`writeLine(""); `,
+						children: (child) => [
+							memo(() => code`
+                writeLine(colors.text.heading.primary("${child.title} ${child.isVirtual ? "" : "Command"}"));
+                writeLine("");
+                writeLine(colors.text.body.secondary("${child.description}"));
+                writeLine("");
+                `),
+							createIntrinsic("hbr", {}),
+							createComponent(BaseHelp, {
+								command: child,
+								indent: 2,
+								filterGlobalOptions: true
+							}),
+							createIntrinsic("hbr", {})
+						]
+					}),
+					memo(() => code`help("Running a specific command with the help flag (via: '${getAppBin(context)} ${command.path.segments.join(" ")} <specific command> --help') will provide additional information that is specific to that command.");
+        writeLine("");`)
+				];
+			}
+		})
+	];
+}
 
 //#endregion
-export { Help, HelpCommands, HelpOptions, HelpUsage };
+export { BaseHelp, CommandHelp, HelpCommands, HelpOptions, HelpUsage, VirtualHelp };
 //# sourceMappingURL=help.mjs.map