Properties
| Property | Required | Type(s) | Default | Description |
|---|---|---|---|---|
action | N | function | Method to process data | |
actionTypes | N | object | List of custom action types | |
arguments | N | object/array | Argument handler | |
autoHelp | N | boolean | false | Toggle for automated help menu |
autoVersion | N | boolean | false | Toggle for automated version output |
command | N | string | Subcommand name | |
cwd | N | string | process.cwd() | Current working directory |
description | N | string | Scaffold description | |
exitOnError | N | boolean | true | Toggle for exiting on error |
flags | N | array | List of flags | |
name | Y | string | Scaffold name | |
options | N | array | List of options | |
prompts | N | array | List of prompts | |
promptTypes | N | object | List of custom prompt types | |
scaffoldDir | N | string | Directory where scaffolds are stored | |
silent | N | boolean | false | Toggle for output suppression |
subcommands | N | array/object | List of subcommands | |
tasks | N | array | List of tasks to perform | |
taskTimer | N | boolean | false | Toggle for task timing |
title | N | string | Scaffold title | |
transform | N | function | Method to transform data | |
version | N | string | Scaffold version |
action
Method to process data.
See Properties.action for more information
actionTypes
List of custom action types.
An object that defines custom action types available to the scaffold.
See Properties.actionTypes for more information
arguments
Argument handler. An object or array of objects that define the arguments to parse.
See Properties.arguments for more information
autoHelp
A boolean flag to automatically generate and display the help menu on --help.
See Properties.autoHelp for more information
autoVersion
A boolean flag to automatically output the version on --version.
See Properties.autoVersion for more information
command
The subcommand name, used when the scaffold is a subcommand of another scaffold. Defaults to value of name.
See Properties.command for more information
cwd
The current working directory.
See Properties.cwd for more information
description
A brief description of the scaffold. Used in the help menu.
See Properties.description for more information
exitOnError
A boolean flag to exit if any task fails.
See Properties.exitOnError for more information
flags
A list of available flag parameters to parse.
See Properties.flags for more information
name
(required) The name of the scaffold. Doubles as the subcommand if command is not set.
See Properties.name for more information
options
A list of available key/value parameters to parse.
See Properties.options for more information
prompts
An array of objects that define the prompts to ask the user.
See Properties.prompts for more information
promptTypes
An object that defines custom prompt types available to the scaffold.
See Properties.promptTypes for more information
scaffoldDir
The directory where scaffolds are stored.
See Properties.scaffoldDir for more information
silent
A boolean flag to suppress logging output.
See Properties.silent for more information
subcommands
An array or object that define the subcommands available to the scaffold.
See Properties.subcommands for more information
taskTimer
A boolean flag to time each task.
See Properties.taskTimer for more information
title
The title of the scaffold.
See Properties.title for more information
transform
A method to transform data before reaching the action.
See Properties.transform for more information
version
The version of the scaffold. Used in the help menu.
See Properties.version for more information