feat(cli): Added the cli package

storm-software · Dec 9, 2023 · 6312c04 · 6312c04
1 parent ad4b00b
commit 6312c04
Show file tree

Hide file tree

Showing 21 changed files with 796 additions and 4 deletions.
diff --git a/docs/api-reports/packages/file-system/api-report.md b/docs/api-reports/packages/file-system/api-report.md
@@ -131,6 +131,12 @@ const FileSystemErrorCode: {
 export { FileSystemErrorCode };
 export { FileSystemErrorCode as FileSystemErrorCode_alias_1 };
 
+// @public
+function findFileExtension(filePath: string): string;
+export { findFileExtension };
+export { findFileExtension as findFileExtension_alias_1 };
+export { findFileExtension as findFileExtension_alias_2 };
+
 // @public
 function findFileName(filePath: string): string;
 export { findFileName };

diff --git a/docs/api-reports/packages/file-system/documents-model.api.json b/docs/api-reports/packages/file-system/documents-model.api.json
@@ -909,6 +909,51 @@
             "endIndex": 46
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@storm-stack/file-system!findFileExtension:function(1)",
+          "docComment": "/**\n * Find the file extension from a file path.\n *\n * @param filePath - The file path to process\n *\n * @returns The file extension\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function findFileExtension(filePath: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "packages/file-system/src/files/file-path-fns.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "filePath",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "findFileExtension"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@storm-stack/file-system!findFileName:function(1)",

diff --git a/package.json b/package.json
@@ -140,7 +140,8 @@
       "@storm-stack/errors": "workspace:*",
       "@storm-stack/serialization": "workspace:*",
       "@storm-stack/logging": "workspace:*",
-      "@storm-stack/file-system": "workspace:*"
+      "@storm-stack/file-system": "workspace:*",
+      "@storm-stack/cli": "workspace:*"
     }
   },
   "triggerEmptyDevReleaseByIncrementingThisNumber": 0

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -0,0 +1,185 @@
+<!-- START header -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+<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/storm-stack" target="_blank">Repository</a>  |  <a href="https://storm-software.github.io/storm-stack/" target="_blank">Documentation</a>  |  <a href="https://github.com/storm-software/storm-stack/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-stack/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-stack/discussions">Ask a Question</a>
+</div>
+
+<br />
+This package is part of the <b>⚡storm-stack</b> monorepo. The storm-stack 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-0.0.1-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 />
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END header -->
+
+# Command Line Utility Library
+
+A collection of CLI utilities to assist in creating command line applications
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D @storm-stack/cli
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D @storm-stack/cli
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D @storm-stack/cli
+```
+
+</details>
+
+## Reduced Package Size
+
+This project uses [tsup](https://tsup.egoist.dev/) to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.
+
+## Development
+
+This project is built using [Nx](https://nx.dev). As a result, many of the usual commands are available to assist in development.
+
+### Building
+
+Run `nx build cli` to build the library.
+
+### Running unit tests
+
+Run `nx test cli` to execute the unit tests via [Jest](https://jestjs.io).
+
+### Linting
+
+Run `nx lint cli` to run [ESLint](https://eslint.org/) on the package.
+
+<!-- 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.
+
+## Roadmap
+
+See the [open issues](https://github.com/storm-software/storm-stack/issues) for a list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/storm-software/storm-stack/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/storm-software/storm-stack/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-stack/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/storm-software/storm-stack/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/storm-software/storm-stack/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>
+<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 />
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END footer -->
diff --git a/packages/cli/eslint.config.js b/packages/cli/eslint.config.js
@@ -0,0 +1,31 @@
+const { FlatCompat } = require("@eslint/eslintrc");
+const baseConfig = require("../../eslint.config.js");
+const js = require("@eslint/js");
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended
+});
+
+module.exports = [
+  ...baseConfig,
+  {
+    files: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
+    rules: {}
+  },
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    rules: {}
+  },
+  {
+    files: ["**/*.js", "**/*.jsx"],
+    rules: {}
+  },
+  ...compat.config({ parser: "jsonc-eslint-parser" }).map(config => ({
+    ...config,
+    "files": ["packages/cli/**/*.json"],
+    "rules": {
+      "@nx/dependency-checks": "error"
+    }
+  }))
+];
diff --git a/packages/cli/jest.config.ts b/packages/cli/jest.config.ts
@@ -0,0 +1,3 @@
+import { getJestConfig } from "@storm-software/testing-tools";
+
+export default getJestConfig("packages/cli", true, "cli");
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -0,0 +1,22 @@
+{
+  "name": "@storm-stack/cli",
+  "version": "0.0.1",
+  "private": true,
+  "description": "A collection of CLI utilities to assist in creating command line applications.",
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/storm-stack.git",
+    "directory": "packages/cli"
+  },
+  "type": "module",
+  "dependencies": {
+    "@storm-software/config-tools": "latest",
+    "chalk": "^5.3.0",
+    "commander": "^11.1.0",
+    "console-table-printer": "^2.11.2",
+    "ora": "^7.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/packages/cli/project.json b/packages/cli/project.json
@@ -0,0 +1,53 @@
+{
+  "name": "cli",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "packages/cli/src",
+  "targets": {
+    "build": {
+      "executor": "@storm-software/workspace-tools:tsup-node",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "entry": "packages/cli/src/index.ts",
+        "outputPath": "dist/packages/cli",
+        "tsConfig": "packages/cli/tsconfig.json",
+        "project": "packages/cli/package.json",
+        "defaultConfiguration": "production",
+        "assets": [
+          {
+            "input": "packages/cli",
+            "glob": "*.md",
+            "output": "/"
+          },
+          {
+            "input": "",
+            "glob": "LICENSE",
+            "output": "/"
+          }
+        ],
+        "platform": "node"
+      },
+      "configurations": {
+        "production": {
+          "debug": false,
+          "verbose": false
+        },
+        "development": {
+          "debug": true,
+          "verbose": true
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "packages/cli/**/*.ts",
+          "{projectRoot}/package.json"
+        ]
+      }
+    },
+    "test": {}
+  }
+}
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -0,0 +1,13 @@
+/**
+ * The cli library used by Storm Software for building TypeScript applications.
+ *
+ * @remarks
+ * A collection of CLI utilities to assist in creating command line applications
+ *
+ * @packageDocumentation
+ */
+
+export * from "./program";
+export * from "./program/shutdown";
+export * from "./types";
+export * from "./utilities";