Module "api-helper/command/transform/spawnCodeTransform"

Index

Type aliases

MinSpawnLogResult

Functions

Type aliases

MinSpawnLogResult

MinSpawnLogResult: Pick<SpawnLogResult, "cmdString" | "code" | "error">

The bits of SpawnLogResult that spawnToTransform needs.

Functions

spawnCodeTransform

spawnCodeTransform(commands: SpawnLogInvocation[], log?: ProgressLog): CodeTransform

- Defined in lib/api-helper/command/transform/spawnCodeTransform.ts:70
Create a code transform by wrapping child processes run in the project directory. If a command fails, no further commands will be run and its error will be returned.

Parameters
- commands: SpawnLogInvocation[]
  
  array of commands to execute
- Optional log: ProgressLog
  
  where to log output from commands
Returns CodeTransform

result of commands, success or the first failure

spawnToTransform

spawnToTransform(p: GitProject, r: MinSpawnLogResult): Promise<TransformResult>

- Defined in lib/api-helper/command/transform/spawnCodeTransform.ts:42
Convert a SpawnLogResult into a TransformResult.

Parameters
- p: GitProject
- r: MinSpawnLogResult
Returns Promise<TransformResult>

Generated using TypeDoc