Interface: GeneratorConfig

Hierarchy#

• Optional actions: Action[] | (this: SAO, ctx: SAO) => Action[] | Promise<Action[]>

Use actions to control how files are generated

• Optional completed: (this: SAO, ctx: SAO) => Promise<void> | void

Run some operations when completed e.g. log some success message

• Optional data: DataFunction

Extra data to use in template transformation

• Optional description: string

Generator description Used in CLI output

• Optional prepare: (this: SAO, ctx: SAO) => Promise<void> | void

Run some operations before starting

• Optional prompts: PromptOptions[] | (this: SAO, ctx: SAO) => PromptOptions[] | Promise<PromptOptions[]>

Use prompts to ask questions before generating project

• Optional subGenerators: Array<{ generator: string ; name: string }>

Sub generator

• Optional templateDir: string

Directory to template folder Defaults to ./template in your generator folder

• Optional transform: boolean

Transform template content with ejs Defaults to true

• Optional updateCheck: boolean

Check updates for npm generators Defaults to true