@shell-shock/core 0.17.5 → 0.17.7

package/dist/components/docs.cjs

@@ -16,6 +16,27 @@ let _powerlines_plugin_alloy_markdown_components_markdown_table = require("@powe
 let _stryke_path_join = require("@stryke/path/join");
 
 //#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 __ΩCommandOptionsDocsProps = [
+	"CommandTree",
+	"command",
+	"The command to generate options documentation for.",
+	"CommandOptionsDocsProps",
+	"P\"w!4\"?#Mw$y"
+];
 /**
 * Generates the options markdown documentation for a command.
 */
@@ -23,22 +44,47 @@ 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((option) => {
+		return require_reflect.sortOptions(Object.values(command.options)).map(__assignType((option) => {
 			return {
 				name: option.name.trim(),
 				description: option.description.trim(),
 				defaultValue: option.default ? String(option.default)?.includes("\"") ? option.default : `\`${option.default}\`` : "",
 				required: option.optional || option.default ? "" : "✔"
 			};
-		});
+		}, [
+			"option",
+			"",
+			"P\"2!\"/\""
+		]));
 	} });
 }
+CommandOptionsDocs.__type = [
+	() => __ΩCommandOptionsDocsProps,
+	"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.",
+	"CommandDocsUsageExampleProps",
+	"PP.!.\".#.$J4%8>&?'\"w(4)?*Mw+y"
+];
 /**
 * Generates the markdown documentation for a command.
 */
 function CommandDocsUsageExample(props) {
 	const { packageManager = "npm", command } = props;
-	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	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 `,
@@ -55,6 +101,29 @@ function CommandDocsUsageExample(props) {
 		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
 	];
 }
+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.
 */
@@ -91,10 +160,16 @@ function CommandDocs(props) {
 				return (0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_core.For, {
 					each: usageExamples,
 					hardline: true,
-					children: (packageManager) => (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
-						packageManager,
-						command
-					})
+					get children() {
+						return __assignType((packageManager) => (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
+							packageManager,
+							command
+						}), [
+							"packageManager",
+							"",
+							"P\"2!\"/\""
+						]);
+					}
 				});
 			}
 		}),
@@ -110,12 +185,30 @@ function CommandDocs(props) {
 		(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 = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	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",
@@ -153,9 +246,20 @@ function CommandDocsFile(props) {
 		}
 	});
 }
+CommandDocsFile.__type = [
+	() => __ΩCommandDocsFileProps,
+	"props",
+	"CommandDocsFile",
+	"Generates the markdown documentation file for a command.",
+	"Pn!2\"\"/#?$"
+];
 
 //#endregion
 exports.CommandDocs = CommandDocs;
 exports.CommandDocsFile = CommandDocsFile;
 exports.CommandDocsUsageExample = CommandDocsUsageExample;
-exports.CommandOptionsDocs = CommandOptionsDocs;
+exports.CommandOptionsDocs = CommandOptionsDocs;
+exports.__ΩCommandDocsFileProps = __ΩCommandDocsFileProps;
+exports.__ΩCommandDocsProps = __ΩCommandDocsProps;
+exports.__ΩCommandDocsUsageExampleProps = __ΩCommandDocsUsageExampleProps;
+exports.__ΩCommandOptionsDocsProps = __ΩCommandOptionsDocsProps;

package/dist/components/docs.mjs

@@ -14,6 +14,27 @@ import { MarkdownTable } from "@powerlines/plugin-alloy/markdown/components/mark
 import { joinPaths } from "@stryke/path/join";
 
 //#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 __ΩCommandOptionsDocsProps = [
+	"CommandTree",
+	"command",
+	"The command to generate options documentation for.",
+	"CommandOptionsDocsProps",
+	"P\"w!4\"?#Mw$y"
+];
 /**
 * Generates the options markdown documentation for a command.
 */
@@ -21,22 +42,47 @@ 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((option) => {
+		return sortOptions(Object.values(command.options)).map(__assignType((option) => {
 			return {
 				name: option.name.trim(),
 				description: option.description.trim(),
 				defaultValue: option.default ? String(option.default)?.includes("\"") ? option.default : `\`${option.default}\`` : "",
 				required: option.optional || option.default ? "" : "✔"
 			};
-		});
+		}, [
+			"option",
+			"",
+			"P\"2!\"/\""
+		]));
 	} });
 }
+CommandOptionsDocs.__type = [
+	() => __ΩCommandOptionsDocsProps,
+	"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.",
+	"CommandDocsUsageExampleProps",
+	"PP.!.\".#.$J4%8>&?'\"w(4)?*Mw+y"
+];
 /**
 * Generates the markdown documentation for a command.
 */
 function CommandDocsUsageExample(props) {
 	const { packageManager = "npm", command } = props;
-	const context = usePowerlines();
+	const context = (usePowerlines.Ω = [["Context", "\"w!"]], usePowerlines());
 	return [
 		createIntrinsic("hbr", {}),
 		code`\`\`\`bash `,
@@ -53,6 +99,29 @@ function CommandDocsUsageExample(props) {
 		createIntrinsic("hbr", {})
 	];
 }
+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.
 */
@@ -89,10 +158,16 @@ function CommandDocs(props) {
 				return createComponent(For, {
 					each: usageExamples,
 					hardline: true,
-					children: (packageManager) => createComponent(CommandDocsUsageExample, {
-						packageManager,
-						command
-					})
+					get children() {
+						return __assignType((packageManager) => createComponent(CommandDocsUsageExample, {
+							packageManager,
+							command
+						}), [
+							"packageManager",
+							"",
+							"P\"2!\"/\""
+						]);
+					}
 				});
 			}
 		}),
@@ -108,12 +183,30 @@ function CommandDocs(props) {
 		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();
+	const context = (usePowerlines.Ω = [["Context", "\"w!"]], usePowerlines());
 	const usageExamples = memo$1(() => [
 		"npm",
 		"yarn",
@@ -151,7 +244,14 @@ function CommandDocsFile(props) {
 		}
 	});
 }
+CommandDocsFile.__type = [
+	() => __ΩCommandDocsFileProps,
+	"props",
+	"CommandDocsFile",
+	"Generates the markdown documentation file for a command.",
+	"Pn!2\"\"/#?$"
+];
 
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs };
+export { CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs, __ΩCommandDocsFileProps, __ΩCommandDocsProps, __ΩCommandDocsUsageExampleProps, __ΩCommandOptionsDocsProps };
 //# sourceMappingURL=docs.mjs.map

package/dist/components/docs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"docs.mjs","names":[],"sources":["../../src/components/docs.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 { code, For, memo, Show } from \"@alloy-js/core\";\nimport { Heading } from \"@alloy-js/markdown\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { MarkdownFileProps } from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownFile } from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownTable } from \"@powerlines/plugin-alloy/markdown/components/markdown-table\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { defu } from \"defu\";\nimport { CommandContext } from \"../contexts/command\";\nimport { getDocsOutputPath } from \"../helpers/docs-helpers\";\nimport { getAppBin } from \"../plugin-utils/context-helpers\";\nimport { sortOptions } from \"../plugin-utils/reflect\";\nimport type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport { Usage } from \"./usage\";\n\nexport interface CommandOptionsDocsProps {\n  /**\n   * The command to generate options documentation for.\n   */\n  command: CommandTree;\n}\n\n/**\n * Generates the options markdown documentation for a command.\n */\nexport function CommandOptionsDocs(props: CommandOptionsDocsProps) {\n  const { command } = props;\n  if (Object.keys(command.options).length === 0) {\n    return code`This command does not have any options.`;\n  }\n\n  return (\n    <MarkdownTable\n      data={sortOptions(Object.values(command.options)).map(option => {\n        return {\n          name: option.name.trim(),\n          description: option.description.trim(),\n          defaultValue: option.default\n            ? String(option.default)?.includes('\"')\n              ? option.default\n              : `\\`${option.default}\\``\n            : \"\",\n          required: option.optional || option.default ? \"\" : \"✔\"\n        };\n      })}\n    />\n  );\n}\n\nexport interface CommandDocsUsageExampleProps {\n  /**\n   * The package manager to generate the usage example for.\n   *\n   * @remarks\n   * If not specified, examples for all supported package managers will be generated.\n   *\n   * @defaultValue \"npm\"\n   */\n  packageManager?: \"npm\" | \"yarn\" | \"pnpm\" | \"bun\";\n\n  /**\n   * The command to generate the usage example for.\n   */\n  command: CommandTree;\n}\n\n/**\n * Generates the markdown documentation for a command.\n */\nexport function CommandDocsUsageExample(props: CommandDocsUsageExampleProps) {\n  const { packageManager = \"npm\", command } = props;\n\n  const context = usePowerlines<Context>();\n\n  return (\n    <>\n      <hbr />\n      {code`\\`\\`\\`bash `}\n      <hbr />\n      <Usage\n        command={command}\n        bin={getAppBin(context)}\n        packageManager={packageManager}\n      />\n      <hbr />\n      {code`\\`\\`\\``}\n      <hbr />\n    </>\n  );\n}\n\nexport interface CommandDocsProps {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  /**\n   * The command to generate options documentation for.\n   */\n  command: CommandTree;\n\n  /**\n   * Optional usage examples to include in the documentation.\n   *\n   * @defaultValue `[\"npm\"]`\n   */\n  usageExamples?: Required<CommandDocsUsageExampleProps>[\"packageManager\"][];\n}\n\n/**\n * Generates the markdown documentation for a command.\n */\nexport function CommandDocs(props: CommandDocsProps) {\n  const { levelOffset = 0, command, usageExamples } = props;\n\n  return (\n    <>\n      <Heading level={1 + levelOffset}>{command.title}</Heading>\n      <Spacing />\n      {code`${command.description}`}\n      <Spacing />\n      <Heading level={2 + levelOffset}>Usage</Heading>\n      <Spacing />\n      {code`The ${command.name} command can be executed using the following syntax: `}\n      <Spacing />\n      <Show\n        when={usageExamples && usageExamples.length > 0}\n        fallback={\n          <CommandDocsUsageExample packageManager=\"npm\" command={command} />\n        }>\n        <For each={usageExamples!} hardline>\n          {packageManager => (\n            <CommandDocsUsageExample\n              packageManager={packageManager}\n              command={command}\n            />\n          )}\n        </For>\n      </Show>\n      <Spacing />\n      <Heading level={2 + levelOffset}>Options</Heading>\n      <Spacing />\n      {code`The following options are available for the ${\n        command.name\n      } command:`}\n      <Spacing />\n      <CommandOptionsDocs command={command} />\n      <Spacing />\n    </>\n  );\n}\n\nexport interface CommandDocsFileProps extends Partial<MarkdownFileProps> {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  /**\n   * The command to generate documentation for.\n   */\n  command: CommandTree;\n}\n\n/**\n * Generates the markdown documentation file for a command.\n */\nexport function CommandDocsFile(props: CommandDocsFileProps) {\n  const { levelOffset = 0, command, frontMatter, ...rest } = props;\n\n  const context = usePowerlines<Context>();\n  const usageExamples = memo(\n    () => [\"npm\", \"yarn\", \"pnpm\", \"bun\"] as CommandDocsProps[\"usageExamples\"]\n  );\n\n  return (\n    <CommandContext.Provider value={command}>\n      <MarkdownFile\n        path={joinPaths(getDocsOutputPath(context), `${command.path}.md`)}\n        {...rest}\n        frontMatter={defu(frontMatter ?? {}, {\n          id: command.id,\n          name: command.name,\n          path: command.path,\n          reference: command.reference,\n          isVirtual: command.isVirtual,\n          title: command.title,\n          description: command.description,\n          tags: command.tags\n        })}>\n        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA6CA,SAAgB,mBAAmB,OAAgC;CACjE,MAAM,EACJ,YACA;AACF,KAAA,OAAA,KAAA,QAAA,QAAA,CAAA,WAAA;AAGA,QAAG,gBAAA,eAAA,EACD,IAAE,OAAM;AACN,SAAE,YAAO,OAAA,OAAA,QAAA,QAAA,CAAA,CAAA,KAAA,WAAA;AACP,UAAO;IACL,MAAA,OAAa,KAAA,MAAO;IACpB,aAAa,OAAO,YAAC,MAAA;IACrB,cAAW,OAAO,UAAU,OAAU,OAAE,QAAA,EAAA,SAAA,KAAA,GAAA,OAAA,UAAA,KAAA,OAAA,QAAA,MAAA;IACxC,UAAM,OAAO,YAAA,OAAA,UAAA,KAAA;IACd;IACD;IAEL,CAAC;;;;;;CAuBF,MAAA,EACC,iBAAc,OACf,YACI;CACJ,MAAM,UAAE,eAAgC;;;;;;GAElC;;AAEN,WAAO,UAAA,QAAA;;GAEG;GACT,CAAC;EAAE,gBAAkB,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;;CA8BtB,MAAE,EACA,cAAU,GACX,SACC,kBACA;AACF,QAAA;EAAA,gBAAyB,SAAA;GAC3B,OAAA,IAAA;;AAEE,WAAA,QAAA;;GAEA,CAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,WAAA,IAAA,GAAA,QAAA,cAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,SAAA;GACF,OAAO,IAAQ;GACb,UAAQ;;;;;;GAER,IAAM,OAAC;AACJ,WAAA,iBAAA,cAAA,SAAA;;GAED,IAAG,WAAS;AACV,WAAO,gBAAS,yBAAa;KAC5B,gBAAS;KACD;KACR,CAAA;;GAEH,IAAG,WAAS;AACV,WAAC,gBAAA,KAAA;KACC,MAAM;KACN,UAAS;KACT,WAAG,mBAAwB,gBAAmB,yBAAqB;MAClE;MACU;MACV,CAAC;KACH,CAAC;;GAEL,CAAC;EAAE,gBAAiB,SAAO,EAAA,CAAA;EAAA,gBAAA,SAAA;GAC1B,OAAO,IAAE;GACT,UAAO;GACR,CAAC;EAAE,gBAAO,SAAA,EAAA,CAAA;EAAA,WAAA,IAAA,+CAAA,QAAA,KAAA,WAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,oBAAA,EACD,SACT,CAAC;EAAE,gBAAU,SAAA,EAAA,CAAA;EAAA;;;;;AAsBhB,SAAgB,gBAAM,OAAA;SAElB,cAAA,GACA,SACA,aACF,GAAA,SACF;;CAEE,MAAA,gBAAA,aAAA;EAAA;EAAA;EAAA;EAAA;EAAA,CAAA;AACA,QAAC,gBAAuB,eAAc,UAAW;EACjD,OAAA;EACF,IAAO,WAAS;AACd,UAAQ,gBAAiB,cAAS,WAAsB;AAElD,WAAS,UAAC,kBAAwB,QAAA,EAAA,GAAA,QAAA,KAAA,KAAA;MAEnC,EAAE,MAAM;IACZ,IAAA,cAAA;;MAEM,IAAA,QAAA;MACJ,MAAA,QAAe;MACb,MAAA,QAAA;MACK,WAAW,QAAC;MACZ,WAAI,QAAA;MACR,OAAW,QAAO;MACd,aAAY,QAAA;MACd,MAAM,QAAQ;MACd,CAAA;;IAEF,IAAE,WAAW;AACX,YAAO,gBAAa,aAAA;MACP;MACP;MACL,IAAA,gBAAA;AACF,cAAA,eAAA;;MAEC,CAAA;;IAEH,CAAC,CAAC;;EAEN,CAAC"}
+{"version":3,"file":"docs.mjs","names":[],"sources":["../../src/components/docs.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 { code, For, memo, Show } from \"@alloy-js/core\";\nimport { Heading } from \"@alloy-js/markdown\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport type { MarkdownFileProps } from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownFile } from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownTable } from \"@powerlines/plugin-alloy/markdown/components/markdown-table\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { defu } from \"defu\";\nimport { CommandContext } from \"../contexts/command\";\nimport { getDocsOutputPath } from \"../helpers/docs-helpers\";\nimport { getAppBin } from \"../plugin-utils/context-helpers\";\nimport { sortOptions } from \"../plugin-utils/reflect\";\nimport type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport { Usage } from \"./usage\";\n\nexport interface CommandOptionsDocsProps {\n  /**\n   * The command to generate options documentation for.\n   */\n  command: CommandTree;\n}\n\n/**\n * Generates the options markdown documentation for a command.\n */\nexport function CommandOptionsDocs(props: CommandOptionsDocsProps) {\n  const { command } = props;\n  if (Object.keys(command.options).length === 0) {\n    return code`This command does not have any options.`;\n  }\n\n  return (\n    <MarkdownTable\n      data={sortOptions(Object.values(command.options)).map(option => {\n        return {\n          name: option.name.trim(),\n          description: option.description.trim(),\n          defaultValue: option.default\n            ? String(option.default)?.includes('\"')\n              ? option.default\n              : `\\`${option.default}\\``\n            : \"\",\n          required: option.optional || option.default ? \"\" : \"✔\"\n        };\n      })}\n    />\n  );\n}\n\nexport interface CommandDocsUsageExampleProps {\n  /**\n   * The package manager to generate the usage example for.\n   *\n   * @remarks\n   * If not specified, examples for all supported package managers will be generated.\n   *\n   * @defaultValue \"npm\"\n   */\n  packageManager?: \"npm\" | \"yarn\" | \"pnpm\" | \"bun\";\n\n  /**\n   * The command to generate the usage example for.\n   */\n  command: CommandTree;\n}\n\n/**\n * Generates the markdown documentation for a command.\n */\nexport function CommandDocsUsageExample(props: CommandDocsUsageExampleProps) {\n  const { packageManager = \"npm\", command } = props;\n\n  const context = usePowerlines<Context>();\n\n  return (\n    <>\n      <hbr />\n      {code`\\`\\`\\`bash `}\n      <hbr />\n      <Usage\n        command={command}\n        bin={getAppBin(context)}\n        packageManager={packageManager}\n      />\n      <hbr />\n      {code`\\`\\`\\``}\n      <hbr />\n    </>\n  );\n}\n\nexport interface CommandDocsProps {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  /**\n   * The command to generate options documentation for.\n   */\n  command: CommandTree;\n\n  /**\n   * Optional usage examples to include in the documentation.\n   *\n   * @defaultValue `[\"npm\"]`\n   */\n  usageExamples?: Required<CommandDocsUsageExampleProps>[\"packageManager\"][];\n}\n\n/**\n * Generates the markdown documentation for a command.\n */\nexport function CommandDocs(props: CommandDocsProps) {\n  const { levelOffset = 0, command, usageExamples } = props;\n\n  return (\n    <>\n      <Heading level={1 + levelOffset}>{command.title}</Heading>\n      <Spacing />\n      {code`${command.description}`}\n      <Spacing />\n      <Heading level={2 + levelOffset}>Usage</Heading>\n      <Spacing />\n      {code`The ${command.name} command can be executed using the following syntax: `}\n      <Spacing />\n      <Show\n        when={usageExamples && usageExamples.length > 0}\n        fallback={\n          <CommandDocsUsageExample packageManager=\"npm\" command={command} />\n        }>\n        <For each={usageExamples!} hardline>\n          {packageManager => (\n            <CommandDocsUsageExample\n              packageManager={packageManager}\n              command={command}\n            />\n          )}\n        </For>\n      </Show>\n      <Spacing />\n      <Heading level={2 + levelOffset}>Options</Heading>\n      <Spacing />\n      {code`The following options are available for the ${\n        command.name\n      } command:`}\n      <Spacing />\n      <CommandOptionsDocs command={command} />\n      <Spacing />\n    </>\n  );\n}\n\nexport interface CommandDocsFileProps extends Partial<MarkdownFileProps> {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  /**\n   * The command to generate documentation for.\n   */\n  command: CommandTree;\n}\n\n/**\n * Generates the markdown documentation file for a command.\n */\nexport function CommandDocsFile(props: CommandDocsFileProps) {\n  const { levelOffset = 0, command, frontMatter, ...rest } = props;\n\n  const context = usePowerlines<Context>();\n  const usageExamples = memo(\n    () => [\"npm\", \"yarn\", \"pnpm\", \"bun\"] as CommandDocsProps[\"usageExamples\"]\n  );\n\n  return (\n    <CommandContext.Provider value={command}>\n      <MarkdownFile\n        path={joinPaths(getDocsOutputPath(context), `${command.path}.md`)}\n        {...rest}\n        frontMatter={defu(frontMatter ?? {}, {\n          id: command.id,\n          name: command.name,\n          path: command.path,\n          reference: command.reference,\n          isVirtual: command.isVirtual,\n          title: command.title,\n          description: command.description,\n          tags: command.tags\n        })}>\n        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,MAAM,aAAa;CAAC;CAAK;CAAW;CAAO;;AAE1C,IAAI,SAAS;AACb,QAAG;;AAgCJ,MAAK,6BAAwB;CAAO;CAAe;CAAG;CAAA;CAAA;CAAA;;;;AAKtD,SAAE,mBAAA,OAAA;CACA,MAAC,EACD,YACI;AACJ,KAAA,OAAQ,KAAQ,QAAI,QAAK,CAAA,WAAA,EACvB,QAAE,IAAO;AAEX,QAAA,gBAAA,eAAA;AAEA,SAAO,YAAA,OAAA,OAAA,QAAA,QAAA,CAAA,CAAA,IAAA,cAAA,WAAA;AACJ,UAAA;IACK,MAAE,OAAW,KAAC,MAAO;IACvB,aAAO,OAAA,YAAA,MAAA;IACL,cAAa,OAAK,UAAM,OAAA,OAAA,QAAA,EAAA,SAAA,KAAA,GAAA,OAAA,UAAA,KAAA,OAAA,QAAA,MAAA;IACxB,UAAA,OAAa,YAAO,OAAgB,UAAE,KAAA;IACvC;KACA;GAAC;GAAU;GAAC;GAAO,CAAO,CAAC;IAEjC,CAAC;;AAEJ,mBAAmB,SAAQ;OAAQ;CAA4B;CAAA;CAAA;CAAA;CAAA;AAC/D,MAAM,kCAAG;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;CAMT,MAAO,EACH,iBAAA,OACA,YACD;CACD,MAAI,WAAA,cAAA,IAAA,CAAA,CAAA,WAAA,OAAA,CAAA,EAAA,eAAA;AACJ,QAAM;EAAA,gBAAe,OAAY,EAAC,CAAA;EAAI,IAAA;EAAkB,gBAAiB,OAAS,EAAA,CAAA;EAAA,gBAAA,OAAA;GACjF;GACC,IAAE,MAAA;AACF,WAAA,UAAA,QAAA;;;GAGD,CAAC;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA,IAAA;EAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;AAEJ,wBAAI,SAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AACJ,MAAE,sBAAoB;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;AAKtB,SAAE,YAAA,OAAA;CACF,MAAO,EACL,cAAQ,YAER;AAEA,QAAO;EAAA,gBAAA,SAAA;GACL,OAAC,IAAA;GACD,IAAG,WAAK;AACN,WAAO,QAAK;;GAEf,CAAC;EAAE,gBAAC,SAAA,EAAA,CAAA;EAAA,WAAA,IAAA,GAAA,QAAA,cAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,SAAA;GACH,OAAI,IAAO;GACX,UAAS;GACV,CAAC;EAAE,gBAAkB,SAAA,EAAA,CAAA;EAAc,WAAA,IAAA,OAAA,QAAA,KAAA,uDAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,MAAA;GAClC,IAAG,OAAA;AACD,WAAM,iBAAA,cAAA,SAAA;;GAER,IAAG,WAAK;AACN,WAAA,gBAAA,yBAAA;KACH,gBAAA;KACH;;;GAGI,IAAA,WAAA;AACC,WAAI,gBAAqB,KAAG;KAC9B,MAAA;KACG,UAAA;KACD,IAAO,WAAQ;AACjB,aAAA,cAAA,mBAAA,gBAAA,yBAAA;OACgB;OACf;OACF,CAAA,EAAY;OAAC;OAAO;OAAA;OAAA,CAAA;;KAElB,CAAA;;GAED,CAAC;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,SAAA;GACF,OAAS,IAAA;;GAER,CAAC;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,WAAA,IAAA,+CAAA,QAAA,KAAA,WAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA,gBAAA,oBAAA,EACS,SACV,CAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA;;AAEH,YAAI,SAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AACJ,MAAE,0BAAyB;OAAA;CAAA;CAA+B;CAAA;CAAkB;CAAA;CAAA;CAAA;CAAA;CAAA;;;;AAK5E,SAAE,gBAAA,OAAA;CACF,MAAO,EACL,cAAQ,YAER,aACE,GAAC,SACC;CACJ,MAAK,WAAS,cAAA,IAAA,CAAA,CAAA,WAAA,OAAA,CAAA,EAAA,eAAA;CACd,MAAK,gBAAe,aAAa;EAAA;EAAA;EAAA;EAAA;EAAA,CAAA;AACjC,QAAK,gBAAS,eAAA,UAAA;EACZ,OAAG;EACH,IAAG,WAAS;AACV,UAAM,gBAAmB,cAAa,WAAY,EACjD,IAAA,OAAS;AACT,WAAA,UAAA,kBAAA,QAAA,EAAA,GAAA,QAAA,KAAA,KAAA;MAEA,EAAC,MAAA;IACA,IAAG,cAAA;AACF,YAAA,KAAA,eAAA,EAAA,EAAA;MACG,IAAC,QAAM;MACR,MAAA,QAAe;MACd,MAAC,QAAA;MACD,WAAE,QAAgB;MAClB,WAAW,QAAO;MAClB,OAAC,QAAA;MACF,aAAA,QAAA;MACD,MAAG,QAAA;MACL,CAAI;;IAEL,IAAA,WAAgB;AAChB,YAAS,gBAAA,aAAA;MACS;MACT;MACR,IAAQ,gBAAC;AACH,cAAE,eAAA;;MAET,CAAA;;IAEJ,CAAA,CAAA;;;;AAIH,gBAAI,SAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}

package/dist/components/exec-builtin.cjs

@@ -11,6 +11,33 @@ let _powerlines_plugin_alloy_typescript_components_builtin_file = require("@powe
 let _powerlines_plugin_alloy_typescript_components_tsdoc = require("@powerlines/plugin-alloy/typescript/components/tsdoc");
 
 //#region src/components/exec-builtin.tsx
+const __ΩOmit = [
+	"T",
+	"K",
+	() => __ΩPick,
+	() => __ΩExclude,
+	"Omit",
+	"b!b\"e!!e!!ge!\"o$#o##w%y"
+];
+const __ΩPick = [
+	"T",
+	"K",
+	"Pick",
+	"l+e#!e\"!fRb!b\"Pde\"\"N#!w#y"
+];
+const __ΩExclude = [
+	"T",
+	"U",
+	"Exclude",
+	"l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
+];
+const __ΩExecBuiltinProps = [
+	() => __ΩOmit,
+	"id",
+	"description",
+	"ExecBuiltinProps",
+	"P!P.\".#Jo!#Mw$y"
+];
 /**
 * A built-in module for handling command execution in Shell Shock.
 */
@@ -708,6 +735,14 @@ return new Promise((resolve, reject) => {
 		}
 	}));
 }
+ExecBuiltin.__type = [
+	() => __ΩExecBuiltinProps,
+	"props",
+	"ExecBuiltin",
+	"A built-in module for handling command execution in Shell Shock.",
+	"Pn!2\"\"/#?$"
+];
 
 //#endregion
-exports.ExecBuiltin = ExecBuiltin;
+exports.ExecBuiltin = ExecBuiltin;
+exports.__ΩExecBuiltinProps = __ΩExecBuiltinProps;

package/dist/components/exec-builtin.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"exec-builtin.d.cts","names":[],"sources":["../../src/components/exec-builtin.tsx"],"mappings":";;;;UAsCiB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;AADF;;iBAQgB,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}
+{"version":3,"file":"exec-builtin.d.cts","names":[],"sources":["../../src/components/exec-builtin.tsx"],"mappings":";;;;UAqCiB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;AADF;;iBAQgB,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}

package/dist/components/exec-builtin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"exec-builtin.d.mts","names":[],"sources":["../../src/components/exec-builtin.tsx"],"mappings":";;;;UAsCiB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;AADF;;iBAQgB,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}
+{"version":3,"file":"exec-builtin.d.mts","names":[],"sources":["../../src/components/exec-builtin.tsx"],"mappings":";;;;UAqCiB,gBAAA,SAAyB,IAAA,CACxC,gBAAA;;AADF;;iBAQgB,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA"}

package/dist/components/exec-builtin.mjs

@@ -8,6 +8,33 @@ import { BuiltinFile } from "@powerlines/plugin-alloy/typescript/components/buil
 import { TSDoc, TSDocDefaultValue, TSDocParam, TSDocReturns } from "@powerlines/plugin-alloy/typescript/components/tsdoc";
 
 //#region src/components/exec-builtin.tsx
+const __ΩOmit = [
+	"T",
+	"K",
+	() => __ΩPick,
+	() => __ΩExclude,
+	"Omit",
+	"b!b\"e!!e!!ge!\"o$#o##w%y"
+];
+const __ΩPick = [
+	"T",
+	"K",
+	"Pick",
+	"l+e#!e\"!fRb!b\"Pde\"\"N#!w#y"
+];
+const __ΩExclude = [
+	"T",
+	"U",
+	"Exclude",
+	"l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
+];
+const __ΩExecBuiltinProps = [
+	() => __ΩOmit,
+	"id",
+	"description",
+	"ExecBuiltinProps",
+	"P!P.\".#Jo!#Mw$y"
+];
 /**
 * A built-in module for handling command execution in Shell Shock.
 */
@@ -705,7 +732,14 @@ return new Promise((resolve, reject) => {
 		}
 	}));
 }
+ExecBuiltin.__type = [
+	() => __ΩExecBuiltinProps,
+	"props",
+	"ExecBuiltin",
+	"A built-in module for handling command execution in Shell Shock.",
+	"Pn!2\"\"/#?$"
+];
 
 //#endregion
-export { ExecBuiltin };
+export { ExecBuiltin, __ΩExecBuiltinProps };
 //# sourceMappingURL=exec-builtin.mjs.map