@shell-shock/plugin-help 0.2.26 → 0.2.29

package/dist/index.mjs

@@ -1,2 +1,92 @@
-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};
+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") }
+						},
+						virtual: false,
+						...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 commands() {
+									return segments.value;
+								} })
+							];
+						}
+					})]);
+				}
+			}
+		}
+	];
+};
+
+//#endregion
+export { plugin as default, 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: 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"}
+{"version":3,"file":"index.mjs","names":[],"sources":[],"mappings":""}

package/dist/types/index.mjs

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

package/dist/types/plugin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"mappings":";;;;;;;UAsCiB,iBAAA;;AAAjB;;;;EAME,QAAA;EAeQ;;;;;;;;EALR,OAAA,GAAU,OAAA,CAAQ,aAAA;EAKV;;;EAAR,KAAA,GAAQ,kBAAA;EAKsB;AAGhC;;EAHE,OAAA,GAAU,oBAAA;AAAA;AAAA,KAGA,oBAAA,GAAuB,qBAAA,GACjC,uBAAA,GACA,UAAA;EAAA;;;EAIE,IAAA,EAAM,IAAA,CAAK,iBAAA;IAMA;;;;;IAAT,OAAA,EAAS,OAAA,CAAQ,aAAA;EAAA;AAAA;AAAA,KAIX,wBAAA,GAA2B,yBAAA,GACrC,2BAAA,GACA,cAAA;EANI;;;EAUF,IAAA,EAAM,QAAA,CAAS,IAAA,CAAK,iBAAA;IAVY;AAIpC;;;;IAYM,OAAA,EAAS,YAAA,CAAa,OAAA,CAAQ,aAAA;EAAA;AAAA;AAAA,KAIxB,iBAAA,yBACc,wBAAA,GAA2B,wBAAA,IACjD,kBAAA,CAAmB,eAAA,IACrB,oBAAA,CAAqB,eAAA,IACrB,OAAA,CAAQ,eAAA"}
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"mappings":""}

package/dist/types/plugin.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/plugin-help",
-  "version": "0.2.26",
+  "version": "0.2.29",
   "private": false,
   "description": "A package containing a Shell Shock plugin to provide help and documentation for the local application's commands.",
   "keywords": [
@@ -151,26 +151,26 @@
   "typings": "dist/index.d.mts",
   "files": ["dist/**/*"],
   "dependencies": {
-    "@alloy-js/core": "0.23.0-dev.8",
-    "@alloy-js/typescript": "0.23.0-dev.4",
-    "@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",
+    "@alloy-js/core": "^0.23.1",
+    "@alloy-js/typescript": "^0.23.0",
+    "@powerlines/deepkit": "^0.9.78",
+    "@powerlines/plugin-alloy": "^0.26.217",
+    "@powerlines/plugin-plugin": "^0.12.536",
+    "@shell-shock/core": "0.17.11",
+    "@shell-shock/plugin-console": "0.2.15",
+    "@shell-shock/plugin-theme": "0.4.24",
+    "@stryke/helpers": "^0.10.24",
+    "@stryke/path": "^0.29.11",
+    "@stryke/string-format": "^0.17.26",
+    "@stryke/type-checks": "^0.6.17",
+    "@stryke/types": "^0.12.12",
     "defu": "^6.1.7",
-    "powerlines": "^0.44.12"
+    "powerlines": "^0.47.124"
   },
   "devDependencies": {
-    "@powerlines/plugin-deepkit": "^0.11.330",
-    "@types/node": "^25.6.0"
+    "@powerlines/plugin-deepkit": "^0.11.467",
+    "@types/node": "^25.9.1"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "832c19e668deb4d29b5e0219a7708d111790f607"
+  "gitHead": "9401c1de122d800040306fc89ad1835930c1a826"
 }