@shell-shock/plugin-help 0.2.0 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/display.d.cts +7 -7
- package/dist/components/display.d.cts.map +1 -1
- package/dist/components/display.d.mts +7 -7
- package/dist/components/display.d.mts.map +1 -1
- package/dist/components/help-builtin.d.cts +3 -3
- package/dist/components/help-builtin.d.cts.map +1 -1
- package/dist/components/help-builtin.d.mts +3 -3
- package/dist/components/help-builtin.d.mts.map +1 -1
- package/dist/components/help-command.d.cts +2 -2
- package/dist/components/help-command.d.cts.map +1 -1
- package/dist/components/help-command.d.mts +2 -2
- package/dist/components/help-command.d.mts.map +1 -1
- package/dist/index.cjs +0 -1
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +0 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +12 -11
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
1
|
+
import * as _$_alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
import { CommandOption, CommandTree } from "@shell-shock/core";
|
|
3
3
|
|
|
4
4
|
//#region src/components/display.d.ts
|
|
@@ -20,7 +20,7 @@ interface HelpUsageDisplayProps {
|
|
|
20
20
|
/**
|
|
21
21
|
* A component that generates the usage display for a command.
|
|
22
22
|
*/
|
|
23
|
-
declare function HelpUsageDisplay(props: HelpUsageDisplayProps): _alloy_js_core0.Children;
|
|
23
|
+
declare function HelpUsageDisplay(props: HelpUsageDisplayProps): _$_alloy_js_core0.Children;
|
|
24
24
|
interface HelpOptionsDisplayProps {
|
|
25
25
|
/**
|
|
26
26
|
* The options to display help for.
|
|
@@ -30,7 +30,7 @@ interface HelpOptionsDisplayProps {
|
|
|
30
30
|
/**
|
|
31
31
|
* A component that generates the options table display for a command.
|
|
32
32
|
*/
|
|
33
|
-
declare function HelpOptionsDisplay(props: HelpOptionsDisplayProps): _alloy_js_core0.Children;
|
|
33
|
+
declare function HelpOptionsDisplay(props: HelpOptionsDisplayProps): _$_alloy_js_core0.Children;
|
|
34
34
|
interface HelpCommandsDisplayProps {
|
|
35
35
|
/**
|
|
36
36
|
* A mapping of command names to their command definitions.
|
|
@@ -40,7 +40,7 @@ interface HelpCommandsDisplayProps {
|
|
|
40
40
|
/**
|
|
41
41
|
* A component that generates the commands table display for a command.
|
|
42
42
|
*/
|
|
43
|
-
declare function HelpCommandsDisplay(props: HelpCommandsDisplayProps): _alloy_js_core0.Children;
|
|
43
|
+
declare function HelpCommandsDisplay(props: HelpCommandsDisplayProps): _$_alloy_js_core0.Children;
|
|
44
44
|
interface BaseHelpDisplayProps {
|
|
45
45
|
/**
|
|
46
46
|
* The command to generate help for.
|
|
@@ -68,7 +68,7 @@ interface BaseHelpDisplayProps {
|
|
|
68
68
|
/**
|
|
69
69
|
* A component that generates the `help` function declaration for a command.
|
|
70
70
|
*/
|
|
71
|
-
declare function BaseHelpDisplay(props: BaseHelpDisplayProps): _alloy_js_core0.Children;
|
|
71
|
+
declare function BaseHelpDisplay(props: BaseHelpDisplayProps): _$_alloy_js_core0.Children;
|
|
72
72
|
interface VirtualCommandHelpDisplayProps {
|
|
73
73
|
/**
|
|
74
74
|
* The options to display help for.
|
|
@@ -89,7 +89,7 @@ interface VirtualCommandHelpDisplayProps {
|
|
|
89
89
|
/**
|
|
90
90
|
* A component that generates the invocation of the `help` function for a command.
|
|
91
91
|
*/
|
|
92
|
-
declare function VirtualCommandHelpDisplay(props: VirtualCommandHelpDisplayProps): _alloy_js_core0.Children;
|
|
92
|
+
declare function VirtualCommandHelpDisplay(props: VirtualCommandHelpDisplayProps): _$_alloy_js_core0.Children;
|
|
93
93
|
interface CommandHelpDisplayProps {
|
|
94
94
|
/**
|
|
95
95
|
* A mapping of command names to their command definitions.
|
|
@@ -99,7 +99,7 @@ interface CommandHelpDisplayProps {
|
|
|
99
99
|
/**
|
|
100
100
|
* A component that generates the invocation of the `help` function for a command.
|
|
101
101
|
*/
|
|
102
|
-
declare function CommandHelpDisplay(props: CommandHelpDisplayProps): _alloy_js_core0.Children;
|
|
102
|
+
declare function CommandHelpDisplay(props: CommandHelpDisplayProps): _$_alloy_js_core0.Children;
|
|
103
103
|
//#endregion
|
|
104
104
|
export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
|
|
105
105
|
//# sourceMappingURL=display.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"display.d.cts","names":[],"sources":["../../src/components/display.tsx"],"mappings":";;;;UAsCiB,qBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;;;;;;;;AAgBX;EANE,MAAA;AAAA;;;;iBAMc,gBAAA,CAAiB,KAAA,EAAO,qBAAA,GAAqB,
|
|
1
|
+
{"version":3,"file":"display.d.cts","names":[],"sources":["../../src/components/display.tsx"],"mappings":";;;;UAsCiB,qBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;;;;;;;;AAgBX;EANE,MAAA;AAAA;;;;iBAMc,gBAAA,CAAiB,KAAA,EAAO,qBAAA,GAAqB,iBAAA,CAAA,QAAA;AAAA,UAiH5C,uBAAA;EAjH4C;AAiH7D;;EAIE,OAAA,EAAS,aAAA;AAAA;;AAMX;;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,iBAAA,CAAA,QAAA;AAAA,UA0EhD,wBAAA;EA1EyB;;;EA8ExC,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAJ3B;;;AAAA,iBAUgB,mBAAA,CAAoB,KAAA,EAAO,wBAAA,GAAwB,iBAAA,CAAA,QAAA;AAAA,UAwBlD,oBAAA;EA9BL;;;EAkCV,OAAA,EAAS,WAAA;EA5BK;;;;;;;;EAsCd,mBAAA;EAde;;;;;;;;EAwBf,MAAA;AAAA;AAMF;;;AAAA,iBAAgB,eAAA,CAAgB,KAAA,EAAO,oBAAA,GAAoB,iBAAA,CAAA,QAAA;AAAA,UA6D1C,8BAAA;EA7De;;;EAiE9B,OAAA,EAAS,aAAA;EAJM;;;EASf,QAAA,EAAU,MAAA,SAAe,WAAA;EAAA;;;;;;EAQzB,QAAA;AAAA;;;;iBAMc,yBAAA,CACd,KAAA,EAAO,8BAAA,GAA8B,iBAAA,CAAA,QAAA;AAAA,UA2DtB,uBAAA;EA5DwB;;;EAgEvC,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,iBAAA,CAAA,QAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
1
|
+
import * as _$_alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
import { CommandOption, CommandTree } from "@shell-shock/core";
|
|
3
3
|
|
|
4
4
|
//#region src/components/display.d.ts
|
|
@@ -20,7 +20,7 @@ interface HelpUsageDisplayProps {
|
|
|
20
20
|
/**
|
|
21
21
|
* A component that generates the usage display for a command.
|
|
22
22
|
*/
|
|
23
|
-
declare function HelpUsageDisplay(props: HelpUsageDisplayProps): _alloy_js_core0.Children;
|
|
23
|
+
declare function HelpUsageDisplay(props: HelpUsageDisplayProps): _$_alloy_js_core0.Children;
|
|
24
24
|
interface HelpOptionsDisplayProps {
|
|
25
25
|
/**
|
|
26
26
|
* The options to display help for.
|
|
@@ -30,7 +30,7 @@ interface HelpOptionsDisplayProps {
|
|
|
30
30
|
/**
|
|
31
31
|
* A component that generates the options table display for a command.
|
|
32
32
|
*/
|
|
33
|
-
declare function HelpOptionsDisplay(props: HelpOptionsDisplayProps): _alloy_js_core0.Children;
|
|
33
|
+
declare function HelpOptionsDisplay(props: HelpOptionsDisplayProps): _$_alloy_js_core0.Children;
|
|
34
34
|
interface HelpCommandsDisplayProps {
|
|
35
35
|
/**
|
|
36
36
|
* A mapping of command names to their command definitions.
|
|
@@ -40,7 +40,7 @@ interface HelpCommandsDisplayProps {
|
|
|
40
40
|
/**
|
|
41
41
|
* A component that generates the commands table display for a command.
|
|
42
42
|
*/
|
|
43
|
-
declare function HelpCommandsDisplay(props: HelpCommandsDisplayProps): _alloy_js_core0.Children;
|
|
43
|
+
declare function HelpCommandsDisplay(props: HelpCommandsDisplayProps): _$_alloy_js_core0.Children;
|
|
44
44
|
interface BaseHelpDisplayProps {
|
|
45
45
|
/**
|
|
46
46
|
* The command to generate help for.
|
|
@@ -68,7 +68,7 @@ interface BaseHelpDisplayProps {
|
|
|
68
68
|
/**
|
|
69
69
|
* A component that generates the `help` function declaration for a command.
|
|
70
70
|
*/
|
|
71
|
-
declare function BaseHelpDisplay(props: BaseHelpDisplayProps): _alloy_js_core0.Children;
|
|
71
|
+
declare function BaseHelpDisplay(props: BaseHelpDisplayProps): _$_alloy_js_core0.Children;
|
|
72
72
|
interface VirtualCommandHelpDisplayProps {
|
|
73
73
|
/**
|
|
74
74
|
* The options to display help for.
|
|
@@ -89,7 +89,7 @@ interface VirtualCommandHelpDisplayProps {
|
|
|
89
89
|
/**
|
|
90
90
|
* A component that generates the invocation of the `help` function for a command.
|
|
91
91
|
*/
|
|
92
|
-
declare function VirtualCommandHelpDisplay(props: VirtualCommandHelpDisplayProps): _alloy_js_core0.Children;
|
|
92
|
+
declare function VirtualCommandHelpDisplay(props: VirtualCommandHelpDisplayProps): _$_alloy_js_core0.Children;
|
|
93
93
|
interface CommandHelpDisplayProps {
|
|
94
94
|
/**
|
|
95
95
|
* A mapping of command names to their command definitions.
|
|
@@ -99,7 +99,7 @@ interface CommandHelpDisplayProps {
|
|
|
99
99
|
/**
|
|
100
100
|
* A component that generates the invocation of the `help` function for a command.
|
|
101
101
|
*/
|
|
102
|
-
declare function CommandHelpDisplay(props: CommandHelpDisplayProps): _alloy_js_core0.Children;
|
|
102
|
+
declare function CommandHelpDisplay(props: CommandHelpDisplayProps): _$_alloy_js_core0.Children;
|
|
103
103
|
//#endregion
|
|
104
104
|
export { BaseHelpDisplay, BaseHelpDisplayProps, CommandHelpDisplay, CommandHelpDisplayProps, HelpCommandsDisplay, HelpCommandsDisplayProps, HelpOptionsDisplay, HelpOptionsDisplayProps, HelpUsageDisplay, HelpUsageDisplayProps, VirtualCommandHelpDisplay, VirtualCommandHelpDisplayProps };
|
|
105
105
|
//# sourceMappingURL=display.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"display.d.mts","names":[],"sources":["../../src/components/display.tsx"],"mappings":";;;;UAsCiB,qBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;;;;;;;;AAgBX;EANE,MAAA;AAAA;;;;iBAMc,gBAAA,CAAiB,KAAA,EAAO,qBAAA,GAAqB,
|
|
1
|
+
{"version":3,"file":"display.d.mts","names":[],"sources":["../../src/components/display.tsx"],"mappings":";;;;UAsCiB,qBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;;;;;;;;AAgBX;EANE,MAAA;AAAA;;;;iBAMc,gBAAA,CAAiB,KAAA,EAAO,qBAAA,GAAqB,iBAAA,CAAA,QAAA;AAAA,UAiH5C,uBAAA;EAjH4C;AAiH7D;;EAIE,OAAA,EAAS,aAAA;AAAA;;AAMX;;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,iBAAA,CAAA,QAAA;AAAA,UA0EhD,wBAAA;EA1EyB;;;EA8ExC,QAAA,EAAU,MAAA,SAAe,WAAA;AAAA;AAJ3B;;;AAAA,iBAUgB,mBAAA,CAAoB,KAAA,EAAO,wBAAA,GAAwB,iBAAA,CAAA,QAAA;AAAA,UAwBlD,oBAAA;EA9BL;;;EAkCV,OAAA,EAAS,WAAA;EA5BK;;;;;;;;EAsCd,mBAAA;EAde;;;;;;;;EAwBf,MAAA;AAAA;AAMF;;;AAAA,iBAAgB,eAAA,CAAgB,KAAA,EAAO,oBAAA,GAAoB,iBAAA,CAAA,QAAA;AAAA,UA6D1C,8BAAA;EA7De;;;EAiE9B,OAAA,EAAS,aAAA;EAJM;;;EASf,QAAA,EAAU,MAAA,SAAe,WAAA;EAAA;;;;;;EAQzB,QAAA;AAAA;;;;iBAMc,yBAAA,CACd,KAAA,EAAO,8BAAA,GAA8B,iBAAA,CAAA,QAAA;AAAA,UA2DtB,uBAAA;EA5DwB;;;EAgEvC,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,iBAAA,CAAA,QAAA"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
1
|
+
import * as _$_alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
import { CommandTree } from "@shell-shock/core";
|
|
3
3
|
import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@ import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components
|
|
|
6
6
|
/**
|
|
7
7
|
* The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.
|
|
8
8
|
*/
|
|
9
|
-
declare function HelpFunctionDeclaration(): _alloy_js_core0.Children;
|
|
9
|
+
declare function HelpFunctionDeclaration(): _$_alloy_js_core0.Children;
|
|
10
10
|
interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description"> {
|
|
11
11
|
/**
|
|
12
12
|
* The command to generate the `help` function declaration for.
|
|
@@ -16,7 +16,7 @@ interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description">
|
|
|
16
16
|
/**
|
|
17
17
|
* A built-in help module for Shell Shock.
|
|
18
18
|
*/
|
|
19
|
-
declare function HelpBuiltin(props: HelpBuiltinProps): _alloy_js_core0.Children;
|
|
19
|
+
declare function HelpBuiltin(props: HelpBuiltinProps): _$_alloy_js_core0.Children;
|
|
20
20
|
//#endregion
|
|
21
21
|
export { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration };
|
|
22
22
|
//# 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,
|
|
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,4 +1,4 @@
|
|
|
1
|
-
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
1
|
+
import * as _$_alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
import { CommandTree } from "@shell-shock/core";
|
|
3
3
|
import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components/builtin-file";
|
|
4
4
|
|
|
@@ -6,7 +6,7 @@ import { BuiltinFileProps } from "@powerlines/plugin-alloy/typescript/components
|
|
|
6
6
|
/**
|
|
7
7
|
* The `updateVersionCheckFile` handler function declaration code for the Shell Shock project.
|
|
8
8
|
*/
|
|
9
|
-
declare function HelpFunctionDeclaration(): _alloy_js_core0.Children;
|
|
9
|
+
declare function HelpFunctionDeclaration(): _$_alloy_js_core0.Children;
|
|
10
10
|
interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description"> {
|
|
11
11
|
/**
|
|
12
12
|
* The command to generate the `help` function declaration for.
|
|
@@ -16,7 +16,7 @@ interface HelpBuiltinProps extends Omit<BuiltinFileProps, "id" | "description">
|
|
|
16
16
|
/**
|
|
17
17
|
* A built-in help module for Shell Shock.
|
|
18
18
|
*/
|
|
19
|
-
declare function HelpBuiltin(props: HelpBuiltinProps): _alloy_js_core0.Children;
|
|
19
|
+
declare function HelpBuiltin(props: HelpBuiltinProps): _$_alloy_js_core0.Children;
|
|
20
20
|
//#endregion
|
|
21
21
|
export { HelpBuiltin, HelpBuiltinProps, HelpFunctionDeclaration };
|
|
22
22
|
//# 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,
|
|
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,10 +1,10 @@
|
|
|
1
|
-
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
1
|
+
import * as _$_alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
|
|
3
3
|
//#region src/components/help-command.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* The Help command's handler wrapper for the Shell Shock project.
|
|
6
6
|
*/
|
|
7
|
-
declare function HelpCommand(): _alloy_js_core0.Children;
|
|
7
|
+
declare function HelpCommand(): _$_alloy_js_core0.Children;
|
|
8
8
|
//#endregion
|
|
9
9
|
export { HelpCommand };
|
|
10
10
|
//# sourceMappingURL=help-command.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-command.d.cts","names":[],"sources":["../../src/components/help-command.tsx"],"mappings":";;;;;;iBAyCgB,WAAA,CAAA,GAAW,
|
|
1
|
+
{"version":3,"file":"help-command.d.cts","names":[],"sources":["../../src/components/help-command.tsx"],"mappings":";;;;;;iBAyCgB,WAAA,CAAA,GAAW,iBAAA,CAAA,QAAA"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import * as _alloy_js_core0 from "@alloy-js/core";
|
|
1
|
+
import * as _$_alloy_js_core0 from "@alloy-js/core";
|
|
2
2
|
|
|
3
3
|
//#region src/components/help-command.d.ts
|
|
4
4
|
/**
|
|
5
5
|
* The Help command's handler wrapper for the Shell Shock project.
|
|
6
6
|
*/
|
|
7
|
-
declare function HelpCommand(): _alloy_js_core0.Children;
|
|
7
|
+
declare function HelpCommand(): _$_alloy_js_core0.Children;
|
|
8
8
|
//#endregion
|
|
9
9
|
export { HelpCommand };
|
|
10
10
|
//# sourceMappingURL=help-command.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-command.d.mts","names":[],"sources":["../../src/components/help-command.tsx"],"mappings":";;;;;;iBAyCgB,WAAA,CAAA,GAAW,
|
|
1
|
+
{"version":3,"file":"help-command.d.mts","names":[],"sources":["../../src/components/help-command.tsx"],"mappings":";;;;;;iBAyCgB,WAAA,CAAA,GAAW,iBAAA,CAAA,QAAA"}
|
package/dist/index.cjs
CHANGED
|
@@ -39,7 +39,6 @@ const plugin = (options = {}) => {
|
|
|
39
39
|
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.");
|
|
40
40
|
else this.inputs.push({
|
|
41
41
|
id: this.config.help.command.name,
|
|
42
|
-
name: this.config.help.command.name,
|
|
43
42
|
path: this.config.help.command.name,
|
|
44
43
|
segments: [this.config.help.command.name],
|
|
45
44
|
title: "Help",
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;AA0CA;cAAa,MAAA,oBAA2B,iBAAA,GAAoB,iBAAA,EAC1D,OAAA,GAAS,iBAAA,
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;AA0CA;cAAa,MAAA,oBAA2B,iBAAA,GAAoB,iBAAA,EAC1D,OAAA,GAAS,iBAAA,KAoHJ,MAAA,CAAO,QAAA"}
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;AA0CA;cAAa,MAAA,oBAA2B,iBAAA,GAAoB,iBAAA,EAC1D,OAAA,GAAS,iBAAA,
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.tsx"],"mappings":";;;;;;AA0CA;cAAa,MAAA,oBAA2B,iBAAA,GAAoB,iBAAA,EAC1D,OAAA,GAAS,iBAAA,KAoHJ,MAAA,CAAO,QAAA"}
|
package/dist/index.mjs
CHANGED
|
@@ -34,7 +34,6 @@ const plugin = (options = {}) => {
|
|
|
34
34
|
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.");
|
|
35
35
|
else this.inputs.push({
|
|
36
36
|
id: this.config.help.command.name,
|
|
37
|
-
name: this.config.help.command.name,
|
|
38
37
|
path: this.config.help.command.name,
|
|
39
38
|
segments: [this.config.help.command.name],
|
|
40
39
|
title: "Help",
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +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 getAppDescription,\n getAppName,\n getAppTitle,\n getCommandList\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 { 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 ? { 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
|
|
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 type { CommandConfig } from \"@shell-shock/core/types/command\";\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 ? { 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 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 ...this.config.help.command\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":";;;;;;;;;;;;;;;;;;AAqCA,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,EACG,MAAC,QAAa,SACf,GAAC,EACR,MAAA,QACO,EACL,EAAA,SAAc,EACd,UAAS,MACP,CAAA,EACD;;;AAGD,SAAE,MAAO,sDAAA;AACT,QAAI,KAAK,OAAK,KAAA,YAAA,OAAA;AACZ,UAAI,WAAA,EAAA;AACJ,SAAI,KAAE,OAAO,MAAA,UAAA,MAAA,SAAA,KAAA,OAAA,KAAA,QAAA,KAAA,CACX,MAAK,KAAC,2LAAoB;SAE1B,MAAK,OAAK,KAAA;MACR,IAAI,KAAK,OAAO,KAAE,QAAQ;MAC1B,MAAM,KAAK,OAAO,KAAK,QAAE;MACzB,UAAC,CAAA,KAAA,OAAA,KAAA,QAAA,KAAA;MACD,OAAO;MACP,MAAA;MACA,aAAY,oEAAA,YAAA,MAAA,KAAA,CAAA;MACZ,OAAA;OACF,MAAA,UAAA,KAAA,WAAA,QAAA,WAAA;OACD,OAAA,EACF,MAAA,UAAA,KAAA,WAAA,QAAA,aAAA,EACK;OACC;;MAED,GAAA,KAAK,OAAO,KAAK;MACnB,CAAA;AAEF,WAAI,OAAK,MAAO,gBAAI,aAAA,EAAA,CAAA,CAAA;;;GAGxB,SAAQ;IACN,OAAM;IACN,MAAM,UAAS;KACb,MAAM,SAAM;KACZ,MAAK,WAAA,MAAA,eAAA,KAAA;AACL,UAAI,MAAK,gDAAA,SAAA,OAAA,mBAAA;KACT,MAAI,MAAK,gBAAY;MACnB,IAAI;MACJ,MAAI,WAAW,KAAO;MACtB,OAAI,YAAe,KAAC;MACpB,aAAY,kBAAK,KAAA;MACjB,WAAW;MACX,MAAI;MACJ,UAAU,EAAA;MACV,OAAM,EAAA;MACN,SAAO,OAAQ,YAAK,KAAU,QAAW,KAAE,WAAA,CAAA,OAAA,MAAA,OAAA,CAAA,CAAA;MAC3C,OAAI,EACF,MAAI,UAAM,KAAU,WAAK,SAAgB,EAC1C;MACD,MAAM,EAAE;MACR,QAAM;MACN,UAAK,KAAA;MACN,EAAE;AACH,YAAO,OAAO,MAAM,CAAC,gBAAK,MAAA;MACxB,IAAI,OAAA;AACJ,cAAA,OAAA,OAAA,KAAA,aAAA;;MAEA,IAAA,WAAa;AACf,cAAA;QAAA,gBAAA,aAAA,EACD,IAAA,UAAA;AACQ,gBAAA,IAAA;WAEF,CAAC;QAAA,gBAAU,SAAA,EAAA,CAAA;QAAA,gBAAA,KAAA;SACd,IAAM,OAAS;AACV,iBAAK,SAAA,MAAA,GAAA,MAAA,EAAA,KAAA,cAAA,EAAA,KAAA,CAAA;;SAEN,gBAAS;SACT,WAAQ,YAAQ,gBAAA,aAAA,EACnB;SAED,CAAA;QAAK;;MAEN,CAAC,CAAC,CAAC;;IAEP;GACF;EAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shell-shock/plugin-help",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.2",
|
|
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,22 @@
|
|
|
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.6.
|
|
56
|
-
"@powerlines/plugin-alloy": "^0.25.
|
|
57
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
58
|
-
"@shell-shock/core": "^0.13.
|
|
59
|
-
"@shell-shock/plugin-theme": "^0.3.
|
|
60
|
-
"@shell-shock/plugin-console": "^0.1.
|
|
55
|
+
"@powerlines/deepkit": "^0.6.162",
|
|
56
|
+
"@powerlines/plugin-alloy": "^0.25.70",
|
|
57
|
+
"@powerlines/plugin-plugin": "^0.12.334",
|
|
58
|
+
"@shell-shock/core": "^0.13.13",
|
|
59
|
+
"@shell-shock/plugin-theme": "^0.3.28",
|
|
60
|
+
"@shell-shock/plugin-console": "^0.1.24",
|
|
61
61
|
"@stryke/string-format": "^0.17.7",
|
|
62
62
|
"@stryke/type-checks": "^0.6.0",
|
|
63
63
|
"@stryke/path": "^0.27.3",
|
|
64
64
|
"defu": "^6.1.4",
|
|
65
|
-
"powerlines": "^0.42.
|
|
65
|
+
"powerlines": "^0.42.24"
|
|
66
66
|
},
|
|
67
67
|
"devDependencies": {
|
|
68
|
-
"@powerlines/plugin-deepkit": "^0.11.
|
|
69
|
-
"@types/node": "^25.5.0"
|
|
68
|
+
"@powerlines/plugin-deepkit": "^0.11.262",
|
|
69
|
+
"@types/node": "^25.5.0",
|
|
70
|
+
"@stryke/types": "^0.11.2"
|
|
70
71
|
},
|
|
71
72
|
"publishConfig": { "access": "public" },
|
|
72
73
|
"exports": {
|
|
@@ -171,5 +172,5 @@
|
|
|
171
172
|
}
|
|
172
173
|
},
|
|
173
174
|
"inlinedDependencies": { "@stryke/types": "0.11.2" },
|
|
174
|
-
"gitHead": "
|
|
175
|
+
"gitHead": "c3d7c3dd32ea1179968a93e2f18da897d8e7e95a"
|
|
175
176
|
}
|