@shell-shock/core 0.1.1 → 0.2.1

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.0-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,45 @@
-const e=require(`./_virtual/rolldown_runtime.cjs`),t=require(`./powerlines.cjs`);let n=require(`powerlines`);var r=class e{#e;static async from(r={}){return new e(await(0,n.createPowerlines)({...r,plugins:(r.plugins??[]).concat(t.shellShock())}))}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=r;
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_powerlines = require('./powerlines.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: [...config.plugins ?? [], require_powerlines.shellShock()]
+		}));
+	}
+	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();
+	}
+};
+
+//#endregion
+exports.ShellShockAPI = ShellShockAPI;

package/dist/api.d.cts

@@ -2,6 +2,13 @@ import { UserConfig } from "./types/config.cjs";
 import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines/types/config";
 
 //#region src/api.d.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.
+ */
 declare class ShellShockAPI {
   #private;
   static from(config?: UserConfig): Promise<ShellShockAPI>;

package/dist/api.d.mts

@@ -2,6 +2,13 @@ import { UserConfig } from "./types/config.mjs";
 import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines/types/config";
 
 //#region src/api.d.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.
+ */
 declare class ShellShockAPI {
   #private;
   static from(config?: UserConfig): Promise<ShellShockAPI>;

package/dist/api.mjs

@@ -1 +1,44 @@
-import{shellShock as e}from"./powerlines.mjs";import{createPowerlines as t}from"powerlines";var n=class n{#e;static async from(r={}){return new n(await t({...r,plugins:(r.plugins??[]).concat(e())}))}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{n as ShellShockAPI};
+import { shellShock } from "./powerlines.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: [...config.plugins ?? [], shellShock()]
+		}));
+	}
+	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();
+	}
+};
+
+//#endregion
+export { ShellShockAPI };

package/dist/components/index.cjs

@@ -0,0 +1,7 @@
+const require_components_utils_builtin = require('./utils-builtin.cjs');
+
+exports.ArgsUtilities = require_components_utils_builtin.ArgsUtilities;
+exports.ColorSupportUtilities = require_components_utils_builtin.ColorSupportUtilities;
+exports.EnvSupportUtilities = require_components_utils_builtin.EnvSupportUtilities;
+exports.HyperlinkSupportUtilities = require_components_utils_builtin.HyperlinkSupportUtilities;
+exports.UtilsBuiltin = require_components_utils_builtin.UtilsBuiltin;

package/dist/components/index.d.cts

@@ -0,0 +1,2 @@
+import { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, HyperlinkSupportUtilities, UtilsBuiltin, UtilsBuiltinProps } from "./utils-builtin.cjs";
+export { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, HyperlinkSupportUtilities, UtilsBuiltin, UtilsBuiltinProps };

package/dist/components/index.d.mts

@@ -0,0 +1,2 @@
+import { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, HyperlinkSupportUtilities, UtilsBuiltin, UtilsBuiltinProps } from "./utils-builtin.mjs";
+export { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, HyperlinkSupportUtilities, UtilsBuiltin, UtilsBuiltinProps };

package/dist/components/index.mjs

@@ -0,0 +1,3 @@
+import { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, HyperlinkSupportUtilities, UtilsBuiltin } from "./utils-builtin.mjs";
+
+export { ArgsUtilities, ColorSupportUtilities, EnvSupportUtilities, HyperlinkSupportUtilities, UtilsBuiltin };