@shell-shock/plugin-help 0.2.24 → 0.2.26

package/dist/index.cjs

@@ -1,98 +1 @@
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
-const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
-const require_components_help_builtin = require('./components/help-builtin.cjs');
-const require_components_help_command = require('./components/help-command.cjs');
-require('./components/index.cjs');
-let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
-let _alloy_js_core = require("@alloy-js/core");
-let _powerlines_plugin_alloy_core_components = require("@powerlines/plugin-alloy/core/components");
-let _powerlines_plugin_alloy_render = require("@powerlines/plugin-alloy/render");
-let _shell_shock_core_plugin_utils = require("@shell-shock/core/plugin-utils");
-let _shell_shock_plugin_console = require("@shell-shock/plugin-console");
-_shell_shock_plugin_console = require_runtime.__toESM(_shell_shock_plugin_console);
-let _shell_shock_plugin_theme = require("@shell-shock/plugin-theme");
-_shell_shock_plugin_theme = require_runtime.__toESM(_shell_shock_plugin_theme);
-let _stryke_helpers_get_unique = require("@stryke/helpers/get-unique");
-let _stryke_path_join = require("@stryke/path/join");
-let _stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
-let defu = require("defu");
-defu = require_runtime.__toESM(defu);
-
-//#region src/index.tsx
-/**
-* The Help - Shell Shock plugin to add a help command to the application.
-*/
-const plugin = (options = {}) => {
-	return [
-		...(0, _shell_shock_plugin_theme.default)(options.theme),
-		...(0, _shell_shock_plugin_console.default)(options.console),
-		{
-			name: "shell-shock:help",
-			enforce: "post",
-			config() {
-				this.debug("Providing default configuration for the Shell Shock `help` plugin.");
-				return { help: (0, defu.default)({ command: options.command === false ? false : (0, _stryke_type_checks_is_set_string.isSetString)(options.command) ? { name: options.command } : { name: "help" } }, options, { builtins: true }) };
-			},
-			async configResolved() {
-				this.debug("Adding the Help command to the application context.");
-				if (this.config.help.command !== false) {
-					this.inputs ??= [];
-					if (this.inputs.some((input) => input.name === this.config.help.command.name)) this.info("The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command.");
-					else this.inputs.push({
-						id: this.config.help.command.name,
-						path: this.config.help.command.name,
-						segments: [this.config.help.command.name],
-						title: "Help",
-						icon: "🛈",
-						tags: ["Utility"],
-						description: `Display command usage details and other useful information to the user.`,
-						entry: {
-							file: (0, _stryke_path_join.joinPaths)(this.entryPath, "help", "index.ts"),
-							input: { file: (0, _stryke_path_join.joinPaths)(this.entryPath, "help", "command.ts") }
-						},
-						isVirtual: false,
-						source: "help-plugin",
-						...this.config.help.command
-					});
-					await (0, _powerlines_plugin_alloy_render.render)(this, (0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_command.TemporaryHelpCommand, {}));
-				}
-			},
-			prepare: {
-				order: "post",
-				async handler() {
-					const _self$ = this;
-					const commands = await (0, _shell_shock_core_plugin_utils.getCommandList)(this);
-					this.debug(`Rendering \`help\` built-ins for each of the ${commands.length} command modules.`);
-					const segments = (0, _alloy_js_core.computed)(() => (0, _stryke_helpers_get_unique.getUniqueBy)(commands.map((command) => command.segments.filter((segment) => !(0, _shell_shock_core_plugin_utils.isDynamicPathSegment)(segment)).filter((segment) => segment.length > 0)), (segments) => segments.join("/")).filter((segments) => segments.length > 0).sort((a, b) => a.join("/").localeCompare(b.join("/"))));
-					return (0, _powerlines_plugin_alloy_render.render)(this, [(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
-						get when() {
-							return _self$.config.help.builtins !== false;
-						},
-						get children() {
-							return [
-								(0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_builtin.HelpBuiltin, { get command() {
-									return (0, _shell_shock_core_plugin_utils.computeBin)(_self$);
-								} }),
-								(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components.Spacing, {}),
-								(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
-									get each() {
-										return commands.sort((a, b) => a.name.localeCompare(b.name));
-									},
-									doubleHardline: true,
-									children: (command) => (0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_builtin.HelpBuiltin, { command })
-								}),
-								(0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_command.HelpCommand, { get segments() {
-									return segments.value;
-								} })
-							];
-						}
-					})]);
-				}
-			}
-		}
-	];
-};
-
-//#endregion
-exports.default = plugin;
-exports.plugin = plugin;
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require(`./_virtual/_rolldown/runtime.cjs`),t=require(`./components/help-builtin.cjs`),n=require(`./components/help-command.cjs`);require(`./components/index.cjs`);let r=require(`@alloy-js/core/jsx-runtime`),i=require(`@alloy-js/core`),a=require(`@powerlines/plugin-alloy/core/components`),o=require(`@powerlines/plugin-alloy/render`),s=require(`@shell-shock/core/plugin-utils`),c=require(`@shell-shock/plugin-console`);c=e.__toESM(c);let l=require(`@shell-shock/plugin-theme`);l=e.__toESM(l);let u=require(`@stryke/helpers/get-unique`),d=require(`@stryke/path/join`),f=require(`@stryke/type-checks/is-set-string`),p=require(`defu`);p=e.__toESM(p);const m=(e={})=>[...(0,l.default)(e.theme),...(0,c.default)(e.console),{name:`shell-shock:help`,enforce:`post`,config(){return this.debug("Providing default configuration for the Shell Shock `help` plugin."),{help:(0,p.default)({command:e.command===!1?!1:(0,f.isSetString)(e.command)?{name:e.command}:{name:`help`}},e,{builtins:!0})}},async configResolved(){this.debug(`Adding the Help command to the application context.`),this.config.help.command!==!1&&(this.inputs??=[],this.inputs.some(e=>e.name===this.config.help.command.name)?this.info("The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command."):this.inputs.push({id:this.config.help.command.name,path:this.config.help.command.name,segments:[this.config.help.command.name],title:`Help`,icon:`🛈`,tags:[`Utility`],description:`Display command usage details and other useful information to the user.`,entry:{file:(0,d.joinPaths)(this.entryPath,`help`,`index.ts`),input:{file:(0,d.joinPaths)(this.entryPath,`help`,`command.ts`)}},isVirtual:!1,source:`help-plugin`,...this.config.help.command}),await(0,o.render)(this,(0,r.createComponent)(n.TemporaryHelpCommand,{})))},prepare:{order:`post`,async handler(){let e=this,c=await(0,s.getCommandList)(this);this.debug(`Rendering \`help\` built-ins for each of the ${c.length} command modules.`);let l=(0,i.computed)(()=>(0,u.getUniqueBy)(c.map(e=>e.segments.filter(e=>!(0,s.isDynamicPathSegment)(e)).filter(e=>e.length>0)),e=>e.join(`/`)).filter(e=>e.length>0).sort((e,t)=>e.join(`/`).localeCompare(t.join(`/`))));return(0,o.render)(this,[(0,r.createComponent)(i.Show,{get when(){return e.config.help.builtins!==!1},get children(){return[(0,r.createComponent)(t.HelpBuiltin,{get command(){return(0,s.computeBin)(e)}}),(0,r.createComponent)(a.Spacing,{}),(0,r.createComponent)(i.For,{get each(){return c.sort((e,t)=>e.name.localeCompare(t.name))},doubleHardline:!0,children:e=>(0,r.createComponent)(t.HelpBuiltin,{command:e})}),(0,r.createComponent)(n.HelpCommand,{get segments(){return l.value}})]}})])}}}];exports.default=m,exports.plugin=m;

package/dist/index.mjs

@@ -1,93 +1,2 @@
-import { HelpBuiltin } from "./components/help-builtin.mjs";
-import { HelpCommand, TemporaryHelpCommand } from "./components/help-command.mjs";
-import "./components/index.mjs";
-import { createComponent } from "@alloy-js/core/jsx-runtime";
-import { For, Show, computed } from "@alloy-js/core";
-import { Spacing } from "@powerlines/plugin-alloy/core/components";
-import { render } from "@powerlines/plugin-alloy/render";
-import { computeBin, getCommandList, isDynamicPathSegment } from "@shell-shock/core/plugin-utils";
-import console from "@shell-shock/plugin-console";
-import theme from "@shell-shock/plugin-theme";
-import { getUniqueBy } from "@stryke/helpers/get-unique";
-import { joinPaths } from "@stryke/path/join";
-import { isSetString } from "@stryke/type-checks/is-set-string";
-import defu from "defu";
-
-//#region src/index.tsx
-/**
-* The Help - Shell Shock plugin to add a help command to the application.
-*/
-const plugin = (options = {}) => {
-	return [
-		...theme(options.theme),
-		...console(options.console),
-		{
-			name: "shell-shock:help",
-			enforce: "post",
-			config() {
-				this.debug("Providing default configuration for the Shell Shock `help` plugin.");
-				return { help: defu({ command: options.command === false ? false : isSetString(options.command) ? { name: options.command } : { name: "help" } }, options, { builtins: true }) };
-			},
-			async configResolved() {
-				this.debug("Adding the Help command to the application context.");
-				if (this.config.help.command !== false) {
-					this.inputs ??= [];
-					if (this.inputs.some((input) => input.name === this.config.help.command.name)) this.info("The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command.");
-					else this.inputs.push({
-						id: this.config.help.command.name,
-						path: this.config.help.command.name,
-						segments: [this.config.help.command.name],
-						title: "Help",
-						icon: "🛈",
-						tags: ["Utility"],
-						description: `Display command usage details and other useful information to the user.`,
-						entry: {
-							file: joinPaths(this.entryPath, "help", "index.ts"),
-							input: { file: joinPaths(this.entryPath, "help", "command.ts") }
-						},
-						isVirtual: false,
-						source: "help-plugin",
-						...this.config.help.command
-					});
-					await render(this, createComponent(TemporaryHelpCommand, {}));
-				}
-			},
-			prepare: {
-				order: "post",
-				async handler() {
-					const _self$ = this;
-					const commands = await getCommandList(this);
-					this.debug(`Rendering \`help\` built-ins for each of the ${commands.length} command modules.`);
-					const segments = computed(() => getUniqueBy(commands.map((command) => command.segments.filter((segment) => !isDynamicPathSegment(segment)).filter((segment) => segment.length > 0)), (segments) => segments.join("/")).filter((segments) => segments.length > 0).sort((a, b) => a.join("/").localeCompare(b.join("/"))));
-					return render(this, [createComponent(Show, {
-						get when() {
-							return _self$.config.help.builtins !== false;
-						},
-						get children() {
-							return [
-								createComponent(HelpBuiltin, { get command() {
-									return computeBin(_self$);
-								} }),
-								createComponent(Spacing, {}),
-								createComponent(For, {
-									get each() {
-										return commands.sort((a, b) => a.name.localeCompare(b.name));
-									},
-									doubleHardline: true,
-									children: (command) => createComponent(HelpBuiltin, { command })
-								}),
-								createComponent(HelpCommand, { get segments() {
-									return segments.value;
-								} })
-							];
-						}
-					})]);
-				}
-			}
-		}
-	];
-};
-
-//#endregion
-export { plugin as default, plugin };
+import{HelpBuiltin as e}from"./components/help-builtin.mjs";import{HelpCommand as t,TemporaryHelpCommand as n}from"./components/help-command.mjs";import"./components/index.mjs";import{createComponent as r}from"@alloy-js/core/jsx-runtime";import{For as i,Show as a,computed as o}from"@alloy-js/core";import{Spacing as s}from"@powerlines/plugin-alloy/core/components";import{render as c}from"@powerlines/plugin-alloy/render";import{computeBin as l,getCommandList as u,isDynamicPathSegment as d}from"@shell-shock/core/plugin-utils";import f from"@shell-shock/plugin-console";import p from"@shell-shock/plugin-theme";import{getUniqueBy as m}from"@stryke/helpers/get-unique";import{joinPaths as h}from"@stryke/path/join";import{isSetString as g}from"@stryke/type-checks/is-set-string";import _ from"defu";const v=(v={})=>[...p(v.theme),...f(v.console),{name:`shell-shock:help`,enforce:`post`,config(){return this.debug("Providing default configuration for the Shell Shock `help` plugin."),{help:_({command:v.command===!1?!1:g(v.command)?{name:v.command}:{name:`help`}},v,{builtins:!0})}},async configResolved(){this.debug(`Adding the Help command to the application context.`),this.config.help.command!==!1&&(this.inputs??=[],this.inputs.some(e=>e.name===this.config.help.command.name)?this.info("The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command."):this.inputs.push({id:this.config.help.command.name,path:this.config.help.command.name,segments:[this.config.help.command.name],title:`Help`,icon:`🛈`,tags:[`Utility`],description:`Display command usage details and other useful information to the user.`,entry:{file:h(this.entryPath,`help`,`index.ts`),input:{file:h(this.entryPath,`help`,`command.ts`)}},isVirtual:!1,source:`help-plugin`,...this.config.help.command}),await c(this,r(n,{})))},prepare:{order:`post`,async handler(){let n=this,f=await u(this);this.debug(`Rendering \`help\` built-ins for each of the ${f.length} command modules.`);let p=o(()=>m(f.map(e=>e.segments.filter(e=>!d(e)).filter(e=>e.length>0)),e=>e.join(`/`)).filter(e=>e.length>0).sort((e,t)=>e.join(`/`).localeCompare(t.join(`/`))));return c(this,[r(a,{get when(){return n.config.help.builtins!==!1},get children(){return[r(e,{get command(){return l(n)}}),r(s,{}),r(i,{get each(){return f.sort((e,t)=>e.name.localeCompare(t.name))},doubleHardline:!0,children:t=>r(e,{command:t})}),r(t,{get segments(){return p.value}})]}})])}}}];export{v as default,v as plugin};
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { computed, For, Show } from \"@alloy-js/core\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport {\n  computeBin,\n  getCommandList,\n  isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport type { CommandConfig } from \"@shell-shock/core/types/command\";\nimport console from \"@shell-shock/plugin-console\";\nimport theme from \"@shell-shock/plugin-theme\";\nimport { getUniqueBy } from \"@stryke/helpers/get-unique\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { HelpBuiltin, HelpCommand, TemporaryHelpCommand } from \"./components\";\nimport type { HelpPluginContext, HelpPluginOptions } from \"./types/plugin\";\n\nexport type * from \"./types\";\n\n/**\n * The Help - Shell Shock plugin to add a help command to the application.\n */\nexport const plugin = <TContext extends HelpPluginContext = HelpPluginContext>(\n  options: HelpPluginOptions = {}\n): Plugin<TContext>[] => {\n  return [\n    ...theme<TContext>(options.theme),\n    ...console<TContext>(options.console),\n    {\n      name: \"shell-shock:help\",\n      enforce: \"post\",\n      config() {\n        this.debug(\n          \"Providing default configuration for the Shell Shock `help` plugin.\"\n        );\n\n        return {\n          help: defu(\n            {\n              command:\n                options.command === false\n                  ? false\n                  : isSetString(options.command)\n                    ? { name: options.command }\n                    : { name: \"help\" }\n            },\n            options,\n            {\n              builtins: true\n            }\n          )\n        };\n      },\n      async configResolved() {\n        this.debug(\"Adding the Help command to the application context.\");\n\n        if (this.config.help.command !== false) {\n          this.inputs ??= [];\n          if (\n            this.inputs.some(\n              input =>\n                input.name === (this.config.help.command as CommandConfig).name\n            )\n          ) {\n            this.info(\n              \"The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command.\"\n            );\n          } else {\n            this.inputs.push({\n              id: this.config.help.command.name,\n              path: this.config.help.command.name,\n              segments: [this.config.help.command.name],\n              title: \"Help\",\n              icon: \"🛈\",\n              tags: [\"Utility\"],\n              description: `Display command usage details and other useful information to the user.`,\n              entry: {\n                file: joinPaths(this.entryPath, \"help\", \"index.ts\"),\n                input: {\n                  file: joinPaths(this.entryPath, \"help\", \"command.ts\")\n                }\n              },\n              isVirtual: false,\n              source: \"help-plugin\",\n              ...this.config.help.command\n            });\n          }\n\n          await render(this, <TemporaryHelpCommand />);\n        }\n      },\n      prepare: {\n        order: \"post\",\n        async handler() {\n          const commands = await getCommandList(this);\n          this.debug(\n            `Rendering \\`help\\` built-ins for each of the ${\n              commands.length\n            } command modules.`\n          );\n\n          const segments = computed(() =>\n            getUniqueBy(\n              commands.map(command =>\n                command.segments\n                  .filter(segment => !isDynamicPathSegment(segment))\n                  .filter(segment => segment.length > 0)\n              ),\n              segments => segments.join(\"/\")\n            )\n              .filter(segments => segments.length > 0)\n              .sort((a, b) => a.join(\"/\").localeCompare(b.join(\"/\")))\n          );\n\n          return render(\n            this,\n            <>\n              <Show when={this.config.help.builtins !== false}>\n                <HelpBuiltin command={computeBin(this)} />\n                <Spacing />\n                <For\n                  each={commands.sort((a, b) => a.name.localeCompare(b.name))}\n                  doubleHardline>\n                  {command => <HelpBuiltin command={command} />}\n                </For>\n                <HelpCommand segments={segments.value} />\n              </Show>\n            </>\n          );\n        }\n      }\n    }\n  ];\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAuCE,QAAA;EAAA,GAAA,MAAA,QAAA,MAAA;EAAA,GAAA,QAAA,QAAA,QAAA;EAAA;GACC,MAAI;GACL,SAAA;GACF,SAAa;AACX,SAAS,MAAA,qEAAqB;AAC7B,WAAO,EACF,MAAC,KAAA,EACF,SAAM,QAAU,YAAc,QAAA,QAAA,YAAA,QAAA,QAAA,GAAA,EAC9B,MAAQ,QAAU,SACrB,GAAA,EACQ,MAAM,QACZ,EACA,EAAA,SAAS,EACP,UAAU,MACT,CAAC,EACH;;GAEH,MAAI,iBAAO;AACT,SAAI,MAAM,sDAAI;AACd,QAAI,KAAE,OAAA,KAAA,YAAA,OAAA;AACJ,UAAK,WAAQ,EAAA;AACb,SAAI,KAAI,OAAQ,MAAA,UAAY,MAAA,SAAA,KAAA,OAAA,KAAA,QAAA,KAAA,CAC1B,MAAK,KAAK,2LAAA;SAEV,MAAK,OAAO,KAAE;MACZ,IAAI,KAAK,OAAO,KAAG,QAAM;MACzB,MAAC,KAAA,OAAA,KAAA,QAAA;MACD,UAAO,CAAA,KAAA,OAAA,KAAA,QAAA,KAAA;MACP,OAAA;MACA,MAAE;MACF,MAAA,CAAA,UAAA;MACF,aAAA;MACD,OAAA;OACF,MAAA,UAAA,KAAA,WAAA,QAAA,WAAA;OACK,OAAA,EACC,MAAO,UAAW,KAAK,WAAW,QAAI,aAAY;OAEnD;MACF,WAAa;MACX,QAAC;MACD,GAAA,KAAK,OAAO,KAAI;MACjB,CAAC;AAEJ,WAAI,OAAA,MAAA,gBAAA,sBAAA,EAAA,CAAA,CAAA;;;GAGR,SAAS;IACP,OAAO;IACP,MAAM,UAAK;KACT,MAAI,SAAW;KACf,MAAM,WAAS,MAAO,eAAa,KAAI;AACvC,UAAK,MAAM,gDAA8B,SAAA,OAAA,mBAAA;KACzC,MAAM,WAAW,eAAY,YAAa,SAAK,KAAA,YAAA,QAAA,SAAA,QAAA,YAAA,CAAA,qBAAA,QAAA,CAAA,CAAA,QAAA,YAAA,QAAA,SAAA,EAAA,CAAA,GAAA,aAAA,SAAA,KAAA,IAAA,CAAA,CAAA,QAAA,aAAA,SAAA,SAAA,EAAA,CAAA,MAAA,GAAA,MAAA,EAAA,KAAA,IAAA,CAAA,cAAA,EAAA,KAAA,IAAA,CAAA,CAAA,CAAA;AAC/C,YAAM,OAAQ,MAAK,CAAA,gBAAA,MAAA;MACjB,IAAI,OAAO;AACT,cAAO,OAAG,OAAS,KAAA,aAAA;;MAErB,IAAI,WAAO;AACT,cAAI;QAAI,gBAAiB,aAAY,EACnC,IAAE,UAAO;AACP,gBAAO,WAAW,OAAK;WAE1B,CAAC;QAAC,gBAAA,SAAA,EAAA,CAAA;QAAA,gBAAA,KAAA;SACD,IAAA,OAAW;AACX,iBAAS,SAAK,MAAO,GAAA,MAAA,EAAA,KAAA,cAAA,EAAA,KAAA,CAAA;;SAErB,gBAAA;SACJ,WAAA,YAAA,gBAAA,aAAA,WAEK,CAAC;SACR,CAAA;QAAA,gBAAA,aAAA,EACD,IAAA,WAAA;AACQ,gBAAA,SAAA;WAEF,CAAC;QAAA;;MAEL,CAAC,CAAA,CAAA;;IAEL;GACF;EAAC"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { computed, For, Show } from \"@alloy-js/core\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport {\n  computeBin,\n  getCommandList,\n  isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport type { CommandConfig } from \"@shell-shock/core/types/command\";\nimport console from \"@shell-shock/plugin-console\";\nimport theme from \"@shell-shock/plugin-theme\";\nimport { getUniqueBy } from \"@stryke/helpers/get-unique\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { HelpBuiltin, HelpCommand, TemporaryHelpCommand } from \"./components\";\nimport type { HelpPluginContext, HelpPluginOptions } from \"./types/plugin\";\n\nexport type * from \"./types\";\n\n/**\n * The Help - Shell Shock plugin to add a help command to the application.\n */\nexport const plugin = <TContext extends HelpPluginContext = HelpPluginContext>(\n  options: HelpPluginOptions = {}\n): Plugin<TContext>[] => {\n  return [\n    ...theme<TContext>(options.theme),\n    ...console<TContext>(options.console),\n    {\n      name: \"shell-shock:help\",\n      enforce: \"post\",\n      config() {\n        this.debug(\n          \"Providing default configuration for the Shell Shock `help` plugin.\"\n        );\n\n        return {\n          help: defu(\n            {\n              command:\n                options.command === false\n                  ? false\n                  : isSetString(options.command)\n                    ? { name: options.command }\n                    : { name: \"help\" }\n            },\n            options,\n            {\n              builtins: true\n            }\n          )\n        };\n      },\n      async configResolved() {\n        this.debug(\"Adding the Help command to the application context.\");\n\n        if (this.config.help.command !== false) {\n          this.inputs ??= [];\n          if (\n            this.inputs.some(\n              (input: CommandConfig) =>\n                input.name === (this.config.help.command as CommandConfig).name\n            )\n          ) {\n            this.info(\n              \"The `help` command already exists in the commands list. If you would like the help command to be managed by the `@shell-shock/plugin-help` package, please remove or rename the command.\"\n            );\n          } else {\n            this.inputs.push({\n              id: this.config.help.command.name,\n              path: this.config.help.command.name,\n              segments: [this.config.help.command.name],\n              title: \"Help\",\n              icon: \"🛈\",\n              tags: [\"Utility\"],\n              description: `Display command usage details and other useful information to the user.`,\n              entry: {\n                file: joinPaths(this.entryPath, \"help\", \"index.ts\"),\n                input: {\n                  file: joinPaths(this.entryPath, \"help\", \"command.ts\")\n                }\n              },\n              isVirtual: false,\n              source: \"help-plugin\",\n              ...this.config.help.command\n            });\n          }\n\n          await render(this, <TemporaryHelpCommand />);\n        }\n      },\n      prepare: {\n        order: \"post\",\n        async handler() {\n          const commands = await getCommandList(this);\n          this.debug(\n            `Rendering \\`help\\` built-ins for each of the ${\n              commands.length\n            } command modules.`\n          );\n\n          const segments = computed(() =>\n            getUniqueBy(\n              commands.map(command =>\n                command.segments\n                  .filter(segment => !isDynamicPathSegment(segment))\n                  .filter(segment => segment.length > 0)\n              ),\n              segments => segments.join(\"/\")\n            )\n              .filter(segments => segments.length > 0)\n              .sort((a, b) => a.join(\"/\").localeCompare(b.join(\"/\")))\n          );\n\n          return render(\n            this,\n            <>\n              <Show when={this.config.help.builtins !== false}>\n                <HelpBuiltin command={computeBin(this)} />\n                <Spacing />\n                <For\n                  each={commands.sort((a, b) => a.name.localeCompare(b.name))}\n                  doubleHardline>\n                  {command => <HelpBuiltin command={command} />}\n                </For>\n                <HelpCommand segments={segments.value} />\n              </Show>\n            </>\n          );\n        }\n      }\n    }\n  ];\n};\n\nexport default plugin;\n"],"mappings":"gyBAiCA,MAAa,GAAU,EAAM,EAAA,GACpB,CAAA,GAAA,EAAA,EAAa,MAAW,CAAE,GAAA,EAAA,EAAA,QAA2B,CAAE,CAChE,KAAO,kCAEP,QAAa,CAEX,wFAAA,CACK,KAAO,EAAK,CACjB,QAAA,EAAA,UAAA,GAAA,GAAA,EAAA,EAAA,QAAA,CAAA,CACU,KAAC,EAAU,QACZ,CAAA,CACD,KAAQ,OACT,CACF,CAAA,EAAM,CACN,SAAQ,GACX,CAAA,CACE,EAEF,MAAE,gBAAS,CACT,KAAE,MAAK,sDAAK,CACR,KAAC,OAAU,KAAA,UAAQ,KACrB,KAAC,SAAA,EAAA,6DAED,KAAO,KAAA,2LAAA,CAEL,KAAE,OAAA,KAAA,CACA,GAAE,KAAO,OAAA,KAAA,QAAA,KACT,KAAI,KAAO,OAAC,KAAW,QAAC,KACxB,SAAQ,CAAA,KAAA,OAAA,KAAA,QAAA,KAAA,CACR,MAAO,OACP,KAAM,KACN,KAAM,CAAC,UAAU,CACjB,YAAC,0EACD,MAAO,CACP,KAAA,EAAA,KAAA,UAAA,OAAA,WAAA,CACE,MAAA,CACF,KAAA,EAAA,KAAA,UAAA,OAAA,aAAA,CACF,CACD,CACF,UAAA,GACK,OAAA,cACA,GAAC,KAAO,OAAO,KAAI,UAGvB,MAAM,EAAO,KAAM,EAAC,EAAA,EAAA,CAAA,CAAA,GAGxB,QAAS,CACP,MAAO,OACP,MAAM,SAAA,CACJ,IAAI,EAAA,KACA,EAAS,MAAA,EAAA,KAAA,CACb,KAAK,MAAM,gDAA8C,EAAS,OAAS,mBAAe,CAC1F,IAAK,EAAA,MAAA,EAAA,EAAA,IAAA,GAAA,EAAA,SAAA,OAAA,GAAA,CAAA,EAAA,EAAA,CAAA,CAAA,OAAA,GAAA,EAAA,OAAA,EAAA,CAAA,CAAA,GAAA,EAAA,KAAA,IAAA,CAAA,CAAA,OAAA,GAAA,EAAA,OAAA,EAAA,CAAA,MAAA,EAAA,IAAA,EAAA,KAAA,IAAA,CAAA,cAAA,EAAA,KAAA,IAAA,CAAA,CAAA,CAAA,CACL,OAAI,EAAK,KAAA,CAAA,EAAA,EAAA,CACP,IAAE,MAAK,CACL,OAAM,EAAK,OAAO,KAAK,WAAY,IAErC,IAAI,UAAW,CACb,MAAO,CAAC,EAAO,EAAA,CACb,IAAI,SAAM,CACV,OAAQ,EAAS,EAAA,EAElB,CAAC,CAAA,EAAO,EAAA,EAAA,CAAA,CAAA,EAAA,EAAA,CACP,IAAE,MAAM,CACN,OAAO,EAAA,MAAA,EAAA,IAAA,EAAA,KAAA,cAAA,EAAA,KAAA,CAAA,EAET,eAAE,GACF,SAAC,GAAA,EAAA,EAAA,CACU,UACX,CAAA,CACD,CAAC,CAAE,EAAkB,EAAA,CACpB,IAAA,UAAA,CACJ,OAAA,EAAA,OAEA,CAAA,CAAK,EAER,CAAA,CAAA,CAAA,EAEF,CACF,CAAC"}

package/dist/types/index.mjs

@@ -1 +1 @@
-export {  };
+export{};

package/dist/types/plugin.mjs

@@ -1 +1 @@
-export {  };
+export{};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/plugin-help",
-  "version": "0.2.24",
+  "version": "0.2.26",
   "private": false,
   "description": "A package containing a Shell Shock plugin to provide help and documentation for the local application's commands.",
   "keywords": [
@@ -153,24 +153,24 @@
   "dependencies": {
     "@alloy-js/core": "0.23.0-dev.8",
     "@alloy-js/typescript": "0.23.0-dev.4",
-    "@powerlines/deepkit": "^0.8.2",
-    "@powerlines/plugin-alloy": "^0.26.18",
-    "@powerlines/plugin-plugin": "^0.12.350",
-    "@shell-shock/core": "^0.17.6",
-    "@shell-shock/plugin-console": "^0.2.10",
-    "@shell-shock/plugin-theme": "^0.4.19",
-    "@stryke/helpers": "^0.10.8",
-    "@stryke/path": "^0.27.4",
-    "@stryke/string-format": "^0.17.9",
-    "@stryke/type-checks": "^0.6.1",
-    "@stryke/types": "^0.11.3",
+    "@powerlines/deepkit": "^0.8.49",
+    "@powerlines/plugin-alloy": "^0.26.67",
+    "@powerlines/plugin-plugin": "^0.12.399",
+    "@shell-shock/core": "^0.17.8",
+    "@shell-shock/plugin-console": "^0.2.12",
+    "@shell-shock/plugin-theme": "^0.4.21",
+    "@stryke/helpers": "^0.10.11",
+    "@stryke/path": "^0.28.1",
+    "@stryke/string-format": "^0.17.12",
+    "@stryke/type-checks": "^0.6.4",
+    "@stryke/types": "^0.11.6",
     "defu": "^6.1.7",
-    "powerlines": "^0.42.40"
+    "powerlines": "^0.44.12"
   },
   "devDependencies": {
-    "@powerlines/plugin-deepkit": "^0.11.280",
+    "@powerlines/plugin-deepkit": "^0.11.330",
     "@types/node": "^25.6.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "592aee8162fccb2d8547f6cf31b820aca3ae13ec"
+  "gitHead": "832c19e668deb4d29b5e0219a7708d111790f607"
 }