@shell-shock/core 0.17.8 → 0.17.11

package/dist/components/docs.d.cts

@@ -1,5 +1,4 @@
 import { CommandTree } from "../types/command.cjs";
-import * as _$_alloy_js_core0 from "@alloy-js/core";
 import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
 
 //#region src/components/docs.d.ts
@@ -12,7 +11,7 @@ interface CommandOptionsDocsProps {
 /**
  * Generates the options markdown documentation for a command.
  */
-declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _$_alloy_js_core0.Children;
+declare function CommandOptionsDocs(props: CommandOptionsDocsProps): import("@alloy-js/core").Children;
 interface CommandDocsUsageExampleProps {
   /**
    * The package manager to generate the usage example for.
@@ -31,7 +30,7 @@ interface CommandDocsUsageExampleProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _$_alloy_js_core0.Children;
+declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): import("@alloy-js/core").Children;
 interface CommandDocsProps {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -56,7 +55,7 @@ interface CommandDocsProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocs(props: CommandDocsProps): _$_alloy_js_core0.Children;
+declare function CommandDocs(props: CommandDocsProps): import("@alloy-js/core").Children;
 interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -75,7 +74,7 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
 /**
  * Generates the markdown documentation file for a command.
  */
-declare function CommandDocsFile(props: CommandDocsFileProps): _$_alloy_js_core0.Children;
+declare function CommandDocsFile(props: CommandDocsFileProps): import("@alloy-js/core").Children;
 //#endregion
 export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps };
 //# 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,WAAA;AAAA;;;AAMX;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,iBAAA,CAAA,QAAA;AAAA,UA4BhD,4BAAA;EA5BgD;;;;;;AA4BjE;;EASE,cAAA;EAKoB;;;EAApB,OAAA,EAAS,WAAA;AAAA;;AAMX;;iBAAgB,uBAAA,CAAwB,KAAA,EAAO,4BAAA,GAA4B,iBAAA,CAAA,QAAA;AAAA,UAsB1D,gBAAA;EAtB8B;;;;;AAsB/C;;;EASE,WAAA;EAYyB;;;EAPzB,OAAA,EAAS,WAAA;EALT;;;;;EAYA,aAAA,GAAgB,QAAA,CAAS,4BAAA;AAAA;;AAM3B;;iBAAgB,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA;AAAA,UAwClC,oBAAA,SAA6B,OAAA,CAAQ,iBAAA;EAxCnB;;;;;AAwCnC;;;EASE,WAAA;EAKS;;;EAAT,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,eAAA,CAAgB,KAAA,EAAO,oBAAA,GAAoB,iBAAA,CAAA,QAAA"}
+{"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"}

package/dist/components/docs.d.mts

@@ -1,5 +1,4 @@
 import { CommandTree } from "../types/command.mjs";
-import * as _$_alloy_js_core0 from "@alloy-js/core";
 import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
 
 //#region src/components/docs.d.ts
@@ -12,7 +11,7 @@ interface CommandOptionsDocsProps {
 /**
  * Generates the options markdown documentation for a command.
  */
-declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _$_alloy_js_core0.Children;
+declare function CommandOptionsDocs(props: CommandOptionsDocsProps): import("@alloy-js/core").Children;
 interface CommandDocsUsageExampleProps {
   /**
    * The package manager to generate the usage example for.
@@ -31,7 +30,7 @@ interface CommandDocsUsageExampleProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _$_alloy_js_core0.Children;
+declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): import("@alloy-js/core").Children;
 interface CommandDocsProps {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -56,7 +55,7 @@ interface CommandDocsProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocs(props: CommandDocsProps): _$_alloy_js_core0.Children;
+declare function CommandDocs(props: CommandDocsProps): import("@alloy-js/core").Children;
 interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -75,7 +74,7 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
 /**
  * Generates the markdown documentation file for a command.
  */
-declare function CommandDocsFile(props: CommandDocsFileProps): _$_alloy_js_core0.Children;
+declare function CommandDocsFile(props: CommandDocsFileProps): import("@alloy-js/core").Children;
 //#endregion
 export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps };
 //# sourceMappingURL=docs.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"docs.d.mts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":";;;;;UAmCiB,uBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;AAAA;;;AAMX;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,iBAAA,CAAA,QAAA;AAAA,UA4BhD,4BAAA;EA5BgD;;;;;;AA4BjE;;EASE,cAAA;EAKoB;;;EAApB,OAAA,EAAS,WAAA;AAAA;;AAMX;;iBAAgB,uBAAA,CAAwB,KAAA,EAAO,4BAAA,GAA4B,iBAAA,CAAA,QAAA;AAAA,UAsB1D,gBAAA;EAtB8B;;;;;AAsB/C;;;EASE,WAAA;EAYyB;;;EAPzB,OAAA,EAAS,WAAA;EALT;;;;;EAYA,aAAA,GAAgB,QAAA,CAAS,4BAAA;AAAA;;AAM3B;;iBAAgB,WAAA,CAAY,KAAA,EAAO,gBAAA,GAAgB,iBAAA,CAAA,QAAA;AAAA,UAwClC,oBAAA,SAA6B,OAAA,CAAQ,iBAAA;EAxCnB;;;;;AAwCnC;;;EASE,WAAA;EAKS;;;EAAT,OAAA,EAAS,WAAA;AAAA;;;;iBAMK,eAAA,CAAgB,KAAA,EAAO,oBAAA,GAAoB,iBAAA,CAAA,QAAA"}
+{"version":3,"file":"docs.d.mts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":""}

package/dist/components/docs.mjs

@@ -1,2 +1,257 @@
-import{CommandContext as e}from"../contexts/command.mjs";import{getDocsOutputPath as t}from"../helpers/docs-helpers.mjs";import{getAppBin as n}from"../plugin-utils/context-helpers.mjs";import{sortOptions as r}from"../plugin-utils/reflect.mjs";import{Usage as i}from"./usage.mjs";import{createComponent as a,createIntrinsic as o,memo as s,mergeProps as c}from"@alloy-js/core/jsx-runtime";import{defu as l}from"defu";import{For as u,Show as d,code as f,memo as p}from"@alloy-js/core";import{Heading as m}from"@alloy-js/markdown";import{Spacing as h}from"@powerlines/plugin-alloy/core/components/spacing";import{usePowerlines as g}from"@powerlines/plugin-alloy/core/contexts/context";import{MarkdownFile as _}from"@powerlines/plugin-alloy/markdown/components/markdown-file";import{MarkdownTable as v}from"@powerlines/plugin-alloy/markdown/components/markdown-table";import{joinPaths as y}from"@stryke/path/join";const b=[`T`,`Required`,`l+e#!e"!fRb!Pde"!gN##w"y`],x=[`T`,`Partial`,`l+e#!e"!fRb!Pde"!gN#"w"y`];function S(e,t){return e.__type=t,e}const C=[`CommandTree`,`command`,`The command to generate options documentation for.`,`CommandOptionsDocsProps`,`P"w!4"?#Mw$y`];function w(e){let{command:t}=e;return Object.keys(t.options).length===0?f`This command does not have any options.`:a(v,{get data(){return r(Object.values(t.options)).map(S(e=>({name:e.name.trim(),description:e.description.trim(),defaultValue:e.default?String(e.default)?.includes(`"`)?e.default:`\`${Array.isArray(e.default)?e.default.join(`, `):e.default}\``:``,required:e.optional||e.default?``:`✔`}),[`option`,``,`P"2!"/"`]))}})}w.__type=[()=>C,`props`,`CommandOptionsDocs`,`Generates the options markdown documentation for a command.`,`Pn!2""/#?$`];const T=[`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`];function E(e){let{packageManager:t=`npm`,command:r}=e,s=(g.Ω=[[`Context`,`"w!`]],g());return[o(`hbr`,{}),f`\`\`\`bash `,o(`hbr`,{}),a(i,{command:r,get bin(){return n(s)},packageManager:t}),o(`hbr`,{}),f`\`\`\``,o(`hbr`,{})]}E.__type=[()=>T,`props`,`CommandDocsUsageExample`,`Generates the markdown documentation for a command.`,`Pn!2""/#?$`];const D=[`levelOffset`,0,`The heading level offset to apply to the generated documentation.`,`CommandTree`,`command`,`The command to generate options documentation for.`,()=>b,()=>T,`packageManager`,`usageExamples`,'`["npm"]`',`Optional usage examples to include in the documentation.`,`CommandDocsProps`,`P'4!8>"?#"w$4%?&n(o'".)fF4*8>+?,Mw-y`];function O(e){let{levelOffset:t=0,command:n,usageExamples:r}=e;return[a(m,{level:1+t,get children(){return n.title}}),a(h,{}),s(()=>f`${n.description}`),a(h,{}),a(m,{level:2+t,children:`Usage`}),a(h,{}),s(()=>f`The ${n.name} command can be executed using the following syntax: `),a(h,{}),a(d,{get when(){return r&&r.length>0},get fallback(){return a(E,{packageManager:`npm`,command:n})},get children(){return a(u,{each:r,hardline:!0,get children(){return S(e=>a(E,{packageManager:e,command:n}),[`packageManager`,``,`P"2!"/"`])}})}}),a(h,{}),a(m,{level:2+t,children:`Options`}),a(h,{}),s(()=>f`The following options are available for the ${n.name} command:`),a(h,{}),a(w,{command:n}),a(h,{})]}O.__type=[()=>D,`props`,`CommandDocs`,`Generates the markdown documentation for a command.`,`Pn!2""/#?$`];const k=[()=>x,`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`];function A(n){let{levelOffset:r=0,command:i,frontMatter:o,...s}=n,u=(g.Ω=[[`Context`,`"w!`]],g()),d=p(()=>[`npm`,`yarn`,`pnpm`,`bun`]);return a(e.Provider,{value:i,get children(){return a(_,c({get path(){return y(t(u),`${i.path}.md`)}},s,{get frontMatter(){return l(o??{},{id:i.id,name:i.name,path:i.path,reference:i.reference,isVirtual:i.isVirtual,title:i.title,description:i.description,tags:i.tags})},get children(){return a(O,{levelOffset:r,command:i,get usageExamples(){return d()}})}}))}})}A.__type=[()=>k,`props`,`CommandDocsFile`,`Generates the markdown documentation file for a command.`,`Pn!2""/#?$`];export{O as CommandDocs,A as CommandDocsFile,E as CommandDocsUsageExample,w as CommandOptionsDocs,k as __ΩCommandDocsFileProps,D as __ΩCommandDocsProps,T as __ΩCommandDocsUsageExampleProps,C as __ΩCommandOptionsDocsProps};
+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";
+
+//#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.
+*/
+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 {
+				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}\`` : "",
+				required: !option.required || 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.Ω = [["Context", "\"w!"]], usePowerlines());
+	return [
+		createIntrinsic("hbr", {}),
+		code`\`\`\`bash `,
+		createIntrinsic("hbr", {}),
+		createComponent(Usage, {
+			command,
+			get bin() {
+				return getAppBin(context);
+			},
+			packageManager
+		}),
+		createIntrinsic("hbr", {}),
+		code`\`\`\``,
+		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.
+*/
+function CommandDocs(props) {
+	const { levelOffset = 0, command, usageExamples } = props;
+	return [
+		createComponent(Heading, {
+			level: 1 + levelOffset,
+			get children() {
+				return command.title;
+			}
+		}),
+		createComponent(Spacing, {}),
+		memo(() => code`${command.description}`),
+		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,
+					hardline: true,
+					get children() {
+						return __assignType((packageManager) => createComponent(CommandDocsUsageExample, {
+							packageManager,
+							command
+						}), [
+							"packageManager",
+							"",
+							"P\"2!\"/\""
+						]);
+					}
+				});
+			}
+		}),
+		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 { 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              : `\\`${\n                  Array.isArray(option.default)\n                    ? option.default.join(\", \")\n                    : option.default\n                }\\``\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":"i8BAEM,EAAa,CAAC,IAAK,UAAW,2BAAO,iBAG1C,MADA,GAAI,OAAS,EACV,EAgCJ,MAAK,EAAwB,CAAO,cAAe,UAAG,qDAAA,0BAAA,eAAA,CAKtD,SAAE,EAAA,EAAA,CACA,GAAC,CACD,WACI,EAIJ,OAHA,OAAQ,KAAQ,EAAI,QAAK,CAAA,SAAA,EACrB,CAAO,0CAEX,EAAA,EAAA,CAAA,IAAA,MAAA,CAEA,OAAO,EAAA,OAAA,OAAA,EAAA,QAAA,CAAA,CAAA,IAAA,EAAA,IACJ,CACK,KAAE,EAAW,KAAC,MAAO,CACvB,YAAO,EAAA,YAAA,MAAA,CACL,aAAa,EAAK,QAAM,OAAA,EAAA,QAAA,EAAA,SAAA,IAAA,CAAA,EAAA,QAAA,KAAA,MAAA,QAAA,EAAA,QAAA,CAAA,EAAA,QAAA,KAAA,KAAA,CAAA,EAAA,QAAA,IAAA,GACxB,SAAA,EAAa,UAAO,EAAgB,QAAE,GAAA,IACvC,EACA,CAAC,SAAU,GAAC,UAAO,CAAO,CAAC,EAEjC,CAAC,CAEJ,EAAmB,OAAS,KAAC,EAAiB,QAAA,qBAAA,8DAAA,aAAA,CAC9C,MAAM,EAAuB,CAAA,MAAA,OAAA,OAAA,MAAA,iBAAA,MAAA,yDAAA,cAAA,UAAA,iDAAA,+BAAA,gCAAA,CAK7B,SAAQ,EAAA,EAAA,CACN,GAAG,CACF,iBAAA,MACH,WAAA,EAEO,GAAU,EAAA,EAAA,CAAA,CAAA,UAA6B,MAAA,CAAA,CAAA,GAAA,EAC5C,MAAE,CAAA,EAAA,MAAA,EAAA,CAAA,CAAA,CAAA,cAAA,EAAA,MAAA,EAAA,CAAA,CAAA,EAAA,EAAA,CACK,UACN,IAAA,KAAA,CACG,OAAA,EAAA,EAAA,EAEH,iBACA,CAAC,CAAE,EAAiB,MAAA,EAAA,CAAA,CAAA,CAAA,SAAA,EAAA,MAAA,EAAA,CAAA,CAAA,CAEvB,EAAwB,OAAS,KAAI,EAAa,QAAA,0BAAA,sDAAA,aAAA,0VAMlD,SAAA,EAAA,EAAA,KAEE,cAAA,EACC,UACD,iBACI,EACJ,MAAO,CAAC,EAAkB,EAAM,WAEhC,IAAM,UAAU,iBAGf,CAAC,CAAC,EAAA,EAAA,EAAA,CAAA,CAAA,MAAA,CAAA,GAAA,EAAA,cAAA,CAAA,EAAA,EAAA,EAAA,CAAA,CAAA,EAAA,EAAA,CACD,MAAO,EAAC,EACR,SAAU,QACX,CAAC,CAAE,EAAM,EAAA,EAAA,CAAA,CAAA,MAAA,CAAA,OAAA,EAAA,KAAA,uDAAA,CAAA,EAAA,EAAA,EAAA,CAAA,CAAA,EAAA,EAAA,CACR,IAAG,MAAA,CACD,OAAE,GAAgB,EAAA,OAAA,GAEpB,IAAI,UAAA,CACF,OAAC,EAAA,EAAA,CACA,eAAK,MACK,UACV,CAAA,EAEJ,IAAA,UAAA,CACH,OAAA,EAAA,EAAA,QAEO,SAAU,GACb,IAAA,UAAA,CACK,OAAQ,EAAa,GAAgB,EAAU,EAAa,CAClE,iBACG,UACI,CAAE,CAAC,CAAA,iBAAoB,GAAI,UAAA,CAAA,EAE/B,CAAA,EAEJ,CAAA,CAAA,EAAoB,EAAA,EAAA,CAAA,CAAA,EAAA,EAAA,WAElB,SAAA,UACD,CAAC,CAAC,EAAe,EAAS,EAAA,CAAO,CAAC,MAAc,CAAG,+CAAA,EAAA,KAAA,WAAA,CAAA,EAAA,EAAA,EAAA,CAAA,CAAA,EAAA,EAAA,CAClD,UACF,CAAA,CAAA,EAAoB,EAAA,EAAA,CAAA,CAAA,CAEtB,EAAI,OAAA,KAAA,EAAA,QAAA,cAAA,sDAAA,aAAA,CACJ,MAAK,EAA2B,KAAO,EAAQ,cAAa,EAAA,oEAAA,cAAA,UAAA,6CAAA,uBAAA,2BAAA,CAK5D,SAAA,EAAA,EAAA,KAEE,cAAA,EACC,UACD,cACF,GAAO,GACL,kCAEM,EAAC,MAAA,CAAA,MAAA,OAAA,OAAA,MAAA,CAAA,CACP,OAAG,EAAA,EAAA,SAAA,CACD,MAAG,EACH,IAAG,UAAS,CACV,OAAO,EAAS,EAAa,EAAA,CAC5B,IAAA,MAAS,CACT,OAAQ,EAAW,EAAmB,EAAQ,CAAA,GAAA,EAAA,KAAA,KAAA,EAE9C,CAAA,EAAQ,CACR,IAAA,aAAS,CACT,OAAA,EAAA,GAAA,EAAA,CAAA,CACK,GAAE,EAAA,GACN,KAAS,EAAA,KACN,KAAA,EAAA,KACF,UAAA,EAAA,UACG,UAAO,EAAA,UACR,MAAA,EAAgB,MACf,YAAC,EAAA,YACD,KAAE,EAAA,KACH,CAAC,EAEJ,IAAG,UAAA,CACD,OAAG,EAAA,EAAA,CACD,cACI,UACT,IAAQ,eAAW,CACZ,OAAE,GAAA,EAER,CAAA,EAED,CAAA,CAAA,EAEJ,CAAC,CAEJ,EAAG,OAAA,KAAA,EAAA,QAAA,kBAAA,2DAAA,aAAA"}
+{"version":3,"file":"docs.mjs","names":[],"sources":[],"mappings":""}