scaffold-unit-testing.md

scaffoldUnitTesting

Scaffolder for enabling unit-testing in a project with the ability to choose a desired framework from provided options.

Table of Contents

• Arguments
  • projectRoot string (required)
  • frameworks object (required)
  • decisions object (optional)
  • visibility string (required)
  • vcs object (required)
  • pathWithinParent string (optional)

Arguments

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

frameworks object (required)

A choices object for defining unit-testing framework options

decisions object (optional)

Answers for prompt questions so that the prompt is skipped at execution time

• keys: string Name of the prompt question
• values: Hard-coded answer for the prompt question

visibility string (required)

visibility of the project (Public or Private)

vcs object (required)

• host string (required) VCS hosting service
• owner string (required) account name on the host service for the repository
• name string (required) repository name

pathWithinParent string (optional)

path within a parent project when working on a sub-project