@storm-software/workspace-tools/dist/src/base/index.d.ts

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

export { withRunExecutor } from './base-executor.js';
export { default as baseExecutorSchema } from './base-executor.untyped.js';
export { withRunGenerator } from './base-generator.js';
export { default as baseGeneratorSchema } from './base-generator.untyped.js';
export { default as cargoBaseExecutorSchema } from './cargo-base-executor.untyped.js';
export { default as typescriptBuildExecutorSchema } from './typescript-build-executor.untyped.js';
import { Tree } from '@nx/devkit';
import { NormalizedLibraryGeneratorOptions } from '@nx/js/src/generators/library/schema';
import { S as StormWorkspaceConfig } from '../../types-C3URiht7.js';
export { default as typescriptLibraryGeneratorSchema } from './typescript-library-generator.untyped.js';
import '../../types-CUnUfpKk.js';
import 'tsup';
import 'zod';
import 'untyped';

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

interface TypeScriptLibraryGeneratorSchema {
 /**
  * Directory
  * 
  * The directory to create the library in
  * 
 */
 directory: string,

 /**
  * Name
  * 
  * The name of the library
  * 
 */
 name: string,

 /**
  * Description
  * 
  * The description of the library
  * 
 */
 description?: string,

 /**
  * Build Executor
  * 
  * The executor to use for building the library
  * 
  * @default "@storm-software/workspace-tools:unbuild"
 */
 buildExecutor?: string,

 /**
  * Platform
  * 
  * The platform to target with the library
  * 
  * @default "neutral"
  * 
  * @enum neutral,node,worker,browser
 */
 platform?: string,

 /**
  * Import Path
  * 
  * The import path for the library
  * 
 */
 importPath?: string,

 /**
  * Tags
  * 
  * The tags for the library
  * 
 */
 tags?: string,

 /**
  * Unit Test Runner
  * 
  * The unit test runner to use
  * 
  * 
  * @enum jest,vitest,none
 */
 unitTestRunner?: string,

 /**
  * Test Environment
  * 
  * The test environment to use
  * 
  * 
  * @enum jsdom,node
 */
 testEnvironment?: string,

 /**
  * Pascal Case Files
  * 
  * Use PascalCase for file names
  * 
  * @default false
 */
 pascalCaseFiles?: boolean,

 /**
  * Strict
  * 
  * Enable strict mode
  * 
  * @default true
 */
 strict?: boolean,

 /**
  * Publishable
  * 
  * Make the library publishable
  * 
  * @default false
 */
 publishable?: boolean,

 /**
  * Buildable
  * 
  * Make the library buildable
  * 
  * @default true
 */
 buildable?: boolean,
}

type TypeScriptLibraryGeneratorOptions = TypeScriptLibraryGeneratorSchema & {
    devDependencies?: Record<string, string>;
    peerDependencies?: Record<string, string>;
    peerDependenciesMeta?: Record<string, any>;
    tsconfigOptions?: Record<string, any>;
};
type TypeScriptLibraryGeneratorNormalizedOptions = TypeScriptLibraryGeneratorOptions & NormalizedLibraryGeneratorOptions & {
    rootProject: boolean;
};
declare function typeScriptLibraryGeneratorFn(tree: Tree, options: TypeScriptLibraryGeneratorOptions, config?: StormWorkspaceConfig): Promise<null>;
declare function getOutputPath(options: TypeScriptLibraryGeneratorNormalizedOptions): string;
declare function createProjectTsConfigJson(tree: Tree, options: TypeScriptLibraryGeneratorNormalizedOptions): void;
type UnitTestRunner = "jest" | "vitest" | "none" | undefined;
type TestEnvironment = "jsdom" | "node" | undefined;
declare function normalizeOptions(tree: Tree, options: TypeScriptLibraryGeneratorOptions, config?: StormWorkspaceConfig): Promise<TypeScriptLibraryGeneratorNormalizedOptions>;

export { type TestEnvironment, type TypeScriptLibraryGeneratorNormalizedOptions, type TypeScriptLibraryGeneratorOptions, type UnitTestRunner, createProjectTsConfigJson, getOutputPath, normalizeOptions, typeScriptLibraryGeneratorFn };