@storm-software/workspace-tools/dist/executor-B8D-FX1j.d.ts

Tools for managing a Storm workspace, including various Nx generators and executors for common development tasks.

import { ExecutorContext, PromiseExecutor } from '@nx/devkit';

// Generated by @storm-software/untyped
// Do not edit this file directly

interface CargoDocExecutorSchema {
 /**
  * Output Path
  * 
  * The output path for the build
  * 
  * @default "dist/{projectRoot}"
  * 
  * @format path
 */
 outputPath?: string,

 /**
  * Cargo.toml Path
  * 
  * The path to the Cargo.toml file
  * 
  * @default "{projectRoot}/Cargo.toml"
  * 
  * @format path
 */
 package?: string,

 /**
  * Toolchain
  * 
  * The type of toolchain to use for the build
  * 
  * @default "stable"
  * 
  * @enum stable,beta,nightly
 */
 toolchain?: string,

 /**
  * Target
  * 
  * The target to build
  * 
 */
 target?: string,

 /**
  * All Targets
  * 
  * Build all targets
  * 
 */
 allTargets?: boolean,

 /**
  * Profile
  * 
  * The profile to build
  * 
 */
 profile?: string,

 /**
  * Release
  * 
  * Build in release mode
  * 
 */
 release?: boolean,

 /**
  * Features
  * 
  * The features to build
  * 
  * 
  * @oneOf [object Object],[object Object]
 */
 features?: string,

 /**
  * All Features
  * 
  * Build all features
  * 
 */
 allFeatures?: boolean,

 /**
  * Library
  * 
  * Generate documentation for the library
  * 
  * @default {"default":true}
 */
 lib?: boolean,

 /**
  * Bins
  * 
  * Generate documentation for the bins
  * 
  * @default {"default":true}
 */
 bins?: boolean,

 /**
  * Examples
  * 
  * Generate documentation for the examples
  * 
  * @default {"default":true}
 */
 examples?: boolean,

 /**
  * No Dependencies
  * 
  * Do not generate documentation for dependencies
  * 
  * @default {"default":false}
 */
 noDeps?: boolean,
}

declare function cargoDocExecutor(options: CargoDocExecutorSchema, context: ExecutorContext): Promise<{
    success: boolean;
}>;
declare const _default: PromiseExecutor<CargoDocExecutorSchema>;

export { type CargoDocExecutorSchema as C, _default as _, cargoDocExecutor as c };