create-storm-workspace 1.60.3 → 1.61.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 1.61.0 (2024-04-13)
+
+
+### 🚀 Features
+
+- **config-tools:** No longer require `config` in storm console write functions ([ad8c6511](https://github.com/storm-software/storm-ops/commit/ad8c6511))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
+## 1.60.4 (2024-04-08)
+
+
+### 🩹 Fixes
+
+- **build-tools:** Resolved issue with module types used in build ([50a368d3](https://github.com/storm-software/storm-ops/commit/50a368d3))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
 ## 1.60.3 (2024-04-08)
 
 

package/README.md

@@ -3,11 +3,13 @@
 <!-- markdownlint-disable -->
 
 
-<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" altText="Storm Software" /></div>
+<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/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://stormsoftware.com/contact" target="_blank">Contact</a>  |  <a href="https://github.com/storm-software/storm-ops" target="_blank">Repository</a>  |  <a href="https://stormstack.github.io/stormstack/" target="_blank">Documentation</a>  |  <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=documentation&template=documentation.yml&title=Documentation Request%3A+">Request Documentation</a> | <a href="https://github.com/storm-software/storm-ops/discussions">Ask a Question</a>
+</b>
 </div>
 
 <br />
@@ -16,7 +18,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <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.60.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.60.4-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)
 
 > [!IMPORTANT]
@@ -84,6 +86,9 @@ Run `nx test create-storm-workspace` to execute the unit tests via [Jest](https:
 
 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/storm-ops/issues) for a list of proposed features (and known issues).
@@ -92,6 +97,9 @@ See the [open issues](https://github.com/storm-software/storm-ops/issues) for a
 - [Top Bugs](https://github.com/storm-software/storm-ops/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/storm-ops/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:
@@ -100,16 +108,25 @@ Reach out to the maintainer at one of the following places:
 - [GitHub discussions](https://github.com/storm-software/storm-ops/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**.
@@ -125,6 +142,9 @@ Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
 
 You can use [markdownlint-cli](https://github.com/storm-software/storm-ops/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)):
@@ -142,7 +162,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <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">
+        <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>
@@ -154,22 +174,38 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 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://pub-e71cff0f90204755bc910518d63cacf8.r2.dev/logo-opengraph.gif" width="100%"/>
+<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" alt="Storm Software" />
 </div>
 <br />
 
 <div align="center">
-<a href="https://www.patsullivan.org" target="_blank">Website</a>  |  <a href="https://www.patsullivan.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>
+<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">
-<p><b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D</p>
+<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.
 
-<h3 align="center">💻 Visit <a href="https://www.patsullivan.org" target="_blank">patsullivan.org</a> to stay up to date with this developer</h3><br /><br />
+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!
+
+<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 />
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
 
 
 <!-- markdownlint-restore -->

package/bin/index.ts

@@ -1,17 +1,23 @@
 #!/usr/bin/env node
 
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 import { getNpmPackageVersion } from "@nx/workspace/src/generators/utils/get-npm-package-version";
-import type { NxClientMode, PresetGeneratorSchema } from "@storm-software/workspace-tools";
+import type {
+  NxClientMode,
+  PresetGeneratorSchema
+} from "@storm-software/workspace-tools";
 import { createWorkspace } from "create-nx-workspace";
 import { prompt } from "enquirer";
 
 async function main() {
+  const { getStopwatch, writeFatal, writeInfo, writeSuccess, loadStormConfig } =
+    await import("@storm-software/config-tools");
+
+  const stopwatch = getStopwatch("create-storm-workspace");
+  const config = await loadStormConfig();
   try {
-    console.log("⚡ Collecting required info to creating a Storm Workspace");
+    writeInfo("⚡ Preparing to create the Storm Workspace", config);
 
-    ["SIGTERM", "SIGINT", "SIGUSR2"].map((type) => {
+    ["SIGTERM", "SIGINT", "SIGUSR2"].map(type => {
       process.once(type, () => {
         try {
           console.info(`process.on ${type}`);
@@ -57,7 +63,10 @@ async function main() {
       namespace = response.namespace;
     }
 
-    let includeApps = process.argv.length > 5 && process.argv[5] ? Boolean(process.argv[5]) : null;
+    let includeApps =
+      process.argv.length > 5 && process.argv[5]
+        ? Boolean(process.argv[5])
+        : null;
     if (!includeApps && typeof includeApps !== "boolean") {
       const response = await prompt<{ includeApps: boolean }>({
         type: "confirm",
@@ -69,7 +78,22 @@ async function main() {
       includeApps = response.includeApps;
     }
 
-    let description = process.argv.length > 6 ? process.argv[6] : null;
+    let includeRust =
+      process.argv.length > 6 && process.argv[6]
+        ? Boolean(process.argv[6])
+        : null;
+    if (!includeRust && typeof includeRust !== "boolean") {
+      const response = await prompt<{ includeRust: boolean }>({
+        type: "confirm",
+        name: "includeRust",
+        message:
+          "Should Rust be included in the workspace (adds a `rust` folder with a `Cargo.toml` file)?",
+        initial: false
+      });
+      includeRust = response.includeRust;
+    }
+
+    let description = process.argv.length > 7 ? process.argv[7] : null;
     if (!description) {
       const response = await prompt<{ description: string }>({
         type: "input",
@@ -83,7 +107,7 @@ async function main() {
       description = response.description;
     }
 
-    let repositoryUrl = process.argv.length > 7 ? process.argv[7] : null;
+    let repositoryUrl = process.argv.length > 8 ? process.argv[8] : null;
     if (!repositoryUrl) {
       const response = await prompt<{ repositoryUrl: string }>({
         type: "input",
@@ -94,7 +118,10 @@ async function main() {
       repositoryUrl = response.repositoryUrl;
     }
 
-    let nxCloud = process.argv.length > 8 && process.argv[8] ? Boolean(process.argv[8]) : null;
+    let nxCloud =
+      process.argv.length > 9 && process.argv[9]
+        ? Boolean(process.argv[9])
+        : null;
     if (!nxCloud && typeof nxCloud !== "boolean") {
       const response = await prompt<{ nxCloud: boolean }>({
         type: "confirm",
@@ -106,7 +133,9 @@ async function main() {
       nxCloud = response.nxCloud;
     }
 
-    let mode: NxClientMode = (process.argv.length > 9 ? process.argv[9] : null) as NxClientMode;
+    let mode: NxClientMode = (
+      process.argv.length > 9 ? process.argv[9] : null
+    ) as NxClientMode;
     if (!mode) {
       mode = (
         await prompt<{ mode: "light" | "dark" }>({
@@ -122,32 +151,38 @@ async function main() {
       ).mode;
     }
 
-    console.log(`⚡ Creating the Storm Workspace: ${name}`);
+    writeInfo(`⚡ Creating the Storm Workspace: ${name}`, config);
 
     const version = getNpmPackageVersion("@storm-software/workspace-tools");
-    const { directory } = await createWorkspace<PresetGeneratorSchema & { interactive: boolean }>(
-      `@storm-software/workspace-tools@${version ? version : "latest"}`,
-      {
-        name,
-        organization,
-        namespace,
-        description,
-        includeApps,
-        repositoryUrl,
-        nxCloud: "skip",
-        packageManager: "pnpm",
-        mode: "dark",
-        interactive: false
-      }
-    );
+    const { directory } = await createWorkspace<
+      PresetGeneratorSchema & { interactive: boolean }
+    >(`@storm-software/workspace-tools@${version ? version : "latest"}`, {
+      name,
+      organization,
+      namespace,
+      description,
+      includeApps,
+      includeRust,
+      repositoryUrl,
+      nxCloud: "skip",
+      packageManager: "pnpm",
+      mode: "dark",
+      interactive: false
+    });
 
-    console.log(`⚡ Successfully created the workspace: ${directory}.`);
+    writeSuccess(
+      `⚡ Successfully created the workspace: ${directory}.`,
+      config
+    );
   } catch (error) {
-    console.log(
-      "❌ An error occurred while creating the workspace. Please correct the below issue:"
+    writeFatal(
+      "❌ An error occurred while creating the workspace. Please correct the below issue:",
+      config
     );
     console.error(error);
     process.exit(1);
+  } finally {
+    stopwatch();
   }
 }