@powerlines/nx 0.1.0

package/README.md

@@ -0,0 +1,490 @@
+<!-- START header -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+<div align="center"><img src="https://public.storm-cdn.com/storm-banner.gif" width="100%" alt="Storm Software" /></div>
+<br />
+
+<div align="center">
+<b>
+<a href="https://stormsoftware.com" target="_blank">Website</a>  •
+<a href="https://github.com/storm-software/powerlines" 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/powerlines/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>Powerlines</b> monorepo. Powerlines 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-1.2.3-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&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;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/powerlines/cr.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/powerlines" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b></div>
+
+<br />
+
+# Powerlines - Nx Plugin
+
+A package containing tools for managing a Storm workspace. It includes various
+[Nx](https://nx.dev) generators and executors for common development tasks.
+
+<!-- START doctoc -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Installing](#installing)
+- [Executors](#executors)
+- [Powerlines Clean Executor](#powerlines-clean-executor)
+  - [Example](#example)
+  - [Options](#options)
+- [Powerlines Prepare Executor](#powerlines-prepare-executor)
+  - [Example](#example-1)
+  - [Options](#options-1)
+- [Powerlines Lint Executor](#powerlines-lint-executor)
+  - [Example](#example-2)
+  - [Options](#options-2)
+- [Powerlines Build Executor](#powerlines-build-executor)
+  - [Example](#example-3)
+  - [Options](#options-3)
+- [Powerlines Docs Executor](#powerlines-docs-executor)
+  - [Example](#example-4)
+  - [Options](#options-4)
+- [Generators](#generators)
+- [Powerlines Sync Generator](#powerlines-sync-generator)
+  - [Options](#options-5)
+- [Building](#building)
+- [Running unit tests](#running-unit-tests)
+- [Storm Workspaces](#storm-workspaces)
+- [Roadmap](#roadmap)
+- [Support](#support)
+- [License](#license)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+- [Contributors](#contributors)
+
+<!-- END doctoc -->
+
+<br />
+
+This library was generated with [Nx](https://nx.dev).
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D @powerlines/devkit-nx
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D @powerlines/devkit-nx
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D @powerlines/devkit-nx
+```
+
+</details>
+
+## Executors
+
+The following executors are available in this package to invoke common tasks for
+the workspace's projects:
+
+<!-- START executors -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Powerlines Clean Executor
+
+A type definition for the Powerlines - Clean executor schema
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:clean
+```
+
+**Please note:** _The clean executor should be included in the desired projects's `project.json` file._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| outputPath      | `string`    | The output path for the build     | "dist/{projectRoot}"     | 
+ | tsconfig      | `string`    | The path to the tsconfig file     | "{projectRoot}/tsconfig.json"     | 
+ | mode      | "development" \| "test" \| "production"     | The build mode     |     | 
+ | skipInstalls      | `boolean`    | Skip installing dependencies during prepare stage     |     | 
+ | logLevel      | "error" \| "success" \| "silent" \| "fatal" \| "warn" \| "info" \| "debug" \| "trace" \| "all"     | The log level to use for the build process     |     | 
+
+
+
+
+## Powerlines Prepare Executor
+
+A type definition for the Powerlines - Prepare executor schema
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:prepare
+```
+
+**Please note:** _The prepare executor should be included in the desired projects's `project.json` file._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| outputPath      | `string`    | The output path for the build     | "dist/{projectRoot}"     | 
+ | tsconfig      | `string`    | The path to the tsconfig file     | "{projectRoot}/tsconfig.json"     | 
+ | mode      | "development" \| "test" \| "production"     | The build mode     |     | 
+ | skipInstalls      | `boolean`    | Skip installing dependencies during prepare stage     |     | 
+ | logLevel      | "error" \| "success" \| "silent" \| "fatal" \| "warn" \| "info" \| "debug" \| "trace" \| "all"     | The log level to use for the build process     |     | 
+ | skipCache      | `boolean`    | Skip the cache when building     |     | 
+ | clean      | `boolean`    | Automatically clean the project's output artifacts (if required)     |     | 
+
+
+
+
+## Powerlines Lint Executor
+
+A type definition for the Powerlines - Lint executor schema
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:lint
+```
+
+**Please note:** _The lint executor should be included in the desired projects's `project.json` file._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| outputPath      | `string`    | The output path for the build     | "dist/{projectRoot}"     | 
+ | tsconfig      | `string`    | The path to the tsconfig file     | "{projectRoot}/tsconfig.json"     | 
+ | mode      | "development" \| "test" \| "production"     | The build mode     |     | 
+ | skipInstalls      | `boolean`    | Skip installing dependencies during prepare stage     |     | 
+ | logLevel      | "error" \| "success" \| "silent" \| "fatal" \| "warn" \| "info" \| "debug" \| "trace" \| "all"     | The log level to use for the build process     |     | 
+ | skipCache      | `boolean`    | Skip the cache when building     |     | 
+ | clean      | `boolean`    | Automatically clean the project's output artifacts (if required)     |     | 
+
+
+
+
+## Powerlines Build Executor
+
+A type definition for the Powerlines - Build executor schema
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:build
+```
+
+**Please note:** _The build executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| outputPath      | `string`    | The output path for the build     | "dist/{projectRoot}"     | 
+ | tsconfig      | `string`    | The path to the tsconfig file     | "{projectRoot}/tsconfig.json"     | 
+ | mode      | "development" \| "test" \| "production"     | The build mode     |     | 
+ | skipInstalls      | `boolean`    | Skip installing dependencies during prepare stage     |     | 
+ | logLevel      | "error" \| "success" \| "silent" \| "fatal" \| "warn" \| "info" \| "debug" \| "trace" \| "all"     | The log level to use for the build process     |     | 
+ | skipCache      | `boolean`    | Skip the cache when building     |     | 
+ | clean      | `boolean`    | Automatically clean the project's output artifacts (if required)     |     | 
+ | **entry \***    | `string`    | The entry file or files to build     | "{sourceRoot}/index.ts"     | 
+ | skipLint      | `boolean`    | Skip the linting process ran prior to the build (if required)     |     | 
+
+
+**Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ 
+
+
+
+## Powerlines Docs Executor
+
+A type definition for the Powerlines - Docs executor schema
+
+### Example 
+
+This executor can be used by executing the following in a command line utility: 
+
+```cmd 
+nx run my-project:docs
+```
+
+**Please note:** _The docs executor should be included in the desired projects's `project.json` file._ 
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| outputPath      | `string`    | The output path for the build     | "dist/{projectRoot}"     | 
+ | tsconfig      | `string`    | The path to the tsconfig file     | "{projectRoot}/tsconfig.json"     | 
+ | mode      | "development" \| "test" \| "production"     | The build mode     |     | 
+ | skipInstalls      | `boolean`    | Skip installing dependencies during prepare stage     |     | 
+ | logLevel      | "error" \| "success" \| "silent" \| "fatal" \| "warn" \| "info" \| "debug" \| "trace" \| "all"     | The log level to use for the build process     |     | 
+ | skipCache      | `boolean`    | Skip the cache when building     |     | 
+ | clean      | `boolean`    | Automatically clean the project's output artifacts (if required)     |     | 
+
+
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END executors -->
+
+## Generators
+
+The following generators are available with this package to assist in workspace
+management:
+
+<!-- START generators -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Powerlines Sync Generator
+
+A type definition for the Powerlines - Sync generator's options
+
+### Options
+
+The following executor options are available:
+
+| Option    | Type   | Description   | Default   | 
+| --------- | ------ | ------------- | --------- | 
+| outOfSyncMessage      | `string`    | The message to display when the project is out of sync with the legal-message.txt file     | "The legal-message.txt file needs to be created"     | 
+
+
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END generators -->
+
+## Building
+
+Run `nx build devkit-nx` to build the library.
+
+## Running unit tests
+
+Run `nx test devkit-nx` 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/powerlines/issues) for
+a list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/storm-software/powerlines/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
+  (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/storm-software/powerlines/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/powerlines/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/powerlines/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/powerlines/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/powerlines/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/powerlines/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/powerlines/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">
+<img src="https://public.storm-cdn.com/brand-banner.png" width="100%" alt="Storm Software" />
+</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/chunk-23KFTIT2.mjs

@@ -0,0 +1 @@
+