@shell-shock/core 0.3.0 → 0.4.0

package/dist/api.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"api.cjs","names":["createPowerlines","plugin","ShellShockAPI","powerlines","from","config","framework","plugins","constructor","clean","inlineConfig","prepare","lint","build","docs","finalize","createShellShock","options","root","process","cwd"],"sources":["../src/api.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 { createPowerlines } from \"powerlines\";\nimport type { PowerlinesAPI } from \"powerlines/api\";\nimport type {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  LintInlineConfig,\n  PluginConfig,\n  PrepareInlineConfig\n} from \"powerlines/types/config\";\nimport { plugin } from \"./plugin\";\nimport type { UserConfig } from \"./types/config\";\nimport type { Context } from \"./types/context\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  public static async from(config: UserConfig = {}): Promise<ShellShockAPI> {\n    const powerlines = await createPowerlines({\n      framework: \"shell-shock\",\n      ...config,\n      plugins: [plugin(), ...(config.plugins ?? [])] as PluginConfig<Context>[]\n    });\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: Partial<UserConfig> = {}\n): Promise<ShellShockAPI> {\n  options.root ??= process.cwd();\n\n  return ShellShockAPI.from(options);\n}\n"],"mappings":";;;;;;;;;;;AAsCA,IAAaE,gBAAb,MAAaA,cAAc;CACzB;CAEA,aAAoBE,KAAKC,SAAqB,EAAE,EAA0B;AAOxE,SAAO,IAAIH,cANQ,uCAAuB;GACxCI,WAAW;GACX,GAAGD;GACHE,SAAS,CAACN,uBAAQ,EAAE,GAAII,OAAOE,WAAW,EAAE,CAAC;GAC9C,CAAC,CAEkC;;CAG9BC,YAAYL,cAA2B;AAC7C,QAAK,aAAcA;;CAGrB,MAAaM,MAAMC,cAAgD;AACjE,SAAO,MAAK,WAAYD,MAAMC,aAAa;;CAG7C,MAAaC,QAAQD,cAAkD;AACrE,SAAO,MAAK,WAAYC,QAAQD,aAAa;;CAG/C,MAAaE,KAAKF,cAA+C;AAC/D,SAAO,MAAK,WAAYE,KAAKF,aAAa;;CAG5C,MAAaG,MAAMH,cAAgD;AACjE,SAAO,MAAK,WAAYG,MAAMH,aAAa;;CAG7C,MAAaI,KAAKJ,cAA+C;AAC/D,SAAO,MAAK,WAAYI,KAAKJ,aAAa;;CAG5C,MAAaK,WAA0B;AACrC,SAAO,MAAK,WAAYA,UAAU;;;;;;;;;AAUtC,eAAsBC,iBACpBC,UAA+B,EAAE,EACT;AACxBA,SAAQC,SAASC,QAAQC,KAAK;AAE9B,QAAOlB,cAAcE,KAAKa,QAAQ"}
+{"version":3,"file":"api.cjs","names":["createPowerlines","plugin","ShellShockAPI","powerlines","from","config","framework","plugins","constructor","clean","inlineConfig","prepare","lint","build","docs","finalize","createShellShock","options","root","process","cwd"],"sources":["../src/api.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 { createPowerlines } from \"powerlines\";\nimport type { PowerlinesAPI } from \"powerlines/api\";\nimport type {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  LintInlineConfig,\n  PluginConfig,\n  PrepareInlineConfig\n} from \"powerlines/types/config\";\nimport { plugin } from \"./plugin\";\nimport type { UserConfig } from \"./types/config\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  public static async from(config: UserConfig = {}): Promise<ShellShockAPI> {\n    const powerlines = await createPowerlines({\n      framework: \"shell-shock\",\n      ...config,\n      plugins: [plugin(), ...(config.plugins ?? [])] as PluginConfig<any>[]\n    });\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: Partial<UserConfig> = {}\n): Promise<ShellShockAPI> {\n  options.root ??= process.cwd();\n\n  return ShellShockAPI.from(options);\n}\n"],"mappings":";;;;;;;;;;;AAqCA,IAAaE,gBAAb,MAAaA,cAAc;CACzB;CAEA,aAAoBE,KAAKC,SAAqB,EAAE,EAA0B;AAOxE,SAAO,IAAIH,cANQ,uCAAuB;GACxCI,WAAW;GACX,GAAGD;GACHE,SAAS,CAACN,uBAAQ,EAAE,GAAII,OAAOE,WAAW,EAAE,CAAC;GAC9C,CAAC,CAEkC;;CAG9BC,YAAYL,cAA2B;AAC7C,QAAK,aAAcA;;CAGrB,MAAaM,MAAMC,cAAgD;AACjE,SAAO,MAAK,WAAYD,MAAMC,aAAa;;CAG7C,MAAaC,QAAQD,cAAkD;AACrE,SAAO,MAAK,WAAYC,QAAQD,aAAa;;CAG/C,MAAaE,KAAKF,cAA+C;AAC/D,SAAO,MAAK,WAAYE,KAAKF,aAAa;;CAG5C,MAAaG,MAAMH,cAAgD;AACjE,SAAO,MAAK,WAAYG,MAAMH,aAAa;;CAG7C,MAAaI,KAAKJ,cAA+C;AAC/D,SAAO,MAAK,WAAYI,KAAKJ,aAAa;;CAG5C,MAAaK,WAA0B;AACrC,SAAO,MAAK,WAAYA,UAAU;;;;;;;;;AAUtC,eAAsBC,iBACpBC,UAA+B,EAAE,EACT;AACxBA,SAAQC,SAASC,QAAQC,KAAK;AAE9B,QAAOlB,cAAcE,KAAKa,QAAQ"}

package/dist/api.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"sourcesContent":[],"mappings":";;;;;;;AAsCA;;;;AAiBmC,cAjBtB,aAAA,CAiBsB;EAAoB,CAAA,OAAA;EAIlB,OAAA,IAAA,CAAA,MAAA,CAAA,EAlBF,UAkBE,CAAA,EAlBgB,OAkBhB,CAlBwB,aAkBxB,CAAA;EAAsB,QAAA,WAAA,CAAA;EAIzB,KAAA,CAAA,YAAA,EARC,iBAQD,CAAA,EARqB,OAQrB,CAAA,IAAA,CAAA;EAAmB,OAAA,CAAA,YAAA,EAJhB,mBAIgB,CAAA,EAJM,OAIN,CAAA,IAAA,CAAA;EAIlB,IAAA,CAAA,YAAA,EAJD,gBAIC,CAAA,EAJkB,OAIlB,CAAA,IAAA,CAAA;EAAoB,KAAA,CAAA,YAAA,EAApB,iBAAoB,CAAA,EAAA,OAAA,CAAA,IAAA,CAAA;EAIrB,IAAA,CAAA,YAAA,EAAA,gBAAA,CAAA,EAAmB,OAAnB,CAAA,IAAA,CAAA;EAAmB,QAAA,CAAA,CAAA,EAI1B,OAJ0B,CAAA,IAAA,CAAA;;;AAerD;;;;;AAEU,iBAFY,gBAAA,CAEZ,OAAA,CAAA,EADC,OACD,CADS,UACT,CAAA,CAAA,EAAP,OAAO,CAAC,aAAD,CAAA"}
+{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"sourcesContent":[],"mappings":";;;;;;;AAqCA;;;;AAiBmC,cAjBtB,aAAA,CAiBsB;EAAoB,CAAA,OAAA;EAIlB,OAAA,IAAA,CAAA,MAAA,CAAA,EAlBF,UAkBE,CAAA,EAlBgB,OAkBhB,CAlBwB,aAkBxB,CAAA;EAAsB,QAAA,WAAA,CAAA;EAIzB,KAAA,CAAA,YAAA,EARC,iBAQD,CAAA,EARqB,OAQrB,CAAA,IAAA,CAAA;EAAmB,OAAA,CAAA,YAAA,EAJhB,mBAIgB,CAAA,EAJM,OAIN,CAAA,IAAA,CAAA;EAIlB,IAAA,CAAA,YAAA,EAJD,gBAIC,CAAA,EAJkB,OAIlB,CAAA,IAAA,CAAA;EAAoB,KAAA,CAAA,YAAA,EAApB,iBAAoB,CAAA,EAAA,OAAA,CAAA,IAAA,CAAA;EAIrB,IAAA,CAAA,YAAA,EAAA,gBAAA,CAAA,EAAmB,OAAnB,CAAA,IAAA,CAAA;EAAmB,QAAA,CAAA,CAAA,EAI1B,OAJ0B,CAAA,IAAA,CAAA;;;AAerD;;;;;AAEU,iBAFY,gBAAA,CAEZ,OAAA,CAAA,EADC,OACD,CADS,UACT,CAAA,CAAA,EAAP,OAAO,CAAC,aAAD,CAAA"}

package/dist/api.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"sourcesContent":[],"mappings":";;;;;;;AAsCA;;;;AAiBmC,cAjBtB,aAAA,CAiBsB;EAAoB,CAAA,OAAA;EAIlB,OAAA,IAAA,CAAA,MAAA,CAAA,EAlBF,UAkBE,CAAA,EAlBgB,OAkBhB,CAlBwB,aAkBxB,CAAA;EAAsB,QAAA,WAAA,CAAA;EAIzB,KAAA,CAAA,YAAA,EARC,iBAQD,CAAA,EARqB,OAQrB,CAAA,IAAA,CAAA;EAAmB,OAAA,CAAA,YAAA,EAJhB,mBAIgB,CAAA,EAJM,OAIN,CAAA,IAAA,CAAA;EAIlB,IAAA,CAAA,YAAA,EAJD,gBAIC,CAAA,EAJkB,OAIlB,CAAA,IAAA,CAAA;EAAoB,KAAA,CAAA,YAAA,EAApB,iBAAoB,CAAA,EAAA,OAAA,CAAA,IAAA,CAAA;EAIrB,IAAA,CAAA,YAAA,EAAA,gBAAA,CAAA,EAAmB,OAAnB,CAAA,IAAA,CAAA;EAAmB,QAAA,CAAA,CAAA,EAI1B,OAJ0B,CAAA,IAAA,CAAA;;;AAerD;;;;;AAEU,iBAFY,gBAAA,CAEZ,OAAA,CAAA,EADC,OACD,CADS,UACT,CAAA,CAAA,EAAP,OAAO,CAAC,aAAD,CAAA"}
+{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"sourcesContent":[],"mappings":";;;;;;;AAqCA;;;;AAiBmC,cAjBtB,aAAA,CAiBsB;EAAoB,CAAA,OAAA;EAIlB,OAAA,IAAA,CAAA,MAAA,CAAA,EAlBF,UAkBE,CAAA,EAlBgB,OAkBhB,CAlBwB,aAkBxB,CAAA;EAAsB,QAAA,WAAA,CAAA;EAIzB,KAAA,CAAA,YAAA,EARC,iBAQD,CAAA,EARqB,OAQrB,CAAA,IAAA,CAAA;EAAmB,OAAA,CAAA,YAAA,EAJhB,mBAIgB,CAAA,EAJM,OAIN,CAAA,IAAA,CAAA;EAIlB,IAAA,CAAA,YAAA,EAJD,gBAIC,CAAA,EAJkB,OAIlB,CAAA,IAAA,CAAA;EAAoB,KAAA,CAAA,YAAA,EAApB,iBAAoB,CAAA,EAAA,OAAA,CAAA,IAAA,CAAA;EAIrB,IAAA,CAAA,YAAA,EAAA,gBAAA,CAAA,EAAmB,OAAnB,CAAA,IAAA,CAAA;EAAmB,QAAA,CAAA,CAAA,EAI1B,OAJ0B,CAAA,IAAA,CAAA;;;AAerD;;;;;AAEU,iBAFY,gBAAA,CAEZ,OAAA,CAAA,EADC,OACD,CADS,UACT,CAAA,CAAA,EAAP,OAAO,CAAC,aAAD,CAAA"}

package/dist/api.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api.mjs","names":["createPowerlines","plugin","ShellShockAPI","powerlines","from","config","framework","plugins","constructor","clean","inlineConfig","prepare","lint","build","docs","finalize","createShellShock","options","root","process","cwd"],"sources":["../src/api.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 { createPowerlines } from \"powerlines\";\nimport type { PowerlinesAPI } from \"powerlines/api\";\nimport type {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  LintInlineConfig,\n  PluginConfig,\n  PrepareInlineConfig\n} from \"powerlines/types/config\";\nimport { plugin } from \"./plugin\";\nimport type { UserConfig } from \"./types/config\";\nimport type { Context } from \"./types/context\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  public static async from(config: UserConfig = {}): Promise<ShellShockAPI> {\n    const powerlines = await createPowerlines({\n      framework: \"shell-shock\",\n      ...config,\n      plugins: [plugin(), ...(config.plugins ?? [])] as PluginConfig<Context>[]\n    });\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: Partial<UserConfig> = {}\n): Promise<ShellShockAPI> {\n  options.root ??= process.cwd();\n\n  return ShellShockAPI.from(options);\n}\n"],"mappings":";;;;;;;;;;AAsCA,IAAaE,gBAAb,MAAaA,cAAc;CACzB;CAEA,aAAoBE,KAAKC,SAAqB,EAAE,EAA0B;AAOxE,SAAO,IAAIH,cANQ,MAAMF,iBAAiB;GACxCM,WAAW;GACX,GAAGD;GACHE,SAAS,CAACN,QAAQ,EAAE,GAAII,OAAOE,WAAW,EAAE,CAAC;GAC9C,CAAC,CAEkC;;CAG9BC,YAAYL,YAA2B;AAC7C,QAAK,aAAcA;;CAGrB,MAAaM,MAAMC,cAAgD;AACjE,SAAO,MAAK,WAAYD,MAAMC,aAAa;;CAG7C,MAAaC,QAAQD,cAAkD;AACrE,SAAO,MAAK,WAAYC,QAAQD,aAAa;;CAG/C,MAAaE,KAAKF,cAA+C;AAC/D,SAAO,MAAK,WAAYE,KAAKF,aAAa;;CAG5C,MAAaG,MAAMH,cAAgD;AACjE,SAAO,MAAK,WAAYG,MAAMH,aAAa;;CAG7C,MAAaI,KAAKJ,cAA+C;AAC/D,SAAO,MAAK,WAAYI,KAAKJ,aAAa;;CAG5C,MAAaK,WAA0B;AACrC,SAAO,MAAK,WAAYA,UAAU;;;;;;;;;AAUtC,eAAsBC,iBACpBC,UAA+B,EAAE,EACT;AACxBA,SAAQC,SAASC,QAAQC,KAAK;AAE9B,QAAOlB,cAAcE,KAAKa,QAAQ"}
+{"version":3,"file":"api.mjs","names":["createPowerlines","plugin","ShellShockAPI","powerlines","from","config","framework","plugins","constructor","clean","inlineConfig","prepare","lint","build","docs","finalize","createShellShock","options","root","process","cwd"],"sources":["../src/api.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 { createPowerlines } from \"powerlines\";\nimport type { PowerlinesAPI } from \"powerlines/api\";\nimport type {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  LintInlineConfig,\n  PluginConfig,\n  PrepareInlineConfig\n} from \"powerlines/types/config\";\nimport { plugin } from \"./plugin\";\nimport type { UserConfig } from \"./types/config\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  public static async from(config: UserConfig = {}): Promise<ShellShockAPI> {\n    const powerlines = await createPowerlines({\n      framework: \"shell-shock\",\n      ...config,\n      plugins: [plugin(), ...(config.plugins ?? [])] as PluginConfig<any>[]\n    });\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: Partial<UserConfig> = {}\n): Promise<ShellShockAPI> {\n  options.root ??= process.cwd();\n\n  return ShellShockAPI.from(options);\n}\n"],"mappings":";;;;;;;;;;AAqCA,IAAaE,gBAAb,MAAaA,cAAc;CACzB;CAEA,aAAoBE,KAAKC,SAAqB,EAAE,EAA0B;AAOxE,SAAO,IAAIH,cANQ,MAAMF,iBAAiB;GACxCM,WAAW;GACX,GAAGD;GACHE,SAAS,CAACN,QAAQ,EAAE,GAAII,OAAOE,WAAW,EAAE,CAAC;GAC9C,CAAC,CAEkC;;CAG9BC,YAAYL,YAA2B;AAC7C,QAAK,aAAcA;;CAGrB,MAAaM,MAAMC,cAAgD;AACjE,SAAO,MAAK,WAAYD,MAAMC,aAAa;;CAG7C,MAAaC,QAAQD,cAAkD;AACrE,SAAO,MAAK,WAAYC,QAAQD,aAAa;;CAG/C,MAAaE,KAAKF,cAA+C;AAC/D,SAAO,MAAK,WAAYE,KAAKF,aAAa;;CAG5C,MAAaG,MAAMH,cAAgD;AACjE,SAAO,MAAK,WAAYG,MAAMH,aAAa;;CAG7C,MAAaI,KAAKJ,cAA+C;AAC/D,SAAO,MAAK,WAAYI,KAAKJ,aAAa;;CAG5C,MAAaK,WAA0B;AACrC,SAAO,MAAK,WAAYA,UAAU;;;;;;;;;AAUtC,eAAsBC,iBACpBC,UAA+B,EAAE,EACT;AACxBA,SAAQC,SAASC,QAAQC,KAAK;AAE9B,QAAOlB,cAAcE,KAAKa,QAAQ"}

package/dist/components/docs.cjs

@@ -18,7 +18,7 @@ let __stryke_path_join = require("@stryke/path/join");
 */
 function CommandOptionsDocs(props) {
 	const { command } = props;
-	if (Object.keys(command.options).length === 0) return ["This command does not have any options."];
+	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_plugin_utils_reflect.sortOptions(Object.values(command.options)).map((option) => {
 			return {
@@ -33,43 +33,103 @@ function CommandOptionsDocs(props) {
 /**
 * Generates the markdown documentation for a command.
 */
-function CommandDocs(props) {
-	const { levelOffset = 0, command } = props;
+function CommandDocsUsageExample(props) {
+	const { packageManager = "npm", command } = props;
 	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)(__alloy_js_core.Switch, { get children() {
+			return [
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Match, {
+					when: packageManager === "yarn",
+					children: `yarn exec `
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Match, {
+					when: packageManager === "pnpm",
+					children: `pnpm exec `
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Match, {
+					when: packageManager === "bun",
+					children: `bun x `
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Match, {
+					"else": true,
+					children: `npx `
+				})
+			];
+		} }),
+		(0, __alloy_js_core_jsx_runtime.memo)(() => `${require_plugin_utils_context_helpers.getAppBin(context)} `),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
+			get each() {
+				return command.path.segments;
+			},
+			joiner: " ",
+			children: (segment) => require_plugin_utils_context_helpers.isVariableCommandPath(segment) ? `<${command.path.variables[segment]?.variadic ? "..." : ""}${(0, __stryke_string_format_kebab_case.kebabCase)(require_plugin_utils_context_helpers.getVariableCommandPathName(segment))}>` : segment
+		}),
+		__alloy_js_core.code` [options] `,
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		__alloy_js_core.code`\`\`\``,
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+	];
+}
+/**
+* Generates the markdown documentation for a command.
+*/
+function CommandDocs(props) {
+	const { levelOffset = 0, command, usageExamples } = props;
 	return [
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
 			level: 1 + levelOffset,
 			get children() {
-				return command.name;
+				return command.title;
 			}
 		}),
-		(0, __alloy_js_core_jsx_runtime.memo)(() => command.description),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`${command.description}`),
 		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
 			level: 2 + levelOffset,
 			children: "Usage"
 		}),
-		__alloy_js_core.code`The command can be executed using the following syntax:
-      \`\`\`bash `,
 		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
-		(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`$ ${require_plugin_utils_context_helpers.getAppBin(context)} `),
-		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.For, {
-			get each() {
-				return command.path.segments;
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(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.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
+			get when() {
+				return usageExamples && usageExamples.length > 0;
 			},
-			children: (segment) => require_plugin_utils_context_helpers.isVariableCommandPath(segment) ? `<${command.path.variables[segment]?.variadic ? "..." : ""}${(0, __stryke_string_format_kebab_case.kebabCase)(require_plugin_utils_context_helpers.getVariableCommandPathName(segment))}>` : segment
+			get fallback() {
+				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, {
+					each: usageExamples,
+					hardline: true,
+					children: (packageManager) => (0, __alloy_js_core_jsx_runtime.createComponent)(CommandDocsUsageExample, {
+						packageManager,
+						command
+					})
+				});
+			}
 		}),
-		__alloy_js_core.code` [options] `,
-		(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", {}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
 			level: 2 + levelOffset,
 			children: "Options"
 		}),
-		(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`The following options are available for the ${command.title} command:`),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(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.createIntrinsic)("hbr", {}),
 		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(CommandOptionsDocs, { command }),
@@ -83,6 +143,12 @@ 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)(() => [
+		"npm",
+		"yarn",
+		"pnpm",
+		"bun"
+	]);
 	return (0, __alloy_js_core_jsx_runtime.createComponent)(require_contexts_command.CommandContext.Provider, {
 		value: command,
 		get children() {
@@ -91,7 +157,10 @@ function CommandDocsFile(props) {
 			} }, rest, { get children() {
 				return (0, __alloy_js_core_jsx_runtime.createComponent)(CommandDocs, {
 					levelOffset,
-					command
+					command,
+					get usageExamples() {
+						return usageExamples();
+					}
 				});
 			} }));
 		}
@@ -101,5 +170,6 @@ function CommandDocsFile(props) {
 //#endregion
 exports.CommandDocs = CommandDocs;
 exports.CommandDocsFile = CommandDocsFile;
+exports.CommandDocsUsageExample = CommandDocsUsageExample;
 exports.CommandOptionsDocs = CommandOptionsDocs;
 //# sourceMappingURL=docs.cjs.map

package/dist/components/docs.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"docs.cjs","names":["code","For","Heading","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","kebabCase","CommandContext","getDocsOutputPath","getAppBin","getVariableCommandPathName","isVariableCommandPath","sortOptions","CommandOptionsDocs","props","command","Object","keys","options","length","_$createComponent","data","values","map","option","name","trim","description","defaultValue","default","String","includes","required","optional","CommandDocs","levelOffset","context","level","children","_$memo","_$createIntrinsic","each","path","segments","segment","variables","variadic","title","CommandDocsFile","rest","Provider","value","_$mergeProps"],"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 } from \"@alloy-js/core\";\nimport { Heading } from \"@alloy-js/markdown\";\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 { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { CommandContext } from \"../contexts/command\";\nimport { getDocsOutputPath } from \"../helpers/docs-helpers\";\nimport {\n  getAppBin,\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"../plugin-utils/context-helpers\";\nimport { sortOptions } from \"../plugin-utils/reflect\";\nimport type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\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 <>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 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/**\n * Generates the markdown documentation for a command.\n */\nexport function CommandDocs(props: CommandDocsProps) {\n  const { levelOffset = 0, command } = props;\n\n  const context = usePowerlines<Context>();\n\n  return (\n    <>\n      <Heading level={1 + levelOffset}>{command.name}</Heading>\n      {command.description}\n      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Usage</Heading>\n      {code`The command can be executed using the following syntax:\n      \\`\\`\\`bash `}\n      <hbr />\n      {code`$ ${getAppBin(context)} `}\n      <For each={command.path.segments}>\n        {segment =>\n          isVariableCommandPath(segment)\n            ? `<${command.path.variables[segment]?.variadic ? \"...\" : \"\"}${kebabCase(\n                getVariableCommandPathName(segment)\n              )}>`\n            : segment\n        }\n      </For>\n      {code` [options] `}\n      <hbr />\n      {code`\\`\\`\\``}\n      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Options</Heading>\n      {code`The following options are available for the ${\n        command.title\n      } command:`}\n      <hbr />\n      <hbr />\n      <CommandOptionsDocs command={command} />\n      <hbr />\n      <hbr />\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\n  return (\n    <CommandContext.Provider value={command}>\n      <MarkdownFile\n        path={joinPaths(getDocsOutputPath(context), `${command.path.value}.md`)}\n        {...rest}>\n        <CommandDocs levelOffset={levelOffset} command={command} />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA+CA,SAAgBc,mBAAmBC,OAAgC;CACjE,MAAM,EAAEC,YAAYD;AACpB,KAAIE,OAAOC,KAAKF,QAAQG,QAAQ,CAACC,WAAW,EAC1C,QAAA,CAAA,0CAAA;AAGF,yDACGf,4EAAa,EAAA,IACZiB,OAAI;AAAA,SAAET,yCAAYI,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,YAAYpB,OAAyB;CACnD,MAAM,EAAEqB,cAAc,GAAGpB,YAAYD;CAErC,MAAMsB,8EAAkC;AAExC,QAAA;mDAEKnC,6BAAO;GAACoC,OAAO,IAAIF;GAAW,IAAAG,WAAA;AAAA,WAAGvB,QAAQU;;GAAI,CAAA;8CAC7CV,QAAQY,YAAW;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGnB1B,6BAAO;GAACoC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;EAC9BvC,oBAAI;;mDACO,OAAA,EAAA,CAAA;8CAEXA,oBAAI,KAAKU,+CAAU2B,QAAQ,CAAA,GAAG;mDAC9BpC,qBAAG;GAAA,IAACyC,OAAI;AAAA,WAAE1B,QAAQ2B,KAAKC;;GAAQL,WAC7BM,YACCjC,2DAAsBiC,QAAQ,GAC1B,IAAI7B,QAAQ2B,KAAKG,UAAUD,UAAUE,WAAW,QAAQ,sDACtDpC,gEAA2BkC,QAC7B,CAAC,CAAA,KACDA;GAAO,CAAA;EAGd7C,oBAAI;mDAAa,OAAA,EAAA,CAAA;EAEjBA,oBAAI;mDAAQ,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGZE,6BAAO;GAACoC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;8CAC9BvC,oBAAI,+CACHgB,QAAQgC,MAAK,WACJ;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGVlC,oBAAkB,EAAUE,SAAO,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;EAAA;;;;;AA2B1C,SAAgBiC,gBAAgBlC,OAA6B;CAC3D,MAAM,EAAEqB,cAAc,GAAGpB,SAAS,GAAGkC,SAASnC;CAE9C,MAAMsB,8EAAkC;AAExC,yDACG7B,wCAAe2C,UAAQ;EAACC,OAAOpC;EAAO,IAAAuB,WAAA;AAAA,2DACpCnC,sHAAY,EAAA,IACXuC,OAAI;AAAA,6CAAYlC,uCAAkB4B,QAAQ,EAAE,GAAGrB,QAAQ2B,KAAKS,MAAK,KAAM;MAAA,EACnEF,MAAI,EAAA,IAAAX,WAAA;AAAA,4DACPJ,aAAW;KAAcC;KAAsBpB;KAAO,CAAA;MAAA,CAAA,CAAA;;EAAA,CAAA"}
+{"version":3,"file":"docs.cjs","names":["code","For","Match","memo","Show","Switch","Heading","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","kebabCase","CommandContext","getDocsOutputPath","getAppBin","getVariableCommandPathName","isVariableCommandPath","sortOptions","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","children","when","_$memo","each","path","segments","joiner","segment","variables","variadic","CommandDocs","levelOffset","usageExamples","level","title","fallback","hardline","CommandDocsFile","rest","Provider","value","_$mergeProps"],"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, Match, memo, Show, Switch } from \"@alloy-js/core\";\nimport { Heading } from \"@alloy-js/markdown\";\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 { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { CommandContext } from \"../contexts/command\";\nimport { getDocsOutputPath } from \"../helpers/docs-helpers\";\nimport {\n  getAppBin,\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"../plugin-utils/context-helpers\";\nimport { sortOptions } from \"../plugin-utils/reflect\";\nimport type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\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      <Switch>\n        <Match when={packageManager === \"yarn\"}>{`yarn exec `}</Match>\n        <Match when={packageManager === \"pnpm\"}>{`pnpm exec `}</Match>\n        <Match when={packageManager === \"bun\"}>{`bun x `}</Match>\n        <Match else>{`npx `}</Match>\n      </Switch>\n      {`${getAppBin(context)} `}\n      <For each={command.path.segments} joiner=\" \">\n        {segment =>\n          isVariableCommandPath(segment)\n            ? `<${command.path.variables[segment]?.variadic ? \"...\" : \"\"}${kebabCase(\n                getVariableCommandPathName(segment)\n              )}>`\n            : segment\n        }\n      </For>\n      {code` [options] `}\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      <hbr />\n      <hbr />\n      {code`${command.description}`}\n      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Usage</Heading>\n      <hbr />\n      <hbr />\n      {code`The ${command.name} command can be executed using the following syntax: `}\n      <hbr />\n      <hbr />\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      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Options</Heading>\n      <hbr />\n      <hbr />\n      {code`The following options are available for the ${\n        command.name\n      } command:`}\n      <hbr />\n      <hbr />\n      <CommandOptionsDocs command={command} />\n      <hbr />\n      <hbr />\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.value}.md`)}\n        {...rest}>\n        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA+CA,SAAgBkB,mBAAmBC,OAAgC;CACjE,MAAM,EAAEC,YAAYD;AACpB,KAAIE,OAAOC,KAAKF,QAAQG,QAAQ,CAACC,WAAW,EAC1C,QAAOxB,oBAAI;AAGb,yDACGS,4EAAa,EAAA,IACZiB,OAAI;AAAA,SAAET,yCAAYI,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;EAGKzC,oBAAI;mDAAa,OAAA,EAAA,CAAA;mDAEjBK,wBAAM,EAAA,IAAAsC,WAAA;AAAA,UAAA;qDACJzC,uBAAK;KAAC0C,MAAMJ,mBAAmB;KAAMG,UAAG;KAAY,CAAA;qDACpDzC,uBAAK;KAAC0C,MAAMJ,mBAAmB;KAAMG,UAAG;KAAY,CAAA;qDACpDzC,uBAAK;KAAC0C,MAAMJ,mBAAmB;KAAKG,UAAG;KAAQ,CAAA;qDAC/CzC,uBAAK;KAAA,QAAA;KAAAyC,UAAO;KAAM,CAAA;IAAA;KAAA,CAAA;8CAEpB,GAAG7B,+CAAU2B,QAAQ,CAAA,GAAG;mDACxBxC,qBAAG;GAAA,IAAC6C,OAAI;AAAA,WAAE1B,QAAQ2B,KAAKC;;GAAUC,QAAM;GAAAN,WACrCO,YACClC,2DAAsBkC,QAAQ,GAC1B,IAAI9B,QAAQ2B,KAAKI,UAAUD,UAAUE,WAAW,QAAQ,sDACtDrC,gEAA2BmC,QAC7B,CAAC,CAAA,KACDA;GAAO,CAAA;EAGdlD,oBAAI;mDAAa,OAAA,EAAA,CAAA;EAEjBA,oBAAI;mDAAQ,OAAA,EAAA,CAAA;EAAA;;;;;AAiCnB,SAAgBqD,YAAYlC,OAAyB;CACnD,MAAM,EAAEmC,cAAc,GAAGlC,SAASmC,kBAAkBpC;AAEpD,QAAA;mDAEKb,6BAAO;GAACkD,OAAO,IAAIF;GAAW,IAAAX,WAAA;AAAA,WAAGvB,QAAQqC;;GAAK,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;8CAG9CzD,oBAAI,GAAGoB,QAAQY,cAAa;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAG5B1B,6BAAO;GAACkD,OAAO,IAAIF;GAAWX,UAAA;GAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;8CAG9B3C,oBAAI,OAAOoB,QAAQU,KAAI,uDAAuD;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAG9E1B,sBAAI;GAAA,IACHwC,OAAI;AAAA,WAAEW,iBAAiBA,cAAc/B,SAAS;;GAAC,IAC/CkC,WAAQ;AAAA,4DACLnB,yBAAuB;KAACC,gBAAc;KAAgBpB;KAAO,CAAA;;GAAA,IAAAuB,WAAA;AAAA,4DAE/D1C,qBAAG;KAAC6C,MAAMS;KAAgBI,UAAQ;KAAAhB,WAChCH,oEACED,yBAAuB;MACNC;MACPpB;MAAO,CAAA;KAEnB,CAAA;;GAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAKJd,6BAAO;GAACkD,OAAO,IAAIF;GAAWX,UAAA;GAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;8CAG9B3C,oBAAI,+CACHoB,QAAQU,KAAI,WACH;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAGVZ,oBAAkB,EAAUE,SAAO,CAAA;mDAAA,OAAA,EAAA,CAAA;mDAAA,OAAA,EAAA,CAAA;EAAA;;;;;AA2B1C,SAAgBwC,gBAAgBzC,OAA6B;CAC3D,MAAM,EAAEmC,cAAc,GAAGlC,SAAS,GAAGyC,SAAS1C;CAE9C,MAAMsB,8EAAkC;CACxC,MAAMc,gDACE;EAAC;EAAO;EAAQ;EAAQ;EAChC,CAAC;AAED,yDACG3C,wCAAekD,UAAQ;EAACC,OAAO3C;EAAO,IAAAuB,WAAA;AAAA,2DACpCnC,sHAAY,EAAA,IACXuC,OAAI;AAAA,6CAAYlC,uCAAkB4B,QAAQ,EAAE,GAAGrB,QAAQ2B,KAAKgB,MAAK,KAAM;MAAA,EACnEF,MAAI,EAAA,IAAAlB,WAAA;AAAA,4DACPU,aAAW;KACGC;KACJlC;KAAO,IAChBmC,gBAAa;AAAA,aAAEA,eAAe;;KAAA,CAAA;MAAA,CAAA,CAAA;;EAAA,CAAA"}

package/dist/components/docs.d.cts

@@ -13,6 +13,25 @@ interface CommandOptionsDocsProps {
  * Generates the options markdown documentation for a command.
  */
 declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core0.Children;
+interface CommandDocsUsageExampleProps {
+  /**
+   * The package manager to generate the usage example for.
+   *
+   * @remarks
+   * If not specified, examples for all supported package managers will be generated.
+   *
+   * @defaultValue "npm"
+   */
+  packageManager?: "npm" | "yarn" | "pnpm" | "bun";
+  /**
+   * The command to generate the usage example for.
+   */
+  command: CommandTree;
+}
+/**
+ * Generates the markdown documentation for a command.
+ */
+declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _alloy_js_core0.Children;
 interface CommandDocsProps {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -27,6 +46,12 @@ interface CommandDocsProps {
    * The command to generate options documentation for.
    */
   command: CommandTree;
+  /**
+   * Optional usage examples to include in the documentation.
+   *
+   * @defaultValue `["npm"]`
+   */
+  usageExamples?: Required<CommandDocsUsageExampleProps>["packageManager"][];
 }
 /**
  * Generates the markdown documentation for a command.
@@ -52,5 +77,5 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
  */
 declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core0.Children;
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps };
+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":";;;;;UAqCiB,uBAAA;;;AAAjB;EAUgB,OAAA,EANL,WAMK;AAwBhB;AAoBA;AA2CA;;AAcW,iBArGK,kBAAA,CAqGL,KAAA,EArG+B,uBAqG/B,CAAA,EArGsD,eAAA,CAAA,QAqGtD;AAdmC,UA/D7B,gBAAA,CA+D6B;EAAO;AAoBrD;;;;;;;;;;;WArEW;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA2ClC,oBAAA,SAA6B,QAAQ;;;;;;;;;;;;;WAc3C;;;;;iBAMK,eAAA,QAAuB,uBAAoB,eAAA,CAAA"}
+{"version":3,"file":"docs.d.cts","names":[],"sources":["../../src/components/docs.tsx"],"sourcesContent":[],"mappings":";;;;;UAqCiB,uBAAA;;;AAAjB;EAUgB,OAAA,EANL,WAMK;AAwBhB;AAoBA;AAkCA;;AAqB2B,iBAnGX,kBAAA,CAmGW,KAAA,EAnGe,uBAmGf,CAAA,EAnGsC,eAAA,CAAA,QAmGtC;AAAT,UA3ED,4BAAA,CA2EC;EAAQ;AAM1B;AAgDA;;;;;AAoBA;;;;;WAvIW;;;;;iBAMK,uBAAA,QAA+B,+BAA4B,eAAA,CAAA;UAkC1D,gBAAA;;;;;;;;;;;;;WAcN;;;;;;kBAOO,SAAS;;;;;iBAMX,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UAgDlC,oBAAA,SAA6B,QAAQ;;;;;;;;;;;;;WAc3C;;;;;iBAMK,eAAA,QAAuB,uBAAoB,eAAA,CAAA"}

package/dist/components/docs.d.mts

@@ -13,6 +13,25 @@ interface CommandOptionsDocsProps {
  * Generates the options markdown documentation for a command.
  */
 declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core0.Children;
+interface CommandDocsUsageExampleProps {
+  /**
+   * The package manager to generate the usage example for.
+   *
+   * @remarks
+   * If not specified, examples for all supported package managers will be generated.
+   *
+   * @defaultValue "npm"
+   */
+  packageManager?: "npm" | "yarn" | "pnpm" | "bun";
+  /**
+   * The command to generate the usage example for.
+   */
+  command: CommandTree;
+}
+/**
+ * Generates the markdown documentation for a command.
+ */
+declare function CommandDocsUsageExample(props: CommandDocsUsageExampleProps): _alloy_js_core0.Children;
 interface CommandDocsProps {
   /**
    * The heading level offset to apply to the generated documentation.
@@ -27,6 +46,12 @@ interface CommandDocsProps {
    * The command to generate options documentation for.
    */
   command: CommandTree;
+  /**
+   * Optional usage examples to include in the documentation.
+   *
+   * @defaultValue `["npm"]`
+   */
+  usageExamples?: Required<CommandDocsUsageExampleProps>["packageManager"][];
 }
 /**
  * Generates the markdown documentation for a command.
@@ -52,5 +77,5 @@ interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
  */
 declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core0.Children;
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps };
+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":";;;;;UAqCiB,uBAAA;;;AAAjB;EAUgB,OAAA,EANL,WAMK;AAwBhB;AAoBA;AA2CA;;AAcW,iBArGK,kBAAA,CAqGL,KAAA,EArG+B,uBAqG/B,CAAA,EArGsD,eAAA,CAAA,QAqGtD;AAdmC,UA/D7B,gBAAA,CA+D6B;EAAO;AAoBrD;;;;;;;;;;;WArEW;;;;;iBAMK,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UA2ClC,oBAAA,SAA6B,QAAQ;;;;;;;;;;;;;WAc3C;;;;;iBAMK,eAAA,QAAuB,uBAAoB,eAAA,CAAA"}
+{"version":3,"file":"docs.d.mts","names":[],"sources":["../../src/components/docs.tsx"],"sourcesContent":[],"mappings":";;;;;UAqCiB,uBAAA;;;AAAjB;EAUgB,OAAA,EANL,WAMK;AAwBhB;AAoBA;AAkCA;;AAqB2B,iBAnGX,kBAAA,CAmGW,KAAA,EAnGe,uBAmGf,CAAA,EAnGsC,eAAA,CAAA,QAmGtC;AAAT,UA3ED,4BAAA,CA2EC;EAAQ;AAM1B;AAgDA;;;;;AAoBA;;;;;WAvIW;;;;;iBAMK,uBAAA,QAA+B,+BAA4B,eAAA,CAAA;UAkC1D,gBAAA;;;;;;;;;;;;;WAcN;;;;;;kBAOO,SAAS;;;;;iBAMX,WAAA,QAAmB,mBAAgB,eAAA,CAAA;UAgDlC,oBAAA,SAA6B,QAAQ;;;;;;;;;;;;;WAc3C;;;;;iBAMK,eAAA,QAAuB,uBAAoB,eAAA,CAAA"}

package/dist/components/docs.mjs

@@ -4,7 +4,7 @@ import { getAppBin, getVariableCommandPathName, isVariableCommandPath } from "..
 import { sortOptions } from "../plugin-utils/reflect.mjs";
 import { createComponent, createIntrinsic, memo, mergeProps } from "@alloy-js/core/jsx-runtime";
 import { kebabCase } from "@stryke/string-format/kebab-case";
-import { For, code } from "@alloy-js/core";
+import { For, Match, Show, Switch, code, memo as memo$1 } from "@alloy-js/core";
 import { Heading } from "@alloy-js/markdown";
 import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
 import { MarkdownFile } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
@@ -17,7 +17,7 @@ import { joinPaths } from "@stryke/path/join";
 */
 function CommandOptionsDocs(props) {
 	const { command } = props;
-	if (Object.keys(command.options).length === 0) return ["This command does not have any options."];
+	if (Object.keys(command.options).length === 0) return code`This command does not have any options.`;
 	return createComponent(MarkdownTable, { get data() {
 		return sortOptions(Object.values(command.options)).map((option) => {
 			return {
@@ -32,43 +32,103 @@ function CommandOptionsDocs(props) {
 /**
 * Generates the markdown documentation for a command.
 */
-function CommandDocs(props) {
-	const { levelOffset = 0, command } = props;
+function CommandDocsUsageExample(props) {
+	const { packageManager = "npm", command } = props;
 	const context = usePowerlines();
+	return [
+		createIntrinsic("hbr", {}),
+		code`\`\`\`bash `,
+		createIntrinsic("hbr", {}),
+		createComponent(Switch, { get children() {
+			return [
+				createComponent(Match, {
+					when: packageManager === "yarn",
+					children: `yarn exec `
+				}),
+				createComponent(Match, {
+					when: packageManager === "pnpm",
+					children: `pnpm exec `
+				}),
+				createComponent(Match, {
+					when: packageManager === "bun",
+					children: `bun x `
+				}),
+				createComponent(Match, {
+					"else": true,
+					children: `npx `
+				})
+			];
+		} }),
+		memo(() => `${getAppBin(context)} `),
+		createComponent(For, {
+			get each() {
+				return command.path.segments;
+			},
+			joiner: " ",
+			children: (segment) => isVariableCommandPath(segment) ? `<${command.path.variables[segment]?.variadic ? "..." : ""}${kebabCase(getVariableCommandPathName(segment))}>` : segment
+		}),
+		code` [options] `,
+		createIntrinsic("hbr", {}),
+		code`\`\`\``,
+		createIntrinsic("hbr", {})
+	];
+}
+/**
+* Generates the markdown documentation for a command.
+*/
+function CommandDocs(props) {
+	const { levelOffset = 0, command, usageExamples } = props;
 	return [
 		createComponent(Heading, {
 			level: 1 + levelOffset,
 			get children() {
-				return command.name;
+				return command.title;
 			}
 		}),
-		memo(() => command.description),
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		memo(() => code`${command.description}`),
 		createIntrinsic("hbr", {}),
 		createIntrinsic("hbr", {}),
 		createComponent(Heading, {
 			level: 2 + levelOffset,
 			children: "Usage"
 		}),
-		code`The command can be executed using the following syntax:
-      \`\`\`bash `,
 		createIntrinsic("hbr", {}),
-		memo(() => code`$ ${getAppBin(context)} `),
-		createComponent(For, {
-			get each() {
-				return command.path.segments;
+		createIntrinsic("hbr", {}),
+		memo(() => code`The ${command.name} command can be executed using the following syntax: `),
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		createComponent(Show, {
+			get when() {
+				return usageExamples && usageExamples.length > 0;
 			},
-			children: (segment) => isVariableCommandPath(segment) ? `<${command.path.variables[segment]?.variadic ? "..." : ""}${kebabCase(getVariableCommandPathName(segment))}>` : segment
+			get fallback() {
+				return createComponent(CommandDocsUsageExample, {
+					packageManager: "npm",
+					command
+				});
+			},
+			get children() {
+				return createComponent(For, {
+					each: usageExamples,
+					hardline: true,
+					children: (packageManager) => createComponent(CommandDocsUsageExample, {
+						packageManager,
+						command
+					})
+				});
+			}
 		}),
-		code` [options] `,
-		createIntrinsic("hbr", {}),
-		code`\`\`\``,
 		createIntrinsic("hbr", {}),
 		createIntrinsic("hbr", {}),
 		createComponent(Heading, {
 			level: 2 + levelOffset,
 			children: "Options"
 		}),
-		memo(() => code`The following options are available for the ${command.title} command:`),
+		createIntrinsic("hbr", {}),
+		createIntrinsic("hbr", {}),
+		memo(() => code`The following options are available for the ${command.name} command:`),
 		createIntrinsic("hbr", {}),
 		createIntrinsic("hbr", {}),
 		createComponent(CommandOptionsDocs, { command }),
@@ -82,6 +142,12 @@ function CommandDocs(props) {
 function CommandDocsFile(props) {
 	const { levelOffset = 0, command, ...rest } = props;
 	const context = usePowerlines();
+	const usageExamples = memo$1(() => [
+		"npm",
+		"yarn",
+		"pnpm",
+		"bun"
+	]);
 	return createComponent(CommandContext.Provider, {
 		value: command,
 		get children() {
@@ -90,7 +156,10 @@ function CommandDocsFile(props) {
 			} }, rest, { get children() {
 				return createComponent(CommandDocs, {
 					levelOffset,
-					command
+					command,
+					get usageExamples() {
+						return usageExamples();
+					}
 				});
 			} }));
 		}
@@ -98,5 +167,5 @@ function CommandDocsFile(props) {
 }
 
 //#endregion
-export { CommandDocs, CommandDocsFile, CommandOptionsDocs };
+export { CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs };
 //# sourceMappingURL=docs.mjs.map

package/dist/components/docs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"docs.mjs","names":["code","For","Heading","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","kebabCase","CommandContext","getDocsOutputPath","getAppBin","getVariableCommandPathName","isVariableCommandPath","sortOptions","CommandOptionsDocs","props","command","Object","keys","options","length","_$createComponent","data","values","map","option","name","trim","description","defaultValue","default","String","includes","required","optional","CommandDocs","levelOffset","context","level","children","_$memo","_$createIntrinsic","each","path","segments","segment","variables","variadic","title","CommandDocsFile","rest","Provider","value","_$mergeProps"],"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 } from \"@alloy-js/core\";\nimport { Heading } from \"@alloy-js/markdown\";\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 { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { CommandContext } from \"../contexts/command\";\nimport { getDocsOutputPath } from \"../helpers/docs-helpers\";\nimport {\n  getAppBin,\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"../plugin-utils/context-helpers\";\nimport { sortOptions } from \"../plugin-utils/reflect\";\nimport type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\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 <>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 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/**\n * Generates the markdown documentation for a command.\n */\nexport function CommandDocs(props: CommandDocsProps) {\n  const { levelOffset = 0, command } = props;\n\n  const context = usePowerlines<Context>();\n\n  return (\n    <>\n      <Heading level={1 + levelOffset}>{command.name}</Heading>\n      {command.description}\n      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Usage</Heading>\n      {code`The command can be executed using the following syntax:\n      \\`\\`\\`bash `}\n      <hbr />\n      {code`$ ${getAppBin(context)} `}\n      <For each={command.path.segments}>\n        {segment =>\n          isVariableCommandPath(segment)\n            ? `<${command.path.variables[segment]?.variadic ? \"...\" : \"\"}${kebabCase(\n                getVariableCommandPathName(segment)\n              )}>`\n            : segment\n        }\n      </For>\n      {code` [options] `}\n      <hbr />\n      {code`\\`\\`\\``}\n      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Options</Heading>\n      {code`The following options are available for the ${\n        command.title\n      } command:`}\n      <hbr />\n      <hbr />\n      <CommandOptionsDocs command={command} />\n      <hbr />\n      <hbr />\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\n  return (\n    <CommandContext.Provider value={command}>\n      <MarkdownFile\n        path={joinPaths(getDocsOutputPath(context), `${command.path.value}.md`)}\n        {...rest}>\n        <CommandDocs levelOffset={levelOffset} command={command} />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA+CA,SAAgBc,mBAAmBC,OAAgC;CACjE,MAAM,EAAEC,YAAYD;AACpB,KAAIE,OAAOC,KAAKF,QAAQG,QAAQ,CAACC,WAAW,EAC1C,QAAA,CAAA,0CAAA;AAGF,QAAAC,gBACGhB,eAAa,EAAA,IACZiB,OAAI;AAAA,SAAET,YAAYI,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,YAAYpB,OAAyB;CACnD,MAAM,EAAEqB,cAAc,GAAGpB,YAAYD;CAErC,MAAMsB,UAAUlC,eAAwB;AAExC,QAAA;EAAAkB,gBAEKnB,SAAO;GAACoC,OAAO,IAAIF;GAAW,IAAAG,WAAA;AAAA,WAAGvB,QAAQU;;GAAI,CAAA;EAAAc,WAC7CxB,QAAQY,YAAW;EAAAa,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAApB,gBAGnBnB,SAAO;GAACoC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;EAC9BvC,IAAI;;EACOyC,gBAAA,OAAA,EAAA,CAAA;EAAAD,WAEXxC,IAAI,KAAKU,UAAU2B,QAAQ,CAAA,GAAG;EAAAhB,gBAC9BpB,KAAG;GAAA,IAACyC,OAAI;AAAA,WAAE1B,QAAQ2B,KAAKC;;GAAQL,WAC7BM,YACCjC,sBAAsBiC,QAAQ,GAC1B,IAAI7B,QAAQ2B,KAAKG,UAAUD,UAAUE,WAAW,QAAQ,KAAKxC,UAC3DI,2BAA2BkC,QAC7B,CAAC,CAAA,KACDA;GAAO,CAAA;EAGd7C,IAAI;EAAayC,gBAAA,OAAA,EAAA,CAAA;EAEjBzC,IAAI;EAAQyC,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAApB,gBAGZnB,SAAO;GAACoC,OAAO,IAAIF;GAAWG,UAAA;GAAA,CAAA;EAAAC,WAC9BxC,IAAI,+CACHgB,QAAQgC,MAAK,WACJ;EAAAP,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAApB,gBAGVP,oBAAkB,EAAUE,SAAO,CAAA;EAAAyB,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;AA2B1C,SAAgBQ,gBAAgBlC,OAA6B;CAC3D,MAAM,EAAEqB,cAAc,GAAGpB,SAAS,GAAGkC,SAASnC;CAE9C,MAAMsB,UAAUlC,eAAwB;AAExC,QAAAkB,gBACGb,eAAe2C,UAAQ;EAACC,OAAOpC;EAAO,IAAAuB,WAAA;AAAA,UAAAlB,gBACpCjB,cAAYiD,WAAA,EAAA,IACXV,OAAI;AAAA,WAAErC,UAAUG,kBAAkB4B,QAAQ,EAAE,GAAGrB,QAAQ2B,KAAKS,MAAK,KAAM;MAAA,EACnEF,MAAI,EAAA,IAAAX,WAAA;AAAA,WAAAlB,gBACPc,aAAW;KAAcC;KAAsBpB;KAAO,CAAA;MAAA,CAAA,CAAA;;EAAA,CAAA"}
+{"version":3,"file":"docs.mjs","names":["code","For","Match","memo","Show","Switch","Heading","usePowerlines","MarkdownFile","MarkdownTable","joinPaths","kebabCase","CommandContext","getDocsOutputPath","getAppBin","getVariableCommandPathName","isVariableCommandPath","sortOptions","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","children","when","_$memo","each","path","segments","joiner","segment","variables","variadic","CommandDocs","levelOffset","usageExamples","level","title","fallback","hardline","CommandDocsFile","rest","Provider","value","_$mergeProps"],"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, Match, memo, Show, Switch } from \"@alloy-js/core\";\nimport { Heading } from \"@alloy-js/markdown\";\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 { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { CommandContext } from \"../contexts/command\";\nimport { getDocsOutputPath } from \"../helpers/docs-helpers\";\nimport {\n  getAppBin,\n  getVariableCommandPathName,\n  isVariableCommandPath\n} from \"../plugin-utils/context-helpers\";\nimport { sortOptions } from \"../plugin-utils/reflect\";\nimport type { CommandTree } from \"../types/command\";\nimport type { Context } from \"../types/context\";\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      <Switch>\n        <Match when={packageManager === \"yarn\"}>{`yarn exec `}</Match>\n        <Match when={packageManager === \"pnpm\"}>{`pnpm exec `}</Match>\n        <Match when={packageManager === \"bun\"}>{`bun x `}</Match>\n        <Match else>{`npx `}</Match>\n      </Switch>\n      {`${getAppBin(context)} `}\n      <For each={command.path.segments} joiner=\" \">\n        {segment =>\n          isVariableCommandPath(segment)\n            ? `<${command.path.variables[segment]?.variadic ? \"...\" : \"\"}${kebabCase(\n                getVariableCommandPathName(segment)\n              )}>`\n            : segment\n        }\n      </For>\n      {code` [options] `}\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      <hbr />\n      <hbr />\n      {code`${command.description}`}\n      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Usage</Heading>\n      <hbr />\n      <hbr />\n      {code`The ${command.name} command can be executed using the following syntax: `}\n      <hbr />\n      <hbr />\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      <hbr />\n      <hbr />\n      <Heading level={2 + levelOffset}>Options</Heading>\n      <hbr />\n      <hbr />\n      {code`The following options are available for the ${\n        command.name\n      } command:`}\n      <hbr />\n      <hbr />\n      <CommandOptionsDocs command={command} />\n      <hbr />\n      <hbr />\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.value}.md`)}\n        {...rest}>\n        <CommandDocs\n          levelOffset={levelOffset}\n          command={command}\n          usageExamples={usageExamples()}\n        />\n      </MarkdownFile>\n    </CommandContext.Provider>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA+CA,SAAgBkB,mBAAmBC,OAAgC;CACjE,MAAM,EAAEC,YAAYD;AACpB,KAAIE,OAAOC,KAAKF,QAAQG,QAAQ,CAACC,WAAW,EAC1C,QAAOxB,IAAI;AAGb,QAAAyB,gBACGhB,eAAa,EAAA,IACZiB,OAAI;AAAA,SAAET,YAAYI,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,UAAUlC,eAAwB;AAExC,QAAA;EAAAmC,gBAAA,OAAA,EAAA,CAAA;EAGK1C,IAAI;EAAa0C,gBAAA,OAAA,EAAA,CAAA;EAAAjB,gBAEjBpB,QAAM,EAAA,IAAAsC,WAAA;AAAA,UAAA;IAAAlB,gBACJvB,OAAK;KAAC0C,MAAMJ,mBAAmB;KAAMG,UAAG;KAAY,CAAA;IAAAlB,gBACpDvB,OAAK;KAAC0C,MAAMJ,mBAAmB;KAAMG,UAAG;KAAY,CAAA;IAAAlB,gBACpDvB,OAAK;KAAC0C,MAAMJ,mBAAmB;KAAKG,UAAG;KAAQ,CAAA;IAAAlB,gBAC/CvB,OAAK;KAAA,QAAA;KAAAyC,UAAO;KAAM,CAAA;IAAA;KAAA,CAAA;EAAAE,WAEpB,GAAG/B,UAAU2B,QAAQ,CAAA,GAAG;EAAAhB,gBACxBxB,KAAG;GAAA,IAAC6C,OAAI;AAAA,WAAE1B,QAAQ2B,KAAKC;;GAAUC,QAAM;GAAAN,WACrCO,YACClC,sBAAsBkC,QAAQ,GAC1B,IAAI9B,QAAQ2B,KAAKI,UAAUD,UAAUE,WAAW,QAAQ,KAAKzC,UAC3DI,2BAA2BmC,QAC7B,CAAC,CAAA,KACDA;GAAO,CAAA;EAGdlD,IAAI;EAAa0C,gBAAA,OAAA,EAAA,CAAA;EAEjB1C,IAAI;EAAQ0C,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;AAiCnB,SAAgBW,YAAYlC,OAAyB;CACnD,MAAM,EAAEmC,cAAc,GAAGlC,SAASmC,kBAAkBpC;AAEpD,QAAA;EAAAM,gBAEKnB,SAAO;GAACkD,OAAO,IAAIF;GAAW,IAAAX,WAAA;AAAA,WAAGvB,QAAQqC;;GAAK,CAAA;EAAAf,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAG,WAG9C7C,IAAI,GAAGoB,QAAQY,cAAa;EAAAU,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAjB,gBAG5BnB,SAAO;GAACkD,OAAO,IAAIF;GAAWX,UAAA;GAAA,CAAA;EAAAD,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAG,WAG9B7C,IAAI,OAAOoB,QAAQU,KAAI,uDAAuD;EAAAY,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAjB,gBAG9ErB,MAAI;GAAA,IACHwC,OAAI;AAAA,WAAEW,iBAAiBA,cAAc/B,SAAS;;GAAC,IAC/CkC,WAAQ;AAAA,WAAAjC,gBACLc,yBAAuB;KAACC,gBAAc;KAAgBpB;KAAO,CAAA;;GAAA,IAAAuB,WAAA;AAAA,WAAAlB,gBAE/DxB,KAAG;KAAC6C,MAAMS;KAAgBI,UAAQ;KAAAhB,WAChCH,mBAAcf,gBACZc,yBAAuB;MACNC;MACPpB;MAAO,CAAA;KAEnB,CAAA;;GAAA,CAAA;EAAAsB,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAjB,gBAKJnB,SAAO;GAACkD,OAAO,IAAIF;GAAWX,UAAA;GAAA,CAAA;EAAAD,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAG,WAG9B7C,IAAI,+CACHoB,QAAQU,KAAI,WACH;EAAAY,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAAjB,gBAGVP,oBAAkB,EAAUE,SAAO,CAAA;EAAAsB,gBAAA,OAAA,EAAA,CAAA;EAAAA,gBAAA,OAAA,EAAA,CAAA;EAAA;;;;;AA2B1C,SAAgBkB,gBAAgBzC,OAA6B;CAC3D,MAAM,EAAEmC,cAAc,GAAGlC,SAAS,GAAGyC,SAAS1C;CAE9C,MAAMsB,UAAUlC,eAAwB;CACxC,MAAMgD,gBAAgBpD,aACd;EAAC;EAAO;EAAQ;EAAQ;EAChC,CAAC;AAED,QAAAsB,gBACGb,eAAekD,UAAQ;EAACC,OAAO3C;EAAO,IAAAuB,WAAA;AAAA,UAAAlB,gBACpCjB,cAAYwD,WAAA,EAAA,IACXjB,OAAI;AAAA,WAAErC,UAAUG,kBAAkB4B,QAAQ,EAAE,GAAGrB,QAAQ2B,KAAKgB,MAAK,KAAM;MAAA,EACnEF,MAAI,EAAA,IAAAlB,WAAA;AAAA,WAAAlB,gBACP4B,aAAW;KACGC;KACJlC;KAAO,IAChBmC,gBAAa;AAAA,aAAEA,eAAe;;KAAA,CAAA;MAAA,CAAA,CAAA;;EAAA,CAAA"}

package/dist/components/index.cjs

@@ -2,4 +2,5 @@ const require_components_docs = require('./docs.cjs');
 
 exports.CommandDocs = require_components_docs.CommandDocs;
 exports.CommandDocsFile = require_components_docs.CommandDocsFile;
+exports.CommandDocsUsageExample = require_components_docs.CommandDocsUsageExample;
 exports.CommandOptionsDocs = require_components_docs.CommandOptionsDocs;

package/dist/components/index.d.cts

@@ -1,2 +1,2 @@
-import { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps } from "./docs.cjs";
-export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps };
+import { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps } from "./docs.cjs";
+export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps };

package/dist/components/index.d.mts

@@ -1,2 +1,2 @@
-import { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps } from "./docs.mjs";
-export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps };
+import { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps } from "./docs.mjs";
+export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandDocsUsageExample, CommandDocsUsageExampleProps, CommandOptionsDocs, CommandOptionsDocsProps };

package/dist/components/index.mjs

@@ -1,3 +1,3 @@
-import { CommandDocs, CommandDocsFile, CommandOptionsDocs } from "./docs.mjs";
+import { CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs } from "./docs.mjs";
 
-export { CommandDocs, CommandDocsFile, CommandOptionsDocs };
+export { CommandDocs, CommandDocsFile, CommandDocsUsageExample, CommandOptionsDocs };