@shell-shock/core 0.17.22 → 0.17.24

package/dist/components/docs.cjs

@@ -1,366 +1,8 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_contexts_command = require('../contexts/command.cjs');
-const require_docs_helpers = require('../helpers/docs-helpers.cjs');
-const require_context_helpers = require('../plugin-utils/context-helpers.cjs');
-const require_reflect = require('../plugin-utils/reflect.cjs');
-const require_components_usage = require('./usage.cjs');
-let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
-let _alloy_js_core = require("@alloy-js/core");
-let defu = require("defu");
-let _alloy_js_markdown = require("@alloy-js/markdown");
-let _powerlines_plugin_alloy_core_components_spacing = require("@powerlines/plugin-alloy/core/components/spacing");
-let _powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
-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");
+const require_docs = require('../docs-C6ZvsVMu.cjs');
 
-//#region src/components/docs.tsx
-const __ΩRequired = [
-	"T",
-	"Required",
-	"l+e#!e\"!fRb!Pde\"!gN##w\"y"
-];
-const __ΩPartial = [
-	"T",
-	"Partial",
-	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
-];
-function __assignType(fn, args) {
-	fn.__type = args;
-	return fn;
-}
-const __ΩCommandParametersDocsProps = [
-	"CommandTree",
-	"command",
-	"The command to generate options documentation for.",
-	"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)).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\"\"/#"
-		]), []);
-	} });
-}
-CommandOptionsDocs.__type = [
-	() => __ΩCommandParametersDocsProps,
-	"props",
-	"CommandOptionsDocs",
-	"Generates the options markdown documentation for a command.",
-	"Pn!2\"\"/#?$"
-];
-const __ΩCommandDocsUsageExampleProps = [
-	"npm",
-	"yarn",
-	"pnpm",
-	"bun",
-	"packageManager",
-	"npm",
-	"The package manager to generate the usage example for.",
-	"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)?*)4+8>,?-Mw.y"
-];
-/**
-* Generates the markdown documentation for a command.
-*/
-function CommandDocsUsageExample(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.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,
-			get bin() {
-				return require_context_helpers.getAppBin(context);
-			},
-			packageManager
-		}),
-		(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 = [
-	() => __ΩCommandDocsUsageExampleProps,
-	"props",
-	"CommandDocsUsageExample",
-	"Generates the markdown documentation for a command.",
-	"Pn!2\"\"/#?$"
-];
-const __ΩCommandDocsProps = [
-	"levelOffset",
-	0,
-	"The heading level offset to apply to the generated documentation.",
-	"CommandTree",
-	"command",
-	"The command to generate options documentation for.",
-	() => __ΩRequired,
-	() => __ΩCommandDocsUsageExampleProps,
-	"packageManager",
-	"usageExamples",
-	"`[\"npm\"]`",
-	"Optional usage examples to include in the documentation.",
-	"CommandDocsProps",
-	"P'4!8>\"?#\"w$4%?&n(o'\".)fF4*8>+?,Mw-y"
-];
-/**
-* Generates the markdown documentation for a command.
-*/
-function CommandDocs(props) {
-	const { levelOffset = 0, command, usageExamples } = props;
-	return [
-		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_markdown.Heading, {
-			level: 1 + levelOffset,
-			get children() {
-				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.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.Show, {
-			get when() {
-				return usageExamples && usageExamples.length > 0;
-			},
-			get fallback() {
-				return (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
-					packageManager: "npm",
-					command
-				});
-			},
-			get children() {
-				return (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
-					each: usageExamples,
-					doubleHardline: true,
-					get children() {
-						return __assignType((packageManager) => (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
-							packageManager,
-							command,
-							get expand() {
-								return usageExamples && usageExamples.length > 1;
-							}
-						}), [
-							"packageManager",
-							"",
-							"P\"2!\"/\""
-						]);
-					}
-				});
-			}
-		}),
-		(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.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, {})
-	];
-}
-CommandDocs.__type = [
-	() => __ΩCommandDocsProps,
-	"props",
-	"CommandDocs",
-	"Generates the markdown documentation for a command.",
-	"Pn!2\"\"/#?$"
-];
-const __ΩCommandDocsFileProps = [
-	() => __ΩPartial,
-	"levelOffset",
-	0,
-	"The heading level offset to apply to the generated documentation.",
-	"CommandTree",
-	"command",
-	"The command to generate documentation for.",
-	"CommandDocsFileProps",
-	"P!o!\"'4\"8>#?$\"w%4&?'Mw(y"
-];
-/**
-* Generates the markdown documentation file for a command.
-*/
-function CommandDocsFile(props) {
-	const { levelOffset = 0, command, frontMatter, ...rest } = props;
-	const context = (_powerlines_plugin_alloy_core_contexts_context.usePowerlines.Ω = [["Context", "\"w!"]], (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)());
-	const usageExamples = (0, _alloy_js_core.memo)(() => [
-		"npm",
-		"yarn",
-		"pnpm",
-		"bun"
-	]);
-	return (0, _alloy_js_core_jsx_runtime.createComponent)(require_contexts_command.CommandContext.Provider, {
-		value: command,
-		get children() {
-			return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_markdown_components_markdown_file.MarkdownFile, (0, _alloy_js_core_jsx_runtime.mergeProps)({ get path() {
-				return (0, _stryke_path_join.joinPaths)(require_docs_helpers.getDocsOutputPath(context), `${command.path}.md`);
-			} }, rest, {
-				get frontMatter() {
-					return (0, defu.defu)(frontMatter ?? {}, {
-						id: command.id,
-						name: command.name,
-						path: command.path,
-						reference: command.docs,
-						virtual: command.virtual,
-						title: command.title,
-						description: command.description,
-						tags: command.tags
-					});
-				},
-				get children() {
-					return (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocs, {
-						levelOffset,
-						command,
-						get usageExamples() {
-							return usageExamples();
-						}
-					});
-				}
-			}));
-		}
-	});
-}
-CommandDocsFile.__type = [
-	() => __ΩCommandDocsFileProps,
-	"props",
-	"CommandDocsFile",
-	"Generates the markdown documentation file for a command.",
-	"Pn!2\"\"/#?$"
-];
-
-//#endregion
-exports.CommandArgumentDocs = CommandArgumentDocs;
-exports.CommandDocs = CommandDocs;
-exports.CommandDocsFile = CommandDocsFile;
-exports.CommandDocsUsageExample = CommandDocsUsageExample;
-exports.CommandOptionsDocs = CommandOptionsDocs;
-exports.__ΩCommandDocsFileProps = __ΩCommandDocsFileProps;
-exports.__ΩCommandDocsProps = __ΩCommandDocsProps;
-exports.__ΩCommandDocsUsageExampleProps = __ΩCommandDocsUsageExampleProps;
-exports.__ΩCommandParametersDocsProps = __ΩCommandParametersDocsProps;
-//# sourceMappingURL=docs.cjs.map
+exports.CommandArgumentDocs = require_docs.CommandArgumentDocs;
+exports.CommandDocs = require_docs.CommandDocs;
+exports.CommandDocsFile = require_docs.CommandDocsFile;
+exports.CommandDocsUsageExample = require_docs.CommandDocsUsageExample;
+exports.CommandOptionsDocs = require_docs.CommandOptionsDocs;

package/dist/components/docs.d.cts

@@ -1,6 +1,5 @@
-import { CommandTree } from "../types/command.cjs";
-import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
-
+import { S as CommandTree } from "../command-CtfR7hKM.cjs";
+import { MarkdownFileProps } from "@power-plant/alloy-js/markdown/components/markdown-file";
 //#region src/components/docs.d.ts
 interface CommandParametersDocsProps {
   /**

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"docs.d.cts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":";;;UAqCiB;;;;EAIf,SAAS;;;;;iBAMK,oBAAoB,OAAO,sDAA0B;;;;iBAmCrD,mBAAmB,OAAO,sDAA0B;UAgCnD;;;;;;;;;EASf;;;;EAKA,SAAS;;;;;;EAOT;;;;;iBAMc,wBAAwB,OAAO,wDAA4B;UA6B1D;;;;;;;;;EASf;;;;EAKA,SAAS;;;;;;EAOT,gBAAgB,SAAS;;;;;iBAMX,YAAY,OAAO,4CAAgB;UAyElC,6BAA6B,QAAQ;;;;;;;;;EASpD;;;;EAKA,SAAS;;;;;iBAMK,gBAAgB,OAAO,gDAAoB"}

package/dist/components/docs.d.mts

@@ -1,6 +1,5 @@
-import { CommandTree } from "../types/command.mjs";
-import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
-
+import { S as CommandTree } from "../command-B6KYexlV.mjs";
+import { MarkdownFileProps } from "@power-plant/alloy-js/markdown/components/markdown-file";
 //#region src/components/docs.d.ts
 interface CommandParametersDocsProps {
   /**