@storm-software/workspace-tools 1.270.2 → 1.271.1

package/docs/api/generators/config-schema/schema.md

@@ -0,0 +1,25 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Config Schema Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `outputFile`
+- **Type**: `string`
+- **Default**: `"{workspaceRoot}/storm-workspace.schema.json"`
+
+> Output File
+
+
+The file to write the schema to
+
+

package/docs/api/generators/init/schema.md

@@ -0,0 +1,15 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Init Generator
+
+## `skipFormat`
+- **Type**: `boolean`
+
+> Skip Format
+
+
+Skip formatting the generated files
+
+

package/docs/api/generators/neutral-library/files/README.md

@@ -0,0 +1,58 @@
+<!-- START header -->
+<!-- END header -->
+
+# <%= name %>
+
+<%= description %>
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D <%= namespace %>/<%= name %>
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D <%= namespace %>/<%= name %>
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D <%= namespace %>/<%= name %>
+```
+
+</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 <%= name %>` to build the library.
+
+### Running unit tests
+
+Run `nx test <%= name %>` to execute the unit tests via [Jest](https://jestjs.io).
+
+### Linting
+
+Run `nx lint <%= name %>` to run [ESLint](https://eslint.org/) on the package.
+
+<!-- START footer -->
+<!-- END footer -->

package/docs/api/generators/neutral-library/schema.md

@@ -0,0 +1,129 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Neutral Library Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `name`
+- **Type**: `string`
+
+> Name
+
+
+The name of the library
+
+
+## `description`
+- **Type**: `string`
+
+> Description
+
+
+The description of the library
+
+
+## `buildExecutor`
+- **Type**: `string`
+- **Default**: `"@storm-software/workspace-tools:unbuild"`
+
+> Build Executor
+
+
+The executor to use for building the library
+
+
+## `platform`
+- **Type**: `string`
+- **Default**: `"neutral"`
+
+> Platform
+
+
+The platform to target with the library
+
+
+## `importPath`
+- **Type**: `string`
+
+> Import Path
+
+
+The import path for the library
+
+
+## `tags`
+- **Type**: `string`
+
+> Tags
+
+
+The tags for the library
+
+
+## `unitTestRunner`
+- **Type**: `string`
+
+> Unit Test Runner
+
+
+The unit test runner to use
+
+
+## `testEnvironment`
+- **Type**: `string`
+
+> Test Environment
+
+
+The test environment to use
+
+
+## `pascalCaseFiles`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Pascal Case Files
+
+
+Use PascalCase for file names
+
+
+## `strict`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Strict
+
+
+Enable strict mode
+
+
+## `publishable`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Publishable
+
+
+Make the library publishable
+
+
+## `buildable`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Buildable
+
+
+Make the library buildable
+
+

package/docs/api/generators/node-library/files/README.md

@@ -0,0 +1,63 @@
+<!-- START header -->
+<!-- END header -->
+
+# <%= name %>
+
+<%= description %>
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D <%= namespace %>/<%= name %>
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D <%= namespace %>/<%= name %>
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D <%= namespace %>/<%= name %>
+```
+
+</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 <%= name %>` to build the library.
+
+### Running unit tests
+
+Run `nx test <%= name %>` to execute the unit tests via
+[Jest](https://jestjs.io).
+
+### Linting
+
+Run `nx lint <%= name %>` to run [ESLint](https://eslint.org/) on the package.
+
+<!-- START footer -->
+<!-- END footer -->

package/docs/api/generators/node-library/schema.md

@@ -0,0 +1,129 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Node Library Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `name`
+- **Type**: `string`
+
+> Name
+
+
+The name of the library
+
+
+## `description`
+- **Type**: `string`
+
+> Description
+
+
+The description of the library
+
+
+## `buildExecutor`
+- **Type**: `string`
+- **Default**: `"@storm-software/workspace-tools:unbuild"`
+
+> Build Executor
+
+
+The executor to use for building the library
+
+
+## `platform`
+- **Type**: `string`
+- **Default**: `"node"`
+
+> Platform
+
+
+The platform to target with the library
+
+
+## `importPath`
+- **Type**: `string`
+
+> Import Path
+
+
+The import path for the library
+
+
+## `tags`
+- **Type**: `string`
+
+> Tags
+
+
+The tags for the library
+
+
+## `unitTestRunner`
+- **Type**: `string`
+
+> Unit Test Runner
+
+
+The unit test runner to use
+
+
+## `testEnvironment`
+- **Type**: `string`
+
+> Test Environment
+
+
+The test environment to use
+
+
+## `pascalCaseFiles`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Pascal Case Files
+
+
+Use PascalCase for file names
+
+
+## `strict`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Strict
+
+
+Enable strict mode
+
+
+## `publishable`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Publishable
+
+
+Make the library publishable
+
+
+## `buildable`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Buildable
+
+
+Make the library buildable
+
+

package/docs/api/generators/preset/schema.md

@@ -0,0 +1,110 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Preset Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+
+## `name`
+- **Type**: `string`
+
+> Name
+
+
+The name of the workspace
+
+
+## `organization`
+- **Type**: `string`
+- **Default**: `"storm-software"`
+
+> Organization
+
+
+The organization of the workspace
+
+
+## `includeApps`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Include Apps
+
+
+Include apps in the workspace
+
+
+## `includeRust`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Include Rust
+
+
+Include Rust support in the workspace
+
+
+## `namespace`
+- **Type**: `string`
+- **Default**: `"storm-software"`
+
+> Namespace
+
+
+The namespace of the workspace
+
+
+## `description`
+- **Type**: `string`
+
+> Description
+
+
+The description of the workspace
+
+
+## `repositoryUrl`
+- **Type**: `string`
+
+> Repository URL
+
+
+The URL of the repository
+
+
+## `nxCloud`
+- **Type**: `string`
+
+> Nx Cloud
+
+
+Nx Cloud configuration
+
+
+## `mode`
+- **Type**: `string`
+
+> Mode
+
+
+The mode of the Nx client
+
+
+## `packageManager`
+- **Type**: `string`
+- **Default**: `"pnpm"`
+
+> Package Manager
+
+
+The package manager to use
+
+

package/docs/api/generators/release-version/schema.md

@@ -0,0 +1,160 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Release Version Generator
+
+## `projects`
+- **Type**: `array`
+
+> Projects
+
+
+The projects to release
+
+
+## `releaseGroup`
+
+## `projectGraph`
+
+## `specifier`
+- **Type**: `string`
+
+> Specifier
+
+
+The specifier
+
+
+## `specifierSource`
+- **Type**: `string`
+
+> Specifier Source
+
+
+The specifier source
+
+
+## `preid`
+- **Type**: `string`
+
+> Preid
+
+
+The preid
+
+
+## `packageRoot`
+- **Type**: `string`
+
+> Package Root
+
+
+The package root
+
+
+## `currentVersionResolver`
+- **Type**: `string`
+- **Default**: `"git-tag"`
+
+> Current Version Resolver
+
+
+The current version resolver
+
+
+## `currentVersionResolverMetadata`
+
+## `fallbackCurrentVersionResolver`
+- **Type**: `string`
+- **Default**: `"disk"`
+
+> Fallback Current Version Resolver
+
+
+The fallback current version resolver
+
+
+## `firstRelease`
+- **Type**: `boolean`
+
+> First Release
+
+
+Release the first version
+
+
+## `versionPrefix`
+- **Type**: `string`
+
+> Version Prefix
+
+
+The version prefix
+
+
+## `skipLockFileUpdate`
+- **Type**: `boolean`
+
+> Skip Lock File Update
+
+
+Skip lock file update
+
+
+## `installArgs`
+- **Type**: `string`
+
+> Install Args
+
+
+The install arguments
+
+
+## `installIgnoreScripts`
+- **Type**: `boolean`
+
+> Install Ignore Scripts
+
+
+Ignore scripts
+
+
+## `conventionalCommitsConfig`
+
+## `deleteVersionPlans`
+- **Type**: `boolean`
+
+> Delete Version Plans
+
+
+Delete version plans
+
+
+## `updateDependents`
+- **Type**: `string`
+
+> Update Dependents
+
+
+Update dependents
+
+
+## `logUnchangedProjects`
+- **Type**: `boolean`
+
+> Log Unchanged Projects
+
+
+Log unchanged projects
+
+
+## `preserveLocalDependencyProtocols`
+- **Type**: `boolean`
+
+> Preserve Local Dependency Protocols
+
+
+Preserve local dependency protocols
+
+