@storm-software/workspace-tools 1.62.18 → 1.62.20

package/src/generators/preset/files/README.md.template

@@ -0,0 +1,273 @@
+<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" alt="Storm Software" /></div>
+
+<br />
+<div align="center">
+<a href="https://stormsoftware.org" target="_blank">Website</a>  |  <a href="https://stormsoftware.org/contact" target="_blank">Contact</a>  |  <a href="https://github.com/<%= namespace %>/<%= name %>" target="_blank">Repository</a>  |  <a href="https://github.com/<%= namespace %>/<%= name %>/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/<%= namespace %>/<%= name %>/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/<%= namespace %>/<%= name %>/issues/new?assignees=&labels=documentation&template=documentation.yml&title=Documentation Request%3A+">Request Documentation</a> | <a href="https://github.com/<%= namespace %>/<%= name %>/discussions">Ask a Question</a>
+</div>
+
+<br />
+<h1><%= name %></h1>
+<%= description %>
+<br /><br />
+⚡<b>Storm Workspaces</b> 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.
+
+<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
+
+[![github](https://img.shields.io/github/package-json/v/<%= namespace %>/<%= name %>?style=for-the-badge&color=1fb2a6)](https://github.com/<%= namespace %>/<%= name %>)&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 docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/<%= namespace %>/<%= name %>/build-release.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+
+<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ 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 availible 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.</h3><br />
+
+<!--#if GitHubActions-->
+
+[![GitHub Actions Build History](https://buildstats.info/github/chart/<%= namespace %>/<%= name %>?branch=main&includeBuildsFromPullRequest=false)](https://github.com/<%= namespace %>/<%= name %>/actions)
+
+<!--#endif-->
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+## Table of Contents
+
+- [Quick Features](#quick-features)
+  - [Tech Stack](#tech-stack)
+- [Getting Started](#getting-started)
+  - [Build](#build)
+  - [Development Server](#development-server)
+- [Acidic - Model-Driven Development](#acidic---model-driven-development)
+  - [Visual Studio Code Extension](#visual-studio-code-extension)
+- [Environment Configuration Help](#environment-configuration-help)
+  - [Plug-Ins](#plug-ins)
+  - [Generate an Application](#generate-an-application)
+  - [Generate a Library](#generate-a-library)
+  - [Code Scaffolding](#code-scaffolding)
+- [Testing](#testing)
+  - [Running Unit Tests](#running-unit-tests)
+  - [Running End-to-End Tests](#running-end-to-end-tests)
+  - [Understand your workspace](#understand-your-workspace)
+- [☁ Nx Cloud](#-nx-cloud)
+  - [Distributed Computation Caching \& Distributed Task Execution](#distributed-computation-caching--distributed-task-execution)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [Support](#support)
+- [License](#license)
+- [Contributors ✨](#contributors-)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+<br />
+
+# Quick Features
+
+The following are some of the features/publishable code that are included in this repository:
+
+- Transport/protocol/backend agnostic data fetching (REST, GraphQL, promises, whatever!)
+- Auto Caching + Refetching (stale-while-revalidate, Window Refocus, Polling/Realtime)
+- Parallel + Dependent Queries
+- Mutations + Reactive Query Refetching
+- Multi-layer Cache + Automatic Garbage Collection
+- Paginated + Cursor-based Queries
+- Load-More + Infinite Scroll Queries w/ Scroll Recovery
+- Request Cancellation
+- React Suspense + Fetch-As-You-Render Query Prefetching
+- Dedicated Devtools
+
+## Tech Stack
+
+<div>
+<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="TypeScript" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/codecov/codecov-plain.svg" alt="Codecov" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/apachekafka/apachekafka-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/amazonwebservices/amazonwebservices-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/css3/css3-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/github/github-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/canva/canva-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/electron/electron-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/docker/docker-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/eslint/eslint-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/figma/figma-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/graphql/graphql-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/jira/jira-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/markdown/markdown-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/mongodb/mongodb-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/mysql/mysql-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nextjs/nextjs-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/postgresql/postgresql-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/storybook/storybook-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/redis/redis-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/prometheus/prometheus-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/sqlite/sqlite-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/react/react-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/tailwindcss/tailwindcss-plain.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/threejs/threejs-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/vscode/vscode-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/android/android-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/apple/apple-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/bash/bash-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/blender/blender-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/jamstack/jamstack-original.svg" alt="Kafka" width="40" height="40"/>&nbsp;<img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/npm/npm-original-wordmark.svg" alt="Kafka" width="40" height="40"/>&nbsp;
+</div>
+
+**Note:** The above list of technologies is far from exhaustive. It is just meant to serve as a short list of _some_ of the technologies that are used in this repository.
+<br /><br />
+
+# Getting Started
+
+Once the code is pulled locally, open a command prompt and run `pnpm install` in the root repo directory (/storm-ops).
+
+More information can be found in the [Open System documentation](https://storm-software.github.io/storm-ops/docs/getting-started/installation).
+
+## Build
+
+Run `pnpm build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+
+## Development Server
+
+Run `pnpm serve` for a dev server. Navigate to <http://localhost:4200/>. The app will automatically reload if you change any of the source files.
+<br /><br />
+
+# Acidic - Model-Driven Development
+
+In StormStack, ⚡ _acidic_ refers to a collection of applications and libraries that are used to build server-side code from a user-defined model. This functionality all lives in the Storm monorepo's `tools` directory (/tools/acidic).
+
+<div align="center"><img src="https://pub-e71cff0f90204755bc910518d63cacf8.r2.dev/storm-generate.bg.png" width="800px" /></div>
+<br />
+
+More information can be found in the [📓 Documentation](https://acidicjs.com/docs).
+<br /><br />
+
+## Visual Studio Code Extension
+
+Acidic has it's own Visual Studio Code extension to support the language model in the IDE. The extension can be found in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=storm-software.acidic).
+
+# Environment Configuration Help
+
+If you run into any issues while trying to run any of the above steps, please reach out to Patrick Sullivan. See the [Support](#support) section for more information.
+
+## Plug-Ins
+
+Some of the plug-ins used by this repository are:
+
+- [@nx/next](https://nx.dev/packages/next)
+- [@nx/react](https://nx.dev/packages/react)
+- [@nx/lint](https://nx.dev/linter/overview)
+- [@nx/js](https://nx.dev/js/overview)
+- [@nx/node](https://nodejs.org)
+- [@nx/web](https://nx.dev/web/overview)
+- [@nx/storybook](https://nx.dev/storybook/overview-react)
+- [@nx/cypress](https://nx.dev/packages/cypress)
+- [@nx/jest](https://nx.dev/packages/jest)
+- And more...
+
+## Generate an Application
+
+Run `nx g @storm-software/workspace:app my-app` to generate an application.
+
+> You can use any of the plugins above to generate applications as well.
+
+When using Nx, you can create multiple applications and libraries in the same workspace.
+
+## Generate a Library
+
+Run `nx g @storm-software/workspace:lib my-lib` to generate a library.
+
+> You can also use any of the plugins above to generate libraries as well.
+
+Libraries are shareable across libraries and applications. They can be imported from `@storm-ops/my-lib`.
+
+## Code Scaffolding
+
+Run `nx g @nx/react:component my-component --project=storm-ops` to generate a new component.
+<br /><br />
+
+# Testing
+
+Open System uses [Jest](https://jestjs.io/) for unit testing and [Cypress](https://www.cypress.io/) for end-to-end testing.
+
+## Running Unit Tests
+
+Run `pnpm test` to execute the unit tests via [Jest](https://jestjs.io).
+
+Run `pnpm affected:test` to execute the unit tests affected by a change.
+
+## Running End-to-End Tests
+
+Run `pnpm e2e` to execute the end-to-end tests via [Cypress](https://www.cypress.io).
+
+Run `pnpm affected:e2e` to execute the end-to-end tests affected by a change.
+
+## Understand your workspace
+
+Run `pnpm graph` to see a diagram of the dependencies of the Open System projects.
+<br /><br />
+
+# ☁ Nx Cloud
+
+Nx caches the output of any previously run command such as testing and building, so it can replay the cached results instead of rerunning it. Nx Cloud allows you to share the computation cache across everyone in your team and CI.
+
+<p align="center"><img src="https://pub-4661138852db4e5da99a6660fbf9b633.r2.dev/Nx Cloud - Dashboard.png" width="100%" alt="Nx Cloud - Dashboard" /></p>
+
+## Distributed Computation Caching & Distributed Task Execution
+
+Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.
+
+Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.
+
+Visit [Nx Cloud](https://nx.app/) to learn more.
+<br /><br />
+
+# Roadmap
+
+See the [open issues](https://github.com/<%= namespace %>/<%= name %>/issues) for a list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/<%= namespace %>/<%= name %>/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/<%= namespace %>/<%= name %>/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Newest Bugs](https://github.com/<%= namespace %>/<%= name %>/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+  <br /><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/<%= namespace %>/<%= name %>/markdownlint-cli) to check for common markdown style inconsistency.
+<br /><br />
+
+# Support
+
+Reach out to the maintainer at one of the following places:
+
+- [Contact](https://stormsoftware.org/contact)
+- [GitHub discussions](https://github.com/<%= namespace %>/<%= name %>/discussions)
+- <contact@stormsoftware.org>
+
+# License
+
+This project is licensed under the **Apache License 2.0**. Feel free to edit and distribute this template as you like. If you have any specific questions, please reach out to the Storm Software development team.
+
+See [LICENSE](LICENSE) for more information.
+
+# 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 -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<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/<%= namespace %>/<%= name %>/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/<%= namespace %>/<%= name %>/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/<%= namespace %>/<%= name %>/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.org"><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">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+<h1 align="center"></h1>
+<br />
+<div align="center">
+  <img src="https://pub-e71cff0f90204755bc910518d63cacf8.r2.dev/logo-opengraph.gif" width="100%" alt="Storm Software" />
+</div>
+<div align="center">
+<a href="https://stormsoftware.org" target="_blank">Website</a>  |  <a href="https://stormsoftware.org/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/sullivanpj" target="_blank">GitHub</a>  |  <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
+</div>
+
+<div align="center">
+<p><b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D</p>
+</div>
+
+<h2 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h2><br /><br />

package/src/generators/preset/files/biome.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.5.1/schema.json",
+  "extends": ["./node_modules/@storm-software/linting-tools/biome/biome.json"]
+}

package/src/generators/preset/files/docs/readme-templates/README.footer.md.template

@@ -0,0 +1,94 @@
+## 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.
+
+## Roadmap
+
+See the [open issues](https://github.com/<%= organization %>/<%= name %>/issues) for a list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/<%= organization %>/<%= name %>/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/<%= organization %>/<%= name %>/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Newest Bugs](https://github.com/<%= organization %>/<%= name %>/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+
+## Support
+
+Reach out to the maintainer at one of the following places:
+
+- [Contact](https://stormsoftware.org/contact)
+- [GitHub discussions](https://github.com/<%= organization %>/<%= name %>/discussions)
+- <support@stormsoftware.org>
+
+## 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.
+
+## 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
+
+## 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/<%= organization %>/<%= name %>/markdownlint-cli) to check for common markdown style inconsistency.
+
+## 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/storm-ops/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-ops/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.org"><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">
+          <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!
+
+<br />
+<br />
+<div align="center">
+<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="Storm Software" />
+</div>
+<br />
+
+<div align="center">
+<a href="https://stormsoftware.org" target="_blank">Website</a>  |  <a href="https://stormsoftware.org/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">
+<p><b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D</p>
+</div>
+
+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 languagues.
+
+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!
+
+<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br /><br />

package/src/generators/preset/files/docs/readme-templates/README.header.md.template

@@ -0,0 +1,17 @@
+<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="Storm Software" /></div>
+
+<br />
+<div align="center">
+<a href="https://stormsoftware.org" target="_blank">Website</a>  |  <a href="https://stormsoftware.org/contact" target="_blank">Contact</a>  |  <a href="https://github.com/<%= organization %>/<%= name %>" target="_blank">Repository</a>  |  <a href="https://stormstack.github.io/stormstack/" target="_blank">Documentation</a>  |  <a href="https://github.com/<%= organization %>/<%= name %>/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/<%= organization %>/<%= name %>/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/<%= organization %>/<%= name %>/issues/new?assignees=&labels=documentation&template=documentation.yml&title=Documentation Request%3A+">Request Documentation</a> | <a href="https://github.com/<%= organization %>/<%= name %>/discussions">Ask a Question</a>
+</div>
+
+<br />
+This package is part of the <b>⚡<%= name %></b> monorepo. The <%= name %> 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.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
+
+[![Version](https://img.shields.io/badge/version-<!-- VERSION -->-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 docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+
+<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ 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 availible 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.</h3><br />

package/src/generators/preset/files/lefthook.json

@@ -0,0 +1,6 @@
+{
+  "remote": {
+    "git_url": "git@github.com:storm-software/storm-ops",
+    "config": "packages/git-tools/src/lefthook/lefthook.yml"
+  }
+}

package/src/generators/preset/files/nx.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@storm-software/workspace-tools/config/nx.json"
+}

package/src/generators/preset/files/pnpm-workspace.yaml

@@ -0,0 +1,6 @@
+packages:
+  - "tools/**"
+  - "packages/**"
+  - "libs/**"
+  - "apps/**"
+  - "docs/**"

package/src/generators/preset/files/socket.yaml

@@ -0,0 +1,20 @@
+# top level version field is required
+version: 2
+
+triggerPaths:
+  - "packages/*/package.json"
+  - "package.json"
+  - "pnpm-lock.yaml"
+  - "pnpm-workspace.yaml"
+  - "apps/*/package.json"
+  - "libs/*/package.json"
+
+projectIgnorePaths:
+  - ".github/"
+  - ".vscode/"
+  - ".verdaccio/"
+  - ".nx/"
+  - "benchmarks/"
+  - "docs/"
+  - "examples/"
+  - "test/"

package/src/generators/preset/files/tsconfig.base.json.template

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": "@storm-software/linting-tools/tsconfig/tsconfig.root.json",
+    "display": "Storm Software - <%= name %>",
+    "compilerOptions": {
+        "rootDir": ".",
+        "baseUrl": ".",
+        "paths": {}
+    },
+    "references": []
+}

package/src/generators/preset/schema.d.ts

@@ -0,0 +1,14 @@
+export type NxClientMode = "light" | "dark";
+export type PackageManager = "npm" | "yarn" | "pnpm";
+
+export interface PresetGeneratorSchema {
+  name: string;
+  organization: string;
+  includeApps: boolean;
+  namespace?: string;
+  description?: string;
+  repositoryUrl?: string;
+  nxCloud: "skip";
+  mode: NxClientMode;
+  packageManager: PackageManager;
+}

package/src/generators/preset/schema.json

@@ -0,0 +1,103 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "preset",
+  "title": "Workspace Preset",
+  "description": "Create a Storm workspace with all of the required files and recommended packages installed.",
+  "type": "object",
+  "example": [
+    {
+      "command": "nx g @storm-software/workspace-tools:preset --name 'example-repo'",
+      "description": "Generate a storm workspace with: \n- name: example-repo \n- namespace: storm-software \n- organization: storm-software \n- repositoryUrl: <https://github.com/storm-software/example-repo>"
+    },
+
+    {
+      "command": "nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example'",
+      "description": "Generate a storm workspace with: \n- name: example-repo \n- namespace: example \n- repositoryUrl: <https://github.com/storm-software/example-repo>"
+    },
+    {
+      "command": "nx g @storm-software/workspace-tools:preset --name 'example-repo' --namespace 'example' --organization 'example-org' --description 'An example workspace'",
+      "description": "Generate a storm workspace with: \n- name: example-repo \n- namespace: example \n- organization: example-org \n- description: An example workspace \n- repositoryUrl: <https://github.com/example-org/example-repo>"
+    }
+  ],
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the workspace root.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use?"
+    },
+    "organization": {
+      "type": "string",
+      "description": "The organization that owns the workspace.",
+      "default": "storm-software",
+      "$default": {
+        "$source": "argv",
+        "index": 1
+      },
+      "x-prompt": "What organization owns this repository?"
+    },
+    "namespace": {
+      "type": "string",
+      "description": "The npm scope used for the workspace. Defaults to the organization name.",
+      "$default": {
+        "$source": "argv",
+        "index": 2
+      },
+      "x-prompt": "What namespace (npm scope) would you like to use? Defaults to the organization name."
+    },
+    "includeApps": {
+      "type": "boolean",
+      "description": "Should a separate `apps` folder be created for this workspace (if Yes: `apps` and `libs` folders will be added, if No: `packages` folders will be added)?",
+      "default": false,
+      "$default": {
+        "$source": "argv",
+        "index": 3
+      },
+      "x-prompt": "Is the workspace a purely package based repository (one large packages folder) or does it include apps (split between apps and libs folders)?"
+    },
+    "description": {
+      "type": "string",
+      "description": "The description of the workspace to use in the package.json and README.md files.",
+      "$default": {
+        "$source": "argv",
+        "index": 4
+      },
+      "x-prompt": "Provide a description of the workspace to use in the package.json and README.md files."
+    },
+    "repositoryUrl": {
+      "type": "string",
+      "description": "The URL of the workspace in GitHub. Defaults to <https://github.com/{organization}/{name}>",
+      "$default": {
+        "$source": "argv",
+        "index": 5
+      },
+      "x-prompt": "What is the workspace's GitHub repository URL?"
+    },
+    "nxCloud": {
+      "type": "boolean",
+      "description": "Should distributed caching with Nx Cloud be enabled for the workspace?",
+      "default": false,
+      "x-prompt": "Should distributed caching with Nx Cloud be enabled for the workspace?",
+      "hidden": true
+    },
+    "mode": {
+      "type": "string",
+      "description": "Which client mode should be used for the Nx Task Runner?",
+      "default": "dark",
+      "enum": ["light", "dark"],
+      "x-prompt": "Which client mode should be used for the Nx Task Runner?"
+    },
+    "packageManager": {
+      "type": "string",
+      "description": "What package manager is used for the workspace?",
+      "enum": ["npm", "yarn", "pnpm"],
+      "default": "pnpm",
+      "x-prompt": "What package manager is used for the workspace?",
+      "hidden": true
+    }
+  },
+  "required": ["name", "organization", "includeApps", "mode"]
+}

package/src/generators/release-version/schema.d.ts

@@ -0,0 +1,3 @@
+import type { ReleaseVersionGeneratorSchema as NxReleaseVersionGeneratorSchema } from "nx/src/command-line/release/version.js";
+
+export interface ReleaseVersionGeneratorSchema extends NxReleaseVersionGeneratorSchema {}