@storm-software/workspace-tools 1.270.2 → 1.271.1

package/docs/api/base/typescript-library-generator.schema.md

@@ -0,0 +1,129 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# TypeScript 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/executors/cargo-build/schema.md

@@ -0,0 +1,89 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Build Executor
+
+## `outputPath`
+- **Type**: `string`
+
+> Output Path
+
+
+The path to the output directory
+
+
+## `package`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/Cargo.toml"`
+
+> Cargo.toml Path
+
+
+The path to the Cargo.toml file
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target
+
+
+The target to build
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Profile
+
+
+The profile to build
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `string`
+
+> Features
+
+
+The features to build
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Build all features
+
+

package/docs/api/executors/cargo-check/schema.md

@@ -0,0 +1,90 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Check Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `package`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/Cargo.toml"`
+
+> Cargo.toml Path
+
+
+The path to the Cargo.toml file
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target
+
+
+The target to build
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Profile
+
+
+The profile to build
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `string`
+
+> Features
+
+
+The features to build
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Build all features
+
+

package/docs/api/executors/cargo-clippy/schema.md

@@ -0,0 +1,99 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Clippy Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `package`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/Cargo.toml"`
+
+> Cargo.toml Path
+
+
+The path to the Cargo.toml file
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target
+
+
+The target to build
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Profile
+
+
+The profile to build
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `string`
+
+> Features
+
+
+The features to build
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Build all features
+
+
+## `fix`
+- **Type**: `boolean`
+
+> Fix
+
+
+Automatically fix issues
+
+

package/docs/api/executors/cargo-doc/schema.md

@@ -0,0 +1,130 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Doc Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `package`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/Cargo.toml"`
+
+> Cargo.toml Path
+
+
+The path to the Cargo.toml file
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target
+
+
+The target to build
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Profile
+
+
+The profile to build
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `string`
+
+> Features
+
+
+The features to build
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Build all features
+
+
+## `lib`
+- **Type**: `boolean`
+- **Default**: `{"default":true}`
+
+> Library
+
+
+Generate documentation for the library
+
+
+## `bins`
+- **Type**: `boolean`
+- **Default**: `{"default":true}`
+
+> Bins
+
+
+Generate documentation for the bins
+
+
+## `examples`
+- **Type**: `boolean`
+- **Default**: `{"default":true}`
+
+> Examples
+
+
+Generate documentation for the examples
+
+
+## `noDeps`
+- **Type**: `boolean`
+- **Default**: `{"default":false}`
+
+> No Dependencies
+
+
+Do not generate documentation for dependencies
+
+

package/docs/api/executors/cargo-format/schema.md

@@ -0,0 +1,90 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Format Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `package`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/Cargo.toml"`
+
+> Cargo.toml Path
+
+
+The path to the Cargo.toml file
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target
+
+
+The target to build
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Profile
+
+
+The profile to build
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `string`
+
+> Features
+
+
+The features to build
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Build all features
+
+

package/docs/api/executors/cargo-publish/schema.md

@@ -0,0 +1,117 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Publish Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `package`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/Cargo.toml"`
+
+> Cargo.toml Path
+
+
+The path to the Cargo.toml file
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target
+
+
+The target to build
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Profile
+
+
+The profile to build
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `string`
+
+> Features
+
+
+The features to build
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Build all features
+
+
+## `registry`
+- **Type**: `string`
+
+> Registry
+
+
+The registry to publish to
+
+
+## `packageRoot`
+- **Type**: `string`
+
+> Package Root
+
+
+The path to the package root
+
+
+## `dryRun`
+- **Type**: `boolean`
+
+> Dry Run
+
+
+Perform a dry run
+
+