"api-helper/command/generator/generatorCommand"

Index

Interfaces

GeneratorCommandDetails

Type aliases

EditorFactory

Functions

Type aliases

EditorFactory

EditorFactory: (params: P, ctx: HandlerContext) => AnyProjectEditor

Type parameters

Type declaration

- (params: P, ctx: HandlerContext): AnyProjectEditor
- Parameters
 - params: P
 - ctx: HandlerContext
 Returns AnyProjectEditor

Functions

computeStartingPoint

computeStartingPoint(params: P, ctx: HandlerContext, repoLoader: RepoLoader, details: GeneratorCommandDetails<any>, startingPoint: StartingPoint, cr: CommandRegistration, sdmo: SoftwareDeliveryMachineOptions): Promise<Project>

- Defined in lib/api-helper/command/generator/generatorCommand.ts:232
Retrieve a seed. Set the seed location on the parameters if possible and necessary.

Type parameters
- P: SeedDrivenGeneratorParameters
Parameters
- params: P
- ctx: HandlerContext
- repoLoader: RepoLoader
- details: GeneratorCommandDetails<any>
- startingPoint: StartingPoint
- cr: CommandRegistration
- sdmo: SoftwareDeliveryMachineOptions
Returns Promise<Project>

defaultDetails

defaultDetails(opts: SoftwareDeliveryMachineOptions, name: string): GeneratorCommandDetails

- Defined in lib/api-helper/command/generator/generatorCommand.ts:286
Type parameters
- P: SeedDrivenGeneratorParameters
Parameters
- opts: SoftwareDeliveryMachineOptions
- name: string
Returns GeneratorCommandDetails

generatorCommand

generatorCommand(sdm: MachineOrMachineOptions, editorFactory: EditorFactory, name: string, paramsMaker: Maker, fallbackTarget: Maker<RepoCreationParameters>, startingPoint: StartingPoint, details?: Partial<GeneratorCommandDetails<any>>, cr: GeneratorRegistration): HandleCommand

- Defined in lib/api-helper/command/generator/generatorCommand.ts:90
Create a command handler for project generation

Type parameters
- P
Parameters
- sdm: MachineOrMachineOptions
 
 this machine or its options
- editorFactory: EditorFactory
 
 to create editorCommand to perform transformation
- name: string
- paramsMaker: Maker
- fallbackTarget: Maker<RepoCreationParameters>
- startingPoint: StartingPoint
- Default value details: Partial<GeneratorCommandDetails<any>> = {}
- cr: GeneratorRegistration
Returns HandleCommand

handle

handle(ctx: HandlerContext, editorFactory: EditorFactory, params: P, details: GeneratorCommandDetails, startingPoint: StartingPoint, cr: GeneratorRegistration, sdmo: SoftwareDeliveryMachineOptions): Promise<RedirectResult>

- Defined in lib/api-helper/command/generator/generatorCommand.ts:154
Type parameters
- P: SeedDrivenGeneratorParameters
Parameters
- ctx: HandlerContext
- editorFactory: EditorFactory
- params: P
- details: GeneratorCommandDetails
- startingPoint: StartingPoint
- cr: GeneratorRegistration
- sdmo: SoftwareDeliveryMachineOptions
Returns Promise<RedirectResult>

handleGenerate

handleGenerate(editorFactory: EditorFactory, details: GeneratorCommandDetails, startingPoint: StartingPoint, cr: GeneratorRegistration, sdmo: SoftwareDeliveryMachineOptions): OnCommand

- Defined in lib/api-helper/command/generator/generatorCommand.ts:143
Type parameters
- P: SeedDrivenGeneratorParameters
Parameters
- editorFactory: EditorFactory
- details: GeneratorCommandDetails
- startingPoint: StartingPoint
- cr: GeneratorRegistration
- sdmo: SoftwareDeliveryMachineOptions
Returns OnCommand

infoMessage

infoMessage(text: string, ctx: HandlerContext): Promise<void>

- Defined in lib/api-helper/command/generator/generatorCommand.ts:297
Parameters
- text: string
- ctx: HandlerContext
Returns Promise<void>

isProjectPromise

isProjectPromise(a: any): a is Promise<Project>

- Defined in lib/api-helper/command/generator/generatorCommand.ts:282
Parameters
- a: any
Returns a is Promise<Project>

isSeedDrivenGeneratorParameters

isSeedDrivenGeneratorParameters(p: any): p is SeedDrivenGeneratorParameters

- Defined in lib/api-helper/command/generator/generatorCommand.ts:138
Parameters
- p: any
Returns p is SeedDrivenGeneratorParameters

toGeneratorParametersMaker

toGeneratorParametersMaker<PARAMS>(paramsMaker: Maker<PARAMS>, target: RepoCreationParameters): Maker<SeedDrivenGeneratorParameters & PARAMS>

- Defined in lib/api-helper/command/generator/generatorCommand.ts:124
Return a parameters maker that is targeting aware

Type parameters
- PARAMS
Parameters
- paramsMaker: Maker<PARAMS>
- target: RepoCreationParameters
Returns Maker<SeedDrivenGeneratorParameters & PARAMS>

Index

Interfaces

Type aliases

Functions

Type aliases

EditorFactory

Type parameters

P

Type declaration

Parameters

params: P

ctx: HandlerContext

Returns AnyProjectEditor<P>

Functions

computeStartingPoint

Type parameters

P: SeedDrivenGeneratorParameters

Parameters

params: P

ctx: HandlerContext

repoLoader: RepoLoader

details: GeneratorCommandDetails<any>

startingPoint: StartingPoint<P>

cr: CommandRegistration<P>

sdmo: SoftwareDeliveryMachineOptions

Returns Promise<Project>

defaultDetails

Type parameters

P: SeedDrivenGeneratorParameters

Parameters

opts: SoftwareDeliveryMachineOptions

name: string

Returns GeneratorCommandDetails<P>

generatorCommand

Type parameters

P

Parameters

sdm: MachineOrMachineOptions

editorFactory: EditorFactory<P>

name: string

paramsMaker: Maker<P>

fallbackTarget: Maker<RepoCreationParameters>

startingPoint: StartingPoint<P>

Default value details: Partial<GeneratorCommandDetails<any>> = {}

cr: GeneratorRegistration<P>

Returns HandleCommand

handle

Type parameters

P: SeedDrivenGeneratorParameters

Parameters

ctx: HandlerContext

editorFactory: EditorFactory<P>

params: P

details: GeneratorCommandDetails<P>

startingPoint: StartingPoint<P>

cr: GeneratorRegistration<P>

sdmo: SoftwareDeliveryMachineOptions

Returns Promise<RedirectResult>

handleGenerate

Type parameters

P: SeedDrivenGeneratorParameters

Parameters

editorFactory: EditorFactory<P>

details: GeneratorCommandDetails<P>

startingPoint: StartingPoint<P>

cr: GeneratorRegistration<P>

sdmo: SoftwareDeliveryMachineOptions

Returns OnCommand<P>

infoMessage

Parameters

text: string

ctx: HandlerContext

Returns Promise<void>

isProjectPromise

Parameters

a: any

Returns a is Promise<Project>

isSeedDrivenGeneratorParameters

Parameters

p: any