Interface: GeneratorConfig
#
Hierarchy- GeneratorConfig
#
Properties#
actions• Optional
actions: Action[] | (this
: SAO, ctx
: SAO) => Action[] | Promise<Action[]>
Use actions to control how files are generated
Defined in: src/generator-config.ts:85
#
completed• Optional
completed: (this
: SAO, ctx
: SAO) => Promise<void> | void
Run some operations when completed e.g. log some success message
Defined in: src/generator-config.ts:106
#
data• Optional
data: DataFunction
Extra data to use in template transformation
Defined in: src/generator-config.ts:75
#
description• Optional
description: string
Generator description Used in CLI output
Defined in: src/generator-config.ts:61
#
prepare• Optional
prepare: (this
: SAO, ctx
: SAO) => Promise<void> | void
Run some operations before starting
Defined in: src/generator-config.ts:101
#
prompts• Optional
prompts: PromptOptions[] | (this
: SAO, ctx
: SAO) => PromptOptions[] | Promise<PromptOptions[]>
Use prompts to ask questions before generating project
Defined in: src/generator-config.ts:79
#
subGenerators• Optional
subGenerators: Array<{ generator
: string ; name
: string }>
Sub generator
Defined in: src/generator-config.ts:94
#
templateDir• Optional
templateDir: string
Directory to template folder
Defaults to ./template
in your generator folder
Defined in: src/generator-config.ts:90
#
transform• Optional
transform: boolean
Transform template content with ejs
Defaults to true
Defined in: src/generator-config.ts:71
#
updateCheck• Optional
updateCheck: boolean
Check updates for npm generators
Defaults to true
Defined in: src/generator-config.ts:66