@shell-shock/core 0.12.2 → 0.13.1

package/dist/components/docs.cjs

@@ -1,17 +1,18 @@
-const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
 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 __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 _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let _alloy_js_core = require("@alloy-js/core");
+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");
 
 //#region src/components/docs.tsx
 /**
@@ -19,8 +20,8 @@ let __stryke_path_join = require("@stryke/path/join");
 */
 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() {
+	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 {
 				name: option.name.trim(),
@@ -36,21 +37,21 @@ function CommandOptionsDocs(props) {
 */
 function CommandDocsUsageExample(props) {
 	const { packageManager = "npm", command } = props;
-	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	const context = (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.createIntrinsic)("hbr", {}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(require_components_usage.Usage, {
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		_alloy_js_core.code`\`\`\`bash `,
+		(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", {}),
-		__alloy_js_core.code`\`\`\``,
-		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		_alloy_js_core.code`\`\`\``,
+		(0, _alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
 	];
 }
 /**
@@ -59,53 +60,53 @@ function CommandDocsUsageExample(props) {
 function CommandDocs(props) {
 	const { levelOffset = 0, command, usageExamples } = props;
 	return [
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
+		(0, _alloy_js_core_jsx_runtime.createComponent)(_alloy_js_markdown.Heading, {
 			level: 1 + levelOffset,
 			get children() {
 				return command.title;
 			}
 		}),
-		(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)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
+		(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)(_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, {
+		(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, {
+				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, {
+				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, {
+					children: (packageManager) => (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
 						packageManager,
 						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, {
+		(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, {})
+		(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, {})
 	];
 }
 /**
@@ -113,20 +114,20 @@ function CommandDocs(props) {
 */
 function CommandDocsFile(props) {
 	const { levelOffset = 0, command, ...rest } = props;
-	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
-	const usageExamples = (0, __alloy_js_core.memo)(() => [
+	const context = (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, {
+	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`);
+			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 children() {
-				return (0, __alloy_js_core_jsx_runtime.createComponent)(CommandDocs, {
+				return (0, _alloy_js_core_jsx_runtime.createComponent)(CommandDocs, {
 					levelOffset,
 					command,
 					get usageExamples() {

package/dist/components/docs.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"docs.cjs","names":["code","For","memo","Show","Heading","Spacing","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","CommandContext","getDocsOutputPath","getAppBin","sortOptions","Usage","CommandOptionsDocs","props","command","Object","keys","options","length","_$createComponent","data","values","map","option","name","trim","description","defaultValue","default","String","includes","required","optional","CommandDocsUsageExample","packageManager","context","_$createIntrinsic","bin","CommandDocs","levelOffset","usageExamples","level","children","title","_$memo","when","fallback","each","hardline","CommandDocsFile","rest","Provider","value","_$mergeProps","path"],"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 { 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, ...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        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA4CA,SAAgBe,mBAAmBC,OAAgC;CACjE,MAAM,EAAEC,YAAYD;AACpB,KAAIE,OAAOC,KAAKF,QAAQG,QAAQ,CAACC,WAAW,EAC1C,QAAOrB,oBAAI;AAGb,yDACGQ,4EAAa,EAAA,IACZe,OAAI;AAAA,SAAEV,4BAAYK,OAAOM,OAAOP,QAAQG,QAAQ,CAAC,CAACK,KAAIC,WAAU;AAC9D,UAAO;IACLC,MAAMD,OAAOC,KAAKC,MAAM;IACxBC,aAAaH,OAAOG,YAAYD,MAAM;IACtCE,cAAcJ,OAAOK,UACjBC,OAAON,OAAOK,QAAQ,EAAEE,SAAS,KAAI,GACnCP,OAAOK,UACP,KAAKL,OAAOK,QAAO,MACrB;IACJG,UAAUR,OAAOS,YAAYT,OAAOK,UAAU,KAAK;IACpD;IACD;IAAA,CAAA;;;;;AAyBR,SAAgBK,wBAAwBpB,OAAqC;CAC3E,MAAM,EAAEqB,iBAAiB,OAAOpB,YAAYD;CAE5C,MAAMsB,8EAAkC;AAExC,QAAA;mDAAA,OAAA,EAAA,CAAA;EAGKtC,oBAAI;mDAAa,OAAA,EAAA,CAAA;mDAEjBc,gCAAK;GACKG;GAAO,IAChBuB,MAAG;AAAA,WAAE5B,kCAAU0B,QAAQ;;GACPD;GAAc,CAAA;mDAAA,OAAA,EAAA,CAAA;EAG/BrC,oBAAI;mDAAQ,OAAA,EAAA,CAAA;EAAA;;;;;AAiCnB,SAAgByC,YAAYzB,OAAyB;CACnD,MAAM,EAAE0B,cAAc,GAAGzB,SAAS0B,kBAAkB3B;AAEpD,QAAA;mDAEKZ,6BAAO;GAACwC,OAAO,IAAIF;GAAW,IAAAG,WAAA;AAAA,WAAG5B,QAAQ6B;;GAAK,CAAA;mDAC9CzC,2DAAO,EAAA,CAAA;8CACPL,oBAAI,GAAGiB,QAAQY,cAAa;mDAC5BxB,2DAAO,EAAA,CAAA;mDACPD,6BAAO;GAACwC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;mDAC9BxC,2DAAO,EAAA,CAAA;8CACPL,oBAAI,OAAOiB,QAAQU,KAAI,uDAAuD;mDAC9EtB,2DAAO,EAAA,CAAA;mDACPF,sBAAI;GAAA,IACH6C,OAAI;AAAA,WAAEL,iBAAiBA,cAActB,SAAS;;GAAC,IAC/C4B,WAAQ;AAAA,4DACLb,yBAAuB;KAACC,gBAAc;KAAgBpB;KAAO,CAAA;;GAAA,IAAA4B,WAAA;AAAA,4DAE/D5C,qBAAG;KAACiD,MAAMP;KAAgBQ,UAAQ;KAAAN,WAChCR,oEACED,yBAAuB;MACNC;MACPpB;MAAO,CAAA;KAEnB,CAAA;;GAAA,CAAA;mDAGJZ,2DAAO,EAAA,CAAA;mDACPD,6BAAO;GAACwC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;mDAC9BxC,2DAAO,EAAA,CAAA;8CACPL,oBAAI,+CACHiB,QAAQU,KAAI,WACH;mDACVtB,2DAAO,EAAA,CAAA;mDACPU,oBAAkB,EAAUE,SAAO,CAAA;mDACnCZ,2DAAO,EAAA,CAAA;EAAA;;;;;AAyBd,SAAgB+C,gBAAgBpC,OAA6B;CAC3D,MAAM,EAAE0B,cAAc,GAAGzB,SAAS,GAAGoC,SAASrC;CAE9C,MAAMsB,8EAAkC;CACxC,MAAMK,gDACE;EAAC;EAAO;EAAQ;EAAQ;EAChC,CAAC;AAED,yDACGjC,wCAAe4C,UAAQ;EAACC,OAAOtC;EAAO,IAAA4B,WAAA;AAAA,2DACpCtC,sHAAY,EAAA,IACXkD,OAAI;AAAA,6CAAY9C,uCAAkB2B,QAAQ,EAAE,GAAGrB,QAAQwC,KAAI,KAAM;MAAA,EAC7DJ,MAAI,EAAA,IAAAR,WAAA;AAAA,4DACPJ,aAAW;KACGC;KACJzB;KAAO,IAChB0B,gBAAa;AAAA,aAAEA,eAAe;;KAAA,CAAA;MAAA,CAAA,CAAA;;EAAA,CAAA"}
+{"version":3,"file":"docs.cjs","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 { 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, ...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        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AA4CA,SAAgB,mBAAmB,OAAgC;CACjE,MAAM,EACJ,YACA;AACF,KAAA,OAAA,KAAA,QAAA,QAAA,CAAA,WAAA;AAGA,wDAAG,2EAAA,EACD,IAAE,OAAM;AACN,SAAE,4BAAO,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,6EAAkC;;;;;;GAElC;;AAEN,WAAO,kCAAA,QAAA;;GAEG;GACT,CAAC;kDAAoB,OAAA,EAAA,CAAA;EAAA,mBAAA;kDAAA,OAAA,EAAA,CAAA;EAAA;;;;;;CA8BtB,MAAE,EACA,cAAU,GACX,SACC,kBACA;AACF,QAAA;kDAAyB,4BAAA;GAC3B,OAAA,IAAA;;AAEE,WAAA,QAAA;;GAEA,CAAA;kDAAA,0DAAA,EAAA,CAAA;6CAAA,mBAAA,GAAA,QAAA,cAAA;kDAAA,0DAAA,EAAA,CAAA;kDAAA,4BAAA;GACF,OAAO,IAAQ;GACb,UAAQ;;;;;;GAER,IAAM,OAAC;AACJ,WAAA,iBAAA,cAAA,SAAA;;GAED,IAAG,WAAS;AACV,2DAAgB,yBAAa;KAC5B,gBAAS;KACD;KACR,CAAA;;GAEH,IAAG,WAAS;AACV,2DAAC,oBAAA;KACC,MAAM;KACN,UAAS;KACT,WAAG,mEAA2C,yBAAqB;MAClE;MACU;MACV,CAAC;KACH,CAAC;;GAEL,CAAC;kDAAmB,0DAAO,EAAA,CAAA;kDAAA,4BAAA;GAC1B,OAAO,IAAE;GACT,UAAO;GACR,CAAC;kDAAS,0DAAA,EAAA,CAAA;6CAAA,mBAAA,+CAAA,QAAA,KAAA,WAAA;kDAAA,0DAAA,EAAA,CAAA;kDAAA,oBAAA,EACD,SACT,CAAC;kDAAY,0DAAA,EAAA,CAAA;EAAA;;;;;AAsBhB,SAAgB,gBAAM,OAAA;SAElB,cAAA,GACA,SACA,GAAA,SACF;CACF,MAAA,6EAAA;;;;;;;AAEE,wDAAA,wCAAA,UAAA;EACC,OAAA;EACD,IAAA,WAAA;AACI,0DAAyB,oHAAQ,EAC/B,IAAE,OAAA;;MAGH,EAAC,MAAA,EACA,IAAI,WAAW;AACpB,2DAAA,aAAA;;KAEM;KACJ,IAAA,gBAAwB;AACtB,aAAA,eAAA;;KAEI,CAAC;MAEL,CAAC,CAAC;;EAEN,CAAC"}

package/dist/components/docs.d.cts

@@ -1,5 +1,5 @@
 import { CommandTree } from "../types/command.cjs";
-import * as _alloy_js_core22 from "@alloy-js/core";
+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 +12,7 @@ interface CommandOptionsDocsProps {
 /**
  * Generates the options markdown documentation for a command.
  */
-declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core22.Children;
+declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core0.Children;
 interface CommandDocsUsageExampleProps {
   /**
    * The package manager to generate the usage example for.
@@ -31,7 +31,7 @@ interface CommandDocsUsageExampleProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _alloy_js_core22.Children;
+declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _alloy_js_core0.Children;
 interface CommandDocsProps {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -56,7 +56,7 @@ interface CommandDocsProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocs(props: CommandDocsProps): _alloy_js_core22.Children;
+declare function CommandDocs(props: CommandDocsProps): _alloy_js_core0.Children;
 interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -75,7 +75,7 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
 /**
  * Generates the markdown documentation file for a command.
  */
-declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core22.Children;
+declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core0.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"],"sourcesContent":[],"mappings":";;;;;UAkCiB,uBAAA;;;AAAjB;EAUgB,OAAA,EANL,WAMK;AAwBhB;AAoBA;AAsBA;;AAqB2B,iBAvFX,kBAAA,CAuFW,KAAA,EAvFe,uBAuFf,CAAA,EAvFsC,gBAAA,CAAA,QAuFtC;AAAT,UA/DD,4BAAA,CA+DC;EAAQ;AAM1B;AAwCA;;;;;AAoBA;;;;;WAnHW;;;;;iBAMK,uBAAA,QAA+B,+BAA4B,gBAAA,CAAA;UAsB1D,gBAAA;;;;;;;;;;;;;WAcN;;;;;;kBAOO,SAAS;;;;;iBAMX,WAAA,QAAmB,mBAAgB,gBAAA,CAAA;UAwClC,oBAAA,SAA6B,QAAQ;;;;;;;;;;;;;WAc3C;;;;;iBAMK,eAAA,QAAuB,uBAAoB,gBAAA,CAAA"}
+{"version":3,"file":"docs.d.cts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":";;;;;UAkCiB,uBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;AAAA;;;AAMX;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,eAAA,CAAA,QAAA;AAAA,UAwBhD,4BAAA;EAxBgD;;;;;;AAwBjE;;EASE,cAAA;EAKoB;;;EAApB,OAAA,EAAS,WAAA;AAAA;;AAMX;;iBAAgB,uBAAA,CAAwB,KAAA,EAAO,4BAAA,GAA4B,eAAA,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,eAAA,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,eAAA,CAAA,QAAA"}

package/dist/components/docs.d.mts

@@ -1,5 +1,5 @@
 import { CommandTree } from "../types/command.mjs";
-import * as _alloy_js_core23 from "@alloy-js/core";
+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 +12,7 @@ interface CommandOptionsDocsProps {
 /**
  * Generates the options markdown documentation for a command.
  */
-declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core23.Children;
+declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core0.Children;
 interface CommandDocsUsageExampleProps {
   /**
    * The package manager to generate the usage example for.
@@ -31,7 +31,7 @@ interface CommandDocsUsageExampleProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _alloy_js_core23.Children;
+declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _alloy_js_core0.Children;
 interface CommandDocsProps {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -56,7 +56,7 @@ interface CommandDocsProps {
 /**
  * Generates the markdown documentation for a command.
  */
-declare function CommandDocs(props: CommandDocsProps): _alloy_js_core23.Children;
+declare function CommandDocs(props: CommandDocsProps): _alloy_js_core0.Children;
 interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -75,7 +75,7 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
 /**
  * Generates the markdown documentation file for a command.
  */
-declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core23.Children;
+declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core0.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"],"sourcesContent":[],"mappings":";;;;;UAkCiB,uBAAA;;;AAAjB;EAUgB,OAAA,EANL,WAMK;AAwBhB;AAoBA;AAsBA;;AAqB2B,iBAvFX,kBAAA,CAuFW,KAAA,EAvFe,uBAuFf,CAAA,EAvFsC,gBAAA,CAAA,QAuFtC;AAAT,UA/DD,4BAAA,CA+DC;EAAQ;AAM1B;AAwCA;;;;;AAoBA;;;;;WAnHW;;;;;iBAMK,uBAAA,QAA+B,+BAA4B,gBAAA,CAAA;UAsB1D,gBAAA;;;;;;;;;;;;;WAcN;;;;;;kBAOO,SAAS;;;;;iBAMX,WAAA,QAAmB,mBAAgB,gBAAA,CAAA;UAwClC,oBAAA,SAA6B,QAAQ;;;;;;;;;;;;;WAc3C;;;;;iBAMK,eAAA,QAAuB,uBAAoB,gBAAA,CAAA"}
+{"version":3,"file":"docs.d.mts","names":[],"sources":["../../src/components/docs.tsx"],"mappings":";;;;;UAkCiB,uBAAA;;;AAAjB;EAIE,OAAA,EAAS,WAAA;AAAA;;;AAMX;iBAAgB,kBAAA,CAAmB,KAAA,EAAO,uBAAA,GAAuB,eAAA,CAAA,QAAA;AAAA,UAwBhD,4BAAA;EAxBgD;;;;;;AAwBjE;;EASE,cAAA;EAKoB;;;EAApB,OAAA,EAAS,WAAA;AAAA;;AAMX;;iBAAgB,uBAAA,CAAwB,KAAA,EAAO,4BAAA,GAA4B,eAAA,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,eAAA,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,eAAA,CAAA,QAAA"}

package/dist/components/docs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"docs.mjs","names":["code","For","memo","Show","Heading","Spacing","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","CommandContext","getDocsOutputPath","getAppBin","sortOptions","Usage","CommandOptionsDocs","props","command","Object","keys","options","length","_$createComponent","data","values","map","option","name","trim","description","defaultValue","default","String","includes","required","optional","CommandDocsUsageExample","packageManager","context","_$createIntrinsic","bin","CommandDocs","levelOffset","usageExamples","level","children","title","_$memo","when","fallback","each","hardline","CommandDocsFile","rest","Provider","value","_$mergeProps","path"],"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 { 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, ...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        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA4CA,SAAgBe,mBAAmBC,OAAgC;CACjE,MAAM,EAAEC,YAAYD;AACpB,KAAIE,OAAOC,KAAKF,QAAQG,QAAQ,CAACC,WAAW,EAC1C,QAAOrB,IAAI;AAGb,QAAAsB,gBACGd,eAAa,EAAA,IACZe,OAAI;AAAA,SAAEV,YAAYK,OAAOM,OAAOP,QAAQG,QAAQ,CAAC,CAACK,KAAIC,WAAU;AAC9D,UAAO;IACLC,MAAMD,OAAOC,KAAKC,MAAM;IACxBC,aAAaH,OAAOG,YAAYD,MAAM;IACtCE,cAAcJ,OAAOK,UACjBC,OAAON,OAAOK,QAAQ,EAAEE,SAAS,KAAI,GACnCP,OAAOK,UACP,KAAKL,OAAOK,QAAO,MACrB;IACJG,UAAUR,OAAOS,YAAYT,OAAOK,UAAU,KAAK;IACpD;IACD;IAAA,CAAA;;;;;AAyBR,SAAgBK,wBAAwBpB,OAAqC;CAC3E,MAAM,EAAEqB,iBAAiB,OAAOpB,YAAYD;CAE5C,MAAMsB,UAAUhC,eAAwB;AAExC,QAAA;EAAAiC,gBAAA,OAAA,EAAA,CAAA;EAGKvC,IAAI;EAAauC,gBAAA,OAAA,EAAA,CAAA;EAAAjB,gBAEjBR,OAAK;GACKG;GAAO,IAChBuB,MAAG;AAAA,WAAE5B,UAAU0B,QAAQ;;GACPD;GAAc,CAAA;EAAAE,gBAAA,OAAA,EAAA,CAAA;EAG/BvC,IAAI;EAAQuC,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;AAiCnB,SAAgBE,YAAYzB,OAAyB;CACnD,MAAM,EAAE0B,cAAc,GAAGzB,SAAS0B,kBAAkB3B;AAEpD,QAAA;EAAAM,gBAEKlB,SAAO;GAACwC,OAAO,IAAIF;GAAW,IAAAG,WAAA;AAAA,WAAG5B,QAAQ6B;;GAAK,CAAA;EAAAxB,gBAC9CjB,SAAO,EAAA,CAAA;EAAA0C,WACP/C,IAAI,GAAGiB,QAAQY,cAAa;EAAAP,gBAC5BjB,SAAO,EAAA,CAAA;EAAAiB,gBACPlB,SAAO;GAACwC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;EAAAvB,gBAC9BjB,SAAO,EAAA,CAAA;EAAA0C,WACP/C,IAAI,OAAOiB,QAAQU,KAAI,uDAAuD;EAAAL,gBAC9EjB,SAAO,EAAA,CAAA;EAAAiB,gBACPnB,MAAI;GAAA,IACH6C,OAAI;AAAA,WAAEL,iBAAiBA,cAActB,SAAS;;GAAC,IAC/C4B,WAAQ;AAAA,WAAA3B,gBACLc,yBAAuB;KAACC,gBAAc;KAAgBpB;KAAO,CAAA;;GAAA,IAAA4B,WAAA;AAAA,WAAAvB,gBAE/DrB,KAAG;KAACiD,MAAMP;KAAgBQ,UAAQ;KAAAN,WAChCR,mBAAcf,gBACZc,yBAAuB;MACNC;MACPpB;MAAO,CAAA;KAEnB,CAAA;;GAAA,CAAA;EAAAK,gBAGJjB,SAAO,EAAA,CAAA;EAAAiB,gBACPlB,SAAO;GAACwC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;EAAAvB,gBAC9BjB,SAAO,EAAA,CAAA;EAAA0C,WACP/C,IAAI,+CACHiB,QAAQU,KAAI,WACH;EAAAL,gBACVjB,SAAO,EAAA,CAAA;EAAAiB,gBACPP,oBAAkB,EAAUE,SAAO,CAAA;EAAAK,gBACnCjB,SAAO,EAAA,CAAA;EAAA;;;;;AAyBd,SAAgB+C,gBAAgBpC,OAA6B;CAC3D,MAAM,EAAE0B,cAAc,GAAGzB,SAAS,GAAGoC,SAASrC;CAE9C,MAAMsB,UAAUhC,eAAwB;CACxC,MAAMqC,gBAAgBzC,aACd;EAAC;EAAO;EAAQ;EAAQ;EAChC,CAAC;AAED,QAAAoB,gBACGZ,eAAe4C,UAAQ;EAACC,OAAOtC;EAAO,IAAA4B,WAAA;AAAA,UAAAvB,gBACpCf,cAAYiD,WAAA,EAAA,IACXC,OAAI;AAAA,WAAEhD,UAAUE,kBAAkB2B,QAAQ,EAAE,GAAGrB,QAAQwC,KAAI,KAAM;MAAA,EAC7DJ,MAAI,EAAA,IAAAR,WAAA;AAAA,WAAAvB,gBACPmB,aAAW;KACGC;KACJzB;KAAO,IAChB0B,gBAAa;AAAA,aAAEA,eAAe;;KAAA,CAAA;MAAA,CAAA,CAAA;;EAAA,CAAA"}
+{"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 { 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, ...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        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA4CA,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,GAAA,SACF;CACF,MAAA,UAAA,eAAA;;;;;;;AAEE,QAAA,gBAAA,eAAA,UAAA;EACC,OAAA;EACD,IAAA,WAAA;AACI,UAAC,gBAAwB,cAAQ,WAAA,EAC/B,IAAE,OAAA;;MAGH,EAAC,MAAA,EACA,IAAI,WAAW;AACpB,WAAA,gBAAA,aAAA;;KAEM;KACJ,IAAA,gBAAwB;AACtB,aAAA,eAAA;;KAEI,CAAC;MAEL,CAAC,CAAC;;EAEN,CAAC"}

package/dist/components/helpers.cjs

@@ -1,7 +1,8 @@
-const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
 const require_types_command = require('../types/command.cjs');
-let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
-let __alloy_js_core = require("@alloy-js/core");
+let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let _alloy_js_core = require("@alloy-js/core");
 
 //#region src/components/helpers.tsx
 /**
@@ -9,7 +10,7 @@ let __alloy_js_core = require("@alloy-js/core");
 */
 function BooleanInputParserLogic(props) {
 	const { name } = props;
-	return [__alloy_js_core.code` !!${name} && ${name}.toLowerCase() !== "false" && ${name}.toLowerCase() !== "f" && ${name}.toLowerCase() !== "no" && ${name} !== "n" && ${name}.toLowerCase() !== "0" && ${name}.toLowerCase() !== "off" && ${name} !== "disable" && ${name}.toLowerCase() !== "disabled" && ${name}.toLowerCase() !== "never" && (Number.isNaN(Number.parseFloat(${name})) || Number.parseFloat(${name}) > 0) `];
+	return [_alloy_js_core.code` !!${name} && ${name}.toLowerCase() !== "false" && ${name}.toLowerCase() !== "f" && ${name}.toLowerCase() !== "no" && ${name} !== "n" && ${name}.toLowerCase() !== "0" && ${name}.toLowerCase() !== "off" && ${name} !== "disable" && ${name}.toLowerCase() !== "disabled" && ${name}.toLowerCase() !== "never" && (Number.isNaN(Number.parseFloat(${name})) || Number.parseFloat(${name}) > 0) `];
 }
 /**
 * Write the logic to determine if the application is running in debug mode.
@@ -18,16 +19,16 @@ function BooleanInputParserLogic(props) {
 * This is used to conditionally include debug-only logic in the generated application, such as additional logging or development tools. The logic should check for common indicators of debug mode, such as environment variables or the presence of a debugger.
 */
 function IsDebug() {
-	return __alloy_js_core.code`isDevelopment || isDebug || env.LOG_LEVEL === "debug"`;
+	return _alloy_js_core.code`isDevelopment || isDebug || env.LOG_LEVEL === "debug"`;
 }
 /**
 * Write the logic to determine if the application is **not** running in debug mode.
 */
 function IsNotDebug() {
 	return [
-		__alloy_js_core.code`!(`,
-		(0, __alloy_js_core_jsx_runtime.createComponent)(IsDebug, {}),
-		__alloy_js_core.code`)`
+		_alloy_js_core.code`!(`,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(IsDebug, {}),
+		_alloy_js_core.code`)`
 	];
 }
 /**
@@ -38,9 +39,9 @@ function IsNotDebug() {
 */
 function IsVerbose() {
 	return [
-		__alloy_js_core.code`( `,
-		(0, __alloy_js_core_jsx_runtime.createComponent)(IsDebug, {}),
-		__alloy_js_core.code`|| hasFlag(["verbose", "verbose=true", "verbose=always"]))`
+		_alloy_js_core.code`( `,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(IsDebug, {}),
+		_alloy_js_core.code`|| hasFlag(["verbose", "verbose=true", "verbose=always"]))`
 	];
 }
 /**
@@ -48,9 +49,9 @@ function IsVerbose() {
 */
 function IsNotVerbose() {
 	return [
-		__alloy_js_core.code`!(`,
-		(0, __alloy_js_core_jsx_runtime.createComponent)(IsVerbose, {}),
-		__alloy_js_core.code`)`
+		_alloy_js_core.code`!(`,
+		(0, _alloy_js_core_jsx_runtime.createComponent)(IsVerbose, {}),
+		_alloy_js_core.code`)`
 	];
 }
 /**
@@ -58,7 +59,7 @@ function IsNotVerbose() {
 */
 function CommandParameterType(props) {
 	const { parameter } = props;
-	return __alloy_js_core.code`${(parameter.kind === require_types_command.CommandParameterKinds.string || parameter.kind === require_types_command.CommandParameterKinds.number) && parameter.choices && parameter.choices.length > 0 ? parameter.choices.map((choice) => typeof choice === "string" ? `"${choice}"` : choice).join(" | ") : parameter.kind === require_types_command.CommandParameterKinds.boolean ? "boolean" : parameter.kind === require_types_command.CommandParameterKinds.number ? "number" : "string"}${(parameter.kind === require_types_command.CommandParameterKinds.string || parameter.kind === require_types_command.CommandParameterKinds.number) && parameter.variadic ? "[]" : ""}${parameter.optional ? " | undefined" : ""}`;
+	return _alloy_js_core.code`${(parameter.kind === require_types_command.CommandParameterKinds.string || parameter.kind === require_types_command.CommandParameterKinds.number) && parameter.choices && parameter.choices.length > 0 ? parameter.choices.map((choice) => typeof choice === "string" ? `"${choice}"` : choice).join(" | ") : parameter.kind === require_types_command.CommandParameterKinds.boolean ? "boolean" : parameter.kind === require_types_command.CommandParameterKinds.number ? "number" : "string"}${(parameter.kind === require_types_command.CommandParameterKinds.string || parameter.kind === require_types_command.CommandParameterKinds.number) && parameter.variadic ? "[]" : ""}${parameter.optional ? " | undefined" : ""}`;
 }
 
 //#endregion

package/dist/components/helpers.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.cjs","names":["code","CommandParameterKinds","BooleanInputParserLogic","props","name","IsDebug","IsNotDebug","_$createComponent","IsVerbose","IsNotVerbose","CommandParameterType","parameter","kind","string","number","choices","length","map","choice","join","boolean","variadic","optional"],"sources":["../../src/components/helpers.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 } from \"@alloy-js/core\";\nimport type { CommandParameter } from \"../types\";\nimport { CommandParameterKinds } from \"../types\";\n\nexport interface BooleanInputParserLogicProps {\n  name: string;\n}\n\n/**\n * Parses a string input into a boolean value, interpreting common truthy and falsy string representations.\n */\nexport function BooleanInputParserLogic(props: BooleanInputParserLogicProps) {\n  const { name } = props;\n\n  return (\n    <>{code` !!${name} && ${name}.toLowerCase() !== \"false\" && ${\n      name\n    }.toLowerCase() !== \"f\" && ${name}.toLowerCase() !== \"no\" && ${\n      name\n    } !== \"n\" && ${name}.toLowerCase() !== \"0\" && ${\n      name\n    }.toLowerCase() !== \"off\" && ${\n      name\n    } !== \"disable\" && ${name}.toLowerCase() !== \"disabled\" && ${\n      name\n    }.toLowerCase() !== \"never\" && (Number.isNaN(Number.parseFloat(${\n      name\n    })) || Number.parseFloat(${name}) > 0) `}</>\n  );\n}\n\n/**\n * Write the logic to determine if the application is running in debug mode.\n *\n * @remarks\n * This is used to conditionally include debug-only logic in the generated application, such as additional logging or development tools. The logic should check for common indicators of debug mode, such as environment variables or the presence of a debugger.\n */\nexport function IsDebug() {\n  return code`isDevelopment || isDebug || env.LOG_LEVEL === \"debug\"`;\n}\n\n/**\n * Write the logic to determine if the application is **not** running in debug mode.\n */\nexport function IsNotDebug() {\n  return (\n    <>\n      {code`!(`}\n      <IsDebug />\n      {code`)`}\n    </>\n  );\n}\n\n/**\n * Write the logic to determine if the application is running in verbose mode.\n *\n * @remarks\n * This is used to conditionally include verbose-only logic in the generated application, such as additional logging or detailed output. The logic should check for common indicators of verbose mode, such as environment variables or command-line flags.\n */\nexport function IsVerbose() {\n  return (\n    <>\n      {code`( `}\n      <IsDebug />\n      {code`|| hasFlag([\"verbose\", \"verbose=true\", \"verbose=always\"]))`}\n    </>\n  );\n}\n\n/**\n * Write the logic to determine if the application is **not** running in verbose mode.\n */\nexport function IsNotVerbose() {\n  return (\n    <>\n      {code`!(`}\n      <IsVerbose />\n      {code`)`}\n    </>\n  );\n}\n\n/**\n * Write the type declaration for a command parameter based on its configuration.\n */\nexport function CommandParameterType(props: { parameter: CommandParameter }) {\n  const { parameter } = props;\n\n  return code`${\n    (parameter.kind === CommandParameterKinds.string ||\n      parameter.kind === CommandParameterKinds.number) &&\n    parameter.choices &&\n    parameter.choices.length > 0\n      ? parameter.choices\n          .map(choice => (typeof choice === \"string\" ? `\"${choice}\"` : choice))\n          .join(\" | \")\n      : parameter.kind === CommandParameterKinds.boolean\n        ? \"boolean\"\n        : parameter.kind === CommandParameterKinds.number\n          ? \"number\"\n          : \"string\"\n  }${\n    (parameter.kind === CommandParameterKinds.string ||\n      parameter.kind === CommandParameterKinds.number) &&\n    parameter.variadic\n      ? \"[]\"\n      : \"\"\n  }${parameter.optional ? \" | undefined\" : \"\"}`;\n}\n"],"mappings":";;;;;;;;;AA6BA,SAAgBE,wBAAwBC,OAAqC;CAC3E,MAAM,EAAEC,SAASD;AAEjB,QAAA,CACKH,oBAAI,MAAMI,KAAI,MAAOA,KAAI,gCAC1BA,KAAI,4BACuBA,KAAI,6BAC/BA,KAAI,cACSA,KAAI,4BACjBA,KAAI,8BAEJA,KAAI,oBACeA,KAAI,mCACvBA,KAAI,gEAEJA,KAAI,0BACqBA,KAAI,SAAS;;;;;;;;AAU5C,SAAgBC,UAAU;AACxB,QAAOL,oBAAI;;;;;AAMb,SAAgBM,aAAa;AAC3B,QAAA;EAEKN,oBAAI;mDACJK,SAAO,EAAA,CAAA;EACPL,oBAAI;EAAG;;;;;;;;AAWd,SAAgBQ,YAAY;AAC1B,QAAA;EAEKR,oBAAI;mDACJK,SAAO,EAAA,CAAA;EACPL,oBAAI;EAA4D;;;;;AAQvE,SAAgBS,eAAe;AAC7B,QAAA;EAEKT,oBAAI;mDACJQ,WAAS,EAAA,CAAA;EACTR,oBAAI;EAAG;;;;;AAQd,SAAgBU,qBAAqBP,OAAwC;CAC3E,MAAM,EAAEQ,cAAcR;AAEtB,QAAOH,oBAAI,IACRW,UAAUC,SAASX,4CAAsBY,UACxCF,UAAUC,SAASX,4CAAsBa,WAC3CH,UAAUI,WACVJ,UAAUI,QAAQC,SAAS,IACvBL,UAAUI,QACPE,KAAIC,WAAW,OAAOA,WAAW,WAAW,IAAIA,OAAM,KAAMA,OAAQ,CACpEC,KAAK,MAAM,GACdR,UAAUC,SAASX,4CAAsBmB,UACvC,YACAT,UAAUC,SAASX,4CAAsBa,SACvC,WACA,YAEPH,UAAUC,SAASX,4CAAsBY,UACxCF,UAAUC,SAASX,4CAAsBa,WAC3CH,UAAUU,WACN,OACA,KACHV,UAAUW,WAAW,iBAAiB"}
+{"version":3,"file":"helpers.cjs","names":[],"sources":["../../src/components/helpers.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 } from \"@alloy-js/core\";\nimport type { CommandParameter } from \"../types\";\nimport { CommandParameterKinds } from \"../types\";\n\nexport interface BooleanInputParserLogicProps {\n  name: string;\n}\n\n/**\n * Parses a string input into a boolean value, interpreting common truthy and falsy string representations.\n */\nexport function BooleanInputParserLogic(props: BooleanInputParserLogicProps) {\n  const { name } = props;\n\n  return (\n    <>{code` !!${name} && ${name}.toLowerCase() !== \"false\" && ${\n      name\n    }.toLowerCase() !== \"f\" && ${name}.toLowerCase() !== \"no\" && ${\n      name\n    } !== \"n\" && ${name}.toLowerCase() !== \"0\" && ${\n      name\n    }.toLowerCase() !== \"off\" && ${\n      name\n    } !== \"disable\" && ${name}.toLowerCase() !== \"disabled\" && ${\n      name\n    }.toLowerCase() !== \"never\" && (Number.isNaN(Number.parseFloat(${\n      name\n    })) || Number.parseFloat(${name}) > 0) `}</>\n  );\n}\n\n/**\n * Write the logic to determine if the application is running in debug mode.\n *\n * @remarks\n * This is used to conditionally include debug-only logic in the generated application, such as additional logging or development tools. The logic should check for common indicators of debug mode, such as environment variables or the presence of a debugger.\n */\nexport function IsDebug() {\n  return code`isDevelopment || isDebug || env.LOG_LEVEL === \"debug\"`;\n}\n\n/**\n * Write the logic to determine if the application is **not** running in debug mode.\n */\nexport function IsNotDebug() {\n  return (\n    <>\n      {code`!(`}\n      <IsDebug />\n      {code`)`}\n    </>\n  );\n}\n\n/**\n * Write the logic to determine if the application is running in verbose mode.\n *\n * @remarks\n * This is used to conditionally include verbose-only logic in the generated application, such as additional logging or detailed output. The logic should check for common indicators of verbose mode, such as environment variables or command-line flags.\n */\nexport function IsVerbose() {\n  return (\n    <>\n      {code`( `}\n      <IsDebug />\n      {code`|| hasFlag([\"verbose\", \"verbose=true\", \"verbose=always\"]))`}\n    </>\n  );\n}\n\n/**\n * Write the logic to determine if the application is **not** running in verbose mode.\n */\nexport function IsNotVerbose() {\n  return (\n    <>\n      {code`!(`}\n      <IsVerbose />\n      {code`)`}\n    </>\n  );\n}\n\n/**\n * Write the type declaration for a command parameter based on its configuration.\n */\nexport function CommandParameterType(props: { parameter: CommandParameter }) {\n  const { parameter } = props;\n\n  return code`${\n    (parameter.kind === CommandParameterKinds.string ||\n      parameter.kind === CommandParameterKinds.number) &&\n    parameter.choices &&\n    parameter.choices.length > 0\n      ? parameter.choices\n          .map(choice => (typeof choice === \"string\" ? `\"${choice}\"` : choice))\n          .join(\" | \")\n      : parameter.kind === CommandParameterKinds.boolean\n        ? \"boolean\"\n        : parameter.kind === CommandParameterKinds.number\n          ? \"number\"\n          : \"string\"\n  }${\n    (parameter.kind === CommandParameterKinds.string ||\n      parameter.kind === CommandParameterKinds.number) &&\n    parameter.variadic\n      ? \"[]\"\n      : \"\"\n  }${parameter.optional ? \" | undefined\" : \"\"}`;\n}\n"],"mappings":";;;;;;;;;;AA6BA,SAAgB,wBAAwB,OAAqC;CAC3E,MAAM,WAEN;AACA,QAAK,CAAA,mBAAO,MAAG,KAAQ,MAAG,KAAM,gCAA8B,KAAA,4BAAA,KAAA,6BAAA,KAAA,cAAA,KAAA,4BAAA,KAAA,8BAAA,KAAA,oBAAA,KAAA,mCAAA,KAAA,gEAAA,KAAA,0BAAA,KAAA,SAAA;;;;;;;;AAShE,SAAM,UAAA;AACJ,QAAI,mBAAA;;;;;AAMN,SAAE,aAAA;AACA,QAAO;EAAA,mBAAI;kDAAyB,SAAC,EAAA,CAAW;EAAC,mBAAG;EAAA;;;;;;;;AAStD,SAAE,YAAA;AACA,QAAO;EAAA,mBAAI;kDAAyB,SAAC,EAAA,CAAW;EAAC,mBAAK;EAA2B;;;;;AAMnF,SAAgB,eAAA;AACd,QAAK;EAAA,mBAAO;kDAAA,WAAA,EAAA,CAAA;EAAA,mBAAA;EAAA;;;;;AAMd,SAAa,qBAAsB,OAEhC;CACD,MAAM,EACN,cACI;AACJ,QAAO,mBAAA,IAAA,UAAA,SAAA,4CAAA,UAAA,UAAA,SAAA,4CAAA,WAAA,UAAA,WAAA,UAAA,QAAA,SAAA,IAAA,UAAA,QAAA,KAAA,WAAA,OAAA,WAAA,WAAA,IAAA,OAAA,KAAA,OAAA,CAAA,KAAA,MAAA,GAAA,UAAA,SAAA,4CAAA,UAAA,YAAA,UAAA,SAAA,4CAAA,SAAA,WAAA,YAAA,UAAA,SAAA,4CAAA,UAAA,UAAA,SAAA,4CAAA,WAAA,UAAA,WAAA,OAAA,KAAA,UAAA,WAAA,iBAAA"}

package/dist/components/helpers.d.cts

@@ -1,6 +1,5 @@
 import { CommandParameter } from "../types/command.cjs";
-import "../types/index.cjs";
-import * as _alloy_js_core15 from "@alloy-js/core";
+import * as _alloy_js_core0 from "@alloy-js/core";
 
 //#region src/components/helpers.d.ts
 interface BooleanInputParserLogicProps {
@@ -9,35 +8,35 @@ interface BooleanInputParserLogicProps {
 /**
  * Parses a string input into a boolean value, interpreting common truthy and falsy string representations.
  */
-declare function BooleanInputParserLogic(props: BooleanInputParserLogicProps): _alloy_js_core15.Children;
+declare function BooleanInputParserLogic(props: BooleanInputParserLogicProps): _alloy_js_core0.Children;
 /**
  * Write the logic to determine if the application is running in debug mode.
  *
  * @remarks
  * This is used to conditionally include debug-only logic in the generated application, such as additional logging or development tools. The logic should check for common indicators of debug mode, such as environment variables or the presence of a debugger.
  */
-declare function IsDebug(): _alloy_js_core15.Children;
+declare function IsDebug(): _alloy_js_core0.Children;
 /**
  * Write the logic to determine if the application is **not** running in debug mode.
  */
-declare function IsNotDebug(): _alloy_js_core15.Children;
+declare function IsNotDebug(): _alloy_js_core0.Children;
 /**
  * Write the logic to determine if the application is running in verbose mode.
  *
  * @remarks
  * This is used to conditionally include verbose-only logic in the generated application, such as additional logging or detailed output. The logic should check for common indicators of verbose mode, such as environment variables or command-line flags.
  */
-declare function IsVerbose(): _alloy_js_core15.Children;
+declare function IsVerbose(): _alloy_js_core0.Children;
 /**
  * Write the logic to determine if the application is **not** running in verbose mode.
  */
-declare function IsNotVerbose(): _alloy_js_core15.Children;
+declare function IsNotVerbose(): _alloy_js_core0.Children;
 /**
  * Write the type declaration for a command parameter based on its configuration.
  */
 declare function CommandParameterType(props: {
   parameter: CommandParameter;
-}): _alloy_js_core15.Children;
+}): _alloy_js_core0.Children;
 //#endregion
 export { BooleanInputParserLogic, BooleanInputParserLogicProps, CommandParameterType, IsDebug, IsNotDebug, IsNotVerbose, IsVerbose };
 //# sourceMappingURL=helpers.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.cts","names":[],"sources":["../../src/components/helpers.tsx"],"sourcesContent":[],"mappings":";;;;;UAsBiB,4BAAA;;;;AAAjB;AAOA;AA0BgB,iBA1BA,uBAAA,CA0BO,KAAA,EA1BwB,4BA0BxB,CAAA,EA1BoD,gBAAA,CAAA,QA0BpD;AAOvB;AAgBA;AAaA;AAaA;;;iBAjDgB,OAAA,CAAA,GAAO,gBAAA,CAAA;;;;iBAOP,UAAA,CAAA,GAAU,gBAAA,CAAA;;;;;;;iBAgBV,SAAA,CAAA,GAAS,gBAAA,CAAA;;;;iBAaT,YAAA,CAAA,GAAY,gBAAA,CAAA;;;;iBAaZ,oBAAA;aAAyC;IAAgB,gBAAA,CAAE"}
+{"version":3,"file":"helpers.d.cts","names":[],"sources":["../../src/components/helpers.tsx"],"mappings":";;;;UAsBiB,4BAAA;EACf,IAAA;AAAA;;AADF;;iBAOgB,uBAAA,CAAwB,KAAA,EAAO,4BAAA,GAA4B,eAAA,CAAA,QAAA;;;AAA3E;;;;iBA0BgB,OAAA,CAAA,GAAO,eAAA,CAAA,QAAA;;;;iBAOP,UAAA,CAAA,GAAU,eAAA,CAAA,QAAA;AAP1B;;;;;AAOA;AAPA,iBAuBgB,SAAA,CAAA,GAAS,eAAA,CAAA,QAAA;;;;iBAaT,YAAA,CAAA,GAAY,eAAA,CAAA,QAAA;;;;iBAaZ,oBAAA,CAAqB,KAAA;EAAS,SAAA,EAAW,gBAAA;AAAA,IAAgB,eAAA,CAAE,QAAA"}