@shell-shock/core 0.11.0 → 0.12.1

package/dist/helpers/automd.cjs

@@ -28,7 +28,7 @@ const commands = (context) => (0, automd.defineGenerator)({
 				children: "Commands"
 			}),
 			(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 commands are available in the ${require_context_helpers.getAppTitle(context)} CLI application:`),
+			(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`The following commands are available in the ${require_context_helpers.getAppTitle(context, true)} command-line interface application:`),
 			(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 			(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core_components.For, {
 				get each() {

package/dist/helpers/automd.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"automd.cjs","names":["code","For","Show","Heading","Spacing","renderString","defineGenerator","CommandDocs","getAppTitle","commands","context","name","generate","contents","_$createComponent","level","children","_$memo","each","Object","values","doubleHardline","child","when","isVirtual","command","levelOffset"],"sources":["../../src/helpers/automd.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 { For, Show } from \"@alloy-js/core/components\";\nimport { Heading } from \"@alloy-js/markdown\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { renderString } from \"@powerlines/plugin-alloy/render\";\nimport { defineGenerator } from \"automd\";\nimport { CommandDocs } from \"../components/docs\";\nimport { getAppTitle } from \"../plugin-utils\";\nimport type { Context } from \"../types/context\";\n\n/**\n * AutoMD generator to generate CLI command documentation\n *\n * @see https://automd.unjs.io/\n *\n * @param context - The generator context.\n * @returns The generated documentation content.\n */\nexport const commands = (context: Context) =>\n  defineGenerator({\n    name: \"commands\",\n    async generate() {\n      return {\n        contents: renderString(\n          context,\n          <>\n            <Heading level={2}>Commands</Heading>\n            <Spacing />\n            {code`The following commands are available in the ${getAppTitle(\n              context\n            )} CLI application:`}\n            <Spacing />\n            <For each={Object.values(context.commands)} doubleHardline>\n              {child => (\n                <Show when={!child.isVirtual}>\n                  <CommandDocs command={child} levelOffset={2} />\n                </Show>\n              )}\n            </For>\n            <Spacing />\n          </>\n        )\n      };\n    }\n  });\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAoCA,MAAaS,YAAYC,wCACP;CACdC,MAAM;CACN,MAAMC,WAAW;AACf,SAAO,EACLC,6DACEH,SAAO;oDAEJP,6BAAO;IAACY,OAAO;IAACC,UAAA;IAAA,CAAA;oDAChBZ,2DAAO,EAAA,CAAA;+CACPJ,oBAAI,+CAA+CQ,oCAClDE,QACD,CAAA,mBAAmB;oDACnBN,2DAAO,EAAA,CAAA;oDACPH,gCAAG;IAAA,IAACiB,OAAI;AAAA,YAAEC,OAAOC,OAAOV,QAAQD,SAAS;;IAAEY,gBAAc;IAAAL,WACvDM,2DACEpB,iCAAI;KAAA,IAACqB,OAAI;AAAA,aAAE,CAACD,MAAME;;KAAS,IAAAR,WAAA;AAAA,8DACzBT,qCAAW;OAACkB,SAASH;OAAOI,aAAa;OAAC,CAAA;;KAAA,CAAA;IAE9C,CAAA;oDAEFtB,2DAAO,EAAA,CAAA;GAEZ,CAAA,EACD;;CAEJ,CAAC"}
+{"version":3,"file":"automd.cjs","names":["code","For","Show","Heading","Spacing","renderString","defineGenerator","CommandDocs","getAppTitle","commands","context","name","generate","contents","_$createComponent","level","children","_$memo","each","Object","values","doubleHardline","child","when","isVirtual","command","levelOffset"],"sources":["../../src/helpers/automd.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 { For, Show } from \"@alloy-js/core/components\";\nimport { Heading } from \"@alloy-js/markdown\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { renderString } from \"@powerlines/plugin-alloy/render\";\nimport { defineGenerator } from \"automd\";\nimport { CommandDocs } from \"../components/docs\";\nimport { getAppTitle } from \"../plugin-utils\";\nimport type { Context } from \"../types/context\";\n\n/**\n * AutoMD generator to generate CLI command documentation\n *\n * @see https://automd.unjs.io/\n *\n * @param context - The generator context.\n * @returns The generated documentation content.\n */\nexport const commands = (context: Context) =>\n  defineGenerator({\n    name: \"commands\",\n    async generate() {\n      return {\n        contents: renderString(\n          context,\n          <>\n            <Heading level={2}>Commands</Heading>\n            <Spacing />\n            {code`The following commands are available in the ${getAppTitle(\n              context,\n              true\n            )} command-line interface application:`}\n            <Spacing />\n            <For each={Object.values(context.commands)} doubleHardline>\n              {child => (\n                <Show when={!child.isVirtual}>\n                  <CommandDocs command={child} levelOffset={2} />\n                </Show>\n              )}\n            </For>\n            <Spacing />\n          </>\n        )\n      };\n    }\n  });\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAoCA,MAAaS,YAAYC,wCACP;CACdC,MAAM;CACN,MAAMC,WAAW;AACf,SAAO,EACLC,6DACEH,SAAO;oDAEJP,6BAAO;IAACY,OAAO;IAACC,UAAA;IAAA,CAAA;oDAChBZ,2DAAO,EAAA,CAAA;+CACPJ,oBAAI,+CAA+CQ,oCAClDE,SACA,KACD,CAAA,sCAAsC;oDACtCN,2DAAO,EAAA,CAAA;oDACPH,gCAAG;IAAA,IAACiB,OAAI;AAAA,YAAEC,OAAOC,OAAOV,QAAQD,SAAS;;IAAEY,gBAAc;IAAAL,WACvDM,2DACEpB,iCAAI;KAAA,IAACqB,OAAI;AAAA,aAAE,CAACD,MAAME;;KAAS,IAAAR,WAAA;AAAA,8DACzBT,qCAAW;OAACkB,SAASH;OAAOI,aAAa;OAAC,CAAA;;KAAA,CAAA;IAE9C,CAAA;oDAEFtB,2DAAO,EAAA,CAAA;GAEZ,CAAA,EACD;;CAEJ,CAAC"}

package/dist/helpers/automd.mjs

@@ -27,7 +27,7 @@ const commands = (context) => defineGenerator({
 				children: "Commands"
 			}),
 			createComponent(Spacing, {}),
-			memo(() => code`The following commands are available in the ${getAppTitle(context)} CLI application:`),
+			memo(() => code`The following commands are available in the ${getAppTitle(context, true)} command-line interface application:`),
 			createComponent(Spacing, {}),
 			createComponent(For, {
 				get each() {

package/dist/helpers/automd.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"automd.mjs","names":["code","For","Show","Heading","Spacing","renderString","defineGenerator","CommandDocs","getAppTitle","commands","context","name","generate","contents","_$createComponent","level","children","_$memo","each","Object","values","doubleHardline","child","when","isVirtual","command","levelOffset"],"sources":["../../src/helpers/automd.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 { For, Show } from \"@alloy-js/core/components\";\nimport { Heading } from \"@alloy-js/markdown\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { renderString } from \"@powerlines/plugin-alloy/render\";\nimport { defineGenerator } from \"automd\";\nimport { CommandDocs } from \"../components/docs\";\nimport { getAppTitle } from \"../plugin-utils\";\nimport type { Context } from \"../types/context\";\n\n/**\n * AutoMD generator to generate CLI command documentation\n *\n * @see https://automd.unjs.io/\n *\n * @param context - The generator context.\n * @returns The generated documentation content.\n */\nexport const commands = (context: Context) =>\n  defineGenerator({\n    name: \"commands\",\n    async generate() {\n      return {\n        contents: renderString(\n          context,\n          <>\n            <Heading level={2}>Commands</Heading>\n            <Spacing />\n            {code`The following commands are available in the ${getAppTitle(\n              context\n            )} CLI application:`}\n            <Spacing />\n            <For each={Object.values(context.commands)} doubleHardline>\n              {child => (\n                <Show when={!child.isVirtual}>\n                  <CommandDocs command={child} levelOffset={2} />\n                </Show>\n              )}\n            </For>\n            <Spacing />\n          </>\n        )\n      };\n    }\n  });\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAoCA,MAAaS,YAAYC,YACvBJ,gBAAgB;CACdK,MAAM;CACN,MAAMC,WAAW;AACf,SAAO,EACLC,UAAUR,aACRK,SAAO;GAAAI,gBAEJX,SAAO;IAACY,OAAO;IAACC,UAAA;IAAA,CAAA;GAAAF,gBAChBV,SAAO,EAAA,CAAA;GAAAa,WACPjB,IAAI,+CAA+CQ,YAClDE,QACD,CAAA,mBAAmB;GAAAI,gBACnBV,SAAO,EAAA,CAAA;GAAAU,gBACPb,KAAG;IAAA,IAACiB,OAAI;AAAA,YAAEC,OAAOC,OAAOV,QAAQD,SAAS;;IAAEY,gBAAc;IAAAL,WACvDM,UAAKR,gBACHZ,MAAI;KAAA,IAACqB,OAAI;AAAA,aAAE,CAACD,MAAME;;KAAS,IAAAR,WAAA;AAAA,aAAAF,gBACzBP,aAAW;OAACkB,SAASH;OAAOI,aAAa;OAAC,CAAA;;KAAA,CAAA;IAE9C,CAAA;GAAAZ,gBAEFV,SAAO,EAAA,CAAA;GAEZ,CAAA,EACD;;CAEJ,CAAC"}
+{"version":3,"file":"automd.mjs","names":["code","For","Show","Heading","Spacing","renderString","defineGenerator","CommandDocs","getAppTitle","commands","context","name","generate","contents","_$createComponent","level","children","_$memo","each","Object","values","doubleHardline","child","when","isVirtual","command","levelOffset"],"sources":["../../src/helpers/automd.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 { For, Show } from \"@alloy-js/core/components\";\nimport { Heading } from \"@alloy-js/markdown\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { renderString } from \"@powerlines/plugin-alloy/render\";\nimport { defineGenerator } from \"automd\";\nimport { CommandDocs } from \"../components/docs\";\nimport { getAppTitle } from \"../plugin-utils\";\nimport type { Context } from \"../types/context\";\n\n/**\n * AutoMD generator to generate CLI command documentation\n *\n * @see https://automd.unjs.io/\n *\n * @param context - The generator context.\n * @returns The generated documentation content.\n */\nexport const commands = (context: Context) =>\n  defineGenerator({\n    name: \"commands\",\n    async generate() {\n      return {\n        contents: renderString(\n          context,\n          <>\n            <Heading level={2}>Commands</Heading>\n            <Spacing />\n            {code`The following commands are available in the ${getAppTitle(\n              context,\n              true\n            )} command-line interface application:`}\n            <Spacing />\n            <For each={Object.values(context.commands)} doubleHardline>\n              {child => (\n                <Show when={!child.isVirtual}>\n                  <CommandDocs command={child} levelOffset={2} />\n                </Show>\n              )}\n            </For>\n            <Spacing />\n          </>\n        )\n      };\n    }\n  });\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAoCA,MAAaS,YAAYC,YACvBJ,gBAAgB;CACdK,MAAM;CACN,MAAMC,WAAW;AACf,SAAO,EACLC,UAAUR,aACRK,SAAO;GAAAI,gBAEJX,SAAO;IAACY,OAAO;IAACC,UAAA;IAAA,CAAA;GAAAF,gBAChBV,SAAO,EAAA,CAAA;GAAAa,WACPjB,IAAI,+CAA+CQ,YAClDE,SACA,KACD,CAAA,sCAAsC;GAAAI,gBACtCV,SAAO,EAAA,CAAA;GAAAU,gBACPb,KAAG;IAAA,IAACiB,OAAI;AAAA,YAAEC,OAAOC,OAAOV,QAAQD,SAAS;;IAAEY,gBAAc;IAAAL,WACvDM,UAAKR,gBACHZ,MAAI;KAAA,IAACqB,OAAI;AAAA,aAAE,CAACD,MAAME;;KAAS,IAAAR,WAAA;AAAA,aAAAF,gBACzBP,aAAW;OAACkB,SAASH;OAAOI,aAAa;OAAC,CAAA;;KAAA,CAAA;IAE9C,CAAA;GAAAZ,gBAEFV,SAAO,EAAA,CAAA;GAEZ,CAAA,EACD;;CAEJ,CAAC"}

package/dist/plugin-utils/description-helpers.cjs

@@ -0,0 +1,105 @@
+
+//#region src/plugin-utils/description-helpers.ts
+const __ΩFormatDescriptionOptions = [
+	"replaceNewlines",
+	true,
+	"collapseWhitespace",
+	"FormatDescriptionOptions",
+	"P)4!8>\")4#8>\"Mw$y"
+];
+/**
+* Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+*
+* @remarks
+* This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+*
+* @param description - The full description string.
+* @returns The formatted description string.
+*/
+function formatDescriptionWhitespace(description, options = {}) {
+	let formattedDescription = description.trim();
+	if (options.replaceNewlines) formattedDescription = formattedDescription.replace(/\s*\n\s*/g, " ");
+	if (options.collapseWhitespace) formattedDescription = formattedDescription.replace(/\s{2,}/g, " ");
+	return formattedDescription.trim();
+}
+formatDescriptionWhitespace.__type = [
+	"description",
+	() => __ΩFormatDescriptionOptions,
+	"options",
+	() => ({}),
+	"formatDescriptionWhitespace",
+	"P&2!n\"2#>$&/%"
+];
+/**
+* Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+*
+* @remarks
+* This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+*
+* @param description - The full description string.
+* @returns The formatted description string.
+*/
+function formatDescriptionEscapes(description) {
+	return description.replaceAll("'", "\\'").replaceAll("\"", "\\\"").replaceAll("`", "\\`").replace(/\$\{/g, "\\${");
+}
+formatDescriptionEscapes.__type = [
+	"description",
+	"formatDescriptionEscapes",
+	"P&2!&/\""
+];
+/**
+* Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+*
+* @remarks
+* This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+*
+* @param description - The full description string.
+* @returns The formatted description string.
+*/
+function formatDescription(description, options = {}) {
+	return formatDescriptionEscapes(formatDescriptionWhitespace(description, options));
+}
+formatDescription.__type = [
+	"description",
+	() => __ΩFormatDescriptionOptions,
+	"options",
+	() => ({}),
+	"formatDescription",
+	"P&2!n\"2#>$&/%"
+];
+const __ΩFormatShortDescriptionOptions = [
+	() => __ΩFormatDescriptionOptions,
+	"length",
+	60,
+	"FormatShortDescriptionOptions",
+	"Pn!'4\"8>#Mw$y"
+];
+/**
+* Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.
+*
+* @param description - The full description string.
+* @param options - Options for formatting the short description, including the maximum length.
+* @returns The extracted short description.
+*/
+function formatShortDescription(description, options = {}) {
+	const length = options.length ?? 60;
+	const formattedDescription = formatDescriptionWhitespace(description, options);
+	let result = ((formattedDescription.indexOf("\n") < length + 1 || formattedDescription.search(/[.!?\n]\s*\S/) > length + 1 ? formattedDescription.trim().match(/^.*[.!?\n]\s?\S/)?.[0]?.trim()?.slice(0, -1)?.trim() : void 0) || formattedDescription).trim();
+	if (result.trim().length > length) result = `${result.substring(0, Math.max(0, length - 3)).trim()}...`;
+	return formatDescriptionEscapes(result);
+}
+formatShortDescription.__type = [
+	"description",
+	() => __ΩFormatShortDescriptionOptions,
+	"options",
+	() => ({}),
+	"formatShortDescription",
+	"P&2!n\"2#>$&/%"
+];
+
+//#endregion
+exports.__ΩFormatDescriptionOptions = __ΩFormatDescriptionOptions;
+exports.__ΩFormatShortDescriptionOptions = __ΩFormatShortDescriptionOptions;
+exports.formatDescription = formatDescription;
+exports.formatShortDescription = formatShortDescription;
+//# sourceMappingURL=description-helpers.cjs.map

package/dist/plugin-utils/description-helpers.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"description-helpers.cjs","names":[],"sources":["../../src/plugin-utils/description-helpers.ts"],"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\nexport interface FormatDescriptionOptions {\n  /**\n   * If true, replaces newlines in the description with spaces. This is useful for ensuring that descriptions are displayed as a single line in contexts where multiline descriptions may not be supported or may cause formatting issues.\n   *\n   * @defaultValue false\n   */\n  replaceNewlines?: boolean;\n\n  /**\n   * If true, collapses multiple consecutive spaces in the description into a single space. This helps to ensure that descriptions are concise and do not contain unnecessary whitespace.\n   *\n   * @defaultValue false\n   */\n  collapseWhitespace?: boolean;\n}\n\n/**\n * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.\n *\n * @remarks\n * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.\n *\n * @param description - The full description string.\n * @returns The formatted description string.\n */\nfunction formatDescriptionWhitespace(\n  description: string,\n  options: FormatDescriptionOptions = {}\n): string {\n  let formattedDescription = description.trim();\n  if (options.replaceNewlines) {\n    formattedDescription = formattedDescription.replace(/\\s*\\n\\s*/g, \" \");\n  }\n  if (options.collapseWhitespace) {\n    formattedDescription = formattedDescription.replace(/\\s{2,}/g, \" \");\n  }\n\n  return formattedDescription.trim();\n}\n\n/**\n * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.\n *\n * @remarks\n * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.\n *\n * @param description - The full description string.\n * @returns The formatted description string.\n */\nfunction formatDescriptionEscapes(description: string): string {\n  return description\n    .replaceAll(\"'\", \"\\\\'\")\n    .replaceAll('\"', '\\\\\"')\n    .replaceAll(\"`\", \"\\\\`\")\n    .replace(/\\$\\{/g, \"\\\\${\");\n}\n\n/**\n * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.\n *\n * @remarks\n * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.\n *\n * @param description - The full description string.\n * @returns The formatted description string.\n */\nexport function formatDescription(\n  description: string,\n  options: FormatDescriptionOptions = {}\n): string {\n  return formatDescriptionEscapes(\n    formatDescriptionWhitespace(description, options)\n  );\n}\n\nexport interface FormatShortDescriptionOptions extends FormatDescriptionOptions {\n  /**\n   * The maximum length of the short description. If the first sentence exceeds this length, it will be truncated.\n   *\n   * @defaultValue 60\n   */\n  length?: number;\n}\n\n/**\n * Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.\n *\n * @param description - The full description string.\n * @param options - Options for formatting the short description, including the maximum length.\n * @returns The extracted short description.\n */\nexport function formatShortDescription(\n  description: string,\n  options: FormatShortDescriptionOptions = {}\n): string {\n  const length = options.length ?? 60;\n  const formattedDescription = formatDescriptionWhitespace(\n    description,\n    options\n  );\n\n  const firstSentenceMatch =\n    formattedDescription.indexOf(\"\\n\") < length + 1 ||\n    formattedDescription.search(/[.!?\\n]\\s*\\S/) > length + 1\n      ? formattedDescription\n          .trim()\n          .match(/^.*[.!?\\n]\\s?\\S/)?.[0]\n          ?.trim()\n          ?.slice(0, -1)\n          ?.trim()\n      : undefined;\n\n  let result = (firstSentenceMatch || formattedDescription).trim();\n  if (result.trim().length > length) {\n    result = `${result.substring(0, Math.max(0, length - 3)).trim()}...`;\n  }\n\n  return formatDescriptionEscapes(result);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA4BA,SAAG,4BAAA,aAAA,UAAA,EAAA,EAAA;CACC,IAAI,uBAAe,YAAA,MAAA;AACnB,KAAA,QAAA,gBACI,wBAAsB,qBAAA,QAAA,aAAA,IAAA;gCAG5B,wBAAA,qBAAA,QAAA,WAAA,IAAA;AAED,QAAA,qBAAA,MAAA;;AAED,4BAA4B,SAAS;CAAC;OAAqB;CAA6B;QAAkB,EAAE;CAAG;CAAW;CAAA;;;;;;;;;;AAU1H,SAAS,yBAAsB,aAAA;AAC3B,QAAO,YACT,WAAA,KAAA,MAAA,CACO,WAAW,MAAK,OAAM,CACtB,WAAW,KAAK,MAAM,CAC7B,QAAA,SAAA,OAAA;;AAEF,yBAAyB,SAAS;CAAC;CAAC;CAAA;CAAA;;;;;;;;;;AAUpC,SAAgB,kBAAkB,aAAU,UAAA,EAAA,EAAA;AAC1C,QAAA,yBAAA,4BAAA,aAAA,QAAA,CAAA;;AAEF,kBAAkB,SAAC;CAAA;OAAA;CAAA;QAAA,EAAA;CAAA;CAAA;CAAA;AACnB,MAAM,mCAAoB;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;;AAS1B,SAAU,uBAAA,aAAA,UAAA,EAAA,EAAA;CACN,MAAM,SAAS,QAAQ,UAAU;CACpC,MAAA,uBAAA,4BAAA,aAAA,QAAA;CAUE,IAAA,WAT4B,qBAAoB,QAAA,KAAA,GAAA,SAAA,KAC3C,qBAAqB,OAAO,eAAQ,GAAA,SAAA,IAC1C,qBACW,MAAM,CACN,MAAM,kBAAE,GAAA,IACP,MAAM,EACV,MAAA,GAAA,GAAA,EACI,MAAM,GACV,WACP,sBAAA,MAAA;AACH,KAAA,OAAA,MAAA,CAAA,SAAA;AAGI,QAAA,yBAAA,OAAA;;AAEJ,uBAAG,SAAA;CAAA;OAAA;CAAA;QAAA,EAAA;CAAA;CAAA;CAAA"}

package/dist/plugin-utils/description-helpers.d.cts

@@ -0,0 +1,44 @@
+//#region src/plugin-utils/description-helpers.d.ts
+interface FormatDescriptionOptions {
+  /**
+   * If true, replaces newlines in the description with spaces. This is useful for ensuring that descriptions are displayed as a single line in contexts where multiline descriptions may not be supported or may cause formatting issues.
+   *
+   * @defaultValue false
+   */
+  replaceNewlines?: boolean;
+  /**
+   * If true, collapses multiple consecutive spaces in the description into a single space. This helps to ensure that descriptions are concise and do not contain unnecessary whitespace.
+   *
+   * @defaultValue false
+   */
+  collapseWhitespace?: boolean;
+}
+/**
+ * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+ *
+ * @remarks
+ * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+ *
+ * @param description - The full description string.
+ * @returns The formatted description string.
+ */
+declare function formatDescription(description: string, options?: FormatDescriptionOptions): string;
+interface FormatShortDescriptionOptions extends FormatDescriptionOptions {
+  /**
+   * The maximum length of the short description. If the first sentence exceeds this length, it will be truncated.
+   *
+   * @defaultValue 60
+   */
+  length?: number;
+}
+/**
+ * Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.
+ *
+ * @param description - The full description string.
+ * @param options - Options for formatting the short description, including the maximum length.
+ * @returns The extracted short description.
+ */
+declare function formatShortDescription(description: string, options?: FormatShortDescriptionOptions): string;
+//#endregion
+export { FormatDescriptionOptions, FormatShortDescriptionOptions, formatDescription, formatShortDescription };
+//# sourceMappingURL=description-helpers.d.cts.map

package/dist/plugin-utils/description-helpers.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"description-helpers.d.cts","names":[],"sources":["../../src/plugin-utils/description-helpers.ts"],"sourcesContent":[],"mappings":";UAkBiB,wBAAA;EAAA;AAkEjB;AASA;AAgBA;;;;;;;;;;;;;;;;;;;iBAzBgB,iBAAA,gCAEL;UAOM,6BAAA,SAAsC;;;;;;;;;;;;;;;iBAgBvC,sBAAA,gCAEL"}

package/dist/plugin-utils/description-helpers.d.mts

@@ -0,0 +1,44 @@
+//#region src/plugin-utils/description-helpers.d.ts
+interface FormatDescriptionOptions {
+  /**
+   * If true, replaces newlines in the description with spaces. This is useful for ensuring that descriptions are displayed as a single line in contexts where multiline descriptions may not be supported or may cause formatting issues.
+   *
+   * @defaultValue false
+   */
+  replaceNewlines?: boolean;
+  /**
+   * If true, collapses multiple consecutive spaces in the description into a single space. This helps to ensure that descriptions are concise and do not contain unnecessary whitespace.
+   *
+   * @defaultValue false
+   */
+  collapseWhitespace?: boolean;
+}
+/**
+ * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+ *
+ * @remarks
+ * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+ *
+ * @param description - The full description string.
+ * @returns The formatted description string.
+ */
+declare function formatDescription(description: string, options?: FormatDescriptionOptions): string;
+interface FormatShortDescriptionOptions extends FormatDescriptionOptions {
+  /**
+   * The maximum length of the short description. If the first sentence exceeds this length, it will be truncated.
+   *
+   * @defaultValue 60
+   */
+  length?: number;
+}
+/**
+ * Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.
+ *
+ * @param description - The full description string.
+ * @param options - Options for formatting the short description, including the maximum length.
+ * @returns The extracted short description.
+ */
+declare function formatShortDescription(description: string, options?: FormatShortDescriptionOptions): string;
+//#endregion
+export { FormatDescriptionOptions, FormatShortDescriptionOptions, formatDescription, formatShortDescription };
+//# sourceMappingURL=description-helpers.d.mts.map

package/dist/plugin-utils/description-helpers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"description-helpers.d.mts","names":[],"sources":["../../src/plugin-utils/description-helpers.ts"],"sourcesContent":[],"mappings":";UAkBiB,wBAAA;EAAA;AAkEjB;AASA;AAgBA;;;;;;;;;;;;;;;;;;;iBAzBgB,iBAAA,gCAEL;UAOM,6BAAA,SAAsC;;;;;;;;;;;;;;;iBAgBvC,sBAAA,gCAEL"}

package/dist/plugin-utils/description-helpers.mjs

@@ -0,0 +1,101 @@
+//#region src/plugin-utils/description-helpers.ts
+const __ΩFormatDescriptionOptions = [
+	"replaceNewlines",
+	true,
+	"collapseWhitespace",
+	"FormatDescriptionOptions",
+	"P)4!8>\")4#8>\"Mw$y"
+];
+/**
+* Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+*
+* @remarks
+* This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+*
+* @param description - The full description string.
+* @returns The formatted description string.
+*/
+function formatDescriptionWhitespace(description, options = {}) {
+	let formattedDescription = description.trim();
+	if (options.replaceNewlines) formattedDescription = formattedDescription.replace(/\s*\n\s*/g, " ");
+	if (options.collapseWhitespace) formattedDescription = formattedDescription.replace(/\s{2,}/g, " ");
+	return formattedDescription.trim();
+}
+formatDescriptionWhitespace.__type = [
+	"description",
+	() => __ΩFormatDescriptionOptions,
+	"options",
+	() => ({}),
+	"formatDescriptionWhitespace",
+	"P&2!n\"2#>$&/%"
+];
+/**
+* Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+*
+* @remarks
+* This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+*
+* @param description - The full description string.
+* @returns The formatted description string.
+*/
+function formatDescriptionEscapes(description) {
+	return description.replaceAll("'", "\\'").replaceAll("\"", "\\\"").replaceAll("`", "\\`").replace(/\$\{/g, "\\${");
+}
+formatDescriptionEscapes.__type = [
+	"description",
+	"formatDescriptionEscapes",
+	"P&2!&/\""
+];
+/**
+* Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.
+*
+* @remarks
+* This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.
+*
+* @param description - The full description string.
+* @returns The formatted description string.
+*/
+function formatDescription(description, options = {}) {
+	return formatDescriptionEscapes(formatDescriptionWhitespace(description, options));
+}
+formatDescription.__type = [
+	"description",
+	() => __ΩFormatDescriptionOptions,
+	"options",
+	() => ({}),
+	"formatDescription",
+	"P&2!n\"2#>$&/%"
+];
+const __ΩFormatShortDescriptionOptions = [
+	() => __ΩFormatDescriptionOptions,
+	"length",
+	60,
+	"FormatShortDescriptionOptions",
+	"Pn!'4\"8>#Mw$y"
+];
+/**
+* Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.
+*
+* @param description - The full description string.
+* @param options - Options for formatting the short description, including the maximum length.
+* @returns The extracted short description.
+*/
+function formatShortDescription(description, options = {}) {
+	const length = options.length ?? 60;
+	const formattedDescription = formatDescriptionWhitespace(description, options);
+	let result = ((formattedDescription.indexOf("\n") < length + 1 || formattedDescription.search(/[.!?\n]\s*\S/) > length + 1 ? formattedDescription.trim().match(/^.*[.!?\n]\s?\S/)?.[0]?.trim()?.slice(0, -1)?.trim() : void 0) || formattedDescription).trim();
+	if (result.trim().length > length) result = `${result.substring(0, Math.max(0, length - 3)).trim()}...`;
+	return formatDescriptionEscapes(result);
+}
+formatShortDescription.__type = [
+	"description",
+	() => __ΩFormatShortDescriptionOptions,
+	"options",
+	() => ({}),
+	"formatShortDescription",
+	"P&2!n\"2#>$&/%"
+];
+
+//#endregion
+export { __ΩFormatDescriptionOptions, __ΩFormatShortDescriptionOptions, formatDescription, formatShortDescription };
+//# sourceMappingURL=description-helpers.mjs.map

package/dist/plugin-utils/description-helpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"description-helpers.mjs","names":[],"sources":["../../src/plugin-utils/description-helpers.ts"],"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\nexport interface FormatDescriptionOptions {\n  /**\n   * If true, replaces newlines in the description with spaces. This is useful for ensuring that descriptions are displayed as a single line in contexts where multiline descriptions may not be supported or may cause formatting issues.\n   *\n   * @defaultValue false\n   */\n  replaceNewlines?: boolean;\n\n  /**\n   * If true, collapses multiple consecutive spaces in the description into a single space. This helps to ensure that descriptions are concise and do not contain unnecessary whitespace.\n   *\n   * @defaultValue false\n   */\n  collapseWhitespace?: boolean;\n}\n\n/**\n * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.\n *\n * @remarks\n * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.\n *\n * @param description - The full description string.\n * @returns The formatted description string.\n */\nfunction formatDescriptionWhitespace(\n  description: string,\n  options: FormatDescriptionOptions = {}\n): string {\n  let formattedDescription = description.trim();\n  if (options.replaceNewlines) {\n    formattedDescription = formattedDescription.replace(/\\s*\\n\\s*/g, \" \");\n  }\n  if (options.collapseWhitespace) {\n    formattedDescription = formattedDescription.replace(/\\s{2,}/g, \" \");\n  }\n\n  return formattedDescription.trim();\n}\n\n/**\n * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.\n *\n * @remarks\n * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.\n *\n * @param description - The full description string.\n * @returns The formatted description string.\n */\nfunction formatDescriptionEscapes(description: string): string {\n  return description\n    .replaceAll(\"'\", \"\\\\'\")\n    .replaceAll('\"', '\\\\\"')\n    .replaceAll(\"`\", \"\\\\`\")\n    .replace(/\\$\\{/g, \"\\\\${\");\n}\n\n/**\n * Formats a description string by trimming whitespace, replacing newlines with spaces (optionally), collapsing multiple spaces into a single space (optionally), and escaping special characters.\n *\n * @remarks\n * This is useful for ensuring that descriptions are concise and well-formatted when displayed in the CLI or documentation.\n *\n * @param description - The full description string.\n * @returns The formatted description string.\n */\nexport function formatDescription(\n  description: string,\n  options: FormatDescriptionOptions = {}\n): string {\n  return formatDescriptionEscapes(\n    formatDescriptionWhitespace(description, options)\n  );\n}\n\nexport interface FormatShortDescriptionOptions extends FormatDescriptionOptions {\n  /**\n   * The maximum length of the short description. If the first sentence exceeds this length, it will be truncated.\n   *\n   * @defaultValue 60\n   */\n  length?: number;\n}\n\n/**\n * Extracts the short description from a longer description string. The short description is typically the first sentence or the first line of the description.\n *\n * @param description - The full description string.\n * @param options - Options for formatting the short description, including the maximum length.\n * @returns The extracted short description.\n */\nexport function formatShortDescription(\n  description: string,\n  options: FormatShortDescriptionOptions = {}\n): string {\n  const length = options.length ?? 60;\n  const formattedDescription = formatDescriptionWhitespace(\n    description,\n    options\n  );\n\n  const firstSentenceMatch =\n    formattedDescription.indexOf(\"\\n\") < length + 1 ||\n    formattedDescription.search(/[.!?\\n]\\s*\\S/) > length + 1\n      ? formattedDescription\n          .trim()\n          .match(/^.*[.!?\\n]\\s?\\S/)?.[0]\n          ?.trim()\n          ?.slice(0, -1)\n          ?.trim()\n      : undefined;\n\n  let result = (firstSentenceMatch || formattedDescription).trim();\n  if (result.trim().length > length) {\n    result = `${result.substring(0, Math.max(0, length - 3)).trim()}...`;\n  }\n\n  return formatDescriptionEscapes(result);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA4BA,SAAG,4BAAA,aAAA,UAAA,EAAA,EAAA;CACC,IAAI,uBAAe,YAAA,MAAA;AACnB,KAAA,QAAA,gBACI,wBAAsB,qBAAA,QAAA,aAAA,IAAA;gCAG5B,wBAAA,qBAAA,QAAA,WAAA,IAAA;AAED,QAAA,qBAAA,MAAA;;AAED,4BAA4B,SAAS;CAAC;OAAqB;CAA6B;QAAkB,EAAE;CAAG;CAAW;CAAA;;;;;;;;;;AAU1H,SAAS,yBAAsB,aAAA;AAC3B,QAAO,YACT,WAAA,KAAA,MAAA,CACO,WAAW,MAAK,OAAM,CACtB,WAAW,KAAK,MAAM,CAC7B,QAAA,SAAA,OAAA;;AAEF,yBAAyB,SAAS;CAAC;CAAC;CAAA;CAAA;;;;;;;;;;AAUpC,SAAgB,kBAAkB,aAAU,UAAA,EAAA,EAAA;AAC1C,QAAA,yBAAA,4BAAA,aAAA,QAAA,CAAA;;AAEF,kBAAkB,SAAC;CAAA;OAAA;CAAA;QAAA,EAAA;CAAA;CAAA;CAAA;AACnB,MAAM,mCAAoB;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;;AAS1B,SAAU,uBAAA,aAAA,UAAA,EAAA,EAAA;CACN,MAAM,SAAS,QAAQ,UAAU;CACpC,MAAA,uBAAA,4BAAA,aAAA,QAAA;CAUE,IAAA,WAT4B,qBAAoB,QAAA,KAAA,GAAA,SAAA,KAC3C,qBAAqB,OAAO,eAAQ,GAAA,SAAA,IAC1C,qBACW,MAAM,CACN,MAAM,kBAAE,GAAA,IACP,MAAM,EACV,MAAA,GAAA,GAAA,EACI,MAAM,GACV,WACP,sBAAA,MAAA;AACH,KAAA,OAAA,MAAA,CAAA,SAAA;AAGI,QAAA,yBAAA,OAAA;;AAEJ,uBAAG,SAAA;CAAA;OAAA;CAAA;QAAA,EAAA;CAAA;CAAA;CAAA"}

package/dist/plugin-utils/get-command-tree.cjs

@@ -1,4 +1,5 @@
 const require_context_helpers = require('./context-helpers.cjs');
+const require_traverse_command_tree = require('./traverse-command-tree.cjs');
 
 //#region src/plugin-utils/get-command-tree.ts
 function __assignType(fn, args) {
@@ -34,7 +35,32 @@ getCommandTree.__type = [
 	"getCommandTree",
 	"P\"w!2\"\"2#P\"w$,J/%"
 ];
+/**
+* Retrieves a list of all command trees defined in the context.
+*
+* @param context - The build context containing the command definitions.
+* @returns A promise that resolves to an array of all command trees in the context.
+*/
+async function getCommandList(context) {
+	const commandList = [];
+	await require_traverse_command_tree.traverseCommands(context, __assignType((commandTree) => {
+		commandList.push(commandTree);
+	}, [
+		"commandTree",
+		"",
+		"P\"2!\"/\""
+	]));
+	return commandList;
+}
+getCommandList.__type = [
+	"Context",
+	"context",
+	"CommandTree",
+	"getCommandList",
+	"P\"w!2\"\"w#F`/$"
+];
 
 //#endregion
+exports.getCommandList = getCommandList;
 exports.getCommandTree = getCommandTree;
 //# sourceMappingURL=get-command-tree.cjs.map

package/dist/plugin-utils/get-command-tree.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-command-tree.cjs","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"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 type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport { isDynamicPathSegment } from \"./context-helpers\";\n\n/**\n * Retrieves a specific command tree based on the provided path.\n *\n * @param context - The build context containing the command definitions.\n * @param path - An array of strings representing the command path.\n * @returns The command tree at the specified path, or null if not found.\n */\nexport function getCommandTree(\n  context: Context,\n  path = [] as string[]\n): CommandTree | null {\n  if (path.length === 0) {\n    return null;\n  }\n\n  let currentTree: CommandTree | null = context.commands[path[0]!] ?? null;\n  if (path.length > 1) {\n    const segments = path\n      .slice(1)\n      .filter(segment => !isDynamicPathSegment(segment));\n    for (const segment of segments) {\n      if (\n        currentTree?.children &&\n        Object.prototype.hasOwnProperty.call(currentTree.children, segment)\n      ) {\n        currentTree = currentTree.children[segment] ?? null;\n      } else {\n        return null;\n      }\n    }\n  }\n\n  return currentTree;\n}\n"],"mappings":";;;AAAA,SAAS,aAAa,IAAI,MAAM;;AAE5B,QAAO;;;;;;;;;AAUX,SAAgB,eAAe,SAAS,OAAO,EAAE,EAAE;uBAE3C,QAAO;CAEX,IAAI,cAAc,QAAQ,SAAS,KAAK,OAAO;;EAE3C,MAAM,WAAW,KACZ,MAAM,EAAE,CACR,OAAO,cAAa,YAAW,CAAC,6CAAW,QAAA,EAAA;GAAA;GAAA;GAAA;GAAA,CAAA,CAAA;iCAEtD,KAAA,aAAA,YACc,OAAO,UAAU,eAAe,KAAK,YAAU,UAAA,QAAA,CAC9D,eAAA,YAAA,SAAA,YAAA;MAGe,QAAO;;AAInB,QAAO;;AAEX,eAAe,SAAS;CAAC;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}
+{"version":3,"file":"get-command-tree.cjs","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"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 type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport { isDynamicPathSegment } from \"./context-helpers\";\nimport { traverseCommands } from \"./traverse-command-tree\";\n\n/**\n * Retrieves a specific command tree based on the provided path.\n *\n * @param context - The build context containing the command definitions.\n * @param path - An array of strings representing the command path.\n * @returns The command tree at the specified path, or null if not found.\n */\nexport function getCommandTree(\n  context: Context,\n  path = [] as string[]\n): CommandTree | null {\n  if (path.length === 0) {\n    return null;\n  }\n\n  let currentTree: CommandTree | null = context.commands[path[0]!] ?? null;\n  if (path.length > 1) {\n    const segments = path\n      .slice(1)\n      .filter(segment => !isDynamicPathSegment(segment));\n    for (const segment of segments) {\n      if (\n        currentTree?.children &&\n        Object.prototype.hasOwnProperty.call(currentTree.children, segment)\n      ) {\n        currentTree = currentTree.children[segment] ?? null;\n      } else {\n        return null;\n      }\n    }\n  }\n\n  return currentTree;\n}\n\n/**\n * Retrieves a list of all command trees defined in the context.\n *\n * @param context - The build context containing the command definitions.\n * @returns A promise that resolves to an array of all command trees in the context.\n */\nexport async function getCommandList(context: Context): Promise<CommandTree[]> {\n  const commandList: CommandTree[] = [];\n  await traverseCommands(context, commandTree => {\n    commandList.push(commandTree);\n  });\n\n  return commandList;\n}\n"],"mappings":";;;;AAAA,SAAS,aAAa,IAAI,MAAM;;AAE5B,QAAO;;;;;;;;;;AAYP,KAAI,KAAK,WAAW;;AAIpB,KAAI,KAAK,SAAS,GAAG;EACjB,MAAM,WAAW,KACZ,MAAM,EAAE,CACR,OAAO,cAAa,YAAW,CAAC,6CAAa,QAAA,EAAA;GAAA;GAAA;GAAA;GAAA,CAAA,CAAA;iCAExD,KAAA,aAAA,YACc,OAAO,UAAU,eAAe,KAAK,YAAU,UAAA,QAAA,CAC9D,eAAA,YAAA,SAAA,YAAA;MAGe,QAAO;;AAInB,QAAO;;AAEX,eAAe,SAAS;CAAC;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;AAOzB,eAAc,eAAA,SAAA;CACV,MAAM,cAAc,EAAE;AACtB,OAAM,+CAAiB,SAAS,cAAA,gBAAA;AAC5B,cAAC,KAAA,YAAA;IACF;EAAC;EAAe;EAAI;EAAI,CAAA,CAAA;AAC3B,QAAO;;AAEX,eAAe,SAAS;CAAC;CAAW;CAAW;CAAY;CAAA;CAAA"}

package/dist/plugin-utils/get-command-tree.d.cts

@@ -11,6 +11,13 @@ import { Context } from "../types/context.cjs";
  * @returns The command tree at the specified path, or null if not found.
  */
 declare function getCommandTree(context: Context, path?: string[]): CommandTree | null;
+/**
+ * Retrieves a list of all command trees defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command trees in the context.
+ */
+declare function getCommandList(context: Context): Promise<CommandTree[]>;
 //#endregion
-export { getCommandTree };
+export { getCommandList, getCommandTree };
 //# sourceMappingURL=get-command-tree.d.cts.map

package/dist/plugin-utils/get-command-tree.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"get-command-tree.d.cts","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"sourcesContent":[],"mappings":";;;;;;;AA6BA;;;;;iBAAgB,cAAA,UACL,2BAER"}
+{"version":3,"file":"get-command-tree.d.cts","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"sourcesContent":[],"mappings":";;;;;;;AA8BA;AAkCA;;;;AAA+D,iBAlC/C,cAAA,CAkC+C,OAAA,EAjCpD,OAiCoD,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EA/B5D,WA+B4D,GAAA,IAAA;;;;;;;iBAAzC,cAAA,UAAwB,UAAU,QAAQ"}

package/dist/plugin-utils/get-command-tree.d.mts

@@ -11,6 +11,13 @@ import { Context } from "../types/context.mjs";
  * @returns The command tree at the specified path, or null if not found.
  */
 declare function getCommandTree(context: Context, path?: string[]): CommandTree | null;
+/**
+ * Retrieves a list of all command trees defined in the context.
+ *
+ * @param context - The build context containing the command definitions.
+ * @returns A promise that resolves to an array of all command trees in the context.
+ */
+declare function getCommandList(context: Context): Promise<CommandTree[]>;
 //#endregion
-export { getCommandTree };
+export { getCommandList, getCommandTree };
 //# sourceMappingURL=get-command-tree.d.mts.map

package/dist/plugin-utils/get-command-tree.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"get-command-tree.d.mts","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"sourcesContent":[],"mappings":";;;;;;;AA6BA;;;;;iBAAgB,cAAA,UACL,2BAER"}
+{"version":3,"file":"get-command-tree.d.mts","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"sourcesContent":[],"mappings":";;;;;;;AA8BA;AAkCA;;;;AAA+D,iBAlC/C,cAAA,CAkC+C,OAAA,EAjCpD,OAiCoD,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EA/B5D,WA+B4D,GAAA,IAAA;;;;;;;iBAAzC,cAAA,UAAwB,UAAU,QAAQ"}

package/dist/plugin-utils/get-command-tree.mjs

@@ -1,4 +1,5 @@
 import { isDynamicPathSegment } from "./context-helpers.mjs";
+import { traverseCommands } from "./traverse-command-tree.mjs";
 
 //#region src/plugin-utils/get-command-tree.ts
 function __assignType(fn, args) {
@@ -34,7 +35,31 @@ getCommandTree.__type = [
 	"getCommandTree",
 	"P\"w!2\"\"2#P\"w$,J/%"
 ];
+/**
+* Retrieves a list of all command trees defined in the context.
+*
+* @param context - The build context containing the command definitions.
+* @returns A promise that resolves to an array of all command trees in the context.
+*/
+async function getCommandList(context) {
+	const commandList = [];
+	await traverseCommands(context, __assignType((commandTree) => {
+		commandList.push(commandTree);
+	}, [
+		"commandTree",
+		"",
+		"P\"2!\"/\""
+	]));
+	return commandList;
+}
+getCommandList.__type = [
+	"Context",
+	"context",
+	"CommandTree",
+	"getCommandList",
+	"P\"w!2\"\"w#F`/$"
+];
 
 //#endregion
-export { getCommandTree };
+export { getCommandList, getCommandTree };
 //# sourceMappingURL=get-command-tree.mjs.map

package/dist/plugin-utils/get-command-tree.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get-command-tree.mjs","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"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 type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport { isDynamicPathSegment } from \"./context-helpers\";\n\n/**\n * Retrieves a specific command tree based on the provided path.\n *\n * @param context - The build context containing the command definitions.\n * @param path - An array of strings representing the command path.\n * @returns The command tree at the specified path, or null if not found.\n */\nexport function getCommandTree(\n  context: Context,\n  path = [] as string[]\n): CommandTree | null {\n  if (path.length === 0) {\n    return null;\n  }\n\n  let currentTree: CommandTree | null = context.commands[path[0]!] ?? null;\n  if (path.length > 1) {\n    const segments = path\n      .slice(1)\n      .filter(segment => !isDynamicPathSegment(segment));\n    for (const segment of segments) {\n      if (\n        currentTree?.children &&\n        Object.prototype.hasOwnProperty.call(currentTree.children, segment)\n      ) {\n        currentTree = currentTree.children[segment] ?? null;\n      } else {\n        return null;\n      }\n    }\n  }\n\n  return currentTree;\n}\n"],"mappings":";;;AAAA,SAAS,aAAa,IAAI,MAAM;;AAE5B,QAAO;;;;;;;;;AAUX,SAAgB,eAAe,SAAS,OAAO,EAAE,EAAE;uBAE3C,QAAO;CAEX,IAAI,cAAc,QAAQ,SAAS,KAAK,OAAO;;EAE3C,MAAM,WAAW,KACZ,MAAM,EAAE,CACR,OAAO,cAAa,YAAW,CAAC,qBAAW,QAAA,EAAA;GAAA;GAAA;GAAA;GAAA,CAAA,CAAA;iCAEtD,KAAA,aAAA,YACc,OAAO,UAAU,eAAe,KAAK,YAAU,UAAA,QAAA,CAC9D,eAAA,YAAA,SAAA,YAAA;MAGe,QAAO;;AAInB,QAAO;;AAEX,eAAe,SAAS;CAAC;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}
+{"version":3,"file":"get-command-tree.mjs","names":[],"sources":["../../src/plugin-utils/get-command-tree.ts"],"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 type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\nimport { isDynamicPathSegment } from \"./context-helpers\";\nimport { traverseCommands } from \"./traverse-command-tree\";\n\n/**\n * Retrieves a specific command tree based on the provided path.\n *\n * @param context - The build context containing the command definitions.\n * @param path - An array of strings representing the command path.\n * @returns The command tree at the specified path, or null if not found.\n */\nexport function getCommandTree(\n  context: Context,\n  path = [] as string[]\n): CommandTree | null {\n  if (path.length === 0) {\n    return null;\n  }\n\n  let currentTree: CommandTree | null = context.commands[path[0]!] ?? null;\n  if (path.length > 1) {\n    const segments = path\n      .slice(1)\n      .filter(segment => !isDynamicPathSegment(segment));\n    for (const segment of segments) {\n      if (\n        currentTree?.children &&\n        Object.prototype.hasOwnProperty.call(currentTree.children, segment)\n      ) {\n        currentTree = currentTree.children[segment] ?? null;\n      } else {\n        return null;\n      }\n    }\n  }\n\n  return currentTree;\n}\n\n/**\n * Retrieves a list of all command trees defined in the context.\n *\n * @param context - The build context containing the command definitions.\n * @returns A promise that resolves to an array of all command trees in the context.\n */\nexport async function getCommandList(context: Context): Promise<CommandTree[]> {\n  const commandList: CommandTree[] = [];\n  await traverseCommands(context, commandTree => {\n    commandList.push(commandTree);\n  });\n\n  return commandList;\n}\n"],"mappings":";;;;AAAA,SAAS,aAAa,IAAI,MAAM;;AAE5B,QAAO;;;;;;;;;;AAYP,KAAI,KAAK,WAAW;;AAIpB,KAAI,KAAK,SAAS,GAAG;EACjB,MAAM,WAAW,KACZ,MAAM,EAAE,CACR,OAAO,cAAa,YAAW,CAAC,qBAAa,QAAA,EAAA;GAAA;GAAA;GAAA;GAAA,CAAA,CAAA;iCAExD,KAAA,aAAA,YACc,OAAO,UAAU,eAAe,KAAK,YAAU,UAAA,QAAA,CAC9D,eAAA,YAAA,SAAA,YAAA;MAGe,QAAO;;AAInB,QAAO;;AAEX,eAAe,SAAS;CAAC;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;;;;;;;AAOzB,eAAc,eAAA,SAAA;CACV,MAAM,cAAc,EAAE;AACtB,OAAM,iBAAiB,SAAS,cAAA,gBAAA;AAC5B,cAAC,KAAA,YAAA;IACF;EAAC;EAAe;EAAI;EAAI,CAAA,CAAA;AAC3B,QAAO;;AAEX,eAAe,SAAS;CAAC;CAAW;CAAW;CAAY;CAAA;CAAA"}

package/dist/plugin-utils/index.cjs

@@ -2,15 +2,21 @@ const require_context_helpers = require('./context-helpers.cjs');
 const require_reflect = require('./reflect.cjs');
 const require_type_checks = require('./type-checks.cjs');
 const require_deepkit = require('./deepkit.cjs');
-const require_get_command_tree = require('./get-command-tree.cjs');
+const require_description_helpers = require('./description-helpers.cjs');
 const require_traverse_command_tree = require('./traverse-command-tree.cjs');
+const require_get_command_tree = require('./get-command-tree.cjs');
 
+exports.__ΩFormatDescriptionOptions = require_description_helpers.__ΩFormatDescriptionOptions;
+exports.__ΩFormatShortDescriptionOptions = require_description_helpers.__ΩFormatShortDescriptionOptions;
 exports.extractReflectionKind = require_deepkit.extractReflectionKind;
 exports.extractType = require_deepkit.extractType;
+exports.formatDescription = require_description_helpers.formatDescription;
+exports.formatShortDescription = require_description_helpers.formatShortDescription;
 exports.getAppBin = require_context_helpers.getAppBin;
 exports.getAppDescription = require_context_helpers.getAppDescription;
 exports.getAppName = require_context_helpers.getAppName;
 exports.getAppTitle = require_context_helpers.getAppTitle;
+exports.getCommandList = require_get_command_tree.getCommandList;
 exports.getCommandTree = require_get_command_tree.getCommandTree;
 exports.getDynamicPathSegmentName = require_context_helpers.getDynamicPathSegmentName;
 exports.getPathSegmentGroupName = require_context_helpers.getPathSegmentGroupName;

package/dist/plugin-utils/index.d.cts

@@ -1,7 +1,8 @@
 import { getAppBin, getAppDescription, getAppName, getAppTitle, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases } from "./context-helpers.cjs";
 import { extractReflectionKind, extractType } from "./deepkit.cjs";
-import { getCommandTree } from "./get-command-tree.cjs";
+import { FormatDescriptionOptions, FormatShortDescriptionOptions, formatDescription, formatShortDescription } from "./description-helpers.cjs";
+import { getCommandList, getCommandTree } from "./get-command-tree.cjs";
 import { sortOptions } from "./reflect.cjs";
 import { traverseCommandTree, traverseCommands } from "./traverse-command-tree.cjs";
 import { isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind } from "./type-checks.cjs";
-export { extractReflectionKind, extractType, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+export { FormatDescriptionOptions, FormatShortDescriptionOptions, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };

package/dist/plugin-utils/index.d.mts

@@ -1,7 +1,8 @@
 import { getAppBin, getAppDescription, getAppName, getAppTitle, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases } from "./context-helpers.mjs";
 import { extractReflectionKind, extractType } from "./deepkit.mjs";
-import { getCommandTree } from "./get-command-tree.mjs";
+import { FormatDescriptionOptions, FormatShortDescriptionOptions, formatDescription, formatShortDescription } from "./description-helpers.mjs";
+import { getCommandList, getCommandTree } from "./get-command-tree.mjs";
 import { sortOptions } from "./reflect.mjs";
 import { traverseCommandTree, traverseCommands } from "./traverse-command-tree.mjs";
 import { isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind } from "./type-checks.mjs";
-export { extractReflectionKind, extractType, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+export { FormatDescriptionOptions, FormatShortDescriptionOptions, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };

package/dist/plugin-utils/index.mjs

@@ -2,7 +2,8 @@ import { getAppBin, getAppDescription, getAppName, getAppTitle, getDynamicPathSe
 import { sortOptions } from "./reflect.mjs";
 import { isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind } from "./type-checks.mjs";
 import { extractReflectionKind, extractType } from "./deepkit.mjs";
-import { getCommandTree } from "./get-command-tree.mjs";
+import { __ΩFormatDescriptionOptions, __ΩFormatShortDescriptionOptions, formatDescription, formatShortDescription } from "./description-helpers.mjs";
 import { traverseCommandTree, traverseCommands } from "./traverse-command-tree.mjs";
+import { getCommandList, getCommandTree } from "./get-command-tree.mjs";
 
-export { extractReflectionKind, extractType, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };
+export { __ΩFormatDescriptionOptions, __ΩFormatShortDescriptionOptions, extractReflectionKind, extractType, formatDescription, formatShortDescription, getAppBin, getAppDescription, getAppName, getAppTitle, getCommandList, getCommandTree, getDynamicPathSegmentName, getPathSegmentGroupName, getPathSegmentName, isCommandArgument, isCommandOption, isCommandParameter, isCommandParameterConfig, isCommandParameterKind, isDynamicPathSegment, isPathSegmentGroup, sortArgAliases, sortOptions, traverseCommandTree, traverseCommands };

package/dist/plugin-utils/type-checks.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"type-checks.d.cts","names":[],"sources":["../../src/plugin-utils/type-checks.ts"],"sourcesContent":[],"mappings":";;;;;;AAoCA;AAiBA;AAYA;AA0BA;AAYgB,iBAnEA,sBAAA,CAmEoC,GAAA,EAAe,GAAA,CAAA,EAAA,GAAA,IAnEV,oBAmEU;;;;;;;iBAlDnD,wBAAA,mBAEN;;;;;;;iBAUM,kBAAA,mBAAqC;;;;;;;iBA0BrC,eAAA,mBAAkC;;;;;;;iBAYlC,iBAAA,mBAAoC"}
+{"version":3,"file":"type-checks.d.cts","names":[],"sources":["../../src/plugin-utils/type-checks.ts"],"sourcesContent":[],"mappings":";;;;;;AAoCA;AAiBA;AAYA;AA0BA;AAYgB,iBAnEA,sBAAA,CAmEoC,GAAA,EAAA,GAAe,CAAA,EAAA,GAAA,IAnEV,oBAmEU;;;;;;;iBAlDnD,wBAAA,mBAEN;;;;;;;iBAUM,kBAAA,mBAAqC;;;;;;;iBA0BrC,eAAA,mBAAkC;;;;;;;iBAYlC,iBAAA,mBAAoC"}