@shell-shock/core 0.2.0 → 0.3.0

package/README.md

@@ -1,4 +1,52 @@
 <!-- START header -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+<div align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/shell-shock/banner-1280x640-dark.gif">
+  <source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/shell-shock/banner-1280x640-light.gif">
+<img src="https://public.storm-cdn.com/shell-shock/banner-1280x640-dark.gif" width="100%" alt="Storm Software" />
+</picture>
+</div>
+<br />
+
+<div align="center">
+<b>
+<a href="https://stormsoftware.com" target="_blank">Website</a>  •
+<a href="https://github.com/storm-software/shell-shock" target="_blank">GitHub</a>  •
+<a href="https://discord.gg/MQ6YVzakM5">Discord</a>  •  <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a>  •  <a href="https://stormsoftware.com/contact" target="_blank">Contact</a>  •
+<a href="https://github.com/storm-software/shell-shock/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
+</b>
+</div>
+
+<br />
+This package is part of the ⚡<b>Shell Shock</b> monorepo. The Shell Shock packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
+<br />
+
+<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
+
+[![Version](https://img.shields.io/badge/version-0.2.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://stormsoftware.com/projects/shell-shock/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/shell-shock/release.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+> [!IMPORTANT] 
+> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<div align="center">
+<b>Be sure to ⭐ this repository on <a href="https://github.com/storm-software/shell-shock" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b>
+</div>
+
+<br />
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
 <!-- END header -->
 
 # Shell Shock
@@ -40,4 +88,177 @@ Run `nx build core` to build the library.
 Run `nx test core` to execute the unit tests via [Jest](https://jestjs.io).
 
 <!-- START footer -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Storm Workspaces
+
+Storm workspaces are built using
+<a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
+for monorepos, which helps you develop like Google, Facebook, and Microsoft.
+Building on top of Nx, the Open System provides a set of tools and patterns that
+help you scale your monorepo to many teams while keeping the codebase
+maintainable.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Roadmap
+
+See the [open issues](https://github.com/storm-software/shell-shock/issues) for
+a list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/storm-software/shell-shock/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
+  (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/storm-software/shell-shock/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
+  (Add your votes using the 👍 reaction)
+- [Newest Bugs](https://github.com/storm-software/shell-shock/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Support
+
+Reach out to the maintainer at one of the following places:
+
+- [Contact](https://stormsoftware.com/contact)
+- [GitHub discussions](https://github.com/storm-software/shell-shock/discussions)
+- <support@stormsoftware.com>
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## License
+
+This project is licensed under the **Apache License 2.0**. Feel free to edit and
+distribute this template as you like.
+
+See [LICENSE](LICENSE) for more information.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Changelog
+
+This project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
+with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
+file
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Contributing
+
+First off, thanks for taking the time to contribute! Contributions are what
+makes the open-source community such an amazing place to learn, inspire, and
+create. Any contributions you make will benefit everybody else and are **greatly
+appreciated**.
+
+Please try to create bug reports that are:
+
+- _Reproducible._ Include steps to reproduce the problem.
+- _Specific._ Include as much detail as possible: which version, what
+  environment, etc.
+- _Unique._ Do not duplicate existing opened issues.
+- _Scoped to a Single Bug._ One bug per report.
+
+Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
+
+You can use
+[markdownlint-cli](https://github.com/storm-software/shell-shock/markdownlint-cli)
+to check for common markdown style inconsistency.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Contributors
+
+Thanks goes to these wonderful people
+([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/shell-shock/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/shell-shock/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/shell-shock/commits?author=sullivanpj" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.com"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg" alt="All Contributors">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the
+[all-contributors](https://github.com/all-contributors/all-contributors)
+specification. Contributions of any kind welcome!
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+<hr />
+<br />
+
+<div align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x320-dark.webp">
+  <source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x320-light.webp">
+<img src="https://public.storm-cdn.com/storm-software/banner-1280x320-dark.webp" width="100%" alt="Storm Software" />
+</picture>
+</div>
+<br />
+
+<div align="center">
+<a href="https://stormsoftware.com" target="_blank">Website</a>  •  <a href="https://stormsoftware.com/contact" target="_blank">Contact</a>  •  <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a>  •  <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a>  •  <a href="https://github.com/storm-software" target="_blank">GitHub</a>  •  <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
+</div>
+
+<div align="center">
+<b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
+</div>
+<br />
+
+Storm Software is an open source software development organization and creator
+of Acidic, StormStack and StormCloud.
+
+Our mission is to make software development more accessible. Our ideal future is
+one where anyone can create software without years of prior development
+experience serving as a barrier to entry. We hope to achieve this via LLMs,
+Generative AI, and intuitive, high-level data modeling/programming languages.
+
+Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
+receive release notifications, ask questions, and get involved.
+
+If this sounds interesting, and you would like to help us in creating the next
+generation of development tools, please reach out on our
+[website](https://stormsoftware.com/contact) or join our
+[Slack channel](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)!
+
+<br />
+
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
+<br />
+<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
+
+<br />
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+<br />
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
 <!-- END footer -->

package/dist/_virtual/rolldown_runtime.cjs

@@ -1 +1,29 @@
-var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));exports.__toESM=s;
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+exports.__toESM = __toESM;

package/dist/api.cjs

@@ -1 +1,57 @@
-const e=require(`./_virtual/rolldown_runtime.cjs`),t=require(`./powerlines.cjs`);let n=require(`@powerlines/plugin-tsdown`);n=e.__toESM(n);let r=require(`powerlines`);var i=class e{#e;static async from(i={}){return new e(await(0,r.createPowerlines)({...i,plugins:[(0,n.default)(),t.shellShock(),...i.plugins??[]]}))}constructor(e){this.#e=e}async clean(e){return this.#e.clean(e)}async prepare(e){return this.#e.prepare(e)}async lint(e){return this.#e.lint(e)}async build(e){return this.#e.build(e)}async docs(e){return this.#e.docs(e)}async finalize(){return this.#e.finalize()}};exports.ShellShockAPI=i;
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_plugin = require('./plugin.cjs');
+let powerlines = require("powerlines");
+
+//#region src/api.ts
+/**
+* The Shell Shock API class.
+*
+* @remarks
+* This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
+*/
+var ShellShockAPI = class ShellShockAPI {
+	#powerlines;
+	static async from(config = {}) {
+		return new ShellShockAPI(await (0, powerlines.createPowerlines)({
+			framework: "shell-shock",
+			...config,
+			plugins: [require_plugin.plugin(), ...config.plugins ?? []]
+		}));
+	}
+	constructor(powerlines$1) {
+		this.#powerlines = powerlines$1;
+	}
+	async clean(inlineConfig) {
+		return this.#powerlines.clean(inlineConfig);
+	}
+	async prepare(inlineConfig) {
+		return this.#powerlines.prepare(inlineConfig);
+	}
+	async lint(inlineConfig) {
+		return this.#powerlines.lint(inlineConfig);
+	}
+	async build(inlineConfig) {
+		return this.#powerlines.build(inlineConfig);
+	}
+	async docs(inlineConfig) {
+		return this.#powerlines.docs(inlineConfig);
+	}
+	async finalize() {
+		return this.#powerlines.finalize();
+	}
+};
+/**
+* Creates a new {@link ShellShockAPI} instance.
+*
+* @param options - The user configuration options.
+* @returns A promise that resolves to a {@link ShellShockAPI} instance.
+*/
+async function createShellShock(options = {}) {
+	options.root ??= process.cwd();
+	return ShellShockAPI.from(options);
+}
+
+//#endregion
+exports.ShellShockAPI = ShellShockAPI;
+exports.createShellShock = createShellShock;
+//# sourceMappingURL=api.cjs.map

package/dist/api.cjs.map

@@ -0,0 +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"}

package/dist/api.d.cts

@@ -20,5 +20,13 @@ declare class ShellShockAPI {
   docs(inlineConfig: DocsInlineConfig): Promise<void>;
   finalize(): Promise<void>;
 }
+/**
+ * Creates a new {@link ShellShockAPI} instance.
+ *
+ * @param options - The user configuration options.
+ * @returns A promise that resolves to a {@link ShellShockAPI} instance.
+ */
+declare function createShellShock(options?: Partial<UserConfig>): Promise<ShellShockAPI>;
 //#endregion
-export { ShellShockAPI };
+export { ShellShockAPI, createShellShock };
+//# sourceMappingURL=api.d.cts.map

package/dist/api.d.cts.map

@@ -0,0 +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"}

package/dist/api.d.mts

@@ -20,5 +20,13 @@ declare class ShellShockAPI {
   docs(inlineConfig: DocsInlineConfig): Promise<void>;
   finalize(): Promise<void>;
 }
+/**
+ * Creates a new {@link ShellShockAPI} instance.
+ *
+ * @param options - The user configuration options.
+ * @returns A promise that resolves to a {@link ShellShockAPI} instance.
+ */
+declare function createShellShock(options?: Partial<UserConfig>): Promise<ShellShockAPI>;
 //#endregion
-export { ShellShockAPI };
+export { ShellShockAPI, createShellShock };
+//# sourceMappingURL=api.d.mts.map

package/dist/api.d.mts.map

@@ -0,0 +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"}

package/dist/api.mjs

@@ -1 +1,55 @@
-import{shellShock as e}from"./powerlines.mjs";import t from"@powerlines/plugin-tsdown";import{createPowerlines as n}from"powerlines";var r=class r{#e;static async from(i={}){return new r(await n({...i,plugins:[t(),e(),...i.plugins??[]]}))}constructor(e){this.#e=e}async clean(e){return this.#e.clean(e)}async prepare(e){return this.#e.prepare(e)}async lint(e){return this.#e.lint(e)}async build(e){return this.#e.build(e)}async docs(e){return this.#e.docs(e)}async finalize(){return this.#e.finalize()}};export{r as ShellShockAPI};
+import { plugin } from "./plugin.mjs";
+import { createPowerlines } from "powerlines";
+
+//#region src/api.ts
+/**
+* The Shell Shock API class.
+*
+* @remarks
+* This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
+*/
+var ShellShockAPI = class ShellShockAPI {
+	#powerlines;
+	static async from(config = {}) {
+		return new ShellShockAPI(await createPowerlines({
+			framework: "shell-shock",
+			...config,
+			plugins: [plugin(), ...config.plugins ?? []]
+		}));
+	}
+	constructor(powerlines) {
+		this.#powerlines = powerlines;
+	}
+	async clean(inlineConfig) {
+		return this.#powerlines.clean(inlineConfig);
+	}
+	async prepare(inlineConfig) {
+		return this.#powerlines.prepare(inlineConfig);
+	}
+	async lint(inlineConfig) {
+		return this.#powerlines.lint(inlineConfig);
+	}
+	async build(inlineConfig) {
+		return this.#powerlines.build(inlineConfig);
+	}
+	async docs(inlineConfig) {
+		return this.#powerlines.docs(inlineConfig);
+	}
+	async finalize() {
+		return this.#powerlines.finalize();
+	}
+};
+/**
+* Creates a new {@link ShellShockAPI} instance.
+*
+* @param options - The user configuration options.
+* @returns A promise that resolves to a {@link ShellShockAPI} instance.
+*/
+async function createShellShock(options = {}) {
+	options.root ??= process.cwd();
+	return ShellShockAPI.from(options);
+}
+
+//#endregion
+export { ShellShockAPI, createShellShock };
+//# sourceMappingURL=api.mjs.map

package/dist/api.mjs.map

@@ -0,0 +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"}

package/dist/components/docs.cjs

@@ -0,0 +1,105 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const require_contexts_command = require('../contexts/command.cjs');
+const require_docs_helpers = require('../helpers/docs-helpers.cjs');
+const require_plugin_utils_context_helpers = require('../plugin-utils/context-helpers.cjs');
+const require_plugin_utils_reflect = require('../plugin-utils/reflect.cjs');
+let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let __stryke_string_format_kebab_case = require("@stryke/string-format/kebab-case");
+let __alloy_js_core = require("@alloy-js/core");
+let __alloy_js_markdown = require("@alloy-js/markdown");
+let __powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
+let __powerlines_plugin_alloy_markdown_components_markdown_file = require("@powerlines/plugin-alloy/markdown/components/markdown-file");
+let __powerlines_plugin_alloy_markdown_components_markdown_table = require("@powerlines/plugin-alloy/markdown/components/markdown-table");
+let __stryke_path_join = require("@stryke/path/join");
+
+//#region src/components/docs.tsx
+/**
+* Generates the options markdown documentation for a command.
+*/
+function CommandOptionsDocs(props) {
+	const { command } = props;
+	if (Object.keys(command.options).length === 0) return ["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 {
+				name: option.name.trim(),
+				description: option.description.trim(),
+				defaultValue: option.default ? String(option.default)?.includes("\"") ? option.default : `\`${option.default}\`` : "",
+				required: option.optional || option.default ? "" : "✔"
+			};
+		});
+	} });
+}
+/**
+* Generates the markdown documentation for a command.
+*/
+function CommandDocs(props) {
+	const { levelOffset = 0, command } = props;
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_markdown.Heading, {
+			level: 1 + levelOffset,
+			get children() {
+				return command.name;
+			}
+		}),
+		(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.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;
+			},
+			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", {}),
+		(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.createComponent)(CommandOptionsDocs, { command }),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+		(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {})
+	];
+}
+/**
+* Generates the markdown documentation file for a command.
+*/
+function CommandDocsFile(props) {
+	const { levelOffset = 0, command, ...rest } = props;
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return (0, __alloy_js_core_jsx_runtime.createComponent)(require_contexts_command.CommandContext.Provider, {
+		value: command,
+		get children() {
+			return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_markdown_components_markdown_file.MarkdownFile, (0, __alloy_js_core_jsx_runtime.mergeProps)({ get path() {
+				return (0, __stryke_path_join.joinPaths)(require_docs_helpers.getDocsOutputPath(context), `${command.path.value}.md`);
+			} }, rest, { get children() {
+				return (0, __alloy_js_core_jsx_runtime.createComponent)(CommandDocs, {
+					levelOffset,
+					command
+				});
+			} }));
+		}
+	});
+}
+
+//#endregion
+exports.CommandDocs = CommandDocs;
+exports.CommandDocsFile = CommandDocsFile;
+exports.CommandOptionsDocs = CommandOptionsDocs;
+//# sourceMappingURL=docs.cjs.map

package/dist/components/docs.cjs.map

@@ -0,0 +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"}

package/dist/components/docs.d.cts

@@ -0,0 +1,56 @@
+import { CommandTree } from "../types/command.cjs";
+import * as _alloy_js_core0 from "@alloy-js/core";
+import { MarkdownFileProps } from "@powerlines/plugin-alloy/markdown/components/markdown-file";
+
+//#region src/components/docs.d.ts
+interface CommandOptionsDocsProps {
+  /**
+   * The command to generate options documentation for.
+   */
+  command: CommandTree;
+}
+/**
+ * Generates the options markdown documentation for a command.
+ */
+declare function CommandOptionsDocs(props: CommandOptionsDocsProps): _alloy_js_core0.Children;
+interface CommandDocsProps {
+  /**
+   * The heading level offset to apply to the generated documentation.
+   *
+   * @remarks
+   * This is useful when nesting the documentation within other markdown files.
+   *
+   * @defaultValue 0
+   */
+  levelOffset?: number;
+  /**
+   * The command to generate options documentation for.
+   */
+  command: CommandTree;
+}
+/**
+ * Generates the markdown documentation for a command.
+ */
+declare function CommandDocs(props: CommandDocsProps): _alloy_js_core0.Children;
+interface CommandDocsFileProps extends Partial<MarkdownFileProps> {
+  /**
+   * The heading level offset to apply to the generated documentation.
+   *
+   * @remarks
+   * This is useful when nesting the documentation within other markdown files.
+   *
+   * @defaultValue 0
+   */
+  levelOffset?: number;
+  /**
+   * The command to generate documentation for.
+   */
+  command: CommandTree;
+}
+/**
+ * Generates the markdown documentation file for a command.
+ */
+declare function CommandDocsFile(props: CommandDocsFileProps): _alloy_js_core0.Children;
+//#endregion
+export { CommandDocs, CommandDocsFile, CommandDocsFileProps, CommandDocsProps, CommandOptionsDocs, CommandOptionsDocsProps };
+//# sourceMappingURL=docs.d.cts.map

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

@@ -0,0 +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"}