@shell-shock/core 0.17.17 → 0.17.19

package/dist/components/command-validation-logic.cjs

@@ -3,8 +3,8 @@ let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
 let _alloy_js_core = require("@alloy-js/core");
 let _stryke_string_format_camel_case = require("@stryke/string-format/camel-case");
 let _powerlines_plugin_alloy_core_components_spacing = require("@powerlines/plugin-alloy/core/components/spacing");
-let _alloy_js_typescript = require("@alloy-js/typescript");
 let _stryke_string_format_list = require("@stryke/string-format/list");
+let _alloy_js_typescript = require("@alloy-js/typescript");
 
 //#region src/components/command-validation-logic.tsx
 function __assignType(fn, args) {

package/dist/components/command-validation-logic.mjs

@@ -2,8 +2,8 @@ import { createComponent, createIntrinsic } from "@alloy-js/core/jsx-runtime";
 import { For, Show, code } from "@alloy-js/core";
 import { camelCase } from "@stryke/string-format/camel-case";
 import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
-import { ElseIfClause, IfStatement, VarDeclaration } from "@alloy-js/typescript";
 import { list } from "@stryke/string-format/list";
+import { ElseIfClause, IfStatement, VarDeclaration } from "@alloy-js/typescript";
 
 //#region src/components/command-validation-logic.tsx
 function __assignType(fn, args) {

package/dist/components/docs.cjs

@@ -13,6 +13,8 @@ let _powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin
 let _powerlines_plugin_alloy_markdown_components_markdown_file = require("@powerlines/plugin-alloy/markdown/components/markdown-file");
 let _powerlines_plugin_alloy_markdown_components_markdown_table = require("@powerlines/plugin-alloy/markdown/components/markdown-table");
 let _stryke_path_join = require("@stryke/path/join");
+let _stryke_string_format_list = require("@stryke/string-format/list");
+let _stryke_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
 
 //#region src/components/docs.tsx
 const __ΩRequired = [
@@ -29,36 +31,68 @@ function __assignType(fn, args) {
 	fn.__type = args;
 	return fn;
 }
-const __ΩCommandOptionsDocsProps = [
+const __ΩCommandParametersDocsProps = [
 	"CommandTree",
 	"command",
 	"The command to generate options documentation for.",
-	"CommandOptionsDocsProps",
+	"CommandParametersDocsProps",
 	"P\"w!4\"?#Mw$y"
 ];
 /**
+* Generates the arguments markdown documentation for a command.
+*/
+function CommandArgumentDocs(props) {
+	const { command } = props;
+	if (Object.keys(command.options).length === 0) return _alloy_js_core.code`This command does not have any arguments.`;
+	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_markdown_components_markdown_table.MarkdownTable, { get data() {
+		return require_reflect.sortOptions(Object.values(command.options)).reduce(__assignType((ret, option) => {
+			ret.push({
+				name: option.name.trim(),
+				description: option.description.trim(),
+				defaultValue: (0, _stryke_type_checks_is_undefined.isUndefined)(option.default) ? "" : JSON.stringify(option.default),
+				required: !option.required || option.default ? "" : "✔"
+			});
+			return ret;
+		}, [
+			"ret",
+			"option",
+			"",
+			"P\"2!\"2\"\"/#"
+		]), []);
+	} });
+}
+CommandArgumentDocs.__type = [
+	() => __ΩCommandParametersDocsProps,
+	"props",
+	"CommandArgumentDocs",
+	"Generates the arguments markdown documentation for a command.",
+	"Pn!2\"\"/#?$"
+];
+/**
 * Generates the options markdown documentation for a command.
 */
 function CommandOptionsDocs(props) {
 	const { command } = props;
 	if (Object.keys(command.options).length === 0) return _alloy_js_core.code`This command does not have any options.`;
 	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_markdown_components_markdown_table.MarkdownTable, { get data() {
-		return require_reflect.sortOptions(Object.values(command.options)).map(__assignType((option) => {
-			return {
+		return require_reflect.sortOptions(Object.values(command.options)).reduce(__assignType((ret, option) => {
+			ret.push({
 				name: option.name.trim(),
 				description: option.description.trim(),
-				defaultValue: option.default ? String(option.default)?.includes("\"") ? option.default : `\`${Array.isArray(option.default) ? option.default.join(", ") : option.default}\`` : "",
+				defaultValue: (0, _stryke_type_checks_is_undefined.isUndefined)(option.default) ? "" : JSON.stringify(option.default),
 				required: !option.required || option.default ? "" : "✔"
-			};
+			});
+			return ret;
 		}, [
+			"ret",
 			"option",
 			"",
-			"P\"2!\"/\""
-		]));
+			"P\"2!\"2\"\"/#"
+		]), []);
 	} });
 }
 CommandOptionsDocs.__type = [
-	() => __ΩCommandOptionsDocsProps,
+	() => __ΩCommandParametersDocsProps,
 	"props",
 	"CommandOptionsDocs",
 	"Generates the options markdown documentation for a command.",
@@ -75,18 +109,31 @@ const __ΩCommandDocsUsageExampleProps = [
 	"CommandTree",
 	"command",
 	"The command to generate the usage example for.",
+	"expand",
+	true,
+	"Whether to add expand/collapse details tags around the usage example. This is useful for hiding long usage examples by default.",
 	"CommandDocsUsageExampleProps",
-	"PP.!.\".#.$J4%8>&?'\"w(4)?*Mw+y"
+	"PP.!.\".#.$J4%8>&?'\"w(4)?*)4+8>,?-Mw.y"
 ];
 /**
 * Generates the markdown documentation for a command.
 */
 function CommandDocsUsageExample(props) {
-	const { packageManager = "npm", command } = props;
+	const { packageManager = "npm", command, expand = false } = props;
 	const context = (_powerlines_plugin_alloy_core_contexts_context.usePowerlines.Ω = [["Context", "\"w!"]], (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)());
 	return [
-		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-		_alloy_js_core.code`\`\`\`bash `,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			when: expand,
+			fallback: _alloy_js_core.code`\`\`\`sh `,
+			get children() {
+				return [
+					_alloy_js_core.code`<details>
+        <summary>Using ${packageManager}:</summary>`,
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					_alloy_js_core.code`\`\`\`sh `
+				];
+			}
+		}),
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(require_components_usage.Usage, {
 			command,
@@ -96,8 +143,17 @@ function CommandDocsUsageExample(props) {
 			packageManager
 		}),
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-		_alloy_js_core.code`\`\`\``,
-		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			when: expand,
+			fallback: _alloy_js_core.code`\`\`\` `,
+			get children() {
+				return [
+					_alloy_js_core.code`\`\`\``,
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					_alloy_js_core.code`</details>`
+				];
+			}
+		})
 	];
 }
 CommandDocsUsageExample.__type = [
@@ -132,18 +188,40 @@ function CommandDocs(props) {
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_markdown.Heading, {
 			level: 1 + levelOffset,
 			get children() {
-				return command.title;
+				return `${command.title}${command.tags.includes("deprecated") ? " (Deprecated)" : command.tags.includes("beta") ? " (Beta)" : command.tags.includes("alpha") ? " (Alpha)" : command.tags.includes("experimental") ? " (Experimental)" : ""}`;
 			}
 		}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`${command.description}`),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			get when() {
+				return command.alias && command.alias.length > 0;
+			},
+			get children() {
+				return [(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}), (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+					get when() {
+						return command.alias.length > 1;
+					},
+					get fallback() {
+						return _alloy_js_core.code`The \`${command.name}\` command can also be invoked using the alias \`${command.alias[0]}\`.`;
+					},
+					get children() {
+						return _alloy_js_core.code`The \`${command.name}\` command can also be invoked using the following aliases: ${(0, _stryke_string_format_list.list)(command.alias.map(__assignType((alias) => `\`${alias}\``, [
+							"alias",
+							"",
+							"P\"2!\"/\""
+						])), { conjunction: "or" })}.`;
+					}
+				})];
+			}
+		}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_markdown.Heading, {
 			level: 2 + levelOffset,
 			children: "Usage"
 		}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-		(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`The ${command.name} command can be executed using the following syntax: `),
+		(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`The \`${command.name}\` command can be executed using the following syntax: `),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
 			get when() {
@@ -158,11 +236,14 @@ function CommandDocs(props) {
 			get children() {
 				return (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
 					each: usageExamples,
-					hardline: true,
+					doubleHardline: true,
 					get children() {
 						return __assignType((packageManager) => (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
 							packageManager,
-							command
+							command,
+							get expand() {
+								return usageExamples && usageExamples.length > 1;
+							}
 						}), [
 							"packageManager",
 							"",
@@ -173,12 +254,31 @@ function CommandDocs(props) {
 			}
 		}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			get when() {
+				return command.args.length > 0;
+			},
+			get children() {
+				return [
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_markdown.Heading, {
+						level: 2 + levelOffset,
+						children: "Positional Arguments"
+					}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`The following positional arguments are available for the \`${command.name}\` command:`),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(CommandArgumentDocs, { command }),
+					(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {})
+				];
+			}
+		}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_markdown.Heading, {
 			level: 2 + levelOffset,
 			children: "Options"
 		}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-		(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`The following options are available for the ${command.name} command:`),
+		(0, _alloy_js_core_jsx_runtime.memo)(() => _alloy_js_core.code`The following options are available for the \`${command.name}\` command:`),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(CommandOptionsDocs, { command }),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {})
@@ -254,6 +354,7 @@ CommandDocsFile.__type = [
 ];
 
 //#endregion
+exports.CommandArgumentDocs = CommandArgumentDocs;
 exports.CommandDocs = CommandDocs;
 exports.CommandDocsFile = CommandDocsFile;
 exports.CommandDocsUsageExample = CommandDocsUsageExample;
@@ -261,5 +362,5 @@ exports.CommandOptionsDocs = CommandOptionsDocs;
 exports.__ΩCommandDocsFileProps = __ΩCommandDocsFileProps;
 exports.__ΩCommandDocsProps = __ΩCommandDocsProps;
 exports.__ΩCommandDocsUsageExampleProps = __ΩCommandDocsUsageExampleProps;
-exports.__ΩCommandOptionsDocsProps = __ΩCommandOptionsDocsProps;
+exports.__ΩCommandParametersDocsProps = __ΩCommandParametersDocsProps;
 //# sourceMappingURL=docs.cjs.map

package/dist/components/docs.d.cts

@@ -2,16 +2,20 @@ import { CommandTree } from "../types/command.cjs";
 import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
 
 //#region src/components/docs.d.ts
-interface CommandOptionsDocsProps {
+interface CommandParametersDocsProps {
   /**
    * The command to generate options documentation for.
    */
   command: CommandTree;
 }
+/**
+ * Generates the arguments markdown documentation for a command.
+ */
+declare function CommandArgumentDocs(props: CommandParametersDocsProps): import("@alloy-js/core").Children;
 /**
  * Generates the options markdown documentation for a command.
  */
-declare function CommandOptionsDocs(props: CommandOptionsDocsProps): import("@alloy-js/core").Children;
+declare function CommandOptionsDocs(props: CommandParametersDocsProps): import("@alloy-js/core").Children;
 interface CommandDocsUsageExampleProps {
   /**
    * The package manager to generate the usage example for.
@@ -26,6 +30,12 @@ interface CommandDocsUsageExampleProps {
    * The command to generate the usage example for.
    */
   command: CommandTree;
+  /**
+   * Whether to add expand/collapse details tags around the usage example. This is useful for hiding long usage examples by default.
+   *
+   * @defaultValue false
+   */
+  expand?: boolean;
 }
 /**
  * Generates the markdown documentation for a command.
@@ -76,5 +86,5 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
  */
 declare function CommandDocsFile(props: CommandDocsFileProps): import("@alloy-js/core").Children;
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps };
+export { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandParametersDocsProps };
 //# sourceMappingURL=docs.d.cts.map

package/dist/components/docs.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"docs.d.cts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":";;;;UAmCiB,uBAAA;;AAAjB;;EAIE,OAAA,EAAS,WAAW;AAAA;AAAA;AAMtB;;AANsB,iBAMN,kBAAA,CAAmB,KAAA,EAAO,uBAAuB,4BAAA,QAAA;AAAA,UA4BhD,4BAAA;EA5ByB;;;;AAAuB;AA4BjE;;;EASE,cAAA;EAAA;;;EAKA,OAAA,EAAS,WAAW;AAAA;AAMtB;;;AAAA,iBAAgB,uBAAA,CAAwB,KAAA,EAAO,4BAA4B,4BAAA,QAAA;AAAA,UAsB1D,gBAAA;EAtBuB;;;AAAmC;AAsB3E;;;;EASE,WAAA;EAYgB;;;EAPhB,OAAA,EAAS,WAAA;EAAT;;;;;EAOA,aAAA,GAAgB,QAAA,CAAS,4BAAA;AAAA;AAM3B;;;AAAA,iBAAgB,WAAA,CAAY,KAAA,EAAO,gBAAgB,4BAAA,QAAA;AAAA,UAwClC,oBAAA,SAA6B,OAAA,CAAQ,iBAAA;EAxC1B;;;AAAuB;AAwCnD;;;;EASE,WAAA;EAT4C;;;EAc5C,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,eAAA,CAAgB,KAAA,EAAO,oBAAoB,4BAAA,QAAA"}
+{"version":3,"file":"docs.d.cts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":";;;;UAqCiB,0BAAA;;AAAjB;;EAIE,OAAA,EAAS,WAAW;AAAA;AAAA;AAMtB;;AANsB,iBAMN,mBAAA,CAAoB,KAAA,EAAO,0BAA0B,4BAAA,QAAA;;;;iBAmCrD,kBAAA,CAAmB,KAAA,EAAO,0BAA0B,4BAAA,QAAA;AAAA,UAgCnD,4BAAA;EAnEoD;AAmCrE;;;;;;;EAyCE,cAAA;EAzCkE;AAgCpE;;EAcE,OAAA,EAAS,WAAW;EAAA;;;;;EAOpB,MAAA;AAAA;AAMF;;;AAAA,iBAAgB,uBAAA,CAAwB,KAAA,EAAO,4BAA4B,4BAAA,QAAA;AAAA,UA6B1D,gBAAA;EA7BuB;;;AAAmC;AA6B3E;;;;EASE,WAAA;EAYgB;;;EAPhB,OAAA,EAAS,WAAA;EAAT;;;;;EAOA,aAAA,GAAgB,QAAA,CAAS,4BAAA;AAAA;AAM3B;;;AAAA,iBAAgB,WAAA,CAAY,KAAA,EAAO,gBAAgB,4BAAA,QAAA;AAAA,UAyElC,oBAAA,SAA6B,OAAA,CAAQ,iBAAA;EAzE1B;;;AAAuB;AAyEnD;;;;EASE,WAAA;EAT4C;;;EAc5C,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,eAAA,CAAgB,KAAA,EAAO,oBAAoB,4BAAA,QAAA"}

package/dist/components/docs.d.mts

@@ -2,16 +2,20 @@ import { CommandTree } from "../types/command.mjs";
 import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
 
 //#region src/components/docs.d.ts
-interface CommandOptionsDocsProps {
+interface CommandParametersDocsProps {
   /**
    * The command to generate options documentation for.
    */
   command: CommandTree;
 }
+/**
+ * Generates the arguments markdown documentation for a command.
+ */
+declare function CommandArgumentDocs(props: CommandParametersDocsProps): import("@alloy-js/core").Children;
 /**
  * Generates the options markdown documentation for a command.
  */
-declare function CommandOptionsDocs(props: CommandOptionsDocsProps): import("@alloy-js/core").Children;
+declare function CommandOptionsDocs(props: CommandParametersDocsProps): import("@alloy-js/core").Children;
 interface CommandDocsUsageExampleProps {
   /**
    * The package manager to generate the usage example for.
@@ -26,6 +30,12 @@ interface CommandDocsUsageExampleProps {
    * The command to generate the usage example for.
    */
   command: CommandTree;
+  /**
+   * Whether to add expand/collapse details tags around the usage example. This is useful for hiding long usage examples by default.
+   *
+   * @defaultValue false
+   */
+  expand?: boolean;
 }
 /**
  * Generates the markdown documentation for a command.
@@ -76,5 +86,5 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
  */
 declare function CommandDocsFile(props: CommandDocsFileProps): import("@alloy-js/core").Children;
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps };
+export { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandParametersDocsProps };
 //# sourceMappingURL=docs.d.mts.map

package/dist/components/docs.mjs

@@ -12,6 +12,8 @@ import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
 import { MarkdownFile } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
 import { MarkdownTable } from "@powerlines/plugin-alloy/markdown/components/markdown-table";
 import { joinPaths } from "@stryke/path/join";
+import { list } from "@stryke/string-format/list";
+import { isUndefined } from "@stryke/type-checks/is-undefined";
 
 //#region src/components/docs.tsx
 const __ΩRequired = [
@@ -28,36 +30,68 @@ function __assignType(fn, args) {
 	fn.__type = args;
 	return fn;
 }
-const __ΩCommandOptionsDocsProps = [
+const __ΩCommandParametersDocsProps = [
 	"CommandTree",
 	"command",
 	"The command to generate options documentation for.",
-	"CommandOptionsDocsProps",
+	"CommandParametersDocsProps",
 	"P\"w!4\"?#Mw$y"
 ];
 /**
+* Generates the arguments markdown documentation for a command.
+*/
+function CommandArgumentDocs(props) {
+	const { command } = props;
+	if (Object.keys(command.options).length === 0) return code`This command does not have any arguments.`;
+	return createComponent(MarkdownTable, { get data() {
+		return sortOptions(Object.values(command.options)).reduce(__assignType((ret, option) => {
+			ret.push({
+				name: option.name.trim(),
+				description: option.description.trim(),
+				defaultValue: isUndefined(option.default) ? "" : JSON.stringify(option.default),
+				required: !option.required || option.default ? "" : "✔"
+			});
+			return ret;
+		}, [
+			"ret",
+			"option",
+			"",
+			"P\"2!\"2\"\"/#"
+		]), []);
+	} });
+}
+CommandArgumentDocs.__type = [
+	() => __ΩCommandParametersDocsProps,
+	"props",
+	"CommandArgumentDocs",
+	"Generates the arguments markdown documentation for a command.",
+	"Pn!2\"\"/#?$"
+];
+/**
 * Generates the options markdown documentation for a command.
 */
 function CommandOptionsDocs(props) {
 	const { command } = props;
 	if (Object.keys(command.options).length === 0) return code`This command does not have any options.`;
 	return createComponent(MarkdownTable, { get data() {
-		return sortOptions(Object.values(command.options)).map(__assignType((option) => {
-			return {
+		return sortOptions(Object.values(command.options)).reduce(__assignType((ret, option) => {
+			ret.push({
 				name: option.name.trim(),
 				description: option.description.trim(),
-				defaultValue: option.default ? String(option.default)?.includes("\"") ? option.default : `\`${Array.isArray(option.default) ? option.default.join(", ") : option.default}\`` : "",
+				defaultValue: isUndefined(option.default) ? "" : JSON.stringify(option.default),
 				required: !option.required || option.default ? "" : "✔"
-			};
+			});
+			return ret;
 		}, [
+			"ret",
 			"option",
 			"",
-			"P\"2!\"/\""
-		]));
+			"P\"2!\"2\"\"/#"
+		]), []);
 	} });
 }
 CommandOptionsDocs.__type = [
-	() => __ΩCommandOptionsDocsProps,
+	() => __ΩCommandParametersDocsProps,
 	"props",
 	"CommandOptionsDocs",
 	"Generates the options markdown documentation for a command.",
@@ -74,18 +108,31 @@ const __ΩCommandDocsUsageExampleProps = [
 	"CommandTree",
 	"command",
 	"The command to generate the usage example for.",
+	"expand",
+	true,
+	"Whether to add expand/collapse details tags around the usage example. This is useful for hiding long usage examples by default.",
 	"CommandDocsUsageExampleProps",
-	"PP.!.\".#.$J4%8>&?'\"w(4)?*Mw+y"
+	"PP.!.\".#.$J4%8>&?'\"w(4)?*)4+8>,?-Mw.y"
 ];
 /**
 * Generates the markdown documentation for a command.
 */
 function CommandDocsUsageExample(props) {
-	const { packageManager = "npm", command } = props;
+	const { packageManager = "npm", command, expand = false } = props;
 	const context = (usePowerlines.Ω = [["Context", "\"w!"]], usePowerlines());
 	return [
-		createIntrinsic("hbr", {}),
-		code`\`\`\`bash `,
+		createComponent(Show, {
+			when: expand,
+			fallback: code`\`\`\`sh `,
+			get children() {
+				return [
+					code`<details>
+        <summary>Using ${packageManager}:</summary>`,
+					createComponent(Spacing, {}),
+					code`\`\`\`sh `
+				];
+			}
+		}),
 		createIntrinsic("hbr", {}),
 		createComponent(Usage, {
 			command,
@@ -95,8 +142,17 @@ function CommandDocsUsageExample(props) {
 			packageManager
 		}),
 		createIntrinsic("hbr", {}),
-		code`\`\`\``,
-		createIntrinsic("hbr", {})
+		createComponent(Show, {
+			when: expand,
+			fallback: code`\`\`\` `,
+			get children() {
+				return [
+					code`\`\`\``,
+					createComponent(Spacing, {}),
+					code`</details>`
+				];
+			}
+		})
 	];
 }
 CommandDocsUsageExample.__type = [
@@ -131,18 +187,40 @@ function CommandDocs(props) {
 		createComponent(Heading, {
 			level: 1 + levelOffset,
 			get children() {
-				return command.title;
+				return `${command.title}${command.tags.includes("deprecated") ? " (Deprecated)" : command.tags.includes("beta") ? " (Beta)" : command.tags.includes("alpha") ? " (Alpha)" : command.tags.includes("experimental") ? " (Experimental)" : ""}`;
 			}
 		}),
 		createComponent(Spacing, {}),
 		memo(() => code`${command.description}`),
+		createComponent(Show, {
+			get when() {
+				return command.alias && command.alias.length > 0;
+			},
+			get children() {
+				return [createComponent(Spacing, {}), createComponent(Show, {
+					get when() {
+						return command.alias.length > 1;
+					},
+					get fallback() {
+						return code`The \`${command.name}\` command can also be invoked using the alias \`${command.alias[0]}\`.`;
+					},
+					get children() {
+						return code`The \`${command.name}\` command can also be invoked using the following aliases: ${list(command.alias.map(__assignType((alias) => `\`${alias}\``, [
+							"alias",
+							"",
+							"P\"2!\"/\""
+						])), { conjunction: "or" })}.`;
+					}
+				})];
+			}
+		}),
 		createComponent(Spacing, {}),
 		createComponent(Heading, {
 			level: 2 + levelOffset,
 			children: "Usage"
 		}),
 		createComponent(Spacing, {}),
-		memo(() => code`The ${command.name} command can be executed using the following syntax: `),
+		memo(() => code`The \`${command.name}\` command can be executed using the following syntax: `),
 		createComponent(Spacing, {}),
 		createComponent(Show, {
 			get when() {
@@ -157,11 +235,14 @@ function CommandDocs(props) {
 			get children() {
 				return createComponent(For, {
 					each: usageExamples,
-					hardline: true,
+					doubleHardline: true,
 					get children() {
 						return __assignType((packageManager) => createComponent(CommandDocsUsageExample, {
 							packageManager,
-							command
+							command,
+							get expand() {
+								return usageExamples && usageExamples.length > 1;
+							}
 						}), [
 							"packageManager",
 							"",
@@ -172,12 +253,31 @@ function CommandDocs(props) {
 			}
 		}),
 		createComponent(Spacing, {}),
+		createComponent(Show, {
+			get when() {
+				return command.args.length > 0;
+			},
+			get children() {
+				return [
+					createComponent(Spacing, {}),
+					createComponent(Heading, {
+						level: 2 + levelOffset,
+						children: "Positional Arguments"
+					}),
+					createComponent(Spacing, {}),
+					memo(() => code`The following positional arguments are available for the \`${command.name}\` command:`),
+					createComponent(Spacing, {}),
+					createComponent(CommandArgumentDocs, { command }),
+					createComponent(Spacing, {})
+				];
+			}
+		}),
 		createComponent(Heading, {
 			level: 2 + levelOffset,
 			children: "Options"
 		}),
 		createComponent(Spacing, {}),
-		memo(() => code`The following options are available for the ${command.name} command:`),
+		memo(() => code`The following options are available for the \`${command.name}\` command:`),
 		createComponent(Spacing, {}),
 		createComponent(CommandOptionsDocs, { command }),
 		createComponent(Spacing, {})
@@ -253,5 +353,5 @@ CommandDocsFile.__type = [
 ];
 
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs, __ΩCommandDocsFileProps, __ΩCommandDocsProps, __ΩCommandDocsUsageExampleProps, __ΩCommandOptionsDocsProps };
+export { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs, __ΩCommandDocsFileProps, __ΩCommandDocsProps, __ΩCommandDocsUsageExampleProps, __ΩCommandParametersDocsProps };
 //# sourceMappingURL=docs.mjs.map

package/dist/components/index.cjs

@@ -12,6 +12,7 @@ exports.ArgsUtilities = require_components_state_builtin.ArgsUtilities;
 exports.ArgumentsParserLogic = require_components_options_parser_logic.ArgumentsParserLogic;
 exports.BooleanInputParserLogic = require_components_helpers.BooleanInputParserLogic;
 exports.ColorSupportUtilities = require_components_utils_builtin.ColorSupportUtilities;
+exports.CommandArgumentDocs = require_components_docs.CommandArgumentDocs;
 exports.CommandDocs = require_components_docs.CommandDocs;
 exports.CommandDocsFile = require_components_docs.CommandDocsFile;
 exports.CommandDocsUsageExample = require_components_docs.CommandDocsUsageExample;
@@ -45,7 +46,7 @@ exports.__ΩBooleanInputParserLogicProps = require_components_helpers.__ΩBoolea
 exports.__ΩCommandDocsFileProps = require_components_docs.__ΩCommandDocsFileProps;
 exports.__ΩCommandDocsProps = require_components_docs.__ΩCommandDocsProps;
 exports.__ΩCommandDocsUsageExampleProps = require_components_docs.__ΩCommandDocsUsageExampleProps;
-exports.__ΩCommandOptionsDocsProps = require_components_docs.__ΩCommandOptionsDocsProps;
+exports.__ΩCommandParametersDocsProps = require_components_docs.__ΩCommandParametersDocsProps;
 exports.__ΩCommandParserLogicProps = require_components_options_parser_logic.__ΩCommandParserLogicProps;
 exports.__ΩCommandValidationLogicProps = require_components_command_validation_logic.__ΩCommandValidationLogicProps;
 exports.__ΩDynamicSegmentsParserLogicProps = require_components_options_parser_logic.__ΩDynamicSegmentsParserLogicProps;

package/dist/components/index.d.cts

@@ -1,9 +1,9 @@
 import { CommandValidationLogic, CommandValidationLogicProps } from "./command-validation-logic.cjs";
-import { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps } from "./docs.cjs";
+import { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandParametersDocsProps } from "./docs.cjs";
 import { ExecBuiltin, ExecBuiltinProps } from "./exec-builtin.cjs";
 import { BooleanInputParserLogic, BooleanInputParserLogicProps, CommandParameterType, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose } from "./helpers.cjs";
 import { ArgumentsParserLogic, ArgumentsParserLogicProps, CommandParserLogic, CommandParserLogicProps, DynamicSegmentsParserLogic, DynamicSegmentsParserLogicProps, OptionsInterfaceDeclaration, OptionsMember, OptionsMemberParserCondition, OptionsMemberParserConditionProps, OptionsMemberParserLogic, OptionsMemberParserLogicProps, OptionsParserLogic, OptionsParserLogicProps } from "./options-parser-logic.cjs";
 import { ArgsUtilities, ContextUtilities, GlobalTypeDefinitions, StateBuiltin, StateBuiltinProps } from "./state-builtin.cjs";
 import { Usage, UsageProps } from "./usage.cjs";
 import { ColorSupportUtilities, EnvSupportUtilities, FindSuggestionsDeclaration, HyperlinkSupportUtilities, ResolveModuleFunctionDeclaration, TerminalSizeDeclaration, UtilsBuiltin, UtilsBuiltinProps } from "./utils-builtin.cjs";
-export { ArgsUtilities, ArgumentsParserLogic, ArgumentsParserLogicProps, BooleanInputParserLogic, BooleanInputParserLogicProps, ColorSupportUtilities, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps, CommandParameterType, CommandParserLogic, CommandParserLogicProps, CommandValidationLogic, CommandValidationLogicProps, ContextUtilities, DynamicSegmentsParserLogic, DynamicSegmentsParserLogicProps, EnvSupportUtilities, ExecBuiltin, ExecBuiltinProps, FindSuggestionsDeclaration, GlobalTypeDefinitions, HyperlinkSupportUtilities, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose, OptionsInterfaceDeclaration, OptionsMember, OptionsMemberParserCondition, OptionsMemberParserConditionProps, OptionsMemberParserLogic, OptionsMemberParserLogicProps, OptionsParserLogic, OptionsParserLogicProps, ResolveModuleFunctionDeclaration, StateBuiltin, StateBuiltinProps, TerminalSizeDeclaration, Usage, UsageProps, UtilsBuiltin, UtilsBuiltinProps };
+export { ArgsUtilities, ArgumentsParserLogic, ArgumentsParserLogicProps, BooleanInputParserLogic, BooleanInputParserLogicProps, ColorSupportUtilities, CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandParameterType, CommandParametersDocsProps, CommandParserLogic, CommandParserLogicProps, CommandValidationLogic, CommandValidationLogicProps, ContextUtilities, DynamicSegmentsParserLogic, DynamicSegmentsParserLogicProps, EnvSupportUtilities, ExecBuiltin, ExecBuiltinProps, FindSuggestionsDeclaration, GlobalTypeDefinitions, HyperlinkSupportUtilities, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose, OptionsInterfaceDeclaration, OptionsMember, OptionsMemberParserCondition, OptionsMemberParserConditionProps, OptionsMemberParserLogic, OptionsMemberParserLogicProps, OptionsParserLogic, OptionsParserLogicProps, ResolveModuleFunctionDeclaration, StateBuiltin, StateBuiltinProps, TerminalSizeDeclaration, Usage, UsageProps, UtilsBuiltin, UtilsBuiltinProps };

package/dist/components/index.d.mts

@@ -1,9 +1,9 @@
 import { CommandValidationLogic, CommandValidationLogicProps } from "./command-validation-logic.mjs";
-import { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps } from "./docs.mjs";
+import { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandParametersDocsProps } from "./docs.mjs";
 import { ExecBuiltin, ExecBuiltinProps } from "./exec-builtin.mjs";
 import { BooleanInputParserLogic, BooleanInputParserLogicProps, CommandParameterType, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose } from "./helpers.mjs";
 import { ArgumentsParserLogic, ArgumentsParserLogicProps, CommandParserLogic, CommandParserLogicProps, DynamicSegmentsParserLogic, DynamicSegmentsParserLogicProps, OptionsInterfaceDeclaration, OptionsMember, OptionsMemberParserCondition, OptionsMemberParserConditionProps, OptionsMemberParserLogic, OptionsMemberParserLogicProps, OptionsParserLogic, OptionsParserLogicProps } from "./options-parser-logic.mjs";
 import { ArgsUtilities, ContextUtilities, GlobalTypeDefinitions, StateBuiltin, StateBuiltinProps } from "./state-builtin.mjs";
 import { Usage, UsageProps } from "./usage.mjs";
 import { ColorSupportUtilities, EnvSupportUtilities, FindSuggestionsDeclaration, HyperlinkSupportUtilities, ResolveModuleFunctionDeclaration, TerminalSizeDeclaration, UtilsBuiltin, UtilsBuiltinProps } from "./utils-builtin.mjs";
-export { ArgsUtilities, ArgumentsParserLogic, ArgumentsParserLogicProps, BooleanInputParserLogic, BooleanInputParserLogicProps, ColorSupportUtilities, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps, CommandParameterType, CommandParserLogic, CommandParserLogicProps, CommandValidationLogic, CommandValidationLogicProps, ContextUtilities, DynamicSegmentsParserLogic, DynamicSegmentsParserLogicProps, EnvSupportUtilities, ExecBuiltin, ExecBuiltinProps, FindSuggestionsDeclaration, GlobalTypeDefinitions, HyperlinkSupportUtilities, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose, OptionsInterfaceDeclaration, OptionsMember, OptionsMemberParserCondition, OptionsMemberParserConditionProps, OptionsMemberParserLogic, OptionsMemberParserLogicProps, OptionsParserLogic, OptionsParserLogicProps, ResolveModuleFunctionDeclaration, StateBuiltin, StateBuiltinProps, TerminalSizeDeclaration, Usage, UsageProps, UtilsBuiltin, UtilsBuiltinProps };
+export { ArgsUtilities, ArgumentsParserLogic, ArgumentsParserLogicProps, BooleanInputParserLogic, BooleanInputParserLogicProps, ColorSupportUtilities, CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandParameterType, CommandParametersDocsProps, CommandParserLogic, CommandParserLogicProps, CommandValidationLogic, CommandValidationLogicProps, ContextUtilities, DynamicSegmentsParserLogic, DynamicSegmentsParserLogicProps, EnvSupportUtilities, ExecBuiltin, ExecBuiltinProps, FindSuggestionsDeclaration, GlobalTypeDefinitions, HyperlinkSupportUtilities, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose, OptionsInterfaceDeclaration, OptionsMember, OptionsMemberParserCondition, OptionsMemberParserConditionProps, OptionsMemberParserLogic, OptionsMemberParserLogicProps, OptionsParserLogic, OptionsParserLogicProps, ResolveModuleFunctionDeclaration, StateBuiltin, StateBuiltinProps, TerminalSizeDeclaration, Usage, UsageProps, UtilsBuiltin, UtilsBuiltinProps };