@storm-software/workspace-tools
Advanced tools
Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.
[!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 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.
A package containing tools for managing a Storm workspace. It includes various Nx generators and executors for common development tasks.
Using pnpm:
pnpm add -D @storm-software/workspace-tools
npm install -D @storm-software/workspace-tools
yarn add -D @storm-software/workspace-tools
The following executors are available in this package to invoke common tasks for the workspace's projects:
Run the `typia` generator to create runtime type validators
This executor can be used by executing the following in a command line utility:
nx run my-project:typia
Please note: The typia executor should be included in the desired projects's project.json file.
Run the `tsdown` build process on a selected project
This executor can be used by executing the following in a command line utility:
nx run my-project:tsdown
Please note: The tsdown executor should be included in the desired projects's project.json file.
Run the `esbuild` build process on a selected project
This executor can be used by executing the following in a command line utility:
nx run my-project:esbuild
Please note: The esbuild executor should be included in the desired projects's project.json file.
Run the `unbuild` build process on a selected project
This executor can be used by executing the following in a command line utility:
nx run my-project:unbuild
Please note: The unbuild executor should be included in the desired projects's project.json file.
Remove configuration files, fields, and scripts for development before publishing package. The executor will remove these unnecessary files and fields to make the distributable package as light as possible (for scenarios like edge computing, limited memory environments, etc.)
This executor can be used by executing the following in a command line utility:
nx run my-project:clean-package
Please note: The clean-package executor should be included in the desired projects's project.json file.
Run a size-limit performance test on the project
This executor can be used by executing the following in a command line utility:
nx run my-project:size-limit
Please note: The size-limit executor should be included in the desired projects's project.json file.
Publish a package to the NPM registry
This executor can be used by executing the following in a command line utility:
nx run my-project:npm-publish
Please note: The npm-publish executor should be included in the desired projects's project.json file.
Publish a Rust crate to the crates.io registry
This executor can be used by executing the following in a command line utility:
nx run my-project:cargo-publish
Please note: The cargo-publish executor should be included in the desired projects's project.json file.
Build a Rust project with Cargo Build
This executor can be used by executing the following in a command line utility:
nx run my-project:cargo-build
Please note: The cargo-build executor should be included in the desired projects's project.json file.
Check a Rust project with Cargo Check
This executor can be used by executing the following in a command line utility:
nx run my-project:cargo-check
Please note: The cargo-check executor should be included in the desired projects's project.json file.
Format a Rust project with Cargo Fmt
This executor can be used by executing the following in a command line utility:
nx run my-project:cargo-format
Please note: The cargo-format executor should be included in the desired projects's project.json file.
Lint a Rust project with Cargo Clippy
This executor can be used by executing the following in a command line utility:
nx run my-project:cargo-clippy
Please note: The cargo-clippy executor should be included in the desired projects's project.json file.
Create docs for a Rust project with Cargo Doc
This executor can be used by executing the following in a command line utility:
nx run my-project:cargo-doc
Please note: The cargo-doc executor should be included in the desired projects's project.json file.
The following generators are available with this package to assist in workspace management:
Initialize the @storm-software/workspace-tools plugin.
Storm workspace preset generator
Create a new NodeJs TypeScript library package in the Storm workspace
Create a Storm JSON schema based on the workspaces project configurations
Create a new Neutral TypeScript library package in the Storm workspace
Create a new browser TypeScript library package in the Storm workspace
The release version generator used in Storm Workspaces
Run nx build workspace-tools to build the library.
Run nx test workspace-tools to execute the unit tests via
Jest.
Storm workspaces are built using Nx, 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.
See the open issues for a list of proposed features (and known issues).
Reach out to the maintainer at one of the following places:
This project is licensed under the Apache License 2.0. Feel free to edit and distribute this template as you like.
See LICENSE for more information.
This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG file
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:
Please adhere to this project's code of conduct.
You can use markdownlint-cli to check for common markdown style inconsistency.
Thanks goes to these wonderful people (emoji key):
 Patrick Sullivan 🎨 💻 🔧 📖 ⚠️ |  Tyler Benning 🎨 |  Stormie 🚧 |
Add your contributions
|
This project follows the all-contributors specification. Contributions of any kind welcome!
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 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 or join our Slack channel!
FAQs
Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.
The npm package @storm-software/workspace-tools receives a total of 771 weekly downloads. As such, @storm-software/workspace-tools popularity was classified as not popular.
We found that @storm-software/workspace-tools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.