@storm-software/workspace-tools 1.228.1 → 1.229.0

package/dist/types-Dbr7XMO3.d.ts

@@ -0,0 +1,101 @@
+import { S as StormConfig } from './types-D9vU63tt.js';
+import { Options } from 'tsup';
+
+// Generated by @storm-software/untyped
+// Do not edit this file directly
+
+interface BaseExecutorSchema {
+ /**
+  * Output Path
+  * 
+  * The output path for the build
+  * 
+  * @default "dist/{projectRoot}"
+  * 
+  * @format path
+ */
+ outputPath?: string,
+}
+
+// Generated by @storm-software/untyped
+// Do not edit this file directly
+
+interface BaseGeneratorSchema {
+ /**
+  * Directory
+  * 
+  * The directory to create the library in
+  * 
+ */
+ directory?: string,
+}
+
+interface TsupContext {
+    projectRoot: string;
+    sourceRoot: string;
+    projectName: string;
+    main: string;
+}
+type BuildOptions = Options;
+type Entry = string | string[] | Record<string, string>;
+interface WorkspaceToolHooks<TSchema = any> {
+    applyDefaultOptions?: (options: Partial<TSchema>, config?: StormConfig) => Promise<TSchema> | TSchema;
+    preProcess?: (options: TSchema, config?: StormConfig) => Promise<void> | void;
+    postProcess?: (config?: StormConfig) => Promise<void> | void;
+}
+interface BaseWorkspaceToolOptions<TSchema = any> {
+    skipReadingConfig?: boolean;
+    hooks?: WorkspaceToolHooks<TSchema>;
+}
+type BaseExecutorOptions<TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema> = BaseWorkspaceToolOptions<TExecutorSchema>;
+interface BaseExecutorResult {
+    error?: Error;
+    success?: boolean;
+}
+type BaseGeneratorOptions<TGeneratorSchema extends BaseGeneratorSchema = BaseGeneratorSchema> = BaseWorkspaceToolOptions<TGeneratorSchema>;
+interface BaseGeneratorResult extends Record<string, any> {
+    error?: Error;
+    success?: boolean;
+    data?: any;
+}
+type ProjectTagVariant = "language" | "type" | "dist-style" | "provider" | "platform" | "registry" | "plugin";
+declare const ProjectTagVariant: {
+    LANGUAGE: ProjectTagVariant;
+    TYPE: ProjectTagVariant;
+    DIST_STYLE: ProjectTagVariant;
+    PROVIDER: ProjectTagVariant;
+    PLATFORM: ProjectTagVariant;
+    REGISTRY: ProjectTagVariant;
+    PLUGIN: ProjectTagVariant;
+};
+type ProjectTagLanguageValue = "typescript" | "rust";
+declare const ProjectTagLanguageValue: {
+    TYPESCRIPT: ProjectTagLanguageValue;
+    RUST: ProjectTagLanguageValue;
+};
+type ProjectTagTypeValue = "library" | "application";
+declare const ProjectTagTypeValue: {
+    LIBRARY: ProjectTagTypeValue;
+    APPLICATION: ProjectTagTypeValue;
+};
+type ProjectTagDistStyleValue = "normal" | "clean";
+declare const ProjectTagDistStyleValue: {
+    NORMAL: ProjectTagDistStyleValue;
+    CLEAN: ProjectTagDistStyleValue;
+};
+type ProjectTagPlatformValue = "node" | "browser" | "neutral" | "worker";
+declare const ProjectTagPlatformValue: {
+    NODE: ProjectTagPlatformValue;
+    BROWSER: ProjectTagPlatformValue;
+    NEUTRAL: ProjectTagPlatformValue;
+    WORKER: ProjectTagPlatformValue;
+};
+type ProjectTagRegistryValue = "cargo" | "npm" | "container" | "cyclone";
+declare const ProjectTagRegistryValue: {
+    CARGO: ProjectTagRegistryValue;
+    NPM: ProjectTagRegistryValue;
+    CONTAINER: ProjectTagRegistryValue;
+    CYCLONE: ProjectTagRegistryValue;
+};
+
+export { type BaseExecutorSchema as B, type Entry as E, ProjectTagVariant as P, type TsupContext as T, type WorkspaceToolHooks as W, type BaseExecutorResult as a, type BaseExecutorOptions as b, type BaseGeneratorSchema as c, type BaseGeneratorResult as d, type BaseGeneratorOptions as e, ProjectTagLanguageValue as f, ProjectTagTypeValue as g, ProjectTagDistStyleValue as h, ProjectTagPlatformValue as i, ProjectTagRegistryValue as j, type BuildOptions as k, type BaseWorkspaceToolOptions as l };

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
+
+