@shell-shock/core 0.17.22 → 0.17.23

package/dist/components/docs.mjs

@@ -1,357 +1,3 @@
-import { CommandContext } from "../contexts/command.mjs";
-import { getDocsOutputPath } from "../helpers/docs-helpers.mjs";
-import { getAppBin } from "../plugin-utils/context-helpers.mjs";
-import { sortOptions } from "../plugin-utils/reflect.mjs";
-import { Usage } from "./usage.mjs";
-import { createComponent, createIntrinsic, memo, mergeProps } from "@alloy-js/core/jsx-runtime";
-import { For, Show, code, memo as memo$1 } from "@alloy-js/core";
-import { defu } from "defu";
-import { Heading } from "@alloy-js/markdown";
-import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
-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";
+import { a as CommandOptionsDocs, i as CommandDocsUsageExample, n as CommandDocs, r as CommandDocsFile, t as CommandArgumentDocs } from "../docs-CGQ2HtEY.mjs";
 
-//#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 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)).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\"\"/#"
-		]), []);
-	} });
-}
-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 = (usePowerlines.Ω = [["Context", "\"w!"]], usePowerlines());
-	return [
-		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,
-			get bin() {
-				return getAppBin(context);
-			},
-			packageManager
-		}),
-		createIntrinsic("hbr", {}),
-		createComponent(Show, {
-			when: expand,
-			fallback: code`\`\`\` `,
-			get children() {
-				return [
-					code`\`\`\``,
-					createComponent(Spacing, {}),
-					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 [
-		createComponent(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)" : ""}`;
-			}
-		}),
-		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: `),
-		createComponent(Spacing, {}),
-		createComponent(Show, {
-			get when() {
-				return usageExamples && usageExamples.length > 0;
-			},
-			get fallback() {
-				return createComponent(CommandDocsUsageExample, {
-					packageManager: "npm",
-					command
-				});
-			},
-			get children() {
-				return createComponent(For, {
-					each: usageExamples,
-					doubleHardline: true,
-					get children() {
-						return __assignType((packageManager) => createComponent(CommandDocsUsageExample, {
-							packageManager,
-							command,
-							get expand() {
-								return usageExamples && usageExamples.length > 1;
-							}
-						}), [
-							"packageManager",
-							"",
-							"P\"2!\"/\""
-						]);
-					}
-				});
-			}
-		}),
-		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:`),
-		createComponent(Spacing, {}),
-		createComponent(CommandOptionsDocs, { command }),
-		createComponent(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 = (usePowerlines.Ω = [["Context", "\"w!"]], usePowerlines());
-	const usageExamples = memo$1(() => [
-		"npm",
-		"yarn",
-		"pnpm",
-		"bun"
-	]);
-	return createComponent(CommandContext.Provider, {
-		value: command,
-		get children() {
-			return createComponent(MarkdownFile, mergeProps({ get path() {
-				return joinPaths(getDocsOutputPath(context), `${command.path}.md`);
-			} }, rest, {
-				get frontMatter() {
-					return 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 createComponent(CommandDocs, {
-						levelOffset,
-						command,
-						get usageExamples() {
-							return usageExamples();
-						}
-					});
-				}
-			}));
-		}
-	});
-}
-CommandDocsFile.__type = [
-	() => __ΩCommandDocsFileProps,
-	"props",
-	"CommandDocsFile",
-	"Generates the markdown documentation file for a command.",
-	"Pn!2\"\"/#?$"
-];
-
-//#endregion
-export { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs, __ΩCommandDocsFileProps, __ΩCommandDocsProps, __ΩCommandDocsUsageExampleProps, __ΩCommandParametersDocsProps };
-//# sourceMappingURL=docs.mjs.map
+export { CommandArgumentDocs, CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs };