@storm-software/workspace-tools 1.295.70 → 1.295.73

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

@@ -0,0 +1,116 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Publish Executor
+
+## `outputPath`
+- **Type**: `string`
+
+> 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
+
+

package/docs/api/executors/clean-package/schema.md

@@ -0,0 +1,64 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Clean Package Executor
+
+## `outputPath`
+- **Type**: `string`
+
+> Output Path
+
+
+The path to the output
+
+
+## `packageJsonPath`
+- **Type**: `string`
+- **Default**: `"{outputPath}/package.json"`
+
+> Package JSON Path
+
+
+The path to the package.json that will be modified
+
+
+## `ignoredFiles`
+- **Type**: `string`
+
+> Ignored Files
+
+
+The files to ignore
+
+
+## `fields`
+- **Type**: `string`
+- **Default**: `[]`
+
+> Fields
+
+
+The fields to include
+
+
+## `cleanReadMe`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Clean Read Me
+
+
+Clean the read me
+
+
+## `cleanComments`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Clean Comments
+
+
+Clean the comments
+
+

package/docs/api/executors/esbuild/schema.md

@@ -0,0 +1,125 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# ESBuild Executor
+
+## `outputPath`
+- **Type**: `string`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `entry`
+- **Type**: `array`
+- **Default**: `["{sourceRoot}/index.ts"]`
+
+> Entry File(s)
+
+
+The entry file or files to build
+
+
+## `tsconfig`
+- **Type**: `string`
+- **Default**: `"{projectRoot}/tsconfig.json"`
+
+> TSConfig Path
+
+
+The path to the tsconfig file
+
+
+## `bundle`
+- **Type**: `boolean`
+
+> Bundle
+
+
+Bundle the output
+
+
+## `minify`
+- **Type**: `boolean`
+
+> Minify
+
+
+Minify the output
+
+
+## `debug`
+- **Type**: `boolean`
+
+> Debug
+
+
+Debug the output
+
+
+## `sourcemap`
+- **Type**: `boolean`
+
+> Sourcemap
+
+
+Generate a sourcemap
+
+
+## `silent`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Silent
+
+
+Should the build run silently - only report errors back to the user
+
+
+## `target`
+- **Type**: `string`
+- **Default**: `"esnext"`
+
+> Target
+
+
+The target to build
+
+
+## `format`
+- **Type**: `string`
+- **Default**: `"esm"`
+
+> Format
+
+
+The format to build
+
+
+## `platform`
+- **Type**: `string`
+- **Default**: `"neutral"`
+
+> Platform
+
+
+The platform to build
+
+
+## `external`
+- **Type**: `array`
+- **Default**: `[]`
+
+> External
+
+
+The external dependencies
+
+
+## `define`
+
+## `env`
+

package/docs/api/executors/napi/schema.md

@@ -0,0 +1,300 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Napi Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"{sourceRoot}"`
+
+> Output Path
+
+
+The path to the output directory
+
+
+## `package`
+- **Type**: `string`
+
+> Package Name
+
+
+Build the specified library or the one at cwd
+
+
+## `toolchain`
+- **Type**: `string`
+- **Default**: `"stable"`
+
+> Toolchain
+
+
+The type of toolchain to use for the build
+
+
+## `target`
+- **Type**: `string`
+
+> Target Triple
+
+
+Build for the target triple, bypassed to `cargo build --target`
+
+
+## `allTargets`
+- **Type**: `boolean`
+
+> All Targets
+
+
+Build all targets
+
+
+## `profile`
+- **Type**: `string`
+
+> Cargo Profile
+
+
+Build artifacts with the specified profile
+
+
+## `release`
+- **Type**: `boolean`
+
+> Release Mode
+
+
+Build in release mode
+
+
+## `features`
+- **Type**: `array`
+
+> Cargo Features
+
+
+List of features to activate
+
+
+## `allFeatures`
+- **Type**: `boolean`
+
+> All Features
+
+
+Activate all available features
+
+
+## `jsBinding`
+- **Type**: `string`
+- **Default**: `"binding.js"`
+
+> JS Binding File
+
+
+The path to the output JavaScript file
+
+
+## `dts`
+- **Type**: `string`
+- **Default**: `"binding.d.ts"`
+
+> DTS Binding File
+
+
+The path to the output TypeScript declaration file
+
+
+## `manifestPath`
+- **Type**: `string`
+
+> Manifest Path
+
+
+The path to the Cargo.toml manifest file
+
+
+## `cwd`
+- **Type**: `string`
+
+> Working Directory
+
+
+Working directory where napi command will be executed; other paths are relative to this
+
+
+## `configPath`
+- **Type**: `string`
+
+> NAPI Config Path
+
+
+Path to napi config JSON file
+
+
+## `packageJsonPath`
+- **Type**: `string`
+
+> package.json Path
+
+
+Path to package.json
+
+
+## `targetDir`
+- **Type**: `string`
+
+> Cargo Target Dir
+
+
+Directory for all crate generated artifacts (cargo build --target-dir)
+
+
+## `platform`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Platform Suffix
+
+
+Add platform triple to generated Node.js binding file, e.g. [name].linux-x64-gnu.node
+
+
+## `jsPackageName`
+- **Type**: `string`
+
+> JS Package Name
+
+
+Package name in generated JS binding file. Works only with --platform
+
+
+## `constEnum`
+- **Type**: `boolean`
+
+> Const Enum
+
+
+Whether to generate const enum for TypeScript bindings
+
+
+## `noJsBinding`
+- **Type**: `boolean`
+
+> Disable JS Binding
+
+
+Disable generation of JS binding file. Works only with --platform
+
+
+## `dtsHeader`
+- **Type**: `string`
+
+> DTS Header
+
+
+Custom file header for generated type def file (requires typedef feature)
+
+
+## `noDtsHeader`
+- **Type**: `boolean`
+
+> Disable Default DTS Header
+
+
+Disable default file header for generated type def file (requires typedef feature)
+
+
+## `dtsCache`
+- **Type**: `boolean`
+- **Default**: `true`
+
+> Enable DTS Cache
+
+
+Enable the DTS cache
+
+
+## `esm`
+- **Type**: `boolean`
+
+> ESM Output
+
+
+Emit an ESM JS binding file instead of CJS (works only with --platform)
+
+
+## `strip`
+- **Type**: `boolean`
+
+> Strip Binary
+
+
+Strip the library to minimize file size
+
+
+## `verbose`
+- **Type**: `boolean`
+
+> Verbose
+
+
+Verbosely log build command trace
+
+
+## `bin`
+- **Type**: `string`
+
+> Binary
+
+
+Build only the specified binary
+
+
+## `crossCompile`
+- **Type**: `boolean`
+
+> Cross Compile
+
+
+[experimental] Cross-compile for the specified target with cargo-xwin on Windows and cargo-zigbuild on other platforms
+
+
+## `useCross`
+- **Type**: `boolean`
+
+> Use cross
+
+
+[experimental] Use cross (https://github.com/cross-rs/cross) instead of cargo
+
+
+## `useNapiCross`
+- **Type**: `boolean`
+
+> Use @napi-rs/cross-toolchain
+
+
+[experimental] Use @napi-rs/cross-toolchain to cross-compile Linux arm/arm64/x64 gnu targets
+
+
+## `watch`
+- **Type**: `boolean`
+
+> Watch
+
+
+Watch crate changes and build continuously with cargo-watch
+
+
+## `noDefaultFeatures`
+- **Type**: `boolean`
+
+> No Default Features
+
+
+Do not activate the default feature
+
+

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

@@ -0,0 +1,73 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Npm Publish Executor
+
+## `packageRoot`
+- **Type**: `string`
+
+> Package Root
+
+
+The path to the package root
+
+
+## `registry`
+- **Type**: `string`
+- **Default**: `"https://registry.npmjs.org/"`
+
+> Registry
+
+
+The registry to publish to
+
+
+## `tag`
+- **Type**: `string`
+- **Default**: `"latest"`
+
+> Tag
+
+
+The tag to publish with
+
+
+## `version`
+- **Type**: `string`
+
+> Version
+
+
+The version to publish. If not provided, the version from package.json will be used
+
+
+## `otp`
+- **Type**: `number`
+
+> One Time Password
+
+
+The one time password
+
+
+## `dryRun`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Dry Run
+
+
+Perform a dry run
+
+
+## `firstRelease`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> First Release
+
+
+Publish the first release
+
+

package/docs/api/executors/size-limit/schema.md

@@ -0,0 +1,24 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Size Limit Executor
+
+## `outputPath`
+- **Type**: `string`
+
+> Output Path
+
+
+The output path for the build
+
+
+## `entry`
+- **Type**: `array`
+
+> Entry
+
+
+The path to the entry file
+
+