npm - @shell-shock/plugin-help - Versions diffs - 0.2.25 → 0.2.28 - Mend

@shell-shock/plugin-help 0.2.25 → 0.2.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/dist/components/display.cjs +1 -1
package/dist/components/display.mjs +1 -1
package/dist/components/display.mjs.map +1 -1
package/dist/components/help-builtin.mjs.map +1 -1
package/dist/components/help-command.cjs +2 -2
package/dist/components/help-command.d.cts +1 -1
package/dist/components/help-command.d.mts +1 -1
package/dist/components/help-command.mjs +2 -2
package/dist/components/help-command.mjs.map +1 -1
package/dist/index.cjs +1 -1
package/dist/index.mjs +1 -1
package/dist/index.mjs.map +1 -1
package/package.json +15 -15

package/dist/components/display.cjs CHANGED Viewed

@@ -99,7 +99,7 @@ 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));
+	const options = (0, _alloy_js_core.computed)(() => filterGlobalOptions ? Object.values(command.options).filter((option) => !context.globalOptions.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(bold(textColors.heading.secondary("Usage:"))${indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : ""});`),
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),

package/dist/components/display.mjs CHANGED Viewed

@@ -97,7 +97,7 @@ function BaseHelpDisplay(props) {
 	const { command, indent = 1, filterGlobalOptions = false } = props;
 	const theme = useTheme();
 	const context = usePowerlines();
-	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));
+	const options = computed(() => filterGlobalOptions ? Object.values(command.options).filter((option) => !context.globalOptions.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(bold(textColors.heading.secondary("Usage:"))${indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : ""});`),
 		createIntrinsic("hbr", {}),

package/dist/components/display.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"display.mjs","names":[],"sources":["../../src/components/display.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 { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { CommandOption, CommandTree } from \"@shell-shock/core\";\nimport { CommandParameterKinds } from \"@shell-shock/core\";\nimport {\n formatDescription,\n formatShortDescription,\n getAppBin,\n getAppTitle,\n getDynamicPathSegmentName,\n isDynamicPathSegment,\n sortOptions\n} from \"@shell-shock/core/plugin-utils\";\nimport { useTheme } from \"@shell-shock/plugin-theme/contexts/theme\";\nimport { camelCase } from \"@stryke/string-format/camel-case\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport type { HelpPluginContext } from \"../types/plugin\";\n\nexport interface HelpUsageDisplayProps {\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 HelpUsageDisplay(props: HelpUsageDisplayProps) {\n const { command, indent = 2 } = props;\n\n const context = usePowerlines<HelpPluginContext>();\n const theme = useTheme();\n\n return (\n <>\n {code`\n writeLine(\n textColors.body.secondary(\\`\\${textColors.usage.bin(\"$_ ${getAppBin(\n context\n )}\")}${\n command.segments.length > 0\n ? ` ${command.segments\n .map(\n segment =>\n `\\${textColors.usage.${\n isDynamicPathSegment(segment) ? \"dynamic\" : \"command\"\n }(\"${\n isDynamicPathSegment(segment)\n ? `[${snakeCase(getDynamicPathSegmentName(segment))}]`\n : segment\n }\")}`\n )\n .join(\" \")}`\n : \"\"\n }${\n Object.values(command.children).length > 0\n ? ` \\${textColors.usage.dynamic(\"[command]\")}`\n : \"\"\n }${\n command.args.length > 0\n ? ` ${command.args\n .map(\n arg =>\n `\\${textColors.usage.args(\"<${snakeCase(\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.choices &&\n arg.choices.length > 0\n ? arg.choices.join(\"\|\")\n : arg.kind === CommandParameterKinds.string &&\n arg.format\n ? arg.format\n : arg.name\n )}${\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.variadic\n ? \"...\"\n : \"\"\n }>\")}`\n )\n .join(\" \")}`\n : \"\"\n } \\${textColors.usage.options(\"[options]\")}\\`), { padding: ${\n theme.padding.app indent\n } }\n );`}\n <hbr />\n <Show when={command.args.length > 0}>\n <hbr />\n {code`\n writeLine(\n textColors.body.secondary(\\`\\${textColors.usage.bin(\"$_ ${getAppBin(context)}\")}${\n command.segments.length > 0\n ? ` ${command.segments\n .map(\n segment =>\n `\\${textColors.usage.${\n isDynamicPathSegment(segment) ? \"dynamic\" : \"command\"\n }(\"${\n isDynamicPathSegment(segment)\n ? `[${snakeCase(getDynamicPathSegmentName(segment))}]`\n : segment\n }\")}`\n )\n .join(\" \")}`\n : \"\"\n }${\n Object.values(command.children).length > 0\n ? ` \\${textColors.usage.dynamic(\"[command]\")}`\n : \"\"\n } \\${textColors.usage.options(\"[options]\")}${\n command.args.length > 0\n ? ` ${command.args\n .map(\n arg =>\n `\\${textColors.usage.args(\"<${snakeCase(\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.choices &&\n arg.choices.length > 0\n ? arg.choices.join(\"\|\")\n : arg.kind === CommandParameterKinds.string &&\n arg.format\n ? arg.format\n : arg.name\n )}${\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.variadic\n ? \"...\"\n : \"\"\n }>\")}`\n )\n .join(\" \")}`\n : \"\"\n }\\`), { padding: ${theme.padding.app * indent} }\n );`}\n <hbr />\n </Show>\n </>\n );\n}\n\nexport interface HelpOptionsDisplayProps {\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 HelpOptionsDisplay(props: HelpOptionsDisplayProps) {\n const { options } = props;\n\n const context = usePowerlines<HelpPluginContext>();\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: textColors.body.primary(\"${\n flags.length > 0\n ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n : \"\"\n }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n option.kind === CommandParameterKinds.string\n ? ` <${snakeCase(\n option.choices && option.choices.length > 0\n ? option.choices.join(\"\|\")\n : option.format\n ? option.format\n : option.name\n )}${option.variadic ? \"...\" : \"\"}>`\n : option.kind === CommandParameterKinds.number\n ? ` <${snakeCase(\n option.choices && option.choices.length > 0\n ? option.choices.join(\"\|\")\n : option.name\n )}${option.variadic ? \"...\" : \"\"}>`\n : \"\"\n }\"), align: \"right\", border: \"none\", maxWidth: \"1/3\" }, { value: textColors.body.tertiary(\\`${formatShortDescription(\n option.description,\n {\n length: 200\n }\n )\n .replace(/\\.+$/, \"\")\n .trim()}${\n option.env \|\| option.default !== undefined\n ? ` (${\n option.env\n ? `env: ${context.config.appSpecificEnvPrefix}_${\n option.env\n }${option.default !== undefined ? \", \" : \"\"}`\n : \"\"\n }${\n option.default !== undefined\n ? `default: ${JSON.stringify(option.default).replace(\n /\"/g,\n '\\\\\"'\n )}`\n : \"\"\n })`\n : \"\"\n }.\\`), align: \"left\", border: \"none\" }], `;\n }}\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface HelpCommandsDisplayProps {\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 HelpCommandsDisplay(props: HelpCommandsDisplayProps) {\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: textColors.body.primary(\"${\n child.name\n }\"), align: \"right\", border: \"none\" }, { value: textColors.body.tertiary(\\`${formatShortDescription(\n child.description,\n {\n length: 200\n }\n )\n .replace(/\\.+$/, \"\")\n .trim()}.\\`), align: \"left\", border: \"none\" }], `\n }\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface BaseHelpDisplayProps {\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 BaseHelpDisplay(props: BaseHelpDisplayProps) {\n const { command, indent = 1, filterGlobalOptions = false } = props;\n\n const theme = useTheme();\n const context = usePowerlines<HelpPluginContext>();\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(bold(textColors.heading.secondary(\"Usage:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app indent} }` : \"\"\n });`}\n <hbr />\n <HelpUsageDisplay command={command} indent={indent} />\n <Spacing />\n <Show when={options.value.length > 0}>\n {code`writeLine(\"\");\n writeLine(bold(textColors.heading.secondary(\"Options:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpOptionsDisplay options={options.value} />\n <Spacing />\n </Show>\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(\"\");\n writeLine(bold(textColors.heading.secondary(\"Commands:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpCommandsDisplay commands={command.children} />\n <Spacing />\n </Show>\n <Show when={isSetString(command.reference)}>\n {code`writeLine(\"\");\n writeLine(textColors.heading.tertiary(\\`More information about this command can be found in the reference documentation at \\${link(\"${\n command.reference\n }\")}\\`)${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <Spacing />\n </Show>\n </>\n );\n}\n\nexport interface VirtualCommandHelpDisplayProps {\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 segments?: string[];\n}\n\nfunction sortCommands(commands: Record<string, CommandTree>) {\n return Object.values(commands).sort((a, b) => {\n if (\n a.tags.some(tag => tag.toLowerCase() === \"deprecated\") &&\n !b.tags.some(tag => tag.toLowerCase() === \"deprecated\")\n ) {\n return 1;\n } else if (\n !a.tags.some(tag => tag.toLowerCase() === \"deprecated\") &&\n b.tags.some(tag => tag.toLowerCase() === \"deprecated\")\n ) {\n return -1;\n } else if (\n a.tags.some(tag => tag.toLowerCase() === \"experimental\") &&\n !b.tags.some(tag => tag.toLowerCase() === \"experimental\")\n ) {\n return 1;\n } else if (\n !a.tags.some(tag => tag.toLowerCase() === \"experimental\") &&\n b.tags.some(tag => tag.toLowerCase() === \"experimental\")\n ) {\n return -1;\n } else if (\n a.tags.some(tag => tag.toLowerCase() === \"utility\") &&\n !b.tags.some(tag => tag.toLowerCase() === \"utility\")\n ) {\n return 1;\n } else if (\n !a.tags.some(tag => tag.toLowerCase() === \"utility\") &&\n b.tags.some(tag => tag.toLowerCase() === \"utility\")\n ) {\n return -1;\n }\n\n return a.name.localeCompare(b.name);\n });\n}\n\n/\n A component that generates the invocation of the `help` function for a command.\n /\nexport function VirtualCommandHelpDisplay(\n props: VirtualCommandHelpDisplayProps\n) {\n const { options, segments, commands } = props;\n\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <>\n <hbr />\n {code`writeLine(bold(textColors.heading.secondary(\"Common Options:\")));`}\n <hbr />\n <HelpOptionsDisplay options={options} />\n {code`writeLine(\"\"); `}\n <Spacing />\n <Show when={Object.keys(commands).length > 0}>\n {code`writeLine(textColors.body.tertiary(\"The following commands are available through the ${getAppTitle(\n context,\n true\n )} command-line interface:\"));\n writeLine(\"\"); `}\n <Spacing />\n <For\n each={sortCommands(commands)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n <hbr />\n {code`\n writeLine(textColors.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\\`${child.title} ${child.isVirtual ? \"\" : \"Command\"}${\n child.tags?.length > 0\n ? ` - ${child.tags\n .map(\n tag =>\n `\\${textColors.tags.${camelCase(tag)} ? textColors.tags.${camelCase(tag)}(inverse(\" ${tag} \")) : textColors.tags.$default(inverse(\" ${tag} \"))}`\n )\n .join(\" \")}`\n : \"\"\n }\\`));\n writeLine(\"\");\n writeLine(textColors.body.tertiary(splitText(\\`${formatDescription(\n child.description\n )\n .replace(/\\.+$/, \"\")\n .trim()}.\\`)));\n writeLine(\"\"); `}\n <hbr />\n <BaseHelpDisplay command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\\`Running a specific command with the help flag (via: \\${inlineCode(\"${getAppBin(\n context\n )} ${\n segments && segments.length > 0 ? ` ${segments.join(\" \")}` : \"\"\n } <specific command> --help\")}) or the help command with the specific command as arguments (via: \\${inlineCode(\"${getAppBin(\n context\n )} ${\n segments && segments.length > 0 ? ` ${segments.join(\" \")}` : \"\"\n } help <specific command>\")}) will provide additional information that is specific to that command.\\`);\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n\nexport interface CommandHelpDisplayProps {\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 CommandHelpDisplay(props: CommandHelpDisplayProps) {\n const { command } = props;\n\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <>\n {code`writeLine(\"\"); `}\n <Spacing />\n <BaseHelpDisplay command={command} filterGlobalOptions={false} />\n {code`writeLine(\"\"); `}\n <Spacing />\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(textColors.body.tertiary(\"The following sub-commands are available:\"));\n writeLine(\"\"); `}\n <Spacing />\n <For\n each={sortCommands(command.children)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n <hbr />\n {code`\n writeLine(textColors.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\\`${child.title} ${child.isVirtual ? \"\" : \"Command\"}${\n child.tags?.length > 0\n ? ` - ${child.tags\n .map(\n tag =>\n `\\${textColors.tags.${camelCase(tag)} ? textColors.tags.${camelCase(tag)}(inverse(\" ${tag} \")) : textColors.tags.$default(inverse(\" ${tag} \"))}`\n )\n .join(\" \")}`\n : \"\"\n }\\`));\n writeLine(\"\");\n writeLine(textColors.body.tertiary(splitText(\\`${formatDescription(\n child.description\n )\n .replace(/\\.+$/, \"\")\n .trim()}.\\`)));\n writeLine(\"\"); `}\n <hbr />\n <BaseHelpDisplay command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\\`Running a specific command with the help flag (via: \\${inlineCode(\"${getAppBin(\n context\n )} ${command.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"],"mappings":";;;;;;;;;;;;;;;;AAmDA,SAAM,iBAAa,OAAA;CACjB,MAAE,EACF,SACF,SAAA;CAEE,MAAA,UAAA,eAAA;CACA,MAAG,QAAU,UAAK;AAClB,QAAA;EAAA,WAAA,IAAA;;kEAEqC,UAAA,QAAA,CAAA,KAAA,QAAA,SAAA,SAAA,IAAA,IAAA,QAAA,SAAA,KAAA,YAAA,uBAAA,qBAAA,QAAA,GAAA,YAAA,UAAA,IAAA,qBAAA,QAAA,GAAA,IAAA,UAAA,0BAAA,QAAA,CAAA,CAAA,KAAA,QAAA,KAAA,CAAA,KAAA,IAAA,KAAA,KAAA,OAAA,OAAA,QAAA,SAAA,CAAA,SAAA,IAAA,+CAAA,KAAA,QAAA,KAAA,SAAA,IAAA,IAAA,QAAA,KAAA,KAAA,QAAA,8BAAA,WAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,IAAA,QAAA,SAAA,IAAA,IAAA,QAAA,KAAA,IAAA,GAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,IAAA,SAAA,IAAA,KAAA,IAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,QAAA,GAAA,MAAA,CAAA,KAAA,IAAA,KAAA,GAAA,4DAAA,MAAA,QAAA,MAAA,OAAA;;;;GAErC,IAAM,OAAO;AACb,WAAW,QAAG,KAAU,SAAA;;GAExB,IAAM,WAAC;AACJ,WAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,WAAA,IAAA;;kEAEU,UAAA,QAAA,CAAA,KAAA,QAAA,SAAA,SAAA,IAAA,IAAA,QAAA,SAAA,KAAA,YAAA,uBAAA,qBAAA,QAAA,GAAA,YAAA,UAAA,IAAA,qBAAA,QAAA,GAAA,IAAA,UAAA,0BAAA,QAAA,CAAA,CAAA,KAAA,QAAA,KAAA,CAAA,KAAA,IAAA,KAAA,KAAA,OAAA,OAAA,QAAA,SAAA,CAAA,SAAA,IAAA,+CAAA,GAAA,4CAAA,QAAA,KAAA,SAAA,IAAA,IAAA,QAAA,KAAA,KAAA,QAAA,8BAAA,WAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,IAAA,QAAA,SAAA,IAAA,IAAA,QAAA,KAAA,IAAA,GAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,IAAA,SAAA,IAAA,KAAA,IAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,QAAA,GAAA,MAAA,CAAA,KAAA,IAAA,KAAA,GAAA,kBAAA,MAAA,QAAA,MAAA,OAAA;UACP;KAAA,gBAAgB,OAAa,EAAE,CAAA;KAAA;;GAEpC,CAAC;EAAC;;;;;AAYL,SAAgB,mBAAA,OAAA;CACd,MAAM,EACJ,YACE;CACJ,MAAM,UAAS,eAAkC;AACjD,QAAO;EAAC,IAAI;EAAK,gBAAyB,OAAE,EAAO,CAAC;EAAE,gBAAC,KAAA;GACrD,IAAI,OAAO;AACT,WAAI,YAAA,QAAA;;GAEN,UAAU;GACV,WAAU,WAAM;IACd,MAAM,QAAM,EAAI;IAChB,MAAM,QAAQ,EAAE;AAChB,QAAI,OAAO,KAAK,WAAW,EACzB,OAAM,KAAK,IAAI,OAAK,OAAS;QAE7B,OAAM,KAAK,KAAK,UAAI,OAAQ,KAAS,GAAA;AAEvC,WAAO,MAAM,SAAO,UAAa;AAC/B,SAAI,MAAM,WAAU,EAClB,OAAM,KAAK,IAAI,QAAO;SAEtB,OAAM,KAAK,KAAE,UAAA,MAAA,GAAA;MAEf;AACF,WAAO,IAAI,sCAAS,MAAA,SAAA,IAAA,GAAA,MAAA,MAAA,CAAA,KAAA,KAAA,GAAA,MAAA,SAAA,IAAA,OAAA,OAAA,KAAA,MAAA,SAAA,IAAA,MAAA,MAAA,CAAA,KAAA,KAAA,GAAA,KAAA,OAAA,SAAA,sBAAA,SAAA,KAAA,UAAA,OAAA,WAAA,OAAA,QAAA,SAAA,IAAA,OAAA,QAAA,KAAA,IAAA,GAAA,OAAA,SAAA,OAAA,SAAA,OAAA,KAAA,GAAA,OAAA,WAAA,QAAA,GAAA,KAAA,OAAA,SAAA,sBAAA,SAAA,KAAA,UAAA,OAAA,WAAA,OAAA,QAAA,SAAA,IAAA,OAAA,QAAA,KAAA,IAAA,GAAA,OAAA,KAAA,GAAA,OAAA,WAAA,QAAA,GAAA,KAAA,GAAA,6FAAA,uBAAA,OAAA,aAAA,EAClB,QAAQ,KACT,CAAC,CAAC,QAAQ,QAAQ,GAAE,CAAA,MAAA,GAAA,OAAA,OAAA,OAAA,YAAA,SAAA,KAAA,OAAA,MAAA,QAAA,QAAA,OAAA,qBAAA,GAAA,OAAA,MAAA,OAAA,YAAA,SAAA,OAAA,OAAA,KAAA,OAAA,YAAA,SAAA,YAAA,KAAA,UAAA,OAAA,QAAA,CAAA,QAAA,MAAA,OAAA,KAAA,GAAA,KAAA,GAAA;;GAExB,CAAC;EAAE,gBAAU,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA;;;;;AAYhB,SAAQ,oBAA4B,OAA8B;CAChE,MAAM,EACJ,aACE;AACJ,QAAO;EAAC,IAAI;EAAY,gBAAC,OAAA,EAAA,CAAA;EAAA,gBAAA,KAAA;GACvB,IAAI,OAAO;AACT,WAAO,OAAO,OAAE,SAAA;;GAElB,UAAU;GACV,WAAU,UAAS,IAAI,sCAAsC,MAAC,KAAU,4EAAC,uBAAA,MAAA,aAAA,EACvE,QAAQ,KACT,CAAC,CAAC,QAAQ,QAAQ,GAAC,CAAA,MAAA,CAAA;GACrB,CAAC;EAAE,gBAAU,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA;;;;;AAgChB,SAAgB,gBAAgB,OAAuB;CACrD,MAAM,EACJ,SACA,SAAQ,GACR,sBAAE,UACH;CACH,MAAA,QAAA,UAAA;;CAEA,MAAO,UAAU,eAAA,sBAAwB,OAAA,OAAA,QAAA,QAAA,CAAA,QAAA,WAAA,CAAA,QAAA,QAAA,MAAA,iBAAA,aAAA,SAAA,OAAA,QAAA,OAAA,MAAA,SAAA,aAAA,KAAA,IAAA,aAAA,OAAA,SAAA,OAAA,KAAA,IAAA,aAAA,OAAA,MAAA,UAAA,OAAA,MAAA,SAAA,MAAA,CAAA,CAAA,CAAA,GAAA,OAAA,OAAA,QAAA,QAAA,CAAA;AACvC,QAAE;EAAA,WAAA,IAAA,yDAAA,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,gBAAA,kBAAA;GACK;GACL;GACF,CAAA;EAAA,gBAAsB,SAAE,EAAA,CAAA;EAAA,gBAAA,MAAA;GAC1B,IAAA,OAAA;;;GAGI,IAAC,WAAc;AACjB,WAAA;KAAA,WAAA,IAAA;gEACwC,SAAyB,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,gBAAA,oBAAA,EAC3D,IAAE,UAAY;;;;;;GAKnB,CAAC;EAAC,gBAAA,MAAA;GACD,IAAG,OAAK;AACN,WAAM,OAAA,KAAA,QAAA,SAAA,CAAA,SAAA;;GAER,IAAI,WAAW;AACb,WAAI;KAAA,WAAiB,IAAG;iEACQ,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,gBAAA,qBAAA,EAC9B,IAAI,WAAS;AACX,aAAO,QAAQ;QAElB,CAAC;KAAE,gBAAkB,SAAS,EAAC,CAAA;KAAA;;;;GAGlC,IAAI,OAAE;AACJ,WAAM,YAAU,QAAW,UAAG;;GAEhC,IAAI,WAAW;AACb,WAAO;KAAC,WAAa,IAAG;4IAClB,QAAA,UAAA,QAAA,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,gBAAA,SAAA,EAAA,CAAA;KAAA;;;;;AAuBZ,SAAS,aAAa,UAAuC;AAC3D,QAAO,OAAG,OAAO,SAAW,CAAA,MAAA,GAAA,MAAA;AAC1B,MAAI,EAAE,KAAE,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,IAAA,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,CACN,QAAO;WACD,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,IAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,CACN,QAAI;WACG,EAAA,KAAS,MAAK,QAAI,IAAA,aAAA,KAAA,eAAA,IAAA,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,eAAA,CACzB,QAAO;WACD,CAAA,EAAM,KAAK,MAAG,QAAO,IAAA,aAAY,KAAA,eAAA,IAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,eAAA,CACvC,QAAO;WACE,EAAE,KAAC,MAAO,QAAA,IAAA,aAAA,KAAA,UAAA,IAAA,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,UAAA,CACnB,QAAO;WACE,CAAC,EAAE,KAAK,MAAC,QAAO,IAAA,aAAA,KAAA,UAAA,IAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,UAAA,CACzB,QAAO;AAET,SAAO,EAAE,KAAK,cAAA,EAAA,KAAA;GACd;;;;;AAMJ,SAAgB,0BAAE,OAAA;CAChB,MAAM,EACJ,SACA,UACA,aACE;CACJ,MAAK,UAAW,eAAA;AAChB,QAAI;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,gBAAA,oBAAA,EACH,SACH,CAAA;EAAA,IAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,MAAA;;AAEM,WAAC,OAAU,KAAA,SAAA,CAAA,SAAyB;;GAEtC,IAAG,WAAW;AACd,WAAA;KAAA,WAAA,IAAA,wFAAA,YAAA,SAAA,KAAA,CAAA;yBACqB;KAAE,gBAAY,SAAA,EAAA,CAAA;KAAA,gBAAA,KAAA;MACvC,IAAA,OAAA;;;MAGK,gBAAe;MAClB,QAAA,IAAA;MACK,OAAQ,IAAC;MACR,WAAU,UAAK;OAAK,gBAAA,OAAA,EAAA,CAAA;OAAA,WAAA,IAAA;;;iEAGvB,kBAAA,MAAA,YAAA,CAAA,QAAA,QAAA,GAAA,CAAA,MAAA,CAAA;iCACgB;OAAA,gBAAA,OAAA,EAAA,CAAA;OAAA,gBAAA,iBAAA;QACX,SAAE;QACF,QAAO;QACR,qBAAO;QACP,CAAC;OAAA,gBAAe,OAAW,EAAA,CAAI;OAAC;MAClC,CAAC;KAAE,WAAQ,IAAA,6EAAA,UAAA,QAAA,CAAA,GAAA,YAAA,SAAA,SAAA,IAAA,IAAA,SAAA,KAAA,IAAA,KAAA,GAAA,iHAAA,UAAA,QAAA,CAAA,GAAA,YAAA,SAAA,SAAA,IAAA,IAAA,SAAA,KAAA,IAAA,KAAA,GAAA;wBACK;KAAA;;GAEpB,CAAC;EAAC;;;;;AAYL,SAAA,mBAAA,OAAA;SAEA,YACI;CACF,MAAM,UAAS,eAAoB;AACnC,QAAE;EAAA,IAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,iBAAA;GACO;;GAER,CAAC;EAAA,IAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,MAAA;GACA,IAAC,OAAU;AACZ,WAAA,OAAA,KAAA,QAAA,SAAA,CAAA,SAAA;;GAEC,IAAC,WAAc;AAChB,WAAA;KAAA,IAAA;;KACgB,gBAAA,SAAA,EAAA,CAAA;KAAA,gBAAA,KAAA;MACf,IAAA,OAAA;AACF,cAAA,aAAsB,QAAO,SAAA;;MAE3B,gBAAA;MACI,QAAQ,IAAC;MACd,OAAA,IAAA;MACG,WAAA,UAAA;OAAA,gBAAA,OAAA,EAAA,CAAA;OAAA,WAAA,IAAA;uDAC2C,MAAW,OAAA,2BAA2B,MAAA,KAAA,gBAAA,GAAA,IAAA,MAAA,MAAA,GAAA,MAAA,YAAA,KAAA,YAAA,MAAA,MAAA,SAAA,IAAA,MAAA,MAAA,KAAA,KAAA,QAAA,sBAAA,UAAA,IAAA,CAAA,qBAAA,UAAA,IAAA,CAAA,aAAA,IAAA,4CAAA,IAAA,OAAA,CAAA,KAAA,IAAA,KAAA,GAAA;;iEAEpE,kBAAA,MAAA,YAAA,CAAA,QAAA,QAAA,GAAA,CAAA,MAAA,CAAA;iCACf;OAAA,gBAAA,OAAA,EAAA,CAAA;OAAA,gBAAA,iBAAA;QACM,SAAO;QACjB,QAAA;;QAEE,CAAA;OAAA,gBAAA,OAAA,EAAA,CAAA;OAAA;MACG,CAAA;KAAA,WAAe,IAAA,6EAAuD,UAAA,QAAA,CAAA,GAAA,QAAA,SAAA,KAAA,IAAA,CAAA;wBACzE;KAAA;;GAEA,CAAA;EAAA"}
1	+ {"version":3,"file":"display.mjs","names":[],"sources":["../../src/components/display.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 { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { CommandOption, CommandTree } from \"@shell-shock/core\";\nimport { CommandParameterKinds } from \"@shell-shock/core\";\nimport {\n formatDescription,\n formatShortDescription,\n getAppBin,\n getAppTitle,\n getDynamicPathSegmentName,\n isDynamicPathSegment,\n sortOptions\n} from \"@shell-shock/core/plugin-utils\";\nimport { useTheme } from \"@shell-shock/plugin-theme/contexts/theme\";\nimport { camelCase } from \"@stryke/string-format/camel-case\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport type { HelpPluginContext } from \"../types/plugin\";\n\nexport interface HelpUsageDisplayProps {\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 HelpUsageDisplay(props: HelpUsageDisplayProps) {\n const { command, indent = 2 } = props;\n\n const context = usePowerlines<HelpPluginContext>();\n const theme = useTheme();\n\n return (\n <>\n {code`\n writeLine(\n textColors.body.secondary(\\`\\${textColors.usage.bin(\"$_ ${getAppBin(\n context\n )}\")}${\n command.segments.length > 0\n ? ` ${command.segments\n .map(\n segment =>\n `\\${textColors.usage.${\n isDynamicPathSegment(segment) ? \"dynamic\" : \"command\"\n }(\"${\n isDynamicPathSegment(segment)\n ? `[${snakeCase(getDynamicPathSegmentName(segment))}]`\n : segment\n }\")}`\n )\n .join(\" \")}`\n : \"\"\n }${\n Object.values(command.children).length > 0\n ? ` \\${textColors.usage.dynamic(\"[command]\")}`\n : \"\"\n }${\n command.args.length > 0\n ? ` ${command.args\n .map(\n arg =>\n `\\${textColors.usage.args(\"<${snakeCase(\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.choices &&\n arg.choices.length > 0\n ? arg.choices.join(\"\|\")\n : arg.kind === CommandParameterKinds.string &&\n arg.format\n ? arg.format\n : arg.name\n )}${\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.variadic\n ? \"...\"\n : \"\"\n }>\")}`\n )\n .join(\" \")}`\n : \"\"\n } \\${textColors.usage.options(\"[options]\")}\\`), { padding: ${\n theme.padding.app indent\n } }\n );`}\n <hbr />\n <Show when={command.args.length > 0}>\n <hbr />\n {code`\n writeLine(\n textColors.body.secondary(\\`\\${textColors.usage.bin(\"$_ ${getAppBin(context)}\")}${\n command.segments.length > 0\n ? ` ${command.segments\n .map(\n segment =>\n `\\${textColors.usage.${\n isDynamicPathSegment(segment) ? \"dynamic\" : \"command\"\n }(\"${\n isDynamicPathSegment(segment)\n ? `[${snakeCase(getDynamicPathSegmentName(segment))}]`\n : segment\n }\")}`\n )\n .join(\" \")}`\n : \"\"\n }${\n Object.values(command.children).length > 0\n ? ` \\${textColors.usage.dynamic(\"[command]\")}`\n : \"\"\n } \\${textColors.usage.options(\"[options]\")}${\n command.args.length > 0\n ? ` ${command.args\n .map(\n arg =>\n `\\${textColors.usage.args(\"<${snakeCase(\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.choices &&\n arg.choices.length > 0\n ? arg.choices.join(\"\|\")\n : arg.kind === CommandParameterKinds.string &&\n arg.format\n ? arg.format\n : arg.name\n )}${\n (arg.kind === CommandParameterKinds.string \|\|\n arg.kind === CommandParameterKinds.number) &&\n arg.variadic\n ? \"...\"\n : \"\"\n }>\")}`\n )\n .join(\" \")}`\n : \"\"\n }\\`), { padding: ${theme.padding.app * indent} }\n );`}\n <hbr />\n </Show>\n </>\n );\n}\n\nexport interface HelpOptionsDisplayProps {\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 HelpOptionsDisplay(props: HelpOptionsDisplayProps) {\n const { options } = props;\n\n const context = usePowerlines<HelpPluginContext>();\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: textColors.body.primary(\"${\n flags.length > 0\n ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n : \"\"\n }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n option.kind === CommandParameterKinds.string\n ? ` <${snakeCase(\n option.choices && option.choices.length > 0\n ? option.choices.join(\"\|\")\n : option.format\n ? option.format\n : option.name\n )}${option.variadic ? \"...\" : \"\"}>`\n : option.kind === CommandParameterKinds.number\n ? ` <${snakeCase(\n option.choices && option.choices.length > 0\n ? option.choices.join(\"\|\")\n : option.name\n )}${option.variadic ? \"...\" : \"\"}>`\n : \"\"\n }\"), align: \"right\", border: \"none\", maxWidth: \"1/3\" }, { value: textColors.body.tertiary(\\`${formatShortDescription(\n option.description,\n {\n length: 200\n }\n )\n .replace(/\\.+$/, \"\")\n .trim()}${\n option.env \|\| option.default !== undefined\n ? ` (${\n option.env\n ? `env: ${context.config.appSpecificEnvPrefix}_${\n option.env\n }${option.default !== undefined ? \", \" : \"\"}`\n : \"\"\n }${\n option.default !== undefined\n ? `default: ${JSON.stringify(option.default).replace(\n /\"/g,\n '\\\\\"'\n )}`\n : \"\"\n })`\n : \"\"\n }.\\`), align: \"left\", border: \"none\" }], `;\n }}\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface HelpCommandsDisplayProps {\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 HelpCommandsDisplay(props: HelpCommandsDisplayProps) {\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: textColors.body.primary(\"${\n child.name\n }\"), align: \"right\", border: \"none\" }, { value: textColors.body.tertiary(\\`${formatShortDescription(\n child.description,\n {\n length: 200\n }\n )\n .replace(/\\.+$/, \"\")\n .trim()}.\\`), align: \"left\", border: \"none\" }], `\n }\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface BaseHelpDisplayProps {\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 BaseHelpDisplay(props: BaseHelpDisplayProps) {\n const { command, indent = 1, filterGlobalOptions = false } = props;\n\n const theme = useTheme();\n const context = usePowerlines<HelpPluginContext>();\n\n const options = computed(() =>\n filterGlobalOptions\n ? Object.values(command.options).filter(\n option =>\n !context.globalOptions.some(\n (globalOption: CommandOption) =>\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(bold(textColors.heading.secondary(\"Usage:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app indent} }` : \"\"\n });`}\n <hbr />\n <HelpUsageDisplay command={command} indent={indent} />\n <Spacing />\n <Show when={options.value.length > 0}>\n {code`writeLine(\"\");\n writeLine(bold(textColors.heading.secondary(\"Options:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpOptionsDisplay options={options.value} />\n <Spacing />\n </Show>\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(\"\");\n writeLine(bold(textColors.heading.secondary(\"Commands:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpCommandsDisplay commands={command.children} />\n <Spacing />\n </Show>\n <Show when={isSetString(command.reference)}>\n {code`writeLine(\"\");\n writeLine(textColors.heading.tertiary(\\`More information about this command can be found in the reference documentation at \\${link(\"${\n command.reference\n }\")}\\`)${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <Spacing />\n </Show>\n </>\n );\n}\n\nexport interface VirtualCommandHelpDisplayProps {\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 segments?: string[];\n}\n\nfunction sortCommands(commands: Record<string, CommandTree>) {\n return Object.values(commands).sort((a, b) => {\n if (\n a.tags.some(tag => tag.toLowerCase() === \"deprecated\") &&\n !b.tags.some(tag => tag.toLowerCase() === \"deprecated\")\n ) {\n return 1;\n } else if (\n !a.tags.some(tag => tag.toLowerCase() === \"deprecated\") &&\n b.tags.some(tag => tag.toLowerCase() === \"deprecated\")\n ) {\n return -1;\n } else if (\n a.tags.some(tag => tag.toLowerCase() === \"experimental\") &&\n !b.tags.some(tag => tag.toLowerCase() === \"experimental\")\n ) {\n return 1;\n } else if (\n !a.tags.some(tag => tag.toLowerCase() === \"experimental\") &&\n b.tags.some(tag => tag.toLowerCase() === \"experimental\")\n ) {\n return -1;\n } else if (\n a.tags.some(tag => tag.toLowerCase() === \"utility\") &&\n !b.tags.some(tag => tag.toLowerCase() === \"utility\")\n ) {\n return 1;\n } else if (\n !a.tags.some(tag => tag.toLowerCase() === \"utility\") &&\n b.tags.some(tag => tag.toLowerCase() === \"utility\")\n ) {\n return -1;\n }\n\n return a.name.localeCompare(b.name);\n });\n}\n\n/\n A component that generates the invocation of the `help` function for a command.\n /\nexport function VirtualCommandHelpDisplay(\n props: VirtualCommandHelpDisplayProps\n) {\n const { options, segments, commands } = props;\n\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <>\n <hbr />\n {code`writeLine(bold(textColors.heading.secondary(\"Common Options:\")));`}\n <hbr />\n <HelpOptionsDisplay options={options} />\n {code`writeLine(\"\"); `}\n <Spacing />\n <Show when={Object.keys(commands).length > 0}>\n {code`writeLine(textColors.body.tertiary(\"The following commands are available through the ${getAppTitle(\n context,\n true\n )} command-line interface:\"));\n writeLine(\"\"); `}\n <Spacing />\n <For\n each={sortCommands(commands)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n <hbr />\n {code`\n writeLine(textColors.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\\`${child.title} ${child.isVirtual ? \"\" : \"Command\"}${\n child.tags?.length > 0\n ? ` - ${child.tags\n .map(\n tag =>\n `\\${textColors.tags.${camelCase(tag)} ? textColors.tags.${camelCase(tag)}(inverse(\" ${tag} \")) : textColors.tags.$default(inverse(\" ${tag} \"))}`\n )\n .join(\" \")}`\n : \"\"\n }\\`));\n writeLine(\"\");\n writeLine(textColors.body.tertiary(splitText(\\`${formatDescription(\n child.description\n )\n .replace(/\\.+$/, \"\")\n .trim()}.\\`)));\n writeLine(\"\"); `}\n <hbr />\n <BaseHelpDisplay command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\\`Running a specific command with the help flag (via: \\${inlineCode(\"${getAppBin(\n context\n )} ${\n segments && segments.length > 0 ? ` ${segments.join(\" \")}` : \"\"\n } <specific command> --help\")}) or the help command with the specific command as arguments (via: \\${inlineCode(\"${getAppBin(\n context\n )} ${\n segments && segments.length > 0 ? ` ${segments.join(\" \")}` : \"\"\n } help <specific command>\")}) will provide additional information that is specific to that command.\\`);\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n\nexport interface CommandHelpDisplayProps {\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 CommandHelpDisplay(props: CommandHelpDisplayProps) {\n const { command } = props;\n\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <>\n {code`writeLine(\"\"); `}\n <Spacing />\n <BaseHelpDisplay command={command} filterGlobalOptions={false} />\n {code`writeLine(\"\"); `}\n <Spacing />\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(textColors.body.tertiary(\"The following sub-commands are available:\"));\n writeLine(\"\"); `}\n <Spacing />\n <For\n each={sortCommands(command.children)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n <hbr />\n {code`\n writeLine(textColors.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\\`${child.title} ${child.isVirtual ? \"\" : \"Command\"}${\n child.tags?.length > 0\n ? ` - ${child.tags\n .map(\n tag =>\n `\\${textColors.tags.${camelCase(tag)} ? textColors.tags.${camelCase(tag)}(inverse(\" ${tag} \")) : textColors.tags.$default(inverse(\" ${tag} \"))}`\n )\n .join(\" \")}`\n : \"\"\n }\\`));\n writeLine(\"\");\n writeLine(textColors.body.tertiary(splitText(\\`${formatDescription(\n child.description\n )\n .replace(/\\.+$/, \"\")\n .trim()}.\\`)));\n writeLine(\"\"); `}\n <hbr />\n <BaseHelpDisplay command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\\`Running a specific command with the help flag (via: \\${inlineCode(\"${getAppBin(\n context\n )} ${command.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"],"mappings":";;;;;;;;;;;;;;;;AAgCA,SAAS,iBAAwB,OAAM;CACvC,MAAQ,EACR,SACA,SAAS,MACH;CACN,MAAO,UAAO,eAAmB;;AAEjC,QAAO;EAAA,WAAU,IAAA;;kEAEoB,UAAA,QAAA,CAAA,KAAA,QAAA,SAAA,SAAA,IAAA,IAAA,QAAA,SAAA,KAAA,YAAA,uBAAA,qBAAA,QAAA,GAAA,YAAA,UAAA,IAAA,qBAAA,QAAA,GAAA,IAAA,UAAA,0BAAA,QAAA,CAAA,CAAA,KAAA,QAAA,KAAA,CAAA,KAAA,IAAA,KAAA,KAAA,OAAA,OAAA,QAAA,SAAA,CAAA,SAAA,IAAA,+CAAA,KAAA,QAAA,KAAA,SAAA,IAAA,IAAA,QAAA,KAAA,KAAA,QAAA,8BAAA,WAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,IAAA,QAAA,SAAA,IAAA,IAAA,QAAA,KAAA,IAAA,GAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,IAAA,SAAA,IAAA,KAAA,IAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,QAAA,GAAA,MAAA,CAAA,KAAA,IAAA,KAAA,GAAA,4DAAA,MAAA,QAAA,MAAA,OAAA;UACjC;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,gBAAA,MAAA;GACF,IAAA,OAAS;;;GAGP,IAAI,WAAS;AACd,WAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,WAAA,IAAA;;kEAEyD,UAAc,QAAM,CAAA,KAAO,QAAA,SAAA,SAAA,IAAA,IAAA,QAAA,SAAA,KAAA,YAAA,uBAAA,qBAAA,QAAA,GAAA,YAAA,UAAA,IAAA,qBAAA,QAAA,GAAA,IAAA,UAAA,0BAAA,QAAA,CAAA,CAAA,KAAA,QAAA,KAAA,CAAA,KAAA,IAAA,KAAA,KAAA,OAAA,OAAA,QAAA,SAAA,CAAA,SAAA,IAAA,+CAAA,GAAA,4CAAA,QAAA,KAAA,SAAA,IAAA,IAAA,QAAA,KAAA,KAAA,QAAA,8BAAA,WAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,IAAA,QAAA,SAAA,IAAA,IAAA,QAAA,KAAA,IAAA,GAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,IAAA,SAAA,IAAA,KAAA,IAAA,IAAA,SAAA,sBAAA,UAAA,IAAA,SAAA,sBAAA,WAAA,IAAA,WAAA,QAAA,GAAA,MAAA,CAAA,KAAA,IAAA,KAAA,GAAA,kBAAA,MAAA,QAAA,MAAA,OAAA;UACpF;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA;;GAEA,CAAC;EAAA;;;;;AAKJ,SAAe,mBAAmB,OAAM;CACtC,MAAA,EACF,YACE;;AAEA,QAAM;EAAA,IAAA;EAAU,gBAAc,OAAmB,EAAC,CAAA;EAAA,gBAAA,KAAA;GAClD,IAAM,OAAO;;;GAGX,UAAC;GACD,WAAO,WAAA;IACL,MAAA,QAAS,EAAA;IACT,MAAE,QAAW,EAAA;AACb,QAAI,OAAA,KAAA,WAAA,EACF,OAAM,KAAA,IAAA,OAAA,OAAA;QAEN,OAAM,KAAI,KAAA,UAAQ,OAAA,KAAA,GAAA;AAEpB,WAAO,MAAK,SAAS,UAAA;AACnB,SAAI,MAAM,WAAM,EACd,OAAM,KAAK,IAAC,QAAA;SAEZ,OAAM,KAAK,KAAC,UAAA,MAAoB,GAAC;MAEnC;AACF,WAAO,IAAI,sCAAO,MAAA,SAAA,IAAA,GAAA,MAAA,MAAA,CAAA,KAAA,KAAA,GAAA,MAAA,SAAA,IAAA,OAAA,OAAA,KAAA,MAAA,SAAA,IAAA,MAAA,MAAA,CAAA,KAAA,KAAA,GAAA,KAAA,OAAA,SAAA,sBAAA,SAAA,KAAA,UAAA,OAAA,WAAA,OAAA,QAAA,SAAA,IAAA,OAAA,QAAA,KAAA,IAAA,GAAA,OAAA,SAAA,OAAA,SAAA,OAAA,KAAA,GAAA,OAAA,WAAA,QAAA,GAAA,KAAA,OAAA,SAAA,sBAAA,SAAA,KAAA,UAAA,OAAA,WAAA,OAAA,QAAA,SAAA,IAAA,OAAA,QAAA,KAAA,IAAA,GAAA,OAAA,KAAA,GAAA,OAAA,WAAA,QAAA,GAAA,KAAA,GAAA,6FAAA,uBAAA,OAAA,aAAA,EAChB,QAAQ,KACT,CAAC,CAAC,QAAQ,QAAQ,GAAE,CAAA,MAAA,GAAA,OAAA,OAAA,OAAA,YAAA,SAAA,KAAA,OAAA,MAAA,QAAA,QAAA,OAAA,qBAAA,GAAA,OAAA,MAAA,OAAA,YAAA,SAAA,OAAA,OAAA,KAAA,OAAA,YAAA,SAAA,YAAA,KAAA,UAAA,OAAA,QAAA,CAAA,QAAA,MAAA,OAAA,KAAA,GAAA,KAAA,GAAA;;GAExB,CAAC;EAAE,gBAAI,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA;;;;;AAKV,SAAU,oBAAsB,OAAA;CAC9B,MAAM,EACJ,aACE;AACJ,QAAO;EAAC,IAAI;EAAU,gBAAiB,OAAS,EAAA,CAAA;EAAA,gBAAS,KAAA;GACvD,IAAI,OAAO;AACT,WAAO,OAAO,OAAO,SAAS;;GAEhC,UAAU;GACV,WAAU,UAAS,IAAG,sCAAoB,MAAA,KAAA,4EAAA,uBAAA,MAAA,aAAA,EACxC,QAAQ,KACT,CAAC,CAAC,QAAQ,QAAQ,GAAG,CAAC,MAAK,CAAA;GAC7B,CAAC;EAAE,gBAAkB,OAAO,EAAC,CAAA;EAAA,IAAA;EAAA;;;;;AAKhC,SAAgB,gBAAU,OAAA;CACxB,MAAM,EACJ,SACA,SAAS,GACT,sBAAY,UACV;CACJ,MAAM,QAAO,UAAA;CACb,MAAM,UAAK,eAAiB;CAC5B,MAAM,UAAQ,eAAc,sBAAA,OAAA,OAAA,QAAA,QAAA,CAAA,QAAA,WAAA,CAAA,QAAA,cAAA,MAAA,iBAAA,aAAA,SAAA,OAAA,QAAA,OAAA,MAAA,SAAA,aAAA,KAAA,IAAA,aAAA,OAAA,SAAA,OAAA,KAAA,IAAA,aAAA,OAAA,MAAA,UAAA,OAAA,MAAA,SAAA,MAAA,CAAA,CAAA,CAAA,GAAA,OAAA,OAAA,QAAA,QAAA,CAAA;AAC5B,QAAO;EAAC,WAAA,IAAA,yDAAA,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,gBAAA,kBAAA;GACD;GACG;GACT,CAAC;EAAE,gBAAY,SAAa,EAAA,CAAA;EAAO,gBAAI,MAAA;GACtC,IAAI,OAAM;AACR,WAAO,QAAA,MAAA,SAAA;;GAET,IAAI,WAAW;AACb,WAAI;KAAA,WAAiB,IAAA;gEACD,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,gBAAA,oBAAA,EAClB,IAAI,UAAQ;AACV,aAAO,QAAQ;QAElB,CAAC;KAAE,gBAAY,SAAA,EAAA,CAAA;KAAA;;GAEnB,CAAC;EAAE,gBAAgB,MAAA;GAClB,IAAI,OAAO;AACT,WAAO,OAAO,KAAK,QAAC,SAAA,CAAA,SAAA;;GAEtB,IAAI,WAAQ;AACV,WAAO;KAAC,WAAa,IAAA;iEACZ,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,gBAAA,qBAAA,EACP,IAAE,WAAA;AACA,aAAO,QAAO;QAEjB,CAAC;KAAE,gBAAK,SAAA,EAAA,CAAA;KAAA;;GAEZ,CAAC;EAAE,gBAAiB,MAAO;GAC1B,IAAI,OAAO;AACT,WAAO,YAAO,QAAA,UAAA;;GAEhB,IAAI,WAAW;AACb,WAAO;KAAC,WAAa,IAAI;4IACqC,QAAA,UAAA,QAAA,SAAA,IAAA,gBAAA,MAAA,QAAA,MAAA,OAAA,MAAA,GAAA,IAAA;KAAA,gBAAA,OAAA,EAAA,CAAA;KAAA,gBAAA,SAAA,EAAA,CAAA;KAAA;;GAEjE,CAAC;EAAC;;AAEL,SAAS,aAAa,UAAQ;AAC5B,QAAO,OAAO,OAAO,SAAS,CAAA,MAAA,GAAA,MAAA;AAC5B,MAAI,EAAE,KAAK,MAAK,QAAO,IAAI,aAAC,KAAA,aAAA,IAAA,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,CAC1B,QAAO;WACE,CAAC,EAAE,KAAK,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,IAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,aAAA,CACjB,QAAO;WACE,EAAE,KAAK,MAAK,QAAO,IAAG,aAAA,KAAA,eAA+B,IAAA,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,eAAA,CAC9D,QAAO;WACE,CAAC,EAAE,KAAK,MAAK,QAAE,IAAA,aAAA,KAAA,eAAA,IAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,eAAA,CACxB,QAAO;WACE,EAAE,KAAK,MAAG,QAAA,IAAA,aAAA,KAAA,UAAA,IAAA,CAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,UAAA,CACnB,QAAO;WACE,CAAC,EAAC,KAAM,MAAI,QAAA,IAAA,aAAA,KAAA,UAAA,IAAA,EAAA,KAAA,MAAA,QAAA,IAAA,aAAA,KAAA,UAAA,CACrB,QAAO;AAET,SAAK,EAAA,KAAA,cAAA,EAAA,KAAA;GACL;;;;;AAMJ,SAAgB,0BAAyB,OAAA;CACvC,MAAE,EACA,SACA,UACF,aACF;;AAEE,QAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,gBAAA,oBAAA,EACG,SACH,CAAA;EAAA,IAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,MAAA;GACF,IAAO,OAAQ;AACb,WAAQ,OAAU,KAAE,SAAK,CAAA,SAAA;;GAEzB,IAAM,WAAU;;;yBAET;KAAA,gBAAA,SAAA,EAAA,CAAA;KAAA,gBAAA,KAAA;MACJ,IAAA,OAAA;AACE,cAAU,aAAI,SAAA;;MAEd,gBAAU;MACT,QAAQ,IAAG;MACX,OAAO,IAAC;MACR,WAAQ,UAAW;OAAA,gBAAW,OAAA,EAAA,CAAA;OAAA,WAAA,IAAA;uDACE,MAAA,OAAA,2BAAA,MAAA,KAAA,gBAAA,GAAA,IAAA,MAAA,MAAA,GAAA,MAAA,YAAA,KAAA,YAAA,MAAA,MAAA,SAAA,IAAA,MAAA,MAAA,KAAA,KAAA,QAAA,sBAAA,UAAA,IAAA,CAAA,qBAAA,UAAA,IAAA,CAAA,aAAA,IAAA,4CAAA,IAAA,OAAA,CAAA,KAAA,IAAA,KAAA,GAAA;;iEAEvB,kBAAA,MAAA,YAAA,CAAA,QAAA,QAAA,GAAA,CAAA,MAAA,CAAA;iCACW;OAAA,gBAAyB,OAAA,EAAA,CAAA;OAAA,gBAAA,iBAAA;QAC3C,SAAA;;QAEA,qBAAqB;QACtB,CAAC;OAAE,gBAAkB,OAAM,EAAA,CAAA;OAAA;MAC7B,CAAC;KAAE,WAAU,IAAO,6EAAU,UAAA,QAAA,CAAA,GAAA,YAAA,SAAA,SAAA,IAAA,IAAA,SAAA,KAAA,IAAA,KAAA,GAAA,iHAAA,UAAA,QAAA,CAAA,GAAA,YAAA,SAAA,SAAA,IAAA,IAAA,SAAA,KAAA,IAAA,KAAA,GAAA;wBAClB;KAAA;;GAEhB,CAAC;EAAC;;;;;AAKL,SAAgB,mBAAgB,OAAU;CACxC,MAAM,EACJ,YACE;CACJ,MAAM,UAAU,eAAY;AAC5B,QAAO;EAAC,IAAI;EAAmB,gBAAkB,SAAS,EAAA,CAAA;EAAA,gBAAA,iBAAA;GAC/C;GACT,qBAAkB;GACnB,CAAC;EAAE,IAAI;EAAc,gBAAO,SAAA,EAAA,CAAA;EAAA,gBAAA,MAAA;GAC3B,IAAI,OAAO;AACT,WAAO,OAAO,KAAA,QAAO,SAAe,CAAC,SAAO;;GAE9C,IAAI,WAAW;AACb,WAAO;KAAC,IAAI;;KACM,gBAAoB,SAAG,EAAA,CAAA;KAAA,gBAAA,KAAA;MACvC,IAAI,OAAO;AACT,cAAO,aAAY,QAAS,SAAS;;MAEvC,gBAAe;MACf,QAAI,IAAO;MACX,OAAI,IAAA;MACJ,WAAM,UAAQ;OAAA,gBAAA,OAAA,EAAA,CAAA;OAAA,WAAA,IAAA;uDACV,MAAA,OAAA,2BAAA,MAAA,KAAA,gBAAA,GAAA,IAAA,MAAA,MAAA,GAAA,MAAA,YAAA,KAAA,YAAA,MAAA,MAAA,SAAA,IAAA,MAAA,MAAA,KAAA,KAAA,QAAA,sBAAA,UAAA,IAAA,CAAA,qBAAA,UAAA,IAAA,CAAA,aAAA,IAAA,4CAAA,IAAA,OAAA,CAAA,KAAA,IAAA,KAAA,GAAA;;iEAEmB,kBAAA,MAAA,YAAA,CAAA,QAAA,QAAA,GAAA,CAAA,MAAA,CAAA;iCACV;OAAA,gBAAA,OAAA,EAAA,CAAA;OAAA,gBAAA,iBAAA;QACX,SAAS;QACT,QAAQ;QACR,qBAAe;QAChB,CAAC;OAAE,gBAAkB,OAAO,EAAC,CAAA;OAAA;MAC/B,CAAC;KAAE,WAAa,IAAC,6EAAO,UAAA,QAAA,CAAA,GAAA,QAAA,SAAA,KAAA,IAAA,CAAA;wBACP;KAAC;;GAEtB,CAAC;EAAC"}

package/dist/components/help-builtin.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"help-builtin.mjs","names":[],"sources":["../../src/components/help-builtin.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 { Show, splitProps } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { TSDoc, TSDocRemarks } from \"@powerlines/plugin-alloy/typescript\";\nimport type { BuiltinFileProps } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport { BuiltinFile } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport type { CommandTree } from \"@shell-shock/core\";\nimport {\n getAppTitle,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport defu from \"defu\";\nimport type { HelpPluginContext } from \"../types\";\nimport { CommandHelpDisplay, VirtualCommandHelpDisplay } from \"./display\";\n\nexport interface HelpBuiltinProps extends Omit<\n BuiltinFileProps,\n \"id\" \| \"description\"\n> {\n /\n The command to generate the `help` function declaration for.\n /\n command: CommandTree;\n}\n\n/\n A built-in help module for Shell Shock.\n */\nexport function HelpBuiltin(props: HelpBuiltinProps) {\n const [{ command, children }, rest] = splitProps(props, [\n \"command\",\n \"children\"\n ]);\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <BuiltinFile\n id={joinPaths(\n \"help\",\n ...command.segments.filter(segment => !isDynamicPathSegment(segment))\n )}\n description={\n command.path\n ? `A collection of utility functions that assist in displaying help information for the ${\n command.title\n } command.`\n : `A collection of utility functions that assist in displaying help information for the ${getAppTitle(\n context,\n true\n )} command-line interface application.`\n }\n {...rest}\n builtinImports={defu(rest.builtinImports ?? {}, {\n utils: [\"isUnicodeSupported\"],\n console: [\n \"splitText\",\n \"writeLine\",\n \"inlineCode\",\n \"textColors\",\n \"inverse\",\n \"bold\",\n \"help\",\n \"table\",\n \"link\"\n ]\n })}>\n <TSDoc\n heading={`Utility functions for displaying help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}>\n <TSDocRemarks>\n {`This module contains utility functions that assist in displaying help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }. The main function exported by this module is the \\`showHelp\\` function, which can be used to display help information for the specified command or application. This function can be called from within the command's handler or from any other part of the application where help information needs to be displayed.`}\n </TSDocRemarks>\n </TSDoc>\n <FunctionDeclaration\n export\n name=\"showHelp\"\n doc={`Display help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}>\n <Show\n when={!command.isVirtual}\n fallback={\n <VirtualCommandHelpDisplay\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n }>\n <CommandHelpDisplay command={command} />\n </Show>\n </FunctionDeclaration>\n <Spacing />\n <Show when={Boolean(children)}>{children}</Show>\n </BuiltinFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;~~AA0CA~~,~~SAAW~~,~~YAAW~~,~~OAAA~~;~~CACtB~~,~~MAAA~~,~~CAAA~~,~~WAEE~~,~~YACG~~,~~QAAQ~~,~~WAAM~~,~~OAAW~~,CAAA,~~WAAW~~,WAAA,CAAA;~~CACvC~~,~~MAAA~~,~~UAAA~~,~~eAAA~~;~~AACF~~,~~QAAO~~,~~gBAAoB~~,~~aAAQ~~,~~WAAkB~~;~~EACnD~~,~~IAAM~~,~~KAAG~~;~~AACN~~,~~UAAQ~~,~~UAAA~~,~~QAAA~~,~~GAAA~~,~~QAAA~~,~~SAAA~~,QAAA,~~YAAA~~,CAAA,qBAAA,QAAA,CAAA,CAAA;;~~EAET~~,IAAA,~~cAAA~~;~~AACF~~,~~UAAM~~,~~WAAU~~,CAAA,CAAA,~~QAAc~~,KAAA,EAAA,GAAA,~~wFAAoB~~,QAAA,MAAA,aAAA,wFAAA,YAAA,SAAA,KAAA,CAAA;;~~EAElD~~,EAAA,~~MAAO~~;~~EACL~~,IAAC,~~iBAAA~~;~~AACC~~,~~UAAI~~,KAAA,~~KAAS~~,kBAAA,EAAA,EAAA;~~IACX~~,~~OAAM~~,~~CAAA~~,~~qBAAA~~;~~IACN~~,SAAG;KAAO;~~KAAU~~;~~KAAgB~~;~~KAAG~~;~~KAAqB~~;~~KAAQ~~;KAAA;KAAA;KAAA;KAAA;~~IACrE~~,CAAA;;~~EAEH~~,~~IAAI~~,~~WAAQ~~;~~AACV~~,~~UAAO~~;~~IAAC~~,~~gBAAe~~,~~OAAQ;KAC7B~~,~~IAAI~~,~~UAAU;AACZ~~,~~aAAI,6DAAQ,~~QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;~~KAEd~~,~~IAAI~~,WAAS;~~AACX~~,~~aAAI~~,gBAAA,cAAA,~~EACF~~,~~IAAG~~,~~WAAY~~;~~AACrB~~,cAAA,6FAAA,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;~~SAEA~~,CAAA;;~~KAEC~~,CAAC;~~IAAA~~,~~gBAAS~~,qBAAA;~~KACT~~,~~UAAG~~;~~KACH~~,~~MAAG~~;~~KACH~~,~~IAAG~~,~~MAAA~~;~~AACD~~,~~aAAC~~,~~oCAAW~~,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;~~KAEd~~,~~IAAG~~,~~WAAK~~;~~AACN~~,~~aAAM~~,gBAAA,MAAA;~~OACL~~,~~IAAK~~,~~OAAC~~;~~AACN~~,~~eAAI~~,CAAA,QAAA;;OAEN,IAAA,~~WAAA~~;~~AACF~~,~~eAAA~~,gBAAA,2BAAA;~~SACS~~,~~IAAE~~,~~UAAQ~~;~~AACR~~,~~iBAAA~~,OAAA,OAAA,QAAA,QAAA;;~~SAEF~~,~~IAAC~~,~~WAAY~~;~~AACjB~~,iBAAA,QAAA,YAAA,EAAA;;~~SAEA~~,~~CAAI~~;;~~OAEJ~~,~~IAAI~~,~~WAAW~~;~~AACb~~,~~eAAK~~,~~gBAAoB~~,~~oBAAmB~~,~~EACpC~~,~~SACZ~~,CAAA;;~~OAEH~~,~~CAAA~~;;~~KAEA~~,CAAC;~~IAAA~~,~~gBAAc~~,SAAA,EAAA,CAAA;IAAA,gBAAA,MAAA;~~KACd~~,IAAI,~~OAAE~~;~~AACJ~~,~~aAAO~~,~~QAAC~~,SAAA;;~~KAED~~;~~KACV~~,CAAC;IAAC;;EAEN,CAAC,CAAC"}
1	+ {"version":3,"file":"help-builtin.mjs","names":[],"sources":["../../src/components/help-builtin.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 { Show, splitProps } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { TSDoc, TSDocRemarks } from \"@powerlines/plugin-alloy/typescript\";\nimport type { BuiltinFileProps } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport { BuiltinFile } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport type { CommandTree } from \"@shell-shock/core\";\nimport {\n getAppTitle,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport defu from \"defu\";\nimport type { HelpPluginContext } from \"../types\";\nimport { CommandHelpDisplay, VirtualCommandHelpDisplay } from \"./display\";\n\nexport interface HelpBuiltinProps extends Omit<\n BuiltinFileProps,\n \"id\" \| \"description\"\n> {\n /\n The command to generate the `help` function declaration for.\n /\n command: CommandTree;\n}\n\n/\n A built-in help module for Shell Shock.\n */\nexport function HelpBuiltin(props: HelpBuiltinProps) {\n const [{ command, children }, rest] = splitProps(props, [\n \"command\",\n \"children\"\n ]);\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <BuiltinFile\n id={joinPaths(\n \"help\",\n ...command.segments.filter(segment => !isDynamicPathSegment(segment))\n )}\n description={\n command.path\n ? `A collection of utility functions that assist in displaying help information for the ${\n command.title\n } command.`\n : `A collection of utility functions that assist in displaying help information for the ${getAppTitle(\n context,\n true\n )} command-line interface application.`\n }\n {...rest}\n builtinImports={defu(rest.builtinImports ?? {}, {\n utils: [\"isUnicodeSupported\"],\n console: [\n \"splitText\",\n \"writeLine\",\n \"inlineCode\",\n \"textColors\",\n \"inverse\",\n \"bold\",\n \"help\",\n \"table\",\n \"link\"\n ]\n })}>\n <TSDoc\n heading={`Utility functions for displaying help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}>\n <TSDocRemarks>\n {`This module contains utility functions that assist in displaying help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }. The main function exported by this module is the \\`showHelp\\` function, which can be used to display help information for the specified command or application. This function can be called from within the command's handler or from any other part of the application where help information needs to be displayed.`}\n </TSDocRemarks>\n </TSDoc>\n <FunctionDeclaration\n export\n name=\"showHelp\"\n doc={`Display help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}>\n <Show\n when={!command.isVirtual}\n fallback={\n <VirtualCommandHelpDisplay\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n }>\n <CommandHelpDisplay command={command} />\n </Show>\n </FunctionDeclaration>\n <Spacing />\n <Show when={Boolean(children)}>{children}</Show>\n </BuiltinFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAgCA,SAAc,YAAA,OAAoB;CAClC,MAAQ,CAAC,WAET,YACE,QAAA,WAAgB,OAAA,CAAA,WAAA,WAAA,CAAA;CAChB,MAAM,UAAE,eAAW;AACnB,QAAA,gBAAA,aAAA,WAAA;EACE,IAAA,KAAA;AACC,UAAI,UAAW,QAAS,GAAK,QAAM,SAAS,QAAA,YAAe,CAAA,qBAAA,QAAA,CAAA,CAAA;;EAE9D,IAAA,cAAoB;AACtB,UAAA,WAAA,CAAA,CAAA,QAAA,KAAA,EAAA,GAAA,wFAAA,QAAA,MAAA,aAAA,wFAAA,YAAA,SAAA,KAAA,CAAA;;EAEE,EAAA,MAAA;EACE,IAAC,iBAAoB;AACvB,UAAA,KAAA,KAAA,kBAAA,EAAA,EAAA;IACK,OAAQ,CAAC,qBAAmB;IAC3B,SAAG;KAAO;KAAa;KAAS;KAAkB;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;IACrD,CAAA;;EAED,IAAA,WAAA;AACF,UAAM;IAAA,gBAAwB,OAAA;;AAEvB,aAAA,6DAAA,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;KAED,IAAE,WAAS;AACV,aAAK,gBAAA,cAAA,EACH,IAAA,WAAgB;AACpB,cAAA,6FAAA,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;SAEC,CAAA;;KAED,CAAC;IAAE,gBAAY,qBAAA;KACd,UAAM;KACN,MAAM;KACN,IAAI,MAAE;AACJ,aAAI,oCAAA,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;KAER,IAAA,WAAA;AACI,aAAI,gBAAA,MAAA;OACR,IAAA,OAAgB;AACR,eAAG,CAAA,QAAA;;OAEN,IAAA,WAAU;AACV,eAAU,gBAAA,2BAAA;SACV,IAAA,UAAW;AACX,iBAAW,OAAA,OAAA,QAAA,QAAA;;SAEN,IAAA,WAAA;AACA,iBAAA,QAAA,YAAA,EAAA;;SAED,CAAA;;OAEN,IAAA,WAAA;AACF,eAAA,gBAAA,oBAAA,EACkB,SACf,CAAA;;OAEC,CAAC;;KAEL,CAAC;IAAC,gBAAY,SAAA,EAAA,CAAA;IAAA,gBAAA,MAAA;KACb,IAAI,OAAK;AACP,aAAE,QAAQ,SAAA;;KAEF;KACX,CAAC;IAAC;;EAEN,CAAC,CAAC"}

package/dist/components/help-command.cjs CHANGED Viewed

@@ -53,14 +53,14 @@ function TemporaryHelpCommand() {
 */
 function HelpCommand(props) {
 	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
-	const helpImports = (0, _alloy_js_core.computed)(() => props.segments ? props.segments.reduce((ret, segments) => {
+	const helpImports = (0, _alloy_js_core.computed)(() => props.commands ? props.commands.reduce((ret, segments) => {
 		ret[(0, _stryke_path.joinPaths)("help", ...segments)] = [{
 			name: "showHelp",
 			alias: `showHelp${segments.map((segment) => (0, _stryke_string_format_pascal_case.pascalCase)(segment.replace(/-/g, ""))).join("")}`
 		}];
 		return ret;
 	}, {}) : {});
-	const commandSegmentsList = props.segments ?? [];
+	const commandSegmentsList = props.commands ?? [];
 	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TypescriptFile, {
 		get path() {
 			return (0, _stryke_path.joinPaths)(context.entryPath, "help", "command.ts");

package/dist/components/help-command.d.cts CHANGED Viewed

@@ -6,7 +6,7 @@ import * as _$_alloy_js_core0 from "@alloy-js/core";
  */
 declare function TemporaryHelpCommand(): _$_alloy_js_core0.Children;
 interface HelpCommandsProps {
-  segments: string[][];
+  commands: string[][];
 }
 /**
  * The Help command's handler wrapper for the Shell Shock project.

package/dist/components/help-command.d.mts CHANGED Viewed

@@ -6,7 +6,7 @@ import * as _$_alloy_js_core0 from "@alloy-js/core";
  */
 declare function TemporaryHelpCommand(): _$_alloy_js_core0.Children;
 interface HelpCommandsProps {
-  segments: string[][];
+  commands: string[][];
 }
 /**
  * The Help command's handler wrapper for the Shell Shock project.

package/dist/components/help-command.mjs CHANGED Viewed

@@ -51,14 +51,14 @@ function TemporaryHelpCommand() {
 */
 function HelpCommand(props) {
 	const context = usePowerlines();
-	const helpImports = computed(() => props.segments ? props.segments.reduce((ret, segments) => {
+	const helpImports = computed(() => props.commands ? props.commands.reduce((ret, segments) => {
 		ret[joinPaths("help", ...segments)] = [{
 			name: "showHelp",
 			alias: `showHelp${segments.map((segment) => pascalCase(segment.replace(/-/g, ""))).join("")}`
 		}];
 		return ret;
 	}, {}) : {});
-	const commandSegmentsList = props.segments ?? [];
+	const commandSegmentsList = props.commands ?? [];
 	return createComponent(TypescriptFile, {
 		get path() {
 			return joinPaths(context.entryPath, "help", "command.ts");

package/dist/components/help-command.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"help-command.mjs","names":[],"sources":["../../src/components/help-command.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 {\n ElseClause,\n ElseIfClause,\n FunctionDeclaration,\n IfStatement\n} from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript\";\nimport {\n TSDoc,\n TSDocParam\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { joinPaths } from \"@stryke/path\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport type { HelpPluginContext } from \"../types/plugin\";\n\n/\n A temporary placeholder component for the help command. The actual content of this component will be rendered in the `prepare` step of the help plugin, after the command list has been fully resolved. This is necessary to ensure that the help command's entry file is generated, and to avoid any issues with missing files or circular dependencies during the rendering process.\n /\nexport function TemporaryHelpCommand() {\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <TypescriptFile path={joinPaths(context.entryPath, \"help\", \"command.ts\")}>\n {code` // Temporary placeholder file to ensure the help command's entry file is generated. The actual content of this file will be rendered in the \\`prepare\\` step of this plugin, after the command list has been fully resolved. `}\n <Spacing />\n <TSDoc heading=\"Display command usage details and other useful information to the user.\">\n <TSDocParam name=\"segments\">\n {`The command segments for the command to show help for. This is used to determine which command's help information to display. If no segments are provided, general help information about the CLI application will be displayed.`}\n </TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n default\n async\n name=\"handler\"\n parameters={[\n { name: \"segments\", type: \"string[]\", default: \"[]\" }\n ]}></FunctionDeclaration>\n </TypescriptFile>\n );\n}\n\nexport interface HelpCommandsProps {\n ~~segments~~: string[][];\n}\n\n/\n The Help command's handler wrapper for the Shell Shock project.\n */\nexport function HelpCommand(props: HelpCommandsProps) {\n const context = usePowerlines<HelpPluginContext>();\n\n const helpImports = computed(() =>\n props.~~segments~~\n ? props.~~segments~~.reduce(\n (ret, segments) => {\n ret[joinPaths(\"help\", ...segments)] = [\n {\n name: \"showHelp\",\n alias: `showHelp${segments\n .map(segment => pascalCase(segment.replace(/-/g, \"\")))\n .join(\"\")}`\n }\n ];\n return ret;\n },\n {} as Record<string, { name: string; alias: string }[]>\n )\n : {}\n );\n\n const commandSegmentsList = props.~~segments~~ ?? [];\n\n return (\n <TypescriptFile\n path={joinPaths(context.entryPath, \"help\", \"command.ts\")}\n imports={{\n \"node:os\": \"os\",\n \"node:fs/promises\": [\"readFile\", \"writeFile\"]\n }}\n builtinImports={{\n ...helpImports.value,\n help: [\"showHelp\"],\n console: [\n \"splitText\",\n \"writeLine\",\n \"inlineCode\",\n \"textColors\",\n \"inverse\",\n \"bold\",\n \"help\",\n \"table\",\n \"link\"\n ]\n }}>\n <TSDoc heading=\"Display command usage details and other useful information to the user.\">\n <TSDocParam name=\"segments\">\n {`The command segments for the command to show help for. This is used to determine which command's help information to display. If no segments are provided, general help information about the CLI application will be displayed.`}\n </TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n default\n async\n name=\"handler\"\n parameters={[{ name: \"segments\", type: \"string[]\", default: \"[]\" }]}>\n <Show\n when={commandSegmentsList.length > 0}\n fallback={code`showHelp(); `}>\n <For each={commandSegmentsList} doubleHardline>\n {(segments, index) => (\n <Show\n when={index > 0}\n fallback={\n <IfStatement\n condition={code`segments.join(\"/\").toLowerCase() === \"${segments\n .join(\"/\")\n .toLowerCase()}\"`}>\n {code` showHelp${segments\n .map(segment => pascalCase(segment))\n .join(\"\")}(); `}\n </IfStatement>\n }>\n <ElseIfClause\n condition={code`segments.join(\"/\").toLowerCase() === \"${segments\n .join(\"/\")\n .toLowerCase()}\"`}>\n {code` showHelp${segments\n .map(segment => pascalCase(segment))\n .join(\"\")}(); `}\n </ElseIfClause>\n </Show>\n )}\n </For>\n <ElseClause>{code`showHelp(); `}</ElseClause>\n </Show>\n </FunctionDeclaration>\n </TypescriptFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;~~AAgCA~~,~~SAAS~~,~~uBAA8B~~;~~CACvC~~,~~MAAQ~~,UAAC,~~eAAyC~~;~~AAClD~~,~~QAAO~~,~~gBAAO~~,~~gBAA6B;;AAEzC~~,~~UAAA~~,~~UAAA~~,~~QAAA~~,~~WAAA~~,~~QAAA~~,~~aAAA~~;;~~EAEA~~,IAAA,WAAA;~~AACI~~,~~UAAC~~;~~IAAA~~,~~IAAS~~;~~IAAuB~~,~~gBAAA~~,~~SAAA~~,EAAA,CAAA;IAAA,~~gBAAA~~,SAAA;~~KAC/B~~,~~SAAS;;AAER~~,~~aAAA~~,~~gBAAA~~,YAAA;OACJ,~~MAAA;OACO,UAAI;OACT,~~CAAA;;~~KAEA~~,~~CAAC~~;~~IAAC~~,~~gBAAiB~~,~~qBAAS~~;~~KAC3B~~,~~UAAQ~~;~~KACR~~,~~WAAE~~;~~KACF~~,~~OAAK~~;~~KACN~~,~~MAAA~~;~~KACC~~,~~YAAA~~,CAAA;~~MACA~~,MAAA;~~MACA~~,MAAA;MACA,~~SAAM~~;~~MACN~~,CAAA;KACD,CAAC;~~IAAC~~;;~~EAEN~~,CAAC~~;;;;;AASJ~~,~~SAAY~~,~~YAAU~~,~~OAA8B~~;~~CAClD~~,MAAA,~~UAAA~~,eAAA~~;CACF~~,~~MAAO,cAAS,eAAmB,~~MAAA,~~WAAmB~~,MAAA,SAAA,QAAA,KAAA,aAAA;~~AACpD~~,~~MAAM~~,~~UAAU~~,QAAA,GAAA,~~SAAc~~,IAAA,CAAA;;~~GAE9B~~,~~OAAM~~,~~WAAc~~,~~SAAW~~,~~KAAE~~,YAAA,WAAA,QAAA,QAAA,MAAA,GAAA,CAAA,CAAA,CAAA,KAAA,GAAA;~~GAC/B~~,~~CAAA~~;~~AACA~~,~~SAAI~~;~~IACH~~,~~EAAE~~,~~CAGA~~,~~GAAG~~,~~EAAE~~,~~CAAC~~;~~CACX~~,MAAM,~~sBAAgB~~,~~MAAU~~,YAAA,~~EAAA;AAChC~~,~~QAAO~~,~~gBAAc,gBAAW~~;~~EAC9B~~,~~IAAI~~,~~OAAO;AACT~~,~~UAAO,UAAC,~~QAAA,WAAA,QAAA,aAAA;;~~EAEV~~,~~SAAQ~~;~~GACN~~,~~WAAK~~;~~GACL~~,~~oBAAiB~~,CAAA,~~YAAgB~~,~~YAAQ~~;~~GAC1C~~;EACD,IAAI,~~iBAAC~~;~~AACN~~,~~UAAA;;IAEK~~,~~MAAA~~,~~CAAA,WAAA;;;;;;;;;;;;IAEN;;EAEE,IAAE,WAAM~~;~~AACN~~,~~UAAO~~,~~CAAC~~,~~gBAAC,SAAA~~;~~IACP~~,~~SAAS~~;~~IACT~~,~~IAAC~~,WAAQ;AACV,~~YAAA~~,gBAAA,~~YAAA~~;~~MACD~~,~~MAAA~~;~~MACK~~,~~UAAW;MACd~~,~~CAAI~~;;~~IAEL~~,~~CAAC~~,~~EAAE~~,~~gBAAW~~,~~qBAAA~~;~~IACb~~,~~UAAG~~;~~IACH~~,~~WAAG~~;~~IACH~~,~~OAAG~~;~~IACH~~,~~MAAG~~;~~IACH~~,~~YAAQ~~,~~CAAA~~;~~KACN~~,~~MAAM~~;~~KACN~~,~~MAAM~~;~~KACN~~,~~SAAK~~;~~KACP~~,~~CAAA~~;~~IACA~~,~~IAAA~~,~~WAAA~~;~~AACD~~,~~YAAM~~,~~gBAAiB~~,~~MAAQ~~;~~MAC7B~~,IAAA,OAAW;~~AACR~~,~~cAAI~~,~~oBAAyB~~,~~SAAQ~~;;~~MAEzC~~,UAAK,IAAA;~~MACN~~,~~IAAA~~,~~WAAA~~;~~AACC~~,~~cAAA~~,CAAA,gBAAA,KAAA;~~QACA~~,MAAA;QACA,gBAAA;~~QACM~~,~~WAAO~~,~~UAAA~~,~~UAAA~~,~~gBAAA~~,~~MAAA~~;~~SACH~~,~~MAAK~~,~~QAAO~~;~~SACrB~~,IAAA,~~WAAA~~;~~AACO~~,iBAAA,~~gBAA6B~~,~~aAAC~~;~~WAC1B~~,~~IAAK~~,~~YAAa~~;~~AACjB~~,mBAAA,IAAA,~~yCAAmC~~,SAAA,KAAA,IAAA,CAAA,aAAA,CAAA;;~~WAEzC~~,IAAA,WAAA;~~AACO~~,~~mBAAS~~,IAAA,YAAA,SAAA,KAAA,YAAA,WAAA,QAAA,CAAA,CAAA,KAAA,GAAA,CAAA;;~~WAEZ~~,~~CAAA~~;;~~SAED~~,~~IAAI~~,~~WAAS~~;~~AACX~~,~~iBAAG~~,~~gBAAiB~~,cAAA;~~WACnB~~,~~IAAK~~,~~YAAW~~;~~AACd~~,~~mBAAI~~,~~IAAQ~~,~~yCAAsB~~,SAAA,KAAA,IAAA,CAAA,aAAA,CAAA;;~~WAErC~~,IAAA,~~WAAW~~;~~AACd~~,~~mBAAA~~,IAAA,YAAA,SAAA,KAAA,YAAA,WAAA,QAAA,CAAA,CAAA,KAAA,GAAA,CAAA;;~~WAEC~~,CAAA;;~~SAED~~,CAAC;QACH,CAAC,EAAE,~~gBAAiB~~,~~YAAA~~,~~EACnB~~,~~UAAS~~,~~IAAA~~,~~gBACV~~,CAAC,CAAC;;MAEN,CAAC;;IAEL,CAAC,CAAC;;EAEN,CAAC"}
1	+ {"version":3,"file":"help-command.mjs","names":[],"sources":["../../src/components/help-command.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 {\n ElseClause,\n ElseIfClause,\n FunctionDeclaration,\n IfStatement\n} from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript\";\nimport {\n TSDoc,\n TSDocParam\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { joinPaths } from \"@stryke/path\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport type { HelpPluginContext } from \"../types/plugin\";\n\n/\n A temporary placeholder component for the help command. The actual content of this component will be rendered in the `prepare` step of the help plugin, after the command list has been fully resolved. This is necessary to ensure that the help command's entry file is generated, and to avoid any issues with missing files or circular dependencies during the rendering process.\n /\nexport function TemporaryHelpCommand() {\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <TypescriptFile path={joinPaths(context.entryPath, \"help\", \"command.ts\")}>\n {code` // Temporary placeholder file to ensure the help command's entry file is generated. The actual content of this file will be rendered in the \\`prepare\\` step of this plugin, after the command list has been fully resolved. `}\n <Spacing />\n <TSDoc heading=\"Display command usage details and other useful information to the user.\">\n <TSDocParam name=\"segments\">\n {`The command segments for the command to show help for. This is used to determine which command's help information to display. If no segments are provided, general help information about the CLI application will be displayed.`}\n </TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n default\n async\n name=\"handler\"\n parameters={[\n { name: \"segments\", type: \"string[]\", default: \"[]\" }\n ]}></FunctionDeclaration>\n </TypescriptFile>\n );\n}\n\nexport interface HelpCommandsProps {\n commands: string[][];\n}\n\n/\n The Help command's handler wrapper for the Shell Shock project.\n */\nexport function HelpCommand(props: HelpCommandsProps) {\n const context = usePowerlines<HelpPluginContext>();\n\n const helpImports = computed(() =>\n props.commands\n ? props.commands.reduce(\n (ret, segments) => {\n ret[joinPaths(\"help\", ...segments)] = [\n {\n name: \"showHelp\",\n alias: `showHelp${segments\n .map(segment => pascalCase(segment.replace(/-/g, \"\")))\n .join(\"\")}`\n }\n ];\n return ret;\n },\n {} as Record<string, { name: string; alias: string }[]>\n )\n : {}\n );\n\n const commandSegmentsList = props.commands ?? [];\n\n return (\n <TypescriptFile\n path={joinPaths(context.entryPath, \"help\", \"command.ts\")}\n imports={{\n \"node:os\": \"os\",\n \"node:fs/promises\": [\"readFile\", \"writeFile\"]\n }}\n builtinImports={{\n ...helpImports.value,\n help: [\"showHelp\"],\n console: [\n \"splitText\",\n \"writeLine\",\n \"inlineCode\",\n \"textColors\",\n \"inverse\",\n \"bold\",\n \"help\",\n \"table\",\n \"link\"\n ]\n }}>\n <TSDoc heading=\"Display command usage details and other useful information to the user.\">\n <TSDocParam name=\"segments\">\n {`The command segments for the command to show help for. This is used to determine which command's help information to display. If no segments are provided, general help information about the CLI application will be displayed.`}\n </TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n default\n async\n name=\"handler\"\n parameters={[{ name: \"segments\", type: \"string[]\", default: \"[]\" }]}>\n <Show\n when={commandSegmentsList.length > 0}\n fallback={code`showHelp(); `}>\n <For each={commandSegmentsList} doubleHardline>\n {(segments, index) => (\n <Show\n when={index > 0}\n fallback={\n <IfStatement\n condition={code`segments.join(\"/\").toLowerCase() === \"${segments\n .join(\"/\")\n .toLowerCase()}\"`}>\n {code` showHelp${segments\n .map(segment => pascalCase(segment))\n .join(\"\")}(); `}\n </IfStatement>\n }>\n <ElseIfClause\n condition={code`segments.join(\"/\").toLowerCase() === \"${segments\n .join(\"/\")\n .toLowerCase()}\"`}>\n {code` showHelp${segments\n .map(segment => pascalCase(segment))\n .join(\"\")}(); `}\n </ElseIfClause>\n </Show>\n )}\n </For>\n <ElseClause>{code`showHelp(); `}</ElseClause>\n </Show>\n </FunctionDeclaration>\n </TypescriptFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;AA8BA,SAAE,uBAAA;CACA,MAAM,UAAC,eAAwB;AACjC,QAAS,gBAAkB,gBAAa;EACxC,IAAQ,OAAC;AACH,UAAO,UAAC,QAAiB,WAAW,QAAO,aAAO;;EAEtD,IAAA,WAAA;AACG,UAAA;IAAS,IAAC;IAAqO,gBAAiB,SAAQ,EAAA,CAAA;IAAA,gBAAwB,SAAI;KACvS,SAAA;KACK,IAAA,WAAS;AACR,aAAS,gBAAe,YAAA;;OAEvB,UAAA;OACJ,CAAA;;KAEE,CAAA;IAAA,gBAAS,qBAAA;KACT,UAAM;KACL,WAAW;KACX,OAAO;KACP,MAAE;KACF,YAAK,CAAA;MACN,MAAA;MACC,MAAA;MACA,SAAA;MACA,CAAA;KACD,CAAC;IAAA;;EAEL,CAAC;;;;;;CAMJ,MAAO,UAAU,eAAA;CACf,MAAA,cAAoB,eAAA,MAAA,WAAA,MAAA,SAAA,QAAA,KAAA,aAAA;AACtB,MAAA,UAAA,QAAA,GAAA,SAAA,IAAA,CAAA;;GAEE,OAAA,WAAA,SAAA,KAAA,YAAA,WAAA,QAAA,QAAA,MAAA,GAAA,CAAA,CAAA,CAAA,KAAA,GAAA;GACC,CAAG;AACJ,SAAA;IACF,EAAO,CAAA,GAAA,EAAA,CAAA;CACL,MAAM,sBAAU,MAAc,YAAA,EAAkB;;EAEhD,IAAM,OAAA;AACJ,UAAM,UAAA,QAAA,WAAA,QAAA,aAAA;;EAEN,SAAO;GACL,WAAU;GACV,oBAAQ,CAAA,YAAA,YAAA;GACT;EACD,IAAI,iBAAgB;AAClB,UAAO;IACL,GAAG,YAAY;IACf,MAAM,CAAA,WAAA;IACN,SAAK;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;IACN;;EAEH,IAAI,WAAQ;AACV,UAAE,CAAA,gBAAA,SAAA;IACA,SAAC;IACN,IAAA,WAAA;;MAEK,MAAA;;MAEC,CAAA;;IAEH,CAAA,EAAI,gBAAY,qBAA2B;IAC3C,UAAS;IACP,WAAW;IACX,OAAM;IACP,MAAA;IACD,YAAc,CAAC;KACX,MAAC;KACH,MAAQ;KACR,SAAS;KACR,CAAC;IACF,IAAG,WAAU;AACX,YAAC,gBAAW,MAAA;MACX,IAAA,OAAW;AACX,cAAQ,oBAAA,SAAA;;MAER,UAAK,IAAA;MACL,IAAK,WAAC;AACN,cAAI,CAAA,gBAAA,KAAA;QACP,MAAA;QACA,gBAAA;QACK,WAAS,UAAe,UAAO,gBAAkB,MAAO;SAC5D,MAAe,QAAE;SACV,IAAA,WAAiB;AACb,iBAAA,gBAAA,aAAA;WACP,IAAA,YAAA;AACN,mBAAA,IAAA,yCAAA,SAAA,KAAA,IAAA,CAAA,aAAA,CAAA;;WAEC,IAAA,WAAA;AACA,mBAAA,IAAA,YAAA,SAAA,KAAA,YAAA,WAAA,QAAA,CAAA,CAAA,KAAA,GAAA,CAAA;;WAEa,CAAC;;SAEN,IAAA,WAAA;AACI,iBAAK,gBAAc,cAAA;WAClB,IAAA,YAAA;AACG,mBAAO,IAAG,yCAAA,SAAA,KAAA,IAAA,CAAA,aAAA,CAAA;;WAEZ,IAAA,WAAS;AACP,mBAAC,IAAA,YAAA,SAAA,KAAA,YAAA,WAAA,QAAA,CAAA,CAAA,KAAA,GAAA,CAAA;;WAEL,CAAA;;SAEH,CAAC;QACH,CAAC,EAAE,gBAAkB,YAAC,EACrB,UAAU,IAAC,gBACZ,CAAC,CAAC;;MAEN,CAAC;;IAEL,CAAC,CAAC;;EAEN,CAAC"}

package/dist/index.cjs CHANGED Viewed

@@ -81,7 +81,7 @@ const plugin = (options = {}) => {
 									doubleHardline: true,
 									children: (command) => (0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_builtin.HelpBuiltin, { command })
 								}),
-								(0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_command.HelpCommand, { get segments() {
+								(0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_command.HelpCommand, { get commands() {
 									return segments.value;
 								} })
 							];

package/dist/index.mjs CHANGED Viewed

@@ -76,7 +76,7 @@ const plugin = (options = {}) => {
 									doubleHardline: true,
 									children: (command) => createComponent(HelpBuiltin, { command })
 								}),
-								createComponent(HelpCommand, { get segments() {
+								createComponent(HelpCommand, { get commands() {
 									return segments.value;
 								} })
 							];

package/dist/index.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.mjs","names":[],"sources":["../src/index.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 { computed, For, Show } from \"@alloy-js/core\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport {\n computeBin,\n getCommandList,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport type { CommandConfig } from \"@shell-shock/core/types/command\";\nimport console from \"@shell-shock/plugin-console\";\nimport theme from \"@shell-shock/plugin-theme\";\nimport { getUniqueBy } from \"@stryke/helpers/get-unique\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { HelpBuiltin, HelpCommand, TemporaryHelpCommand } from \"./components\";\nimport type { HelpPluginContext, HelpPluginOptions } from \"./types/plugin\";\n\nexport type from \"./types\";\n\n/*\n The Help - Shell Shock plugin to add a help command to the application.\n */\nexport const plugin = <TContext extends HelpPluginContext = HelpPluginContext>(\n options: HelpPluginOptions = {}\n): Plugin<TContext>[] => {\n return [\n ...theme<TContext>(options.theme),\n ...console<TContext>(options.console),\n {\n name: \"shell-shock:help\",\n enforce: \"post\",\n config() {\n this.debug(\n \"Providing default configuration for the Shell Shock `help` plugin.\"\n );\n\n return {\n help: defu(\n {\n command:\n options.command === false\n ? false\n : isSetString(options.command)\n ? { name: options.command }\n : { name: \"help\" }\n },\n options,\n {\n builtins: true\n }\n )\n };\n },\n async configResolved() {\n this.debug(\"Adding the Help command to the application context.\");\n\n if (this.config.help.command !== false) {\n this.inputs ??= [];\n if (\n this.inputs.some(\n input =>\n input.name === (this.config.help.command as CommandConfig).name\n )\n ) {\n this.info(\n \"The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command.\"\n );\n } else {\n this.inputs.push({\n id: this.config.help.command.name,\n path: this.config.help.command.name,\n segments: [this.config.help.command.name],\n title: \"Help\",\n icon: \"🛈\",\n tags: [\"Utility\"],\n description: `Display command usage details and other useful information to the user.`,\n entry: {\n file: joinPaths(this.entryPath, \"help\", \"index.ts\"),\n input: {\n file: joinPaths(this.entryPath, \"help\", \"command.ts\")\n }\n },\n isVirtual: false,\n source: \"help-plugin\",\n ...this.config.help.command\n });\n }\n\n await render(this, <TemporaryHelpCommand />);\n }\n },\n prepare: {\n order: \"post\",\n async handler() {\n const commands = await getCommandList(this);\n this.debug(\n `Rendering \\`help\\` built-ins for each of the ${\n commands.length\n } command modules.`\n );\n\n const segments = computed(() =>\n getUniqueBy(\n commands.map(command =>\n command.segments\n .filter(segment => !isDynamicPathSegment(segment))\n .filter(segment => segment.length > 0)\n ),\n segments => segments.join(\"/\")\n )\n .filter(segments => segments.length > 0)\n .sort((a, b) => a.join(\"/\").localeCompare(b.join(\"/\")))\n );\n\n return render(\n this,\n <>\n <Show when={this.config.help.builtins !== false}>\n <HelpBuiltin command={computeBin(this)} />\n <Spacing />\n <For\n each={commands.sort((a, b) => a.name.localeCompare(b.name))}\n doubleHardline>\n {command => <HelpBuiltin command={command} />}\n </For>\n <HelpCommand ~~segments~~={segments.value} />\n </Show>\n </>\n );\n }\n }\n }\n ];\n};\n\nexport default plugin;\n"],"mappings":"~~;;;;;;;;;;;;;;;;;;;;AAuCE~~,~~QAAA~~;EAAA,GAAA,MAAA,~~QAAA~~,~~MAAA~~;~~EAAA~~,GAAA,QAAA,QAAA,~~QAAA~~;~~EAAA~~;~~GACC~~,~~MAAI;GACL~~,~~SAAA;GACF,~~SAAa~~;AACX~~,~~SAAS~~,~~MAAA~~,~~qEAAqB;AAC7B~~,~~WAAO~~,~~EACF~~,~~MAAC~~,~~KAAA~~,~~EACF~~,~~SAAM,QAAU,YAAc,~~QAAA,QAAA,YAAA,QAAA,QAAA,GAAA,~~EAC9B~~,~~MAAQ~~,QAAU,~~SACrB~~,GAAA,~~EACQ~~,~~MAAM~~,~~QACZ~~,~~EACA~~,EAAA,~~SAAS~~,~~EACP~~,~~UAAU~~,~~MACT~~,~~CAAC~~,~~EACH~~;;~~GAEH~~,~~MAAI~~,~~iBAAO~~;AACT,~~SAAI~~,~~MAAM~~,~~sDAAI~~;~~AACd~~,QAAI,~~KAAE~~,~~OAAA~~,KAAA,~~YAAA~~,~~OAAA~~;~~AACJ~~,~~UAAK~~,~~WAAQ~~,EAAA;~~AACb~~,~~SAAI~~,~~KAAI,OAAQ,MAAA,UAAY,MAAA,SAAA,~~KAAA,~~OAAA,KAAA,QAAA,KAAA,CAC1B,MAAK,KAAK,~~2LAAA;~~SAEV~~,~~MAAK~~,~~OAAO~~,~~KAAE~~;~~MACZ~~,~~IAAI~~,~~KAAK~~,~~OAAO~~,~~KAAG~~,~~QAAM~~;~~MACzB~~,~~MAAC~~,~~KAAA~~,~~OAAA~~,~~KAAA~~,~~QAAA~~;~~MACD~~,~~UAAO~~,CAAA,KAAA,OAAA,KAAA,QAAA,KAAA;~~MACP~~,~~OAAA~~;~~MACA~~,~~MAAE~~;~~MACF~~,~~MAAA~~,~~CAAA~~,~~UAAA~~;~~MACF~~,~~aAAA~~;MACD,~~OAAA~~;~~OACF~~,MAAA,UAAA,KAAA,WAAA,QAAA,WAAA;~~OACK~~,OAAA,~~EACC~~,~~MAAO~~,~~UAAW~~,~~KAAK~~,~~WAAW~~,~~QAAI~~,~~aAAY~~;~~OAEnD~~;MACF,~~WAAa~~;~~MACX~~,~~QAAC~~;~~MACD~~,~~GAAA~~,~~KAAK~~,OAAO,KAAI~~;MACjB~~,~~CAAC;AAEJ~~,~~WAAI~~,~~OAAA~~,~~MAAA~~,~~gBAAA,~~sBAAA,EAAA,CAAA,CAAA;;;~~GAGR~~,SAAS;IACP,OAAO;IACP,MAAM,~~UAAK~~;~~KACT~~,MAAI,~~SAAW~~;~~KACf~~,~~MAAM~~,WAAS,~~MAAO~~,~~eAAa~~,~~KAAI~~;~~AACvC~~,UAAK,MAAM,~~gDAA8B~~,~~SAAA~~,~~OAAA~~,~~mBAAA~~;~~KACzC~~,~~MAAM~~,~~WAAW~~,~~eAAY~~,~~YAAa~~,~~SAAK~~,KAAA,YAAA,QAAA,SAAA,QAAA,YAAA,CAAA,qBAAA,QAAA,CAAA,CAAA,QAAA,YAAA,QAAA,SAAA,EAAA,CAAA,GAAA,aAAA,SAAA,KAAA,IAAA,CAAA,CAAA,QAAA,aAAA,SAAA,SAAA,EAAA,CAAA,MAAA,GAAA,MAAA,EAAA,KAAA,IAAA,CAAA,cAAA,EAAA,KAAA,IAAA,CAAA,CAAA,CAAA;~~AAC/C~~,~~YAAM~~,~~OAAQ~~,~~MAAK~~,CAAA,gBAAA,MAAA;~~MACjB~~,~~IAAI~~,~~OAAO~~;~~AACT~~,~~cAAO~~,~~OAAG~~,~~OAAS~~,~~KAAA~~,~~aAAA~~;;~~MAErB~~,IAAI,~~WAAO~~;~~AACT~~,~~cAAI~~;~~QAAI~~,~~gBAAiB~~,~~aAAY~~,~~EACnC~~,~~IAAE~~,~~UAAO~~;~~AACP~~,~~gBAAO~~,~~WAAW~~,~~OAAK~~;~~WAE1B~~,CAAC;~~QAAC~~,~~gBAAA~~,SAAA,EAAA,CAAA;QAAA,gBAAA,KAAA;~~SACD~~,~~IAAA~~,~~OAAW~~;~~AACX~~,~~iBAAS~~,~~SAAK~~,~~MAAO~~,GAAA,MAAA,EAAA,KAAA,cAAA,EAAA,KAAA,CAAA;;~~SAErB~~,~~gBAAA~~;~~SACJ~~,~~WAAA~~,YAAA,gBAAA,aAAA,~~WAEK~~,~~CAAC;SACR~~,CAAA;~~QAAA~~,~~gBAAA~~,aAAA,~~EACD~~,IAAA,WAAA;~~AACQ~~,gBAAA,SAAA;~~WAEF~~,~~CAAC~~;~~QAAA~~;;~~MAEL~~,~~CAAC~~,CAAA,CAAA;;~~IAEL~~;GACF;EAAC"}
1	+ {"version":3,"file":"index.mjs","names":[],"sources":["../src/index.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 { computed, For, Show } from \"@alloy-js/core\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport {\n computeBin,\n getCommandList,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport type { CommandConfig } from \"@shell-shock/core/types/command\";\nimport console from \"@shell-shock/plugin-console\";\nimport theme from \"@shell-shock/plugin-theme\";\nimport { getUniqueBy } from \"@stryke/helpers/get-unique\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { HelpBuiltin, HelpCommand, TemporaryHelpCommand } from \"./components\";\nimport type { HelpPluginContext, HelpPluginOptions } from \"./types/plugin\";\n\nexport type from \"./types\";\n\n/*\n The Help - Shell Shock plugin to add a help command to the application.\n */\nexport const plugin = <TContext extends HelpPluginContext = HelpPluginContext>(\n options: HelpPluginOptions = {}\n): Plugin<TContext>[] => {\n return [\n ...theme<TContext>(options.theme),\n ...console<TContext>(options.console),\n {\n name: \"shell-shock:help\",\n enforce: \"post\",\n config() {\n this.debug(\n \"Providing default configuration for the Shell Shock `help` plugin.\"\n );\n\n return {\n help: defu(\n {\n command:\n options.command === false\n ? false\n : isSetString(options.command)\n ? { name: options.command }\n : { name: \"help\" }\n },\n options,\n {\n builtins: true\n }\n )\n };\n },\n async configResolved() {\n this.debug(\"Adding the Help command to the application context.\");\n\n if (this.config.help.command !== false) {\n this.inputs ??= [];\n if (\n this.inputs.some(\n (input: CommandConfig) =>\n input.name === (this.config.help.command as CommandConfig).name\n )\n ) {\n this.info(\n \"The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command.\"\n );\n } else {\n this.inputs.push({\n id: this.config.help.command.name,\n path: this.config.help.command.name,\n segments: [this.config.help.command.name],\n title: \"Help\",\n icon: \"🛈\",\n tags: [\"Utility\"],\n description: `Display command usage details and other useful information to the user.`,\n entry: {\n file: joinPaths(this.entryPath, \"help\", \"index.ts\"),\n input: {\n file: joinPaths(this.entryPath, \"help\", \"command.ts\")\n }\n },\n isVirtual: false,\n source: \"help-plugin\",\n ...this.config.help.command\n });\n }\n\n await render(this, <TemporaryHelpCommand />);\n }\n },\n prepare: {\n order: \"post\",\n async handler() {\n const commands = await getCommandList(this);\n\n this.debug(\n `Rendering \\`help\\` built-ins for each of the ${\n commands.length\n } command modules.`\n );\n\n const segments = computed(() =>\n getUniqueBy(\n commands.map(command =>\n command.segments\n .filter(segment => !isDynamicPathSegment(segment))\n .filter(segment => segment.length > 0)\n ),\n segments => segments.join(\"/\")\n )\n .filter(segments => segments.length > 0)\n .sort((a, b) => a.join(\"/\").localeCompare(b.join(\"/\")))\n );\n\n return render(\n this,\n <>\n <Show when={this.config.help.builtins !== false}>\n <HelpBuiltin command={computeBin(this)} />\n <Spacing />\n <For\n each={commands.sort((a, b) => a.name.localeCompare(b.name))}\n doubleHardline>\n {command => <HelpBuiltin command={command} />}\n </For>\n <HelpCommand commands={segments.value} />\n </Show>\n </>\n );\n }\n }\n }\n ];\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAiCA,MAAa,UAAU,UAAM,EAAA,KAAW;AACxC,QAAS;EAAA,GAAA,MAAA,QAAa,MAAW;EAAE,GAAA,QAAA,QAAA,QAA2B;EAAE;GAChE,MAAO;;GAEP,SAAa;;AAEX,WAAA,EACK,MAAO,KAAK,EACjB,SAAA,QAAA,YAAA,QAAA,QAAA,YAAA,QAAA,QAAA,GAAA,EACU,MAAC,QAAU,SACZ,GAAA,EACD,MAAQ,QACT,EACF,EAAA,SAAM,EACN,UAAQ,MACX,CAAA,EACE;;GAEF,MAAE,iBAAS;AACT,SAAE,MAAK,sDAAK;AACZ,QAAI,KAAC,OAAU,KAAA,YAAQ,OAAiB;AACtC,UAAC,WAAA,EAAA;mFAED,MAAO,KAAA,2LAAA;SAEL,MAAE,OAAA,KAAA;MACA,IAAE,KAAO,OAAA,KAAA,QAAA;MACT,MAAI,KAAO,OAAC,KAAW,QAAC;MACxB,UAAQ,CAAA,KAAA,OAAA,KAAA,QAAA,KAAA;MACR,OAAO;MACP,MAAM;MACN,MAAM,CAAC,UAAU;MACjB,aAAC;MACD,OAAO;OACP,MAAA,UAAA,KAAA,WAAA,QAAA,WAAA;OACE,OAAA,EACF,MAAA,UAAA,KAAA,WAAA,QAAA,aAAA,EACF;OACD;MACF,WAAA;MACK,QAAA;MACA,GAAC,KAAO,OAAO,KAAI;;AAGvB,WAAM,OAAO,MAAM,gBAAC,sBAAA,EAAA,CAAA,CAAA;;;GAGxB,SAAS;IACP,OAAO;IACP,MAAM,UAAA;KACJ,MAAI,SAAA;KACJ,MAAI,WAAS,MAAA,eAAA,KAAA;AACb,UAAK,MAAM,gDAA8C,SAAS,OAAS,mBAAe;KAC1F,MAAK,WAAA,eAAA,YAAA,SAAA,KAAA,YAAA,QAAA,SAAA,QAAA,YAAA,CAAA,qBAAA,QAAA,CAAA,CAAA,QAAA,YAAA,QAAA,SAAA,EAAA,CAAA,GAAA,aAAA,SAAA,KAAA,IAAA,CAAA,CAAA,QAAA,aAAA,SAAA,SAAA,EAAA,CAAA,MAAA,GAAA,MAAA,EAAA,KAAA,IAAA,CAAA,cAAA,EAAA,KAAA,IAAA,CAAA,CAAA,CAAA;AACL,YAAI,OAAK,MAAA,CAAA,gBAAA,MAAA;MACP,IAAE,OAAK;AACL,cAAM,OAAK,OAAO,KAAK,aAAY;;MAErC,IAAI,WAAW;AACb,cAAO;QAAC,gBAAO,aAAA,EACb,IAAI,UAAM;AACV,gBAAQ,WAAS,OAAA;WAElB,CAAC;QAAA,gBAAO,SAAA,EAAA,CAAA;QAAA,gBAAA,KAAA;SACP,IAAE,OAAM;AACN,iBAAO,SAAA,MAAA,GAAA,MAAA,EAAA,KAAA,cAAA,EAAA,KAAA,CAAA;;SAET,gBAAE;SACF,WAAC,YAAA,gBAAA,aAAA,EACU,SACX,CAAA;SACD,CAAC;QAAE,gBAAkB,aAAA,EACpB,IAAA,WAAA;AACJ,gBAAA,SAAA;WAEA,CAAA;QAAK;;MAER,CAAA,CAAA,CAAA;;IAEF;GACF;EAAC"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/plugin-help",
-  "version": "0.2.25",
+  "version": "0.2.28",
   "private": false,
   "description": "A package containing a Shell Shock plugin to provide help and documentation for the local application's commands.",
   "keywords": [
@@ -153,24 +153,24 @@
   "dependencies": {
     "@alloy-js/core": "0.23.0-dev.8",
     "@alloy-js/typescript": "0.23.0-dev.4",
-    "@powerlines/deepkit": "^0.8.2",
-    "@powerlines/plugin-alloy": "^0.26.18",
-    "@powerlines/plugin-plugin": "^0.12.350",
-    "@shell-shock/core": "^0.17.7",
-    "@shell-shock/plugin-console": "^0.2.11",
-    "@shell-shock/plugin-theme": "^0.4.20",
-    "@stryke/helpers": "^0.10.8",
-    "@stryke/path": "^0.27.4",
-    "@stryke/string-format": "^0.17.9",
-    "@stryke/type-checks": "^0.6.1",
-    "@stryke/types": "^0.11.3",
+    "@powerlines/deepkit": "^0.8.64",
+    "@powerlines/plugin-alloy": "^0.26.84",
+    "@powerlines/plugin-plugin": "^0.12.416",
+    "@shell-shock/core": "^0.17.10",
+    "@shell-shock/plugin-console": "^0.2.14",
+    "@shell-shock/plugin-theme": "^0.4.23",
+    "@stryke/helpers": "^0.10.12",
+    "@stryke/path": "^0.28.2",
+    "@stryke/string-format": "^0.17.13",
+    "@stryke/type-checks": "^0.6.5",
+    "@stryke/types": "^0.12.0",
     "defu": "^6.1.7",
-    "powerlines": "^0.42.40"
+    "powerlines": "^0.47.4"
   },
   "devDependencies": {
-    "@powerlines/plugin-deepkit": "^0.11.280",
+    "@powerlines/plugin-deepkit": "^0.11.347",
     "@types/node": "^25.6.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "dcc6ef2c66de17416af3242b25b977c49974b4a1"
+  "gitHead": "7b4030fd6be000c960e8cc4c4f7b4db205054e69"
 }