@storm-software/workspace-tools 1.228.0 → 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/base/base-executor.schema.md

@@ -0,0 +1,16 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Base Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> Output Path
+
+
+The output path for the build
+
+

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

@@ -0,0 +1,15 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Base Generator
+
+## `directory`
+- **Type**: `string`
+
+> Directory
+
+
+The directory to create the library in
+
+

package/docs/api/base/cargo-base-executor.schema.md

@@ -0,0 +1,90 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# Cargo Base 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/base/typescript-build-executor.schema.md

@@ -0,0 +1,130 @@
+
+<!-- Generated by @storm-software/untyped -->
+<!-- Do not edit this file directly -->
+
+# TypeScript Build Executor
+
+## `outputPath`
+- **Type**: `string`
+- **Default**: `"dist/{projectRoot}"`
+
+> 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`
+- **Default**: `false`
+
+> Bundle
+
+
+Bundle the output
+
+
+## `minify`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Minify
+
+
+Minify the output
+
+
+## `debug`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> Debug
+
+
+Debug the output
+
+
+## `sourcemap`
+- **Type**: `boolean`
+- **Default**: `false`
+
+> 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**: `array`
+- **Default**: `["cjs","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/base/typescript-library-generator.schema.md

@@ -0,0 +1,297 @@
+
+<!-- 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
+
+
+## `devDependencies`
+
+## `dependencies`
+
+## `peerDependencies`
+
+## `peerDependenciesMeta`
+
+## `tags`
+- **Type**: `string`
+
+> Tags
+
+
+The tags for the library
+
+
+## `tsconfigOptions`
+
+## `skipFormat`
+- **Type**: `boolean`
+
+> Skip Format
+
+
+Skip formatting
+
+
+## `skipTsConfig`
+- **Type**: `boolean`
+
+> Skip TsConfig
+
+
+Skip TypeScript configuration
+
+
+## `skipPackageJson`
+- **Type**: `boolean`
+
+> Skip Package Json
+
+
+Skip package.json
+
+
+## `includeBabelRc`
+- **Type**: `boolean`
+
+> Include Babel Rc
+
+
+Include Babel configuration
+
+
+## `unitTestRunner`
+- **Type**: `string`
+
+> Unit Test Runner
+
+
+The unit test runner to use
+
+
+## `linter`
+- **Type**: `string`
+
+> Linter
+
+
+The linter to use
+
+
+## `testEnvironment`
+- **Type**: `string`
+
+> Test Environment
+
+
+The test environment to use
+
+
+## `importPath`
+- **Type**: `string`
+
+> Import Path
+
+
+The import path for the library
+
+
+## `js`
+- **Type**: `boolean`
+
+> JavaScript
+
+
+Use JavaScript instead of TypeScript
+
+
+## `pascalCaseFiles`
+- **Type**: `boolean`
+
+> Pascal Case Files
+
+
+Use PascalCase for file names
+
+
+## `strict`
+- **Type**: `boolean`
+
+> Strict
+
+
+Enable strict mode
+
+
+## `publishable`
+- **Type**: `boolean`
+
+> Publishable
+
+
+Make the library publishable
+
+
+## `buildable`
+- **Type**: `boolean`
+
+> Buildable
+
+
+Make the library buildable
+
+
+## `setParserOptionsProject`
+- **Type**: `boolean`
+
+> Set Parser Options Project
+
+
+Set parser options project
+
+
+## `config`
+- **Type**: `string`
+
+> Config
+
+
+The configuration type
+
+
+## `compiler`
+- **Type**: `string`
+
+> Compiler
+
+
+The compiler to use
+
+
+## `bundler`
+- **Type**: `string`
+
+> Bundler
+
+
+The bundler to use
+
+
+## `skipTypeCheck`
+- **Type**: `boolean`
+
+> Skip Type Check
+
+
+Skip type checking
+
+
+## `minimal`
+- **Type**: `boolean`
+
+> Minimal
+
+
+Create a minimal library
+
+
+## `rootProject`
+- **Type**: `boolean`
+
+> Root Project
+
+
+Create a root project
+
+
+## `simpleName`
+- **Type**: `boolean`
+
+> Simple Name
+
+
+Use a simple name for the library
+
+
+## `addPlugin`
+- **Type**: `boolean`
+
+> Add Plugin
+
+
+Add a plugin to the library
+
+
+## `useProjectJson`
+- **Type**: `boolean`
+
+> Use Project Json
+
+
+Use project.json
+
+
+## `skipWorkspacesWarning`
+- **Type**: `boolean`
+
+> Skip Workspaces Warning
+
+
+Skip workspaces warning
+
+
+## `useTscExecutor`
+- **Type**: `boolean`
+
+> Use Tsc Executor
+
+
+Use TSC executor
+
+

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