@shell-shock/plugin-help 0.2.21 → 0.2.22

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.
@@ -15,32 +15,6 @@ let _stryke_path = require("@stryke/path");
15
15
 
16
16
  //#region src/components/help-builtin.tsx
17
17
  /**
18
- * The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.
19
- */
20
- function HelpFunctionDeclaration() {
21
- return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TSDoc, {
22
- heading: "A helper function that updates the version check file.",
23
- get children() {
24
- return [
25
- (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TSDocRemarks, { children: `This function is used to update the version check file with the current timestamp. It can be used in the CLI upgrade command to record the last time a check for updates was performed. The function writes a "version-check.json" file in the data directory, which contains a timestamp of the last check for updates.` }),
26
- (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
27
- (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TSDocReturns, { children: `A promise that resolves to a boolean indicating whether a check for updates is required.` })
28
- ];
29
- }
30
- }), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
31
- "export": true,
32
- async: true,
33
- name: "updateVersionCheckFile",
34
- returnType: "void",
35
- get children() {
36
- return [(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.IfStatement, {
37
- condition: _alloy_js_core.code`!existsSync(paths.data)`,
38
- children: _alloy_js_core.code`await mkdir(paths.data, { recursive: true }); `
39
- }), _alloy_js_core.code`await writeFile(join(paths.data, "version-check.json"), JSON.stringify({ timestamp: new Date().getTime() }), "utf8"); `];
40
- }
41
- })];
42
- }
43
- /**
44
18
  * A built-in help module for Shell Shock.
45
19
  */
46
20
  function HelpBuiltin(props) {
@@ -72,13 +46,22 @@ function HelpBuiltin(props) {
72
46
  },
73
47
  get children() {
74
48
  return [
49
+ (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TSDoc, {
50
+ get heading() {
51
+ return `Utility functions for displaying help information for the ${command.path ? `${command.title} command` : `${(0, _shell_shock_core_plugin_utils.getAppTitle)(context, true)} application`}.`;
52
+ },
53
+ get children() {
54
+ return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_typescript.TSDocRemarks, { get children() {
55
+ return `This module contains utility functions that assist in displaying help information for the ${command.path ? `${command.title} command` : `${(0, _shell_shock_core_plugin_utils.getAppTitle)(context, true)} application`}. The main function exported by this module is the \`showHelp\` function, which can be used to display help information for the specified command or application. This function can be called from within the command's handler or from any other part of the application where help information needs to be displayed.`;
56
+ } });
57
+ }
58
+ }),
75
59
  (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_typescript.FunctionDeclaration, {
76
60
  "export": true,
77
61
  name: "showHelp",
78
62
  get doc() {
79
63
  return `Display help information for the ${command.path ? `${command.title} command` : `${(0, _shell_shock_core_plugin_utils.getAppTitle)(context, true)} application`}.`;
80
64
  },
81
- parameters: [],
82
65
  get children() {
83
66
  return (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
84
67
  get when() {
@@ -113,5 +96,4 @@ function HelpBuiltin(props) {
113
96
  }
114
97
 
115
98
  //#endregion
116
- exports.HelpBuiltin = HelpBuiltin;
117
- exports.HelpFunctionDeclaration = HelpFunctionDeclaration;
99
+ exports.HelpBuiltin = HelpBuiltin;
@@ -3,10 +3,6 @@ import { CommandTree } from "@shell-shock/core";
3
3
  import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
4
4
 
5
5
  //#region src/components/help-builtin.d.ts
6
- /**
7
- * The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.
8
- */
9
- declare function HelpFunctionDeclaration(): _$_alloy_js_core0.Children;
10
6
  interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description"> {
11
7
  /**
12
8
  * The command to generate the `help` function declaration for.
@@ -18,5 +14,5 @@ interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description">
18
14
  */
19
15
  declare function HelpBuiltin(props: HelpBuiltinProps): _$_alloy_js_core0.Children;
20
16
  //#endregion
21
- export { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration };
17
+ export { HelpBuiltin, HelpBuiltinProps };
22
18
  //# sourceMappingURL=help-builtin.d.cts.map
@@ -1 +1 @@
1
- {"version":3,"file":"help-builtin.d.cts","names":[],"sources":["../../src/components/help-builtin.tsx"],"mappings":";;;;;;;;iBA0CgB,uBAAA,CAAA,GAAuB,iBAAA,CAAA,QAAA;AAAA,UA0BtB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;;;EAMA,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}
1
+ {"version":3,"file":"help-builtin.d.cts","names":[],"sources":["../../src/components/help-builtin.tsx"],"mappings":";;;;;UAmCiB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;;AADF;EAOE,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}
@@ -3,10 +3,6 @@ import { CommandTree } from "@shell-shock/core";
3
3
  import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
4
4
 
5
5
  //#region src/components/help-builtin.d.ts
6
- /**
7
- * The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.
8
- */
9
- declare function HelpFunctionDeclaration(): _$_alloy_js_core0.Children;
10
6
  interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description"> {
11
7
  /**
12
8
  * The command to generate the `help` function declaration for.
@@ -18,5 +14,5 @@ interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description">
18
14
  */
19
15
  declare function HelpBuiltin(props: HelpBuiltinProps): _$_alloy_js_core0.Children;
20
16
  //#endregion
21
- export { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration };
17
+ export { HelpBuiltin, HelpBuiltinProps };
22
18
  //# sourceMappingURL=help-builtin.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"help-builtin.d.mts","names":[],"sources":["../../src/components/help-builtin.tsx"],"mappings":";;;;;;;;iBA0CgB,uBAAA,CAAA,GAAuB,iBAAA,CAAA,QAAA;AAAA,UA0BtB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;;;EAMA,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}
1
+ {"version":3,"file":"help-builtin.d.mts","names":[],"sources":["../../src/components/help-builtin.tsx"],"mappings":";;;;;UAmCiB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;;AADF;EAOE,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}
@@ -1,43 +1,17 @@
1
1
  import { CommandHelpDisplay, VirtualCommandHelpDisplay } from "./display.mjs";
2
2
  import { createComponent, memo, mergeProps } from "@alloy-js/core/jsx-runtime";
3
- import { Show, code, splitProps } from "@alloy-js/core";
3
+ import { Show, splitProps } from "@alloy-js/core";
4
4
  import { getAppTitle, isDynamicPathSegment } from "@shell-shock/core/plugin-utils";
5
5
  import defu from "defu";
6
6
  import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
7
7
  import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
8
- import { FunctionDeclaration, IfStatement } from "@alloy-js/typescript";
9
- import { TSDoc, TSDocRemarks, TSDocReturns } from "@powerlines/plugin-alloy/typescript";
8
+ import { FunctionDeclaration } from "@alloy-js/typescript";
9
+ import { TSDoc, TSDocRemarks } from "@powerlines/plugin-alloy/typescript";
10
10
  import { BuiltinFile } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
11
11
  import { joinPaths } from "@stryke/path";
12
12
 
13
13
  //#region src/components/help-builtin.tsx
14
14
  /**
15
- * The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.
16
- */
17
- function HelpFunctionDeclaration() {
18
- return [createComponent(TSDoc, {
19
- heading: "A helper function that updates the version check file.",
20
- get children() {
21
- return [
22
- createComponent(TSDocRemarks, { children: `This function is used to update the version check file with the current timestamp. It can be used in the CLI upgrade command to record the last time a check for updates was performed. The function writes a "version-check.json" file in the data directory, which contains a timestamp of the last check for updates.` }),
23
- createComponent(Spacing, {}),
24
- createComponent(TSDocReturns, { children: `A promise that resolves to a boolean indicating whether a check for updates is required.` })
25
- ];
26
- }
27
- }), createComponent(FunctionDeclaration, {
28
- "export": true,
29
- async: true,
30
- name: "updateVersionCheckFile",
31
- returnType: "void",
32
- get children() {
33
- return [createComponent(IfStatement, {
34
- condition: code`!existsSync(paths.data)`,
35
- children: code`await mkdir(paths.data, { recursive: true }); `
36
- }), code`await writeFile(join(paths.data, "version-check.json"), JSON.stringify({ timestamp: new Date().getTime() }), "utf8"); `];
37
- }
38
- })];
39
- }
40
- /**
41
15
  * A built-in help module for Shell Shock.
42
16
  */
43
17
  function HelpBuiltin(props) {
@@ -69,13 +43,22 @@ function HelpBuiltin(props) {
69
43
  },
70
44
  get children() {
71
45
  return [
46
+ createComponent(TSDoc, {
47
+ get heading() {
48
+ return `Utility functions for displaying help information for the ${command.path ? `${command.title} command` : `${getAppTitle(context, true)} application`}.`;
49
+ },
50
+ get children() {
51
+ return createComponent(TSDocRemarks, { get children() {
52
+ return `This module contains utility functions that assist in displaying help information for the ${command.path ? `${command.title} command` : `${getAppTitle(context, true)} application`}. The main function exported by this module is the \`showHelp\` function, which can be used to display help information for the specified command or application. This function can be called from within the command's handler or from any other part of the application where help information needs to be displayed.`;
53
+ } });
54
+ }
55
+ }),
72
56
  createComponent(FunctionDeclaration, {
73
57
  "export": true,
74
58
  name: "showHelp",
75
59
  get doc() {
76
60
  return `Display help information for the ${command.path ? `${command.title} command` : `${getAppTitle(context, true)} application`}.`;
77
61
  },
78
- parameters: [],
79
62
  get children() {
80
63
  return createComponent(Show, {
81
64
  get when() {
@@ -110,5 +93,5 @@ function HelpBuiltin(props) {
110
93
  }
111
94
 
112
95
  //#endregion
113
- export { HelpBuiltin, HelpFunctionDeclaration };
96
+ export { HelpBuiltin };
114
97
  //# sourceMappingURL=help-builtin.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"help-builtin.mjs","names":[],"sources":["../../src/components/help-builtin.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, Show, splitProps } from \"@alloy-js/core\";\nimport { FunctionDeclaration, IfStatement } from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n TSDoc,\n TSDocRemarks,\n TSDocReturns\n} from \"@powerlines/plugin-alloy/typescript\";\nimport type { BuiltinFileProps } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport { BuiltinFile } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport type { CommandTree } from \"@shell-shock/core\";\nimport {\n getAppTitle,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport defu from \"defu\";\nimport type { HelpPluginContext } from \"../types\";\nimport { CommandHelpDisplay, VirtualCommandHelpDisplay } from \"./display\";\n\n/**\n * The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.\n */\nexport function HelpFunctionDeclaration() {\n return (\n <>\n <TSDoc heading=\"A helper function that updates the version check file.\">\n <TSDocRemarks>\n {`This function is used to update the version check file with the current timestamp. It can be used in the CLI upgrade command to record the last time a check for updates was performed. The function writes a \"version-check.json\" file in the data directory, which contains a timestamp of the last check for updates.`}\n </TSDocRemarks>\n <Spacing />\n <TSDocReturns>\n {`A promise that resolves to a boolean indicating whether a check for updates is required.`}\n </TSDocReturns>\n </TSDoc>\n <FunctionDeclaration\n export\n async\n name=\"updateVersionCheckFile\"\n returnType=\"void\">\n <IfStatement condition={code`!existsSync(paths.data)`}>\n {code`await mkdir(paths.data, { recursive: true }); `}\n </IfStatement>\n {code`await writeFile(join(paths.data, \"version-check.json\"), JSON.stringify({ timestamp: new Date().getTime() }), \"utf8\"); `}\n </FunctionDeclaration>\n </>\n );\n}\n\nexport interface HelpBuiltinProps extends Omit<\n BuiltinFileProps,\n \"id\" | \"description\"\n> {\n /**\n * The command to generate the `help` function declaration for.\n */\n command: CommandTree;\n}\n\n/**\n * A built-in help module for Shell Shock.\n */\nexport function HelpBuiltin(props: HelpBuiltinProps) {\n const [{ command, children }, rest] = splitProps(props, [\n \"command\",\n \"children\"\n ]);\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <BuiltinFile\n id={joinPaths(\n \"help\",\n ...command.segments.filter(segment => !isDynamicPathSegment(segment))\n )}\n description={\n command.path\n ? `A collection of utility functions that assist in displaying help information for the ${\n command.title\n } command.`\n : `A collection of utility functions that assist in displaying help information for the ${getAppTitle(\n context,\n true\n )} command-line interface application.`\n }\n {...rest}\n builtinImports={defu(rest.builtinImports ?? {}, {\n utils: [\"isUnicodeSupported\"],\n console: [\n \"splitText\",\n \"writeLine\",\n \"inlineCode\",\n \"textColors\",\n \"inverse\",\n \"bold\",\n \"help\",\n \"table\",\n \"link\"\n ]\n })}>\n <FunctionDeclaration\n export\n name=\"showHelp\"\n doc={`Display help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}\n parameters={[]}>\n <Show\n when={!command.isVirtual}\n fallback={\n <VirtualCommandHelpDisplay\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n }>\n <CommandHelpDisplay command={command} />\n </Show>\n </FunctionDeclaration>\n <Spacing />\n <Show when={Boolean(children)}>{children}</Show>\n </BuiltinFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAoCA,SAAc,0BAA4B;AAC1C,QAAS,CAAA,gBAAmB,OAAC;;EAE3B,IAAA,WAAA;AACI,UAAE;IAAA,gBAAwB,cAAQ,EACtC,UAAA,4TACK,CAAA;IAAA,gBAAS,SAAA,EAAuB,CAAC;IAAE,gBAAA,cAAA,EAClC,UAAC,4FACJ,CAAA;IAAA;;EAEF,CAAC,EAAE,gBAAe,qBAAA;EACjB,UAAQ;EACR,OAAM;EACN,MAAK;EACL,YAAK;EACL,IAAI,WAAM;AACR,UAAI,CAAA,gBAAY,aAAA;IACd,WAAK,IAAA;IACN,UAAA,IAAA;IACA,CAAC,EAAA,IAAA,yHAAA;;EAEL,CAAC,CAAC;;;;;AAYL,SAAE,YAAgB,OAAA;CAChB,MAAM,CAAC,EACP,SACE,YACC,QAAI,WAAW,OAAS,CAAG,WAAQ,WAAS,CAAA;CAC/C,MAAE,UAAA,eAAA;AACF,QAAO,gBAAa,aAAA,WAAA;EACtB,IAAA,KAAA;;;EAGI,IAAC,cAAc;AACjB,UAAA,WAAA,CAAA,CAAA,QAAA,KAAA,EAAA,GAAA,wFAAA,QAAA,MAAA,aAAA,wFAAA,YAAA,SAAA,KAAA,CAAA;;EAEA,EAAA,MAAS;EACP,IAAC,iBAAQ;AACR,UAAQ,KAAA,KAAA,kBAAA,EAAA,EAAA;IACT,OAAA,CAAA,qBAAA;IACI,SAAS;KAAC;KAAa;KAAC;KAAoB;KAAA;KAAA;KAAA;KAAA;KAAA;KAAA;;;EAGhD,IAAC,WAAA;AACC,UAAI;IAAA,gBAAS,qBAAA;KACX,UAAM;KACN,MAAG;KACJ,IAAA,MAAA;AACD,aAAW,oCAAC,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;KAEV,YAAO,EAAA;KACP,IAAI,WAAU;AACZ,aAAI,gBAAQ,MAAA;OACV,IAAG,OAAA;AACD,eAAO,CAAA,QAAA;;OAET,IAAG,WAAY;AACrB,eAAA,gBAAA,2BAAA;SACQ,IAAA,UAAA;AACR,iBAAgB,OAAU,OAAA,QAAe,QAAO;;SAEtC,IAAC,WAAA;AACN,iBAAU,QAAA,YAAA,EAAA;;SAEV,CAAA;;OAEA,IAAA,WAAQ;AACR,eAAK,gBAAA,oBAAA,EACA,SACL,CAAK;;OAER,CAAA;;KAED,CAAA;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,MAAA;KACC,IAAA,OAAA;AACA,aAAM,QAAQ,SAAA;;KAEJ;KACX,CAAC;IAAC;;EAEN,CAAC,CAAC"}
1
+ {"version":3,"file":"help-builtin.mjs","names":[],"sources":["../../src/components/help-builtin.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/shell-shock.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/shell-shock\n Documentation: https://docs.stormsoftware.com/projects/shell-shock\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { Show, splitProps } from \"@alloy-js/core\";\nimport { FunctionDeclaration } from \"@alloy-js/typescript\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { TSDoc, TSDocRemarks } from \"@powerlines/plugin-alloy/typescript\";\nimport type { BuiltinFileProps } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport { BuiltinFile } from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport type { CommandTree } from \"@shell-shock/core\";\nimport {\n getAppTitle,\n isDynamicPathSegment\n} from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path\";\nimport defu from \"defu\";\nimport type { HelpPluginContext } from \"../types\";\nimport { CommandHelpDisplay, VirtualCommandHelpDisplay } from \"./display\";\n\nexport interface HelpBuiltinProps extends Omit<\n BuiltinFileProps,\n \"id\" | \"description\"\n> {\n /**\n * The command to generate the `help` function declaration for.\n */\n command: CommandTree;\n}\n\n/**\n * A built-in help module for Shell Shock.\n */\nexport function HelpBuiltin(props: HelpBuiltinProps) {\n const [{ command, children }, rest] = splitProps(props, [\n \"command\",\n \"children\"\n ]);\n const context = usePowerlines<HelpPluginContext>();\n\n return (\n <BuiltinFile\n id={joinPaths(\n \"help\",\n ...command.segments.filter(segment => !isDynamicPathSegment(segment))\n )}\n description={\n command.path\n ? `A collection of utility functions that assist in displaying help information for the ${\n command.title\n } command.`\n : `A collection of utility functions that assist in displaying help information for the ${getAppTitle(\n context,\n true\n )} command-line interface application.`\n }\n {...rest}\n builtinImports={defu(rest.builtinImports ?? {}, {\n utils: [\"isUnicodeSupported\"],\n console: [\n \"splitText\",\n \"writeLine\",\n \"inlineCode\",\n \"textColors\",\n \"inverse\",\n \"bold\",\n \"help\",\n \"table\",\n \"link\"\n ]\n })}>\n <TSDoc\n heading={`Utility functions for displaying help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}>\n <TSDocRemarks>\n {`This module contains utility functions that assist in displaying help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }. The main function exported by this module is the \\`showHelp\\` function, which can be used to display help information for the specified command or application. This function can be called from within the command's handler or from any other part of the application where help information needs to be displayed.`}\n </TSDocRemarks>\n </TSDoc>\n <FunctionDeclaration\n export\n name=\"showHelp\"\n doc={`Display help information for the ${\n command.path\n ? `${command.title} command`\n : `${getAppTitle(context, true)} application`\n }.`}>\n <Show\n when={!command.isVirtual}\n fallback={\n <VirtualCommandHelpDisplay\n options={Object.values(command.options)}\n commands={command.children ?? {}}\n />\n }>\n <CommandHelpDisplay command={command} />\n </Show>\n </FunctionDeclaration>\n <Spacing />\n <Show when={Boolean(children)}>{children}</Show>\n </BuiltinFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;AA0CA,SAAW,YAAW,OAAA;CACtB,MAAA,CAAA,WAEE,YACG,QAAQ,WAAM,OAAW,CAAA,WAAW,WAAA,CAAA;CACvC,MAAA,UAAA,eAAA;AACF,QAAO,gBAAoB,aAAQ,WAAkB;EACnD,IAAM,KAAG;AACN,UAAQ,UAAA,QAAA,GAAA,QAAA,SAAA,QAAA,YAAA,CAAA,qBAAA,QAAA,CAAA,CAAA;;EAET,IAAA,cAAA;AACF,UAAM,WAAU,CAAA,CAAA,QAAc,KAAA,EAAA,GAAA,wFAAoB,QAAA,MAAA,aAAA,wFAAA,YAAA,SAAA,KAAA,CAAA;;EAElD,EAAA,MAAO;EACL,IAAC,iBAAA;AACC,UAAI,KAAA,KAAS,kBAAA,EAAA,EAAA;IACX,OAAM,CAAA,qBAAA;IACN,SAAG;KAAO;KAAU;KAAgB;KAAG;KAAqB;KAAQ;KAAA;KAAA;KAAA;KAAA;IACrE,CAAA;;EAEH,IAAI,WAAQ;AACV,UAAO;IAAC,gBAAe,OAAQ;KAC7B,IAAI,UAAU;AACZ,aAAI,6DAAQ,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;KAEd,IAAI,WAAS;AACX,aAAI,gBAAA,cAAA,EACF,IAAG,WAAY;AACrB,cAAA,6FAAA,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;SAEA,CAAA;;KAEC,CAAC;IAAA,gBAAS,qBAAA;KACT,UAAG;KACH,MAAG;KACH,IAAG,MAAA;AACD,aAAC,oCAAW,QAAA,OAAA,GAAA,QAAA,MAAA,YAAA,GAAA,YAAA,SAAA,KAAA,CAAA,cAAA;;KAEd,IAAG,WAAK;AACN,aAAM,gBAAA,MAAA;OACL,IAAK,OAAC;AACN,eAAI,CAAA,QAAA;;OAEN,IAAA,WAAA;AACF,eAAA,gBAAA,2BAAA;SACS,IAAE,UAAQ;AACR,iBAAA,OAAA,OAAA,QAAA,QAAA;;SAEF,IAAC,WAAY;AACjB,iBAAA,QAAA,YAAA,EAAA;;SAEA,CAAI;;OAEJ,IAAI,WAAW;AACb,eAAK,gBAAoB,oBAAmB,EACpC,SACZ,CAAA;;OAEH,CAAA;;KAEA,CAAC;IAAA,gBAAc,SAAA,EAAA,CAAA;IAAA,gBAAA,MAAA;KACd,IAAI,OAAE;AACJ,aAAO,QAAC,SAAA;;KAED;KACV,CAAC;IAAC;;EAEN,CAAC,CAAC"}
@@ -8,7 +8,6 @@ exports.CommandHelpDisplay = require_components_display.CommandHelpDisplay;
8
8
  exports.HelpBuiltin = require_components_help_builtin.HelpBuiltin;
9
9
  exports.HelpCommand = require_components_help_command.HelpCommand;
10
10
  exports.HelpCommandsDisplay = require_components_display.HelpCommandsDisplay;
11
- exports.HelpFunctionDeclaration = require_components_help_builtin.HelpFunctionDeclaration;
12
11
  exports.HelpOptionsDisplay = require_components_display.HelpOptionsDisplay;
13
12
  exports.HelpUsageDisplay = require_components_display.HelpUsageDisplay;
14
13
  exports.VirtualCommandHelpDisplay = require_components_display.VirtualCommandHelpDisplay;
@@ -1,4 +1,4 @@
1
1
  import { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps } from "./display.cjs";
2
- import { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration } from "./help-builtin.cjs";
2
+ import { HelpBuiltin, HelpBuiltinProps } from "./help-builtin.cjs";
3
3
  import { HelpCommand } from "./help-command.cjs";
4
- export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpBuiltin, HelpBuiltinProps, HelpCommand, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpFunctionDeclaration, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
4
+ export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpBuiltin, HelpBuiltinProps, HelpCommand, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
@@ -1,4 +1,4 @@
1
1
  import { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps } from "./display.mjs";
2
- import { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration } from "./help-builtin.mjs";
2
+ import { HelpBuiltin, HelpBuiltinProps } from "./help-builtin.mjs";
3
3
  import { HelpCommand } from "./help-command.mjs";
4
- export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpBuiltin, HelpBuiltinProps, HelpCommand, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpFunctionDeclaration, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
4
+ export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpBuiltin, HelpBuiltinProps, HelpCommand, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
@@ -1,5 +1,5 @@
1
1
  import { BaseHelpDisplay, CommandHelpDisplay, HelpCommandsDisplay, HelpOptionsDisplay, HelpUsageDisplay, VirtualCommandHelpDisplay } from "./display.mjs";
2
- import { HelpBuiltin, HelpFunctionDeclaration } from "./help-builtin.mjs";
2
+ import { HelpBuiltin } from "./help-builtin.mjs";
3
3
  import { HelpCommand } from "./help-command.mjs";
4
4
 
5
- export { BaseHelpDisplay, CommandHelpDisplay, HelpBuiltin, HelpCommand, HelpCommandsDisplay, HelpFunctionDeclaration, HelpOptionsDisplay, HelpUsageDisplay, VirtualCommandHelpDisplay };
5
+ export { BaseHelpDisplay, CommandHelpDisplay, HelpBuiltin, HelpCommand, HelpCommandsDisplay, HelpOptionsDisplay, HelpUsageDisplay, VirtualCommandHelpDisplay };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shell-shock/plugin-help",
3
- "version": "0.2.21",
3
+ "version": "0.2.22",
4
4
  "private": false,
5
5
  "description": "A package containing a Shell Shock plugin to provide help and documentation for the local application's commands.",
6
6
  "keywords": [
@@ -52,21 +52,21 @@
52
52
  "dependencies": {
53
53
  "@alloy-js/core": "0.23.0-dev.8",
54
54
  "@alloy-js/typescript": "0.23.0-dev.4",
55
- "@powerlines/deepkit": "^0.8.0",
56
- "@powerlines/plugin-alloy": "^0.26.15",
57
- "@powerlines/plugin-plugin": "^0.12.347",
58
- "@shell-shock/core": "^0.17.3",
59
- "@shell-shock/plugin-theme": "^0.4.16",
60
- "@shell-shock/plugin-console": "^0.2.7",
55
+ "@powerlines/deepkit": "^0.8.1",
56
+ "@powerlines/plugin-alloy": "^0.26.16",
57
+ "@powerlines/plugin-plugin": "^0.12.348",
58
+ "@shell-shock/core": "^0.17.4",
59
+ "@shell-shock/plugin-theme": "^0.4.17",
60
+ "@shell-shock/plugin-console": "^0.2.8",
61
61
  "@stryke/string-format": "^0.17.9",
62
62
  "@stryke/type-checks": "^0.6.1",
63
63
  "@stryke/path": "^0.27.4",
64
64
  "@stryke/types": "^0.11.3",
65
65
  "defu": "^6.1.7",
66
- "powerlines": "^0.42.37"
66
+ "powerlines": "^0.42.38"
67
67
  },
68
68
  "devDependencies": {
69
- "@powerlines/plugin-deepkit": "^0.11.277",
69
+ "@powerlines/plugin-deepkit": "^0.11.278",
70
70
  "@types/node": "^25.6.0"
71
71
  },
72
72
  "publishConfig": { "access": "public" },
@@ -171,5 +171,5 @@
171
171
  }
172
172
  }
173
173
  },
174
- "gitHead": "d6ec6746792a83206915332c4eb87c9da70a5148"
174
+ "gitHead": "1364666ac28f03cca26271afb582c71a2fe12ecd"
175
175
  }