@storm-software/workspace-tools

<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x640-dark.gif"> <source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x640-light.gif"> <img src="https://public.storm-cdn.com/storm-software/banner-1280x640-dark.gif" width="100%" alt="Storm Software" /> </picture> </div> <br /> <div align="center"> <b> <a href="https://stormsoftware.com" target="_blank">Website</a> • <a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> • <a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</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> </b> </div> <br /> This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops 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.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br /> [![Version](https://img.shields.io/badge/version-1.295.20-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/) [![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/) [![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/) [![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/) ![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) [![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/) ![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] > 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 available 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.   <div align="center"> <b>Be sure to ⭐ this <a href="https://github.com/storm-software/storm-ops" target="_blank">repository on GitHub</a> so you can keep up to date on any daily progress!</b> </div> <br />   ## Table of Contents - [Storm Workspace Tools](#storm-workspace-tools) - [Installing](#installing) - [Executors](#executors) - [Typia Executor](#typia-executor) - [Example](#example) - [Options](#options) - [ESBuild Executor](#esbuild-executor) - [Example](#example-1) - [Options](#options-1) - [Unbuild Executor](#unbuild-executor) - [Example](#example-2) - [Options](#options-2) - [Clean Package Executor](#clean-package-executor) - [Example](#example-3) - [Options](#options-3) - [Size Limit Executor](#size-limit-executor) - [Example](#example-4) - [Options](#options-4) - [Npm Publish Executor](#npm-publish-executor) - [Example](#example-5) - [Options](#options-5) - [Cargo Publish Executor](#cargo-publish-executor) - [Example](#example-6) - [Options](#options-6) - [Cargo Build Executor](#cargo-build-executor) - [Example](#example-7) - [Options](#options-7) - [Cargo Check Executor](#cargo-check-executor) - [Example](#example-8) - [Options](#options-8) - [Cargo Format Executor](#cargo-format-executor) - [Example](#example-9) - [Options](#options-9) - [Cargo Clippy Executor](#cargo-clippy-executor) - [Example](#example-10) - [Options](#options-10) - [Cargo Doc Executor](#cargo-doc-executor) - [Example](#example-11) - [Options](#options-11) - [Napi Executor](#napi-executor) - [Example](#example-12) - [Options](#options-12) - [Generators](#generators) - [Init Generator](#init-generator) - [Options](#options-13) - [Preset Generator](#preset-generator) - [Options](#options-14) - [Node Library Generator](#node-library-generator) - [Options](#options-15) - [Config Schema Generator](#config-schema-generator) - [Options](#options-16) - [Neutral Library Generator](#neutral-library-generator) - [Options](#options-17) - [Browser Library Generator](#browser-library-generator) - [Options](#options-18) - [release-version](#release-version) - [Building](#building) - [Running unit tests](#running-unit-tests) - [Storm Workspaces](#storm-workspaces) - [Roadmap](#roadmap) - [Support](#support) - [License](#license) - [Changelog](#changelog) - [Contributing](#contributing) - [Contributors](#contributors)  <br />    # Storm Workspace Tools A package containing tools for managing a Storm workspace. It includes various [Nx](https://nx.dev) generators and executors for common development tasks. ## Installing Using [pnpm](http://pnpm.io): ```bash pnpm add -D @storm-software/workspace-tools ``` <details> <summary>Using npm</summary> ```bash npm install -D @storm-software/workspace-tools ``` </details> <details> <summary>Using yarn</summary> ```bash yarn add -D @storm-software/workspace-tools ``` </details> ## Executors The following executors are available in this package to invoke common tasks for the workspace's projects:    ## Typia Executor A type definition for a Typia executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:typia ``` **Please note:** _The typia executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | **outputPath \*** | `string` | The output path for the build | "{sourceRoot}/__generated__/typia" | | **entry \*** | `string[]` | The entry file or files to build | `[]` | | **tsconfig \*** | `string` | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | clean | `boolean` | Clean the output directory before building | `true` | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ ## ESBuild Executor A type definition for an ESBuild executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:esbuild ``` **Please note:** _The esbuild executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | entry | `string[]` | The entry file or files to build | `[]` | | tsconfig | `string` | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | bundle | `boolean` | Bundle the output | | | minify | `boolean` | Minify the output | | | debug | `boolean` | Debug the output | | | sourcemap | `boolean` | Generate a sourcemap | | | silent | `boolean` | Should the build run silently - only report errors back to the user | | | target | "es3" \| "es5" \| "es6" \| "es2015" \| "es2016" \| "es2017" \| "es2018" \| "es2019" \| "es2020" \| "es2021" \| "es2022" \| "es2023" \| "es2024" \| "esnext" \| "node12" \| "node14" \| "node16" \| "node18" \| "node20" \| "node22" \| "browser" \| "chrome58" \| "chrome59" \| "chrome60" | The target to build | "esnext" | | format | "cjs" \| "esm" \| "iife" | The format to build | "esm" | | platform | "neutral" \| "node" \| "browser" | The platform to build | "neutral" | | external | `any[]` | The external dependencies | `[]` | | define | `object` | The define values | `[object Object]` | | env | `object` | The environment variable values | `[object Object]` | ## Unbuild Executor A type definition for a unbuild executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:unbuild ``` **Please note:** _The unbuild executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | | | **entry \*** | `string[]` | The directory to use as input for the build | `[]` | | tsconfig | `string` | The path to the tsconfig file | "{projectRoot}/tsconfig.json" | | bundle | `boolean` | Bundle the output | | | minify | `boolean` | Minify the output | | | debug | `boolean` | Debug the output | | | sourcemap | `boolean` | Generate a sourcemap | | | silent | `boolean` | Should the build run silently - only report errors back to the user | | | target | "es3" \| "es5" \| "es6" \| "es2015" \| "es2016" \| "es2017" \| "es2018" \| "es2019" \| "es2020" \| "es2021" \| "es2022" \| "es2023" \| "es2024" \| "esnext" \| "node12" \| "node14" \| "node16" \| "node18" \| "node20" \| "node22" \| "browser" \| "chrome58" \| "chrome59" \| "chrome60" | The target to build | "esnext" | | format | `string[]` | The format to build | `[]` | | platform | "neutral" \| "node" \| "browser" | The platform to build | "neutral" | | external | `any[]` | The external dependencies | `[]` | | define | `object` | The define values | `[object Object]` | | env | `object` | The environment variable values | `[object Object]` | | **name \*** | `string` | The name of the project/build | "{projectName}" | | treeShaking | `boolean` | Enable tree shaking | `true` | | watch | `boolean` | Watch for changes | | | clean | `boolean` | Clean the output directory before building | `true` | | stub | `boolean` | Stub the output | | | buildOnly | `boolean` | Should the build process skip generating a package.json and copying assets | | | watchOptions | `object` | Watch options | `[object Object]` | | stubOptions | `object` | Stub options | `[object Object]` | | dependencies | `string[]` | The dependencies to install | | | peerDependencies | `string[]` | The peer dependencies to install | | | devDependencies | `string[]` | The dev dependencies to install | | | alias | `object` | The alias to use | `[object Object]` | | replace | `object` | The replace to use | `[object Object]` | | rollup | `object` | The rollup options | `[object Object]` | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ ## Clean Package Executor The clean package executor is responsible for removing unnecessary files and fields from a distributable package to make it 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: ```cmd nx run my-project:clean-package ``` **Please note:** _The clean-package executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The path to the output | "dist/{projectRoot}" | | packageJsonPath | `string` | The path to the package.json that will be modified | "{outputPath}/package.json" | | ignoredFiles | `string` | The files to ignore | | | fields | `string` | The fields to include | "" | | cleanReadMe | `boolean` | Clean the read me | `true` | | cleanComments | `boolean` | Clean the comments | `true` | ## Size Limit Executor A type definition for a Size Limit executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:size-limit ``` **Please note:** _The size-limit executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | entry | `string[]` | The path to the entry file | | ## Npm Publish Executor A type definition for a Npm Publish executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:npm-publish ``` **Please note:** _The npm-publish executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | packageRoot | `string` | The path to the package root | | | registry | `string` | The registry to publish to | "https://registry.npmjs.org/" | | tag | `string` | The tag to publish with | "latest" | | version | `string` | The version to publish. If not provided, the version from package.json will be used | | | otp | `number` | The one time password | | | dryRun | `boolean` | Perform a dry run | | | firstRelease | `boolean` | Publish the first release | | ## Cargo Publish Executor A type definition for a Cargo/rust Publish executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:cargo-publish ``` **Please note:** _The cargo-publish executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | package | `string` | The path to the Cargo.toml file | "{projectRoot}/Cargo.toml" | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | The target to build | | | allTargets | `boolean` | Build all targets | | | profile | `string` | The profile to build | | | release | `boolean` | Build in release mode | | | features | `string` | The features to build | | | allFeatures | `boolean` | Build all features | | | registry | `string` | The registry to publish to | | | packageRoot | `string` | The path to the package root | | | dryRun | `boolean` | Perform a dry run | | ## Cargo Build Executor A type definition for a Cargo/rust build executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:cargo-build ``` **Please note:** _The cargo-build executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The path to the output directory | | | package | `string` | The path to the Cargo.toml file | "{projectRoot}/Cargo.toml" | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | The target to build | | | allTargets | `boolean` | Build all targets | | | profile | `string` | The profile to build | | | release | `boolean` | Build in release mode | | | features | `string` | The features to build | | | allFeatures | `boolean` | Build all features | | ## Cargo Check Executor A type definition for a Cargo/rust check executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:cargo-check ``` **Please note:** _The cargo-check executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | package | `string` | The path to the Cargo.toml file | "{projectRoot}/Cargo.toml" | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | The target to build | | | allTargets | `boolean` | Build all targets | | | profile | `string` | The profile to build | | | release | `boolean` | Build in release mode | | | features | `string` | The features to build | | | allFeatures | `boolean` | Build all features | | ## Cargo Format Executor A type definition for a Cargo/rust format executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:cargo-format ``` **Please note:** _The cargo-format executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | package | `string` | The path to the Cargo.toml file | "{projectRoot}/Cargo.toml" | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | The target to build | | | allTargets | `boolean` | Build all targets | | | profile | `string` | The profile to build | | | release | `boolean` | Build in release mode | | | features | `string` | The features to build | | | allFeatures | `boolean` | Build all features | | ## Cargo Clippy Executor A type definition for a Cargo/rust clippy executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:cargo-clippy ``` **Please note:** _The cargo-clippy executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | package | `string` | The path to the Cargo.toml file | "{projectRoot}/Cargo.toml" | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | The target to build | | | allTargets | `boolean` | Build all targets | | | profile | `string` | The profile to build | | | release | `boolean` | Build in release mode | | | features | `string` | The features to build | | | allFeatures | `boolean` | Build all features | | | fix | `boolean` | Automatically fix issues | | ## Cargo Doc Executor A type definition for a Cargo/rust documentation executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:cargo-doc ``` **Please note:** _The cargo-doc executor should be included in the desired projects's `project.json` file._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | outputPath | `string` | The output path for the build | "dist/{projectRoot}" | | package | `string` | The path to the Cargo.toml file | "{projectRoot}/Cargo.toml" | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | The target to build | | | allTargets | `boolean` | Build all targets | | | profile | `string` | The profile to build | | | release | `boolean` | Build in release mode | | | features | `string` | The features to build | | | allFeatures | `boolean` | Build all features | | | lib | `boolean` | Generate documentation for the library | `[object Object]` | | bins | `boolean` | Generate documentation for the bins | `[object Object]` | | examples | `boolean` | Generate documentation for the examples | `[object Object]` | | noDeps | `boolean` | Do not generate documentation for dependencies | `[object Object]` | ## Napi Executor A type definition for the Napi - Bindings Build executor schema ### Example This executor can be used by executing the following in a command line utility: ```cmd nx run my-project:napi ``` **Please note:** _The napi executor should be included in the desired projects's `project.json` file.All required options must be included in the `options` property of the json._ ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | **outputPath \*** | `string` | The path to the output directory | "{sourceRoot}" | | **package \*** | `string` | Build the specified library or the one at cwd | | | toolchain | "stable" \| "beta" \| "nightly" | The type of toolchain to use for the build | "stable" | | target | `string` | Build for the target triple, bypassed to \`cargo build --target\` | | | allTargets | `boolean` | Build all targets | | | profile | `string` | Build artifacts with the specified profile | | | release | `boolean` | Build in release mode | | | features | `string[]` | List of features to activate | | | allFeatures | `boolean` | Activate all available features | | | **jsBinding \*** | `string` | The path to the output JavaScript file | "binding.js" | | **dts \*** | `string` | The path to the output TypeScript declaration file | "binding.d.ts" | | **manifestPath \*** | `string` | The path to the Cargo.toml manifest file | | | cwd | `string` | Working directory where napi command will be executed; other paths are relative to this | | | configPath | `string` | Path to napi config JSON file | | | packageJsonPath | `string` | Path to package.json | | | targetDir | `string` | Directory for all crate generated artifacts (cargo build --target-dir) | | | platform | `boolean` | Add platform triple to generated Node.js binding file, e.g. [name].linux-x64-gnu.node | `true` | | jsPackageName | `string` | Package name in generated JS binding file. Works only with --platform | | | constEnum | `boolean` | Whether to generate const enum for TypeScript bindings | | | noJsBinding | `boolean` | Disable generation of JS binding file. Works only with --platform | | | dtsHeader | `string` | Custom file header for generated type def file (requires typedef feature) | | | noDtsHeader | `boolean` | Disable default file header for generated type def file (requires typedef feature) | | | dtsCache | `boolean` | Enable the DTS cache | `true` | | esm | `boolean` | Emit an ESM JS binding file instead of CJS (works only with --platform) | | | strip | `boolean` | Strip the library to minimize file size | | | verbose | `boolean` | Verbosely log build command trace | | | bin | `string` | Build only the specified binary | | | crossCompile | `boolean` | [experimental] Cross-compile for the specified target with cargo-xwin on Windows and cargo-zigbuild on other platforms | | | useCross | `boolean` | [experimental] Use cross (https://github.com/cross-rs/cross) instead of cargo | | | useNapiCross | `boolean` | [experimental] Use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets | | | watch | `boolean` | Watch crate changes and build continuously with cargo-watch | | | noDefaultFeatures | `boolean` | Do not activate the default feature | | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._    ## Generators The following generators are available with this package to assist in workspace management:    ## Init Generator A type definition for an init generator schema ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | skipFormat | `boolean` | Skip formatting the generated files | | ## Preset Generator A type definition for a preset generator schema ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | **directory \*** | `string` | The directory to create the library in | | | **name \*** | `string` | The name of the workspace | | | organization | `string` | The organization of the workspace | "storm-software" | | includeApps | `boolean` | Include apps in the workspace | `true` | | includeRust | `boolean` | Include Rust support in the workspace | | | namespace | `string` | The namespace of the workspace | "storm-software" | | description | `string` | The description of the workspace | | | repositoryUrl | `string` | The URL of the repository | | | nxCloud | `string` | Nx Cloud configuration | | | mode | `string` | The mode of the Nx client | | | packageManager | "npm" \| "pnpm" \| "yarn" \| "bun" | The package manager to use | "pnpm" | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ ## Node Library Generator A type definition for a NodeJs library generator schema ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | **directory \*** | `string` | The directory to create the library in | | | **name \*** | `string` | The name of the library | | | description | `string` | The description of the library | | | buildExecutor | `string` | The executor to use for building the library | "@storm-software/workspace-tools:unbuild" | | platform | "node" \| "neutral" | The platform to target with the library | "node" | | importPath | `string` | The import path for the library | | | tags | `string` | The tags for the library | | | unitTestRunner | "jest" \| "vitest" \| "none" | The unit test runner to use | | | testEnvironment | "jsdom" \| "node" | The test environment to use | | | pascalCaseFiles | `boolean` | Use PascalCase for file names | | | strict | `boolean` | Enable strict mode | `true` | | publishable | `boolean` | Make the library publishable | | | buildable | `boolean` | Make the library buildable | `true` | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ ## Config Schema Generator A type definition for a config schema generator schema ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | directory | `string` | The directory to create the library in | | | outputFile | `string` | The file to write the schema to | "{workspaceRoot}/storm-workspace.schema.json" | ## Neutral Library Generator A type definition for a neutral library generator schema ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | **directory \*** | `string` | The directory to create the library in | | | **name \*** | `string` | The name of the library | | | description | `string` | The description of the library | | | buildExecutor | `string` | The executor to use for building the library | "@storm-software/workspace-tools:unbuild" | | platform | "neutral" | The platform to target with the library | "neutral" | | importPath | `string` | The import path for the library | | | tags | `string` | The tags for the library | | | unitTestRunner | "jest" \| "vitest" \| "none" | The unit test runner to use | | | testEnvironment | "jsdom" \| "node" | The test environment to use | | | pascalCaseFiles | `boolean` | Use PascalCase for file names | | | strict | `boolean` | Enable strict mode | `true` | | publishable | `boolean` | Make the library publishable | | | buildable | `boolean` | Make the library buildable | `true` | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ ## Browser Library Generator A type definition for a browser library generator schema ### Options The following executor options are available: | Option | Type | Description | Default | | --------- | ------ | ------------- | --------- | | **directory \*** | `string` | The directory to create the library in | | | **name \*** | `string` | The name of the library | | | description | `string` | The description of the library | | | buildExecutor | `string` | The executor to use for building the library | "@storm-software/workspace-tools:unbuild" | | platform | "browser" \| "neutral" | The platform to target with the library | "browser" | | importPath | `string` | The import path for the library | | | tags | `string` | The tags for the library | | | unitTestRunner | "jest" \| "vitest" \| "none" | The unit test runner to use | | | testEnvironment | "jsdom" \| "node" | The test environment to use | | | pascalCaseFiles | `boolean` | Use PascalCase for file names | | | strict | `boolean` | Enable strict mode | `true` | | publishable | `boolean` | Make the library publishable | | | buildable | `boolean` | Make the library buildable | `true` | **Please note:** _Option names followed by \* above are required, and must be provided to run the executor._ ## 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](https://jestjs.io).    ## 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. <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). - [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction) - [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: - [Contact](https://stormsoftware.com/contact) - [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**. 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-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)):  <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.com"><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" alt="All Contributors"> <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a> </img> </td> </tr> </tfoot> </table>  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"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x320-dark.webp"> <source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x320-light.webp"> <img src="https://public.storm-cdn.com/storm-software/banner-1280x320-dark.webp" width="100%" alt="Storm Software" /> </picture> </div> <br /> <div align="center"> <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"> <b>Fingerprint:</b> F47F 1853 BCAD DE9B 42C8 6316 9FDE EC95 47FE D106 </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. Join us on [Discord](https://discord.gg/MQ6YVzakM5) 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](https://stormsoftware.com/contact) or join our [Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA) channel! <br /> <div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/icon-fill.png" alt="Storm Software" width="200px"/></a></div> <br /> <div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div> <br /> <div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div> <br /> <br />