@storm-software/git-tools 1.10.0 → 1.10.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.10.0](https://github.com/storm-software/storm-ops/compare/git-tools-v1.9.5...git-tools-v1.10.0) (2023-11-29)
+
+
+### Features
+
+* **git-tools:** Added executors and generators sections to the readme-gen CLI ([99aacba](https://github.com/storm-software/storm-ops/commit/99aacba62747cef1347bc87a0fff35fb2ffb0bde))
+
 ## [1.9.5](https://github.com/storm-software/storm-ops/compare/git-tools-v1.9.4...git-tools-v1.9.5) (2023-11-29)
 
 

package/README.md

@@ -3,7 +3,8 @@
 <!-- markdownlint-disable -->
 
 
-<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="Storm Software" /></div>
+<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" 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/storm-software/stormstack" target="_blank">Repository</a>  |  <a href="https://stormstack.github.io/stormstack/" target="_blank">Documentation</a>  |  <a href="https://github.com/storm-software/stormstack/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/storm-software/stormstack/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/storm-software/stormstack/issues/new?assignees=&labels=documentation&template=documentation.yml&title=Documentation Request%3A+">Request Documentation</a> | <a href="https://github.com/storm-software/stormstack/discussions">Ask a Question</a>
@@ -15,10 +16,10 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <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-1.8.21-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.10.0-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 />
+<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 />
 
 
 <!-- markdownlint-restore -->
@@ -131,6 +132,8 @@ This project follows the [all-contributors](https://github.com/all-contributors/
 <div align="center">
   <img src="https://pub-e71cff0f90204755bc910518d63cacf8.r2.dev/logo-opengraph.gif" width="100%"/>
 </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>
 </div>

package/cli/index.js

@@ -194022,7 +194022,10 @@ var getExecutorMarkdown = (packageName, executorsJsonFile, executorsJson) => {
                 result3 += `| \`string\`  `;
               }
               if (schema.description) {
-                result3 += `| ${schema.description}    `;
+                result3 += `| ${schema.description.replaceAll(
+                  "`",
+                  "\\`"
+                )}    `;
               } else {
                 result3 += `|    `;
               }
@@ -194031,7 +194034,8 @@ var getExecutorMarkdown = (packageName, executorsJsonFile, executorsJson) => {
               } else {
                 result3 += `|    `;
               }
-              result3 += "|\n";
+              result3 += ` | 
+`;
             }
             return result3;
           }).join();
@@ -194050,7 +194054,7 @@ var getExecutorMarkdown = (packageName, executorsJsonFile, executorsJson) => {
 `;
     }
     if (!description && executor.description) {
-      description = `${executor.description}
+      description = `${executor.description.replaceAll("`", "\\`")}
 
 `;
     }
@@ -194102,8 +194106,8 @@ var getGeneratorMarkdown = (packageName, generatorsJsonFile, generatorsJson) =>
         if (schemaJson.properties && Object.keys(schemaJson.properties).length > 0) {
           const required2 = schemaJson.required && Array.isArray(schemaJson.required) ? schemaJson.required : [];
           result2 += "### Options\n\nThe following executor options are available:\n\n";
-          result2 += "| Option    | Type   | Description   | Default   |";
-          result2 += "| --------- | ------ | ------------- | --------- |";
+          result2 += "| Option    | Type   | Description   | Default   | \n";
+          result2 += "| --------- | ------ | ------------- | --------- | \n";
           result2 += Object.entries(schemaJson.properties).map(([name2, schema]) => {
             let resultSchema = "";
             if (name2) {
@@ -194122,7 +194126,10 @@ var getGeneratorMarkdown = (packageName, generatorsJsonFile, generatorsJson) =>
                 resultSchema += `| \`string\`  `;
               }
               if (schema.description) {
-                resultSchema += `| ${schema.description}    `;
+                resultSchema += `| ${schema.description.replaceAll(
+                  "`",
+                  "\\`"
+                )}    `;
               } else {
                 resultSchema += `|    `;
               }
@@ -194131,7 +194138,8 @@ var getGeneratorMarkdown = (packageName, generatorsJsonFile, generatorsJson) =>
               } else {
                 resultSchema += `|    `;
               }
-              resultSchema += "|\n";
+              resultSchema += ` | 
+`;
             }
             return resultSchema;
           }).join();
@@ -194152,7 +194160,10 @@ This generator can be used by executing the following examples in a command line
             example += schemaJson.example.map((exampleCmd) => {
               let resultCmd = "";
               if (exampleCmd.description && typeof exampleCmd.description === "string") {
-                resultCmd += `#### ${exampleCmd.description}
+                resultCmd += `#### ${exampleCmd.description.replaceAll(
+                  "`",
+                  "\\`"
+                )}
 
 `;
               }
@@ -194175,7 +194186,10 @@ ${exampleCmd}
             if (schemaJson.example.description && typeof schemaJson.example.description === "string") {
               example = `### Example 
 
-${schemaJson.example.description} 
+${schemaJson.example.description.replaceAll(
+                "`",
+                "\\`"
+              )} 
 
 `;
             } else {
@@ -194225,7 +194239,7 @@ nx g ${packageName}:${name}
 `;
     }
     if (!description && generator.description) {
-      description = `${generator.description}
+      description = `${generator.description.replaceAll("`", "\\`")}
 
 `;
     }