Class Init

constructor

• new Init(src: string): Init

  Initialize the builder, providing the file url or file path to the init script. (This is used to find the templates dir via a relative path.)

  Parameters

  • src: string

  Returns Init

positionals

values

build

• build(__namedParameters: BuildOptions): Promise<void>

  Fill in all templates and write files to the target directory

  Parameters

  • __namedParameters: BuildOptions

  Returns Promise<void>

prompt

• prompt(
      message: string,
      key: string,
      options?: ReadOptions<string>,
  ): Promise<string>

  Prompt the user for a given value, returning the value they provide, and saving it to values for Init#build to consume.

  If they have already specified it on the command line, then the prompt is skipped, and this simply returns the value.

  If they have set -y or --yes on the command line, or if the npm_config_yes environment variable is set to "true", and a default is provided, then the prompt is skipped.

  Parameters

  • message: string
  • key: string
  • options: ReadOptions<string> = {}

  Returns Promise<string>

run

• run(cmd: string): Promise<void>

  Run a command in the target directory.

  This can only be done after the build has completed.

  Parameters

  • cmd: string

  Returns Promise<void>