@shell-shock/preset-script 0.4.1 → 0.4.2
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.
- package/dist/components/bin-entry.cjs +5 -1
- package/dist/components/bin-entry.cjs.map +1 -1
- package/dist/components/bin-entry.mjs +5 -1
- package/dist/components/bin-entry.mjs.map +1 -1
- package/dist/components/command-entry.cjs +66 -71
- package/dist/components/command-entry.cjs.map +1 -1
- package/dist/components/command-entry.d.cts.map +1 -1
- package/dist/components/command-entry.d.mts.map +1 -1
- package/dist/components/command-entry.mjs +67 -72
- package/dist/components/command-entry.mjs.map +1 -1
- package/dist/components/console-builtin.cjs +7 -6
- package/dist/components/console-builtin.cjs.map +1 -1
- package/dist/components/console-builtin.d.cts +1 -0
- package/dist/components/console-builtin.d.cts.map +1 -1
- package/dist/components/console-builtin.d.mts +1 -0
- package/dist/components/console-builtin.d.mts.map +1 -1
- package/dist/components/console-builtin.mjs +7 -6
- package/dist/components/console-builtin.mjs.map +1 -1
- package/dist/components/help.cjs +2 -2
- package/dist/components/help.cjs.map +1 -1
- package/dist/components/help.d.cts +7 -7
- package/dist/components/help.d.cts.map +1 -1
- package/dist/components/help.d.mts.map +1 -1
- package/dist/components/help.mjs +2 -2
- package/dist/components/help.mjs.map +1 -1
- package/dist/components/utils-builtin.d.cts +7 -7
- package/dist/components/virtual-command-entry.cjs +2 -1
- package/dist/components/virtual-command-entry.cjs.map +1 -1
- package/dist/components/virtual-command-entry.mjs +2 -1
- package/dist/components/virtual-command-entry.mjs.map +1 -1
- package/dist/types/plugin.d.cts.map +1 -1
- package/package.json +5 -5
package/dist/components/help.cjs
CHANGED
|
@@ -176,7 +176,7 @@ function VirtualHelp(props) {
|
|
|
176
176
|
ender: __alloy_js_core.code`writeLine(""); `,
|
|
177
177
|
children: (child) => [
|
|
178
178
|
(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`
|
|
179
|
-
writeLine(colors.text.heading.primary("${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
179
|
+
writeLine(colors.text.heading.primary(${child.icon ? `(isUnicodeSupported ? " ${child.icon} " : "") + ` : ""}"${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
180
180
|
writeLine("");
|
|
181
181
|
writeLine(colors.text.body.secondary("${child.description}"));
|
|
182
182
|
writeLine("");
|
|
@@ -233,7 +233,7 @@ function CommandHelp(props) {
|
|
|
233
233
|
ender: __alloy_js_core.code`writeLine(""); `,
|
|
234
234
|
children: (child) => [
|
|
235
235
|
(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`
|
|
236
|
-
writeLine(colors.text.heading.primary("${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
236
|
+
writeLine(colors.text.heading.primary(${child.icon ? `(isUnicodeSupported ? " ${child.icon} " : "") + ` : ""}"${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
237
237
|
writeLine("");
|
|
238
238
|
writeLine(colors.text.body.secondary("${child.description}"));
|
|
239
239
|
writeLine("");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.cjs","names":["code","computed","For","Show","ReflectionKind","usePowerlines","Usage","getAppBin","sortOptions","kebabCase","snakeCase","useTheme","HelpUsage","props","command","indent","context","theme","_$createComponent","each","Object","keys","config","bin","hardline","children","_$memo","padding","app","_$createIntrinsic","HelpOptions","options","option","flags","names","name","length","push","alias","forEach","sort","join","kind","string","variadic","number","description","replace","env","default","undefined","envPrefix","JSON","stringify","HelpCommands","commands","values","child","BaseHelp","filterGlobalOptions","filter","some","globalOption","includes","when","value","VirtualHelp","path","doubleHardline","joiner","ender","title","isVirtual","segments","CommandHelp"],"sources":["../../src/components/help.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { Usage } from \"@shell-shock/core/components/usage\";\nimport { getAppBin } from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport { sortOptions } from \"@shell-shock/core/plugin-utils/reflect\";\nimport type {\n CommandOption,\n CommandTree,\n CommandTreePath\n} from \"@shell-shock/core/types/command\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { useTheme } from \"../contexts\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\n\nexport interface HelpUsageProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 2\n */\n indent?: number;\n}\n\n/**\n * A component that generates the usage display for a command.\n */\nexport function HelpUsage(props: HelpUsageProps) {\n const { command, indent = 2 } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const theme = useTheme();\n\n return (\n <For each={Object.keys(context.config.bin)} hardline>\n {bin => (\n <>\n {code`\n writeLine(\n colors.text.body.primary(\"`}\n <Usage bin={bin} command={command} />\n {code`\"), { padding: ${theme.padding.app * indent} }\n );`}\n <hbr />\n </>\n )}\n </For>\n );\n}\n\nexport interface HelpOptionsProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n}\n\n/**\n * A component that generates the options table display for a command.\n */\nexport function HelpOptions(props: HelpOptionsProps) {\n const { options } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={sortOptions(options)} hardline>\n {option => {\n const flags = [] as string[];\n const names = [] as string[];\n if (option.name.length === 1) {\n flags.push(`-${option.name}`);\n } else {\n names.push(`--${kebabCase(option.name)}`);\n }\n\n option.alias.forEach((alias: string) => {\n if (alias.length === 1) {\n flags.push(`-${alias}`);\n } else {\n names.push(`--${kebabCase(alias)}`);\n }\n });\n\n return code`[{ value: colors.text.body.primary(\"${\n flags.length > 0\n ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n : \"\"\n }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n option.kind === ReflectionKind.string\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : option.kind === ReflectionKind.number\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : \"\"\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${option.description.replace(\n /\\.+$/,\n \"\"\n )} ${\n option.env || option.default !== undefined\n ? `(${\n option.env\n ? `env: ${context.config.envPrefix}_${option.env}${\n option.default !== undefined ? \", \" : \"\"\n }`\n : \"\"\n }${\n option.default !== undefined\n ? `default: ${JSON.stringify(option.default)}`\n : \"\"\n })`\n : \"\"\n }.\"), align: \"left\", border: \"none\" }], `;\n }}\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface HelpCommandsProps {\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n}\n\n/**\n * A component that generates the commands table display for a command.\n */\nexport function HelpCommands(props: HelpCommandsProps) {\n const { commands } = props;\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={Object.values(commands)} hardline>\n {child =>\n code`[{ value: colors.text.body.primary(\"${\n child.name\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${child.description.replace(\n /\\.+$/,\n \"\"\n )}\"), align: \"left\", border: \"none\" }], `\n }\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface BaseHelpProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * Whether to filter out global options from the help display.\n *\n * @remarks\n * When enabled, any options that are present in the global options context will be filtered out from the help display. This is useful for sub-commands to avoid displaying global options that are not relevant to the specific command.\n *\n * @defaultValue false\n */\n filterGlobalOptions?: boolean;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 1\n */\n indent?: number;\n}\n\n/**\n * A component that generates the `help` function declaration for a command.\n */\nexport function BaseHelp(props: BaseHelpProps) {\n const { command, indent = 1, filterGlobalOptions = false } = props;\n\n const theme = useTheme();\n const context = usePowerlines<ScriptPresetContext>();\n\n const options = computed(() =>\n filterGlobalOptions\n ? Object.values(command.options).filter(\n option =>\n !context.options.some(\n globalOption =>\n globalOption.name === option.name ||\n option.alias.includes(globalOption.name) ||\n globalOption.alias?.includes(option.name) ||\n globalOption.alias?.some(alias => option.alias.includes(alias))\n )\n )\n : Object.values(command.options)\n );\n\n return (\n <>\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Usage:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpUsage command={command} indent={indent} />\n <hbr />\n <hbr />\n <Show when={options.value.length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Options:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpOptions options={options.value} />\n <hbr />\n <hbr />\n </Show>\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Commands:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpCommands commands={command.children} />\n <hbr />\n <hbr />\n </Show>\n </>\n );\n}\n\nexport interface VirtualHelpProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n\n /**\n * The command path to generate help for, used for generating the help invocation instructions.\n *\n * @remarks\n * This is optional since the virtual command entry component can be used for both the global binary executable and virtual commands (there will be no command definition for the binary executable).\n */\n path?: CommandTreePath;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function VirtualHelp(props: VirtualHelpProps) {\n const { options, path, commands } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Global Options:\")));`}\n <hbr />\n <HelpOptions options={options} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(commands).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(commands)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(\"${child.title} ${\n child.isVirtual ? \"\" : \"Command\"\n }\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )}${\n path?.segments && path.segments.length > 0\n ? ` ${path.segments.join(\" \")}`\n : \"\"\n } <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n\nexport interface CommandHelpProps {\n /**\n * A mapping of command names to their command definitions.\n */\n command: CommandTree;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function CommandHelp(props: CommandHelpProps) {\n const { command } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <BaseHelp command={command} filterGlobalOptions={false} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following sub-commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(command.children)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(\"${child.title} ${\n child.isVirtual ? \"\" : \"Command\"\n }\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )} ${command.path.segments.join(\" \")} <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAsDA,SAAgBY,UAAUC,OAAuB;CAC/C,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMG,8EAA8C;CACpD,MAAMC,QAAQN,iCAAU;AAExB,yDACGT,qBAAG;EAAA,IAACiB,OAAI;AAAA,UAAEC,OAAOC,KAAKL,QAAQM,OAAOC,IAAI;;EAAEC,UAAQ;EAAAC,WACjDF,QAAG;GAECvB,oBAAI;;;oDAGJM,2CAAK;IAAMiB;IAAcT;IAAO,CAAA;+CAChCd,oBAAI,kBAAkBiB,MAAMU,QAAQC,MAAMb,OAAM;UAClD;oDAAA,OAAA,EAAA,CAAA;GAAA;EAGF,CAAA;;;;;AAeP,SAAgBe,YAAYjB,OAAyB;CACnD,MAAM,EAAEkB,YAAYlB;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,oEAAcY,QAAQ;;GAAEP,UAAQ;GAAAC,WACtCO,WAAU;IACT,MAAMC,QAAQ,EAAc;IAC5B,MAAMC,QAAQ,EAAc;AAC5B,QAAIF,OAAOG,KAAKC,WAAW,EACzBH,OAAMI,KAAK,IAAIL,OAAOG,OAAO;QAE7BD,OAAMG,KAAK,sDAAeL,OAAOG,KAAK,GAAG;AAG3CH,WAAOM,MAAMC,SAASD,UAAkB;AACtC,SAAIA,MAAMF,WAAW,EACnBH,OAAMI,KAAK,IAAIC,QAAQ;SAEvBJ,OAAMG,KAAK,sDAAeC,MAAM,GAAG;MAErC;AAEF,WAAOtC,oBAAI,uCACTiC,MAAMG,SAAS,IACX,GAAGH,MAAMO,MAAM,CAACC,KAAK,KAAK,GAAGP,MAAME,SAAS,IAAI,OAAO,OACvD,KACHF,MAAME,SAAS,IAAIF,MAAMM,MAAM,CAACC,KAAK,KAAK,GAAG,KAC9CT,OAAOU,SAAStC,gDAAeuC,SAC3B,sDAAeX,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1DZ,OAAOU,SAAStC,gDAAeyC,SAC7B,sDAAeb,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1D,GAAE,4EACmEZ,OAAOc,YAAYC,QAC9F,QACA,GACD,CAAA,GACCf,OAAOgB,OAAOhB,OAAOiB,YAAYC,SAC7B,IACElB,OAAOgB,MACH,QAAQhC,QAAQM,OAAO6B,UAAS,GAAInB,OAAOgB,MACzChB,OAAOiB,YAAYC,SAAY,OAAO,OAExC,KAEJlB,OAAOiB,YAAYC,SACf,YAAYE,KAAKC,UAAUrB,OAAOiB,QAAQ,KAC1C,GAAE,KAER,GAAE;;GAET,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGFjD,oBAAI;EAAO;;;;;AAelB,SAAgBsD,aAAazC,OAA0B;CACrD,MAAM,EAAE0C,aAAa1C;AAErB,QAAA;EAEKb,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,WAAEC,OAAOoC,OAAOD,SAAS;;GAAE/B,UAAQ;GAAAC,WACzCgC,UACCzD,oBAAI,uCACFyD,MAAMtB,KAAI,4EACiEsB,MAAMX,YAAYC,QAC7F,QACA,GACD,CAAA;GAAwC,CAAA;mDAAA,OAAA,EAAA,CAAA;EAI5C/C,oBAAI;EAAO;;;;;AAmClB,SAAgB0D,SAAS7C,OAAsB;CAC7C,MAAM,EAAEC,SAASC,SAAS,GAAG4C,sBAAsB,UAAU9C;CAE7D,MAAMI,QAAQN,iCAAU;CACxB,MAAMK,8EAA8C;CAEpD,MAAMe,8CACJ4B,sBACIvC,OAAOoC,OAAO1C,QAAQiB,QAAQ,CAAC6B,QAC7B5B,WACE,CAAChB,QAAQe,QAAQ8B,MACfC,iBACEA,aAAa3B,SAASH,OAAOG,QAC7BH,OAAOM,MAAMyB,SAASD,aAAa3B,KAAK,IACxC2B,aAAaxB,OAAOyB,SAAS/B,OAAOG,KAAK,IACzC2B,aAAaxB,OAAOuB,MAAKvB,UAASN,OAAOM,MAAMyB,SAASzB,MAAM,CAClE,CACJ,CAAC,GACDlB,OAAOoC,OAAO1C,QAAQiB,QAC5B,CAAC;AAED,QAAA;8CAEK/B,oBAAI,iEACHe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;mDAAA,OAAA,EAAA,CAAA;mDAEHH,WAAS;GAAUE;GAAiBC;GAAM,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAG1CZ,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAEjC,QAAQkC,MAAM7B,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;iDACjCzB,oBAAI;wEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDe,aAAW,EAAA,IAACC,UAAO;AAAA,aAAEA,QAAQkC;QAAK,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;mDAIpC9D,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;iDACjDzB,oBAAI;yEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDuC,cAAY,EAAA,IAACC,WAAQ;AAAA,aAAEzC,QAAQW;QAAQ,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAA;;;;;AA+BhD,SAAgByC,YAAYrD,OAAyB;CACnD,MAAM,EAAEkB,SAASoC,MAAMZ,aAAa1C;CAEpC,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;;mDACW,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGfA,oBAAI;mDAA2E,OAAA,EAAA,CAAA;mDAE/E8B,aAAW,EAAUC,SAAO,CAAA;EAC5B/B,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrBG,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKkC,SAAS,CAACnB,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACzCzB,oBAAI;;sDACW,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAGfE,qBAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAOD,SAAS;;MAC7Ba,gBAAc;MACdC,QAAQrE,oBAAI;MACZsE,OAAOtE,oBAAI;MAAiByB,WAC3BgC,UAAK;mDAEDzD,oBAAI;yDACsCyD,MAAMc,MAAK,GAClDd,MAAMe,YAAY,KAAK,UAAS;;wDAGMf,MAAMX,YAAW;;kBAExD;wDAAA,OAAA,EAAA,CAAA;wDAEFY,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;wDAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;iDAEF3D,oBAAI,6HACHgB,QACD,GACCmD,MAAMM,YAAYN,KAAKM,SAASrC,SAAS,IACrC,IAAI+B,KAAKM,SAAShC,KAAK,IAAI,KAC3B,GAAE;wBAEO;KAAA;;GAAA,CAAA;EAAA;;;;;AAgBvB,SAAgBiC,YAAY7D,OAAyB;CACnD,MAAM,EAAEC,YAAYD;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrB0D,UAAQ;GAAU5C;GAAS6C,qBAAqB;GAAK,CAAA;EACrD3D,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrBG,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACjDzB,oBAAI;;sDACW,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAGfE,qBAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAO1C,QAAQW,SAAS;;MACrC2C,gBAAc;MACdC,QAAQrE,oBAAI;MACZsE,OAAOtE,oBAAI;MAAiByB,WAC3BgC,UAAK;mDAEDzD,oBAAI;yDACsCyD,MAAMc,MAAK,GAClDd,MAAMe,YAAY,KAAK,UAAS;;wDAGMf,MAAMX,YAAW;;kBAExD;wDAAA,OAAA,EAAA,CAAA;wDAEFY,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;wDAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;iDAEF3D,oBAAI,6HACHgB,QACD,CAAA,GAAIF,QAAQqD,KAAKM,SAAShC,KAAK,IAAI,CAAA;wBACrB;KAAA;;GAAA,CAAA;EAAA"}
|
|
1
|
+
{"version":3,"file":"help.cjs","names":["code","computed","For","Show","ReflectionKind","usePowerlines","Usage","getAppBin","sortOptions","kebabCase","snakeCase","useTheme","HelpUsage","props","command","indent","context","theme","_$createComponent","each","Object","keys","config","bin","hardline","children","_$memo","padding","app","_$createIntrinsic","HelpOptions","options","option","flags","names","name","length","push","alias","forEach","sort","join","kind","string","variadic","number","description","replace","env","default","undefined","envPrefix","JSON","stringify","HelpCommands","commands","values","child","BaseHelp","filterGlobalOptions","filter","some","globalOption","includes","when","value","VirtualHelp","path","doubleHardline","joiner","ender","icon","title","isVirtual","segments","CommandHelp"],"sources":["../../src/components/help.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { Usage } from \"@shell-shock/core/components/usage\";\nimport { getAppBin } from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport { sortOptions } from \"@shell-shock/core/plugin-utils/reflect\";\nimport type {\n CommandOption,\n CommandTree,\n CommandTreePath\n} from \"@shell-shock/core/types/command\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { useTheme } from \"../contexts\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\n\nexport interface HelpUsageProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 2\n */\n indent?: number;\n}\n\n/**\n * A component that generates the usage display for a command.\n */\nexport function HelpUsage(props: HelpUsageProps) {\n const { command, indent = 2 } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const theme = useTheme();\n\n return (\n <For each={Object.keys(context.config.bin)} hardline>\n {bin => (\n <>\n {code`\n writeLine(\n colors.text.body.primary(\"`}\n <Usage bin={bin} command={command} />\n {code`\"), { padding: ${theme.padding.app * indent} }\n );`}\n <hbr />\n </>\n )}\n </For>\n );\n}\n\nexport interface HelpOptionsProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n}\n\n/**\n * A component that generates the options table display for a command.\n */\nexport function HelpOptions(props: HelpOptionsProps) {\n const { options } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={sortOptions(options)} hardline>\n {option => {\n const flags = [] as string[];\n const names = [] as string[];\n if (option.name.length === 1) {\n flags.push(`-${option.name}`);\n } else {\n names.push(`--${kebabCase(option.name)}`);\n }\n\n option.alias.forEach((alias: string) => {\n if (alias.length === 1) {\n flags.push(`-${alias}`);\n } else {\n names.push(`--${kebabCase(alias)}`);\n }\n });\n\n return code`[{ value: colors.text.body.primary(\"${\n flags.length > 0\n ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n : \"\"\n }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n option.kind === ReflectionKind.string\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : option.kind === ReflectionKind.number\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : \"\"\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${option.description.replace(\n /\\.+$/,\n \"\"\n )} ${\n option.env || option.default !== undefined\n ? `(${\n option.env\n ? `env: ${context.config.envPrefix}_${option.env}${\n option.default !== undefined ? \", \" : \"\"\n }`\n : \"\"\n }${\n option.default !== undefined\n ? `default: ${JSON.stringify(option.default)}`\n : \"\"\n })`\n : \"\"\n }.\"), align: \"left\", border: \"none\" }], `;\n }}\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface HelpCommandsProps {\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n}\n\n/**\n * A component that generates the commands table display for a command.\n */\nexport function HelpCommands(props: HelpCommandsProps) {\n const { commands } = props;\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={Object.values(commands)} hardline>\n {child =>\n code`[{ value: colors.text.body.primary(\"${\n child.name\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${child.description.replace(\n /\\.+$/,\n \"\"\n )}\"), align: \"left\", border: \"none\" }], `\n }\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface BaseHelpProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * Whether to filter out global options from the help display.\n *\n * @remarks\n * When enabled, any options that are present in the global options context will be filtered out from the help display. This is useful for sub-commands to avoid displaying global options that are not relevant to the specific command.\n *\n * @defaultValue false\n */\n filterGlobalOptions?: boolean;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 1\n */\n indent?: number;\n}\n\n/**\n * A component that generates the `help` function declaration for a command.\n */\nexport function BaseHelp(props: BaseHelpProps) {\n const { command, indent = 1, filterGlobalOptions = false } = props;\n\n const theme = useTheme();\n const context = usePowerlines<ScriptPresetContext>();\n\n const options = computed(() =>\n filterGlobalOptions\n ? Object.values(command.options).filter(\n option =>\n !context.options.some(\n globalOption =>\n globalOption.name === option.name ||\n option.alias.includes(globalOption.name) ||\n globalOption.alias?.includes(option.name) ||\n globalOption.alias?.some(alias => option.alias.includes(alias))\n )\n )\n : Object.values(command.options)\n );\n\n return (\n <>\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Usage:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpUsage command={command} indent={indent} />\n <hbr />\n <hbr />\n <Show when={options.value.length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Options:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpOptions options={options.value} />\n <hbr />\n <hbr />\n </Show>\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Commands:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpCommands commands={command.children} />\n <hbr />\n <hbr />\n </Show>\n </>\n );\n}\n\nexport interface VirtualHelpProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n\n /**\n * The command path to generate help for, used for generating the help invocation instructions.\n *\n * @remarks\n * This is optional since the virtual command entry component can be used for both the global binary executable and virtual commands (there will be no command definition for the binary executable).\n */\n path?: CommandTreePath;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function VirtualHelp(props: VirtualHelpProps) {\n const { options, path, commands } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Global Options:\")));`}\n <hbr />\n <HelpOptions options={options} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(commands).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(commands)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\"${child.title} ${child.isVirtual ? \"\" : \"Command\"}\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )}${\n path?.segments && path.segments.length > 0\n ? ` ${path.segments.join(\" \")}`\n : \"\"\n } <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n\nexport interface CommandHelpProps {\n /**\n * A mapping of command names to their command definitions.\n */\n command: CommandTree;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function CommandHelp(props: CommandHelpProps) {\n const { command } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <BaseHelp command={command} filterGlobalOptions={false} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following sub-commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(command.children)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\"${child.title} ${child.isVirtual ? \"\" : \"Command\"}\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )} ${command.path.segments.join(\" \")} <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAsDA,SAAgBY,UAAUC,OAAuB;CAC/C,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMG,8EAA8C;CACpD,MAAMC,QAAQN,iCAAU;AAExB,yDACGT,qBAAG;EAAA,IAACiB,OAAI;AAAA,UAAEC,OAAOC,KAAKL,QAAQM,OAAOC,IAAI;;EAAEC,UAAQ;EAAAC,WACjDF,QAAG;GAECvB,oBAAI;;;oDAGJM,2CAAK;IAAMiB;IAAcT;IAAO,CAAA;+CAChCd,oBAAI,kBAAkBiB,MAAMU,QAAQC,MAAMb,OAAM;UAClD;oDAAA,OAAA,EAAA,CAAA;GAAA;EAGF,CAAA;;;;;AAeP,SAAgBe,YAAYjB,OAAyB;CACnD,MAAM,EAAEkB,YAAYlB;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,oEAAcY,QAAQ;;GAAEP,UAAQ;GAAAC,WACtCO,WAAU;IACT,MAAMC,QAAQ,EAAc;IAC5B,MAAMC,QAAQ,EAAc;AAC5B,QAAIF,OAAOG,KAAKC,WAAW,EACzBH,OAAMI,KAAK,IAAIL,OAAOG,OAAO;QAE7BD,OAAMG,KAAK,sDAAeL,OAAOG,KAAK,GAAG;AAG3CH,WAAOM,MAAMC,SAASD,UAAkB;AACtC,SAAIA,MAAMF,WAAW,EACnBH,OAAMI,KAAK,IAAIC,QAAQ;SAEvBJ,OAAMG,KAAK,sDAAeC,MAAM,GAAG;MAErC;AAEF,WAAOtC,oBAAI,uCACTiC,MAAMG,SAAS,IACX,GAAGH,MAAMO,MAAM,CAACC,KAAK,KAAK,GAAGP,MAAME,SAAS,IAAI,OAAO,OACvD,KACHF,MAAME,SAAS,IAAIF,MAAMM,MAAM,CAACC,KAAK,KAAK,GAAG,KAC9CT,OAAOU,SAAStC,gDAAeuC,SAC3B,sDAAeX,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1DZ,OAAOU,SAAStC,gDAAeyC,SAC7B,sDAAeb,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1D,GAAE,4EACmEZ,OAAOc,YAAYC,QAC9F,QACA,GACD,CAAA,GACCf,OAAOgB,OAAOhB,OAAOiB,YAAYC,SAC7B,IACElB,OAAOgB,MACH,QAAQhC,QAAQM,OAAO6B,UAAS,GAAInB,OAAOgB,MACzChB,OAAOiB,YAAYC,SAAY,OAAO,OAExC,KAEJlB,OAAOiB,YAAYC,SACf,YAAYE,KAAKC,UAAUrB,OAAOiB,QAAQ,KAC1C,GAAE,KAER,GAAE;;GAET,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGFjD,oBAAI;EAAO;;;;;AAelB,SAAgBsD,aAAazC,OAA0B;CACrD,MAAM,EAAE0C,aAAa1C;AAErB,QAAA;EAEKb,oBAAI;mDAAU,OAAA,EAAA,CAAA;mDAEdE,qBAAG;GAAA,IAACiB,OAAI;AAAA,WAAEC,OAAOoC,OAAOD,SAAS;;GAAE/B,UAAQ;GAAAC,WACzCgC,UACCzD,oBAAI,uCACFyD,MAAMtB,KAAI,4EACiEsB,MAAMX,YAAYC,QAC7F,QACA,GACD,CAAA;GAAwC,CAAA;mDAAA,OAAA,EAAA,CAAA;EAI5C/C,oBAAI;EAAO;;;;;AAmClB,SAAgB0D,SAAS7C,OAAsB;CAC7C,MAAM,EAAEC,SAASC,SAAS,GAAG4C,sBAAsB,UAAU9C;CAE7D,MAAMI,QAAQN,iCAAU;CACxB,MAAMK,8EAA8C;CAEpD,MAAMe,8CACJ4B,sBACIvC,OAAOoC,OAAO1C,QAAQiB,QAAQ,CAAC6B,QAC7B5B,WACE,CAAChB,QAAQe,QAAQ8B,MACfC,iBACEA,aAAa3B,SAASH,OAAOG,QAC7BH,OAAOM,MAAMyB,SAASD,aAAa3B,KAAK,IACxC2B,aAAaxB,OAAOyB,SAAS/B,OAAOG,KAAK,IACzC2B,aAAaxB,OAAOuB,MAAKvB,UAASN,OAAOM,MAAMyB,SAASzB,MAAM,CAClE,CACJ,CAAC,GACDlB,OAAOoC,OAAO1C,QAAQiB,QAC5B,CAAC;AAED,QAAA;8CAEK/B,oBAAI,iEACHe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;mDAAA,OAAA,EAAA,CAAA;mDAEHH,WAAS;GAAUE;GAAiBC;GAAM,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAG1CZ,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAEjC,QAAQkC,MAAM7B,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;iDACjCzB,oBAAI;wEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDe,aAAW,EAAA,IAACC,UAAO;AAAA,aAAEA,QAAQkC;QAAK,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;mDAIpC9D,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;iDACjDzB,oBAAI;yEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;sDAAA,OAAA,EAAA,CAAA;sDAEDuC,cAAY,EAAA,IAACC,WAAQ;AAAA,aAAEzC,QAAQW;QAAQ,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAA;;;;;AA+BhD,SAAgByC,YAAYrD,OAAyB;CACnD,MAAM,EAAEkB,SAASoC,MAAMZ,aAAa1C;CAEpC,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;;mDACW,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;EAGfA,oBAAI;mDAA2E,OAAA,EAAA,CAAA;mDAE/E8B,aAAW,EAAUC,SAAO,CAAA;EAC5B/B,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrBG,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKkC,SAAS,CAACnB,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACzCzB,oBAAI;;sDACW,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAGfE,qBAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAOD,SAAS;;MAC7Ba,gBAAc;MACdC,QAAQrE,oBAAI;MACZsE,OAAOtE,oBAAI;MAAiByB,WAC3BgC,UAAK;mDAEDzD,oBAAI;wDAEDyD,MAAMc,OACF,2BAA2Bd,MAAMc,KAAI,gBACrC,GAAE,GACJd,MAAMe,MAAK,GAAIf,MAAMgB,YAAY,KAAK,UAAS;;wDAEXhB,MAAMX,YAAW;;kBAExD;wDAAA,OAAA,EAAA,CAAA;wDAEFY,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;wDAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;iDAEF3D,oBAAI,6HACHgB,QACD,GACCmD,MAAMO,YAAYP,KAAKO,SAAStC,SAAS,IACrC,IAAI+B,KAAKO,SAASjC,KAAK,IAAI,KAC3B,GAAE;wBAEO;KAAA;;GAAA,CAAA;EAAA;;;;;AAgBvB,SAAgBkC,YAAY9D,OAAyB;CACnD,MAAM,EAAEC,YAAYD;CAEpB,MAAMG,8EAA8C;AAEpD,QAAA;EAEKhB,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrB0D,UAAQ;GAAU5C;GAAS6C,qBAAqB;GAAK,CAAA;EACrD3D,oBAAI;mDAAiB,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGrBG,sBAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACjDzB,oBAAI;;sDACW,OAAA,EAAA,CAAA;sDAAA,OAAA,EAAA,CAAA;sDAGfE,qBAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAO1C,QAAQW,SAAS;;MACrC2C,gBAAc;MACdC,QAAQrE,oBAAI;MACZsE,OAAOtE,oBAAI;MAAiByB,WAC3BgC,UAAK;mDAEDzD,oBAAI;wDAEDyD,MAAMc,OACF,2BAA2Bd,MAAMc,KAAI,gBACrC,GAAE,GACJd,MAAMe,MAAK,GAAIf,MAAMgB,YAAY,KAAK,UAAS;;wDAEXhB,MAAMX,YAAW;;kBAExD;wDAAA,OAAA,EAAA,CAAA;wDAEFY,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;wDAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;iDAEF3D,oBAAI,6HACHgB,QACD,CAAA,GAAIF,QAAQqD,KAAKO,SAASjC,KAAK,IAAI,CAAA;wBACrB;KAAA;;GAAA,CAAA;EAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
import { CommandOption, CommandTree, CommandTreePath } from "@shell-shock/core/types/command";
|
|
3
3
|
|
|
4
4
|
//#region src/components/help.d.ts
|
|
@@ -20,7 +20,7 @@ interface HelpUsageProps {
|
|
|
20
20
|
/**
|
|
21
21
|
* A component that generates the usage display for a command.
|
|
22
22
|
*/
|
|
23
|
-
declare function HelpUsage(props: HelpUsageProps):
|
|
23
|
+
declare function HelpUsage(props: HelpUsageProps): _alloy_js_core0.Children;
|
|
24
24
|
interface HelpOptionsProps {
|
|
25
25
|
/**
|
|
26
26
|
* The options to display help for.
|
|
@@ -30,7 +30,7 @@ interface HelpOptionsProps {
|
|
|
30
30
|
/**
|
|
31
31
|
* A component that generates the options table display for a command.
|
|
32
32
|
*/
|
|
33
|
-
declare function HelpOptions(props: HelpOptionsProps):
|
|
33
|
+
declare function HelpOptions(props: HelpOptionsProps): _alloy_js_core0.Children;
|
|
34
34
|
interface HelpCommandsProps {
|
|
35
35
|
/**
|
|
36
36
|
* A mapping of command names to their command definitions.
|
|
@@ -40,7 +40,7 @@ interface HelpCommandsProps {
|
|
|
40
40
|
/**
|
|
41
41
|
* A component that generates the commands table display for a command.
|
|
42
42
|
*/
|
|
43
|
-
declare function HelpCommands(props: HelpCommandsProps):
|
|
43
|
+
declare function HelpCommands(props: HelpCommandsProps): _alloy_js_core0.Children;
|
|
44
44
|
interface BaseHelpProps {
|
|
45
45
|
/**
|
|
46
46
|
* The command to generate help for.
|
|
@@ -68,7 +68,7 @@ interface BaseHelpProps {
|
|
|
68
68
|
/**
|
|
69
69
|
* A component that generates the `help` function declaration for a command.
|
|
70
70
|
*/
|
|
71
|
-
declare function BaseHelp(props: BaseHelpProps):
|
|
71
|
+
declare function BaseHelp(props: BaseHelpProps): _alloy_js_core0.Children;
|
|
72
72
|
interface VirtualHelpProps {
|
|
73
73
|
/**
|
|
74
74
|
* The options to display help for.
|
|
@@ -89,7 +89,7 @@ interface VirtualHelpProps {
|
|
|
89
89
|
/**
|
|
90
90
|
* A component that generates the invocation of the `help` function for a command.
|
|
91
91
|
*/
|
|
92
|
-
declare function VirtualHelp(props: VirtualHelpProps):
|
|
92
|
+
declare function VirtualHelp(props: VirtualHelpProps): _alloy_js_core0.Children;
|
|
93
93
|
interface CommandHelpProps {
|
|
94
94
|
/**
|
|
95
95
|
* A mapping of command names to their command definitions.
|
|
@@ -99,7 +99,7 @@ interface CommandHelpProps {
|
|
|
99
99
|
/**
|
|
100
100
|
* A component that generates the invocation of the `help` function for a command.
|
|
101
101
|
*/
|
|
102
|
-
declare function CommandHelp(props: CommandHelpProps):
|
|
102
|
+
declare function CommandHelp(props: CommandHelpProps): _alloy_js_core0.Children;
|
|
103
103
|
//#endregion
|
|
104
104
|
export { BaseHelp, BaseHelpProps, CommandHelp, CommandHelpProps, HelpCommands, HelpCommandsProps, HelpOptions, HelpOptionsProps, HelpUsage, HelpUsageProps, VirtualHelp, VirtualHelpProps };
|
|
105
105
|
//# sourceMappingURL=help.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.d.cts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAkCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAuBR;AAUjB;AA+DA;AAUA;AAuBA;AA8BA;AAsDA;;EAS2B,MAAA,CAAA,EAAA,MAAA;;;;AAc3B;
|
|
1
|
+
{"version":3,"file":"help.d.cts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAkCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAuBR;AAUjB;AA+DA;AAUA;AAuBA;AA8BA;AAsDA;;EAS2B,MAAA,CAAA,EAAA,MAAA;;;;AAc3B;AA0DiB,iBAtSD,SAAA,CAsSiB,KAItB,EA1SsB,cA0SX,CAAA,EA1SyB,eAAA,CAAA,QA0SzB;AAMN,UAzRC,gBAAA,CAyRkB;;;;WArRxB;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA+DlC,iBAAA;;;;YAIL,eAAe;;;;;iBAMX,YAAA,QAAoB,oBAAiB,eAAA,CAAA;UAuBpC,aAAA;;;;WAIN;;;;;;;;;;;;;;;;;;;;;;;iBA0BK,QAAA,QAAgB,gBAAa,eAAA,CAAA;UAsD5B,gBAAA;;;;WAIN;;;;YAKC,eAAe;;;;;;;SAQlB;;;;;iBAMO,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA0DlC,gBAAA;;;;WAIN;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.d.mts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAkCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAuBR;AAUjB;AA+DA;AAUA;AAuBA;AA8BA;AAsDA;;EAS2B,MAAA,CAAA,EAAA,MAAA;;;;AAc3B;
|
|
1
|
+
{"version":3,"file":"help.d.mts","names":[],"sources":["../../src/components/help.tsx"],"sourcesContent":[],"mappings":";;;;UAkCiB,cAAA;;;AAAjB;EAoBgB,OAAA,EAhBL,WAgBc;EAuBR;AAUjB;AA+DA;AAUA;AAuBA;AA8BA;AAsDA;;EAS2B,MAAA,CAAA,EAAA,MAAA;;;;AAc3B;AA0DiB,iBAtSD,SAAA,CAsSiB,KAItB,EA1SsB,cA0SX,CAAA,EA1SyB,eAAA,CAAA,QA0SzB;AAMN,UAzRC,gBAAA,CAyRkB;;;;WArRxB;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA+DlC,iBAAA;;;;YAIL,eAAe;;;;;iBAMX,YAAA,QAAoB,oBAAiB,eAAA,CAAA;UAuBpC,aAAA;;;;WAIN;;;;;;;;;;;;;;;;;;;;;;;iBA0BK,QAAA,QAAgB,gBAAa,eAAA,CAAA;UAsD5B,gBAAA;;;;WAIN;;;;YAKC,eAAe;;;;;;;SAQlB;;;;;iBAMO,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA0DlC,gBAAA;;;;WAIN;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA"}
|
package/dist/components/help.mjs
CHANGED
|
@@ -175,7 +175,7 @@ function VirtualHelp(props) {
|
|
|
175
175
|
ender: code`writeLine(""); `,
|
|
176
176
|
children: (child) => [
|
|
177
177
|
memo(() => code`
|
|
178
|
-
writeLine(colors.text.heading.primary("${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
178
|
+
writeLine(colors.text.heading.primary(${child.icon ? `(isUnicodeSupported ? " ${child.icon} " : "") + ` : ""}"${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
179
179
|
writeLine("");
|
|
180
180
|
writeLine(colors.text.body.secondary("${child.description}"));
|
|
181
181
|
writeLine("");
|
|
@@ -232,7 +232,7 @@ function CommandHelp(props) {
|
|
|
232
232
|
ender: code`writeLine(""); `,
|
|
233
233
|
children: (child) => [
|
|
234
234
|
memo(() => code`
|
|
235
|
-
writeLine(colors.text.heading.primary("${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
235
|
+
writeLine(colors.text.heading.primary(${child.icon ? `(isUnicodeSupported ? " ${child.icon} " : "") + ` : ""}"${child.title} ${child.isVirtual ? "" : "Command"}"));
|
|
236
236
|
writeLine("");
|
|
237
237
|
writeLine(colors.text.body.secondary("${child.description}"));
|
|
238
238
|
writeLine("");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.mjs","names":["code","computed","For","Show","ReflectionKind","usePowerlines","Usage","getAppBin","sortOptions","kebabCase","snakeCase","useTheme","HelpUsage","props","command","indent","context","theme","_$createComponent","each","Object","keys","config","bin","hardline","children","_$memo","padding","app","_$createIntrinsic","HelpOptions","options","option","flags","names","name","length","push","alias","forEach","sort","join","kind","string","variadic","number","description","replace","env","default","undefined","envPrefix","JSON","stringify","HelpCommands","commands","values","child","BaseHelp","filterGlobalOptions","filter","some","globalOption","includes","when","value","VirtualHelp","path","doubleHardline","joiner","ender","title","isVirtual","segments","CommandHelp"],"sources":["../../src/components/help.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { Usage } from \"@shell-shock/core/components/usage\";\nimport { getAppBin } from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport { sortOptions } from \"@shell-shock/core/plugin-utils/reflect\";\nimport type {\n CommandOption,\n CommandTree,\n CommandTreePath\n} from \"@shell-shock/core/types/command\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { useTheme } from \"../contexts\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\n\nexport interface HelpUsageProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 2\n */\n indent?: number;\n}\n\n/**\n * A component that generates the usage display for a command.\n */\nexport function HelpUsage(props: HelpUsageProps) {\n const { command, indent = 2 } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const theme = useTheme();\n\n return (\n <For each={Object.keys(context.config.bin)} hardline>\n {bin => (\n <>\n {code`\n writeLine(\n colors.text.body.primary(\"`}\n <Usage bin={bin} command={command} />\n {code`\"), { padding: ${theme.padding.app * indent} }\n );`}\n <hbr />\n </>\n )}\n </For>\n );\n}\n\nexport interface HelpOptionsProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n}\n\n/**\n * A component that generates the options table display for a command.\n */\nexport function HelpOptions(props: HelpOptionsProps) {\n const { options } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={sortOptions(options)} hardline>\n {option => {\n const flags = [] as string[];\n const names = [] as string[];\n if (option.name.length === 1) {\n flags.push(`-${option.name}`);\n } else {\n names.push(`--${kebabCase(option.name)}`);\n }\n\n option.alias.forEach((alias: string) => {\n if (alias.length === 1) {\n flags.push(`-${alias}`);\n } else {\n names.push(`--${kebabCase(alias)}`);\n }\n });\n\n return code`[{ value: colors.text.body.primary(\"${\n flags.length > 0\n ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n : \"\"\n }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n option.kind === ReflectionKind.string\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : option.kind === ReflectionKind.number\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : \"\"\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${option.description.replace(\n /\\.+$/,\n \"\"\n )} ${\n option.env || option.default !== undefined\n ? `(${\n option.env\n ? `env: ${context.config.envPrefix}_${option.env}${\n option.default !== undefined ? \", \" : \"\"\n }`\n : \"\"\n }${\n option.default !== undefined\n ? `default: ${JSON.stringify(option.default)}`\n : \"\"\n })`\n : \"\"\n }.\"), align: \"left\", border: \"none\" }], `;\n }}\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface HelpCommandsProps {\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n}\n\n/**\n * A component that generates the commands table display for a command.\n */\nexport function HelpCommands(props: HelpCommandsProps) {\n const { commands } = props;\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={Object.values(commands)} hardline>\n {child =>\n code`[{ value: colors.text.body.primary(\"${\n child.name\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${child.description.replace(\n /\\.+$/,\n \"\"\n )}\"), align: \"left\", border: \"none\" }], `\n }\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface BaseHelpProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * Whether to filter out global options from the help display.\n *\n * @remarks\n * When enabled, any options that are present in the global options context will be filtered out from the help display. This is useful for sub-commands to avoid displaying global options that are not relevant to the specific command.\n *\n * @defaultValue false\n */\n filterGlobalOptions?: boolean;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 1\n */\n indent?: number;\n}\n\n/**\n * A component that generates the `help` function declaration for a command.\n */\nexport function BaseHelp(props: BaseHelpProps) {\n const { command, indent = 1, filterGlobalOptions = false } = props;\n\n const theme = useTheme();\n const context = usePowerlines<ScriptPresetContext>();\n\n const options = computed(() =>\n filterGlobalOptions\n ? Object.values(command.options).filter(\n option =>\n !context.options.some(\n globalOption =>\n globalOption.name === option.name ||\n option.alias.includes(globalOption.name) ||\n globalOption.alias?.includes(option.name) ||\n globalOption.alias?.some(alias => option.alias.includes(alias))\n )\n )\n : Object.values(command.options)\n );\n\n return (\n <>\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Usage:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpUsage command={command} indent={indent} />\n <hbr />\n <hbr />\n <Show when={options.value.length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Options:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpOptions options={options.value} />\n <hbr />\n <hbr />\n </Show>\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Commands:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpCommands commands={command.children} />\n <hbr />\n <hbr />\n </Show>\n </>\n );\n}\n\nexport interface VirtualHelpProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n\n /**\n * The command path to generate help for, used for generating the help invocation instructions.\n *\n * @remarks\n * This is optional since the virtual command entry component can be used for both the global binary executable and virtual commands (there will be no command definition for the binary executable).\n */\n path?: CommandTreePath;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function VirtualHelp(props: VirtualHelpProps) {\n const { options, path, commands } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Global Options:\")));`}\n <hbr />\n <HelpOptions options={options} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(commands).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(commands)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(\"${child.title} ${\n child.isVirtual ? \"\" : \"Command\"\n }\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )}${\n path?.segments && path.segments.length > 0\n ? ` ${path.segments.join(\" \")}`\n : \"\"\n } <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n\nexport interface CommandHelpProps {\n /**\n * A mapping of command names to their command definitions.\n */\n command: CommandTree;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function CommandHelp(props: CommandHelpProps) {\n const { command } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <BaseHelp command={command} filterGlobalOptions={false} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following sub-commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(command.children)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(\"${child.title} ${\n child.isVirtual ? \"\" : \"Command\"\n }\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )} ${command.path.segments.join(\" \")} <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAsDA,SAAgBY,UAAUC,OAAuB;CAC/C,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMG,UAAUX,eAAoC;CACpD,MAAMY,QAAQN,UAAU;AAExB,QAAAO,gBACGhB,KAAG;EAAA,IAACiB,OAAI;AAAA,UAAEC,OAAOC,KAAKL,QAAQM,OAAOC,IAAI;;EAAEC,UAAQ;EAAAC,WACjDF,QAAG;GAECvB,IAAI;;;GAEoBkB,gBACxBZ,OAAK;IAAMiB;IAAcT;IAAO,CAAA;GAAAY,WAChC1B,IAAI,kBAAkBiB,MAAMU,QAAQC,MAAMb,OAAM;UAClD;GAAAc,gBAAA,OAAA,EAAA,CAAA;GAAA;EAGF,CAAA;;;;;AAeP,SAAgBC,YAAYjB,OAAyB;CACnD,MAAM,EAAEkB,YAAYlB;CAEpB,MAAMG,UAAUX,eAAoC;AAEpD,QAAA;EAEKL,IAAI;EAAU6B,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAEdhB,KAAG;GAAA,IAACiB,OAAI;AAAA,WAAEX,YAAYuB,QAAQ;;GAAEP,UAAQ;GAAAC,WACtCO,WAAU;IACT,MAAMC,QAAQ,EAAc;IAC5B,MAAMC,QAAQ,EAAc;AAC5B,QAAIF,OAAOG,KAAKC,WAAW,EACzBH,OAAMI,KAAK,IAAIL,OAAOG,OAAO;QAE7BD,OAAMG,KAAK,KAAK5B,UAAUuB,OAAOG,KAAK,GAAG;AAG3CH,WAAOM,MAAMC,SAASD,UAAkB;AACtC,SAAIA,MAAMF,WAAW,EACnBH,OAAMI,KAAK,IAAIC,QAAQ;SAEvBJ,OAAMG,KAAK,KAAK5B,UAAU6B,MAAM,GAAG;MAErC;AAEF,WAAOtC,IAAI,uCACTiC,MAAMG,SAAS,IACX,GAAGH,MAAMO,MAAM,CAACC,KAAK,KAAK,GAAGP,MAAME,SAAS,IAAI,OAAO,OACvD,KACHF,MAAME,SAAS,IAAIF,MAAMM,MAAM,CAACC,KAAK,KAAK,GAAG,KAC9CT,OAAOU,SAAStC,eAAeuC,SAC3B,KAAKjC,UAAUsB,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1DZ,OAAOU,SAAStC,eAAeyC,SAC7B,KAAKnC,UAAUsB,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1D,GAAE,4EACmEZ,OAAOc,YAAYC,QAC9F,QACA,GACD,CAAA,GACCf,OAAOgB,OAAOhB,OAAOiB,YAAYC,SAC7B,IACElB,OAAOgB,MACH,QAAQhC,QAAQM,OAAO6B,UAAS,GAAInB,OAAOgB,MACzChB,OAAOiB,YAAYC,SAAY,OAAO,OAExC,KAEJlB,OAAOiB,YAAYC,SACf,YAAYE,KAAKC,UAAUrB,OAAOiB,QAAQ,KAC1C,GAAE,KAER,GAAE;;GAET,CAAA;EAAApB,gBAAA,OAAA,EAAA,CAAA;EAGF7B,IAAI;EAAO;;;;;AAelB,SAAgBsD,aAAazC,OAA0B;CACrD,MAAM,EAAE0C,aAAa1C;AAErB,QAAA;EAEKb,IAAI;EAAU6B,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAEdhB,KAAG;GAAA,IAACiB,OAAI;AAAA,WAAEC,OAAOoC,OAAOD,SAAS;;GAAE/B,UAAQ;GAAAC,WACzCgC,UACCzD,IAAI,uCACFyD,MAAMtB,KAAI,4EACiEsB,MAAMX,YAAYC,QAC7F,QACA,GACD,CAAA;GAAwC,CAAA;EAAAlB,gBAAA,OAAA,EAAA,CAAA;EAI5C7B,IAAI;EAAO;;;;;AAmClB,SAAgB0D,SAAS7C,OAAsB;CAC7C,MAAM,EAAEC,SAASC,SAAS,GAAG4C,sBAAsB,UAAU9C;CAE7D,MAAMI,QAAQN,UAAU;CACxB,MAAMK,UAAUX,eAAoC;CAEpD,MAAM0B,UAAU9B,eACd0D,sBACIvC,OAAOoC,OAAO1C,QAAQiB,QAAQ,CAAC6B,QAC7B5B,WACE,CAAChB,QAAQe,QAAQ8B,MACfC,iBACEA,aAAa3B,SAASH,OAAOG,QAC7BH,OAAOM,MAAMyB,SAASD,aAAa3B,KAAK,IACxC2B,aAAaxB,OAAOyB,SAAS/B,OAAOG,KAAK,IACzC2B,aAAaxB,OAAOuB,MAAKvB,UAASN,OAAOM,MAAMyB,SAASzB,MAAM,CAClE,CACJ,CAAC,GACDlB,OAAOoC,OAAO1C,QAAQiB,QAC5B,CAAC;AAED,QAAA;EAAAL,WAEK1B,IAAI,iEACHe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;EAAAc,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAEHN,WAAS;GAAUE;GAAiBC;GAAM,CAAA;EAAAc,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAG1Cf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAEjC,QAAQkC,MAAM7B,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KAAAC,WACjC1B,IAAI;wEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;KAAAc,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAEDY,aAAW,EAAA,IAACC,UAAO;AAAA,aAAEA,QAAQkC;QAAK,CAAA;KAAApC,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAAX,gBAIpCf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KAAAC,WACjD1B,IAAI;yEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;KAAAc,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAEDoC,cAAY,EAAA,IAACC,WAAQ;AAAA,aAAEzC,QAAQW;QAAQ,CAAA;KAAAI,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAA;;;;;AA+BhD,SAAgBqC,YAAYrD,OAAyB;CACnD,MAAM,EAAEkB,SAASoC,MAAMZ,aAAa1C;CAEpC,MAAMG,UAAUX,eAAoC;AAEpD,QAAA;EAEKL,IAAI;;EACW6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAGf7B,IAAI;EAA2E6B,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAE/EY,aAAW,EAAUC,SAAO,CAAA;EAC5B/B,IAAI;EAAiB6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAGrBf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKkC,SAAS,CAACnB,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACzCzB,IAAI;;KACW6B,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAGfhB,KAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAOD,SAAS;;MAC7Ba,gBAAc;MACdC,QAAQrE,IAAI;MACZsE,OAAOtE,IAAI;MAAiByB,WAC3BgC,UAAK;OAAA/B,WAED1B,IAAI;yDACsCyD,MAAMc,MAAK,GAClDd,MAAMe,YAAY,KAAK,UAAS;;wDAGMf,MAAMX,YAAW;;kBAExD;OAAAjB,gBAAA,OAAA,EAAA,CAAA;OAAAX,gBAEFwC,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;OAAA9B,gBAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;KAAAH,WAEF1B,IAAI,8DAA8DO,UACjES,QACD,GACCmD,MAAMM,YAAYN,KAAKM,SAASrC,SAAS,IACrC,IAAI+B,KAAKM,SAAShC,KAAK,IAAI,KAC3B,GAAE;wBAEO;KAAA;;GAAA,CAAA;EAAA;;;;;AAgBvB,SAAgBiC,YAAY7D,OAAyB;CACnD,MAAM,EAAEC,YAAYD;CAEpB,MAAMG,UAAUX,eAAoC;AAEpD,QAAA;EAEKL,IAAI;EAAiB6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAGrBwC,UAAQ;GAAU5C;GAAS6C,qBAAqB;GAAK,CAAA;EACrD3D,IAAI;EAAiB6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAGrBf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACjDzB,IAAI;;KACW6B,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAGfhB,KAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAO1C,QAAQW,SAAS;;MACrC2C,gBAAc;MACdC,QAAQrE,IAAI;MACZsE,OAAOtE,IAAI;MAAiByB,WAC3BgC,UAAK;OAAA/B,WAED1B,IAAI;yDACsCyD,MAAMc,MAAK,GAClDd,MAAMe,YAAY,KAAK,UAAS;;wDAGMf,MAAMX,YAAW;;kBAExD;OAAAjB,gBAAA,OAAA,EAAA,CAAA;OAAAX,gBAEFwC,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;OAAA9B,gBAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;KAAAH,WAEF1B,IAAI,8DAA8DO,UACjES,QACD,CAAA,GAAIF,QAAQqD,KAAKM,SAAShC,KAAK,IAAI,CAAA;wBACrB;KAAA;;GAAA,CAAA;EAAA"}
|
|
1
|
+
{"version":3,"file":"help.mjs","names":["code","computed","For","Show","ReflectionKind","usePowerlines","Usage","getAppBin","sortOptions","kebabCase","snakeCase","useTheme","HelpUsage","props","command","indent","context","theme","_$createComponent","each","Object","keys","config","bin","hardline","children","_$memo","padding","app","_$createIntrinsic","HelpOptions","options","option","flags","names","name","length","push","alias","forEach","sort","join","kind","string","variadic","number","description","replace","env","default","undefined","envPrefix","JSON","stringify","HelpCommands","commands","values","child","BaseHelp","filterGlobalOptions","filter","some","globalOption","includes","when","value","VirtualHelp","path","doubleHardline","joiner","ender","icon","title","isVirtual","segments","CommandHelp"],"sources":["../../src/components/help.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { Usage } from \"@shell-shock/core/components/usage\";\nimport { getAppBin } from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport { sortOptions } from \"@shell-shock/core/plugin-utils/reflect\";\nimport type {\n CommandOption,\n CommandTree,\n CommandTreePath\n} from \"@shell-shock/core/types/command\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { snakeCase } from \"@stryke/string-format/snake-case\";\nimport { useTheme } from \"../contexts\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\n\nexport interface HelpUsageProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 2\n */\n indent?: number;\n}\n\n/**\n * A component that generates the usage display for a command.\n */\nexport function HelpUsage(props: HelpUsageProps) {\n const { command, indent = 2 } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const theme = useTheme();\n\n return (\n <For each={Object.keys(context.config.bin)} hardline>\n {bin => (\n <>\n {code`\n writeLine(\n colors.text.body.primary(\"`}\n <Usage bin={bin} command={command} />\n {code`\"), { padding: ${theme.padding.app * indent} }\n );`}\n <hbr />\n </>\n )}\n </For>\n );\n}\n\nexport interface HelpOptionsProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n}\n\n/**\n * A component that generates the options table display for a command.\n */\nexport function HelpOptions(props: HelpOptionsProps) {\n const { options } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={sortOptions(options)} hardline>\n {option => {\n const flags = [] as string[];\n const names = [] as string[];\n if (option.name.length === 1) {\n flags.push(`-${option.name}`);\n } else {\n names.push(`--${kebabCase(option.name)}`);\n }\n\n option.alias.forEach((alias: string) => {\n if (alias.length === 1) {\n flags.push(`-${alias}`);\n } else {\n names.push(`--${kebabCase(alias)}`);\n }\n });\n\n return code`[{ value: colors.text.body.primary(\"${\n flags.length > 0\n ? `${flags.sort().join(\", \")}${names.length > 0 ? \", \" : \"\"}`\n : \"\"\n }${names.length > 0 ? names.sort().join(\", \") : \"\"}${\n option.kind === ReflectionKind.string\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : option.kind === ReflectionKind.number\n ? ` <${snakeCase(option.name)}${option.variadic ? \"...\" : \"\"}>`\n : \"\"\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${option.description.replace(\n /\\.+$/,\n \"\"\n )} ${\n option.env || option.default !== undefined\n ? `(${\n option.env\n ? `env: ${context.config.envPrefix}_${option.env}${\n option.default !== undefined ? \", \" : \"\"\n }`\n : \"\"\n }${\n option.default !== undefined\n ? `default: ${JSON.stringify(option.default)}`\n : \"\"\n })`\n : \"\"\n }.\"), align: \"left\", border: \"none\" }], `;\n }}\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface HelpCommandsProps {\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n}\n\n/**\n * A component that generates the commands table display for a command.\n */\nexport function HelpCommands(props: HelpCommandsProps) {\n const { commands } = props;\n\n return (\n <>\n {code`table([ `}\n <hbr />\n <For each={Object.values(commands)} hardline>\n {child =>\n code`[{ value: colors.text.body.primary(\"${\n child.name\n }\"), align: \"right\", border: \"none\" }, { value: colors.text.body.tertiary(\"${child.description.replace(\n /\\.+$/,\n \"\"\n )}\"), align: \"left\", border: \"none\" }], `\n }\n </For>\n <hbr />\n {code` ]); `}\n </>\n );\n}\n\nexport interface BaseHelpProps {\n /**\n * The command to generate help for.\n */\n command: CommandTree;\n\n /**\n * Whether to filter out global options from the help display.\n *\n * @remarks\n * When enabled, any options that are present in the global options context will be filtered out from the help display. This is useful for sub-commands to avoid displaying global options that are not relevant to the specific command.\n *\n * @defaultValue false\n */\n filterGlobalOptions?: boolean;\n\n /**\n * The padding scale to apply to the help display headings.\n *\n * @remarks\n * This value is multiplied by the theme's app padding to determine the final padding.\n *\n * @defaultValue 1\n */\n indent?: number;\n}\n\n/**\n * A component that generates the `help` function declaration for a command.\n */\nexport function BaseHelp(props: BaseHelpProps) {\n const { command, indent = 1, filterGlobalOptions = false } = props;\n\n const theme = useTheme();\n const context = usePowerlines<ScriptPresetContext>();\n\n const options = computed(() =>\n filterGlobalOptions\n ? Object.values(command.options).filter(\n option =>\n !context.options.some(\n globalOption =>\n globalOption.name === option.name ||\n option.alias.includes(globalOption.name) ||\n globalOption.alias?.includes(option.name) ||\n globalOption.alias?.some(alias => option.alias.includes(alias))\n )\n )\n : Object.values(command.options)\n );\n\n return (\n <>\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Usage:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpUsage command={command} indent={indent} />\n <hbr />\n <hbr />\n <Show when={options.value.length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Options:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpOptions options={options.value} />\n <hbr />\n <hbr />\n </Show>\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(\"\");\n writeLine(colors.bold(colors.text.heading.secondary(\"Commands:\"))${\n indent > 1 ? `, { padding: ${theme.padding.app * indent} }` : \"\"\n });`}\n <hbr />\n <HelpCommands commands={command.children} />\n <hbr />\n <hbr />\n </Show>\n </>\n );\n}\n\nexport interface VirtualHelpProps {\n /**\n * The options to display help for.\n */\n options: CommandOption[];\n\n /**\n * A mapping of command names to their command definitions.\n */\n commands: Record<string, CommandTree>;\n\n /**\n * The command path to generate help for, used for generating the help invocation instructions.\n *\n * @remarks\n * This is optional since the virtual command entry component can be used for both the global binary executable and virtual commands (there will be no command definition for the binary executable).\n */\n path?: CommandTreePath;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function VirtualHelp(props: VirtualHelpProps) {\n const { options, path, commands } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n {code`writeLine(colors.bold(colors.text.heading.secondary(\"Global Options:\")));`}\n <hbr />\n <HelpOptions options={options} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(commands).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(commands)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\"${child.title} ${child.isVirtual ? \"\" : \"Command\"}\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )}${\n path?.segments && path.segments.length > 0\n ? ` ${path.segments.join(\" \")}`\n : \"\"\n } <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n\nexport interface CommandHelpProps {\n /**\n * A mapping of command names to their command definitions.\n */\n command: CommandTree;\n}\n\n/**\n * A component that generates the invocation of the `help` function for a command.\n */\nexport function CommandHelp(props: CommandHelpProps) {\n const { command } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <BaseHelp command={command} filterGlobalOptions={false} />\n {code`writeLine(\"\"); `}\n <hbr />\n <hbr />\n <Show when={Object.keys(command.children).length > 0}>\n {code`writeLine(colors.text.body.secondary(\"The following sub-commands are available:\"));\n writeLine(\"\"); `}\n <hbr />\n <hbr />\n <For\n each={Object.values(command.children)}\n doubleHardline\n joiner={code`writeLine(\"\"); `}\n ender={code`writeLine(\"\"); `}>\n {child => (\n <>\n {code`\n writeLine(colors.text.heading.primary(${\n child.icon\n ? `(isUnicodeSupported ? \" ${child.icon} \" : \"\") + `\n : \"\"\n }\"${child.title} ${child.isVirtual ? \"\" : \"Command\"}\"));\n writeLine(\"\");\n writeLine(colors.text.body.secondary(\"${child.description}\"));\n writeLine(\"\");\n `}\n <hbr />\n <BaseHelp command={child} indent={2} filterGlobalOptions />\n <hbr />\n </>\n )}\n </For>\n {code`help(\"Running a specific command with the help flag (via: '${getAppBin(\n context\n )} ${command.path.segments.join(\" \")} <specific command> --help') will provide additional information that is specific to that command.\");\n writeLine(\"\");`}\n </Show>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAsDA,SAAgBY,UAAUC,OAAuB;CAC/C,MAAM,EAAEC,SAASC,SAAS,MAAMF;CAEhC,MAAMG,UAAUX,eAAoC;CACpD,MAAMY,QAAQN,UAAU;AAExB,QAAAO,gBACGhB,KAAG;EAAA,IAACiB,OAAI;AAAA,UAAEC,OAAOC,KAAKL,QAAQM,OAAOC,IAAI;;EAAEC,UAAQ;EAAAC,WACjDF,QAAG;GAECvB,IAAI;;;GAEoBkB,gBACxBZ,OAAK;IAAMiB;IAAcT;IAAO,CAAA;GAAAY,WAChC1B,IAAI,kBAAkBiB,MAAMU,QAAQC,MAAMb,OAAM;UAClD;GAAAc,gBAAA,OAAA,EAAA,CAAA;GAAA;EAGF,CAAA;;;;;AAeP,SAAgBC,YAAYjB,OAAyB;CACnD,MAAM,EAAEkB,YAAYlB;CAEpB,MAAMG,UAAUX,eAAoC;AAEpD,QAAA;EAEKL,IAAI;EAAU6B,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAEdhB,KAAG;GAAA,IAACiB,OAAI;AAAA,WAAEX,YAAYuB,QAAQ;;GAAEP,UAAQ;GAAAC,WACtCO,WAAU;IACT,MAAMC,QAAQ,EAAc;IAC5B,MAAMC,QAAQ,EAAc;AAC5B,QAAIF,OAAOG,KAAKC,WAAW,EACzBH,OAAMI,KAAK,IAAIL,OAAOG,OAAO;QAE7BD,OAAMG,KAAK,KAAK5B,UAAUuB,OAAOG,KAAK,GAAG;AAG3CH,WAAOM,MAAMC,SAASD,UAAkB;AACtC,SAAIA,MAAMF,WAAW,EACnBH,OAAMI,KAAK,IAAIC,QAAQ;SAEvBJ,OAAMG,KAAK,KAAK5B,UAAU6B,MAAM,GAAG;MAErC;AAEF,WAAOtC,IAAI,uCACTiC,MAAMG,SAAS,IACX,GAAGH,MAAMO,MAAM,CAACC,KAAK,KAAK,GAAGP,MAAME,SAAS,IAAI,OAAO,OACvD,KACHF,MAAME,SAAS,IAAIF,MAAMM,MAAM,CAACC,KAAK,KAAK,GAAG,KAC9CT,OAAOU,SAAStC,eAAeuC,SAC3B,KAAKjC,UAAUsB,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1DZ,OAAOU,SAAStC,eAAeyC,SAC7B,KAAKnC,UAAUsB,OAAOG,KAAK,GAAGH,OAAOY,WAAW,QAAQ,GAAE,KAC1D,GAAE,4EACmEZ,OAAOc,YAAYC,QAC9F,QACA,GACD,CAAA,GACCf,OAAOgB,OAAOhB,OAAOiB,YAAYC,SAC7B,IACElB,OAAOgB,MACH,QAAQhC,QAAQM,OAAO6B,UAAS,GAAInB,OAAOgB,MACzChB,OAAOiB,YAAYC,SAAY,OAAO,OAExC,KAEJlB,OAAOiB,YAAYC,SACf,YAAYE,KAAKC,UAAUrB,OAAOiB,QAAQ,KAC1C,GAAE,KAER,GAAE;;GAET,CAAA;EAAApB,gBAAA,OAAA,EAAA,CAAA;EAGF7B,IAAI;EAAO;;;;;AAelB,SAAgBsD,aAAazC,OAA0B;CACrD,MAAM,EAAE0C,aAAa1C;AAErB,QAAA;EAEKb,IAAI;EAAU6B,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAEdhB,KAAG;GAAA,IAACiB,OAAI;AAAA,WAAEC,OAAOoC,OAAOD,SAAS;;GAAE/B,UAAQ;GAAAC,WACzCgC,UACCzD,IAAI,uCACFyD,MAAMtB,KAAI,4EACiEsB,MAAMX,YAAYC,QAC7F,QACA,GACD,CAAA;GAAwC,CAAA;EAAAlB,gBAAA,OAAA,EAAA,CAAA;EAI5C7B,IAAI;EAAO;;;;;AAmClB,SAAgB0D,SAAS7C,OAAsB;CAC7C,MAAM,EAAEC,SAASC,SAAS,GAAG4C,sBAAsB,UAAU9C;CAE7D,MAAMI,QAAQN,UAAU;CACxB,MAAMK,UAAUX,eAAoC;CAEpD,MAAM0B,UAAU9B,eACd0D,sBACIvC,OAAOoC,OAAO1C,QAAQiB,QAAQ,CAAC6B,QAC7B5B,WACE,CAAChB,QAAQe,QAAQ8B,MACfC,iBACEA,aAAa3B,SAASH,OAAOG,QAC7BH,OAAOM,MAAMyB,SAASD,aAAa3B,KAAK,IACxC2B,aAAaxB,OAAOyB,SAAS/B,OAAOG,KAAK,IACzC2B,aAAaxB,OAAOuB,MAAKvB,UAASN,OAAOM,MAAMyB,SAASzB,MAAM,CAClE,CACJ,CAAC,GACDlB,OAAOoC,OAAO1C,QAAQiB,QAC5B,CAAC;AAED,QAAA;EAAAL,WAEK1B,IAAI,iEACHe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;EAAAc,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAEHN,WAAS;GAAUE;GAAiBC;GAAM,CAAA;EAAAc,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAG1Cf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAEjC,QAAQkC,MAAM7B,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KAAAC,WACjC1B,IAAI;wEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;KAAAc,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAEDY,aAAW,EAAA,IAACC,UAAO;AAAA,aAAEA,QAAQkC;QAAK,CAAA;KAAApC,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAAX,gBAIpCf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KAAAC,WACjD1B,IAAI;yEAELe,SAAS,IAAI,gBAAgBE,MAAMU,QAAQC,MAAMb,OAAM,MAAO,GAAE,IAC9D;KAAAc,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAEDoC,cAAY,EAAA,IAACC,WAAQ;AAAA,aAAEzC,QAAQW;QAAQ,CAAA;KAAAI,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAA;;GAAA,CAAA;EAAA;;;;;AA+BhD,SAAgBqC,YAAYrD,OAAyB;CACnD,MAAM,EAAEkB,SAASoC,MAAMZ,aAAa1C;CAEpC,MAAMG,UAAUX,eAAoC;AAEpD,QAAA;EAEKL,IAAI;;EACW6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAGf7B,IAAI;EAA2E6B,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAE/EY,aAAW,EAAUC,SAAO,CAAA;EAC5B/B,IAAI;EAAiB6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAGrBf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKkC,SAAS,CAACnB,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACzCzB,IAAI;;KACW6B,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAGfhB,KAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAOD,SAAS;;MAC7Ba,gBAAc;MACdC,QAAQrE,IAAI;MACZsE,OAAOtE,IAAI;MAAiByB,WAC3BgC,UAAK;OAAA/B,WAED1B,IAAI;wDAEDyD,MAAMc,OACF,2BAA2Bd,MAAMc,KAAI,gBACrC,GAAE,GACJd,MAAMe,MAAK,GAAIf,MAAMgB,YAAY,KAAK,UAAS;;wDAEXhB,MAAMX,YAAW;;kBAExD;OAAAjB,gBAAA,OAAA,EAAA,CAAA;OAAAX,gBAEFwC,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;OAAA9B,gBAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;KAAAH,WAEF1B,IAAI,8DAA8DO,UACjES,QACD,GACCmD,MAAMO,YAAYP,KAAKO,SAAStC,SAAS,IACrC,IAAI+B,KAAKO,SAASjC,KAAK,IAAI,KAC3B,GAAE;wBAEO;KAAA;;GAAA,CAAA;EAAA;;;;;AAgBvB,SAAgBkC,YAAY9D,OAAyB;CACnD,MAAM,EAAEC,YAAYD;CAEpB,MAAMG,UAAUX,eAAoC;AAEpD,QAAA;EAEKL,IAAI;EAAiB6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAGrBwC,UAAQ;GAAU5C;GAAS6C,qBAAqB;GAAK,CAAA;EACrD3D,IAAI;EAAiB6B,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAX,gBAGrBf,MAAI;GAAA,IAAC6D,OAAI;AAAA,WAAE5C,OAAOC,KAAKP,QAAQW,SAAS,CAACW,SAAS;;GAAC,IAAAX,WAAA;AAAA,WAAA;KACjDzB,IAAI;;KACW6B,gBAAA,OAAA,EAAA,CAAA;KAAAA,gBAAA,OAAA,EAAA,CAAA;KAAAX,gBAGfhB,KAAG;MAAA,IACFiB,OAAI;AAAA,cAAEC,OAAOoC,OAAO1C,QAAQW,SAAS;;MACrC2C,gBAAc;MACdC,QAAQrE,IAAI;MACZsE,OAAOtE,IAAI;MAAiByB,WAC3BgC,UAAK;OAAA/B,WAED1B,IAAI;wDAEDyD,MAAMc,OACF,2BAA2Bd,MAAMc,KAAI,gBACrC,GAAE,GACJd,MAAMe,MAAK,GAAIf,MAAMgB,YAAY,KAAK,UAAS;;wDAEXhB,MAAMX,YAAW;;kBAExD;OAAAjB,gBAAA,OAAA,EAAA,CAAA;OAAAX,gBAEFwC,UAAQ;QAAC5C,SAAS2C;QAAO1C,QAAQ;QAAG4C,qBAAmB;QAAA,CAAA;OAAA9B,gBAAA,OAAA,EAAA,CAAA;OAAA;MAG3D,CAAA;KAAAH,WAEF1B,IAAI,8DAA8DO,UACjES,QACD,CAAA,GAAIF,QAAQqD,KAAKO,SAASjC,KAAK,IAAI,CAAA;wBACrB;KAAA;;GAAA,CAAA;EAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as _alloy_js_core5 from "@alloy-js/core";
|
|
2
2
|
import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
|
|
3
3
|
|
|
4
4
|
//#region src/components/utils-builtin.d.ts
|
|
@@ -6,27 +6,27 @@ interface UtilsBuiltinProps extends Omit<BuiltinFileProps, "id" | "description">
|
|
|
6
6
|
/**
|
|
7
7
|
* Generates utilities for detecting terminal color support.
|
|
8
8
|
*/
|
|
9
|
-
declare function EnvSupportUtilities():
|
|
9
|
+
declare function EnvSupportUtilities(): _alloy_js_core5.Children;
|
|
10
10
|
/**
|
|
11
11
|
* Generates utilities for detecting terminal color support.
|
|
12
12
|
*/
|
|
13
|
-
declare function ColorSupportUtilities():
|
|
13
|
+
declare function ColorSupportUtilities(): _alloy_js_core5.Children;
|
|
14
14
|
/**
|
|
15
15
|
* Generates utilities for detecting terminal color support.
|
|
16
16
|
*/
|
|
17
|
-
declare function HyperlinkSupportUtilities():
|
|
17
|
+
declare function HyperlinkSupportUtilities(): _alloy_js_core5.Children;
|
|
18
18
|
/**
|
|
19
19
|
* Generates utilities for detecting terminal color support.
|
|
20
20
|
*/
|
|
21
|
-
declare function ArgsUtilities():
|
|
21
|
+
declare function ArgsUtilities(): _alloy_js_core5.Children;
|
|
22
22
|
/**
|
|
23
23
|
* The `exit` handler function declaration code for the Shell Shock project.
|
|
24
24
|
*/
|
|
25
|
-
declare function ExitFunctionDeclaration():
|
|
25
|
+
declare function ExitFunctionDeclaration(): _alloy_js_core5.Children;
|
|
26
26
|
/**
|
|
27
27
|
* A built-in utilities module for Shell Shock.
|
|
28
28
|
*/
|
|
29
|
-
declare function UtilsBuiltin(props: UtilsBuiltinProps):
|
|
29
|
+
declare function UtilsBuiltin(props: UtilsBuiltinProps): _alloy_js_core5.Children;
|
|
30
30
|
//#endregion
|
|
31
31
|
export { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, ExitFunctionDeclaration, HyperlinkSupportUtilities, UtilsBuiltin, UtilsBuiltinProps };
|
|
32
32
|
//# sourceMappingURL=utils-builtin.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"virtual-command-entry.cjs","names":["code","computed","For","Show","FunctionDeclaration","usePowerlines","TSDoc","TSDocParam","TSDocRemarks","TSDocTitle","TypescriptFile","getAppBin","getDynamicPathSegmentName","isDynamicPathSegment","joinPaths","constantCase","pascalCase","defu","BannerFunctionDeclaration","CommandEntry","CommandRouter","VirtualHelp","VirtualCommandHandlerDeclaration","props","command","children","context","_$createComponent","heading","title","path","segments","map","segment","join","description","replace","_$createIntrinsic","name","async","parameters","type","default","commands","options","Object","values","VirtualCommandEntry","imports","builtinImports","rest","filePath","entryPath","filter","_$mergeProps","value","didyoumean2","entries","child","isVirtual","reduce","ret","alias","console","utils","each","when","fallback"],"sources":["../../src/components/virtual-command-entry.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 type { Children } from \"@alloy-js/core\";\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { TypescriptFileImports } from \"@powerlines/plugin-alloy/types/components\";\nimport type { EntryFileProps } from \"@powerlines/plugin-alloy/typescript/components/entry-file\";\nimport {\n TSDoc,\n TSDocParam,\n TSDocRemarks,\n TSDocTitle\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript/components/typescript-file\";\nimport {\n getAppBin,\n getDynamicPathSegmentName,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport type { CommandTree } from \"@shell-shock/core/types/command\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport defu from \"defu\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\nimport { BannerFunctionDeclaration } from \"./banner-function-declaration\";\nimport { CommandEntry } from \"./command-entry\";\nimport { CommandRouter } from \"./command-router\";\nimport { VirtualHelp } from \"./help\";\n\nexport interface VirtualCommandHandlerDeclarationProps {\n command: CommandTree;\n children?: Children;\n}\n\n/**\n * A component that generates the `handler` function declaration for a command.\n */\nexport function VirtualCommandHandlerDeclaration(\n props: VirtualCommandHandlerDeclarationProps\n) {\n const { command, children } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n <TSDoc\n heading={`The ${command.title} (${getAppBin(context)} ${command.path.segments\n .map(segment =>\n isDynamicPathSegment(segment)\n ? `[${constantCase(getDynamicPathSegmentName(segment))}]`\n : segment\n )\n .join(\" \")}) virtual command.`}>\n <TSDocRemarks>{`${command.description.replace(/\\.+$/, \"\")}.`}</TSDocRemarks>\n <hbr />\n <TSDocTitle>{command.title}</TSDocTitle>\n <TSDocParam name=\"args\">{`The command-line arguments passed to the command.`}</TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n async\n name=\"handler\"\n parameters={[{ name: \"args\", type: \"string[]\", default: \"getArgs()\" }]}>\n <hbr />\n <hbr />\n {children}\n <CommandRouter\n path={command.path.segments}\n commands={command.children}\n />\n <hbr />\n <hbr />\n {code`writeLine(\"\");\n banner();`}\n <hbr />\n <hbr />\n <VirtualHelp\n path={command.path}\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n </FunctionDeclaration>\n </>\n );\n}\n\nexport interface VirtualCommandEntryProps extends Omit<\n EntryFileProps,\n \"path\" | \"typeDefinition\"\n> {\n command: CommandTree;\n}\n\n/**\n * The virtual command entry point for the Shell Shock project.\n */\nexport function VirtualCommandEntry(props: VirtualCommandEntryProps) {\n const { command, imports, builtinImports, ...rest } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const filePath = computed(() =>\n joinPaths(\n context.entryPath,\n command.path.segments\n .filter(segment => !isDynamicPathSegment(segment))\n .join(\"/\"),\n \"index.ts\"\n )\n );\n\n return (\n <>\n <TypescriptFile\n {...rest}\n path={filePath.value}\n imports={defu(\n {\n didyoumean2: [\n { name: \"didYouMean\", default: true },\n { name: \"ReturnTypeEnums\" },\n { name: \"ThresholdTypeEnums\" }\n ]\n },\n imports ?? {},\n Object.entries(command.children)\n .filter(([, child]) => child.isVirtual)\n .reduce((ret, [name, child]) => {\n ret[`./${child.name}`] = [\n { name: \"handler\", alias: `handle${pascalCase(name)}` }\n ];\n\n return ret;\n }, {} as TypescriptFileImports)\n )}\n builtinImports={defu(builtinImports ?? {}, {\n console: [\"warn\", \"error\", \"table\", \"colors\", \"writeLine\"],\n utils: [\"getArgs\", \"hasFlag\", \"isMinimal\"]\n })}>\n <BannerFunctionDeclaration command={command} />\n <hbr />\n <hbr />\n <VirtualCommandHandlerDeclaration command={command} />\n </TypescriptFile>\n <For each={Object.values(command.children)}>\n {child => (\n <Show\n when={child.isVirtual}\n fallback={<CommandEntry command={child} />}>\n <VirtualCommandEntry command={child} />\n </Show>\n )}\n </For>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAuDA,SAAgBsB,iCACdC,OACA;CACA,MAAM,EAAEC,SAASC,aAAaF;CAE9B,MAAMG,8EAA8C;AAEpD,QAAA,kDAEKpB,6DAAK;EAAA,IACJsB,UAAO;AAAA,UAAE,OAAOJ,QAAQK,MAAK,mEAAeH,QAAQ,CAAA,GAAIF,QAAQM,KAAKC,SAClEC,KAAIC,sFACkBA,QAAQ,GACzB,0IAA2CA,QAAQ,CAAC,CAAA,KACpDA,QACL,CACAC,KAAK,IAAI,CAAA;;EAAoB,IAAAT,WAAA;AAAA,UAAA;qDAC/BjB,oEAAY,EAAA,IAAAiB,WAAA;AAAA,YAAE,GAAGD,QAAQW,YAAYC,QAAQ,QAAQ,GAAG,CAAA;OAAG,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAE3D3B,kEAAU,EAAA,IAAAgB,WAAA;AAAA,YAAED,QAAQK;OAAK,CAAA;qDACzBtB,kEAAU;KAAC+B,MAAI;KAAAb,UAAS;KAAmD,CAAA;IAAA;;EAAA,CAAA,mDAE7ErB,2CAAmB;EAAA,UAAA;EAElBmC,OAAK;EACLD,MAAI;EACJE,YAAY,CAAC;GAAEF,MAAM;GAAQG,MAAM;GAAYC,SAAS;GAAa,CAAC;EAAA,IAAAjB,WAAA;AAAA,UAAA;qDAAA,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;IAGrEA;qDACAL,iDAAa;KAAA,IACZU,OAAI;AAAA,aAAEN,QAAQM,KAAKC;;KAAQ,IAC3BY,WAAQ;AAAA,aAAEnB,QAAQC;;KAAQ,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;IAI3BzB,oBAAI;;qDACK,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAGTqB,qCAAW;KAAA,IACVS,OAAI;AAAA,aAAEN,QAAQM;;KAAI,IAClBc,UAAO;AAAA,aAAEC,OAAOC,OAAOtB,QAAQoB,QAAQ;;KAAA,IACvCD,WAAQ;AAAA,aAAEnB,QAAQC,YAAY,EAAE;;KAAA,CAAA;IAAA;;EAAA,CAAA,CAAA;;;;;AAiB1C,SAAgBsB,oBAAoBxB,OAAiC;CACnE,MAAM,EAAEC,SAASwB,SAASC,gBAAgB,GAAGC,SAAS3B;CAEtD,MAAMG,8EAA8C;CACpD,MAAMyB,iFAEFzB,QAAQ0B,WACR5B,QAAQM,KAAKC,SACVsB,QAAOpB,YAAW,2EAAsBA,QAAQ,CAAC,CACjDC,KAAK,IAAI,EACZ,WAEJ,CAAC;AAED,QAAA,kDAEKxB,4HACKwC,MAAI;EAAA,IACRpB,OAAI;AAAA,UAAEqB,SAASI;;EAAK,IACpBP,UAAO;AAAA,4BACL,EACEQ,aAAa;IACX;KAAElB,MAAM;KAAcI,SAAS;KAAM;IACrC,EAAEJ,MAAM,mBAAmB;IAC3B,EAAEA,MAAM,sBAAsB;IAAA,EAEjC,EACDU,WAAW,EAAE,EACbH,OAAOY,QAAQjC,QAAQC,SAAS,CAC7B4B,QAAQ,GAAGK,WAAWA,MAAMC,UAAU,CACtCC,QAAQC,KAAK,CAACvB,MAAMoB,WAAW;AAC9BG,QAAI,KAAKH,MAAMpB,UAAU,CACvB;KAAEA,MAAM;KAAWwB,OAAO,4DAAoBxB,KAAK;KAAI,CACxD;AAED,WAAOuB;MACN,EAA2B,CAClC,CAAC;;EAAA,IACDZ,iBAAc;AAAA,4BAAOA,kBAAkB,EAAE,EAAE;IACzCc,SAAS;KAAC;KAAQ;KAAS;KAAS;KAAU;KAAY;IAC1DC,OAAO;KAAC;KAAW;KAAW;
|
|
1
|
+
{"version":3,"file":"virtual-command-entry.cjs","names":["code","computed","For","Show","FunctionDeclaration","usePowerlines","TSDoc","TSDocParam","TSDocRemarks","TSDocTitle","TypescriptFile","getAppBin","getDynamicPathSegmentName","isDynamicPathSegment","joinPaths","constantCase","pascalCase","defu","BannerFunctionDeclaration","CommandEntry","CommandRouter","VirtualHelp","VirtualCommandHandlerDeclaration","props","command","children","context","_$createComponent","heading","title","path","segments","map","segment","join","description","replace","_$createIntrinsic","name","async","parameters","type","default","commands","options","Object","values","VirtualCommandEntry","imports","builtinImports","rest","filePath","entryPath","filter","_$mergeProps","value","didyoumean2","entries","child","isVirtual","reduce","ret","alias","console","utils","each","when","fallback"],"sources":["../../src/components/virtual-command-entry.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 type { Children } from \"@alloy-js/core\";\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { TypescriptFileImports } from \"@powerlines/plugin-alloy/types/components\";\nimport type { EntryFileProps } from \"@powerlines/plugin-alloy/typescript/components/entry-file\";\nimport {\n TSDoc,\n TSDocParam,\n TSDocRemarks,\n TSDocTitle\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript/components/typescript-file\";\nimport {\n getAppBin,\n getDynamicPathSegmentName,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport type { CommandTree } from \"@shell-shock/core/types/command\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport defu from \"defu\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\nimport { BannerFunctionDeclaration } from \"./banner-function-declaration\";\nimport { CommandEntry } from \"./command-entry\";\nimport { CommandRouter } from \"./command-router\";\nimport { VirtualHelp } from \"./help\";\n\nexport interface VirtualCommandHandlerDeclarationProps {\n command: CommandTree;\n children?: Children;\n}\n\n/**\n * A component that generates the `handler` function declaration for a command.\n */\nexport function VirtualCommandHandlerDeclaration(\n props: VirtualCommandHandlerDeclarationProps\n) {\n const { command, children } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n <TSDoc\n heading={`The ${command.title} (${getAppBin(context)} ${command.path.segments\n .map(segment =>\n isDynamicPathSegment(segment)\n ? `[${constantCase(getDynamicPathSegmentName(segment))}]`\n : segment\n )\n .join(\" \")}) virtual command.`}>\n <TSDocRemarks>{`${command.description.replace(/\\.+$/, \"\")}.`}</TSDocRemarks>\n <hbr />\n <TSDocTitle>{command.title}</TSDocTitle>\n <TSDocParam name=\"args\">{`The command-line arguments passed to the command.`}</TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n async\n name=\"handler\"\n parameters={[{ name: \"args\", type: \"string[]\", default: \"getArgs()\" }]}>\n <hbr />\n <hbr />\n {children}\n <CommandRouter\n path={command.path.segments}\n commands={command.children}\n />\n <hbr />\n <hbr />\n {code`writeLine(\"\");\n banner();`}\n <hbr />\n <hbr />\n <VirtualHelp\n path={command.path}\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n </FunctionDeclaration>\n </>\n );\n}\n\nexport interface VirtualCommandEntryProps extends Omit<\n EntryFileProps,\n \"path\" | \"typeDefinition\"\n> {\n command: CommandTree;\n}\n\n/**\n * The virtual command entry point for the Shell Shock project.\n */\nexport function VirtualCommandEntry(props: VirtualCommandEntryProps) {\n const { command, imports, builtinImports, ...rest } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const filePath = computed(() =>\n joinPaths(\n context.entryPath,\n command.path.segments\n .filter(segment => !isDynamicPathSegment(segment))\n .join(\"/\"),\n \"index.ts\"\n )\n );\n\n return (\n <>\n <TypescriptFile\n {...rest}\n path={filePath.value}\n imports={defu(\n {\n didyoumean2: [\n { name: \"didYouMean\", default: true },\n { name: \"ReturnTypeEnums\" },\n { name: \"ThresholdTypeEnums\" }\n ]\n },\n imports ?? {},\n Object.entries(command.children)\n .filter(([, child]) => child.isVirtual)\n .reduce((ret, [name, child]) => {\n ret[`./${child.name}`] = [\n { name: \"handler\", alias: `handle${pascalCase(name)}` }\n ];\n\n return ret;\n }, {} as TypescriptFileImports)\n )}\n builtinImports={defu(builtinImports ?? {}, {\n console: [\"warn\", \"error\", \"table\", \"colors\", \"writeLine\"],\n utils: [\"getArgs\", \"hasFlag\", \"isMinimal\", \"isUnicodeSupported\"]\n })}>\n <BannerFunctionDeclaration command={command} />\n <hbr />\n <hbr />\n <VirtualCommandHandlerDeclaration command={command} />\n </TypescriptFile>\n <For each={Object.values(command.children)}>\n {child => (\n <Show\n when={child.isVirtual}\n fallback={<CommandEntry command={child} />}>\n <VirtualCommandEntry command={child} />\n </Show>\n )}\n </For>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAuDA,SAAgBsB,iCACdC,OACA;CACA,MAAM,EAAEC,SAASC,aAAaF;CAE9B,MAAMG,8EAA8C;AAEpD,QAAA,kDAEKpB,6DAAK;EAAA,IACJsB,UAAO;AAAA,UAAE,OAAOJ,QAAQK,MAAK,mEAAeH,QAAQ,CAAA,GAAIF,QAAQM,KAAKC,SAClEC,KAAIC,sFACkBA,QAAQ,GACzB,0IAA2CA,QAAQ,CAAC,CAAA,KACpDA,QACL,CACAC,KAAK,IAAI,CAAA;;EAAoB,IAAAT,WAAA;AAAA,UAAA;qDAC/BjB,oEAAY,EAAA,IAAAiB,WAAA;AAAA,YAAE,GAAGD,QAAQW,YAAYC,QAAQ,QAAQ,GAAG,CAAA;OAAG,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAE3D3B,kEAAU,EAAA,IAAAgB,WAAA;AAAA,YAAED,QAAQK;OAAK,CAAA;qDACzBtB,kEAAU;KAAC+B,MAAI;KAAAb,UAAS;KAAmD,CAAA;IAAA;;EAAA,CAAA,mDAE7ErB,2CAAmB;EAAA,UAAA;EAElBmC,OAAK;EACLD,MAAI;EACJE,YAAY,CAAC;GAAEF,MAAM;GAAQG,MAAM;GAAYC,SAAS;GAAa,CAAC;EAAA,IAAAjB,WAAA;AAAA,UAAA;qDAAA,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;IAGrEA;qDACAL,iDAAa;KAAA,IACZU,OAAI;AAAA,aAAEN,QAAQM,KAAKC;;KAAQ,IAC3BY,WAAQ;AAAA,aAAEnB,QAAQC;;KAAQ,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;IAI3BzB,oBAAI;;qDACK,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAGTqB,qCAAW;KAAA,IACVS,OAAI;AAAA,aAAEN,QAAQM;;KAAI,IAClBc,UAAO;AAAA,aAAEC,OAAOC,OAAOtB,QAAQoB,QAAQ;;KAAA,IACvCD,WAAQ;AAAA,aAAEnB,QAAQC,YAAY,EAAE;;KAAA,CAAA;IAAA;;EAAA,CAAA,CAAA;;;;;AAiB1C,SAAgBsB,oBAAoBxB,OAAiC;CACnE,MAAM,EAAEC,SAASwB,SAASC,gBAAgB,GAAGC,SAAS3B;CAEtD,MAAMG,8EAA8C;CACpD,MAAMyB,iFAEFzB,QAAQ0B,WACR5B,QAAQM,KAAKC,SACVsB,QAAOpB,YAAW,2EAAsBA,QAAQ,CAAC,CACjDC,KAAK,IAAI,EACZ,WAEJ,CAAC;AAED,QAAA,kDAEKxB,4HACKwC,MAAI;EAAA,IACRpB,OAAI;AAAA,UAAEqB,SAASI;;EAAK,IACpBP,UAAO;AAAA,4BACL,EACEQ,aAAa;IACX;KAAElB,MAAM;KAAcI,SAAS;KAAM;IACrC,EAAEJ,MAAM,mBAAmB;IAC3B,EAAEA,MAAM,sBAAsB;IAAA,EAEjC,EACDU,WAAW,EAAE,EACbH,OAAOY,QAAQjC,QAAQC,SAAS,CAC7B4B,QAAQ,GAAGK,WAAWA,MAAMC,UAAU,CACtCC,QAAQC,KAAK,CAACvB,MAAMoB,WAAW;AAC9BG,QAAI,KAAKH,MAAMpB,UAAU,CACvB;KAAEA,MAAM;KAAWwB,OAAO,4DAAoBxB,KAAK;KAAI,CACxD;AAED,WAAOuB;MACN,EAA2B,CAClC,CAAC;;EAAA,IACDZ,iBAAc;AAAA,4BAAOA,kBAAkB,EAAE,EAAE;IACzCc,SAAS;KAAC;KAAQ;KAAS;KAAS;KAAU;KAAY;IAC1DC,OAAO;KAAC;KAAW;KAAW;KAAa;KAAoB;IAChE,CAAC;;EAAA,IAAAvC,WAAA;AAAA,UAAA;qDACDP,0EAAyB,EAAUM,SAAO,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAAA,OAAA,EAAA,CAAA;qDAG1CF,kCAAgC,EAAUE,SAAO,CAAA;IAAA;;EAAA,CAAA,CAAA,mDAEnDtB,qBAAG;EAAA,IAAC+D,OAAI;AAAA,UAAEpB,OAAOC,OAAOtB,QAAQC,SAAS;;EAAAA,WACvCiC,2DACEvD,sBAAI;GAAA,IACH+D,OAAI;AAAA,WAAER,MAAMC;;GAAS,IACrBQ,WAAQ;AAAA,4DAAGhD,+CAAY,EAACK,SAASkC,OAAK,CAAA;;GAAA,IAAAjC,WAAA;AAAA,4DACrCsB,qBAAmB,EAACvB,SAASkC,OAAK,CAAA;;GAAA,CAAA;EAEtC,CAAA,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"virtual-command-entry.mjs","names":["code","computed","For","Show","FunctionDeclaration","usePowerlines","TSDoc","TSDocParam","TSDocRemarks","TSDocTitle","TypescriptFile","getAppBin","getDynamicPathSegmentName","isDynamicPathSegment","joinPaths","constantCase","pascalCase","defu","BannerFunctionDeclaration","CommandEntry","CommandRouter","VirtualHelp","VirtualCommandHandlerDeclaration","props","command","children","context","_$createComponent","heading","title","path","segments","map","segment","join","description","replace","_$createIntrinsic","name","async","parameters","type","default","commands","options","Object","values","VirtualCommandEntry","imports","builtinImports","rest","filePath","entryPath","filter","_$mergeProps","value","didyoumean2","entries","child","isVirtual","reduce","ret","alias","console","utils","each","when","fallback"],"sources":["../../src/components/virtual-command-entry.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 type { Children } from \"@alloy-js/core\";\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { TypescriptFileImports } from \"@powerlines/plugin-alloy/types/components\";\nimport type { EntryFileProps } from \"@powerlines/plugin-alloy/typescript/components/entry-file\";\nimport {\n TSDoc,\n TSDocParam,\n TSDocRemarks,\n TSDocTitle\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript/components/typescript-file\";\nimport {\n getAppBin,\n getDynamicPathSegmentName,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport type { CommandTree } from \"@shell-shock/core/types/command\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport defu from \"defu\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\nimport { BannerFunctionDeclaration } from \"./banner-function-declaration\";\nimport { CommandEntry } from \"./command-entry\";\nimport { CommandRouter } from \"./command-router\";\nimport { VirtualHelp } from \"./help\";\n\nexport interface VirtualCommandHandlerDeclarationProps {\n command: CommandTree;\n children?: Children;\n}\n\n/**\n * A component that generates the `handler` function declaration for a command.\n */\nexport function VirtualCommandHandlerDeclaration(\n props: VirtualCommandHandlerDeclarationProps\n) {\n const { command, children } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n <TSDoc\n heading={`The ${command.title} (${getAppBin(context)} ${command.path.segments\n .map(segment =>\n isDynamicPathSegment(segment)\n ? `[${constantCase(getDynamicPathSegmentName(segment))}]`\n : segment\n )\n .join(\" \")}) virtual command.`}>\n <TSDocRemarks>{`${command.description.replace(/\\.+$/, \"\")}.`}</TSDocRemarks>\n <hbr />\n <TSDocTitle>{command.title}</TSDocTitle>\n <TSDocParam name=\"args\">{`The command-line arguments passed to the command.`}</TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n async\n name=\"handler\"\n parameters={[{ name: \"args\", type: \"string[]\", default: \"getArgs()\" }]}>\n <hbr />\n <hbr />\n {children}\n <CommandRouter\n path={command.path.segments}\n commands={command.children}\n />\n <hbr />\n <hbr />\n {code`writeLine(\"\");\n banner();`}\n <hbr />\n <hbr />\n <VirtualHelp\n path={command.path}\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n </FunctionDeclaration>\n </>\n );\n}\n\nexport interface VirtualCommandEntryProps extends Omit<\n EntryFileProps,\n \"path\" | \"typeDefinition\"\n> {\n command: CommandTree;\n}\n\n/**\n * The virtual command entry point for the Shell Shock project.\n */\nexport function VirtualCommandEntry(props: VirtualCommandEntryProps) {\n const { command, imports, builtinImports, ...rest } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const filePath = computed(() =>\n joinPaths(\n context.entryPath,\n command.path.segments\n .filter(segment => !isDynamicPathSegment(segment))\n .join(\"/\"),\n \"index.ts\"\n )\n );\n\n return (\n <>\n <TypescriptFile\n {...rest}\n path={filePath.value}\n imports={defu(\n {\n didyoumean2: [\n { name: \"didYouMean\", default: true },\n { name: \"ReturnTypeEnums\" },\n { name: \"ThresholdTypeEnums\" }\n ]\n },\n imports ?? {},\n Object.entries(command.children)\n .filter(([, child]) => child.isVirtual)\n .reduce((ret, [name, child]) => {\n ret[`./${child.name}`] = [\n { name: \"handler\", alias: `handle${pascalCase(name)}` }\n ];\n\n return ret;\n }, {} as TypescriptFileImports)\n )}\n builtinImports={defu(builtinImports ?? {}, {\n console: [\"warn\", \"error\", \"table\", \"colors\", \"writeLine\"],\n utils: [\"getArgs\", \"hasFlag\", \"isMinimal\"]\n })}>\n <BannerFunctionDeclaration command={command} />\n <hbr />\n <hbr />\n <VirtualCommandHandlerDeclaration command={command} />\n </TypescriptFile>\n <For each={Object.values(command.children)}>\n {child => (\n <Show\n when={child.isVirtual}\n fallback={<CommandEntry command={child} />}>\n <VirtualCommandEntry command={child} />\n </Show>\n )}\n </For>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAuDA,SAAgBsB,iCACdC,OACA;CACA,MAAM,EAAEC,SAASC,aAAaF;CAE9B,MAAMG,UAAUrB,eAAoC;AAEpD,QAAA,CAAAsB,gBAEKrB,OAAK;EAAA,IACJsB,UAAO;AAAA,UAAE,OAAOJ,QAAQK,MAAK,IAAKlB,UAAUe,QAAQ,CAAA,GAAIF,QAAQM,KAAKC,SAClEC,KAAIC,YACHpB,qBAAqBoB,QAAQ,GACzB,IAAIlB,aAAaH,0BAA0BqB,QAAQ,CAAC,CAAA,KACpDA,QACL,CACAC,KAAK,IAAI,CAAA;;EAAoB,IAAAT,WAAA;AAAA,UAAA;IAAAE,gBAC/BnB,cAAY,EAAA,IAAAiB,WAAA;AAAA,YAAE,GAAGD,QAAQW,YAAYC,QAAQ,QAAQ,GAAG,CAAA;OAAG,CAAA;IAAAC,gBAAA,OAAA,EAAA,CAAA;IAAAV,gBAE3DlB,YAAU,EAAA,IAAAgB,WAAA;AAAA,YAAED,QAAQK;OAAK,CAAA;IAAAF,gBACzBpB,YAAU;KAAC+B,MAAI;KAAAb,UAAS;KAAmD,CAAA;IAAA;;EAAA,CAAA,EAAAE,gBAE7EvB,qBAAmB;EAAA,UAAA;EAElBmC,OAAK;EACLD,MAAI;EACJE,YAAY,CAAC;GAAEF,MAAM;GAAQG,MAAM;GAAYC,SAAS;GAAa,CAAC;EAAA,IAAAjB,WAAA;AAAA,UAAA;IAAAY,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAGrEZ;IAAQE,gBACRP,eAAa;KAAA,IACZU,OAAI;AAAA,aAAEN,QAAQM,KAAKC;;KAAQ,IAC3BY,WAAQ;AAAA,aAAEnB,QAAQC;;KAAQ,CAAA;IAAAY,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAI3BrC,IAAI;;IACKqC,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAAAV,gBAGTN,aAAW;KAAA,IACVS,OAAI;AAAA,aAAEN,QAAQM;;KAAI,IAClBc,UAAO;AAAA,aAAEC,OAAOC,OAAOtB,QAAQoB,QAAQ;;KAAA,IACvCD,WAAQ;AAAA,aAAEnB,QAAQC,YAAY,EAAE;;KAAA,CAAA;IAAA;;EAAA,CAAA,CAAA;;;;;AAiB1C,SAAgBsB,oBAAoBxB,OAAiC;CACnE,MAAM,EAAEC,SAASwB,SAASC,gBAAgB,GAAGC,SAAS3B;CAEtD,MAAMG,UAAUrB,eAAoC;CACpD,MAAM8C,WAAWlD,eACfa,UACEY,QAAQ0B,WACR5B,QAAQM,KAAKC,SACVsB,QAAOpB,YAAW,CAACpB,qBAAqBoB,QAAQ,CAAC,CACjDC,KAAK,IAAI,EACZ,WAEJ,CAAC;AAED,QAAA,CAAAP,gBAEKjB,gBAAc4C,WACTJ,MAAI;EAAA,IACRpB,OAAI;AAAA,UAAEqB,SAASI;;EAAK,IACpBP,UAAO;AAAA,UAAE/B,KACP,EACEuC,aAAa;IACX;KAAElB,MAAM;KAAcI,SAAS;KAAM;IACrC,EAAEJ,MAAM,mBAAmB;IAC3B,EAAEA,MAAM,sBAAsB;IAAA,EAEjC,EACDU,WAAW,EAAE,EACbH,OAAOY,QAAQjC,QAAQC,SAAS,CAC7B4B,QAAQ,GAAGK,WAAWA,MAAMC,UAAU,CACtCC,QAAQC,KAAK,CAACvB,MAAMoB,WAAW;AAC9BG,QAAI,KAAKH,MAAMpB,UAAU,CACvB;KAAEA,MAAM;KAAWwB,OAAO,SAAS9C,WAAWsB,KAAK;KAAI,CACxD;AAED,WAAOuB;MACN,EAA2B,CAClC,CAAC;;EAAA,IACDZ,iBAAc;AAAA,UAAEhC,KAAKgC,kBAAkB,EAAE,EAAE;IACzCc,SAAS;KAAC;KAAQ;KAAS;KAAS;KAAU;KAAY;IAC1DC,OAAO;KAAC;KAAW;KAAW;
|
|
1
|
+
{"version":3,"file":"virtual-command-entry.mjs","names":["code","computed","For","Show","FunctionDeclaration","usePowerlines","TSDoc","TSDocParam","TSDocRemarks","TSDocTitle","TypescriptFile","getAppBin","getDynamicPathSegmentName","isDynamicPathSegment","joinPaths","constantCase","pascalCase","defu","BannerFunctionDeclaration","CommandEntry","CommandRouter","VirtualHelp","VirtualCommandHandlerDeclaration","props","command","children","context","_$createComponent","heading","title","path","segments","map","segment","join","description","replace","_$createIntrinsic","name","async","parameters","type","default","commands","options","Object","values","VirtualCommandEntry","imports","builtinImports","rest","filePath","entryPath","filter","_$mergeProps","value","didyoumean2","entries","child","isVirtual","reduce","ret","alias","console","utils","each","when","fallback"],"sources":["../../src/components/virtual-command-entry.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 type { Children } from \"@alloy-js/core\";\nimport { code, computed, For, Show } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { TypescriptFileImports } from \"@powerlines/plugin-alloy/types/components\";\nimport type { EntryFileProps } from \"@powerlines/plugin-alloy/typescript/components/entry-file\";\nimport {\n TSDoc,\n TSDocParam,\n TSDocRemarks,\n TSDocTitle\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { TypescriptFile } from \"@powerlines/plugin-alloy/typescript/components/typescript-file\";\nimport {\n getAppBin,\n getDynamicPathSegmentName,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils/context-helpers\";\nimport type { CommandTree } from \"@shell-shock/core/types/command\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { pascalCase } from \"@stryke/string-format/pascal-case\";\nimport defu from \"defu\";\nimport type { ScriptPresetContext } from \"../types/plugin\";\nimport { BannerFunctionDeclaration } from \"./banner-function-declaration\";\nimport { CommandEntry } from \"./command-entry\";\nimport { CommandRouter } from \"./command-router\";\nimport { VirtualHelp } from \"./help\";\n\nexport interface VirtualCommandHandlerDeclarationProps {\n command: CommandTree;\n children?: Children;\n}\n\n/**\n * A component that generates the `handler` function declaration for a command.\n */\nexport function VirtualCommandHandlerDeclaration(\n props: VirtualCommandHandlerDeclarationProps\n) {\n const { command, children } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n\n return (\n <>\n <TSDoc\n heading={`The ${command.title} (${getAppBin(context)} ${command.path.segments\n .map(segment =>\n isDynamicPathSegment(segment)\n ? `[${constantCase(getDynamicPathSegmentName(segment))}]`\n : segment\n )\n .join(\" \")}) virtual command.`}>\n <TSDocRemarks>{`${command.description.replace(/\\.+$/, \"\")}.`}</TSDocRemarks>\n <hbr />\n <TSDocTitle>{command.title}</TSDocTitle>\n <TSDocParam name=\"args\">{`The command-line arguments passed to the command.`}</TSDocParam>\n </TSDoc>\n <FunctionDeclaration\n export\n async\n name=\"handler\"\n parameters={[{ name: \"args\", type: \"string[]\", default: \"getArgs()\" }]}>\n <hbr />\n <hbr />\n {children}\n <CommandRouter\n path={command.path.segments}\n commands={command.children}\n />\n <hbr />\n <hbr />\n {code`writeLine(\"\");\n banner();`}\n <hbr />\n <hbr />\n <VirtualHelp\n path={command.path}\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n </FunctionDeclaration>\n </>\n );\n}\n\nexport interface VirtualCommandEntryProps extends Omit<\n EntryFileProps,\n \"path\" | \"typeDefinition\"\n> {\n command: CommandTree;\n}\n\n/**\n * The virtual command entry point for the Shell Shock project.\n */\nexport function VirtualCommandEntry(props: VirtualCommandEntryProps) {\n const { command, imports, builtinImports, ...rest } = props;\n\n const context = usePowerlines<ScriptPresetContext>();\n const filePath = computed(() =>\n joinPaths(\n context.entryPath,\n command.path.segments\n .filter(segment => !isDynamicPathSegment(segment))\n .join(\"/\"),\n \"index.ts\"\n )\n );\n\n return (\n <>\n <TypescriptFile\n {...rest}\n path={filePath.value}\n imports={defu(\n {\n didyoumean2: [\n { name: \"didYouMean\", default: true },\n { name: \"ReturnTypeEnums\" },\n { name: \"ThresholdTypeEnums\" }\n ]\n },\n imports ?? {},\n Object.entries(command.children)\n .filter(([, child]) => child.isVirtual)\n .reduce((ret, [name, child]) => {\n ret[`./${child.name}`] = [\n { name: \"handler\", alias: `handle${pascalCase(name)}` }\n ];\n\n return ret;\n }, {} as TypescriptFileImports)\n )}\n builtinImports={defu(builtinImports ?? {}, {\n console: [\"warn\", \"error\", \"table\", \"colors\", \"writeLine\"],\n utils: [\"getArgs\", \"hasFlag\", \"isMinimal\", \"isUnicodeSupported\"]\n })}>\n <BannerFunctionDeclaration command={command} />\n <hbr />\n <hbr />\n <VirtualCommandHandlerDeclaration command={command} />\n </TypescriptFile>\n <For each={Object.values(command.children)}>\n {child => (\n <Show\n when={child.isVirtual}\n fallback={<CommandEntry command={child} />}>\n <VirtualCommandEntry command={child} />\n </Show>\n )}\n </For>\n </>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAuDA,SAAgBsB,iCACdC,OACA;CACA,MAAM,EAAEC,SAASC,aAAaF;CAE9B,MAAMG,UAAUrB,eAAoC;AAEpD,QAAA,CAAAsB,gBAEKrB,OAAK;EAAA,IACJsB,UAAO;AAAA,UAAE,OAAOJ,QAAQK,MAAK,IAAKlB,UAAUe,QAAQ,CAAA,GAAIF,QAAQM,KAAKC,SAClEC,KAAIC,YACHpB,qBAAqBoB,QAAQ,GACzB,IAAIlB,aAAaH,0BAA0BqB,QAAQ,CAAC,CAAA,KACpDA,QACL,CACAC,KAAK,IAAI,CAAA;;EAAoB,IAAAT,WAAA;AAAA,UAAA;IAAAE,gBAC/BnB,cAAY,EAAA,IAAAiB,WAAA;AAAA,YAAE,GAAGD,QAAQW,YAAYC,QAAQ,QAAQ,GAAG,CAAA;OAAG,CAAA;IAAAC,gBAAA,OAAA,EAAA,CAAA;IAAAV,gBAE3DlB,YAAU,EAAA,IAAAgB,WAAA;AAAA,YAAED,QAAQK;OAAK,CAAA;IAAAF,gBACzBpB,YAAU;KAAC+B,MAAI;KAAAb,UAAS;KAAmD,CAAA;IAAA;;EAAA,CAAA,EAAAE,gBAE7EvB,qBAAmB;EAAA,UAAA;EAElBmC,OAAK;EACLD,MAAI;EACJE,YAAY,CAAC;GAAEF,MAAM;GAAQG,MAAM;GAAYC,SAAS;GAAa,CAAC;EAAA,IAAAjB,WAAA;AAAA,UAAA;IAAAY,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAGrEZ;IAAQE,gBACRP,eAAa;KAAA,IACZU,OAAI;AAAA,aAAEN,QAAQM,KAAKC;;KAAQ,IAC3BY,WAAQ;AAAA,aAAEnB,QAAQC;;KAAQ,CAAA;IAAAY,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAI3BrC,IAAI;;IACKqC,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAAAV,gBAGTN,aAAW;KAAA,IACVS,OAAI;AAAA,aAAEN,QAAQM;;KAAI,IAClBc,UAAO;AAAA,aAAEC,OAAOC,OAAOtB,QAAQoB,QAAQ;;KAAA,IACvCD,WAAQ;AAAA,aAAEnB,QAAQC,YAAY,EAAE;;KAAA,CAAA;IAAA;;EAAA,CAAA,CAAA;;;;;AAiB1C,SAAgBsB,oBAAoBxB,OAAiC;CACnE,MAAM,EAAEC,SAASwB,SAASC,gBAAgB,GAAGC,SAAS3B;CAEtD,MAAMG,UAAUrB,eAAoC;CACpD,MAAM8C,WAAWlD,eACfa,UACEY,QAAQ0B,WACR5B,QAAQM,KAAKC,SACVsB,QAAOpB,YAAW,CAACpB,qBAAqBoB,QAAQ,CAAC,CACjDC,KAAK,IAAI,EACZ,WAEJ,CAAC;AAED,QAAA,CAAAP,gBAEKjB,gBAAc4C,WACTJ,MAAI;EAAA,IACRpB,OAAI;AAAA,UAAEqB,SAASI;;EAAK,IACpBP,UAAO;AAAA,UAAE/B,KACP,EACEuC,aAAa;IACX;KAAElB,MAAM;KAAcI,SAAS;KAAM;IACrC,EAAEJ,MAAM,mBAAmB;IAC3B,EAAEA,MAAM,sBAAsB;IAAA,EAEjC,EACDU,WAAW,EAAE,EACbH,OAAOY,QAAQjC,QAAQC,SAAS,CAC7B4B,QAAQ,GAAGK,WAAWA,MAAMC,UAAU,CACtCC,QAAQC,KAAK,CAACvB,MAAMoB,WAAW;AAC9BG,QAAI,KAAKH,MAAMpB,UAAU,CACvB;KAAEA,MAAM;KAAWwB,OAAO,SAAS9C,WAAWsB,KAAK;KAAI,CACxD;AAED,WAAOuB;MACN,EAA2B,CAClC,CAAC;;EAAA,IACDZ,iBAAc;AAAA,UAAEhC,KAAKgC,kBAAkB,EAAE,EAAE;IACzCc,SAAS;KAAC;KAAQ;KAAS;KAAS;KAAU;KAAY;IAC1DC,OAAO;KAAC;KAAW;KAAW;KAAa;KAAoB;IAChE,CAAC;;EAAA,IAAAvC,WAAA;AAAA,UAAA;IAAAE,gBACDT,2BAAyB,EAAUM,SAAO,CAAA;IAAAa,gBAAA,OAAA,EAAA,CAAA;IAAAA,gBAAA,OAAA,EAAA,CAAA;IAAAV,gBAG1CL,kCAAgC,EAAUE,SAAO,CAAA;IAAA;;EAAA,CAAA,CAAA,EAAAG,gBAEnDzB,KAAG;EAAA,IAAC+D,OAAI;AAAA,UAAEpB,OAAOC,OAAOtB,QAAQC,SAAS;;EAAAA,WACvCiC,UAAK/B,gBACHxB,MAAI;GAAA,IACH+D,OAAI;AAAA,WAAER,MAAMC;;GAAS,IACrBQ,WAAQ;AAAA,WAAAxC,gBAAGR,cAAY,EAACK,SAASkC,OAAK,CAAA;;GAAA,IAAAjC,WAAA;AAAA,WAAAE,gBACrCoB,qBAAmB,EAACvB,SAASkC,OAAK,CAAA;;GAAA,CAAA;EAEtC,CAAA,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;;;;UAmCiB,mBAAA,SACP,KAAK,4BAA4B,QAAQ;;AADnD;;;;;;;;;;EAmBY,cAAA,CAAA,EALN,aAK4B,EAAA,GAAA,CAAG,
|
|
1
|
+
{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;;;;UAmCiB,mBAAA,SACP,KAAK,4BAA4B,QAAQ;;AADnD;;;;;;;;;;EAmBY,cAAA,CAAA,EALN,aAK4B,EAAA,GAAA,CAAA,CAAG,OAAA,EAJpB,OAIiC,EAAA,KAAA,EAJjB,WAIoC,EAAA,GAJpB,aAIoB,EAAA,CAAA,GAAA,KAAA;AAErE;AAAyC,KAF7B,sBAAA,GAAyB,UAEI,GAFS,mBAET;AACzB,KADJ,0BAAA,GAA6B,cACzB,GAAd,QAAc,CAAL,IAAK,CAAA,mBAAA,EAAA,OAAA,CAAA,CAAA,GACd,yBADc;AAAL,KAGC,mBAHD,CAAA,wBAIe,0BAJf,GAKP,0BALO,CAAA,GAMP,kBANO,CAMY,eANZ,CAAA,GAOT,kBAPS,CAOU,eAPV,CAAA,GAQT,OARS,CAQD,eARC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shell-shock/preset-script",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A Shell Shock preset that generates a fully-featured script application.",
|
|
6
6
|
"repository": {
|
|
@@ -282,8 +282,8 @@
|
|
|
282
282
|
"@powerlines/deepkit": "^0.6.50",
|
|
283
283
|
"@powerlines/plugin-alloy": "^0.20.14",
|
|
284
284
|
"@powerlines/plugin-plugin": "^0.12.221",
|
|
285
|
-
"@shell-shock/core": "^0.
|
|
286
|
-
"@shell-shock/plugin-theme": "^0.0.
|
|
285
|
+
"@shell-shock/core": "^0.7.0",
|
|
286
|
+
"@shell-shock/plugin-theme": "^0.0.16",
|
|
287
287
|
"@stryke/path": "0.26.4",
|
|
288
288
|
"@stryke/string-format": "0.13.7",
|
|
289
289
|
"defu": "6.1.4",
|
|
@@ -293,8 +293,8 @@
|
|
|
293
293
|
"devDependencies": {
|
|
294
294
|
"@babel/core": "^7.29.0",
|
|
295
295
|
"@powerlines/plugin-alloy": "^0.20.14",
|
|
296
|
-
"@types/node": "^22.19.
|
|
296
|
+
"@types/node": "^22.19.10"
|
|
297
297
|
},
|
|
298
298
|
"publishConfig": { "access": "public" },
|
|
299
|
-
"gitHead": "
|
|
299
|
+
"gitHead": "b7429d401477d60e5e8ff9daa437ccd748732ca4"
|
|
300
300
|
}
|