@storm-software/workspace-tools
v1.258.7
Published
Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.
Downloads
8,321
Maintainers
Readme
[!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.
Table of Contents
- Storm Workspace Tools
- Installing
- Executors
- typia
- tsdown
- esbuild
- unbuild
- clean-package
- size-limit
- npm-publish
- cargo-publish
- cargo-build
- cargo-check
- cargo-format
- cargo-clippy
- cargo-doc
- Generators
- init
- preset
- node-library
- config-schema
- neutral-library
- browser-library
- release-version
- Building
- Running unit tests
- Storm Workspaces
- Roadmap
- Support
- License
- Changelog
- Contributing
- Contributors
Storm Workspace Tools
A package containing tools for managing a Storm workspace. It includes various Nx generators and executors for common development tasks.
Installing
Using pnpm:
pnpm add -D @storm-software/workspace-tools
npm install -D @storm-software/workspace-tools
yarn add -D @storm-software/workspace-tools
Executors
The following executors are available in this package to invoke common tasks for the workspace's projects:
typia
Run the `typia` generator to create runtime type validators
Example
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.
tsdown
Run the `tsdown` build process on a selected project
Example
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.
esbuild
Run the `esbuild` build process on a selected project
Example
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.
unbuild
Run the `unbuild` build process on a selected project
Example
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.
clean-package
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.)
Example
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.
size-limit
Run a size-limit performance test on the project
Example
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.
npm-publish
Publish a package to the NPM registry
Example
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.
cargo-publish
Publish a Rust crate to the crates.io registry
Example
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.
cargo-build
Build a Rust project with Cargo Build
Example
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.
cargo-check
Check a Rust project with Cargo Check
Example
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.
cargo-format
Format a Rust project with Cargo Fmt
Example
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.
cargo-clippy
Lint a Rust project with Cargo Clippy
Example
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.
cargo-doc
Create docs for a Rust project with Cargo Doc
Example
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.
Generators
The following generators are available with this package to assist in workspace management:
init
Initialize the @storm-software/workspace-tools
plugin.
preset
Storm workspace preset generator
node-library
Create a new NodeJs TypeScript library package in the Storm workspace
config-schema
Create a Storm JSON schema based on the workspaces project configurations
neutral-library
Create a new Neutral TypeScript library package in the Storm workspace
browser-library
Create a new browser TypeScript library package in the Storm workspace
release-version
The release version generator used in Storm Workspaces
Building
Run nx build workspace-tools
to build the library.
Running unit tests
Run nx test workspace-tools
to execute the unit tests via
Jest.
Storm Workspaces
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.
Roadmap
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
Support
Reach out to the maintainer at one of the following places:
License
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.
Changelog
This project adheres to Semantic Versioning. Every release, along with the migration instructions, is documented in the CHANGELOG 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.
You can use markdownlint-cli to check for common markdown style inconsistency.
Contributors
Thanks goes to these wonderful people (emoji key):
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!