Skip to main content

Interface: DecoupledKitGenerator<Prompts, Data>

Generators need prompts to get user data not provided by CLI arguments

Type parameters​

NameType
PromptsDefaultAnswers
Dataunknown

Properties​

actions​

• actions: Action[]

An array of actions to run with the prompts and templates

Defined in​

src/types.ts:76


addon​

• Optional addon: boolean

Set to true if the generator is considered an addon. This will give priority to the templates when de-duping.

Defined in​

src/types.ts:85


cmsType​

• cmsType: "drupal" | "wp" | "wordpress" | "d9" | "d10" | "any"

Identifies a generators compatible CMS(s).

Defined in​

src/types.ts:93


data​

• Optional data: Data

Any extra data that should be passed from the generator to the actions

Defined in​

src/types.ts:80


description​

• description: string

Description of the generator

Defined in​

src/types.ts:59


name​

• name: string

Generator's name. This should be kebab case.

Defined in​

src/types.ts:55


nextSteps​

• Optional nextSteps: string[]

Any message(s) to be rendered after actions are successfully completed.

Defined in​

src/types.ts:89


prompts​

• prompts: QuestionCollection<DefaultAnswers>[]

An array of inquirer prompts

Template

the type of the required user input

Default

DefaultAnswers - { outDir: string };

Defined in​

src/types.ts:65


templates​

• templates: string[]

An array of paths to the generator's templates. This should be empty if the generator does not have templates.

Defined in​

src/types.ts:72