@shell-shock/core 0.17.17 → 0.17.18

package/dist/components/docs.cjs

@@ -13,6 +13,7 @@ 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_type_checks_is_undefined = require("@stryke/type-checks/is-undefined");
 
 //#region src/components/docs.tsx
 const __ΩRequired = [
@@ -43,18 +44,20 @@ 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 = [
@@ -75,18 +78,26 @@ 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 = true } = 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`\`\`\`bash `,
+			children: _alloy_js_core.code`<details>
+        <summary>Using ${packageManager}</summary>
+        \`\`\`bash `
+		}),
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(require_components_usage.Usage, {
 			command,
@@ -96,7 +107,12 @@ function CommandDocsUsageExample(props) {
 			packageManager
 		}),
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-		_alloy_js_core.code`\`\`\``,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
+			when: expand,
+			fallback: _alloy_js_core.code`\`\`\` `,
+			children: _alloy_js_core.code`\`\`\`
+        </details> `
+		}),
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
 	];
 }

package/dist/components/docs.d.cts

@@ -26,6 +26,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 true
+   */
+  expand?: boolean;
 }
 /**
  * Generates the markdown documentation for a command.

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":";;;;UAoCiB,uBAAA;;AAAjB;;EAIE,OAAA,EAAS,WAAW;AAAA;AAAA;AAMtB;;AANsB,iBAMN,kBAAA,CAAmB,KAAA,EAAO,uBAAuB,4BAAA,QAAA;AAAA,UAgChD,4BAAA;EAhCyB;;;;AAAuB;AAgCjE;;;EASE,cAAA;EAAA;;;EAKA,OAAA,EAAS,WAAW;EAOd;AAAA;AAMR;;;EANE,MAAA;AAAA;;;;iBAMc,uBAAA,CAAwB,KAAA,EAAO,4BAA4B,4BAAA,QAAA;AAAA,UA4B1D,gBAAA;EAAgB;;;;;;;;EAS/B,WAAA;EAKS;;;EAAT,OAAA,EAAS,WAAA;EAO4C;AAAA;AAMvD;;;EANE,aAAA,GAAgB,QAAA,CAAS,4BAAA;AAAA;;;;iBAMX,WAAA,CAAY,KAAA,EAAO,gBAAgB,4BAAA,QAAA;AAAA,UAwClC,oBAAA,SAA6B,OAAA,CAAQ,iBAAA;EAAhB;;;;;;;;EASpC,WAAA;EAAA;;;EAKA,OAAA,EAAS,WAAA;AAAA;AAMX;;;AAAA,iBAAgB,eAAA,CAAgB,KAAA,EAAO,oBAAoB,4BAAA,QAAA"}

package/dist/components/docs.d.mts

@@ -26,6 +26,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 true
+   */
+  expand?: boolean;
 }
 /**
  * Generates the markdown documentation for a command.

package/dist/components/docs.mjs

@@ -12,6 +12,7 @@ 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 { isUndefined } from "@stryke/type-checks/is-undefined";
 
 //#region src/components/docs.tsx
 const __ΩRequired = [
@@ -42,18 +43,20 @@ 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 = [
@@ -74,18 +77,26 @@ 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 = true } = props;
 	const context = (usePowerlines.Ω = [["Context", "\"w!"]], usePowerlines());
 	return [
-		createIntrinsic("hbr", {}),
-		code`\`\`\`bash `,
+		createComponent(Show, {
+			when: expand,
+			fallback: code`\`\`\`bash `,
+			children: code`<details>
+        <summary>Using ${packageManager}</summary>
+        \`\`\`bash `
+		}),
 		createIntrinsic("hbr", {}),
 		createComponent(Usage, {
 			command,
@@ -95,7 +106,12 @@ function CommandDocsUsageExample(props) {
 			packageManager
 		}),
 		createIntrinsic("hbr", {}),
-		code`\`\`\``,
+		createComponent(Show, {
+			when: expand,
+			fallback: code`\`\`\` `,
+			children: code`\`\`\`
+        </details> `
+		}),
 		createIntrinsic("hbr", {})
 	];
 }

package/dist/components/usage.cjs

@@ -54,11 +54,11 @@ function Usage(props) {
 			"segment",
 			"",
 			"P\"2!\"/\""
-		])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " [commands]" : ""}${command.args.length > 0 ? ` ${command.args.map(__assignType((param) => `<${(0, _stryke_string_format_snake_case.snakeCase)(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
+		])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " <commands>" : ""}${command.args.length > 0 ? command.args.map(__assignType((param) => `<${(0, _stryke_string_format_snake_case.snakeCase)(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
 			"param",
 			"",
 			"P\"2!\"/\""
-		])).join(" ")}` : ""} [options]`),
+		])).join(" ") : ""} [options]`),
 		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
 			get when() {
 				return command.args.length > 0;
@@ -66,7 +66,9 @@ function Usage(props) {
 			get children() {
 				return [
 					(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-					_alloy_js_core.code`$ `,
+					(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					_alloy_js_core.code`# or with options before arguments: `,
+					(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 					(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Switch, { get children() {
 						return [
 							(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Match, {
@@ -91,11 +93,11 @@ function Usage(props) {
 						"segment",
 						"",
 						"P\"2!\"/\""
-					])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " [commands]" : ""} [options] ${command.args.length > 0 ? ` ${command.args.map(__assignType((param) => `<${(0, _stryke_string_format_snake_case.snakeCase)(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
+					])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " <commands>" : ""} [options] ${command.args.length > 0 ? command.args.map(__assignType((param) => `<${(0, _stryke_string_format_snake_case.snakeCase)(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
 						"param",
 						"",
 						"P\"2!\"/\""
-					])).join(" ")}` : ""}`)
+					])).join(" ") : ""}`)
 				];
 			}
 		})

package/dist/components/usage.mjs

@@ -53,11 +53,11 @@ function Usage(props) {
 			"segment",
 			"",
 			"P\"2!\"/\""
-		])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " [commands]" : ""}${command.args.length > 0 ? ` ${command.args.map(__assignType((param) => `<${snakeCase(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
+		])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " <commands>" : ""}${command.args.length > 0 ? command.args.map(__assignType((param) => `<${snakeCase(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
 			"param",
 			"",
 			"P\"2!\"/\""
-		])).join(" ")}` : ""} [options]`),
+		])).join(" ") : ""} [options]`),
 		createComponent(Show, {
 			get when() {
 				return command.args.length > 0;
@@ -65,7 +65,9 @@ function Usage(props) {
 			get children() {
 				return [
 					createIntrinsic("hbr", {}),
-					code`$ `,
+					createIntrinsic("hbr", {}),
+					code`# or with options before arguments: `,
+					createIntrinsic("hbr", {}),
 					createComponent(Switch, { get children() {
 						return [
 							createComponent(Match, {
@@ -90,11 +92,11 @@ function Usage(props) {
 						"segment",
 						"",
 						"P\"2!\"/\""
-					])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " [commands]" : ""} [options] ${command.args.length > 0 ? ` ${command.args.map(__assignType((param) => `<${snakeCase(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
+					])).join(" ")}` : ""}${Object.values(command.children).length > 0 ? " <commands>" : ""} [options] ${command.args.length > 0 ? command.args.map(__assignType((param) => `<${snakeCase(param.name)}${(param.type === "string" || param.type === "number") && param.variadic ? "..." : ""}>`, [
 						"param",
 						"",
 						"P\"2!\"/\""
-					])).join(" ")}` : ""}`)
+					])).join(" ") : ""}`)
 				];
 			}
 		})

package/dist/package.cjs

@@ -1,6 +1,6 @@
 
 //#region package.json
-var version = "0.17.16";
+var version = "0.17.17";
 
 //#endregion
 Object.defineProperty(exports, 'version', {

package/dist/package.mjs

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "0.17.16";
+var version = "0.17.17";
 
 //#endregion
 export { version };

package/dist/plugin-utils/reflect.cjs

@@ -8,11 +8,12 @@ function __assignType(fn, args) {
 * Sort command options alphabetically by name, placing boolean options with negatives appropriately.
 *
 * @param options - The array of command options to sort.
+* @param skipNegatives - Whether to skip negative options when sorting (default: true).
 * @returns A new array of sorted command options.
 */
-function sortOptions(options) {
+function sortOptions(options, skipNegatives = true) {
 	if (!options || options.length === 0) return [];
-	return options.filter(__assignType((arg) => arg.type !== "boolean" || arg.variadic || !arg.isNegativeOf, [
+	return options.filter(__assignType((arg) => arg.type !== "boolean" || arg.variadic || !skipNegatives || !arg.isNegativeOf, [
 		"arg",
 		"",
 		"P\"2!\"/\""
@@ -42,9 +43,10 @@ function sortOptions(options) {
 sortOptions.__type = [
 	"CommandOption",
 	"options",
+	"skipNegatives",
 	"sortOptions",
 	"Sort command options alphabetically by name, placing boolean options with negatives appropriately.",
-	"P\"w!F2\"\"w!F/#?$"
+	"P\"w!F2\"\"2#\"w!F/$?%"
 ];
 
 //#endregion

package/dist/plugin-utils/reflect.d.cts

@@ -5,9 +5,10 @@ import { CommandOption } from "../types/command.cjs";
  * Sort command options alphabetically by name, placing boolean options with negatives appropriately.
  *
  * @param options - The array of command options to sort.
+ * @param skipNegatives - Whether to skip negative options when sorting (default: true).
  * @returns A new array of sorted command options.
  */
-declare function sortOptions(options: CommandOption[]): CommandOption[];
+declare function sortOptions(options: CommandOption[], skipNegatives?: boolean): CommandOption[];
 //#endregion
 export { sortOptions };
 //# sourceMappingURL=reflect.d.cts.map

package/dist/plugin-utils/reflect.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"reflect.d.cts","names":[],"sources":["../../src/plugin-utils/reflect.ts"],"mappings":";;;;;AA0BA;;;;iBAAgB,WAAA,CAAY,OAAA,EAAS,aAAA,KAAkB,aAAa"}
+{"version":3,"file":"reflect.d.cts","names":[],"sources":["../../src/plugin-utils/reflect.ts"],"mappings":";;;;;AA2BA;;;;;iBAAgB,WAAA,CACd,OAAA,EAAS,aAAA,IACT,aAAA,aACC,aAAa"}

package/dist/plugin-utils/reflect.d.mts

@@ -5,9 +5,10 @@ import { CommandOption } from "../types/command.mjs";
  * Sort command options alphabetically by name, placing boolean options with negatives appropriately.
  *
  * @param options - The array of command options to sort.
+ * @param skipNegatives - Whether to skip negative options when sorting (default: true).
  * @returns A new array of sorted command options.
  */
-declare function sortOptions(options: CommandOption[]): CommandOption[];
+declare function sortOptions(options: CommandOption[], skipNegatives?: boolean): CommandOption[];
 //#endregion
 export { sortOptions };
 //# sourceMappingURL=reflect.d.mts.map

package/dist/plugin-utils/reflect.mjs

@@ -7,11 +7,12 @@ function __assignType(fn, args) {
 * Sort command options alphabetically by name, placing boolean options with negatives appropriately.
 *
 * @param options - The array of command options to sort.
+* @param skipNegatives - Whether to skip negative options when sorting (default: true).
 * @returns A new array of sorted command options.
 */
-function sortOptions(options) {
+function sortOptions(options, skipNegatives = true) {
 	if (!options || options.length === 0) return [];
-	return options.filter(__assignType((arg) => arg.type !== "boolean" || arg.variadic || !arg.isNegativeOf, [
+	return options.filter(__assignType((arg) => arg.type !== "boolean" || arg.variadic || !skipNegatives || !arg.isNegativeOf, [
 		"arg",
 		"",
 		"P\"2!\"/\""
@@ -41,9 +42,10 @@ function sortOptions(options) {
 sortOptions.__type = [
 	"CommandOption",
 	"options",
+	"skipNegatives",
 	"sortOptions",
 	"Sort command options alphabetically by name, placing boolean options with negatives appropriately.",
-	"P\"w!F2\"\"w!F/#?$"
+	"P\"w!F2\"\"2#\"w!F/$?%"
 ];
 
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shell-shock/core",
-  "version": "0.17.17",
+  "version": "0.17.18",
   "private": false,
   "description": "A package containing the core Shell Shock functionality used to build and manage a command-line application.",
   "keywords": ["shell-shock", "powerlines", "storm-software"],
@@ -407,5 +407,5 @@
     "typescript": "^6.0.3"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "8c9f000d243ed0b6ac67b2be112429ddeccd0617"
+  "gitHead": "4ca0ac0ff9ada03aea6667c89a04b54dc73ff40b"
 }