@shell-shock/plugin-help 0.1.2

package/dist/components/help-command.cjs

@@ -0,0 +1,97 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.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_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
+let _alloy_js_typescript = require("@alloy-js/typescript");
+let _powerlines_plugin_alloy_typescript = require("@powerlines/plugin-alloy/typescript");
+let _stryke_path = require("@stryke/path");
+let _powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
+let _powerlines_plugin_alloy_core = require("@powerlines/plugin-alloy/core");
+let _powerlines_plugin_alloy_typescript_components_tsdoc = require("@powerlines/plugin-alloy/typescript/components/tsdoc");
+
+//#region src/components/help-command.tsx
+/**
+* The Help command's handler wrapper for the Shell Shock project.
+*/
+function HelpCommand() {
+	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TypescriptFile, {
+		get path() {
+			return (0, _stryke_path.joinPaths)(context.entryPath, "help", "command.ts");
+		},
+		imports: {
+			"node:os": ["os"],
+			"node:fs/promises": ["readFile", "writeFile"]
+		},
+		builtinImports: { console: [
+			"colors",
+			"writeLine",
+			"success",
+			"warn",
+			"stripAnsi"
+		] },
+		get children() {
+			return [
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, { heading: "Options for the Help command." }),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.InterfaceDeclaration, {
+					"export": true,
+					name: "HelpOptions",
+					get children() {
+						return [
+							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, {
+								heading: "Whether to help to the latest version.",
+								get children() {
+									return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocRemarks, { children: `If set to \`true\`, the command will attempt to help to the latest version. This option takes precedence over the \`version\` option.` }), (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocDefaultValue, {
+										get type() {
+											return _powerlines_deepkit_vendor_type.ReflectionKind.boolean;
+										},
+										defaultValue: false
+									})];
+								}
+							}),
+							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.InterfaceMember, {
+								name: "latest",
+								optional: true,
+								type: "boolean"
+							}),
+							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
+							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, {
+								heading: "A specific application version to help to.",
+								get children() {
+									return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocRemarks, { children: `The command will attempt to help to the specified version. The version should be a valid semantic version string, or \`latest\` to help to the latest version.` }), (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDocDefaultValue, {
+										get type() {
+											return _powerlines_deepkit_vendor_type.ReflectionKind.string;
+										},
+										defaultValue: "latest"
+									})];
+								}
+							}),
+							(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.InterfaceMember, {
+								name: "version",
+								optional: true,
+								type: "string"
+							})
+						];
+					}
+				}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core.Spacing, {}),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript_components_tsdoc.TSDoc, { heading: "Handler logic for the \\`help\\` command." }),
+				(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					parameters: [{
+						name: "options",
+						type: "HelpOptions"
+					}],
+					children: _alloy_js_core.code` return;`
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+exports.HelpCommand = HelpCommand;

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

@@ -0,0 +1,10 @@
+import * as _alloy_js_core0 from "@alloy-js/core";
+
+//#region src/components/help-command.d.ts
+/**
+ * The Help command's handler wrapper for the Shell Shock project.
+ */
+declare function HelpCommand(): _alloy_js_core0.Children;
+//#endregion
+export { HelpCommand };
+//# sourceMappingURL=help-command.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"help-command.d.cts","names":[],"sources":["../../src/components/help-command.tsx"],"mappings":";;;;;;iBAyCgB,WAAA,CAAA,GAAW,eAAA,CAAA,QAAA"}

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

@@ -0,0 +1,10 @@
+import * as _alloy_js_core0 from "@alloy-js/core";
+
+//#region src/components/help-command.d.ts
+/**
+ * The Help command's handler wrapper for the Shell Shock project.
+ */
+declare function HelpCommand(): _alloy_js_core0.Children;
+//#endregion
+export { HelpCommand };
+//# sourceMappingURL=help-command.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"help-command.d.mts","names":[],"sources":["../../src/components/help-command.tsx"],"mappings":";;;;;;iBAyCgB,WAAA,CAAA,GAAW,eAAA,CAAA,QAAA"}

package/dist/components/help-command.mjs

@@ -0,0 +1,96 @@
+import { createComponent } from "@alloy-js/core/jsx-runtime";
+import { code } from "@alloy-js/core";
+import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
+import { FunctionDeclaration, InterfaceDeclaration } from "@alloy-js/typescript";
+import { InterfaceMember, TypescriptFile } from "@powerlines/plugin-alloy/typescript";
+import { joinPaths } from "@stryke/path";
+import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { Spacing } from "@powerlines/plugin-alloy/core";
+import { TSDoc as TSDoc$1, TSDocDefaultValue, TSDocRemarks as TSDocRemarks$1 } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
+
+//#region src/components/help-command.tsx
+/**
+* The Help command's handler wrapper for the Shell Shock project.
+*/
+function HelpCommand() {
+	const context = usePowerlines();
+	return createComponent(TypescriptFile, {
+		get path() {
+			return joinPaths(context.entryPath, "help", "command.ts");
+		},
+		imports: {
+			"node:os": ["os"],
+			"node:fs/promises": ["readFile", "writeFile"]
+		},
+		builtinImports: { console: [
+			"colors",
+			"writeLine",
+			"success",
+			"warn",
+			"stripAnsi"
+		] },
+		get children() {
+			return [
+				createComponent(TSDoc$1, { heading: "Options for the Help command." }),
+				createComponent(InterfaceDeclaration, {
+					"export": true,
+					name: "HelpOptions",
+					get children() {
+						return [
+							createComponent(TSDoc$1, {
+								heading: "Whether to help to the latest version.",
+								get children() {
+									return [createComponent(TSDocRemarks$1, { children: `If set to \`true\`, the command will attempt to help to the latest version. This option takes precedence over the \`version\` option.` }), createComponent(TSDocDefaultValue, {
+										get type() {
+											return ReflectionKind.boolean;
+										},
+										defaultValue: false
+									})];
+								}
+							}),
+							createComponent(InterfaceMember, {
+								name: "latest",
+								optional: true,
+								type: "boolean"
+							}),
+							createComponent(Spacing, {}),
+							createComponent(TSDoc$1, {
+								heading: "A specific application version to help to.",
+								get children() {
+									return [createComponent(TSDocRemarks$1, { children: `The command will attempt to help to the specified version. The version should be a valid semantic version string, or \`latest\` to help to the latest version.` }), createComponent(TSDocDefaultValue, {
+										get type() {
+											return ReflectionKind.string;
+										},
+										defaultValue: "latest"
+									})];
+								}
+							}),
+							createComponent(InterfaceMember, {
+								name: "version",
+								optional: true,
+								type: "string"
+							})
+						];
+					}
+				}),
+				createComponent(Spacing, {}),
+				createComponent(TSDoc$1, { heading: "Handler logic for the \\`help\\` command." }),
+				createComponent(FunctionDeclaration, {
+					"export": true,
+					"default": true,
+					async: true,
+					name: "handler",
+					parameters: [{
+						name: "options",
+						type: "HelpOptions"
+					}],
+					children: code` return;`
+				})
+			];
+		}
+	});
+}
+
+//#endregion
+export { HelpCommand };
+//# sourceMappingURL=help-command.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"help-command.mjs","names":[],"sources":["../../src/components/help-command.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code } from \"@alloy-js/core\";\nimport {\n  FunctionDeclaration,\n  InterfaceDeclaration\n} from \"@alloy-js/typescript\";\nimport { ReflectionKind } from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n  InterfaceMember,\n  TypescriptFile\n} from \"@powerlines/plugin-alloy/typescript\";\nimport {\n  TSDoc,\n  TSDocDefaultValue,\n  TSDocRemarks\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { joinPaths } from \"@stryke/path\";\nimport type { HelpPluginContext } from \"../types/plugin\";\n\n/**\n * The Help command's handler wrapper for the Shell Shock project.\n */\nexport function HelpCommand() {\n  const context = usePowerlines<HelpPluginContext>();\n\n  return (\n    <TypescriptFile\n      path={joinPaths(context.entryPath, \"help\", \"command.ts\")}\n      imports={{\n        \"node:os\": [\"os\"],\n        \"node:fs/promises\": [\"readFile\", \"writeFile\"]\n      }}\n      builtinImports={{\n        console: [\"colors\", \"writeLine\", \"success\", \"warn\", \"stripAnsi\"]\n      }}>\n      <TSDoc heading=\"Options for the Help command.\" />\n      <InterfaceDeclaration export name=\"HelpOptions\">\n        <TSDoc heading=\"Whether to help to the latest version.\">\n          <TSDocRemarks>{`If set to \\`true\\`, the command will attempt to help to the latest version. This option takes precedence over the \\`version\\` option.`}</TSDocRemarks>\n          <TSDocDefaultValue\n            type={ReflectionKind.boolean}\n            defaultValue={false}\n          />\n        </TSDoc>\n        <InterfaceMember name=\"latest\" optional type=\"boolean\" />\n        <Spacing />\n        <TSDoc heading=\"A specific application version to help to.\">\n          <TSDocRemarks>{`The command will attempt to help to the specified version. The version should be a valid semantic version string, or \\`latest\\` to help to the latest version.`}</TSDocRemarks>\n          <TSDocDefaultValue\n            type={ReflectionKind.string}\n            defaultValue=\"latest\"\n          />\n        </TSDoc>\n        <InterfaceMember name=\"version\" optional type=\"string\" />\n      </InterfaceDeclaration>\n      <Spacing />\n      <TSDoc heading=\"Handler logic for the \\`help\\` command.\"></TSDoc>\n      <FunctionDeclaration\n        export\n        default\n        async\n        name=\"handler\"\n        parameters={[{ name: \"options\", type: \"HelpOptions\" }]}>\n        {code` return;`}\n      </FunctionDeclaration>\n    </TypescriptFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;AAgCA,SAAE,cAAiB;CACjB,MAAA,UAAA,eAAA;AACA,QAAO,gBAAkB,gBAAgB;EAC3C,IAAQ,OAAC;AACH,UAAO,UAAC,QAAiB,WAAW,QAAO,aAAO;;EAEtD,SAAA;GACI,WAAM,CAAA,KAAU;GACpB,oBAAA,CAAA,YAAA,YAAA;GACF;EACE,gBAAgB;;;;;;KAEhB;EACE,IAAC,WAAA;AACC,UAAM;IAAA,gBAAkB,SAAS,EACjC,SAAS,iCACR,CAAC;IAAC,gBAAgB,sBAAA;KACjB,UAAS;KACV,MAAA;KACD,IAAA,WAAgB;AACd,aAAS;OAAC,gBAAW,SAAa;QAClC,SAAA;QACI,IAAC,WAAS;AACf,gBAAA,CAAA,gBAAiC,gBAAa,EACtC,UAAS,yIACb,CAAA,EAAA,gBAAyB,mBAAc;UACvC,IAAA,OAAA;AACO,kBAAA,eAAsB;;UAE7B,cAAA;UACI,CAAA,CAAA;;QAEN,CAAA;OAAA,gBAAS,iBAAA;QACT,MAAM;QACJ,UAAA;QACA,MAAA;QACA,CAAC;OAAA,gBAAoB,SAAO,EAAA,CAAA;OAAA,gBAAA,SAAA;QAC3B,SAAA;QACD,IAAA,WAAA;AACD,gBAAK,CAAA,gBAAA,gBAAA,EACN,UAAgB,kKACjB,CAAA,EAAA,gBAAoB,mBAAA;UACZ,IAAA,OAAA;AACH,kBAAS,eAAkB;;UAEhC,cAAA;UACA,CAAA,CAAA;;QAEA,CAAI;OAAE,gBAAO,iBAAA;QACb,MAAU;QACT,UAAa;QACd,MAAA;QACF,CAAA;OAAA;;KAEN,CAAA;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,SAAA"}

package/dist/components/index.cjs

@@ -0,0 +1,14 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_components_display = require('./display.cjs');
+const require_components_help_builtin = require('./help-builtin.cjs');
+const require_components_help_command = require('./help-command.cjs');
+
+exports.BaseHelpDisplay = require_components_display.BaseHelpDisplay;
+exports.CommandHelpDisplay = require_components_display.CommandHelpDisplay;
+exports.HelpBuiltin = require_components_help_builtin.HelpBuiltin;
+exports.HelpCommand = require_components_help_command.HelpCommand;
+exports.HelpCommandsDisplay = require_components_display.HelpCommandsDisplay;
+exports.HelpFunctionDeclaration = require_components_help_builtin.HelpFunctionDeclaration;
+exports.HelpOptionsDisplay = require_components_display.HelpOptionsDisplay;
+exports.HelpUsageDisplay = require_components_display.HelpUsageDisplay;
+exports.VirtualCommandHelpDisplay = require_components_display.VirtualCommandHelpDisplay;

package/dist/components/index.d.cts

@@ -0,0 +1,4 @@
+import { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps } from "./display.cjs";
+import { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration } from "./help-builtin.cjs";
+import { HelpCommand } from "./help-command.cjs";
+export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpBuiltin, HelpBuiltinProps, HelpCommand, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpFunctionDeclaration, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };

package/dist/components/index.d.mts

@@ -0,0 +1,4 @@
+import { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps } from "./display.mjs";
+import { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration } from "./help-builtin.mjs";
+import { HelpCommand } from "./help-command.mjs";
+export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpBuiltin, HelpBuiltinProps, HelpCommand, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpFunctionDeclaration, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };

package/dist/components/index.mjs

@@ -0,0 +1,5 @@
+import { BaseHelpDisplay, CommandHelpDisplay, HelpCommandsDisplay, HelpOptionsDisplay, HelpUsageDisplay, VirtualCommandHelpDisplay } from "./display.mjs";
+import { HelpBuiltin, HelpFunctionDeclaration } from "./help-builtin.mjs";
+import { HelpCommand } from "./help-command.mjs";
+
+export { BaseHelpDisplay, CommandHelpDisplay, HelpBuiltin, HelpCommand, HelpCommandsDisplay, HelpFunctionDeclaration, HelpOptionsDisplay, HelpUsageDisplay, VirtualCommandHelpDisplay };

package/dist/index.cjs

@@ -0,0 +1,105 @@
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
+const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
+const require_is_set_string = require('./node_modules/.pnpm/@stryke_type-checks@0.5.39/node_modules/@stryke/type-checks/dist/is-set-string.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_path_join = require("@stryke/path/join");
+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 : require_is_set_string.isSetString(options.command) ? options.command : "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)) 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: this.config.help.command,
+						path: this.config.help.command,
+						segments: [this.config.help.command],
+						title: "Help",
+						description: `A command for displaying help information to assist in using the ${(0, _shell_shock_core_plugin_utils.getAppTitle)(this, true)} command-line interface application.`,
+						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
+					});
+					await (0, _powerlines_plugin_alloy_render.render)(this, (0, _alloy_js_core_jsx_runtime.createComponent)(require_components_help_command.HelpCommand, {}));
+				}
+			},
+			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 bin = (0, _alloy_js_core.computed)(() => ({
+						id: "",
+						name: (0, _shell_shock_core_plugin_utils.getAppName)(this),
+						title: (0, _shell_shock_core_plugin_utils.getAppTitle)(this),
+						description: (0, _shell_shock_core_plugin_utils.getAppDescription)(this),
+						isVirtual: true,
+						path: null,
+						segments: [],
+						alias: [],
+						options: Object.fromEntries(this.options.map((option) => [option.name, option])),
+						entry: { file: (0, _stryke_path_join.joinPaths)(this.entryPath, "bin.ts") },
+						args: [],
+						parent: null,
+						children: this.commands
+					}));
+					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 bin.value;
+								} }),
+								(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 })
+								})
+							];
+						}
+					})]);
+				}
+			}
+		}
+	];
+};
+
+//#endregion
+exports.default = plugin;
+exports.plugin = plugin;

package/dist/index.d.cts

@@ -0,0 +1,11 @@
+import { HelpPluginContext, HelpPluginOptions, HelpPluginResolvedConfig, HelpPluginUserConfig } from "./types/plugin.cjs";
+import { Plugin } from "powerlines";
+
+//#region src/index.d.ts
+/**
+ * The Help - Shell Shock plugin to add a help command to the application.
+ */
+declare const plugin: <TContext extends HelpPluginContext = HelpPluginContext>(options?: HelpPluginOptions) => Plugin<TContext>[];
+//#endregion
+export { HelpPluginContext, HelpPluginOptions, HelpPluginResolvedConfig, HelpPluginUserConfig, plugin as default, plugin };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;AAyCA;;cAAa,MAAA,oBAA2B,iBAAA,GAAoB,iBAAA,EAC1D,OAAA,GAAS,iBAAA,KAgHJ,MAAA,CAAO,QAAA"}

package/dist/index.d.mts

@@ -0,0 +1,11 @@
+import { HelpPluginContext, HelpPluginOptions, HelpPluginResolvedConfig, HelpPluginUserConfig } from "./types/plugin.mjs";
+import { Plugin } from "powerlines";
+
+//#region src/index.d.ts
+/**
+ * The Help - Shell Shock plugin to add a help command to the application.
+ */
+declare const plugin: <TContext extends HelpPluginContext = HelpPluginContext>(options?: HelpPluginOptions) => Plugin<TContext>[];
+//#endregion
+export { HelpPluginContext, HelpPluginOptions, HelpPluginResolvedConfig, HelpPluginUserConfig, plugin as default, plugin };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;AAyCA;cAAa,MAAA,oBAA2B,iBAAA,GAAoB,iBAAA,EAC1D,OAAA,GAAS,iBAAA,KAgHJ,MAAA,CAAO,QAAA"}

package/dist/index.mjs

@@ -0,0 +1,100 @@
+import { isSetString } from "./node_modules/.pnpm/@stryke_type-checks@0.5.39/node_modules/@stryke/type-checks/dist/is-set-string.mjs";
+import { HelpBuiltin } from "./components/help-builtin.mjs";
+import { HelpCommand } 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 { getAppDescription, getAppName, getAppTitle, getCommandList } from "@shell-shock/core/plugin-utils";
+import console from "@shell-shock/plugin-console";
+import theme from "@shell-shock/plugin-theme";
+import { joinPaths } from "@stryke/path/join";
+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) ? options.command : "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)) 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: this.config.help.command,
+						path: this.config.help.command,
+						segments: [this.config.help.command],
+						title: "Help",
+						description: `A command for displaying help information to assist in using the ${getAppTitle(this, true)} command-line interface application.`,
+						entry: {
+							file: joinPaths(this.entryPath, "help", "index.ts"),
+							input: { file: joinPaths(this.entryPath, "help", "command.ts") }
+						},
+						isVirtual: false
+					});
+					await render(this, createComponent(HelpCommand, {}));
+				}
+			},
+			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 bin = computed(() => ({
+						id: "",
+						name: getAppName(this),
+						title: getAppTitle(this),
+						description: getAppDescription(this),
+						isVirtual: true,
+						path: null,
+						segments: [],
+						alias: [],
+						options: Object.fromEntries(this.options.map((option) => [option.name, option])),
+						entry: { file: joinPaths(this.entryPath, "bin.ts") },
+						args: [],
+						parent: null,
+						children: this.commands
+					}));
+					return render(this, [createComponent(Show, {
+						get when() {
+							return _self$.config.help.builtins !== false;
+						},
+						get children() {
+							return [
+								createComponent(HelpBuiltin, { get command() {
+									return bin.value;
+								} }),
+								createComponent(Spacing, {}),
+								createComponent(For, {
+									get each() {
+										return commands.sort((a, b) => a.name.localeCompare(b.name));
+									},
+									doubleHardline: true,
+									children: (command) => createComponent(HelpBuiltin, { command })
+								})
+							];
+						}
+					})]);
+				}
+			}
+		}
+	];
+};
+
+//#endregion
+export { plugin as default, plugin };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +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  getAppDescription,\n  getAppName,\n  getAppTitle,\n  getCommandList\n} from \"@shell-shock/core/plugin-utils\";\nimport console from \"@shell-shock/plugin-console\";\nimport theme from \"@shell-shock/plugin-theme\";\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 } 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) => {\n  return [\n    ...theme(options.theme),\n    console(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                    ? options.command\n                    : \"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(input => input.name === this.config.help.command)\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,\n              name: this.config.help.command,\n              path: this.config.help.command,\n              segments: [this.config.help.command],\n              title: \"Help\",\n              description: `A command for displaying help information to assist in using the ${getAppTitle(\n                this,\n                true\n              )} command-line interface application.`,\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            });\n          }\n\n          await render(this, <HelpCommand />);\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 bin = computed(() => ({\n            id: \"\",\n            name: getAppName(this),\n            title: getAppTitle(this),\n            description: getAppDescription(this),\n            isVirtual: true,\n            path: null,\n            segments: [],\n            alias: [],\n            options: Object.fromEntries(\n              this.options.map(option => [option.name, option])\n            ),\n            entry: {\n              file: joinPaths(this.entryPath, \"bin.ts\")\n            },\n            args: [],\n            parent: null,\n            children: this.commands\n          }));\n\n          return render(\n            this,\n            <>\n              <Show when={this.config.help.builtins !== false}>\n                <HelpBuiltin command={bin.value} />\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              </Show>\n            </>\n          );\n        }\n      }\n    }\n  ] as Plugin<TContext>[];\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;AAoCA,MAAa,UAAe,UAAA,EAAA,KAAA;;;;;GAE1B,MAAA;GACC,SAAU;GACX,SAAA;AACI,SAAC,MAAM,qEAAiE;AAC5E,WAAS,EACN,MAAA,KAAA,EACI,SAAA,QAAA,YAAA,QAAA,QAAA,YAAA,QAAA,QAAA,GAAA,QAAA,UAAA,QACF,EAAA,SAAa,EAChB,UAAgB,MAChB,CAAA,EACE;;GAEF,MAAE,iBAAS;AACT,SAAE,MAAK,sDAAK;AACZ,QAAI,KAAC,OAAU,KAAA,YAAQ,OAAiB;AACtC,UAAC,WAAA,EAAA;8EAED,MAAO,KAAA,2LAAA;SAEL,MAAE,OAAA,KAAA;MACA,IAAE,KAAO,OAAA,KAAA;MACT,MAAI,KAAO,OAAC,KAAW;MACvB,MAAM,KAAE,OAAA,KAAA;MACR,UAAQ,CAAA,KAAA,OAAY,KAAQ,QAAO;MACnC,OAAO;MACP,aAAW,oEAAI,YAAA,MAAA,KAAA,CAAA;MACf,OAAC;OACD,MAAO,UAAA,KAAA,WAAA,QAAA,WAAA;OACP,OAAA,EACE,MAAQ,UAAE,KAAA,WAAA,QAAA,aAAA,EACZ;OACF;MACD,WAAA;MACF,CAAA;AAEC,WAAK,OAAO,MAAO,gBAAiB,aAAO,EAAA,CAAA,CAAW;;;GAG1D,SAAM;IACJ,OAAO;IACP,MAAM,UAAK;KACT,MAAI,SAAA;KACJ,MAAI,WAAS,MAAA,eAAA,KAAA;AACb,UAAK,MAAM,gDAA8C,SAAS,OAAS,mBAAe;KAC1F,MAAK,MAAA,gBAAA;MACH,IAAE;MACF,MAAM,WAAQ,KAAK;MACnB,OAAO,YAAY,KAAK;MACxB,aAAU,kBAAiB,KAAO;MAClC,WAAU;MACV,MAAI;MACJ,UAAU,EAAE;MACZ,OAAI,EAAA;MACJ,SAAM,OAAI,YAAA,KAAA,QAAA,KAAA,WAAA,CAAA,OAAA,MAAA,OAAA,CAAA,CAAA;MACV,OAAM,EACJ,MAAK,UAAQ,KAAK,WAAU,SAAa,EAC1C;MACD,MAAM,EAAA;MACN,QAAM;MACN,UAAQ,KAAM;MACf,EAAE;AACH,YAAO,OAAA,MAAA,CAAA,gBAAA,MAAA;MACL,IAAI,OAAA;AACF,cAAE,OAAA,OAAA,KAAA,aAAA;;;AAGJ,cAAM;QAAA,gBAAc,aAAe,EACrC,IAAA,UAAA;AACD,gBAAA,IAAA;WAEM,CAAC;QAAE,gBAAK,SAAA,EAAA,CAAA;QAAA,gBAAA,KAAA;SACP,IAAA,OAAU;AACR,iBAAA,SAAgB,MAAC,GAAA,MAAc,EAAC,KAAK,cAAA,EAAA,KAAA,CAAA;;SAExC,gBAAiB;SAChB,WAAS,YAAA,gBAAA,aAAA,EACD,SACX,CAAA;;;;MAGF,CAAC,CAAC,CAAC;;IAEP;GACF;EAAC"}

package/dist/node_modules/.pnpm/@stryke_string-format@0.17.4/node_modules/@stryke/string-format/dist/constant-case.cjs

@@ -0,0 +1,17 @@
+
+//#region ../../node_modules/.pnpm/@stryke+string-format@0.17.4/node_modules/@stryke/string-format/dist/constant-case.mjs
+/**
+* Check if the input string is in constant case.
+*
+* @remarks
+* Constant case is defined as all uppercase letters with underscores separating words - "THIS_IS_AN_EXAMPLE".
+*
+* @param input - The input string to check.
+* @returns True if the input is in constant case, false otherwise.
+*/
+function isConstantCase(input) {
+	return input ? /^[A-Z0-9_]+$/.test(input) : false;
+}
+
+//#endregion
+exports.isConstantCase = isConstantCase;

package/dist/node_modules/.pnpm/@stryke_string-format@0.17.4/node_modules/@stryke/string-format/dist/constant-case.mjs

@@ -0,0 +1,17 @@
+//#region ../../node_modules/.pnpm/@stryke+string-format@0.17.4/node_modules/@stryke/string-format/dist/constant-case.mjs
+/**
+* Check if the input string is in constant case.
+*
+* @remarks
+* Constant case is defined as all uppercase letters with underscores separating words - "THIS_IS_AN_EXAMPLE".
+*
+* @param input - The input string to check.
+* @returns True if the input is in constant case, false otherwise.
+*/
+function isConstantCase(input) {
+	return input ? /^[A-Z0-9_]+$/.test(input) : false;
+}
+
+//#endregion
+export { isConstantCase };
+//# sourceMappingURL=constant-case.mjs.map

package/dist/node_modules/.pnpm/@stryke_string-format@0.17.4/node_modules/@stryke/string-format/dist/constant-case.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constant-case.mjs","names":[],"sources":["../../../../../../../../../../node_modules/.pnpm/@stryke+string-format@0.17.4/node_modules/@stryke/string-format/dist/constant-case.mjs"],"sourcesContent":["import { getWords } from \"./get-words.mjs\";\nimport { isSnakeCase } from \"./snake-case.mjs\";\n\n//#region src/constant-case.ts\n/**\n* Check if the input string is in constant case.\n*\n* @remarks\n* Constant case is defined as all uppercase letters with underscores separating words - \"THIS_IS_AN_EXAMPLE\".\n*\n* @param input - The input string to check.\n* @returns True if the input is in constant case, false otherwise.\n*/\nfunction isConstantCase(input) {\n\treturn input ? /^[A-Z0-9_]+$/.test(input) : false;\n}\n/**\n* Convert the input string to constant case.\n*\n* @remarks\n* Constant case is defined as all uppercase letters with underscores separating words - \"THIS_IS_AN_EXAMPLE\".\n*\n* @param input - The input string.\n* @returns The constant-cased string.\n*/\nfunction constantCase(input) {\n\treturn isConstantCase(input) || input === void 0 ? input : isSnakeCase(input) ? input.toUpperCase() : getWords(input).join(\"_\").toUpperCase();\n}\n\n//#endregion\nexport { constantCase, isConstantCase };\n//# sourceMappingURL=constant-case.mjs.map"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;AAaA,SAAS,eAAe,OAAO;AAC9B,QAAO,QAAQ,eAAe,KAAK,MAAM,GAAG"}

package/dist/node_modules/.pnpm/@stryke_string-format@0.17.4/node_modules/@stryke/string-format/dist/get-words.cjs

@@ -0,0 +1,38 @@
+
+//#region ../../node_modules/.pnpm/@stryke+string-format@0.17.4/node_modules/@stryke/string-format/dist/get-words.mjs
+/**
+* Regular expression pattern to split strings into words for various case conversions
+*
+* This pattern matches sequences of characters in a string, considering the following case:
+* - Sequences of two or more uppercase letters followed by an uppercase letter and lowercase letters or digits (for acronyms)
+* - Sequences of one uppercase letter optionally followed by lowercase letters and digits
+* - Single uppercase letters
+* - Sequences of digits
+*
+* The resulting match can be used to convert camelCase, snake_case, kebab-case, and other mixed formats into
+* a consistent format like snake case.
+*
+* @example
+* const matches = 'camelCaseHTTPRequest'.match(CASE_SPLIT_PATTERN);
+* // matches: ['camel', 'Case', 'HTTP', 'Request']
+*/
+const CASE_SPLIT_PATTERN = /[A-Z]?[a-z]+|\d+|[A-Z]+(?![a-z])/g;
+const RELAXED_SPLIT_PATTERN = /[A-Z/.-]?[a-z/.-]+|\d+|[A-Z/.-]+(?![a-z/.-])/g;
+/**
+* Splits a string into words using a regular expression pattern
+*
+* @example
+* const words = getWords('camelCaseHTTPRequest');
+* // words: ['camel', 'Case', 'HTTP', 'Request']
+*
+* @param str - The string to split into words
+* @param options - Options for splitting the string
+* @returns An array of words
+*/
+function getWords(str, options = {}) {
+	if (str.length > 5e3) throw new Error("The regular expression parameter of `get-words` can't handle strings longer than 2000 characters");
+	return [...str.match(options.split ?? (options.relaxed ? RELAXED_SPLIT_PATTERN : CASE_SPLIT_PATTERN)) ?? []];
+}
+
+//#endregion
+exports.getWords = getWords;